User & Permission

Update a single resource - Catalog Permission

Replaces the PermissionCatalog resource.

put/permissions/catalogs/{id}

Request

  • Base URL
    https://{instance_name}.quable.com/api
  • URL
    https://{instance_name}.quable.com/api/permissions/catalogs/{id}
  • Auth
    API key in header Authorization

Path parameters

idstring required

Resource identifier

Request body

@idstring
@typestring
classificationsstring[] required

This array should contains collection of classification Identifiers. While POST or PUT, this array should contain every single value needed, while current values in the payload will replace existing ones.

usersIdentifier[]

This object should contains a collection of user identifiers

Example request

{
  "classifications": [
    "code_1",
    "code_2"
  ],
  "users": [
    "johndoe",
    "janedoe"
  ],
  "description": {
    "fr-FR": "fr-FR translation",
    "en-US": "en-US translation",
    "<*>": "..."
  },
  "name": {
    "fr-FR": "fr-FR translation",
    "en-US": "en-US translation",
    "<*>": "..."
  }
}

Response

PermissionCatalog resource updated

classificationsstring[]
dateCreatedstring date-time nullable

This is an ISO datetime

dateModifiedstring date-time nullable

This is an ISO datetime

idstring

This is the unique identifier of the resource

Example response

{
  "classifications": [
    "classification_id_1",
    "classification_id_2"
  ],
  "name": {
    "fr-FR": "fr-FR translation",
    "en-US": "en-US translation",
    "<*>": "..."
  },
  "description": {
    "fr-FR": "fr-FR translation",
    "en-US": "en-US translation",
    "<*>": "..."
  },
  "id": "identifier_example",
  "users": [
    {
      "id": "identifier_example"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.