Eindhoven University of Technology externalOrganization API
The externalOrganization API from Eindhoven University of Technology — 29 operation(s) for externalorganization.
Eindhoven University of Technology externalOrganization API is one of 38 APIs that Eindhoven University of Technology publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include externalOrganization. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
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, /ws/api.
34 operations
29 paths
46 schemas
1 DELETE22 GET6 POST5 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Eindhoven University of Technology 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
PUT
/external-organizations
Create external organization
GET
/external-organizations/allowed-address-countries
A list of allowed address countries
GET
/external-organizations/allowed-address-subdivision
A list of allowed address subdivisions
GET
/external-organizations/allowed-classified-file-types
A list of allowed classified identifier types
GET
/external-organizations/allowed-classified-identifier-types
A list of allowed classified identifier types
GET
/external-organizations/allowed-document-licenses
A list of allowed document licenses
GET
/external-organizations/allowed-document-types
A list of allowed document types
GET
/external-organizations/allowed-keyword-group-configurations
A list of keyword group configurations
GET
/external-organizations/allowed-keyword-group-configurations/{id}/classifications
A list of allowed classifications for the specified keyword group
GET
/external-organizations/allowed-link-types
A list of allowed link types
GET
/external-organizations/allowed-locales
A list of allowed locales in localized strings
GET
/external-organizations/allowed-nature-types
A list of allowed nature types
GET
/external-organizations/allowed-types
A list of allowed external organization types
GET
/external-organizations/allowed-workflow-steps
A list of allowed workflow steps
GET
/external-organizations/disciplines/allowed-discipline-schemes
A list of allowed discipline schemes
GET
/external-organizations/disciplines/{discipline-scheme}/allowed-disciplines
A list of allowed disciplines for a specific discipline scheme
POST
/external-organizations/disciplines/{discipline-scheme}/search
Query operation for disciplines associated with external organizations
PUT
/external-organizations/file-uploads
Upload file to a specific external organization
POST
/external-organizations/merge
Merge external organizations
GET
/external-organizations/orderings
Lists available orderings
POST
/external-organizations/preview-deduplication
Preview deduplication of external organizations
POST
/external-organizations/search
Query operation for external organizations
GET
/external-organizations/{uuid}
Get external organization
PUT
/external-organizations/{uuid}
Update external organization
DELETE
/external-organizations/{uuid}
Delete external organization
POST
/external-organizations/{uuid}/actions/lock
Lock the content
POST
/external-organizations/{uuid}/actions/unlock
Unlock the content
GET
/external-organizations/{uuid}/dependents
Lists all dependents to the external organization
GET
/external-organizations/{uuid}/disciplines/{discipline-scheme}
Get disciplines from the discipline scheme associated with the external organization
PUT
/external-organizations/{uuid}/disciplines/{discipline-scheme}
Update disciplines from the discipline scheme associated with the external organization
GET
/external-organizations/{uuid}/files/{fileId}
Get file from the external organization
GET
/external-organizations/{uuid}/notes
Lists notes
PUT
/external-organizations/{uuid}/notes
Create note
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.
PageInformation
object
Information about pages
2 properties
ContentRef
object
2 properties
2 required
AllowedKeywordGroupConfiguration
object
A specification of the allowed behavior of a specified keyword group
10 properties
1 required
LocalizedString
object
A set of string values, one for each submission locale. Note: invalid locale values will be ignored.
DisciplinesAssociation
object
An association between a content and a number of discipline assignments
3 properties
1 required
DisciplinesDisciplineListResult
object
List of disciplines for a specific discipline scheme
3 properties
FormattedLocalizedString
object
A set of localized strings that support formatting. Invalid locale values will be ignored.
CERIFAddress
object
A physical address
11 properties
GeoLocation
object
Geographical location
3 properties
DateRange
object
A date range
2 properties
SystemLocalizedString
object
A set of localized string values each for a specific UI locale.
OrganizationRef
object
A reference to an organization in the institution
1 required
ContentRefListResult
object
List of Content Refs
1 property
ExternalOrganization
object
An organization external to the institution
34 properties
2 required
Note
object
A note
3 properties
1 required
NoteListResult
object
List of notes
3 properties
Visibility
object
Visibility of an object
2 properties
1 required
ExternalOrganizationRefList
object
List of references to organizations external to the institution.
1 property
DisciplinesDiscipline
object
A discipline within a specific discipline scheme
3 properties
ImageFile
object
An image file
15 properties
2 required
RemoteFile
object
Information about a remote file (Elsevier only)
6 properties
4 required
Link
object
A hyperlink describing a location on the web.
5 properties
1 required
ExternalOrganizationsQuery
object
Create a query for external organizations
6 properties
Workflow
object
Information about workflow
2 properties
1 required
LocalesList
object
List of available locales
1 property
UploadedFile
object
Information about the uploaded file
7 properties
1 required
DisciplinesDisciplineSchemeListResult
object
List of discipline schemes
2 properties
ExternalOrganizationListResult
object
List of organizations external to the institution. Can contain a subset of all items along with the full count
3 properties
Identifier
object
1 property
1 required
ConflictProblemDetails
object
Problem details for state conflict failures
7 properties
KeywordGroup
object
4 properties
2 required
WorkflowListResult
object
List of workflow steps.
1 property
ExternalOrganizationRef
object
A reference to an organization external to the institution
1 required
Document
object
Document
17 properties
4 required
DisciplinesAssociationListResult
object
List of discipline associations. Can contain a subset of all items along with the full count
3 properties
DisciplinesDisciplineAssignment
object
The assigned discipline and its split percentage
2 properties
2 required
ProblemDetails
object
RFC7807 Error details
5 properties
ClassificationRef
object
A reference to a classification value
2 properties
1 required
OrganizationOrExternalOrganizationRef
object
A reference to an organization in the institution or an external organization
2 properties
AllowedKeywordGroupConfigurationList
object
List of allowed keyword group configurations
1 property
ExternalOrganizationList
object
List of organizations external to the institution.
1 property
ClassificationSchemeRef
object
A reference to a classification scheme
1 required
OrderingsList
object
List of available orderings
1 property
DisciplinesDisciplineScheme
object
A discipline scheme
2 properties
2 required
ClassificationRefList
object
List of classification references
1 property
DisciplinesAssociationsQuery
object
Create a query for discipline associations
3 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Eindhoven University of Technology 12
Other APIs Eindhoven University of Technology publishes across the network.
TU/e Research Portal OAI-PMH
Eindhoven University of Technology activity API
Eindhoven University of Technology application API
Eindhoven University of Technology authorCollaboration API
Eindhoven University of Technology award API
Eindhoven University of Technology classificationScheme API
Eindhoven University of Technology concept API
Eindhoven University of Technology conferenceSeries API
Eindhoven University of Technology contract API
Eindhoven University of Technology course API
Eindhoven University of Technology dataSet API
Eindhoven University of Technology education API
#externalOrganization