Miscellaneous Endpoints

Get multiple Access Levels

Read the data for multiple Access Level Items. Alliant Access Levels define the level of access an Alliant User has to certain data (for example, Normal or Supervisor).

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:

example-1

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:

example-1

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

$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:

contains

The response includes only data Items with a displayName value that contains 'rin'

$filter=displayName contains 'rin'

endswith

The response includes only data Items with a comment value that ends with 'ing'

$filter=comment endswith 'ing'

startswith

The response includes only data Items with a description value that starts with 'str'

$filter=description startswith 'str'

eq

The response includes a single data Item with an id value equal to 'ABC123'

$filter=id eq 'ABC123'

ge

The response includes only data Items with a udfVersionNumber value equal to 1

$filter=udfVersionNumber ge 1

combinedFilter

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'

referenceFilter

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:

propertyAsc

ascending sort by property1

$orderby=property1

referencePropertyDesc

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:

example-1

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:

example-1

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

Success

400

Bad Request

403

Forbidden

404

Not Found

405

Method Not Allowed

500

Internal Server Error

get/api/data/accessLevels

Response samples

application/json

{"result": {"previousPageUrl": null,
"nextPageUrl": null,
"itemCount": 4,
"totalItemCount": 4,
"items": [{"_type": "accessLevel",
"description": "Confidential",
"displayName": "Confidential",
"guid": "8d2eca39-3578-4f8d-b1fa-4efde6a9aad3",
"id": "Confidential",
"smallSID": 2,
"systemModifiedDatetime": "2013-01-07T07:47:50.14"
},
{"_type": "accessLevel",
"description": "No Access",
"displayName": "No Access",
"guid": "fabb3796-c1a5-45ac-babd-014454826097",
"id": "No Access",
"smallSID": 0,
"systemModifiedDatetime": "2013-01-07T07:47:50.14"
},
{"_type": "accessLevel",
"description": "Normal",
"displayName": "Normal",
"guid": "4563de6f-4a21-4260-a7aa-6579b55f66f7",
"id": "Normal",
"smallSID": 1,
"systemModifiedDatetime": "2013-01-07T07:47:50.14"
},
{"_type": "accessLevel",
"description": "Supervisor",
"displayName": "Supervisor",
"guid": "65738565-660c-4d53-afde-cf9b152792e2",
"id": "Supervisor",
"smallSID": 3,
"systemModifiedDatetime": "2013-01-07T07:47:50.14"
}
]
},
"errors": [ ],
"warnings": [ ],
"hasErrors": false,
"hasWarnings": false
}

Get a single Access Level

Read the data for a single Access Level Item. Alliant Access Levels define the level of access an Alliant User has to certain data (for example, Normal or Supervisor).

SecurityHeaderToken

Request

path Parameters

guid

required

string

Access Level Unique Identity

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: example-1 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: example-1 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.

Responses

200

Success

403

Forbidden

404

Not Found

405

Method Not Allowed

500

Internal Server Error

get/api/data/accessLevels/{guid}

Response samples

200
403
404
405
500

application/json

{"result": {"_type": "accessLevel",
"description": "Confidential",
"displayName": "Confidential",
"guid": "8d2eca39-3578-4f8d-b1fa-4efde6a9aad3",
"id": "Confidential",
"smallSID": 2,
"systemModifiedDatetime": "2013-01-07T07:47:50.14"
},
"errors": [ ],
"warnings": [ ],
"hasErrors": false,
"hasWarnings": false
}

Get multiple Access Types

Read the data for multiple Access Type Items. Alliant Access Types define the type of access an Alliant User has to certain data (for example, View or Modify).

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:

example-1

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:

example-1

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

$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:

contains

The response includes only data Items with a displayName value that contains 'rin'

$filter=displayName contains 'rin'

endswith

The response includes only data Items with a comment value that ends with 'ing'

$filter=comment endswith 'ing'

startswith

The response includes only data Items with a description value that starts with 'str'

$filter=description startswith 'str'

eq

The response includes a single data Item with an id value equal to 'ABC123'

$filter=id eq 'ABC123'

ge

The response includes only data Items with a udfVersionNumber value equal to 1

