Get multiple Submitted Tasks
Read the data for multiple Submitted Tasks.
query Parameters
Success
Bad Request
Forbidden
Not Found
Method Not Allowed
Internal Server Error
- 200
- 400
- 403
- 404
- 405
- 500
{- "result": {
- "previousPageUrl": "string",
- "nextPageUrl": "string",
- "itemCount": 1,
- "totalItemCount": 20,
- "items": [
- {
- "_type": "dataItemType",
- "displayName": "string",
- "guid": "6c556cd8-ac27-4167-844c-f00ddb170b3f",
- "batchProcessReference": {
- "_type": "dataItemType",
- "displayName": "string",
- "guid": "6c556cd8-ac27-4167-844c-f00ddb170b3f"
}, - "batchProcessTableName": "string",
- "batchUserConnectionGUID": "6c556cd8-ac27-4167-844c-f00ddb170b3f",
- "commandReference": {
- "_type": "dataItemType",
- "displayName": "string",
- "guid": "6c556cd8-ac27-4167-844c-f00ddb170b3f"
}, - "comment": "string",
- "completedCountNumber": 0,
- "endDatetime": "2019-08-24T14:15:22Z",
- "entityReference": {
- "_type": "dataItemType",
- "displayName": "string",
- "guid": "6c556cd8-ac27-4167-844c-f00ddb170b3f"
}, - "formattedDuration": "string",
- "modifiedByUserReference": {
- "_type": "dataItemType",
- "displayName": "string",
- "guid": "6c556cd8-ac27-4167-844c-f00ddb170b3f"
}, - "modifiedDatetime": "2019-08-24T14:15:22Z",
- "percentCompleteNumber": 0,
- "runTimeSecondsNumber": 0,
- "sid": 1,
- "startDatetime": "2019-08-24T14:15:22Z",
- "statusReference": {
- "_type": "dataItemType",
- "displayName": "string",
- "guid": "6c556cd8-ac27-4167-844c-f00ddb170b3f"
}, - "submittedByUserReference": {
- "_type": "dataItemType",
- "displayName": "string",
- "guid": "6c556cd8-ac27-4167-844c-f00ddb170b3f"
}, - "submittedDatetime": "2019-08-24T14:15:22Z",
- "systemModifiedDatetime": "2019-08-24T14:15:22Z",
- "totalCountNumber": 0
}
]
}, - "errors": [ ],
- "warnings": [ ],
- "hasErrors": false,
- "hasWarnings": false
}
Get a single Submitted Task
Read the data for a specific Submitted Task.
path Parameters
query Parameters
minimal | boolean When you specify this Verbosity parameter, the |
default | boolean Use this Verbosity parameter option when you want Alliant API to return a response that includes all properties for the Item, including UD Fields. This is the default option that is used when no Verbosity parameter is provided. |
verbose | boolean Use this Verbosity parameter option when you want Alliant API to return UD Field Lookups, Adjustments on Tab, Child Collection, and Cross-Reference properties in addition to the properties from the default Verbosity level. Note: Using this parameter may affect performance and should only be used when necessary. |
include | string Use this Verbosity parameter to specify the properties to include in the response, separated by commas. You can also specify that you want to include Adjustments on Tab, Cross-Reference data Items, Child Items, and Child fields in the response. When you set the Verbosity of the response to minimal or default, Items only display as much information as the Verbosity parameter allows. You can use the ChildDataItem.ChildPropertyName syntax to specify when you want to return additional Child properties. Note: When the values specified in the include parameter are not valid, the query parameter is ignored and a warning is added to response includes property1, childItem1 child collection, childProperty2 of childItem2 collection, udLookup_UDField1 UD Field lookup collection. include=property1,childItem1,childItem2.childProperty2,udLookup_UDField1 |
exclude | string Use this Verbosity parameter to specify the properties to exclude from the response, separated by commas. You can also specify that you want to exclude Adjustments on Tab, Cross-Reference data Items, Child Items, and Child fields from the response. You can use the ChildDataItem.ChildPropertyName syntax to specify when you want to exclude specific Child properties. Note: When the values specified in the exclude parameter are not valid, the query parameter is ignored and a warning is added to response includes all properies according to Verbosity parameter, except for property1, childItem1 collection, childProperty2 of childItem2 collection, and udLookup_UDField1 UD Field lookup collection. exclude=property1,childItem1,childItem2.childProperty2,udLookup_UDField1 |
autoLogOff | boolean Use the autoLogOff parameter to log off Alliant API, discard the Alliant session Security Token, and release the Alliant license currently in use by Alliant API once the request completes. |
Successful Operation
Forbidden
Not Found
Method Not Allowed
Internal Server Error
- 200
- 403
- 404
- 405
- 500
{- "result": {
- "_type": "dataItemType",
- "displayName": "string",
- "guid": "6c556cd8-ac27-4167-844c-f00ddb170b3f",
- "batchProcessReference": {
- "_type": "dataItemType",
- "displayName": "string",
- "guid": "6c556cd8-ac27-4167-844c-f00ddb170b3f"
}, - "batchProcessTableName": "string",
- "batchUserConnectionGUID": "6c556cd8-ac27-4167-844c-f00ddb170b3f",
- "commandReference": {
- "_type": "dataItemType",
- "displayName": "string",
- "guid": "6c556cd8-ac27-4167-844c-f00ddb170b3f"
}, - "comment": "string",
- "completedCountNumber": 0,
- "endDatetime": "2019-08-24T14:15:22Z",
- "entityReference": {
- "_type": "dataItemType",
- "displayName": "string",
- "guid": "6c556cd8-ac27-4167-844c-f00ddb170b3f"
}, - "formattedDuration": "string",
- "modifiedByUserReference": {
- "_type": "dataItemType",
- "displayName": "string",
- "guid": "6c556cd8-ac27-4167-844c-f00ddb170b3f"
}, - "modifiedDatetime": "2019-08-24T14:15:22Z",
- "percentCompleteNumber": 0,
- "runTimeSecondsNumber": 0,
- "sid": 1,
- "startDatetime": "2019-08-24T14:15:22Z",
- "statusReference": {
- "_type": "dataItemType",
- "displayName": "string",
- "guid": "6c556cd8-ac27-4167-844c-f00ddb170b3f"
}, - "submittedByUserReference": {
- "_type": "dataItemType",
- "displayName": "string",
- "guid": "6c556cd8-ac27-4167-844c-f00ddb170b3f"
}, - "submittedDatetime": "2019-08-24T14:15:22Z",
- "systemModifiedDatetime": "2019-08-24T14:15:22Z",
- "totalCountNumber": 0
}, - "errors": [
- { }
], - "warnings": [
- { }
], - "hasErrors": false,
- "hasWarnings": false
}
Update a Submitted Task
Update the data for a specific Submitted Task.
The request body that you submit should include all of the properties that you want to update. When you want to update a Child Data Item, you must specify a value for the _action
subproperty. The following actions are available for Child Data Items:
· add – specify this action when you want to add a new Item.
· delete – specify this action when you want to delete an Item.
· update – specify this action when you want to update data for an Item.
path Parameters
query Parameters
minimal | boolean When you specify this Verbosity parameter, the |
default | boolean Use this Verbosity parameter option when you want Alliant API to return a response that includes all properties for the Item, including UD Fields. This is the default option that is used when no Verbosity parameter is provided. |
verbose | boolean Use this Verbosity parameter option when you want Alliant API to return UD Field Lookups, Adjustments on Tab, Child Collection, and Cross-Reference properties in addition to the properties from the default Verbosity level. Note: Using this parameter may affect performance and should only be used when necessary. |
include | string Use this Verbosity parameter to specify the properties to include in the response, separated by commas. You can also specify that you want to include Adjustments on Tab, Cross-Reference data Items, Child Items, and Child fields in the response. When you set the Verbosity of the response to minimal or default, Items only display as much information as the Verbosity parameter allows. You can use the ChildDataItem.ChildPropertyName syntax to specify when you want to return additional Child properties. Note: When the values specified in the include parameter are not valid, the query parameter is ignored and a warning is added to response includes property1, childItem1 child collection, childProperty2 of childItem2 collection, udLookup_UDField1 UD Field lookup collection. include=property1,childItem1,childItem2.childProperty2,udLookup_UDField1 |
exclude | string Use this Verbosity parameter to specify the properties to exclude from the response, separated by commas. You can also specify that you want to exclude Adjustments on Tab, Cross-Reference data Items, Child Items, and Child fields from the response. You can use the ChildDataItem.ChildPropertyName syntax to specify when you want to exclude specific Child properties. Note: When the values specified in the exclude parameter are not valid, the query parameter is ignored and a warning is added to response includes all properies according to Verbosity parameter, except for property1, childItem1 collection, childProperty2 of childItem2 collection, and udLookup_UDField1 UD Field lookup collection. exclude=property1,childItem1,childItem2.childProperty2,udLookup_UDField1 |
forceTimestampValidation | boolean Use the forceTimestampValidation parameter to validate the Timestamp for the Items that you want to update. When you use this parameter, you must include the following in the request body:
|
autoLogOff | boolean Use the autoLogOff parameter to log off Alliant API, discard the Alliant session Security Token, and release the Alliant license currently in use by Alliant API once the request completes. |
Request Body schema: application/jsonrequired
Include as much information as possible regarding the Submitted Task
OK
Bad Request
Forbidden
Not Found
Method Not Allowed
Conflict
Unsupported Media Type
Internal Server Error
- Payload
{- "comment": "string"
}
- 200
- 400
- 403
- 404
- 405
- 409
- 415
- 500
{- "result": {
- "_type": "dataItemType",
- "displayName": "string",
- "guid": "6c556cd8-ac27-4167-844c-f00ddb170b3f",
- "batchProcessReference": {
- "_type": "dataItemType",
- "displayName": "string",
- "guid": "6c556cd8-ac27-4167-844c-f00ddb170b3f"
}, - "batchProcessTableName": "string",
- "batchUserConnectionGUID": "6c556cd8-ac27-4167-844c-f00ddb170b3f",
- "commandReference": {
- "_type": "dataItemType",
- "displayName": "string",
- "guid": "6c556cd8-ac27-4167-844c-f00ddb170b3f"
}, - "comment": "string",
- "completedCountNumber": 0,
- "endDatetime": "2019-08-24T14:15:22Z",
- "entityReference": {
- "_type": "dataItemType",
- "displayName": "string",
- "guid": "6c556cd8-ac27-4167-844c-f00ddb170b3f"
}, - "formattedDuration": "string",
- "modifiedByUserReference": {
- "_type": "dataItemType",
- "displayName": "string",
- "guid": "6c556cd8-ac27-4167-844c-f00ddb170b3f"
}, - "modifiedDatetime": "2019-08-24T14:15:22Z",
- "percentCompleteNumber": 0,
- "runTimeSecondsNumber": 0,
- "sid": 1,
- "startDatetime": "2019-08-24T14:15:22Z",
- "statusReference": {
- "_type": "dataItemType",
- "displayName": "string",
- "guid": "6c556cd8-ac27-4167-844c-f00ddb170b3f"
}, - "submittedByUserReference": {
- "_type": "dataItemType",
- "displayName": "string",
- "guid": "6c556cd8-ac27-4167-844c-f00ddb170b3f"
}, - "submittedDatetime": "2019-08-24T14:15:22Z",
- "systemModifiedDatetime": "2019-08-24T14:15:22Z",
- "totalCountNumber": 0
}, - "errors": [
- { }
], - "warnings": [
- { }
], - "hasErrors": false,
- "hasWarnings": false
}
Update a Submitted Task
Update the data for a specific Submitted Task.
The request body that you submit should include all of the properties that you want to update. When you want to update a Child Data Item, you must specify a value for the _action
subproperty. The following actions are available for Child Data Items:
· add – specify this action when you want to add a new Item.
· delete – specify this action when you want to delete an Item.
· update – specify this action when you want to update data for an Item.
path Parameters
query Parameters
minimal | boolean When you specify this Verbosity parameter, the |
default | boolean Use this Verbosity parameter option when you want Alliant API to return a response that includes all properties for the Item, including UD Fields. This is the default option that is used when no Verbosity parameter is provided. |
verbose | boolean Use this Verbosity parameter option when you want Alliant API to return UD Field Lookups, Adjustments on Tab, Child Collection, and Cross-Reference properties in addition to the properties from the default Verbosity level. Note: Using this parameter may affect performance and should only be used when necessary. |
include | string Use this Verbosity parameter to specify the properties to include in the response, separated by commas. You can also specify that you want to include Adjustments on Tab, Cross-Reference data Items, Child Items, and Child fields in the response. When you set the Verbosity of the response to minimal or default, Items only display as much information as the Verbosity parameter allows. You can use the ChildDataItem.ChildPropertyName syntax to specify when you want to return additional Child properties. Note: When the values specified in the include parameter are not valid, the query parameter is ignored and a warning is added to response includes property1, childItem1 child collection, childProperty2 of childItem2 collection, udLookup_UDField1 UD Field lookup collection. include=property1,childItem1,childItem2.childProperty2,udLookup_UDField1 |
exclude | string Use this Verbosity parameter to specify the properties to exclude from the response, separated by commas. You can also specify that you want to exclude Adjustments on Tab, Cross-Reference data Items, Child Items, and Child fields from the response. You can use the ChildDataItem.ChildPropertyName syntax to specify when you want to exclude specific Child properties. Note: When the values specified in the exclude parameter are not valid, the query parameter is ignored and a warning is added to response includes all properies according to Verbosity parameter, except for property1, childItem1 collection, childProperty2 of childItem2 collection, and udLookup_UDField1 UD Field lookup collection. exclude=property1,childItem1,childItem2.childProperty2,udLookup_UDField1 |
forceTimestampValidation | boolean Use the forceTimestampValidation parameter to validate the Timestamp for the Items that you want to update. When you use this parameter, you must include the following in the request body:
|
autoLogOff | boolean Use the autoLogOff parameter to log off Alliant API, discard the Alliant session Security Token, and release the Alliant license currently in use by Alliant API once the request completes. |
Request Body schema: application/jsonrequired
Include as much information as possible regarding the Submitted Task
OK
Bad Request
Forbidden
Not Found
Method Not Allowed
Conflict
Unsupported Media Type
Internal Server Error
- Payload
{- "comment": "string"
}
- 200
- 400
- 403
- 404
- 405
- 409
- 415
- 500
{- "result": {
- "_type": "dataItemType",
- "displayName": "string",
- "guid": "6c556cd8-ac27-4167-844c-f00ddb170b3f",
- "batchProcessReference": {
- "_type": "dataItemType",
- "displayName": "string",
- "guid": "6c556cd8-ac27-4167-844c-f00ddb170b3f"
}, - "batchProcessTableName": "string",
- "batchUserConnectionGUID": "6c556cd8-ac27-4167-844c-f00ddb170b3f",
- "commandReference": {
- "_type": "dataItemType",
- "displayName": "string",
- "guid": "6c556cd8-ac27-4167-844c-f00ddb170b3f"
}, - "comment": "string",
- "completedCountNumber": 0,
- "endDatetime": "2019-08-24T14:15:22Z",
- "entityReference": {
- "_type": "dataItemType",
- "displayName": "string",
- "guid": "6c556cd8-ac27-4167-844c-f00ddb170b3f"
}, - "formattedDuration": "string",
- "modifiedByUserReference": {
- "_type": "dataItemType",
- "displayName": "string",
- "guid": "6c556cd8-ac27-4167-844c-f00ddb170b3f"
}, - "modifiedDatetime": "2019-08-24T14:15:22Z",
- "percentCompleteNumber": 0,
- "runTimeSecondsNumber": 0,
- "sid": 1,
- "startDatetime": "2019-08-24T14:15:22Z",
- "statusReference": {
- "_type": "dataItemType",
- "displayName": "string",
- "guid": "6c556cd8-ac27-4167-844c-f00ddb170b3f"
}, - "submittedByUserReference": {
- "_type": "dataItemType",
- "displayName": "string",
- "guid": "6c556cd8-ac27-4167-844c-f00ddb170b3f"
}, - "submittedDatetime": "2019-08-24T14:15:22Z",
- "systemModifiedDatetime": "2019-08-24T14:15:22Z",
- "totalCountNumber": 0
}, - "errors": [
- { }
], - "warnings": [
- { }
], - "hasErrors": false,
- "hasWarnings": false
}
Delete a Submitted Task
Delete a specific Submitted Task.
path Parameters
OK
Forbidden
Method Not Allowed
Conflict
Internal Server Error
- 200
- 403
- 405
- 409
- 500
{- "result": null,
- "errors": [ ],
- "warnings": [ ],
- "hasErrors": false,
- "hasWarnings": false
}
Execute the Resubmit Tool on a single Submitted Task
Execute the Resubmit Tool on a single Submitted Task.
OK
Bad Request
Forbidden
Not Found
Method Not Allowed
Internal Server Error
- 200
- 400
- 403
- 404
- 405
- 500
{- "result": null,
- "errors": [ ],
- "warnings": [ ],
- "hasErrors": false,
- "hasWarnings": false
}
Execute the Cancel Tool on a single Submitted Task
Execute the Cancel Tool on a single Submitted Task.
OK
Bad Request
Forbidden
Not Found
Method Not Allowed
Internal Server Error
- 200
- 400
- 403
- 404
- 405
- 500
{- "result": null,
- "errors": [ ],
- "warnings": [ ],
- "hasErrors": false,
- "hasWarnings": false
}