...
C | Verb | URL | Description | Mandatory parameters | Optional parameters | Sorting fields | Response Data | Formats | Response codes | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| | | Returns a list of all communities on the system or return just top level communities. | - | The list of communities containing respective fields . | | |||||||||||||||||||||
| | | Return detailed information about | | | - | [Fields | #com_elements] describing community. | | [200, 400, 404, 500 | #rcodes] | ]]></ac:plain-text-body></ac:structured-macro> | |||||||||||||||
| |
| |
| Return a particular data field found in the community
element): id - entity identifier, internal to the system name - entity name countItems - number of items under community handle - handle of the community (unique persistent resource identifier) type - entity type (object type in the system) collections - collections contained in the community, ordered by id canedit - states user persmission on the community (editing) anchestor - anchestors of the community children - subcommunities, ordered by id administrators - group administrators, ordered by id recent - recent items in the community shortDescription - short description copyrightText - copyright text sidebarText - sidebar text introductoryText - introductory text | | Respective field info | | |||||||||||||||||||
| | | Return a community logo | | - | - | Contains community logo (bitstream) | | |||||||||||||||||||
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="2bfce481-e9c0-4876-81e7-c1302339e08d"><ac:plain-text-body><![CDATA[ {{ | {{[id | #sort_id]}} | #sort_name]}} | #sort_countitems]}} | Respective field info | | [ |
| | | Return a list of all collections in the system. | - | The list of the collections containing respective fields. | | 200, 204, 400, 500 | #rcodes] | ]]></ac:plain-text-body></ac:structured-macro> | ||||||||||
| |
|
| |
| Return detailed information about | | Fields of the collection entity. | - | Contains community logo (bitstream) | | ||||||||||||||||
| |
| Return a particular data field found list of all collections in the collection | col_elements | col_elements | Fields supported (for | Respective field info | |
| | | Return a list of the items in the system | - | - | - | - | | {{[id | #sort_id]}} | The list of the collections containing respective fields. |
| | |||||
| | | Return detailed information about an item. | - |
| Fields of the item entity. | | {{[id | #sort_id]}} | Fields of the collection entity. | | ||||||||||||||||
| | | Return a particular data field fould found in the item collection
element): metadata - item metadata submitter - submitter group isArchived - archival status of the item isWithdrawn - states if the item is withdrawn owningCollection - owning collection of the item lastModified - last modified time collections - collections the item appears in communities - communities the item appears is name - name of the item bitstreams - bitstreams related to the item handle - item handle (unique identified) canedit - states can user edit the item id - item id type - element type bundles - bundles related to the item | | - | - | Respective field info | | 200, 204, 400, 500 | ||||||||||||||||||
| | | Return bitstream object - usually the library item file. | | - | - | Fields of the bitstream entity. | | 200, 400, 401, 403, 404, 500 |
| | | Return a particular data field found in bitstream |||||||||||||||
| Anchor | bit_elements | bit_elements | Supported fields (for|||||||||||||||||||||||||
| | | #immediateonly]}} | {{[id | #sort_id]}} | Respective field info | | ||||||||||||||||||||
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="b1c07cf8-4fb1-4bcd-b7ab-09dba51924ed"><ac:plain-text-body><![CDATA[ |
| | | Return a list of the items in the system | - | | |||||||||||||||||||||
- | The list of the items containing related fields . |
|
| ||||||||||||||||||||||||
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="940c34c6-0a0a-4541-8e71-a2c073bf3a7c"><ac:plain-text-body><![CDATA[ |
| | | Return detailed information about an item. | | | | Fields of the item entity. | | | - | - | Respective field info | | 200, 400, 401, 403, 404, 500 | ||||||||||||
| | | Return bitstream | | - | - | Return bitstream | | 200, 400, 401, 403, 404, 500 | ||||||||||||||||||
| | | Return a list of the groups in the system | - | - | - | The list of the groups containing related fields . | 200, 204, 400, 500 | |||||||||||||||||||
| |
| Return a group object | | - | - | Fields of the group entity. | | 200, 204, 400, 500 |
| |
| Return a particular data field found fould in the group entity item
element): handle - unique id (external) id - internal id of the gruop isEmpty - is the group empty members - group members (as users) memberGroups - group members (as groups) name - group name type - entity type (referring to group) Fields supported (for element): metadata - item metadata submitter - submitter group isArchived - archival status of the item isWithdrawn - states if the item is withdrawn owningCollection - owning collection of the item lastModified - last modified time collections - collections the item appears in communities - communities the item appears is name - name of the item bitstreams - bitstreams related to the item handle - item handle (unique identified) canedit - states can user edit the item id - item id type - element type bundles - bundles related to the item <ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="1100380e-6741-4f31-8312-154ca8209db7"><ac:plain-text-body><![CDATA[ | | | - | Respective field info | | 200, 204, 400, 500 | ||||||||
| | | Return bitstream object - usually the library item file. | | - | - | Fields of the bitstream entity. | | 200, 400, 401, 403, 404, 500 | ||||||||||||||||||
| | | Return a particular data field found in bitstream
Supported fields (for element): mimeType - mime type of file bundles - bundles the bitstream is a part of checkSum - checksum of the file checkSumAlgorithm - checksum algorithm used description - bitstream description formatDescription - file format description sequenceId - sequence id of the file size - size of the file source - source (typically filename with path information) storeNumber - asset store number where the bitstream is stored userFormatDescription - user's format description name - bitstream name handle - unique id of the bitstream id - internal id of the bitstream type - type of the entity (referring to bitstream) <ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="57c20973-e748-46f1-8f0c-8143ffeb757c"><ac:plain-text-body><![CDATA[ | | | - | Respective field info | | 200, 400, 401, 403, 404, 500 | ]]></ac:plain-text-body></ac:structured-macro> | |||||||||||||||||
| | | Return bitstream | | - | - | Return bitstream | | 200, 400, 401, 403, 404, 500 | ||||||||||||||||||
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="6054cc3e-3a18-4d38-808f-b66b1112c927"><ac:plain-text-body><![CDATA[ |
| | | Return a list of the groups in the system | - | | - | The list of the groups containing related [fields | #gru_elements] . | | 200, 204, 400, 500 | ||||||||||||||||
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="d49aad33-11c3-47b9-8827-4b2aabcc5a84"><ac:plain-text-body><![CDATA[ |
| | | Return a group object | | | - | [Fields | #gro_elements] of the group entity. | | 200, 204, 400, 500 | ]]></ac:plain-text-body></ac:structured-macro> | |||||||||||||||
| | | Return a particular data field found in the group entity
Supported fields (for element): handle - unique id (external) id - internal id of the gruop isEmpty - is the group empty members - group members (as users) memberGroups - group members (as groups) name - group name type - entity type (referring to group) <ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="cd409395-4316-4a21-a9a6-3706b28647ce"><ac:plain-text-body><![CDATA[ | | | - | Respective field info | | 200, 204, 400, 500 | ]]></ac:plain-text-body></ac:structured-macro> | |||||||||||||||||
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="15b513b9-93b5-489d-8319-4ddf20532c6d"><ac:plain-text-body><![CDATA[ |
| | | Return a list of the users in the system | - | | - | The list of the users containing related [fields | #use_elements] . | | - | - | Respective field info | | 200,204,400,500 |
| | | Return a list of the users in the system | - | - | - | The list of the users containing related fields . | | ]]></ac:plain-text-body></ac:structured-macro> | ||
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="affd0fe5-75a1-486e-bcfb-c80c77c755e6"><ac:plain-text-body><![CDATA[ 200,204,400,500 |
| | | Return a user info | | | - | [Fields | #use_elements] of the user entity. | | 200,204,400,500 204,400,500 | ]]></ac:plain-text-body></ac:structured-macro> | |||||||||||||||
| | | Return a particular data field found in the user
Supported fields (for element): email - user's email firstName - first name fullName - full name handle - handle (unique, external) id - internal id of the user language - preferred language lastName - last name name - name netId - network id requireCertificate - requires certificate to login selfRegistered - is user self registered id - internal id of the user language - preferred language lastName - last name name - name netId - network id requireCertificate - requires certificate to login selfRegistered - is user self registered <ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="922b3813-ef72-484f-aafd-76e2fbc6f037"><ac:plain-text-body><![CDATA[ type - type of the object | | | - | Respective field info | | 200,204,400,500 | ]]></ac:plain-text-body></ac:structured-macro> |
Note: modifier idOnly is referred only to first layer of the results. For all other layers (e.g. nested results) only ids are returned in some cases, due to possible loops. Example: for community containing collections, on second level the response contains only ids for some elements where multiple loops may be created (community->has_collection->has_community....). Other data is modified according to idOnly flag.
...