Get multiple Contract Lists
Read the data for multiple Contract Lists.
A Contract List identifies a dynamic set of Contracts and Contract Lists. You create a Contract List by including and excluding specific Contracts and Contract Lists. Currently, you can use Contract Lists only for Internet Delivery purposes.
Note: The List Details that you access in Alliant API reflect the List definition and not the resolved set of Items and Lists ultimately defined by the List.
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",
- "comment": "string",
- "description": "string",
- "includeOnlyCommonItemsFlag": true,
- "createdByTypeReference": {
- "_type": "dataItemType",
- "displayName": "string",
- "guid": "6c556cd8-ac27-4167-844c-f00ddb170b3f"
}, - "definitionText": "string",
- "hashCategory": "string",
- "listDescriptionResolvedFlag": true,
- "listLevelResolvedFlag": true,
- "listResolvedFlag": true,
- "listSummaryResolvedFlag": true,
- "modifiedByUserReference": {
- "_type": "dataItemType",
- "displayName": "string",
- "guid": "6c556cd8-ac27-4167-844c-f00ddb170b3f"
}, - "modifiedDatetime": "2019-08-24T14:15:22Z",
- "resolutionErrorMessage": "string",
- "resolveCount": 0,
- "sid": 1,
- "systemDefinedFlag": true,
- "systemModifiedDatetime": "2019-08-24T14:15:22Z",
- "uniquenessNumber": 0,
- "verifiedFlag": true,
- "versionNumber": 0
}
]
}, - "errors": [ ],
- "warnings": [ ],
- "hasErrors": false,
- "hasWarnings": false
}
Create a Contract List
Create a Contract List.
A Contract List identifies a dynamic set of Contracts and Contract Lists. You create a Contract List by including and excluding specific Contracts and Contract Lists. Currently, you can use Contract Lists only for Internet Delivery purposes.
If getOrCreateWithHashCategory query parameter is added then this endpoint gets an existing User-Defined Contract List or creates a new Contract List. If an existing User-Defined Contract List matches List Definition specified in a request (ListDetails
and ListXrefs
) for a Hash Category specified as a value of getOrCreateWithHashCategory query parameter then this Contract List is returned in a response. In this case, the successful response is indicated with a 200 status code. If no Contract List matches List Definition and Hash Category, then a new Contract List is created. In this case, the successful response is indicated with a 201 status code.
Note: The List Details that you access in Alliant API reflect the List definition and not the resolved set of Items and Lists ultimately defined by the List.
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 |
getOrCreateWithHashCategory | string [ 1 .. 60 ] characters This parameter provides functionality to assist with having an upstream system manage lists within Alliant. The value assigned to this parameter should be an identifier of the specific integration making the call. This will effectively create a namespace for that integration so that if seperate upstream systems are creating and managing lists within Alliant, then these will not impact eachother. When submitting a list using this parameter, the call should contain all items that are desired to be contained in the list. The response will return details of a list that is either created or matched with those contents. If a list with the same contents exists with a matching Get or Create a Contact for a Hash Category 'Data Bridge integration'. getOrCreateWithHashCategory=Data bridge integration |
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 Contract List
comment | string (Comment) <= 1000 characters Specify any additional information for the List, when applicable. This property is ignored when getOrCreateWithHashCategory query parameter is specified and an existing List is returned. |
description required | string (description) [ 1 .. 255 ] characters Specify the unique “name” of the List. This property is ignored when getOrCreateWithHashCategory query parameter is specified and an existing List is returned. |
includeOnlyCommonItemsFlag | boolean (Flag) Specify whether to include only the Items that are common to all of the Lists and Items that are specified in the Lists and the Items collections. |
Array of objects (List Item Details POST Request Properties) Contract List Items. Include the | |
Array of objects (List List Details POST Request Properties) Contract List Lists. Include the |
Successful Operation
Created
Bad Request
Forbidden
Not Found
Method Not Allowed
Conflict
Unsupported Media Type
Internal Server Error
- Payload
{- "comment": "string",
- "description": "string",
- "includeOnlyCommonItemsFlag": true,
- "contractListDetails": [
- {
- "_action": "add",
- "excludeFlag": true,
- "itemReference": "string"
}
], - "contractListXrefs": [
- {
- "_action": "add",
- "excludeFlag": true,
- "listReference": "string"
}
]
}
- 200
- 201
- 400
- 403
- 404
- 405
- 409
- 415
- 500
{- "result": {
- "_type": "dataItemType",
- "displayName": "string",
- "guid": "6c556cd8-ac27-4167-844c-f00ddb170b3f",
- "comment": "string",
- "description": "string",
- "includeOnlyCommonItemsFlag": true,
- "createdByTypeReference": {
- "_type": "dataItemType",
- "displayName": "string",
- "guid": "6c556cd8-ac27-4167-844c-f00ddb170b3f"
}, - "definitionText": "string",
- "hashCategory": "string",
- "listDescriptionResolvedFlag": true,
- "listLevelResolvedFlag": true,
- "listResolvedFlag": true,
- "listSummaryResolvedFlag": true,
- "modifiedByUserReference": {
- "_type": "dataItemType",
- "displayName": "string",
- "guid": "6c556cd8-ac27-4167-844c-f00ddb170b3f"
}, - "modifiedDatetime": "2019-08-24T14:15:22Z",
- "resolutionErrorMessage": "string",
- "resolveCount": 0,
- "sid": 1,
- "systemDefinedFlag": true,
- "systemModifiedDatetime": "2019-08-24T14:15:22Z",
- "uniquenessNumber": 0,
- "verifiedFlag": true,
- "versionNumber": 0
}, - "errors": [
- { }
], - "warnings": [
- { }
], - "hasErrors": false,
- "hasWarnings": false
}
Get a single Contract List
Read the data for a specific Contract List.
A Contract List identifies a dynamic set of Contracts and Contract Lists. You create a Contract List by including and excluding specific Contracts and Contract Lists. Currently, you can use Contract Lists only for Internet Delivery purposes.
Note: The List Details that you access in Alliant API reflect the List definition and not the resolved set of Items and Lists ultimately defined by the List.
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",
- "comment": "string",
- "description": "string",
- "includeOnlyCommonItemsFlag": true,
- "createdByTypeReference": {
- "_type": "dataItemType",
- "displayName": "string",
- "guid": "6c556cd8-ac27-4167-844c-f00ddb170b3f"
}, - "definitionText": "string",
- "hashCategory": "string",
- "listDescriptionResolvedFlag": true,
- "listLevelResolvedFlag": true,
- "listResolvedFlag": true,
- "listSummaryResolvedFlag": true,
- "modifiedByUserReference": {
- "_type": "dataItemType",
- "displayName": "string",
- "guid": "6c556cd8-ac27-4167-844c-f00ddb170b3f"
}, - "modifiedDatetime": "2019-08-24T14:15:22Z",
- "resolutionErrorMessage": "string",
- "resolveCount": 0,
- "sid": 1,
- "systemDefinedFlag": true,
- "systemModifiedDatetime": "2019-08-24T14:15:22Z",
- "uniquenessNumber": 0,
- "verifiedFlag": true,
- "versionNumber": 0
}, - "errors": [
- { }
], - "warnings": [
- { }
], - "hasErrors": false,
- "hasWarnings": false
}
Update a Contract List
Update the data for a specific Contract List.
A Contract List identifies a dynamic set of Contracts and Contract Lists. You create a Contract List by including and excluding specific Contracts and Contract Lists. Currently, you can use Contract Lists only for Internet Delivery purposes.
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 or Cross-Reference 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.
The following actions are available for Cross-Reference Items:
· add – specify this action when you want to add a Cross-Reference Item.
· update – specify this action when you want to update data for a Cross-Reference Item.
Note: The List Details that you access in Alliant API reflect the List definition and not the resolved set of Items and Lists ultimately defined by the List.
Note: When you submit a request to add or delete Child or Cross-reference Items, the request is not idempotent. When you specify an _action
value for a Child or Cross-reference Item, the action supercedes the behaviour indicated by the HTTP verb for the Child or Cross-reference Item. In this scenario, the request is similar to an HTTP PATCH request.
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
Specify the changes that you want to make to the Contract List
comment | string (Comment) <= 1000 characters Specify any additional information for the List, when applicable. This property is ignored when getOrCreateWithHashCategory query parameter is specified and an existing List is returned. |
description required | string (description) [ 1 .. 255 ] characters Specify the unique “name” of the List. This property is ignored when getOrCreateWithHashCategory query parameter is specified and an existing List is returned. |
includeOnlyCommonItemsFlag | boolean (Flag) Specify whether to include only the Items that are common to all of the Lists and Items that are specified in the Lists and the Items collections. |
Array of objects (List Item Details PUT Request Properties) Contract List Items. Include the | |
Array of objects (List List Details PUT Request Properties) Contract List Lists. Include the |
OK
Bad Request
Forbidden
Not Found
Method Not Allowed
Conflict
Unsupported Media Type
Internal Server Error
- Payload
{- "comment": "string",
- "description": "string",
- "includeOnlyCommonItemsFlag": true,
- "contractListDetails": [
- {
- "_action": "add",
- "excludeFlag": true,
- "guid": "6c556cd8-ac27-4167-844c-f00ddb170b3f",
- "itemReference": "string"
}
], - "contractListXrefs": [
- {
- "_action": "add",
- "excludeFlag": true,
- "guid": "6c556cd8-ac27-4167-844c-f00ddb170b3f",
- "listReference": "string"
}
]
}
- 200
- 400
- 403
- 404
- 405
- 409
- 415
- 500
{- "result": {
- "_type": "dataItemType",
- "displayName": "string",
- "guid": "6c556cd8-ac27-4167-844c-f00ddb170b3f",
- "comment": "string",
- "description": "string",
- "includeOnlyCommonItemsFlag": true,
- "createdByTypeReference": {
- "_type": "dataItemType",
- "displayName": "string",
- "guid": "6c556cd8-ac27-4167-844c-f00ddb170b3f"
}, - "definitionText": "string",
- "hashCategory": "string",
- "listDescriptionResolvedFlag": true,
- "listLevelResolvedFlag": true,
- "listResolvedFlag": true,
- "listSummaryResolvedFlag": true,
- "modifiedByUserReference": {
- "_type": "dataItemType",
- "displayName": "string",
- "guid": "6c556cd8-ac27-4167-844c-f00ddb170b3f"
}, - "modifiedDatetime": "2019-08-24T14:15:22Z",
- "resolutionErrorMessage": "string",
- "resolveCount": 0,
- "sid": 1,
- "systemDefinedFlag": true,
- "systemModifiedDatetime": "2019-08-24T14:15:22Z",
- "uniquenessNumber": 0,
- "verifiedFlag": true,
- "versionNumber": 0
}, - "errors": [
- { }
], - "warnings": [
- { }
], - "hasErrors": false,
- "hasWarnings": false
}
Update a Contract List
Update the data for a specific Contract List.
A Contract List identifies a dynamic set of Contracts and Contract Lists. You create a Contract List by including and excluding specific Contracts and Contract Lists. Currently, you can use Contract Lists only for Internet Delivery purposes.
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 or Cross-Reference 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.
The following actions are available for Cross-Reference Items:
· add – specify this action when you want to add a Cross-Reference Item.
· update – specify this action when you want to update data for a Cross-Reference Item.
Note: The List Details that you access in Alliant API reflect the List definition and not the resolved set of Items and Lists ultimately defined by the List.
Note: As well as partial updates, it is possible to use an _action
to add or delete records. When there is an _action included within the body, then this action supercedes the behaviour indicated by the HTTP verb.
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
Specify the changes that you want to make to the Contract List
comment | string (Comment) <= 1000 characters Specify any additional information for the List, when applicable. This property is ignored when getOrCreateWithHashCategory query parameter is specified and an existing List is returned. |
description required | string (description) [ 1 .. 255 ] characters Specify the unique “name” of the List. This property is ignored when getOrCreateWithHashCategory query parameter is specified and an existing List is returned. |
includeOnlyCommonItemsFlag | boolean (Flag) Specify whether to include only the Items that are common to all of the Lists and Items that are specified in the Lists and the Items collections. |
Array of objects (List Item Details PUT Request Properties) Contract List Items. Include the | |
Array of objects (List List Details PUT Request Properties) Contract List Lists. Include the |
OK
Bad Request
Forbidden
Not Found
Method Not Allowed
Conflict
Unsupported Media Type
Internal Server Error
- Payload
{- "comment": "string",
- "description": "string",
- "includeOnlyCommonItemsFlag": true,
- "contractListDetails": [
- {
- "_action": "add",
- "excludeFlag": true,
- "guid": "6c556cd8-ac27-4167-844c-f00ddb170b3f",
- "itemReference": "string"
}
], - "contractListXrefs": [
- {
- "_action": "add",
- "excludeFlag": true,
- "guid": "6c556cd8-ac27-4167-844c-f00ddb170b3f",
- "listReference": "string"
}
]
}
- 200
- 400
- 403
- 404
- 405
- 409
- 415
- 500
{- "result": {
- "_type": "dataItemType",
- "displayName": "string",
- "guid": "6c556cd8-ac27-4167-844c-f00ddb170b3f",
- "comment": "string",
- "description": "string",
- "includeOnlyCommonItemsFlag": true,
- "createdByTypeReference": {
- "_type": "dataItemType",
- "displayName": "string",
- "guid": "6c556cd8-ac27-4167-844c-f00ddb170b3f"
}, - "definitionText": "string",
- "hashCategory": "string",
- "listDescriptionResolvedFlag": true,
- "listLevelResolvedFlag": true,
- "listResolvedFlag": true,
- "listSummaryResolvedFlag": true,
- "modifiedByUserReference": {
- "_type": "dataItemType",
- "displayName": "string",
- "guid": "6c556cd8-ac27-4167-844c-f00ddb170b3f"
}, - "modifiedDatetime": "2019-08-24T14:15:22Z",
- "resolutionErrorMessage": "string",
- "resolveCount": 0,
- "sid": 1,
- "systemDefinedFlag": true,
- "systemModifiedDatetime": "2019-08-24T14:15:22Z",
- "uniquenessNumber": 0,
- "verifiedFlag": true,
- "versionNumber": 0
}, - "errors": [
- { }
], - "warnings": [
- { }
], - "hasErrors": false,
- "hasWarnings": false
}
Delete a Contract List
Delete a specific Contract List.
A Contract List identifies a dynamic set of Contracts and Contract Lists. You create a Contract List by including and excluding specific Contracts and Contract Lists. Currently, you can use Contract Lists only for Internet Delivery purposes.
Note: The List Details that you access in Alliant API reflect the List definition and not the resolved set of Items and Lists ultimately defined by the List.
OK
Forbidden
Method Not Allowed
Conflict
Internal Server Error
- 200
- 403
- 405
- 409
- 500
{- "result": null,
- "errors": [ ],
- "warnings": [ ],
- "hasErrors": false,
- "hasWarnings": false
}
Copy an existing Contract List
Copy a specific Contract List.
This PUT does not behave as a standard HTTP PUT and is NOT idempotent. This PUT will create a new resource. Its behaviour is that of a POST and it should be treated as such.
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",
- "comment": "string",
- "description": "string",
- "includeOnlyCommonItemsFlag": true,
- "createdByTypeReference": {
- "_type": "dataItemType",
- "displayName": "string",
- "guid": "6c556cd8-ac27-4167-844c-f00ddb170b3f"
}, - "definitionText": "string",
- "hashCategory": "string",
- "listDescriptionResolvedFlag": true,
- "listLevelResolvedFlag": true,
- "listResolvedFlag": true,
- "listSummaryResolvedFlag": true,
- "modifiedByUserReference": {
- "_type": "dataItemType",
- "displayName": "string",
- "guid": "6c556cd8-ac27-4167-844c-f00ddb170b3f"
}, - "modifiedDatetime": "2019-08-24T14:15:22Z",
- "resolutionErrorMessage": "string",
- "resolveCount": 0,
- "sid": 1,
- "systemDefinedFlag": true,
- "systemModifiedDatetime": "2019-08-24T14:15:22Z",
- "uniquenessNumber": 0,
- "verifiedFlag": true,
- "versionNumber": 0
}, - "errors": [
- { }
], - "warnings": [
- { }
], - "hasErrors": false,
- "hasWarnings": false
}
Execute the Resolve Tool for an existing Contract List
Execute the Resolve Tool on an existing Contract List.
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
}