Revision as of 14:01, June 23, 2020 by Peter Chaplin (talk | contribs)
Jump to: navigation, search

Get common task attributes for modification

Method

Up to 9.0.012

GET

From 9.0.013

POST

Important
The new request has exactly the same parameters as the old one and allows you to pass the ql_expression in the request body in JSON format.

Syntax

Up to 9.0.012

GET /gtl/tasks/{solutionDbid}/{page}

From 9.0.013

POST /gtl/tasks/{solutionDbid}/{page}/search

Request Body

Up to 9.0.012

Either:

{
    "content": {
        "include": [ <task_id1>, <task_id2>, ...]
}

Or:

{
    "content": {
        "exclude": [ <task_id1>, <task_id2>, ...]
}

From 9.0.013

Either:

{
    "content": {
        "include": [ <task_id1>, <task_id2>, ...]
    },
    "qlExpression": [<ql_item>, <ql_item>, ...]
}

Or:

{
    "content": {
        "exclude": [ <task_id1>, <task_id2>, ...]
    },
    "qlExpression": [<ql_item>, <ql_item>, ...]
}

Notes

  • It is not allowed to send both "include" and "exclude" lists.
  • snapshot_id is mandatory.
  • The value for the qlExpression field is the same object as the request body from Fetch paginated list of tasks.

Response Body

{
  "attribute_definitions":
  [
    {
      "name": "<attribute name>",
      "label": "<localized attribute label>",
      "type": "<string/date/int/img/list>",
      "values":
       [
        {
         "value": "<name of value>",
         "label": "<display name>"
        },
        ...
     ],
      "category": "core/ext/data",
    },
    ...
  ],
  "attribute_values":
  {
    "core":
    {
        <attribute definitions>
    },
    "ext":
    {
        <attribute definitions>
    },
    "data":
    {
        <attribute definitions>
    }
  }
}
  • "attribute_definitions" contains only editable attributes.
  • "attribute_values" contains only attributes that have the same value for all the selected tasks.
Comments or questions about this documentation? Contact us for support!