Skip to content

Licenses

Gives access to the available licenses on the server.

Fields#

  • pk: int
  • name: str
  • url: str
  • domains: array of str (Software/Models/Data)
  • permissions: array of str
  • limitations: array of str
  • conditions: array of str

Actions#

List#

Lists the licences present on the server.

Method#

POST

URL#

/v1/licences/list /v1/licenses/list

Permissions#
Body (optional)#
Response#
  • A JSON array of objects containing each licence's fields

Create#

Creates a new licence.

Method#

POST

URL#

/v1/licences/create /v1/licenses/create

Body#
  • name: str
  • url: str
Permissions#
Response#
  • A JSON object containing the newly-created licence's fields

Retrieve#

Gets the information about a specific licence.

Method#

GET

URL#

/v1/licences/{PK} /v1/licenses/{PK}

Parameters#
  • PK: int (primary key of the licence)
Permissions#
Response#
  • A JSON object containing the licence's fields

Update#

Updates a specific licence.

Method#

PUT

URL#

/v1/licences/{PK} /v1/licenses/{PK}

Parameters#
  • PK: int (primary key of licence)
Body#
  • name: str
  • url: str
Permissions#
Response#
  • A JSON object containing the updated licence's fields

Partial Update#

Updates a specific licence.

Method#

PATCH

URL#

/v1/licences/{PK} /v1/licenses/{PK}

Parameters#
  • PK: int (primary key of the licence)
Body#
  • name (optional): str
  • url (optional): str
Permissions#
Response#
  • A JSON object containing the updated licence's fields

Destroy#

Deletes a licence from the server.

Method#

DELETE

URL#

/v1/licences/{PK} /v1/licenses/{PK}

Parameters#
  • PK: int (primary key of the licence)
Permissions#

Modify Subdescriptors#

Modifies the domains, permissions, limitations and conditions of a licence.

Method#

PATCH

URL#

/v1/licences/{PK}/subdescriptors /v1/licenses/{PK}/subdescriptors

Parameters#
  • PK: int (primary key of the licence)
Body#
  • type: str (one of: "domains", "permissions", "limitations", "conditions")
  • method: str (one of: "add", "remove")
  • names: array of str (the type sub-descriptors to add to/remove from the licence)
Permissions#
Response#
  • A JSON object containing the updated licence's fields