GET /api/v2/shared-items
List of current account Shared Items


GET /api/v2/shared-items/:id
Show a Shared Item

Params

Param name Description
id
required

Shared Item ID

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hyphen(-) with no leading or trailing space.


POST /api/v2/shared-items
Create shared item

Params

Param name Description
data
required

shared item information

Validations:

  • Must be a Hash

data[type]
required

Validations:

data[attributes]
required

Validations:

  • Must be a Hash

data[attributes][permission]
required

Share permission

Validations:

  • Must be a String

data[relationships]
required

Validations:

  • Must be a Hash

data[relationships][account]
required

Validations:

  • Must be a Hash

data[relationships][account][data]
required

Validations:

  • Must be a Hash

data[relationships][account][data][type]
required

should be `accounts`

Validations:

  • Must be a String

data[relationships][account][data][id]
required

Account ID

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hyphen(-) with no leading or trailing space.

data[relationships][shareable]
required

Validations:

  • Must be a Hash

data[relationships][shareable][data]
required

Validations:

  • Must be a Hash

data[relationships][shareable][data][type]
required

asset type: which can be `locker-items`, `watchlists`

Validations:

  • Must be a String

data[relationships][shareable][data][id]
required

asset ID

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hyphen(-) with no leading or trailing space.


PATCH /api/v2/shared-items/:id
Update a shared item

Params

Param name Description
id
required

shared item ID

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hyphen(-) with no leading or trailing space.

data
required

shared item information

Validations:

  • Must be a Hash

data[type]
optional

Validations:

data[attributes]
optional

Validations:

  • Must be a Hash

data[attributes][permission]
optional

Share permission

Validations:

  • Must be a String

data[relationships]
optional

Validations:

  • Must be a Hash

data[relationships][account]
optional

Validations:

  • Must be a Hash

data[relationships][account][data]
optional

Validations:

  • Must be a Hash

data[relationships][account][data][type]
optional

should be `accounts`

Validations:

  • Must be a String

data[relationships][account][data][id]
optional

Account ID

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hyphen(-) with no leading or trailing space.

data[relationships][shareable]
optional

Validations:

  • Must be a Hash

data[relationships][shareable][data]
optional

Validations:

  • Must be a Hash

data[relationships][shareable][data][type]
optional

asset type: which can be `locker-items`, `watchlists`

Validations:

  • Must be a String

data[relationships][shareable][data][id]
optional

asset ID

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hyphen(-) with no leading or trailing space.


DELETE /api/v2/shared-items/:id
Delete a shared item

Params

Param name Description
id
required

Shared Item ID

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hyphen(-) with no leading or trailing space.