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 organization API

The organization API from King Fahd University of Petroleum & Minerals — 34 operation(s) for organization.

King Fahd University of Petroleum & Minerals organization 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 organization. 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 39 operations across 34 paths, and defines 49 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.

39 operations 34 paths 49 schemas 1 DELETE29 GET4 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 organization 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 39

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

organization 39
GET
/organizations
Lists all organizations
organization_list 3 params → 200
PUT
/organizations
Create organization
organization_create body → 201400
GET
/organizations/allowed-address-countries
A list of allowed address countries
organization_getAllowedAddressCountries → 200
GET
/organizations/allowed-address-subdivision
A list of allowed address subdivisions
organization_getAllowedAddressSubdivisions → 200
GET
/organizations/allowed-address-types
A list of allowed address types
organization_getAllowedAddressTypes → 200
GET
/organizations/allowed-classified-file-typesdeprecated
DEPRECATED - use 'allowed-photo-types' - A list of allowed classified identifier types
organization_getAllowedClassifiedImageTypes → 200
GET
/organizations/allowed-classified-identifier-types
A list of allowed classified identifier types
organization_getAllowedClassifiedIdentifierTypes → 200
GET
/organizations/allowed-cost-centers
A list of allowed cost centers
organization_getAllowedCostCenters → 200
GET
/organizations/allowed-custom-defined-field-values/{propertyName}/classifications
Get allowed classifications for the custom-defined field associated with the organization
organization_getAllowedCustomDefinedFieldClassifications 1 param → 200400404
GET
/organizations/allowed-email-types
A list of allowed e-mail types
organization_getAllowedEmailTypes → 200
GET
/organizations/allowed-keyword-group-configurations
A list of keyword group configurations
organization_getAllowedKeywordGroupConfigurations → 200
GET
/organizations/allowed-keyword-group-configurations/{id}/classifications
A list of allowed classifications for the specified keyword group
organization_getAllowedKeywordGroupConfigurationClassifications 1 param → 200
GET
/organizations/allowed-link-types
A list of allowed link types
organization_getAllowedLinkTypes → 200
GET
/organizations/allowed-locales
A list of allowed locales in localized strings
organization_getAllowedLocales → 200
GET
/organizations/allowed-main-research-areas
A list of allowed main research areas
organization_getAllowedMainResearchAreas → 200
GET
/organizations/allowed-name-variant-types
A list of allowed name variant types
organization_getAllowedNameVariantTypes → 200
GET
/organizations/allowed-phone-number-types
A list of allowed phone number types
organization_getAllowedPhoneNumberTypes → 200
GET
/organizations/allowed-photo-types
A list of allowed photo types
organization_getAllowedPhotoTypes → 200
GET
/organizations/allowed-profile-information-types
A list of allowed profile information types
organization_getAllowedProfileInformationTypes → 200
GET
/organizations/allowed-types
A list of allowed organization types
organization_getAllowedTypes → 200
GET
/organizations/allowed-web-address-types
A list of allowed web address types
organization_getAllowedWebAddressTypes → 200
GET
/organizations/disciplines/allowed-discipline-schemes
A list of allowed discipline schemes
organization_getAllowedDisciplineSchemes → 200
GET
/organizations/disciplines/{discipline-scheme}/allowed-disciplines
A list of allowed disciplines for a specific discipline scheme
organization_getAllowedDisciplines 3 params → 200
POST
/organizations/disciplines/{discipline-scheme}/search
Query operation for disciplines associated with organizations
organization_listDisciplineAssociations 1 param body → 200400
PUT
/organizations/file-uploads
Upload file to a specific organization
organization_fileUploads 1 param body → default
GET
/organizations/orderings
Lists available orderings
organization_getOrderings → 200
POST
/organizations/search
Query operation for organizations
organization_query body → 200400
GET
/organizations/{uuid}
Get organization
organization_get 1 param → 200301404
PUT
/organizations/{uuid}
Update organization
organization_update 1 param body → 200400404409
DELETE
/organizations/{uuid}
Delete organization
organization_delete 1 param → 204404409
POST
/organizations/{uuid}/actions/lock
Lock the content
organization_lock 1 param → 204404409
POST
/organizations/{uuid}/actions/unlock
Unlock the content
organization_unlock 1 param → 204404409
GET
/organizations/{uuid}/dependents
Lists all dependents to the organization
organization_dependents 2 params → 200
GET
/organizations/{uuid}/disciplines/{discipline-scheme}
Get disciplines from the discipline scheme associated with the organization
organization_getDisciplineAssociation 2 params → 200404
PUT
/organizations/{uuid}/disciplines/{discipline-scheme}
Update disciplines from the discipline scheme associated with the organization
organization_putDisciplineAssociation 2 params body → 200400404
GET
/organizations/{uuid}/files/{fileId}
Get file from the organization
organization_getFile 2 params → 200
GET
/organizations/{uuid}/fingerprints
Get the fingerprints for the organization
organization_getFingerprints 1 param → 200403404
GET
/organizations/{uuid}/notes
Lists notes
organization_listNotes 3 params → 200404
PUT
/organizations/{uuid}/notes
Create note
organization_createNote 1 param body → 200400

Schemas 49

The contract defines 49 schemas that model the data the API accepts and returns. The most detailed are Organization (31 properties), ImageFile (15 properties), Fingerprint (13 properties), ClassifiedAddress (10 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
UploadedFile
object
Information about the uploaded file
7 properties 1 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
Identifier
object
1 property 1 required
ClassifiedValue
object
A classified value
3 properties 2 required
Visibility
object
Visibility of an object
2 properties 1 required
DisciplinesDisciplineAssignment
object
The assigned discipline and its split percentage
2 properties 2 required
Organization
object
An organization in the institution
31 properties 3 required
DisciplinesAssociationsQuery
object
Create a query for discipline associations
3 properties
ClassifiedFormattedLocalizedValue
object
A classified formatted localized value
3 properties 1 required
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
GeoLocation
object
Geographical location
3 properties
ProblemDetails
object
RFC7807 Error details
5 properties
ContentRef
object
2 properties 2 required
Fingerprint
object
A fingerprint
13 properties 1 required
DisciplinesDiscipline
object
A discipline within a specific discipline scheme
3 properties
OrganizationListResult
object
A list of organizations
3 properties
ImageFile
object
An image file
15 properties 2 required
CustomDefinedField
object
Map of CustomDefinedField values, where the key is the field identifier
1 property 1 required
FormattedLocalizedString
object
A set of localized strings that support formatting. Invalid locale values will be ignored.
PageInformation
object
Information about pages
2 properties
CustomDefinedFields
object
Map of CustomDefinedField values, where the key is the field identifier
OrganizationRef
object
A reference to an organization in the institution
1 required
ClassificationSchemeRef
object
A reference to a classification scheme
1 required
PersonRef
object
A reference to a person internal to the institution
1 required
ClassificationRefList
object
List of classification references
1 property
ClassifiedAddress
object
A physical address
10 properties 1 required
ConceptRef
object
A reference to a concept
1 required
DateRange
object
A date range
2 properties
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
LocalizedString
object
A set of string values, one for each submission locale. Note: invalid locale values will be ignored.
RankedConcept
object
A ranked concept
4 properties 2 required
KeywordGroup
object
4 properties 2 required
LocalesList
object
List of available locales
1 property
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
FingerprintListResult
object
List of fingerprints. Can contain a subset of all items along with the full count
3 properties
OrganizationsQuery
object
Create a query for organizations
6 properties
OrderingsList
object
List of available orderings
1 property
ClassifiedLocalizedValue
object
A classified localized value
3 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

kfupm-organization-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