System Tools API (1.6.0)

APIs for InsuranceSuite system tools

Starts the batch process

Starts the batch process. If the batch process was already running, no new process is started. The response will indicate whether a new process was actually started, based on whether the processId property is populated. (Since 1.5.0)

gw-resourceType: BatchProcess

gw-sinceVersion: 1.5.0

Authorizations:

basicAuth

path Parameters

batchProcessType

required

string

gw-sinceVersion: 1.5.0

The type of the batch process (Since 1.5.0)

query Parameters

fields

Array of strings

gw-allowForCompositeApi: true

Allows the caller to specify the set of fields that should be included on the response. This can be used to limit the set of fields returned as well as to include optional fields that otherwise wouldn't normally be returned. The parameter is either of the form fields=<field list> or fields=<include>:<field list>, where <field list> consists of a comma-separated list of field or field set names. See the documentation for more information.

Request Body schema: application/json

object (BatchProcessStartData)

Responses

Request samples

Payload

Content type

application/json

{"data": {"attributes": {"dbconsistencycheck": {"checkTypes": ["string"
],
"description": "string",
"rerunKey": 0,
"tableNames": ["string"
]
},
"purgeAsyncApiRequests": {"purgeDaysOld": 1
}
},
"checksum": "string",
"id": "string",
"links": {"property1": {"href": "string",
"methods": ["string"
]
},
"property2": {"href": "string",
"methods": ["string"
]
}
},
"method": "post",
"refid": "string",
"related": {"property1": {"count": 0,
"data": [{"displayName": "string",
"id": "string",
"refid": "string",
"type": "string",
"uri": "string"
}
],
"total": 0
},
"property2": {"count": 0,
"data": [{"displayName": "string",
"id": "string",
"refid": "string",
"type": "string",
"uri": "string"
}
],
"total": 0
}
},
"uri": "string"
}
}

Response samples

Content type

application/json

{"data": {"attributes": {"distributed": true,
"processId": 0,
"status": {"dateCompleted": "2019-08-24T14:15:22Z",
"dateCreated": "2019-08-24T14:15:22Z",
"failedOps": 0,
"failureReason": "string",
"opsCompleted": 0,
"opsExpected": 0,
"progress": "string",
"serverId": "string",
"startDate": "2019-08-24T14:15:22Z",
"type": "string"
},
"type": {"code": "string",
"name": "string"
},
"wasStopped": true,
"workQueueStatus": {"numActiveExecutors": 0,
"numActiveWorkItems": 0
}
},
"checksum": "string",
"id": "string",
"links": {"property1": {"href": "string",
"methods": ["string"
]
},
"property2": {"href": "string",
"methods": ["string"
]
}
},
"method": "post",
"refid": "string",
"related": {"property1": {"count": 0,
"data": [{"displayName": "string",
"id": "string",
"jsonPath": "string",
"refid": "string",
"type": "string",
"uri": "string"
}
],
"total": 0
},
"property2": {"count": 0,
"data": [{"displayName": "string",
"id": "string",
"jsonPath": "string",
"refid": "string",
"type": "string",
"uri": "string"
}
],
"total": 0
}
},
"type": "string",
"uri": "string"
}
}

Was this page helpful?