Profile Services

Public Services

Service Requires Access Token? Example Notes
Count all profiles in a collection No /api/v1/opus/[opusId]/count[?includeArchived=false] Counts all profiles in the collection. Optionally include archived profiles using includeArchived (default: false)
Export all profiles in a collection (results are paged) Yes /api/v1/opus/[opusId]/export[?max=1000&offset=0&includeArchived=false&summary=false]
max
The maximum number of profiles to retrieve (profiles will be sorted alphabetically by name). Default: 500.
offset
The 0-based index of the profile to start from (profiles will be sorted alphabetically by name). Default: 0.
includeArchived
Whether to include archived profiles in the export. Default: false.
summary
Whether to generate a summary of the included profiles. If true, only the profile name details, name attributes and the summary attribute will be included. If false, all data will be included. Default: false.

Some services require an Access Token for the target collection.

Access tokens can be generated by the Collection Administrator. Services that do not require an Access Token cannot be used to retrieve data from private collections.

Admin Tools