Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

King Fahd University of Petroleum & Minerals externalOrganization API

The externalOrganization API from King Fahd University of Petroleum & Minerals — 29 operation(s) for externalorganization.

King Fahd University of Petroleum & Minerals externalOrganization API is one of 38 APIs that King Fahd University of Petroleum & Minerals publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 4 JSON Schema definitions.

Tagged areas include externalOrganization. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, a JSON-LD context, and 4 JSON Schemas.

This API exposes 34 operations across 29 paths, and defines 46 schemas. It is described by OpenAPI 3.0.1, at version 5.35.3-4.

Requests are made against a single base URL, https://pure.kfupm.edu.sa/ws/api.

34 operations 29 paths 46 schemas 1 DELETE22 GET6 POST5 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
5.35.3-4
Base URL
https://eprints.kfupm.edu.sa/cgi/oai2
Authentication
API Key
Resource Areas
1

Authentication & Security 1

King Fahd University of Petroleum & Minerals externalOrganization API declares 1 security scheme for authenticating requests. An API key is passed in the header as api-key (api-key). By default, every request must be authenticated.

  • api-key — Security mechanism for the API

Paths & Operations 34

Across 29 paths, the API surfaces 34 operations — 1 DELETE, 22 GET, 6 POST, 5 PUT. Each is listed below with its method, path, parameters, and response codes.

externalOrganization 34
GET
/external-organizations
Lists all external organizations
externalOrganization_list 3 params → 200
PUT
/external-organizations
Create external organization
externalOrganization_create body → 201400
GET
/external-organizations/allowed-address-countries
A list of allowed address countries
externalOrganization_getAllowedAddressCountries → 200
GET
/external-organizations/allowed-address-subdivision
A list of allowed address subdivisions
externalOrganization_getAllowedAddressSubdivisions → 200
GET
/external-organizations/allowed-classified-file-types
A list of allowed classified identifier types
externalOrganization_getAllowedClassifiedImageTypes → 200
GET
/external-organizations/allowed-classified-identifier-types
A list of allowed classified identifier types
externalOrganization_getAllowedClassifiedIdentifierTypes → 200
GET
/external-organizations/allowed-document-licenses
A list of allowed document licenses
externalOrganization_getAllowedDocumentLicenses → 200
GET
/external-organizations/allowed-document-types
A list of allowed document types
externalOrganization_getAllowedDocumentTypes → 200
GET
/external-organizations/allowed-keyword-group-configurations
A list of keyword group configurations
externalOrganization_getAllowedKeywordGroupConfigurations → 200
GET
/external-organizations/allowed-keyword-group-configurations/{id}/classifications
A list of allowed classifications for the specified keyword group
externalOrganization_getAllowedKeywordGroupConfigurationClassifications 1 param → 200
GET
/external-organizations/allowed-link-types
A list of allowed link types
externalOrganization_getAllowedLinkTypes → 200
GET
/external-organizations/allowed-locales
A list of allowed locales in localized strings
externalOrganization_getAllowedLocales → 200
GET
/external-organizations/allowed-nature-types
A list of allowed nature types
externalOrganization_getAllowedNatureTypes → 200
GET
/external-organizations/allowed-types
A list of allowed external organization types
externalOrganization_getAllowedTypes → 200
GET
/external-organizations/allowed-workflow-steps
A list of allowed workflow steps
externalOrganization_getAllowedWorkflowSteps → 200
GET
/external-organizations/disciplines/allowed-discipline-schemes
A list of allowed discipline schemes
externalOrganization_getAllowedDisciplineSchemes → 200
GET
/external-organizations/disciplines/{discipline-scheme}/allowed-disciplines
A list of allowed disciplines for a specific discipline scheme
externalOrganization_getAllowedDisciplines 3 params → 200
POST
/external-organizations/disciplines/{discipline-scheme}/search
Query operation for disciplines associated with external organizations
externalOrganization_listDisciplineAssociations 1 param body → 200400
PUT
/external-organizations/file-uploads
Upload file to a specific external organization
externalOrganization_fileUploads 1 param body → default
POST
/external-organizations/merge
Merge external organizations
externalOrganization_merge body → 200400
GET
/external-organizations/orderings
Lists available orderings
externalOrganization_getOrderings → 200
POST
/external-organizations/preview-deduplication
Preview deduplication of external organizations
externalOrganization_previewDeduplication body → 200400
POST
/external-organizations/search
Query operation for external organizations
externalOrganization_query body → 200400
GET
/external-organizations/{uuid}
Get external organization
externalOrganization_get 1 param → 200301404
PUT
/external-organizations/{uuid}
Update external organization
externalOrganization_update 1 param body → 200400404409
DELETE
/external-organizations/{uuid}
Delete external organization
externalOrganization_delete 1 param → 204404409
POST
/external-organizations/{uuid}/actions/lock
Lock the content
externalOrganization_lock 1 param → 204404409
POST
/external-organizations/{uuid}/actions/unlock
Unlock the content
externalOrganization_unlock 1 param → 204404409
GET
/external-organizations/{uuid}/dependents
Lists all dependents to the external organization
externalOrganization_dependents 2 params → 200
GET
/external-organizations/{uuid}/disciplines/{discipline-scheme}
Get disciplines from the discipline scheme associated with the external organization
externalOrganization_getDisciplineAssociation 2 params → 200404
PUT
/external-organizations/{uuid}/disciplines/{discipline-scheme}
Update disciplines from the discipline scheme associated with the external organization
externalOrganization_putDisciplineAssociation 2 params body → 200400404
GET
/external-organizations/{uuid}/files/{fileId}
Get file from the external organization
externalOrganization_getFile 2 params → 200
GET
/external-organizations/{uuid}/notes
Lists notes
externalOrganization_listNotes 3 params → 200404
PUT
/external-organizations/{uuid}/notes
Create note
externalOrganization_createNote 1 param body → 200400

