Skip to content

Commit

Permalink
Merge branch 'dspace-cris-2023_02_x' into main-cris
Browse files Browse the repository at this point in the history
# Conflicts:
#	suggestions.md
#	suggestiontargets.md
#	workspaceitem-data-upload.md
  • Loading branch information
atarix83 committed Dec 31, 2024
2 parents c70d2c1 + c0df71a commit a498c12
Show file tree
Hide file tree
Showing 62 changed files with 671 additions and 263 deletions.
1 change: 1 addition & 0 deletions authentication.md
Original file line number Diff line number Diff line change
Expand Up @@ -100,6 +100,7 @@ This will return the authentication status, E.G.:
"okay" : true,
"authenticated" : true,
"type" : "status",
"uniqueType": "authn.status",
"_links" : {
"eperson" : {
"href" : "http://${dspace-server.url}/api/eperson/epersons/2245f2c5-1bed-414b-a313-3fd2d2ec89d6"
Expand Down
3 changes: 2 additions & 1 deletion authorizations.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,8 @@ Provide detailed information about a specific authorization. The JSON response d
```json
{
"id": [eperson-uuid_]feature-id_restobjectcategory.restobjectname_object-id,
"type": "authorization"
"type": "authorization",
"uniqueType": "authz.authorization"
}
```

Expand Down
1 change: 1 addition & 0 deletions bitstreamformats.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,7 @@ Provide detailed information about a specific bitstream format. The JSON respons
"xml"
],
"type": "bitstreamformat",
"uniqueType": "core.bitstreamformat",
"_links": {
"self": {
"href": "https://dspace7-internal.atmire.com/rest/api/core/bitstreamformats/5"
Expand Down
3 changes: 2 additions & 1 deletion bitstreams.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,8 @@ Provide detailed information about a specific bitstream. The JSON response docum
"value": "9d8f0f9e369cf12159d47c146c499cf4"
},
"sequenceId": null,
"type": "bitstream"
"type": "bitstream",
"uniqueType": "core.bitstream"
}
```

Expand Down
2 changes: 2 additions & 0 deletions browses.md
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,7 @@ Provide detailed information about a specific browse index and access to the lis
],
"order": "ASC",
"type": "browse",
"uniqueType": "discover.browse",
"metadata": [
"dc.date.issued"
]
Expand Down Expand Up @@ -122,6 +123,7 @@ Provide detailed information about a specific hierarchical browse index and acce
"facetType": "subject",
"vocabulary": "srsc",
"type": "browse",
"uniqueType": "discover.browse",
"metadata": [
"dc.subject"
],
Expand Down
3 changes: 3 additions & 0 deletions bundles.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ Provide detailed information about a specific bundle. A sample JSON response doc
]
},
"type": "bundle",
"uniqueType": "core.bundle",
"_links" : {
"primarybitstream" : {
"href" : "https://demo.dspace.org/server/api/core/bitstreams/ac49f361-4ffd-47a4-8eb2-e6c73c3f3e76"
Expand Down Expand Up @@ -77,6 +78,7 @@ Provide detailed information about a specific bundle. A sample JSON response doc
},
"sequenceId" : null,
"type" : "bitstream",
"uniqueType": "core.bitstream",
"_links" : {
"content" : {
"href" : "https://demo.dspace.org/server/api/core/bitstreams/1ce6db0e-662f-4a13-ba87-c371ad664b14/content"
Expand Down Expand Up @@ -123,6 +125,7 @@ Provide detailed information about a specific bundle. A sample JSON response doc
},
"sequenceId" : null,
"type" : "bitstream",
"uniqueType": "core.bitstream",
"_links" : {
"content" : {
"href" : "https://demo.dspace.org/server/api/core/bitstreams/4dd9621f-a464-4192-bc17-d70f68845bdc/content"
Expand Down
3 changes: 2 additions & 1 deletion claimedtasks.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,8 @@ Provide details about a specific task in the pool. The JSON response document is
"id": 1,
"step": "editstep",
"action": "editaction",
"type": "claimedtask"
"type": "claimedtask",
"uniqueType": "workflow.claimedtask"
}
```

Expand Down
4 changes: 3 additions & 1 deletion collections.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,8 @@ Provide detailed information about a specific collection. The JSON response docu
}
]
},
"type": "collection"
"type": "collection",
"uniqueType": "core.collection"
}
```

Expand Down Expand Up @@ -394,6 +395,7 @@ The json representation is as follow
"groupUUID": "11cc35e5-a11d-4b64-b5b9-0052a5d15509",
"action": "DEFAULT_BITSTREAM_READ",
"type": "resourcePolicy",
"uniqueType": "authz.resourcePolicy"
"_links": {
"self": {
"href": "https://demo.dspace.org/server/api/authz/resourcePolicies/2844"
Expand Down
3 changes: 2 additions & 1 deletion communities.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,8 @@ Provide detailed information about a specific community. The JSON response docum
}
]
},
"type": "community"
"type": "community",
"uniqueType": "core.community"
}
```

