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

Eindhoven University of Technology authorCollaboration API

The authorCollaboration API from Eindhoven University of Technology — 9 operation(s) for authorcollaboration.

Eindhoven University of Technology authorCollaboration 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 authorCollaboration. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 13 operations across 9 paths, and defines 17 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.

13 operations 9 paths 17 schemas 1 DELETE6 GET3 POST3 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://pure.tue.nl/ws/oai
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Eindhoven University of Technology authorCollaboration 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 13

Across 9 paths, the API surfaces 13 operations — 1 DELETE, 6 GET, 3 POST, 3 PUT. Each is listed below with its method, path, parameters, and response codes.

authorCollaboration 13
GET
/author-collaborations
Lists all author collaborations
authorCollaboration_list 3 params → 200
PUT
/author-collaborations
Create author collaboration
authorCollaboration_create body → 201400
GET
/author-collaborations/allowed-locales
A list of allowed locales in localized strings
authorCollaborations_getAllowedLocales → 200
GET
/author-collaborations/allowed-workflow-steps
A list of allowed workflow steps
authorCollaborations_getAllowedWorkflowSteps → 200
GET
/author-collaborations/orderings
Lists available orderings
authorCollaborations_getOrderings → 200
POST
/author-collaborations/search
Query operation for author-collaborations
authorCollaborations_query body → 200400
GET
/author-collaborations/{uuid}
Get author collaboration
authorCollaborations_get 1 param → 200301404
PUT
/author-collaborations/{uuid}
Update author collaboration
authorCollaboration_update 1 param body → 200400404409
DELETE
/author-collaborations/{uuid}
Delete author collaboration
authorCollaboration_delete 1 param → 204404409
POST
/author-collaborations/{uuid}/actions/lock
Lock the content
authorCollaborations_lock 1 param → 204404409
POST
/author-collaborations/{uuid}/actions/unlock
Unlock the content
authorCollaborations_unlock 1 param → 204404409
GET
/author-collaborations/{uuid}/notes
Lists notes
authorCollaborations_listNotes 3 params → 200404
PUT
/author-collaborations/{uuid}/notes
Create note
authorCollaborations_createNote 1 param body → 200400

Schemas 17

The contract defines 17 schemas that model the data the API accepts and returns. The most detailed are AuthorCollaboration (16 properties), ConflictProblemDetails (7 properties), AuthorCollaborationQuery (6 properties), ProblemDetails (5 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
LocalesList
object
List of available locales
1 property
Note
object
A note
3 properties 1 required
NoteListResult
object
List of notes
3 properties
LocalizedString
object
A set of string values, one for each submission locale. Note: invalid locale values will be ignored.
Identifier
object
1 property 1 required
AuthorCollaboration
object
Author collaboration
16 properties 1 required
ConflictProblemDetails
object
Problem details for state conflict failures
7 properties
AuthorCollaborationListResult
object
List of author collaborations. Can contain a subset of all items along with the full count
3 properties
OrderingsList
object
List of available orderings
1 property
WorkflowListResult
object
List of workflow steps.
1 property
ExternalOrganizationRef
object
A reference to an organization external to the institution
1 required
AuthorCollaborationQuery
object
Create a query for author-collaborations
6 properties
SystemLocalizedString
object
A set of localized string values each for a specific UI locale.
Workflow
object
Information about workflow
2 properties 1 required
ProblemDetails
object
RFC7807 Error details
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

eindhoven-university-of-technology-authorcollaboration-api-openapi.yml Raw ↑

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 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
Eindhoven University of Technology equipment API