For example, given below are sample request and response parameters.
-
Request parameters to get the Token:
Command
POST
URL
<<Get Token URL>>
Body
x-www-form-urlencoded
Grant_Type
Client_Credentials
Client_ID
876ED610-8093-430C-BED3-49BDFC2AB43A
Client_Secret
+MHrwwC2YQn5aF?iE3f)[vwKGNKQ: F3VfrNjki^0)2t[?^=#RiS5qJMWEE#c+n}E
Scope
ingr.api
Resource
3C1DC2AD-7806-4DE2-B565-276F139456F1
-
Request parameters to create a sync and update a sync – Tag to FLOC:
Command
POST
URL
<<API Destination URL>>
Authentication
Basic
Authorization
Basic (user name and password)
Request Headers
Content-Type: text/plain; charset=utf-8
Body
1011-VES-301,SPFKEY,6FIP0GNA|FDW
1011-VES-301,CATEGORY,M
1011-VES-301,STRIND,RE-FX
1011-VES-301,DESCRIPT,suction scrubber
1011-VES-301,EQINSTALL,X
1011-VES-301,MAINTPLANT,1000
1011-VES-301,CONFIGURATION,PL_PDA-PO
1011-VES-301,SUPFLOC,10-PUMPS
1011-VES-301,MANMODEL,SOLBERG-CST-900
1011-VES-301,MANFACTURE,SOLBERG
230-QD-4501-08,SPFKEY,074062A|FDW
230-QD-4501-08,CATEGORY,M
230-QD-4501-08,STRIND,RE-FX
230-QD-4501-08,DESCRIPT,PRESSURE TO CURRENT CONVERTER
230-QD-4501-08,EQINSTALL,X
230-QD-4501-08,MAINTPLANT,1000
230-QD-4501-08,SUPFLOC,10-PRESSURE INSTRUMENTS
230-QD-4501-08,CONFIGURATION,PL_PDA-PO
-
Response parameters to create a sync and update a sync – Tag to FLOC:
Command
POST
URL
https://localhost/SDxServer/api/v2/SDA/FLOCFeedback
Authentication
Client Credentials
Authorization
Bear token
Accept
application/vnd.intergraph.data+json
Request Headers
Content-Type: application/json; charset=utf-8
Body
{
"FLOCObjects":
[
{
"Name":"1011-VES-301",
"FLOCID":"?0100000000000000399",
"SPFKEY":"6FIP0GNA|FDW",
"Status":"SUCCESS",
"Message":"Functional location 1011-VES-301 successfully created",
"Configuration":"PL_PDA-PO"
},
{
"Name":"230-QD-4501-08",
"FLOCID":"?010000000000000088",
"SPFKEY":"074062A|FDW",
"Status":"SUCCESS",
"Message":"Functional location 230-QD-4501-08 successfully updated",
"Configuration":"PL_PDA-PO"
}
]
}
-
Request parameters to create a sync and update a sync – Asset to Equipment:
Command
POST
URL
<<API Destination URL>>
Authentication
Basic
Authorization
Basic (user name and password)
Request Headers
Content-Type: text/plain; charset=utf-8
Body
6FKI000A|FDW,,EQUICATGRY,M
6FKI000A|FDW,,CONFIGURATION,PL_PDA-PO
6FKI000A|FDW,,MAINTPLANT,1000
6FKI000A|FDW,,DESCRIPT,Vessel Head
6FKI000A|FDW,,FUNCLOC,1011-VES-301
6FKF000A|FDW,000000000010000506,EQUICATGRY,M
6FKF000A|FDW,000000000010000506,CONFIGURATION, PL_PDA-PO
6FKF000A|FDW,000000000010000506,MAINTPLANT,1000
6FKF000A|FDW,000000000010000506,DESCRIPT,Vessel Body
6FKF000A|FDW,000000000010000506,FUNCLOC, 1011-VES-301
-
Response parameters to create a sync and update a sync – Asset to Equipment:
Command
POST
URL
https://localhost/SDxServer/api/v2/SDA/AssetEquipmentSyncFeedback
Authentication
Client Credentials
Authorization
Bear token
Accept
application/vnd.intergraph.data+json
Request Headers
Content-Type: application/json; charset=utf-8
Body
{
"AssetSyncObjects":
[
{
"AssetID": "6FKF000A|FDW",
"EquipmentID":"10000507",
"Status":"SUCCESS",
"Message":"Equipment 10000507 successfully created.",
"Configuration":"PL_PDA-PO"
},
{
"AssetID": "6FKI000A|FDW",
"EquipmentID":"10000506",
"Status":"SUCCESS",
"Message":"Equipment 10000506 successfully updated.",
"Configuration":"PL_PDA-PO"
}
]
}
-
Request parameters to delete a sync – Tag to FLOC:
Command
POST
URL
<<API Destination URL>>
Authentication
Basic
Authorization
Basic (user name and password)
Request Headers
Content-Type: text/plain; charset=utf-8
Body
1011-VES-301,SPFKEY,6FK0003A
1011-VES-301,STATUS,DLFL
1011-VES-301,CONFIGURATION, PL_PDA-PO
-
Response parameters to delete a sync – Tag to FLOC:
Command
POST
URL
https://localhost/SDxServer/api/v2/SDA/DeleteFLOCFeedback
Authentication
Client Credentials
Authorization
Bear token
Accept
application/vnd.intergraph.data+json
Request Headers
Content-Type: application/json; charset=utf-8
Body
{
"FLOCObjects":
[
{
"Name":"1011-VES-301",
"SPFKEY":"6FPI00FA|SPXCommon",
"FLOCID":"?0100000000000001703",
"Status":"SUCCESS",
"Message":"Deletion flag has been successfully set",
"Configuration":"PL_PDA-PO"
}
]
}
-
Request parameters to delete a sync – Asset to Equipment:
Command
POST
URL
<<API Destination URL>>
Authentication
Basic
Authorization
Basic (user name and password)
Request Headers
Content-Type: text/plain; charset=utf-8
Body
6FKI000A,000000000010000507,STATUS,DLFL
6FKI000A,000000000010000507,CONFIGURATION, PL_PDA-PO
-
Response parameters to delete a sync – Asset to Equipment:
Command
POST
URL
https://localhost/SDxServer/api/v2/SDA/DeleteAssetEquipmentFeedback
Authentication
Client Credentials
Authorization
Bear token
Accept
application/vnd.intergraph.data+json
Request Headers
Content-Type: application/json; charset=utf-8
Body
{
"AssetSyncObjects":
[
{
"AssetID":"6FKI000A",
"EquipmentID":"10000507",
"Status":"SUCCESS",
"Message":"Deletion flag has been successfully set",
"Configuration":"PL_PDA-PO"
}
]
}