$filter=udfVersionNumber ge 1

combinedFilter

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'

referenceFilter

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:

propertyAsc

ascending sort by property1

$orderby=property1

referencePropertyDesc

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:

example-1

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:

example-1

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

Success

400

Bad Request

403

Forbidden

404

Not Found

405

Method Not Allowed

500

Internal Server Error

get/api/data/accessTypes

Response samples

application/json

{"result": {"previousPageUrl": null,
"nextPageUrl": null,
"itemCount": 2,
"totalItemCount": 2,
"items": [{"_type": "accessType",
"description": "Modify",
"displayName": "Modify",
"guid": "a8fdad2a-a2ea-4194-9bde-da13e62d981d",
"sid": 2
},
{"_type": "accessType",
"description": "View",
"displayName": "View",
"guid": "fdd1582e-3370-4775-a789-8e91794318fb",
"sid": 1
}
]
},
"errors": [ ],
"warnings": [ ],
"hasErrors": false,
"hasWarnings": false
}

Get a single Access Type

Read the data for a single Access Type Item. Alliant Access Types define the type of access an Alliant User has to certain data (for example, View or Modify).

SecurityHeaderToken

Request

path Parameters

guid

required

string

Access Type Unique Identity

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: example-1 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: example-1 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.

Responses

200

Success

403

Forbidden

404

Not Found

405

Method Not Allowed

500

Internal Server Error

get/api/data/accessTypes/{guid}

Response samples

200
403
404
405
500

application/json

{"result": {"_type": "accessType",
"description": "Modify",
"displayName": "Modify",
"guid": "a8fdad2a-a2ea-4194-9bde-da13e62d981d",
"sid": 2
},
"errors": [ ],
"warnings": [ ],
"hasErrors": false,
"hasWarnings": false
}

Get multiple Authentication Methods

Read the data for multiple Authentication Method Items.

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:

example-1

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:

example-1

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

$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:

contains

The response includes only data Items with a displayName value that contains 'rin'

$filter=displayName contains 'rin'

endswith

The response includes only data Items with a comment value that ends with 'ing'

$filter=comment endswith 'ing'

startswith

The response includes only data Items with a description value that starts with 'str'

$filter=description startswith 'str'

eq

The response includes a single data Item with an id value equal to 'ABC123'

$filter=id eq 'ABC123'

ge

The response includes only data Items with a udfVersionNumber value equal to 1

$filter=udfVersionNumber ge 1

combinedFilter

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'

referenceFilter

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:

propertyAsc

ascending sort by property1

$orderby=property1

referencePropertyDesc

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:

example-1

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:

example-1

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

Success

400

Bad Request

403

Forbidden

404

Not Found

405

Method Not Allowed

500

Internal Server Error

get/api/data/authenticationMethods

Response samples

application/json

{"result": {"previousPageUrl": null,
"nextPageUrl": null,
"itemCount": 2,
"totalItemCount": 2,
"items": [{"_type": "authenticationMethod",
"comment": null,
"description": "Password",
"displayName": "Password",
"guid": "0821486a-8e3a-4ba9-b761-a550b33c53cd",
"id": "Password",
"sid": 1,
"sortOrderNumber": 1
},
{"_type": "authenticationMethod",
"comment": null,
"description": "Public Key",
"displayName": "Public Key",
"guid": "c8911d08-da6d-466b-be5b-0e261c7680ab",
"id": "Public Key",
"sid": 2,
"sortOrderNumber": 2
}
]
},
"errors": [ ],
"warnings": [ ],
"hasErrors": false,
"hasWarnings": false
}

Get a single Authentication Method

Read the data for a single Authentication Method Item.

SecurityHeaderToken

Request

path Parameters

guid

required

string

Authentication Method Unique Identity

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: example-1 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: example-1 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.

Responses

200

Success

403

Forbidden

404

Not Found

405

Method Not Allowed

500

Internal Server Error

get/api/data/authenticationMethods/{guid}

Response samples

200
403
404
405
500

application/json

