Computed Dates

Get multiple Computed Dates

Read the data for multiple Computed Dates.

SecurityHeaderToken
Request
query Parameters
minimal
boolean

When you specify this Verbosity parameter, the _timestamp, _type, displayName, and guid properties are returned.

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 warnings property of the Standard Response.

Examples:
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 warnings property of the Standard Response.

Examples:
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
contextReplace
string

Use this parameter to specify the properties with context replaced values in the response, separated by commas. You can also specify that you want to context replace values for all properties by specifying all.

Note: When the values specified in the contextReplace parameter are not valid, the query parameter is ignored.

Examples:
displayName and ud_UDField1 properties in the response have context replaced values.
contextReplace=displayName,ud_UDField1
All properties in the response have context replaced values.
contextReplace=all
$filter
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}

  • filterBy is the name of a property, the name of a Reference property specified as referenceProperty.property, or the name of Reference property for quality or inequality comparisons to null.

  • operator – specify one of the following operators:

    Operator Description filterBy datatype
    contains Contains String/Text
    endswith Ends with String/Text
    startswith Starts with String/Text
    eq Equals String/Text, Integer, Small Integer, Flag/Boolean, Reference property eq null
    ne Does not equal String/Text, Integer, Small Integer, Flag/Boolean, Reference property ne null
    le Less than or equal to String/Text, Integer, Small Integer, Flag/Boolean, DateTime
    lt Less than String/Text, Integer, Small Integer, Flag/Boolean, DateTime
    ge Greater than or equal to String/Text, Integer, Small Integer, Flag/Boolean, DateTime
    gt Greater than String/Text, Integer, Small Integer, Flag/Boolean, DateTime
  • value is the value to which the operator is applied. The value should be enclosed in single quotes unless the value is an Integer or Small Integer

You can use the and and or operators to combine multiple filter parameter criteria.

Examples:
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 1
The 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
$orderby
string

Use the $orderby parameter to specify the sort order of the returned data Items. You can specify a property or a property of a Reference property followed by asc or desc to sort returned data Items by a property in ascending or descending order.

Note: When this parameter is not specified, the returned data Items are sorted by Display Name in ascending order.

Examples:
ascending sort by property1
$orderby=property1
descending sort by property1 of the referenceProperty
$orderby=referenceProperty.property1 desc
$top
integer

Use the $top parameter to specify the maximum number of Items to return. When you do not specify this parameter, 20 Items are returned by default. When you specify the verbose parameter, the maximum number of Items that you can request 100. When you specify the minimal or default parameters, the maximum number of Items that you can request 1000. This query parameter combined with $skip query parameter can be used to facilitate paging.

Examples:
The response includes 30 data Items
$top=30
$skip
integer

Use the $skip parameter to specify the number of Items to skip from the first result. This query parameter combined with the $top query parameter can be used to facilitate paging. For example, $skip=20&$top=20 returns the second page of 20 Items.

Examples:
The response includes data Items that follow the first 30 data Items
$skip=30
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.

Responses
200

OK

400

Bad Request

403

Forbidden

404

Not Found

405

Method Not Allowed

500

Internal Server Error

get/api/data/computedDateHeaders
Response samples
application/json
{
  • "result": {
    },
  • "errors": [ ],
  • "warnings": [ ],
  • "hasErrors": false,
  • "hasWarnings": false
}

Get a single Computed Date

Read the data for a specific Computed Date.

SecurityHeaderToken
Request
path Parameters
guid
required
string

Computed Date Unique Identity

query Parameters
downloadAttachments
boolean

Use the downloadAttachments parameter to include Attachment data in the response. You must include either the verbose parameter or the include={ItemType}Attachments parameter when you want to include Attachment data in the response. Attachment data is returned in the _data property in base64 encoded format. When you do not include the downloadAttachments parameter but you include the verbose parameter or the include={ItemType}Attachments parameter, you can use the value in the the _downloadUrl properties to download Attachments directly.

minimal
boolean

When you specify this Verbosity parameter, the _timestamp, _type, displayName, and guid properties are returned.

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 warnings property of the Standard Response.

Examples:
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 warnings property of the Standard Response.

Examples:
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
contextReplace
string

Use this parameter to specify the properties with context replaced values in the response, separated by commas. You can also specify that you want to context replace values for all properties by specifying all.

Note: When the values specified in the contextReplace parameter are not valid, the query parameter is ignored.

Examples:
displayName and ud_UDField1 properties in the response have context replaced values.
contextReplace=displayName,ud_UDField1
All properties in the response have context replaced values.
contextReplace=all
getWarnings
boolean

When you specify this parameter, warning validation messages are returned.

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.

Responses
200

OK

403

Forbidden

404

Not Found

405

Method Not Allowed

500

Internal Server Error

get/api/data/computedDateHeaders/{guid}
Response samples
application/json
{
  • "result": {
    },
  • "errors": [
    ],
  • "warnings": [
    ],
  • "hasErrors": false,
  • "hasWarnings": false
}

Use the In Use Tool on a Computed Date

Use the In Use Tool on a Computed Date.

SecurityHeaderToken
Request
path Parameters
guid
required
string

Computed Date Unique Identity

query Parameters
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.

Responses
200

OK

400

Bad Request

403

Forbidden

404

Not Found

405

Method Not Allowed

500

Internal Server Error

put/api/data/computedDateHeaders/inUse/{guid}
Response samples
application/json
{
  • "result": [
    ],
  • "errors": [ ],
  • "warnings": [ ],
  • "hasErrors": false,
  • "hasWarnings": false
}

Use the Resolve Tool on a Computed Date

Use the Resolve Tool on a Computed Date.

SecurityHeaderToken
Request
path Parameters
guid
required
string

Computed Date Unique Identity

query Parameters
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.

Responses
200

OK

400

Bad Request

403

Forbidden

404

Not Found

405

Method Not Allowed

500

Internal Server Error

put/api/data/computedDateHeaders/resolve/{guid}
Response samples
application/json
{
  • "result": null,
  • "errors": [ ],
  • "warnings": [ ],
  • "hasErrors": false,
  • "hasWarnings": false
}