Transaction Characteristic Import

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

Create an Import UserX Batch

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

The POST Request Body must include the Import File Name, the page size (the number of UserXs to be submitted per batch), and the total number of UserXs. When a batch of UserX 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 UserX data. When the entire batch of UserXs 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 UserX 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 Items or after all of the Items 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: example-1 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: example-1 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 UserX Batch

importFileName required	string [ 1 .. 255 ] characters Specify the name of the Import File Definition that you want to use to Import the UserX data. The Import File Definition must be associated with an Import File Type that is configured to use the UserX Staging Area to Import to the Posted History table.
description	string [ 1 .. 255 ] characters Specify a Description for the Import UserX Batch.
pageSize required	integer [ 1 .. 4 ] characters Specify the page size (the number of UserXs per page) for submitting UserXs for the Batch. This is a required value that must be between 1 and 1000.
totalItems required	integer [ 1 .. 10 ] characters Specify the total number of UserXs 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 UserXs included in the request, when necessary. This must be a unique value for the Import UserX Batch. The first Page Number must be 0, the second Page Number is 1, and so forth.
	Array of objects (UserX Import Properties) userXs

Responses

201

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/userXs/batch

Request samples

Payload

application/json

{"importFileName": "APIUserXs",
"description": "UserX Import from Alliant API",
"pageSize": 2,
"totalItems": 2
}

Response samples

application/json

{"result": {"batchId": 1,
"jobQueueGuid": "e29a07ac-4391-4846-9cf6-492fbba5b2dc"
},
"errors": [ ],
"warnings": [ ],
"hasErrors": false,
"hasWarnings": false
}

Submit UserXs for an Import UserX Batch

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

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

When you are not submitting a page of UserX 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 UserXs to an Import UserX Batch that has been cleared. When you clear an Import UserX Batch, the UserX data is removed from the Database. However, you must create a new Import UserX Batch to submit new pages of UserXs.

SecurityHeaderToken

Request

path Parameters

batchID

required

string

Import UserX 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 Items or after all of the Items 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: example-1 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: example-1 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 UserX data for the page of UserXs.

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

pageNumber	integer Specify a Page Number value for the UserXs included in the request, when necessary. This must be a unique value for the Import UserX Batch. The first Page Number must be 0, the second Page Number is 1, and so forth.
	Array of objects (UserX Import Properties) UserXs

Responses

200

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/userXs/batch/{batchID}

Request samples

Payload

application/json

{"pageNumber": 0,
"items": [{"adminClassReference": {"id": "exampleID"
},
"comment": "Example Comment",
"description": "Pebbles 2: Secret of the Ooze",
"id": "004 Product",
"ipRightsBearingFlag": true,
"parentReference": {"id": "idOfParent"
},
"royaltyBearingFlag": true,
"ud_userDefinedStringField": "ud field Value",
"ud_userDefinedNumberField": 0,
"ud_userDefinedReference": {"id": "exampleID"
},
"udLookup_LookupUDField": {"udfLookupItems": [{"amount1Range": "1:3",
"amount2Range": "2:4",
"contact1Reference": {"id": "exampleID"
},
"contact2Reference": {"id": "exampleID"
},
"contact3Reference": {"id": "exampleID"
},
"contact4Reference": {"id": "exampleID"
},
"endActualPeriodReference": {"id": "exampleID"
},
"endOtherPeriodReference": {"id": "exampleID"
},
"endPostedPeriodReference": {"id": "exampleID"
},
"fromDate": "2019-08-24T14:15:22Z",
"price1Range": "4.21:30.45",
"price2Range": "5.24:532.21",
"rate1Range": "2.3:5.2",
"rate2Range": "8.6:45.2",
"rate3Range": "10.3:87.0",
"sortOrderNumber": 1,
"startActualPeriodReference": {"id": "exampleID"
},
"startOtherPeriodReference": {"id": "exampleID"
},
"startPostedPeriodReference": {"id": "exampleID"
},
"text1": "example text",
"text2": "example test",
"toDate": "2019-08-24T14:15:22Z",
"ud_LookupUDField": "exampleUDFValue",
"udKeyXHierarchyTypeReference": {"id": "exampleID"
},
"udKeyXListReference": {"description": "exampleDescription"
},
"udKeyXReference": {"id": "exampleID"
},
"unit1Range": "5:200",
"unit2Range": "5:100"
}
]
},
"user1BOMHeaders": [{"allocationMethodReference": {"registeredProdedureName": "NameOfProcedure"
},
"allocationUDFReference": {"name": "udfName"
},
"effectiveFromDate": "2021-08-06T00:00:00",
"effectiveToDate": "9999-12-31T23:59:59",
"user1BOMDetails": [{"allocationPercent": 100,
"largeSortOrderNumber": 1,
"quantity": 1,
"udKey1Reference": {"id": "exampleID"
}
}
]
}
]
}
]
}