{"result": {"_type": "authenticationMethod",
"comment": null,
"description": "Password",
"displayName": "Password",
"guid": "0821486a-8e3a-4ba9-b761-a550b33c53cd",
"id": "Password",
"sid": 1,
"sortOrderNumber": 1
},
"errors": [ ],
"warnings": [ ],
"hasErrors": false,
"hasWarnings": false
}

Get multiple Authentication Types

Read the data for multiple Authentication Type Items.

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:

example-1

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:

example-1

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

$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:

contains

The response includes only data Items with a displayName value that contains 'rin'

$filter=displayName contains 'rin'

endswith

The response includes only data Items with a comment value that ends with 'ing'

$filter=comment endswith 'ing'

startswith

The response includes only data Items with a description value that starts with 'str'

$filter=description startswith 'str'

eq

The response includes a single data Item with an id value equal to 'ABC123'

$filter=id eq 'ABC123'

ge

The response includes only data Items with a udfVersionNumber value equal to 1

$filter=udfVersionNumber ge 1

combinedFilter

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'

referenceFilter

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:

propertyAsc

ascending sort by property1

$orderby=property1

referencePropertyDesc

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:

example-1

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:

example-1

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

Success

400

Bad Request

403

Forbidden

404

Not Found

405

Method Not Allowed

500

Internal Server Error

get/api/data/authenticationTypes

Response samples

application/json

{"result": {"previousPageUrl": null,
"nextPageUrl": null,
"itemCount": 2,
"totalItemCount": 2,
"items": [{"_type": "authenticationType",
"comment": null,
"description": "Key",
"displayName": "Key",
"guid": "3fe85a0f-4acb-482a-b4d0-1b7b43fb9b29",
"id": "Key",
"sid": 2,
"sortOrderNumber": 2,
"systemModifiedDatetime": "2022-11-10T09:27:11"
},
{"_type": "authenticationType",
"comment": null,
"description": "IAM Role",
"displayName": "IAM Role",
"guid": "68a5ccc5-31e1-49ff-8949-b810aa14ebbb",
"id": "IAM Role",
"sid": 3,
"sortOrderNumber": 3,
"systemModifiedDatetime": "2022-11-10T09:27:11"
}
]
},
"errors": [ ],
"warnings": [ ],
"hasErrors": false,
"hasWarnings": false
}

Get a single Authentication Type

Read the data for a single Authentication Type Item.

SecurityHeaderToken

Request

path Parameters

guid

required

string

Authentication Type Unique Identity

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: example-1 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: example-1 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.

Responses

200

Success

403

Forbidden

404

Not Found

405

Method Not Allowed

500

Internal Server Error

get/api/data/authenticationTypes/{guid}

Response samples

200
403
404
405
500

application/json

{"result": {"_type": "authenticationType",
"comment": null,
"description": "IAM Role",
"displayName": "IAM Role",
"guid": "68a5ccc5-31e1-49ff-8949-b810aa14ebbb",
"id": "IAM Role",
"sid": 3,
"sortOrderNumber": 3,
"systemModifiedDatetime": "2022-11-10T09:27:11"
},
"errors": [ ],
"warnings": [ ],
"hasErrors": false,
"hasWarnings": false
}

Get multiple Certificate Types

Read the data for multiple Certificate Type Items.

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:

example-1

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:

example-1

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

$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:

contains

The response includes only data Items with a displayName value that contains 'rin'

$filter=displayName contains 'rin'

endswith

The response includes only data Items with a comment value that ends with 'ing'

$filter=comment endswith 'ing'

startswith

The response includes only data Items with a description value that starts with 'str'

$filter=description startswith 'str'

eq

The response includes a single data Item with an id value equal to 'ABC123'

$filter=id eq 'ABC123'

ge

The response includes only data Items with a udfVersionNumber value equal to 1

$filter=udfVersionNumber ge 1

combinedFilter

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'

referenceFilter

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:

propertyAsc

ascending sort by property1

$orderby=property1

referencePropertyDesc

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:

example-1

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:

example-1

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

Success

400

Bad Request

403

Forbidden

404

Not Found

405

Method Not Allowed

500

Internal Server Error

get/api/data/certificateTypes

Response samples

application/json

