Actions

Given a resource, looks at its status. SUCCESS will mean action has been successfully terminated.

GEThttps://api.cegedim.cloud/itcare/actions

Authorization

oauth2

Query parameters

Response

200400

OK

Body

*/*

processstring

Code of action performed

statusenum

Status label of action

SUCCESS,IN_PROGRESS,ERROR

messagestring

Human readable message of status

idinteger (int64)

submittedAtstring (date-time)

completedAtstring (date-time)

lastUpdatedAtstring (date-time)

submittedBystring

resourceTypestring

resourceNamestring

familystring

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://api.cegedim.cloud/itcare/actions', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400

[
  {
    "process": "text",
    "status": "SUCCESS,IN_PROGRESS,ERROR",
    "message": "text",
    "id": 1,
    "submittedAt": "2025-02-05T03:55:48.276Z",
    "completedAt": "2025-02-05T03:55:48.276Z",
    "lastUpdatedAt": "2025-02-05T03:55:48.276Z",
    "submittedBy": "text",
    "resourceType": "text",
    "resourceName": "text",
    "family": "text"
  }
]

Use this method to look for status of an asynchronously launched action (with 202 status code). SUCCESS will mean action has been successfully terminated.

GEThttps://api.cegedim.cloud/itcare/actions/{actionId}

Authorization

oauth2

Path parameters

actionId*integer (int64)

Response

200400

OK

Body

*/*

processstring

Code of action performed

statusenum

Status label of action

SUCCESS,IN_PROGRESS,ERROR

messagestring

Human readable message of status

idinteger (int64)

submittedAtstring (date-time)

completedAtstring (date-time)

lastUpdatedAtstring (date-time)

submittedBystring

resourceTypestring

resourceNamestring

familystring

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://api.cegedim.cloud/itcare/actions/{actionId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400

{
  "process": "text",
  "status": "SUCCESS,IN_PROGRESS,ERROR",
  "message": "text",
  "id": 1,
  "submittedAt": "2025-02-05T03:55:48.276Z",
  "completedAt": "2025-02-05T03:55:48.276Z",
  "lastUpdatedAt": "2025-02-05T03:55:48.276Z",
  "submittedBy": "text",
  "resourceType": "text",
  "resourceName": "text",
  "family": "text"
}