SOsoldo
Lists

Add List

Endpoint to add a new List.

post/business/v2/dictionaries

Request

Request body application/x-www-form-urlencoded

dictionarystring

The name of the List.

uniqueSelectTagboolean

It determines whether multiple Tags of the List can be selected.

requiredboolean

It determines required.

rolesstring[]

List of Roles to can view items in transaction details.

usersstring[]

List of User IDs to can view items in transaction details..

Example request

{
  "dictionary": "CustomTransactionMetadata",
  "uniqueSelectTag": true,
  "roles": [
    "7bf79328-a7ae-4222-aa54-091ff7f429a7",
    "2d65bd5e-3fdf-4002-b166-bde7fb8863fa"
  ],
  "users": [
    "XMPL1234-000001",
    "XMPL1234-000002",
    "XMPL1234-000003"
  ]
}

Response

The returned resource is a single List.

idstring

The ID of the List.

dictionarystring

The name of the List.

visibleboolean

It determines whether the List is active.

creation_timestring

The date and time when the List was created.

last_updatestring

The date and time when the List was last updated.

rolesstring[]

The list of Roles that can view the items in the transaction details.(sortable: no).

usersstring[]

The list of Users that can view the items in the transaction details. (sortable: no).

is_unique_select_tagboolean

It determines whether multiple tags of the List can be selected.

Example response

{
  "id": "7bf79328-a7ae-4222-aa54-091ff7f429a7",
  "dictionary": "ExampleTagDictionary",
  "visible": true,
  "creation_time": "2017-06-01T12:48:40Z",
  "last_update": "2017-06-01T12:48:40Z",
  "roles": [
    "7bf79328-a7ae-4222-aa54-091ff7f429a7",
    "2d65bd5e-3fdf-4002-b166-bde7fb8863fa"
  ],
  "users": [
    "XMPL1234-000001",
    "XMPL1234-000002",
    "XMPL1234-000003"
  ]
}

Changes

No recorded changes to this operation across all 10 revisions of this API.