{"result": {"previousPageUrl": null,
"nextPageUrl": null,
"itemCount": 2,
"totalItemCount": 2,
"items": [{"_type": "certificateType",
"comment": null,
"description": "Auto",
"displayName": "Auto",
"guid": "b6e335d0-5288-41d4-9d2e-b0631510923c",
"id": "Auto",
"sid": 1,
"sortOrderNumber": 1,
"systemModifiedDatetime": "2022-11-10T09:27:11"
},
{"_type": "certificateType",
"comment": null,
"description": "Privacy Enhanced Mail Format (PEM)",
"displayName": "Privacy Enhanced Mail Format (PEM)",
"guid": "fc89ce2d-4485-4b60-a38f-e61b16fa1f12",
"id": "Privacy Enhanced Mail Format (PEM)",
"sid": 2,
"sortOrderNumber": 2,
"systemModifiedDatetime": "2022-11-10T09:27:11"
}
]
},
"errors": [ ],
"warnings": [ ],
"hasErrors": false,
"hasWarnings": false
}

Get a single Certificate Type

Read the data for a single Certificate Type Item.

SecurityHeaderToken

Request

path Parameters

guid

required

string

Certificate Type Unique Identity

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: example-1 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: example-1 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.

Responses

200

Success

403

Forbidden

404

Not Found

405

Method Not Allowed

500

Internal Server Error

get/api/data/certificateTypes/{guid}

Response samples

200
403
404
405
500

application/json

{"result": {"_type": "certificateType",
"comment": null,
"description": "Auto",
"displayName": "Auto",
"guid": "b6e335d0-5288-41d4-9d2e-b0631510923c",
"id": "Auto",
"sid": 1,
"sortOrderNumber": 1,
"systemModifiedDatetime": "2022-11-10T09:27:11"
},
"errors": [ ],
"warnings": [ ],
"hasErrors": false,
"hasWarnings": false
}

Get multiple File System Locations

Read the data for multiple File System Location Items.

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:

example-1

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:

example-1

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

$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:

contains

The response includes only data Items with a displayName value that contains 'rin'

$filter=displayName contains 'rin'

endswith

The response includes only data Items with a comment value that ends with 'ing'

$filter=comment endswith 'ing'

startswith

The response includes only data Items with a description value that starts with 'str'

$filter=description startswith 'str'

eq

The response includes a single data Item with an id value equal to 'ABC123'

$filter=id eq 'ABC123'

ge

The response includes only data Items with a udfVersionNumber value equal to 1

$filter=udfVersionNumber ge 1

combinedFilter

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'

referenceFilter

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:

propertyAsc

ascending sort by property1

$orderby=property1

referencePropertyDesc

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:

example-1

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:

example-1

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

Success

400

Bad Request

403

Forbidden

404

Not Found

405

Method Not Allowed

500

Internal Server Error

get/api/data/fileSystemLocations

Response samples

application/json

{"result": {"previousPageUrl": null,
"nextPageUrl": null,
"itemCount": 2,
"totalItemCount": 2,
"items": [{"_type": "fileSystemLocation",
"cloudEndpoint": "https://my-bucket.s3.us-west-1.amazonaws.com",
"description": "US West (N. California) - Amazon S3 Region",
"displayName": "US West (N. California) - Amazon S3 Region",
"guid": "87d62378-fe9d-4d88-95ec-99a13121cf75",
"id": "US West (N. California) - Amazon S3 Region",
"locationCode": "us-west-1",
"sid": 3,
"sortOrderNumber": 3,
"systemModifiedDatetime": "2022-10-05T14:34:13"
},
{"_type": "fileSystemLocation",
"cloudEndpoint": "https://my-bucket.s3.us-west-2.amazonaws.com",
"description": "US West (Oregon) - Amazon S3 Region",
"displayName": "US West (Oregon) - Amazon S3 Region",
"guid": "87d62378-fe9d-4d88-95ec-99a13121cf75",
"id": "US West (Oregon) - Amazon S3 Region",
"locationCode": "us-west-2",
"sid": 4,
"sortOrderNumber": 4,
"systemModifiedDatetime": "2022-10-05T14:34:13"
}
]
},
"errors": [ ],
"warnings": [ ],
"hasErrors": false,
"hasWarnings": false
}

