Declaration Download - Generate new
This document describes how to use the Substantio REST API endpoint for exporting declaration requests—specifically IPC-1752A compliant material declarations.
The API returns a unified compliance evaluation for all applicable regulations based on all declarations provided.
REST Endpoint Template
[http/https]://{servername}:{port}/sb/api/data/part/exp/ext-api
?accessToken={token}
&type={type}
&[mode={mode}]
&[search_parameters]
Parameters Overview
1. accessToken Parameter
2. type Parameter
Determines which declarations are included in the export.
3. Parameter
Controls which parts of the declaration request are exported.
If omitted, only material compliance is exported.
4. Search Parameters (search_parameters)
These optional parameters refine which declarations are returned.
4.1 Submission Status Filters
4.2 Date Filters
All date values must use YYYY-MM-DD format.
4.3 Distribution Type
5. Example Request
http://sb-server.com/sb/api/data/part/exp/ext-api
?accessToken=f3fc33a4-016b-46b8-a609-c00dc501808f
&type=all
&submitted=yes
&submittedFrom=2021-05-01
&submittedUntil=2021-05-30
Explanation:
Returns all declarations requested by any user in the authenticated user’s company that were submitted between 1–30 May 2021.
6. Notes & Best Practices
- Ensure the accessToken is valid; expired tokens will result in authentication errors.
- Use HTTPS to protect sensitive data.
- type=all should only be used by Company Admins.
- If only IPC-1752A material data is needed, omit mode for fastest performance.