Schemas 46

The contract defines 46 schemas that model the data the API accepts and returns. The most detailed are ExternalOrganization (34 properties), Document (17 properties), ImageFile (15 properties), CERIFAddress (11 properties). Each schema is shown below with its type and property counts.

DisciplinesDisciplineScheme
object
A discipline scheme
2 properties 2 required
SystemLocalizedString
object
A set of localized string values each for a specific UI locale.
RemoteFile
object
Information about a remote file (Elsevier only)
6 properties 4 required
ExternalOrganizationsQuery
object
Create a query for external organizations
6 properties
UploadedFile
object
Information about the uploaded file
7 properties 1 required
Document
object
Document
17 properties 4 required
DisciplinesDisciplineListResult
object
List of disciplines for a specific discipline scheme
3 properties
Link
object
A hyperlink describing a location on the web.
5 properties 1 required
ConflictProblemDetails
object
Problem details for state conflict failures
7 properties
ExternalOrganizationRef
object
A reference to an organization external to the institution
1 required
Identifier
object
1 property 1 required
Visibility
object
Visibility of an object
2 properties 1 required
DisciplinesDisciplineAssignment
object
The assigned discipline and its split percentage
2 properties 2 required
DisciplinesAssociationsQuery
object
Create a query for discipline associations
3 properties
ExternalOrganizationRefList
object
List of references to organizations external to the institution.
1 property
Note
object
A note
3 properties 1 required
AllowedKeywordGroupConfigurationList
object
List of allowed keyword group configurations
1 property
ClassificationRef
object
A reference to a classification value
2 properties 1 required
DisciplinesDisciplineSchemeListResult
object
List of discipline schemes
2 properties
ContentRefListResult
object
List of Content Refs
1 property
OrganizationOrExternalOrganizationRef
object
A reference to an organization in the institution or an external organization
2 properties
GeoLocation
object
Geographical location
3 properties
ContentRef
object
2 properties 2 required
ExternalOrganizationListResult
object
List of organizations external to the institution. Can contain a subset of all items along with the full count
3 properties
ProblemDetails
object
RFC7807 Error details
5 properties
DisciplinesDiscipline
object
A discipline within a specific discipline scheme
3 properties
ExternalOrganization
object
An organization external to the institution
34 properties 2 required
ImageFile
object
An image file
15 properties 2 required
OrganizationRef
object
A reference to an organization in the institution
1 required
PageInformation
object
Information about pages
2 properties
FormattedLocalizedString
object
A set of localized strings that support formatting. Invalid locale values will be ignored.
ClassificationSchemeRef
object
A reference to a classification scheme
1 required
ClassificationRefList
object
List of classification references
1 property
DateRange
object
A date range
2 properties
ExternalOrganizationList
object
List of organizations external to the institution.
1 property
AllowedKeywordGroupConfiguration
object
A specification of the allowed behavior of a specified keyword group
10 properties 1 required
DisciplinesAssociation
object
An association between a content and a number of discipline assignments
3 properties 1 required
WorkflowListResult
object
List of workflow steps.
1 property
LocalizedString
object
A set of string values, one for each submission locale. Note: invalid locale values will be ignored.
KeywordGroup
object
4 properties 2 required
LocalesList
object
List of available locales
1 property
CERIFAddress
object
A physical address
11 properties
NoteListResult
object
List of notes
3 properties
DisciplinesAssociationListResult
object
List of discipline associations. Can contain a subset of all items along with the full count
3 properties
Workflow
object
Information about workflow
2 properties 1 required
OrderingsList
object
List of available orderings
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

kfupm-externalorganization-api-openapi.yml Raw ↑

Other APIs King Fahd University of Petroleum & Minerals publishes across the network.

KFUPM ePrints REST / Search
King Fahd University of Petroleum & Minerals activity API
King Fahd University of Petroleum & Minerals application API
King Fahd University of Petroleum & Minerals authorCollaboration API
King Fahd University of Petroleum & Minerals award API
King Fahd University of Petroleum & Minerals classificationScheme API
King Fahd University of Petroleum & Minerals concept API
King Fahd University of Petroleum & Minerals conferenceSeries API
King Fahd University of Petroleum & Minerals contract API
King Fahd University of Petroleum & Minerals course API
King Fahd University of Petroleum & Minerals dataSet API
King Fahd University of Petroleum & Minerals education API