Skip to content

Latest commit

 

History

History
119 lines (99 loc) · 3.49 KB

entitytypes.md

File metadata and controls

119 lines (99 loc) · 3.49 KB
Raw

Entity Type Endpoints

Back to the list of all defined endpoints

This endpoint contains the various types of entities (publication, person, journal, …) and links to the types of relationships each of these entities may have. Entities are Items with a valid value in the dspace.entity.type

Main Endpoint

/api/core/entitytypes

A sample can be found at https://demo.dspace.org/server/#https://demo.dspace.org/server/api/core/entitytypes

{
  "_embedded": {
    "entitytypes": [
      {
        "id": 1,
        "label": "Publication",
        "type": "entitytype",
        "_links": {
          "self": {
            "href": "https://demo.dspace.org/server/api/core/entitytypes/1"
          },
          "relationshiptypes": {
            "href": "https://demo.dspace.org/server/api/core/entitytypes/1/relationshiptypes"
          }
        }
      },
      {
        "id": 2,
        "label": "Person",
        "type": "entitytype",
        "_links": {
          "self": {
            "href": "https://demo.dspace.org/server/api/core/entitytypes/2"
          },
          "relationshiptypes": {
            "href": "https://demo.dspace.org/server/api/core/entitytypes/2/relationshiptypes"
          }
        }
      }
    ]
  },
  "_links": {
    "self": {
      "href": "https://demo.dspace.org/server/api/core/entitytypes"
    }
  },
  "page": {
    "size": 20,
    "totalElements": 2,
    "totalPages": 1,
    "number": 0
  }
}

Single Entity Type

/api/core/entitytypes/<:id>

A sample can be found at https://demo.dspace.org/server/#https://demo.dspace.org/server/api/core/entitytypes/1

{
  "id": 1,
  "label": "Publication",
  "type": "entitytype",
  "_links": {
    "self": {
      "href": "https://demo.dspace.org/server/api/core/entitytypes/1"
    },
    "relationshiptypes": {
      "href": "https://demo.dspace.org/server/api/core/entitytypes/1/relationshiptypes"
    }
  }
}

It contains a HAL link to the Relationship Types for the current Entity Type (not embedded)

Relationship Types for the current Entity Type

/api/core/entitytypes/<:id>/relationshiptypes

A sample can be found at https://demo.dspace.org/server/#https://demo.dspace.org/server/api/core/entitytypes/1/relationshiptypes It embeds the relationshiptypes which are linked to the given entity type (either on the left or right side)

Get Entity type from label

/api/core/entitytypes/label/<:entity-type-label>

A sample request would be https://demo.dspace.org/server/#/server/api/core/entitytypes/label/Person The entity-type-label is mandatory

There's always at most one entity type per label.

It would respond with:

  • The single entity type if there's a match
  • 404 if the entity type doesn't exist

Search methods

findAllByAuthorizedCollection

/api/core/entitytypes/search/findAllByAuthorizedCollection

The supported parameters are:

  • page, size see pagination It returns a list of entity types for which there is at least one collection in which the user is authorized to submit

Return codes:

  • 200 OK - if the operation succeed

findAllByAuthorizedExternalSource

/api/core/entitytypes/search/findAllByAuthorizedExternalSource

The supported parameters are:

  • page, size see pagination It returns a list of entity types for which there is at least one collection in which the user is authorized to submit supported by at least one external data source provider

Return codes:

  • 200 OK - if the operation succeed