API Docs
Get User Attachments
Contents
This API returns a list of a users attachments.
Resource URL
GET /almaws/v1/users/{user_id}/attachments
API Description
URL Parameters
Parameter | Type | Description |
---|---|---|
user_id | xs:string | A unique identifier for the user. |
Querystring Parameters
Parameter | Type | Required | Description |
---|---|---|---|
user_id_type | xs:string | Optional. Default: all_unique | The type of identifier that is being searched. Optional. If this is not provided, all unique identifier types are used. The values that can be used are any of the values in the User Identifier Type code table. |
limit | xs:int | Optional. Default: 10 | Limits the number of results. Optional. Valid values are 0-100. Default value: 10. |
offset | xs:int | Optional. Default: 0 | Offset of the results returned. Optional. Default value: 0, which means that the first results will be returned. |
expand | xs:string | Optional. | The expand parameter. Optional. Possible values: 'content' or 'content_no_encoding'. |
Body Parameters
None
Output
This method returns a Attachments
object. See doc
Possible Error Codes
Code | Message |
---|---|
60323 | Search for attachments failed. |
60100 | The parameter X must be a number greater than zero. |
412400 | User X not found. |