How Can We Help?
Substantio TC API
REST Link template for downloading declaration requests
Link representation like the following:
https://[servername]:[port]/sb/api/data/part/exp/ext-api?accessToken=[token]&type=[type]&mode=[mode]&[search_parameters]
Link representation for example
https://sb-server.com/sb/api/data/part/exp/ext-api?accessToken=f3fc33a4-016b-46b8-a609-c00dc501808f&type=all&mode=sc&submitted=yes&submittedFrom=2021-05-01&submittedUntil=2021-05-30</
Endpoint returns material declarations requested by anyone in user’s company and submitted in May 2021.
Explanation of the elements in the link:
The [token]
The [token]
Access token, obtained from Substantio. This token serves for authentication. To find the token choose Settings, as shown in the slide show.
The [type]
The [type]
The type defines the search scope.
The [mode]
The [mode]
Mode controls which areas of declaration request will be exported. It is NOT mandatory – if left out from the REST link, material compliance declaration is exported only.
The [search_parameters]
The [search_parameters]
Search Parameters define Request attributes to process.
Works as “&[ParameterName]=[ParameterValue]”
Parameter |
Possible values |
Alternative value |
Explanation |
submitted |
All |
|
Returns all declarations, submitted and not submitted. |
|
|
allExSolved |
allExSolvedAck |
All except solved, resent or acknowledged. |
|
|
Yes |
|
Returns only submitted declarations. |
|
|
YesNW |
|
Returns only declarations, which were submitted without warnings (complete declarations). |
|
|
YesWW |
|
Returns only declarations, which were submitted with warnings (incomplete declarations). |
|
|
No |
|
Returns declarations which were not submitted. |
|
|
Sos |
solsuback |
Returns submitted, solved internally and acknowledged declarations. |
|
|
Solved |
|
Returns internally solved declarations. |
|
|
acknowledged |
|
Returns acknowledged declarations. |
|
|
acksub |
|
Returns acknowledged or submitted declarations. |
|
|
ReqONLY |
|
Requested only, not seen. |
|
|
SeenONLY |
|
Seen only |
|
|
SeenOrReq |
|
Requested only, not seen. |
submittedFrom |
Date (YYYY-MM-DD) |
|
Submitted from a specified date. |
submittedUntil |
Date (YYYY-MM-DD) |
|
Submitted until a specified date. |
requestedFrom |
Date (YYYY-MM-DD) |
|
Requested from a specified date. |
requestedUntil |
Date (YYYY-MM-DD) |
|
Requested until a specified date. |
lastUpdatedFrom |
Date (YYYY-MM-DD) |
|
Updated from a specific date. |
lastUpdatedUntil |
Date (YYYY-MM-DD) |
|
Updated until a specific date. |
distributionType |
all |
|
Returns all requests. |
|
|
in-house |
|
Returns all requests marked as in-house (were not sent). |
|
|
supplier |
|
Return all supplier requests (requests sent to suppliers). |
