PUT api/v1/Fulfillment/Job
Request Information
URI Parameters
Body Parameters
Job| Name | Description | Type | Additional information |
|---|---|---|---|
| Id | integer | ||
| JobTypeId | TJobType | ||
| JobIdentifier | globally unique identifier | ||
| ClientId | integer | ||
| StartDate | date | ||
| EndDate | date | ||
| PercentComplete | integer | ||
| RequestingUserId | integer | ||
| TotalRecords | integer | ||
| SuccessfulRecords | integer | ||
| ErrorRecords | integer | ||
| JobStatusId | TJobStatus | ||
| Notes | string | ||
| JobDetails | Collection of JobDetail | ||
| ModifiedDateTime |
Modified datetime for the object. This will be added by the system. |
date | |
| ExecutionTime |
How long the method took in milliseconds. System supplied value. |
integer | |
| TxID |
Transaction ID of the call. Will be added for the response. Not needed in the request. |
string |
Request Formats
application/json, text/json
Sample:
{
"id": 1,
"jobTypeId": "Unknown",
"jobIdentifier": "f904492a-69ef-4da9-979c-6b98245acf67",
"clientId": 1,
"startDate": "2025-08-14T01:25:46.9871243+00:00",
"endDate": "2025-08-14T01:25:46.9871243+00:00",
"percentComplete": 5,
"requestingUserId": 1,
"totalRecords": 6,
"successfulRecords": 7,
"errorRecords": 8,
"jobStatusId": 0,
"notes": "sample string 9",
"jobDetails": [
{
"id": 1,
"jobId": 2,
"objectName": "sample string 3",
"objectId": 4,
"modifiedDateTime": "2025-08-14T01:25:46.9871243+00:00",
"executionTime": 7,
"txID": "sample string 8"
},
{
"id": 1,
"jobId": 2,
"objectName": "sample string 3",
"objectId": 4,
"modifiedDateTime": "2025-08-14T01:25:46.9871243+00:00",
"executionTime": 7,
"txID": "sample string 8"
}
],
"modifiedDateTime": "2025-08-14T01:25:46.9871243+00:00",
"executionTime": 12,
"txID": "sample string 13"
}
application/x-www-form-urlencoded
Sample:
Sample not available.
application/xml
Sample:
Sample not available.
text/xml
Sample:
Sample not available.
Response Information
Resource Description
Job| Name | Description | Type | Additional information |
|---|---|---|---|
| Id | integer | ||
| JobTypeId | TJobType | ||
| JobIdentifier | globally unique identifier | ||
| ClientId | integer | ||
| StartDate | date | ||
| EndDate | date | ||
| PercentComplete | integer | ||
| RequestingUserId | integer | ||
| TotalRecords | integer | ||
| SuccessfulRecords | integer | ||
| ErrorRecords | integer | ||
| JobStatusId | TJobStatus | ||
| Notes | string | ||
| JobDetails | Collection of JobDetail | ||
| ModifiedDateTime |
Modified datetime for the object. This will be added by the system. |
date | |
| ExecutionTime |
How long the method took in milliseconds. System supplied value. |
integer | |
| TxID |
Transaction ID of the call. Will be added for the response. Not needed in the request. |
string |
Response Formats
application/json, text/json
Sample:
{
"id": 1,
"jobTypeId": "Unknown",
"jobIdentifier": "9c8f8683-b8bb-40a2-97bb-65841fb5d845",
"clientId": 1,
"startDate": "2025-08-14T01:25:47.0496173+00:00",
"endDate": "2025-08-14T01:25:47.0496173+00:00",
"percentComplete": 5,
"requestingUserId": 1,
"totalRecords": 6,
"successfulRecords": 7,
"errorRecords": 8,
"jobStatusId": 0,
"notes": "sample string 9",
"jobDetails": [
{
"id": 1,
"jobId": 2,
"objectName": "sample string 3",
"objectId": 4,
"modifiedDateTime": "2025-08-14T01:25:47.0496173+00:00",
"executionTime": 7,
"txID": "sample string 8"
},
{
"id": 1,
"jobId": 2,
"objectName": "sample string 3",
"objectId": 4,
"modifiedDateTime": "2025-08-14T01:25:47.0496173+00:00",
"executionTime": 7,
"txID": "sample string 8"
}
],
"modifiedDateTime": "2025-08-14T01:25:47.0496173+00:00",
"executionTime": 12,
"txID": "sample string 13"
}
application/xml
Sample:
Sample not available.
text/xml
Sample:
Sample not available.