MassWorkflowJobDto

Example Json Object

  1{
  2  "id": 0,
  3  "taskCount": 0,
  4  "failedTaskCount": 0,
  5  "doneTaskCount": 0,
  6  "inProgressTaskCount": 0,
  7  "cancelledTaskCount": 0,
  8  "errorMessage": "string",
  9  "queueTime": "2019-08-24T14:15:22Z",
 10  "startTime": "2019-08-24T14:15:22Z",
 11  "endTime": "2019-08-24T14:15:22Z",
 12  "status": "CREATED",
 13  "executor": "SCHEDULER",
 14  "scheduleJobId": 0,
 15  "batchSize": 10,
 16  "totalObjectCount": 0,
 17  "readOnly": true,
 18  "profileId": 0,
 19  "unauthorized": true,
 20  "filter": {
 21    "id": 0,
 22    "profileId": 0,
 23    "jobId": 0,
 24    "name": "string",
 25    "principalPositionType": "LESSEE",
 26    "filterTypes": {
 27      "erpSystemFilterType": "ALL",
 28      "erpSystems": [
 29        {
 30          "id": 0,
 31          "displayId": "string",
 32          "status": "CREATED",
 33          "name": "string",
 34          "type": "NAKISA",
 35          "sapVersion": "ECC_EHP5"
 36        }
 37      ],
 38      "leaseAreaFilterType": "ALL",
 39      "leaseAreas": [
 40        {
 41          "id": 10000001,
 42          "displayId": "0001",
 43          "status": {
 44            "name": "ACTIVE",
 45            "captionKey": "enum.objectStatus.active",
 46            "active": true,
 47            "caption": "Active"
 48          },
 49          "name": "Global Lease Area"
 50        }
 51      ],
 52      "businessUnitFilterType": "ALL",
 53      "businessUnits": [
 54        {
 55          "id": 10000001,
 56          "displayId": "BU0001",
 57          "status": {
 58            "name": "ACTIVE",
 59            "captionKey": "enum.objectStatus.active",
 60            "active": true,
 61            "caption": "Active"
 62          },
 63          "name": "North America Business Unit"
 64        }
 65      ],
 66      "companyFilterType": "ALL",
 67      "companies": [
 68        {
 69          "id": 10000006,
 70          "displayId": "1005",
 71          "status": {
 72            "name": "ACTIVE",
 73            "captionKey": "enum.objectStatus.active",
 74            "active": true,
 75            "caption": "Active"
 76          },
 77          "erpSystemId": 10000001,
 78          "erpSystemDisplayId": "FINQ8S-300",
 79          "countryId": 10000095,
 80          "countryDisplayId": "CA",
 81          "postingPeriodVariantId": 0,
 82          "fiscalVariantId": 0
 83        }
 84      ],
 85      "leaseDepartmentFilterType": "ALL",
 86      "leaseDepartments": [
 87        {
 88          "id": 300001,
 89          "displayId": "DEP-01",
 90          "status": {
 91            "name": "ACTIVE",
 92            "captionKey": "enum.objectStatus.active",
 93            "active": true,
 94            "caption": "Active"
 95          },
 96          "name": "Finance Department"
 97        }
 98      ],
 99      "leaseGroupFilterType": "ALL",
100      "leaseGroups": [
101        {
102          "id": 60000001,
103          "displayId": "LG-001",
104          "status": {
105            "name": "ACTIVE",
106            "captionKey": "enum.objectStatus.active",
107            "active": true,
108            "caption": "Active"
109          },
110          "name": "Global Lease Group"
111        }
112      ],
113      "costCenterFilterType": "ALL",
114      "costCenters": [
115        {
116          "id": 14001,
117          "displayId": "CC-001",
118          "status": {
119            "name": "ACTIVE",
120            "captionKey": "enum.objectStatus.active",
121            "active": true,
122            "caption": "Active"
123          },
124          "name": "Cost Center A"
125        }
126      ],
127      "profitCenterFilterType": "ALL",
128      "profitCenters": [
129        {
130          "id": 9001,
131          "displayId": "PC-001",
132          "status": {
133            "name": "ACTIVE",
134            "captionKey": "enum.objectStatus.active",
135            "active": true,
136            "caption": "Active"
137          },
138          "name": "North Region Profit Center",
139          "validTo": "2025-12-31",
140          "erpSystemId": 101,
141          "erpSystemDisplayId": "SAP-01"
142        }
143      ],
144      "wbsFilterType": "ALL",
145      "wbses": [
146        {
147          "id": 1001,
148          "displayId": "WBS-2025-001",
149          "status": {
150            "name": "ACTIVE",
151            "captionKey": "enum.objectStatus.active",
152            "active": true,
153            "caption": "Active"
154          },
155          "name": "Main Project WBS"
156        }
157      ],
158      "businessAreaFilterType": "ALL",
159      "businessAreas": [
160        {
161          "id": 3001,
162          "displayId": "BA-2025-001",
163          "status": {
164            "name": "ACTIVE",
165            "captionKey": "enum.objectStatus.active",
166            "active": true,
167            "caption": "Active"
168          },
169          "name": "North America Operations"
170        }
171      ],
172      "functionalAreaFilterType": "ALL",
173      "functionalAreas": [
174        {
175          "id": 2001,
176          "displayId": "FA-2025-001",
177          "status": {
178            "name": "ACTIVE",
179            "captionKey": "enum.objectStatus.active",
180            "active": true,
181            "caption": "Active"
182          },
183          "name": "Accounting Department"
184        }
185      ]
186    },
187    "bypassFiltering": true,
188    "listObjectType": "MASTER_AGREEMENT",
189    "objectListDisplayIds": [
190      "string"
191    ]
192  },
193  "input": {
194    "id": 0,
195    "entityType": "MASTER_AGREEMENT",
196    "migratedFilterType": "MIGRATED",
197    "useDefaultWorkbookInput": true,
198    "initialState": "MLA_DEFINE",
199    "terminalState": "MLA_DEFINE",
200    "transitions": [
201      "MLA_DEFINE_TO_WAITING_FOR_APPROVAL"
202    ],
203    "intermediateStates": [
204      "MLA_DEFINE"
205    ],
206    "acceptsHitchhickers": true,
207    "dateType": "AG_ROU_DATES",
208    "postingDate": "2019-08-24",
209    "documentDate": "2019-08-24"
210  },
211  "processingStage": "CREATING",
212  "generatingXSSFWorkbookInputTemplate": true,
213  "startedGeneratingXSSFWorkbookInputTemplateAt": "2019-08-24T14:15:22Z"
214}