Expand Down
4 changes: 3 additions & 1 deletion edititems.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,8 @@ Provide detailed information about a specific edititem. The JSON response docume
]
}
},
"type":"edititem"
"type":"edititem",
"uniqueType": "core.edititem"
}
```
Return codes:
Expand Down Expand Up @@ -68,6 +69,7 @@ The JSON response document is as follow
"label": null,
"submissionDefinition": "publication-edit",
"type": "edititemmode",
"uniqueType": "core.edititemmode",
"_links": {
"self": {
"href": "https://{dspace-cris-backend-url}/server/api/core/edititemmodes/FULL"
Expand Down
3 changes: 3 additions & 0 deletions entitytypes.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ A sample can be found at https://demo.dspace.org/server/#https://demo.dspace.org
"id": 1,
"label": "Publication",
"type": "entitytype",
"uniqueType": "core.entitytype",
"_links": {
"self": {
"href": "https://demo.dspace.org/server/api/core/entitytypes/1"
Expand All @@ -31,6 +32,7 @@ A sample can be found at https://demo.dspace.org/server/#https://demo.dspace.org
"id": 2,
"label": "Person",
"type": "entitytype",
"uniqueType": "core.entitytype",
"_links": {
"self": {
"href": "https://demo.dspace.org/server/api/core/entitytypes/2"
Expand Down Expand Up @@ -66,6 +68,7 @@ A sample can be found at https://demo.dspace.org/server/#https://demo.dspace.org
"id": 1,
"label": "Publication",
"type": "entitytype",
"uniqueType": "core.entitytype",
"_links": {
"self": {
"href": "https://demo.dspace.org/server/api/core/entitytypes/1"
Expand Down
3 changes: 3 additions & 0 deletions epersongroups.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@
},
"permanent": true,
"type": "group",
"uniqueType": "eperson.group",
"_links": {
"subgroups": {
"href": "https://demo.dspace.org/server/api/eperson/groups/617cf46b-535c-42d5-9d22-327ce2eff6dc/subgroups"
Expand Down Expand Up @@ -120,6 +121,7 @@ Sample:
"metadata": {},
"permanent": true,
"type": "group",
"uniqueType": "eperson.group",
"_links": {
"subgroups": {
"href": "https://demo.dspace.org/server/api/eperson/groups/617cf46b-535c-42d5-9d22-327ce2eff6dc/subgroups"
Expand Down Expand Up @@ -256,6 +258,7 @@ Sample:
"selfRegistered": false,
"groups": null,
"type": "eperson",
"uniqueType": "eperson.eperson",
"_links": {
"self": {
"href": "https://demo.dspace.org/server/api/eperson/epersons/a6086b34-3918-45b7-8ddd-9329a702a26a"
Expand Down
8 changes: 6 additions & 2 deletions epersonregistrations.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,8 @@ Also exposes whether it's a new user registration, or a password reset for an ex
"id": 1,
"email": "[email protected]",
"user": null,
"type": "registration"
"type": "registration",
"uniqueType": "eperson.registration"
}
```
2. User registration linked to an eperson:
Expand All @@ -32,7 +33,8 @@ Also exposes whether it's a new user registration, or a password reset for an ex
"id": 2,
"email": "[email protected]",
"user": "028dcbb8-0da2-4122-a0ea-254be49ca107",
"type": "registration"
"type": "registration",
"uniqueType": "eperson.registration"
}
```
3. User registration done using **orcid** that didn't provide an email:
Expand All @@ -42,6 +44,7 @@ Also exposes whether it's a new user registration, or a password reset for an ex
"email": null,
"user": "028dcbb8-0da2-4122-a0ea-254be49ca107",
"type": "registration",
"uniqueType": "eperson.registration",
"registrationType": "orcid",
"netId": "0000-1111-2222-3333",
"registrationMetadata": {
Expand Down Expand Up @@ -87,6 +90,7 @@ Also exposes whether it's a new user registration, or a password reset for an ex
"email": "[email protected]",
"user": "028dcbb8-0da2-4122-a0ea-254be49ca107",
"type": "registration",
"uniqueType": "eperson.registration",
"registrationType": "orcid",
"netId": "0000-1111-2222-3333",
"registrationMetadata": {
Expand Down
1 change: 1 addition & 0 deletions epersons.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,7 @@
"selfRegistered": true,
"machineTokenGenerated": true,
"type": "eperson",
"uniqueType": "eperson.eperson",
"_links": {
"self": {
"href": "https://demo.dspace.org/server/api/eperson/epersons/028dcbb8-0da2-4122-a0ea-254be49ca107"
Expand Down
9 changes: 8 additions & 1 deletion external-authority-sources.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ Example:
"name": "orcid",
"hierarchical": false,
"type": "externalsource",
"uniqueType": "integration.externalsource",
"_links": {
"entries": {
"href": "https://demo.dspace.org/server/api/integration/externalsources/orcid/entries"
Expand All @@ -33,6 +34,7 @@ Example:
"name": "ciencia",
"hierarchical": false,
"type": "externalsource",
"uniqueType": "integration.externalsource",
"_links": {
"entries": {
"href": "https://demo.dspace.org/server/api/integration/externalsources/ciencia/entries"
Expand All @@ -50,6 +52,7 @@ Example:
"name": "my_staff_db",
"hierarchical": false,
"type": "externalsource",
"uniqueType": "integration.externalsource",
"_links": {
"entries": {
"href": "https://demo.dspace.org/server/api/integration/externalsources/my_staff_db/entries"
Expand Down Expand Up @@ -87,7 +90,8 @@ Provide detailed information about a specific external source. The JSON response
"id": "orcid",
"name": "orcid",
"hierarchical": false,
"type": "externalsource"
"type": "externalsource",
"uniqueType": "integration.externalsource"
}
```

