GET API/V1/Customization/TasksProcesses

Request Information

URI Parameters

NameDescriptionTypeAdditional information
Id

Direct lookup by Identifier.Id. When provided, all other filters are ignored; a non-matching id (or an id of a different entity type) yields 404.

integer

None.

NameContains

Case-insensitive substring match on Identifier.Description (task/process name).

string

None.

ExternalCode

Exact, case-sensitive match on Identifier.Code. May match multiple items.

string

None.

OrderingType

Filters by element type. Allowed values: "task", "process" (case-insensitive). Omitted: both tasks and processes are returned.

string

None.

Body Parameters

None.

Response Information

Resource Description

Collection of iMDsoft.API.Metavision.Data.Customization.TaskProcessCustomization
NameDescriptionTypeAdditional information
Identifier

Primary identifier: Id (MetaVision id), Code (external code, may be null), Description (task/process name).

iMDsoft.API.Metavision.Data.Data.CodedElement

None.

OrderingType

Element type. One of: "task", "process".

string

None.

Routes

Allowed routes (mode + selected list). Null/omitted when not configured.

iMDsoft.API.Metavision.Data.Customization.RouteSpec

None.

Frequencies

Allowed frequencies (mode + selected list).

iMDsoft.API.Metavision.Data.Customization.FrequencySpec

None.

AdditionalInformation

Configured additional information entries. Empty array if none.

Collection of iMDsoft.API.Metavision.Data.Customization.TaskProcessAdditionalInformation

None.

EffortNumberOfCareGivers

Number of caregivers required. Applies to tasks only (0 and null are distinct); omitted for processes.

integer

None.

EffortDuration

Task duration in minutes. Applies to tasks only (0 and null are distinct); omitted for processes.

integer

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "identifier": {
      "id": 1,
      "code": "sample string 1",
      "description": "sample string 2"
    },
    "orderingType": "sample string 1",
    "routes": {
      "mode": "sample string 1",
      "selected": [
        {
          "id": 1,
          "code": "sample string 1",
          "description": "sample string 2"
        },
        {
          "id": 1,
          "code": "sample string 1",
          "description": "sample string 2"
        }
      ]
    },
    "frequencies": {
      "mode": "sample string 1",
      "selected": [
        {
          "id": 1,
          "code": "sample string 1",
          "description": "sample string 2"
        },
        {
          "id": 1,
          "code": "sample string 1",
          "description": "sample string 2"
        }
      ]
    },
    "additionalInformation": [
      {
        "type": "sample string 1",
        "name": "sample string 2",
        "availableFor": "sample string 3",
        "text": "sample string 4",
        "parameterId": 1,
        "parameterValue": "sample string 5",
        "url": "sample string 6"
      },
      {
        "type": "sample string 1",
        "name": "sample string 2",
        "availableFor": "sample string 3",
        "text": "sample string 4",
        "parameterId": 1,
        "parameterValue": "sample string 5",
        "url": "sample string 6"
      }
    ]
  },
  {
    "identifier": {
      "id": 1,
      "code": "sample string 1",
      "description": "sample string 2"
    },
    "orderingType": "sample string 1",
    "routes": {
      "mode": "sample string 1",
      "selected": [
        {
          "id": 1,
          "code": "sample string 1",
          "description": "sample string 2"
        },
        {
          "id": 1,
          "code": "sample string 1",
          "description": "sample string 2"
        }
      ]
    },
    "frequencies": {
      "mode": "sample string 1",
      "selected": [
        {
          "id": 1,
          "code": "sample string 1",
          "description": "sample string 2"
        },
        {
          "id": 1,
          "code": "sample string 1",
          "description": "sample string 2"
        }
      ]
    },
    "additionalInformation": [
      {
        "type": "sample string 1",
        "name": "sample string 2",
        "availableFor": "sample string 3",
        "text": "sample string 4",
        "parameterId": 1,
        "parameterValue": "sample string 5",
        "url": "sample string 6"
      },
      {
        "type": "sample string 1",
        "name": "sample string 2",
        "availableFor": "sample string 3",
        "text": "sample string 4",
        "parameterId": 1,
        "parameterValue": "sample string 5",
        "url": "sample string 6"
      }
    ]
  }
]