Gets the task reporting fields

GET /cs-close-api/task-definitions/{id}/reporting-fields

To retrieve task reporting fields based on a task definition ID, you can query the database or an API with the specified ID, which will return the relevant task definition and its associated reporting fields. This allows you to access task-specific data for reporting purposes.

Path parameters

  • id integer Required

    The identifier of the entity definition. Only task definitions defined for the specified entity definition report details will be returned

Responses

  • 200 application/json

    OK

    Hide response attributes Show response attributes object
    • taskName string

      The name of the task.

    • userDefinedFields array[object]

      All active reporting fields in the system and their values for this task.

      All active reporting fields in the system and their values for this task.

      Hide userDefinedFields attributes Show userDefinedFields attributes object
      • name string

        The name of the reporting field.

      • value object

        The value of the reporting field. This can be alphanumeric, numeric or null.
GET /cs-close-api/task-definitions/{id}/reporting-fields 
curl \
 --request GET 'http://close-service:8082/cs-close-api/task-definitions/{id}/reporting-fields'
Response examples (200) 
{
  "taskName": "string",
  "userDefinedFields": [
    {
      "name": "string",
      "value": {}
    }
  ]
}