Get multiple Scheduled Task Summaries
Read the data for multiple Scheduled Task Summaries.
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"
}, - "cancelReasonDescription": "string",
- "comment": "string",
- "contractGroupReference": {
- "_type": "dataItemType",
- "displayName": "string",
- "guid": "6c556cd8-ac27-4167-844c-f00ddb170b3f"
}, - "contractPriorityNumber": 0,
- "contractReference": {
- "_type": "dataItemType",
- "displayName": "string",
- "guid": "6c556cd8-ac27-4167-844c-f00ddb170b3f"
}, - "cssScheduledBySequenceNumber": 0,
- "dealPriorityNumber": 0,
- "dealReference": {
- "_type": "dataItemType",
- "displayName": "string",
- "guid": "6c556cd8-ac27-4167-844c-f00ddb170b3f"
}, - "dependencyGroupGUID": "6c556cd8-ac27-4167-844c-f00ddb170b3f",
- "dependencyGroupOrderNumber": 0,
- "dueDatetime": "2019-08-24T14:15:22Z",
- "groupPriorityNumber": 0,
- "jobQueueReference": {
- "_type": "dataItemType",
- "displayName": "string",
- "guid": "6c556cd8-ac27-4167-844c-f00ddb170b3f"
}, - "jobQueueStatusReference": {
- "_type": "dataItemType",
- "displayName": "string",
- "guid": "6c556cd8-ac27-4167-844c-f00ddb170b3f"
}, - "modifiedByUserReference": {
- "_type": "dataItemType",
- "displayName": "string",
- "guid": "6c556cd8-ac27-4167-844c-f00ddb170b3f"
}, - "modifiedDatetime": "2019-08-24T14:15:22Z",
- "ofTotalStatementsNumber": 0,
- "periodTypeReference": {
- "_type": "dataItemType",
- "displayName": "string",
- "guid": "6c556cd8-ac27-4167-844c-f00ddb170b3f"
}, - "postedPeriodReference": {
- "_type": "dataItemType",
- "displayName": "string",
- "guid": "6c556cd8-ac27-4167-844c-f00ddb170b3f"
}, - "preparerReference": {
- "_type": "dataItemType",
- "displayName": "string",
- "guid": "6c556cd8-ac27-4167-844c-f00ddb170b3f"
}, - "processingOrderNumber": 0,
- "runAsPreviewFlag": true,
- "scheduleTypeReference": {
- "_type": "dataItemType",
- "displayName": "string",
- "guid": "6c556cd8-ac27-4167-844c-f00ddb170b3f"
}, - "statementNumber": 0,
- "statementSID": 1,
- "systemModifiedDatetime": "2019-08-24T14:15:22Z",
- "taskStatusReference": {
- "_type": "dataItemType",
- "displayName": "string",
- "guid": "6c556cd8-ac27-4167-844c-f00ddb170b3f"
}, - "templateReference": {
- "_type": "dataItemType",
- "displayName": "string",
- "guid": "6c556cd8-ac27-4167-844c-f00ddb170b3f"
}
}
]
}, - "errors": [ ],
- "warnings": [ ],
- "hasErrors": false,
- "hasWarnings": false
}
Get a single Scheduled Task Summary
Read the data for a specific Scheduled Task Summary.
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
Bad Request
Forbidden
Not Found
Method Not Allowed
Internal Server Error
- 200
- 400
- 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"
}, - "cancelReasonDescription": "string",
- "comment": "string",
- "contractGroupReference": {
- "_type": "dataItemType",
- "displayName": "string",
- "guid": "6c556cd8-ac27-4167-844c-f00ddb170b3f"
}, - "contractPriorityNumber": 0,
- "contractReference": {
- "_type": "dataItemType",
- "displayName": "string",
- "guid": "6c556cd8-ac27-4167-844c-f00ddb170b3f"
}, - "cssScheduledBySequenceNumber": 0,
- "dealPriorityNumber": 0,
- "dealReference": {
- "_type": "dataItemType",
- "displayName": "string",
- "guid": "6c556cd8-ac27-4167-844c-f00ddb170b3f"
}, - "dependencyGroupGUID": "6c556cd8-ac27-4167-844c-f00ddb170b3f",
- "dependencyGroupOrderNumber": 0,
- "dueDatetime": "2019-08-24T14:15:22Z",
- "groupPriorityNumber": 0,
- "jobQueueReference": {
- "_type": "dataItemType",
- "displayName": "string",
- "guid": "6c556cd8-ac27-4167-844c-f00ddb170b3f"
}, - "jobQueueStatusReference": {
- "_type": "dataItemType",
- "displayName": "string",
- "guid": "6c556cd8-ac27-4167-844c-f00ddb170b3f"
}, - "modifiedByUserReference": {
- "_type": "dataItemType",
- "displayName": "string",
- "guid": "6c556cd8-ac27-4167-844c-f00ddb170b3f"
}, - "modifiedDatetime": "2019-08-24T14:15:22Z",
- "ofTotalStatementsNumber": 0,
- "periodTypeReference": {
- "_type": "dataItemType",
- "displayName": "string",
- "guid": "6c556cd8-ac27-4167-844c-f00ddb170b3f"
}, - "postedPeriodReference": {
- "_type": "dataItemType",
- "displayName": "string",
- "guid": "6c556cd8-ac27-4167-844c-f00ddb170b3f"
}, - "preparerReference": {
- "_type": "dataItemType",
- "displayName": "string",
- "guid": "6c556cd8-ac27-4167-844c-f00ddb170b3f"
}, - "processingOrderNumber": 0,
- "runAsPreviewFlag": true,
- "scheduleTypeReference": {
- "_type": "dataItemType",
- "displayName": "string",
- "guid": "6c556cd8-ac27-4167-844c-f00ddb170b3f"
}, - "statementNumber": 0,
- "statementSID": 1,
- "systemModifiedDatetime": "2019-08-24T14:15:22Z",
- "taskStatusReference": {
- "_type": "dataItemType",
- "displayName": "string",
- "guid": "6c556cd8-ac27-4167-844c-f00ddb170b3f"
}, - "templateReference": {
- "_type": "dataItemType",
- "displayName": "string",
- "guid": "6c556cd8-ac27-4167-844c-f00ddb170b3f"
}
}, - "errors": [
- { }
], - "warnings": [
- { }
], - "hasErrors": false,
- "hasWarnings": false
}
Execute the Approve Tool on a collection of Scheduled Task Summaries
Execute the Approve Tool on a collection of Scheduled Task Summaries. You must specify the collection of Scheduled Tasks that you want to approve using the filter parameter.
query Parameters
$filter required | string Use the $filter parameter to filter returned data Items in a manner similar to the Alliant User Applications column filter. This parameter uses the following format: {filterBy} {operator} {value}
You can use the and and or operators to combine multiple filter parameter criteria. The response includes only data Items with a displayName value that contains 'rin' $filter=displayName contains 'rin'The response includes only data Items with a comment value that ends with 'ing' $filter=comment endswith 'ing'The response includes only data Items with a description value that starts with 'str' $filter=description startswith 'str'The response includes a single data Item with an id value equal to 'ABC123' $filter=id eq 'ABC123'The response includes only data Items with a udfVersionNumber value equal to 1 $filter=udfVersionNumber ge 1The response includes only data Items with a displayName value that starts with 'rin' or data Items with a comment value that ends with 'ing' and data Items with description value that starts with 'str' $filter=(displayName contains 'rin' or comment endswith 'ing') and description startswith 'str'The response includes only data Items that have no Admin Class $filter=adminClassReference eq null | ||||||||||||||||||||||||||||||
submit required | integer Use the submit parameter to submit a Submitted Task request to execute the specified Scheduled Tasks Tool. This is a required parameter for Scheduled Tasks Tool endpoints. | ||||||||||||||||||||||||||||||
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. |
Request Body schema: application/json
Successful Operation
Bad Request
Forbidden
Not Found
Method Not Allowed
Conflict
Unsupported Media Type
Internal Server Error
- Payload
{- "submittedTaskComment": "string",
- "submittedTaskParms": {
- "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
}
Execute the Approve Tool on a single Scheduled Task Summary Item
Execute the Approve Tool on a single Scheduled Task Summary Item.
query Parameters
submit required | integer Use the submit parameter to submit a Submitted Task request to execute the specified Scheduled Tasks Tool. This is a required parameter for Scheduled Tasks Tool endpoints. |
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. |
Request Body schema: application/json
Successful Operation
Bad Request
Forbidden
Not Found
Method Not Allowed
Conflict
Unsupported Media Type
Internal Server Error
- Payload
{- "submittedTaskComment": "string",
- "submittedTaskParms": {
- "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
}
Execute the Assign Tool on a collection of Scheduled Task Summaries
Execute the Assign Tool on a collection of Scheduled Task Summaries. You must specify the collection of Scheduled Tasks that you want to assign using the filter parameter.
query Parameters
$filter required | string Use the $filter parameter to filter returned data Items in a manner similar to the Alliant User Applications column filter. This parameter uses the following format: {filterBy} {operator} {value}
You can use the and and or operators to combine multiple filter parameter criteria. The response includes only data Items with a displayName value that contains 'rin' $filter=displayName contains 'rin'The response includes only data Items with a comment value that ends with 'ing' $filter=comment endswith 'ing'The response includes only data Items with a description value that starts with 'str' $filter=description startswith 'str'The response includes a single data Item with an id value equal to 'ABC123' $filter=id eq 'ABC123'The response includes only data Items with a udfVersionNumber value equal to 1 $filter=udfVersionNumber ge 1The response includes only data Items with a displayName value that starts with 'rin' or data Items with a comment value that ends with 'ing' and data Items with description value that starts with 'str' $filter=(displayName contains 'rin' or comment endswith 'ing') and description startswith 'str'The response includes only data Items that have no Admin Class $filter=adminClassReference eq null | ||||||||||||||||||||||||||||||
submit required | integer Use the submit parameter to submit a Submitted Task request to execute the specified Scheduled Tasks Tool. This is a required parameter for Scheduled Tasks Tool endpoints. | ||||||||||||||||||||||||||||||
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. |
Request Body schema: application/json
Successful Operation
Bad Request
Forbidden
Not Found
Method Not Allowed
Conflict
Unsupported Media Type
Internal Server Error
- Payload
{- "submittedTaskComment": "string",
- "submittedTaskParms": {
- "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
}
Execute the Assign Tool on a single Scheduled Task Summary Item
Execute the Assign Tool on a single Scheduled Task Summary Item.
query Parameters
submit required | integer Use the submit parameter to submit a Submitted Task request to execute the specified Scheduled Tasks Tool. This is a required parameter for Scheduled Tasks Tool endpoints. |
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. |
Request Body schema: application/json
Successful Operation
Bad Request
Forbidden
Not Found
Method Not Allowed
Conflict
Unsupported Media Type
Internal Server Error
- Payload
{- "submittedTaskComment": "string",
- "submittedTaskParms": {
- "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
}
Execute the Clear Tool on a collection of Scheduled Task Summaries
Execute the Clear Tool on a collection of Scheduled Task Summaries. You must specify the collection of Scheduled Tasks that you want to clear using the filter parameter.
query Parameters
$filter required | string Use the $filter parameter to filter returned data Items in a manner similar to the Alliant User Applications column filter. This parameter uses the following format: {filterBy} {operator} {value}
You can use the and and or operators to combine multiple filter parameter criteria. The response includes only data Items with a displayName value that contains 'rin' $filter=displayName contains 'rin'The response includes only data Items with a comment value that ends with 'ing' $filter=comment endswith 'ing'The response includes only data Items with a description value that starts with 'str' $filter=description startswith 'str'The response includes a single data Item with an id value equal to 'ABC123' $filter=id eq 'ABC123'The response includes only data Items with a udfVersionNumber value equal to 1 $filter=udfVersionNumber ge 1The response includes only data Items with a displayName value that starts with 'rin' or data Items with a comment value that ends with 'ing' and data Items with description value that starts with 'str' $filter=(displayName contains 'rin' or comment endswith 'ing') and description startswith 'str'The response includes only data Items that have no Admin Class $filter=adminClassReference eq null | ||||||||||||||||||||||||||||||
submit required | integer Use the submit parameter to submit a Submitted Task request to execute the specified Scheduled Tasks Tool. This is a required parameter for Scheduled Tasks Tool endpoints. | ||||||||||||||||||||||||||||||
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. |
Request Body schema: application/json
Successful Operation
Bad Request
Forbidden
Not Found
Method Not Allowed
Conflict
Unsupported Media Type
Internal Server Error
- Payload
{- "submittedTaskComment": "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
}
Execute the Clear Tool on a single Scheduled Task Summary Item
Execute the Clear Tool on a single Scheduled Task Summary Item.
query Parameters
submit required | integer Use the submit parameter to submit a Submitted Task request to execute the specified Scheduled Tasks Tool. This is a required parameter for Scheduled Tasks Tool endpoints. |
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. |
Request Body schema: application/json
Successful Operation
Bad Request
Forbidden
Not Found
Method Not Allowed
Conflict
Unsupported Media Type
Internal Server Error
- Payload
{- "submittedTaskComment": "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
}
Execute the Hold Tool on a collection of Scheduled Task Summaries
Execute the Hold Tool on a collection of Scheduled Task Summaries. You must specify the collection of Scheduled Tasks that you want to hold using the filter parameter.
query Parameters
$filter required | string Use the $filter parameter to filter returned data Items in a manner similar to the Alliant User Applications column filter. This parameter uses the following format: {filterBy} {operator} {value}
You can use the and and or operators to combine multiple filter parameter criteria. The response includes only data Items with a displayName value that contains 'rin' $filter=displayName contains 'rin'The response includes only data Items with a comment value that ends with 'ing' $filter=comment endswith 'ing'The response includes only data Items with a description value that starts with 'str' $filter=description startswith 'str'The response includes a single data Item with an id value equal to 'ABC123' $filter=id eq 'ABC123'The response includes only data Items with a udfVersionNumber value equal to 1 $filter=udfVersionNumber ge 1The response includes only data Items with a displayName value that starts with 'rin' or data Items with a comment value that ends with 'ing' and data Items with description value that starts with 'str' $filter=(displayName contains 'rin' or comment endswith 'ing') and description startswith 'str'The response includes only data Items that have no Admin Class $filter=adminClassReference eq null | ||||||||||||||||||||||||||||||
submit required | integer Use the submit parameter to submit a Submitted Task request to execute the specified Scheduled Tasks Tool. This is a required parameter for Scheduled Tasks Tool endpoints. | ||||||||||||||||||||||||||||||
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. |
Request Body schema: application/json
Successful Operation
Bad Request
Forbidden
Not Found
Method Not Allowed
Conflict
Unsupported Media Type
Internal Server Error
- Payload
{- "submittedTaskComment": "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
}
Execute the Hold Tool on a single Scheduled Task Summary Item
Execute the Hold Tool on a single Scheduled Task Summary Item.
query Parameters
submit required | integer Use the submit parameter to submit a Submitted Task request to execute the specified Scheduled Tasks Tool. This is a required parameter for Scheduled Tasks Tool endpoints. |
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. |
Request Body schema: application/json
Successful Operation
Bad Request
Forbidden
Not Found
Method Not Allowed
Conflict
Unsupported Media Type
Internal Server Error
- Payload
{- "submittedTaskComment": "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
}
Execute the Release Tool on a collection of Scheduled Task Summaries
Execute the Release Tool on a collection of Scheduled Task Summaries. You must specify the collection of Scheduled Tasks that you want to hold using the filter parameter.
query Parameters
$filter required | string Use the $filter parameter to filter returned data Items in a manner similar to the Alliant User Applications column filter. This parameter uses the following format: {filterBy} {operator} {value}
You can use the and and or operators to combine multiple filter parameter criteria. The response includes only data Items with a displayName value that contains 'rin' $filter=displayName contains 'rin'The response includes only data Items with a comment value that ends with 'ing' $filter=comment endswith 'ing'The response includes only data Items with a description value that starts with 'str' $filter=description startswith 'str'The response includes a single data Item with an id value equal to 'ABC123' $filter=id eq 'ABC123'The response includes only data Items with a udfVersionNumber value equal to 1 $filter=udfVersionNumber ge 1The response includes only data Items with a displayName value that starts with 'rin' or data Items with a comment value that ends with 'ing' and data Items with description value that starts with 'str' $filter=(displayName contains 'rin' or comment endswith 'ing') and description startswith 'str'The response includes only data Items that have no Admin Class $filter=adminClassReference eq null | ||||||||||||||||||||||||||||||
submit required | integer Use the submit parameter to submit a Submitted Task request to execute the specified Scheduled Tasks Tool. This is a required parameter for Scheduled Tasks Tool endpoints. | ||||||||||||||||||||||||||||||
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. |
Request Body schema: application/json
Successful Operation
Bad Request
Forbidden
Not Found
Method Not Allowed
Conflict
Unsupported Media Type
Internal Server Error
- Payload
{- "submittedTaskComment": "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
}
Execute the Release Tool on a single Scheduled Task Summary Item
Execute the Release Tool on a single Scheduled Task Summary Item.
query Parameters
submit required | integer Use the submit parameter to submit a Submitted Task request to execute the specified Scheduled Tasks Tool. This is a required parameter for Scheduled Tasks Tool endpoints. |
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. |
Request Body schema: application/json
Successful Operation
Bad Request
Forbidden
Not Found
Method Not Allowed
Conflict
Unsupported Media Type
Internal Server Error
- Payload
{- "submittedTaskComment": "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
}