Jurisdiction Transactions
The API Jurisdiction transactions can be used to create, update, delete and retrieve jurisdiction entities in the CMDB.
Limited Support/End of Life Capabilities
The Classic API has been replaced by the Alemba RestFul API. While we will continue to support the Classic API for clients that are still using it, no further development will be done.
If you need to request a hotfix or support for these features, please contact Alemba Support
JurisdictionCreate Transaction
The JurisdictionCreate transaction can be used to create a new jurisdiction record and save its details.
Input Parameters: JurisdictionCreateRequest
Argument | Type | Mandatory | Default | Description |
sID | String | No. See Transaction Login. | “” | Analyst’s current Session ID |
sLoginUserID | String | No. See Transaction Login. | “” | Analyst’s Login ID |
sLoginPassword | String | No. See Transaction Login. | “” | Analyst’s Password |
sDatabase | String | No. See Transaction Login. | “” | Name of the ASM System for logging in. |
lEntityRef | Lookup Field | Ignored | - | Ignored on Create |
sGroupName | String | No | “” | Jurisdiction Group name |
sDescription | String | No | “” | Jurisdiction Description |
lPartition | Lookup Field | No | Analyst’s default partition | Partition in which to create this Jurisdiction |
sReason | String | No | “” | Audit reason |
aCustomParameters | Array | No | “” | See Defining Custom Parameters. |
Return Values:JurisdictionResponse
Argument | Type | Description |
nEntityRef | Integer | Newly created jurisdiction ref |
sMessage | String | Error/Warning message returned from API |
Ret | APIReturn | Error/Warning number returned from API |
JurisdictionUpdate Transaction
The JurisdictionUpdate transaction can be used to update the details of an existing jurisdiction record.
Input Parameters: JurisdictionUpdateRequest
Argument | Type | Mandatory | Default | Description |
sID | String | No. See Transaction Login. | “” | Analyst’s current Session ID |
sLoginUserID | String | No. See Transaction Login. | “” | Analyst’s Login ID |
sLoginPassword | String | No. See Transaction Login. | “” | Analyst’s Password |
sDatabase | String | No. See Transaction Login. | “” | Name of the ASM System for logging in. |
lEntityRef | Lookup Field | Yes | - | Reference number of the Jurisdiction to update |
sGroupName | String | No | (As is) | Jurisdiction Group name |
sDescription | String | No | (As is) | Jurisdiction Description |
lPartition | Lookup Field | No | (As is) | Partition in which to create this Jurisdiction |
sReason | String | No | “” | Audit reason |
aCustomParameters | Array | No | “” | See Defining Custom Parameters. |
Return Values: JurisdictionResponse
See JurisdictionResponse for more information.
JurisdictionRetrieve Transaction
The JurisdictionRetrieve transaction can be used to retrieve the details of a Jurisdiction record.
Input Parameters: JurisdictionEntityRequest
Argument | Type | Mandatory | Default | Description |
sID | String | No. See Transaction Login. | “” | Analyst’s current Session ID |
sLoginUserID | String | No. See Transaction Login. | “” | Analyst’s Login ID |
sLoginPassword | String | No. See Transaction Login. | “” | Analyst’s Password |
sDatabase | String | No. See Transaction Login. | “” | Name of the ASM System for logging in. |
lEntityRef | Lookup Field | Yes | - | Reference number of the Jurisdiction to retrieve |
aCustomParameters | Array | No | “” | See Defining Custom Parameters. |
Return Parameters: JurisdictionRetrieveResponse
Argument | Type | Description |
Ret | APIReturn | Error/Warning number returned from by API |
sMessage | String | Error/Warning message returned by the API |
ResultSet | DataSet | ResultSet containing attribute details |
JurisdictionDelete Transaction
The JurisdictionDelete transaction can be used to find and delete a jurisdiction record. After the transaction is executed, the status and audit trail are updated.
Input Parameters: JurisdictionDeleteRequest
Argument | Type | Mandatory | Default | Description |
sID | String | No. See Transaction Login. | “” | Analyst’s current Session ID |
sLoginUserID | String | No. See Transaction Login. | “” | Analyst’s Login ID |
sLoginPassword | String | No. See Transaction Login. | “” | Analyst’s Password |
sDatabase | String | No. See Transaction Login. | “” | Name of the ASM System for logging in. |
lEntityRef | Lookup Field | Yes | - | Reference number of the Jurisdiction to delete |
sReason | String | No | “” | Audit reason |
aCustomParameters | Array | No | “” | See Defining Custom Parameters. |
Return Values: JurisdictionResponse
See JurisdictionResponse for more information.