Visit Rightsline
logo
Powered by Redocly

Transaction Import

You can use Alliant API to Import Transaction data to the Alliant system by sending requests with pages of Transaction data to the Import Transaction endpoints.  When all of the Transactions in an Import Transaction Batch have been sent, you use the Submit parameter to submit the Import Batch Job for processing by the Import Batch Service. When you want to Import Transaction data into the Alliant system, you must first create the Import Transaction Batch using the HTTP POST api/Import/Transactions/Batch endpoint. You can send the first page of Transaction data with the POST endpoint. When the Import Transaction Batch includes only a single page of Transaction data that is included in the POST request, you can create the Import Transaction Batch and submit it for processing in the same request using the Submit parameter. When the Import Transaction Batch includes multiple pages of Transaction data, you send each page of Transactions and submit the batch for processing using the HTTP PATCH api/Import/Transactions/Batch/{batchId} endpoint after the Import Transaction Batch is created using the HTTP POST endpoint. You can read the data for an Import Transaction Batch using the HTTP GET api/Import/Transactions/Batch/{batchId} endpoint. When you want to clear the Transactions from an Import Transaction Batch, you can use the HTTP POST api/Import/Transactions/Batch/{batchId}/clear.

Create an Import Transaction Batch

When you want to Import Transaction data into the Alliant system, you must first issue this endpoint to create the Import Transaction Batch.

The POST Request Body must include the Import File Name, the page size (the number of Transactions to be submitted per batch), and the total number of Transactions. When a batch of Transaction data is included in the initial POST Request, the POST Request Body also includes a Description for the batch, a page number for the batch, and an array of Transaction data. When the entire batch of Transactions is contained within the POST request, you can use the Submit parameter to submit the job for processing in the same request. The request response includes the batchId value used to submit subsequent pages of Import Transaction data for the Batch Job.

SecurityHeaderToken
Request
query Parameters
submit
integer

Use the submit parameter to submit the Import job for processing by the Import Batch Service. You should only include this parameter with the last page of Transactions or after all of the Transactions for the batch have been submitted.

jobPriority
integer

Use the jobPriority parameter when submitting the Import Job to set the Job Priority value for the Import Job. When you do not specify this value when submitting the Import Job, the Highest Priority value for the associated Job Class is used for the Import Job. This value is ignored when the submit parameter is not present.

Examples:
Specifies a Job Priority value of 1.
jobPriority=1
jobClass
string

Use the jobClass parameter when submitting the Import Job to specify the Job Class for the Import Job. When you do not specify this value when submitting the Import Job, the first Job Class in the Alliant system for which the Alliant User has permissions (determined alphabetically by the Job Class Description values) is used for the Import Job. This value is ignored when the submit parameter is not present.

Examples:
Specifies the 'Any Time of the Day' Job Class.
jobClass=Any Time of the Day
Request Body schema: application/json
required

Include as much information as possible regarding the Import Transaction Batch

importFileName
required
string [ 1 .. 255 ] characters

Specify the name of the Import File Definition that you want to use to Import the Transaction data. The Import File Definition must be associated with an Import File Type that is configured to use the Transaction Staging Area to Import to the Posted History table.

description
string [ 1 .. 255 ] characters

Specify a Description for the Import Transaction Batch.

pageSize
required
integer [ 1 .. 4 ] characters

Specify the page size (the number of Transactions per page) for submitting Transactions for the Batch. This is a required value that must be between 1 and 1000.

totalTransactions
required
integer [ 1 .. 10 ] characters

Specify the total number of Transactions to be submitted for the Batch. This is a required value that must be between 1 and 2147483647.

pageNumber
integer

Specify a Page Number value for the Transactions included in the request, when necessary. This must be a unique value for the Import Transaction Batch. The first Page Number must be 0, the second Page Number is 1, and so forth.

Array of objects (Transaction Request Properties)

Transactions

Responses
201

OK

400

Bad Request

403

Forbidden

404

Not Found

405

Method Not Allowed

409

Conflict

415

Unsupported Media Type

500

Internal Server Error

post/api/import/transactions/batch
Request samples
application/json
{
  • "importFileName": "APITransactions",
  • "description": "Transaction Import from Alliant API",
  • "pageSize": 2,
  • "totalTransactions": 2
}
Response samples
application/json
{
  • "result": {
    },
  • "errors": [ ],
  • "warnings": [ ],
  • "hasErrors": false,
  • "hasWarnings": false
}

Submit Transactions for an Import Transaction Batch