Expand Down Expand Up @@ -219,6 +223,7 @@ sample for an external source /server/api/integration/externalsources/orcid/entr
"type" : "item"
}],
"type": "externalSourceEntry",
"uniqueType": "integration.externalSourceEntry"
"_links": {
"authority": {
"href": "https://demo.dspace.org/server/api/integration/authorities/authors/entryValues/d4b5ca88-9d6d-4a87-b905-fef0f8cae26c"
Expand Down Expand Up @@ -274,6 +279,7 @@ sample for an external source /server/api/integration/externalsources/orcid/entr
]
},
"type": "externalSourceEntry",
"uniqueType": "integration.externalSourceEntry",
"_links": {
"entity": {
"href": "https://demo.dspace.org/server/api/core/item/6fd90bf5-b84f-47b3-aaec-a55bde3a2a5a"
Expand Down Expand Up @@ -303,6 +309,7 @@ sample for an external source /api/integration/externalsources/orcid/entryValues
"display": "Smith, Dean",
"value": "Smith, Dean",
"type": "externalSourceEntry",
"uniqueType": "integration.externalSourceEntry",
"externalSource": "orcid",
"metadata": {
"dc.identifier.orcid": [
Expand Down
3 changes: 2 additions & 1 deletion features.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,8 @@ Provide detailed information about a specific feature. Access is restricted to s
"resourcetypes": [
"core.item"
],
"type": "feature"
"type": "feature",
"uniqueType": "authz.feature"
}
```

Expand Down
5 changes: 4 additions & 1 deletion identifiers.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,8 @@ On success, the identifier resource is returned as a response.
"value" : "https://doi.org/10.33515/dspace-61",
"identifierType" : "doi",
"identifierStatus" : "TO_BE_REGISTERED",
"type" : "identifier"
"type" : "identifier",
"uniqueType": "pid.identifier"
}
```

Expand All @@ -53,6 +54,7 @@ Return an array of identifiers associated with the given item.
"identifierType": "doi",
"identifierStatus": "TO_BE_REGISTERED",
"type": "identifier",
"uniqueType": "pid.identifier",
"_links": {
"self": {
"href": "http://localhost:8080/server/api/ppid/identifiers"
Expand All @@ -65,6 +67,7 @@ Return an array of identifiers associated with the given item.
"identifierType": "handle",
"identifierStatus": null,
"type": "identifier",
"uniqueType": "pid.identifier",
"_links": {
"self": {
"href": "http://localhost:8080/server/api/ppid/identifiers"
Expand Down
1 change: 1 addition & 0 deletions item-requests.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ Provide detailed information about a specific request. The JSON response documen
"acceptRequest":false,
"allfiles":false,
"type":"itemrequest",
"uniqueType": "tools.itemrequest",
"bitstreamId":"dca2dadb-7028-40a9-ab39-1a47726df7ef",
"itemId":"71d9fb0c-cc36-41c1-b1d3-63887b414fca",
"requestEmail":"[email protected]",
Expand Down
Loading

0 comments on commit a498c12

Please sign in to comment.