Properties

Name

Type

Required

Restrictions

Description

id

integer(int64)

false

none

none

taskCount

integer(int32)

false

none

none

failedTaskCount

integer(int32)

false

none

none

doneTaskCount

integer(int32)

false

none

none

inProgressTaskCount

integer(int32)

false

none

none

cancelledTaskCount

integer(int32)

false

none

none

errorMessage

string

false

none

none

queueTime

string(date-time)

false

none

none

startTime

string(date-time)

false

none

none

endTime

string(date-time)

false

none

none

status

string

false

none

none

executor

string

false

none

none

scheduleJobId

integer(int64)

false

none

none

batchSize

integer(int32)

false

none

none

totalObjectCount

integer(int32)

false

none

none

readOnly

boolean

false

none

none

profileId

integer(int64)

false

none

none

unauthorized

boolean

false

none

none

filter

MassWorkflowJobFilterDto

false

none

none

input

MassWorkflowJobInputDto

false

none

none

processingStage

string

false

none

none

generatingXSSFWorkbookInputTemplate

boolean

false

none

none

startedGeneratingXSSFWorkbookInputTemplateAt

string(date-time)

false

none

none

Enumerated Values

Attribute

Value

executor

MANUAL, SCHEDULER

processingStage

CANCELLED, CANCELLING, COMPLETED, CREATING, FAILED, GENERATING_WORKBOOK_TEMPLATE, INTERRUPTED, INTERRUPTING, PENDING_USER_INPUT, PROCESSING_MASS_WORKFLOW

status

CANCELLED, CANCELLING, CREATED, CREATING, DONE, FAILED, INTERRUPTED, INTERRUPTING, KILLING, PENDING, PROCESSING, SCHEDULED