Once the Import Transaction Batch is created using the HTTP POST endpoint, you submit each page of Transactions using this endpoint.

When you are submitting a page of Transaction data, the PATCH Request Body must include the Page Number for the Transactions and an array of Transaction data.  When you are submitting the final page of Transactions, you can also include the Submit parameter to submit the batch for processing.

When you are not submitting a page of Transaction data but only submitting the batch for processing, no Request Body data is required and you must include the Submit parameter to submit the batch for processing.

Note: You cannot submit pages of Transactions to an Import Transaction Batch that has been cleared. When you clear an Import Transaction Batch, the Transaction data is removed from the Database. However, you must create a new Import Transaction Batch to submit new pages of Transactions.

SecurityHeaderToken
Request
path Parameters
batchID
required
string

Import Transaction Batch ID

query Parameters
submit
integer

Use the submit parameter to submit the Import job for processing by the Import Batch Service. You should only include this parameter with the last page of Transactions or after all of the Transactions for the batch have been submitted.

jobPriority
integer

Use the jobPriority parameter when submitting the Import Job to set the Job Priority value for the Import Job. When you do not specify this value when submitting the Import Job, the Highest Priority value for the associated Job Class is used for the Import Job. This value is ignored when the submit parameter is not present.

Examples:
Specifies a Job Priority value of 1.
jobPriority=1
jobClass
string

Use the jobClass parameter when submitting the Import Job to specify the Job Class for the Import Job. When you do not specify this value when submitting the Import Job, the first Job Class in the Alliant system for which the Alliant User has permissions (determined alphabetically by the Job Class Description values) is used for the Import Job. This value is ignored when the submit parameter is not present.

Examples:
Specifies the 'Any Time of the Day' Job Class.
jobClass=Any Time of the Day
Request Body schema: application/json
required

Include the Page Number and the Transaction data for the page of Transactions.

Note: The Request Body is required only when submitting a page of Transaction data. When submitting the Import job for processing without a page of Transaction data, no Request Body is required.

pageNumber
integer

Specify a Page Number value for the Transactions included in the request, when necessary. This must be a unique value for the Import Transaction Batch. The first Page Number must be 0, the second Page Number is 1, and so forth.

Array of objects (Transaction Request Properties)

Transactions

Responses
200

OK

400

Bad Request

403

Forbidden

404

Not Found

405

Method Not Allowed

409

Conflict

415

Unsupported Media Type

500

Internal Server Error

patch/api/import/transactions/batch/{batchID}
Request samples
application/json
{
  • "pageNumber": 0,
  • "transactions": [
    ]
}
Response samples
application/json
{
  • "result": { },
  • "errors": [ ],
  • "warnings": [ ],
  • "hasErrors": false,
  • "hasWarnings": false
}

Read Import Transaction Batch Data

Read the data for an Import Transaction Batch.

SecurityHeaderToken
Request
path Parameters
batchID
required
string

Import Transaction Batch ID

query Parameters
pageNumber
integer

Use the pageNumber parameter when reading Import Transaction Batch data to specify the page of Transaction data that you want to retrieve, when applicable. The first Page Number is 0, the second Page Number is 1, and so forth.

Examples:
Specifies a Page Number value of 1.
pageNumber=1
Responses
200

OK

400

Bad Request

403

Forbidden

404

Not Found

405

Method Not Allowed

409

Conflict

415

Unsupported Media Type

500

Internal Server Error

get/api/import/transactions/batch/{batchID}
Response samples
application/json
{
  • "result": {
    },
  • "errors": [ ],
  • "warnings": [ ],
  • "hasErrors": false,
  • "hasWarnings": false
}

Clear the Transactions from an Import Transaction Batch

Clear the Transactions from an Import Transaction Batch. This endpoint removes the Transactions in the Import Transaction Batch from the database. You should use this Tool when Transactions were mistakenly added in an Import Transaction Batch or when an error occurs while processing the Import job, as necessary. You can no longer use an Import Transaction Batch once it is cleared. When you want to resubmit any cleared Transactions, you must create a new Import Transaction Batch.

Note: You cannot submit pages of Transactions to an Import Transaction Batch that has been cleared. When you clear an Import Transaction Batch, the Transaction data is removed from the Database. However, you must create a new Import Transaction Batch to submit new pages of Transactions.

SecurityHeaderToken
Request
path Parameters
batchID
required
string

Import Transaction Batch ID

query Parameters
includeSuspense
integer

Use the includeSuspense parameter to clear any Suspense rows that are associated with the Transactions. When you do not include this parameter, any Suspense rows that are associated with the Transactions in the Batch remain.

