...
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. | | #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 | | | {{[id | #sort_id]}} | #sort_name]}} | #sort_countitems]}} | Respective field info | Respective field info | | |||||||||
| | | Return a community logo | | - | - | Contains community logo (bitstream) | | ||||||||||||||||
| | | Return a list of all collections in the system. | - | The list of the collections containing respective fields. | | #rcodes] | |||||||||||||||||
| ]]></ac:plain-text-body></ac:structured-macro> |
|
| | Return a community logo | | - | - | Contains community logo (bitstream) | | Return detailed information about | | Fields of the collection entity. | | ||||||||||
| | | Return a list of all collections particular data field found in the systemcollection
element): id - entity identifier, internal to the system name - collection name licence - collection licence items - items contained in collection handle - handle of the collection (unique persistent resource identifier) canedit - states user permission on the collection (edit) communities - communities collection is a part of countItems - number of the items in the collection type - entity type (object type in the system) shortDescription - short description of the collection introText - introductory text for the collection copyrightText - copyright text for the collection sidebarText - sidebar text for the collection provenance - provenance | | | Respective field info | | |||||||||||||||||
| | | Return a list of the items in the system | - | ||||||||||||||||||||
- | The list of the items containing related | - | | {{[id | #sort_id]}} | The list of the collections containing respective fields . | |
| ||||||||||||||||
| | | Return detailed information about | | | {{[id | #sort_id]}} | Fields of the collection entity. | | Fields of the item entity. | | 200, 204, 400, 500 | ||||||||||||
| | | Return a particular data field found fould in the collection item
element): id - entity identifier, internal to the system name - collection name licence - collection licence items - items contained in collection handle - handle of the collection (unique persistent resource identifier) canedit - states user permission on the collection (edit) communities - communities collection is a part of countItems - number of the items in the collection type - entity type (object type in the system) shortDescription - short description of the collection introText - introductory text for the collection copyrightText - copyright text for the collection sidebarText - sidebar text for the collection provenance - provenance | | | #immediateonly]}} | {{[id | #sort_id]}} | Respective field info | | ||||||||||||||
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="918018cd-6e2a-4883-97f6-f6887d5cd4f9"><ac:plain-text-body><![CDATA[ |
| | | Return a list of the items in the system | - | | ||||||||||||||||||
| | - | 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) | | - | 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 . | | - | The list of the items containing related fields .
|
| <ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="638cd323-51e4-418d-925d-e64008a66799"><ac:plain-text-body><![CDATA[ |
| | | Return detailed information about an item. | | | | Fields of the item entity. | | 200, 204, 400, 500 | |||
| | | Return a particular data field fould in the item | ite_elements | ite_elements | Fields supported (for | | - | 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||||||||||||||||||||||
group object | | - | Fields of the group entity. | | 200, 204, 400, 500 | |||||||||||||||||||
| | | 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) | | - | Respective field info | | | - | 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="d9f5f172-a775-42f9-ad5d-6bacb6adfda8"><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="a0985af5-d723-4767-8630-e72deab8c51f"><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 ||||||||||||||||||||||
| Anchor | gro_elements | gro_elements | Supported fields (for | | - | 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="a94cfabe-6cb9-4723-9535-8b2ec9e1a26e"><ac:plain-text-body><![CDATA[ |
| | | Return a list of the users in the system | - | | - | The list of the users containing related [fields | #use_elements] . | | 200, 204, 400, 500 | |||
| | | Return a list of the users in the system | - | - | The list of the users containing related fields . | | 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="192a9139-1e9b-4052-95db-14beb4390c3f"><ac:plain-text-body><![CDATA[ | ||||||||||||||
| | | Return a user info | | | - | [Fields#use_elements] of the user entity. | | 200,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 <ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="ecdf99e4-0df7-4f49-8360-550ef39ca1b5"><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.
...