Get all task properties

get https://{project_url}/webservice/rest-api/{api_interface}/{version}/task-properties

Get information about task properties.

Query Params

count

integer

≥ 1

Defaults to 100

The number of records to return in API response.
⚠️ We recommended adjust the batch size based on processing time. Depending on the response time of the request. Default value of 100 records is used if count parameter is not set.

offset

integer

≥ 0

Defaults to 0

The number of records from a collection to skip. Default value of 0 is used when parameter offset is not set.

sort_field

string

Name of the sorting parameter. You can sort by any of the first level parameters from the resource response. Response is sorted by the specified field.

sort_direction

string

Direction of sorting the response list.

name

string

Search record by name or a part of the name.

Headers

Accept-Language

string

Defaults to cs, en-gb;q=0.8

The unique ID of the language code by ISO 639-1.

Responses

Response body

object

data

object

task_properties

array of objects

List of all task properties.

task_properties

object

property_id

string

The unique ID of the property.

name

string

required

Name of the property.

description

string

User defined description of the property.

data_type

string

required

Data type of the final value. Possible values: string / boolean / integer / date / timestamp / float / customized data types

items

array of objects

List of possible values. Used for multivalued data types (like enum, multiselect).

items

object

string

The unique ID of the property item.

name

string

Name of the property item.

resource_record_id

string

The ID of the CareCloud REST API resource record is filled when the property is related directly to the CareCloud API resource (for example resource stores). Usually, the data type of the property determines it.

state

integer

State of the property item.
Possible values are: 0 - deleted / 1 - active / 2 - non active

1 2

is_required

boolean

required

The settings whether the property is a required parameter of the specific entity.

true

is_unique

boolean

required

The setting whether the property contains a unique value within the specific entity.

true

last_change

string

Date and time of the last change. (YYYY-MM-DD HH:MM:SS)

state

integer

State of the property
Possible values are: 0 - deleted / 1 - active

1 2

total_items

integer

The number of all found task properties.

429

Too many requests - more than the resource limit.

503

Temporary state when the service is temporarily unavailable, overloaded or there is a maintenance window.

Language

Credentials

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url 'https://sandbox.crmcarecloud.com/webservice/rest-api/enterprise-interface/v1.0/task-properties?count=100&offset=0' \
3
     --header 'Accept-Language: cs, en-gb;q=0.8' \
4
     --header 'accept: application/json'


xxxxxxxxxx
25
 
1
{
2
  "data": {
3
    "task_properties": [
4
      {
5
        "property_id": "size",
6
        "name": "Size",
7
        "description": "size",
8
        "data_type": "string",
9
        "items": [
10
          {
11
            "id": "8fd73167342d0689c4c015320",
12
            "name": "{\"en\":\"evening\",\"cz\":\"vecer\"}",
13
            "resource_record_id": "67342d3167342d0689c4c00689c4",
14
            "state": 1
15
          }
16
        ],
17
        "is_required": false,
18
        "is_unique": false,
19
        "last_change": "2019-06-20 14:48:09",
20
        "state": 1
21
      }
22
    ],
23
    "total_items": 1
24
  }
25
}

200OK

400Bad input parameter. Error message specifies the detail.

401The client has invalid credentials or auth token.

403The client does not exist or the client tried to access non authorized property/resource.

404The resource was not found.

405The resource does not support the specified HTTP method.

500Server is not working as expected.