Responses
200

OK

400

Bad Request

403

Forbidden

404

Not Found

405

Method Not Allowed

409

Conflict

415

Unsupported Media Type

500

Internal Server Error

post/api/import/transactions/batch/{batchID}/clear
Response samples
application/json
{
  • "result": null,
  • "errors": [ ],
  • "warnings": [ ],
  • "hasErrors": false,
  • "hasWarnings": false
}

Get multiple Import Transaction Batches

Read the data for multiple Import Transaction Batches.

You can use the parameters available for multiple-Item endpoints to filter the results based on the Batch ID (returned as the sid parameter) or the Job Queue Globally Unique Identifier (returned as the jobQueueGUID parameter).  For example, when you want to Read the information for an API Transaction Import Batch with the batchId value of 1, the endpoint can be as follows:

{Base Address}/api/data/stagingAPIBatch?$Filter=sid eq 1

SecurityHeaderToken
Request
query Parameters
$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
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
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

500

Internal Server Error

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

Get a single Import Transaction Batch

Read the data for a single Import Transaction Batch.

SecurityHeaderToken
Request
path Parameters
guid
required
string

API Transaction Import Batch 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:
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
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

500

Internal Server Error

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

Get multiple Job Queue Summaries

Read the Job Queue Information for an API Transaction Import Batch Job.

You can use the parameters available for multiple-Item endpoints to filter the results based on the Job Queue Globally Unique Identifier (returned as the jobQueueGUID parameter when you read the data for an API Transaction Import Batch).  For example, when you want to Read the information for an API Transaction Import Batch with the jobQueueGUID value of 51fe9515-0eb7-4ab9-90ed-847b867e3ba7, the endpoint can be as follows:

{Base Address}/api/data/JobQueueSummaries?$filter=jobQueueGUID eq '51fe9515-0eb7-4ab9-90ed-847b867e3ba7'

SecurityHeaderToken
Request
query Parameters
$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
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
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

500

Internal Server Error

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

Get multiple Transmission History Entries

Read the Transmission History information for an API Transaction Import Batch Job.

You can use the parameters available for multiple-Item endpoints to filter the results based on the System ID (SID) value for the apiBatchReference property, which corresponds to the batchID value for the API Transaction Import Batch.  For example, when you want to Read the Transmission History information for an API Transaction Import Batch Job with the System ID (SID) value of 1 for the apiBatchReference property, the endpoint can be as follows:

{Base Address}/api/data/TransmissionHistories?$Filter=apiBatchReference.SID eq 1

Note: When you use Alliant API to submit an Import Transaction Batch and there are configuration issues that prevent the batch from being added to Import Transmission History, the batchID value for the Import Transaction Batch and the System ID (SID) value for the apiBatchReference property in Transmission History can get out of sync. When this occurs, use the Import Transaction Batch Clear endpoint to clear any batches that were submitted with the incorrect configuration.  The batchID value for subsequent Import Transaction Batches will correspond to the System ID (SID) value for the apiBatchReference property in Transmission History.

SecurityHeaderToken
Request
query Parameters
$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
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
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

500

Internal Server Error

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

Get multiple Transmission History Error Records

You can use the parameters available for multiple-Item endpoints to filter the results based on the System ID (SID) value for the apiBatchReference property, which corresponds to the batchID value for the API Transaction Import Batch.  For example, when you want to Read the Transmission History error information for an API Transaction Import Batch Job with the System ID (SID) value of 1 for the apiBatchReference property, the endpoint can be as follows:

{Base Address}/api/data/TransmissionHistoryErrors?$Filter=apiBatchReference.SID eq 1

Note: When you use Alliant API to submit an Import Transaction Batch and there are configuration issues that prevent the batch from being added to Import Transmission History, the batchID value for the Import Transaction Batch and the System ID (SID) value for the apiBatchReference property in Transmission History can get out of sync. When this occurs, use the Import Transaction Batch Clear endpoint to clear any batches that were submitted with the incorrect configuration.  The batchID value for subsequent Import Transaction Batches will correspond to the System ID (SID) value for the apiBatchReference property in Transmission History Errors.

SecurityHeaderToken
Request
query Parameters
$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
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
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

500

Internal Server Error

get/api/data/TransmissionHistoryErrors
Response samples
application/json
{
  • "result": {
    },
  • "errors": [ ],
  • "warnings": [ ],
  • "hasErrors": false,
  • "hasWarnings": false
}
➔ Next to Miscellaneous Endpoints