Interface for Synchronizing Data to ISA

Scenario

This interface is used to synchronize USM data to the ISA. Information such as OUs, operators, roles, and operator roles under AICC tenants can be synchronized to the ISA.

Interface Method

POST

URI

https://Domain name /apiaccess/rest/service-pub/v1/isa/dataSync. (For example, the domain name is service.besclouds.com.)

Request Description

**Table 1** Request header parameters
No.	Parameter	Type	Mandatory	Description
1	Content-Type	String	Yes	"application/json"
2	x-app-key	String	Yes	App key, which is the user ID.
3	Authorization	String	Yes	For details about the generation mode, see C1 System Configuration Interface Authentication.

**Table 2** Request body parameters
No.	Parameter	Mandatory	Type	Description
1	id	Yes	String	Request ID, which is unique.
2	username	No	String	Login account of the request initiator.
3	userPassword	No	String	Login password of the request initiator, which is encrypted by using AES128GCM.
4	messageSource	Yes	String	Entity that initiates data synchronization, for example, AICC.
5	action	Yes	String	The options are as follows: DataSync: Table: asynchronous synchronization message RealTime: Table: synchronous synchronization message
6	contentType	Yes	String	Message content. The option can be Xml or SFTP. Xml: When this parameter is set to Xml, the content parameter stores the data to be synchronized. XML is used. SFTP: When the option is SFTP, the content parameter stores the file name of the synchronized content on the SFTP server.
7	content	Yes	String	Synchronized content. When contentType is set to XML, the content is in XML format.
8	dataObjectId	No	String	Data item ID.
9	dataObjectType	No	String	Data item type ID.
10	extColumn1	Yes	String	Synchronization subscriber and subscription table corresponding to the synchronization subscriber.
11	extColumn2	Yes	String	Synchronization mode.
12	extColumn3	No	String	Reserved.
13	ftpInfo	No	object	SFTP service configuration. The detailed synchronization result cannot be obtained in file synchronization mode. Therefore, you are advised not to use this node.

**Table 3** FtpInfo parameters
No.	Parameter	Mandatory	Type	Description
1	id	No	String	IP address of the SFTP server.
2	user	No	String	SFTP server user.
3	password	No	String	User password for logging in to the SFTP server.
4	path	No	String	Working path of the SFTP server.

Response Description

Response status code: 200

**Table 4** Response body parameters
No.	Parameter	Mandatory	Type	Description
1	returnCode	Yes	String	Response result code. 0: success; other values: failure.
3	description	No	String	Response result description.

Error Code

Response status code: 400
Incorrect request. Check the request path and parameters.
Response status code: 401
Unauthorized operation. 1. Check whether you have purchased related services. 2. Contact customer service to check the status of your account.
Response status code: 403
The authentication fails.
Response status code: 404
The requested content is not found. Check the request path.
Response status code: 500
Business failure. Check the values of parameters in the request.

Example

Scenario: Synchronize organization information to ISA.

URL: https://Domain name/apiaccess/rest/service-pub/v1/isa/dataSync

Request header

Content-Type: application/json
x-app-key: *****
Authorization: *****

Request Description:

{
    "id": "xxxxx123465651261",
    "username": "datasync",
    "userPassword": "******",
    "messageSource": "AICC",
    "action": "RealTime: Table",
    "contentType": "Xml",
    "content": "<![CDATA[ <operations> <operation type=\"DELETE\"> <metadata> <table name=\"SYS_ORG\" alias=\"SYS_ORG\"/> <columns> <column name=\"ORG_ID\" type=\"12\" isKey=\"true\" condition=\"0\"></column> </columns> </metadata> <records> <record> <field name=\"ORG_ID\">1831238558</field> </record> </records> </operation> <operation type=\"SmartInsert\"> <metadata> <table name=\"SYS_ORG\" alias=\"SYS_ORG\"/> <columns> <column name=\"ORG_ID\" type=\"12\" isKey=\"true\" condition=\"0\"></column> <column name=\"ORG_ID_NUM\" type=\"2\" isKey=\"false\" condition=\"0\"></column> <column name=\"ORG_TYPE\" type=\"12\" isKey=\"false\" condition=\"0\"></column> <column name=\"ORG_NAME\" type=\"12\" isKey=\"false\" condition=\"0\"></column> <column name=\"PARENT_ORG_ID\" type=\"12\" isKey=\"false\" condition=\"0\"></column> <column name=\"BE_ID\" type=\"12\" isKey=\"false\" condition=\"0\"></column> <column name=\"BE_CODE\" type=\"12\" isKey=\"false\" condition=\"0\"></column> <column name=\"B_REGION_ID\" type=\"12\" isKey=\"false\" condition=\"0\"></column> <column name=\"B_REGION_CODE\" type=\"12\" isKey=\"false\" condition=\"0\"></column> <column name=\"ORG_CODE\" type=\"12\" isKey=\"false\" condition=\"0\"></column> <column name=\"CHANNEL_FLAG\" type=\"1\" isKey=\"false\" condition=\"0\"></column> <column name=\"STATUS\" type=\"12\" isKey=\"false\" condition=\"0\"></column> <column name=\"CREATE_OPER_ID\" type=\"12\" isKey=\"false\" condition=\"0\"></column> <column name=\"CREATE_TIME\" type=\"93\" isKey=\"false\" condition=\"0\"></column> <column name=\"MODIFY_TIME\" type=\"93\" isKey=\"false\" condition=\"0\"></column> </columns> </metadata> <records> <record> <field name=\"ORG_ID\">2833237838</field> <field name=\"ORG_ID_NUM\">2833237838</field> <field name=\"ORG_TYPE\">D</field> <field name=\"ORG_NAME\">default organization</field> <field name=\"PARENT_ORG_ID\"></field> <field name=\"BE_ID\">2841807204</field> <field name=\"BE_CODE\">101284180720400</field> <field name=\"B_REGION_ID\">101</field> <field name=\"B_REGION_CODE\">101</field> <field name=\"ORG_CODE\">1012841807204-TSV</field> <field name=\"CHANNEL_FLAG\">N</field> <field name=\"STATUS\">1</field> <field name=\"CREATE_OPER_ID\">101</field> <field name=\"CREATE_TIME\">20130702070133</field> <field name=\"MODIFY_TIME\">20130703015003</field> </record> </records> </operation> </operations> ]]>",
    "extColumn1": "AICC:SYS_ORG",
    "extColumn2": "sasda"
}