Process

Gets a list of Process objects started by the currently logged in User.

get

Path parameters

strTokenstringRequired

The login token

strTypestringOptional

Optional filter for Process type

Responses

200

Success

application/json

Response of a List Processes request.

requestIDinteger · int64Optional

Progressive number of the request (since the Server started). Use this number, together with the RequestDateTime property, to report an anomalous reponse.

requestDateTimestring · date-timeOptional

Timestamp of the request. Use this timestamp, together with the RequestID property, to report an anomalous reponse.

resultCodeinteger · int32Optional

Result code. A code of 0 means no errors. When the request fails, its value is indicative of the actual error.

resultMessagestring · nullableOptional

Result message. A message of Ok means no errors.

get

/api/v2/Processes/{strToken}/{strType}

HTTPcURLJavaScriptPython

GET /api/v2/Processes/{strToken}/{strType} HTTP/1.1
Accept: */*

200

Success

{
  "processes": [
    {
      "processID": "text",
      "memoriID": "text",
      "processUserName": "text",
      "processType": "text",
      "status": "text",
      "error": "text",
      "totalElements": 1,
      "processedElements": 1,
      "progress": 1,
      "processSpecsJSON": "text",
      "begin": "2026-06-09T12:22:13.140Z",
      "end": "2026-06-09T12:22:13.140Z",
      "eta": 1,
      "creationTimestamp": "2026-06-09T12:22:13.140Z",
      "lastChangeTimestamp": "2026-06-09T12:22:13.140Z"
    }
  ],
  "requestID": 1,
  "requestDateTime": "2026-06-09T12:22:13.140Z",
  "resultCode": 1,
  "resultMessage": "text"
}

Gets a list of Process objects for the specified Memori.

get

Path parameters

strTokenstringRequired

The login token

strMemoriIDstringRequired

The ID of the Memori object

strTypestringOptional

Optional filter for Process type

Responses

200

Success

application/json

Response of a List Processes request.

requestIDinteger · int64Optional

Progressive number of the request (since the Server started). Use this number, together with the RequestDateTime property, to report an anomalous reponse.

requestDateTimestring · date-timeOptional

Timestamp of the request. Use this timestamp, together with the RequestID property, to report an anomalous reponse.

resultCodeinteger · int32Optional

Result code. A code of 0 means no errors. When the request fails, its value is indicative of the actual error.

resultMessagestring · nullableOptional

Result message. A message of Ok means no errors.

get

/api/v2/MemoriProcesses/{strToken}/{strMemoriID}/{strType}

HTTPcURLJavaScriptPython

GET /api/v2/MemoriProcesses/{strToken}/{strMemoriID}/{strType} HTTP/1.1
Accept: */*

200

Success

{
  "processes": [
    {
      "processID": "text",
      "memoriID": "text",
      "processUserName": "text",
      "processType": "text",
      "status": "text",
      "error": "text",
      "totalElements": 1,
      "processedElements": 1,
      "progress": 1,
      "processSpecsJSON": "text",
      "begin": "2026-06-09T12:22:13.140Z",
      "end": "2026-06-09T12:22:13.140Z",
      "eta": 1,
      "creationTimestamp": "2026-06-09T12:22:13.140Z",
      "lastChangeTimestamp": "2026-06-09T12:22:13.140Z"
    }
  ],
  "requestID": 1,
  "requestDateTime": "2026-06-09T12:22:13.140Z",
  "resultCode": 1,
  "resultMessage": "text"
}

Gets the status of an Process object.

get

Path parameters

strTokenstringRequired

The login token

strProcessIDstringRequired

The Process object ID

Responses

200

Success

application/json

Response of an Import, Analysis or Get Process Status requests.

requestIDinteger · int64Optional

Progressive number of the request (since the Server started). Use this number, together with the RequestDateTime property, to report an anomalous reponse.

requestDateTimestring · date-timeOptional

Timestamp of the request. Use this timestamp, together with the RequestID property, to report an anomalous reponse.

resultCodeinteger · int32Optional

Result code. A code of 0 means no errors. When the request fails, its value is indicative of the actual error.

resultMessagestring · nullableOptional

Result message. A message of Ok means no errors.

get

/api/v2/ProcessStatus/{strToken}/{strProcessID}

HTTPcURLJavaScriptPython

GET /api/v2/ProcessStatus/{strToken}/{strProcessID} HTTP/1.1
Accept: */*

200

Success

{
  "status": {
    "processID": "text",
    "memoriID": "text",
    "processUserName": "text",
    "processType": "text",
    "status": "text",
    "error": "text",
    "totalElements": 1,
    "processedElements": 1,
    "progress": 1,
    "processSpecsJSON": "text",
    "begin": "2026-06-09T12:22:13.140Z",
    "end": "2026-06-09T12:22:13.140Z",
    "eta": 1,
    "creationTimestamp": "2026-06-09T12:22:13.140Z",
    "lastChangeTimestamp": "2026-06-09T12:22:13.140Z"
  },
  "requestID": 1,
  "requestDateTime": "2026-06-09T12:22:13.140Z",
  "resultCode": 1,
  "resultMessage": "text"
}

Interrupts an ongoing Process object.

post

Path parameters

strTokenstringRequired

The login token

strProcessIDstringRequired

The Process object ID

Responses

200

Success

application/json

Response of an Import, Analysis or Get Process Status requests.

requestIDinteger · int64Optional

Progressive number of the request (since the Server started). Use this number, together with the RequestDateTime property, to report an anomalous reponse.

requestDateTimestring · date-timeOptional

Timestamp of the request. Use this timestamp, together with the RequestID property, to report an anomalous reponse.

resultCodeinteger · int32Optional

Result code. A code of 0 means no errors. When the request fails, its value is indicative of the actual error.

resultMessagestring · nullableOptional

Result message. A message of Ok means no errors.

post

/api/v2/StopProcess/{strToken}/{strProcessID}

HTTPcURLJavaScriptPython

POST /api/v2/StopProcess/{strToken}/{strProcessID} HTTP/1.1
Accept: */*

200

Success

{
  "status": {
    "processID": "text",
    "memoriID": "text",
    "processUserName": "text",
    "processType": "text",
    "status": "text",
    "error": "text",
    "totalElements": 1,
    "processedElements": 1,
    "progress": 1,
    "processSpecsJSON": "text",
    "begin": "2026-06-09T12:22:13.140Z",
    "end": "2026-06-09T12:22:13.140Z",
    "eta": 1,
    "creationTimestamp": "2026-06-09T12:22:13.140Z",
    "lastChangeTimestamp": "2026-06-09T12:22:13.140Z"
  },
  "requestID": 1,
  "requestDateTime": "2026-06-09T12:22:13.140Z",
  "resultCode": 1,
  "resultMessage": "text"
}