Get a single File System Location

Read the data for a single File System Location Item.

SecurityHeaderToken

Request

path Parameters

guid

required

string

File System Location Unique Identity

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: example-1 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: example-1 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.

Responses

200

Success

403

Forbidden

404

Not Found

405

Method Not Allowed

500

Internal Server Error

get/api/data/fileSystemLocations/{guid}

Response samples

200
403
404
405
500

application/json

{"result": {"_type": "fileSystemLocation",
"cloudEndpoint": "https://my-bucket.s3.us-west-1.amazonaws.com",
"description": "US West (N. California) - Amazon S3 Region",
"displayName": "US West (N. California) - Amazon S3 Region",
"guid": "87d62378-fe9d-4d88-95ec-99a13121cf75",
"id": "US West (N. California) - Amazon S3 Region",
"locationCode": "us-west-1",
"sid": 3,
"sortOrderNumber": 3,
"systemModifiedDatetime": "2022-10-05T14:34:13"
},
"errors": [ ],
"warnings": [ ],
"hasErrors": false,
"hasWarnings": false
}

Get multiple Transfer Types

Read the data for multiple Transfer Type Items.

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:

example-1

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:

example-1

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

$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:

contains

The response includes only data Items with a displayName value that contains 'rin'

$filter=displayName contains 'rin'

endswith

The response includes only data Items with a comment value that ends with 'ing'

$filter=comment endswith 'ing'

startswith

The response includes only data Items with a description value that starts with 'str'

$filter=description startswith 'str'

eq

The response includes a single data Item with an id value equal to 'ABC123'

$filter=id eq 'ABC123'

ge

The response includes only data Items with a udfVersionNumber value equal to 1

$filter=udfVersionNumber ge 1

combinedFilter

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'

referenceFilter

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:

propertyAsc

ascending sort by property1

$orderby=property1

referencePropertyDesc

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:

example-1

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:

example-1

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

Success

400

Bad Request

403

Forbidden

404

Not Found

405

Method Not Allowed

500

Internal Server Error

get/api/data/transferTypes

Response samples

application/json

{"result": {"previousPageUrl": null,
"nextPageUrl": null,
"itemCount": 2,
"totalItemCount": 2,
"items": [{"_type": "transferType",
"authorizationScope": null,
"authorizationURL": null,
"comment": null,
"description": "Amazon S3",
"displayName": "Amazon S3",
"guid": "508e47b8-98d2-4c1e-8529-8e1da48b97e1",
"id": "S3",
"sid": 3,
"sortOrderNumber": 4,
"systemModifiedDatetime": "2022-10-05T11:37:24",
"tokenURL": null
},
{"_type": "transferType",
"authorizationScope": null,
"authorizationURL": null,
"comment": null,
"description": "SFTP",
"displayName": "SFTP",
"guid": "c6074462-c23b-4384-8a78-166b83fdddd2",
"id": "SFTP",
"sid": 4,
"sortOrderNumber": 3,
"systemModifiedDatetime": "2022-10-05T11:37:24",
"tokenURL": null
}
]
},
"errors": [ ],
"warnings": [ ],
"hasErrors": false,
"hasWarnings": false
}

Get a single Transfer Type

Read the data for a single Transfer Type Item.

SecurityHeaderToken

Request

path Parameters

guid

required

string

Transfer Type Unique Identity

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: example-1 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: example-1 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.

Responses

200

Success

403

Forbidden

404

Not Found

405

Method Not Allowed

500

Internal Server Error

get/api/data/transferTypes/{guid}

Response samples

200
403
404
405
500

application/json

{"result": {"_type": "transferType",
"authorizationScope": null,
"authorizationURL": null,
"comment": null,
"description": "Amazon S3",
"displayName": "Amazon S3",
"guid": "508e47b8-98d2-4c1e-8529-8e1da48b97e1",
"id": "S3",
"sid": 3,
"sortOrderNumber": 4,
"systemModifiedDatetime": "2022-10-05T11:37:24",
"tokenURL": null
},
"errors": [ ],
"warnings": [ ],
"hasErrors": false,
"hasWarnings": false
}