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
get
GET /api/v2/Processes/{strToken}/{strType} HTTP/1.1
Host: 
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": "2025-07-13T11:31:18.219Z",
      "end": "2025-07-13T11:31:18.219Z",
      "eta": 1,
      "creationTimestamp": "2025-07-13T11:31:18.219Z",
      "lastChangeTimestamp": "2025-07-13T11:31:18.219Z"
    }
  ],
  "requestID": 1,
  "requestDateTime": "2025-07-13T11:31:18.219Z",
  "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
get
GET /api/v2/MemoriProcesses/{strToken}/{strMemoriID}/{strType} HTTP/1.1
Host: 
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": "2025-07-13T11:31:18.219Z",
      "end": "2025-07-13T11:31:18.219Z",
      "eta": 1,
      "creationTimestamp": "2025-07-13T11:31:18.219Z",
      "lastChangeTimestamp": "2025-07-13T11:31:18.219Z"
    }
  ],
  "requestID": 1,
  "requestDateTime": "2025-07-13T11:31:18.219Z",
  "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
get
GET /api/v2/ProcessStatus/{strToken}/{strProcessID} HTTP/1.1
Host: 
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": "2025-07-13T11:31:18.219Z",
    "end": "2025-07-13T11:31:18.219Z",
    "eta": 1,
    "creationTimestamp": "2025-07-13T11:31:18.219Z",
    "lastChangeTimestamp": "2025-07-13T11:31:18.219Z"
  },
  "requestID": 1,
  "requestDateTime": "2025-07-13T11:31:18.219Z",
  "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
post
POST /api/v2/StopProcess/{strToken}/{strProcessID} HTTP/1.1
Host: 
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": "2025-07-13T11:31:18.219Z",
    "end": "2025-07-13T11:31:18.219Z",
    "eta": 1,
    "creationTimestamp": "2025-07-13T11:31:18.219Z",
    "lastChangeTimestamp": "2025-07-13T11:31:18.219Z"
  },
  "requestID": 1,
  "requestDateTime": "2025-07-13T11:31:18.219Z",
  "resultCode": 1,
  "resultMessage": "text"
}
PreviousNotificationNextPwlUser