Response samples

application/json

{"result": { },
"errors": [ ],
"warnings": [ ],
"hasErrors": false,
"hasWarnings": false
}

Read Import UserX Batch Data

Read the data for an Import UserX Batch.

SecurityHeaderToken

Request

path Parameters

batchID

required

string

Import UserX Batch ID

query Parameters

pageNumber

integer

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

Examples:

example-1

Specifies a Page Number value of 1.

pageNumber=1

Responses

200

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/userXs/batch/{batchID}

Response samples

application/json

{"result": {"importFileName": "userxs",
"importFileSID": 140,
"description": "UserX Import from Alliant API",
"fileDownloadNumber": null,
"pageSize": 2,
"totalItems": 2,
"batchId": 22,
"pageNumber": 0,
"receivedItems": 2,
"createdDateTime": "2022-27-25",
"items": [{"adminClassReference": {"id": "exampleID"
},
"comment": "Example Comment",
"description": "Pebbles 2: Secret of the Ooze",
"id": "004 Product",
"ipRightsBearingFlag": true,
"parentReference": {"id": "idOfParent"
},
"royaltyBearingFlag": true,
"ud_userDefinedStringField": "ud field Value",
"ud_userDefinedNumberField": 0,
"ud_userDefinedReference": {"id": "exampleID"
},
"udLookup_LookupUDField": {"udfLookupItems": [{"amount1Range": "1:3",
"amount2Range": "2:4",
"contact1Reference": {"id": "exampleID"
},
"contact2Reference": {"id": "exampleID"
},
"contact3Reference": {"id": "exampleID"
},
"contact4Reference": {"id": "exampleID"
},
"endActualPeriodReference": {"id": "exampleID"
},
"endOtherPeriodReference": {"id": "exampleID"
},
"endPostedPeriodReference": {"id": "exampleID"
},
"fromDate": "2019-08-24T14:15:22Z",
"price1Range": "4.21:30.45",
"price2Range": "5.24:532.21",
"rate1Range": "2.3:5.2",
"rate2Range": "8.6:45.2",
"rate3Range": "10.3:87.0",
"sortOrderNumber": 1,
"startActualPeriodReference": {"id": "exampleID"
},
"startOtherPeriodReference": {"id": "exampleID"
},
"startPostedPeriodReference": {"id": "exampleID"
},
"text1": "example text",
"text2": "example test",
"toDate": "2019-08-24T14:15:22Z",
"ud_LookupUDField": "exampleUDFValue",
"udKeyXHierarchyTypeReference": {"id": "exampleID"
},
"udKeyXListReference": {"description": "exampleDescription"
},
"udKeyXReference": {"id": "exampleID"
},
"unit1Range": "5:200",
"unit2Range": "5:100"
}
]
},
"user1BOMHeaders": [{"allocationMethodReference": {"registeredProdedureName": "NameOfProcedure"
},
"allocationUDFReference": {"name": "udfName"
},
"effectiveFromDate": "2021-08-06T00:00:00",
"effectiveToDate": "9999-12-31T23:59:59",
"user1BOMDetails": [{"allocationPercent": 100,
"largeSortOrderNumber": 1,
"quantity": 1,
"udKey1Reference": {"id": "exampleID"
}
}
]
}
]
}
]
},
"errors": [ ],
"warnings": [ ],
"hasErrors": false,
"hasWarnings": false
}

➔ Next to Reset

Transaction Characteristic Import

Create an Import UserX Batch

query Parameters

Request Body schema: application/jsonrequired

Submit UserXs for an Import UserX Batch

path Parameters

query Parameters

Request Body schema: application/jsonrequired

Read Import UserX Batch Data

path Parameters

query Parameters

Request Body schema: application/json
required

Request Body schema: application/json
required