Using API
The SSCC Management apps provides a complete API set to manage SSCC via API. This on could be used to interact with powerplatform.
Packagetype resource type
Methods
| Method | Return Type | Description | |
|---|---|---|---|
| GET | packagetype | Gets an array of packagetype objects. |
Properties
| Property | Type | Description | |
|---|---|---|---|
| code | string | Specifies the package code (20 digits) as defined on the Package Type list. | |
| description | string | Specifies the package description. | |
| externalCode | string | Specifies the package external code. | |
| id | Guid | The Unique ID of the package type. |
HTTP request
Get request
Replace the URL prefix for Business Central depending on environment following the guideline.
GET businesscentralPrefix/api/isatech/sscc/v1.0/companies({companyId})/packageTypes
Returned Value
{
"value": [
{
"@odata.etag": "string",
"code": "string",
"description": "string",
"externalCode": "string",
"systemId": "guid"
}
]
}
SSCC resource type
Methods
| Method | Return Type | Description | |
|---|---|---|---|
| GET | sscc | Gets an array of sscc objects. | |
| POST | sscc | Create a sscc object. | |
| PATCH | sscc | Update a sscc object. |
Properties
| Property | Type | Description | |
|---|---|---|---|
| ssccNo | string | Specifies the SSCC number. | |
| packageType | string | PackageType Code. | |
| status | string | SSCC status. | |
| userID | string | User ID Code identifier. | |
| id | Guid | The Unique ID of the sscc type. |
HTTP request
Get request
Replace the URL prefix for Business Central depending on environment following the guideline.
GET businesscentralPrefix/api/isatech/sscc/v1.0/companies({companyId})/sscc
Direct filtering is possible on id, userID and ssccNo using following oData filtering syntaxes
GET businesscentralPrefix/api/isatech/sscc/v1.0/companies({companyId})/sscc?filter eq id
GET businesscentralPrefix/api/isatech/sscc/v1.0/companies({companyId})/sscc?filter eq userID
GET businesscentralPrefix/api/isatech/sscc/v1.0/companies({companyId})/sscc?filter eq ssccNo
Returned Value
{
"value": [
{
"@odata.etag": "string",
"id": "guid",
"ssccNo": "string",
"packageType": "string",
"status": "srting",
"userID": "string"
}
]
}
Bound Actions
The SSCC resource type offers a bound action called print which prints the corresponding SSCC Label. This feature uses the SSCC Label report selection to select the corresponding report. This is illustrated in the following example:
POST businesscentralPrefix/api/isatech/sscc/v1.0/companies({companyId})/sscc/Microsoft.NAV.print
The response has no content; the response code is 204.