Substantio TC API

REST Link template for downloading declaration requests

https://[servername]:[port]/sb/api/data/part/exp/ext-api?accessToken=[token]&type=[type]&mode=[mode]&[search_parameters]

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.

[token]

Access token, obtained from Substantio. This token serves for authentication.

[type]

Type defines search scope

[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.

[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 specified date
submittedUntil
Date (YYYY-MM-DD)
 
Submitted until specified date
requestedFrom
Date (YYYY-MM-DD)
 
Requested from specified date
requestedUntil
Date (YYYY-MM-DD)
 
Requested until specified date
lastUpdatedFrom
Date (YYYY-MM-DD)
 
Updated from specific date
lastUpdatedUntil
Date (YYYY-MM-DD)
 
Updated until 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).

Subscribe to our Newsletter!

Stay in the loop on product compliance, regulations, and new software features.

When you send the form, the data you provide will be processed for the purpose of handling the enquiry(s) by Substantio GmbH, Warthestr. 23, 32427 Minden. Your data will be processed strictly for the intended purpose. For further information on the processing of your data within our website, please refer to our Data Protection Information.