Managing App and Solution Artifacts

12min

Overview
The Artifacts APIs enable developers to add, remove, update and download artifacts for a given app or solution. The following section walks you through how to manage the following supported artifacts on the OS1 Platform:
Icons
Images
Documents
Permission files
Note that this is a common set of APIs for both App and Solution. 
﻿
1. Uploading Artifacts
Purpose:
Upload various artifacts, including icons, images, documents, and permission files, for a specific version of an application or solution.
Endpoint
﻿POST /developer/artifacts﻿
Body Parameters
Parameter
Description
file
The file to be uploaded. Max size is 10MB. 
﻿Using Postman﻿
In Postman, select File from Key dropdown menu to choose a file to upload. 
﻿
﻿
﻿
Query Parameters
Parameter
Description
appVersionId
The Version ID of the App. Provide this ID for app types. 
solutionVersionId
The Version ID of the Solution. Provide this ID for solution types. 
artifactType*﻿
This ENUM attribute will specify the artifact type. Possible values:
ICON, IMAGE, DOCS, PERMFILE, PERMFILE_WEB_CLIENT, ALL. Note that PERMFILE and PERMFILE_WEB_CLIENT or only valid for app types.
﻿Required Attributes﻿
(*) Indicates that the attribute is required. 
﻿
Example Request:
POST /developer/artifacts?&appVersionId=appversion:1f866da9-6205-5760-a82e-94acb79dcd1e&artifactType=ICON
﻿
Response:
On success, the response provides the fileID and the URL where the artifact has been uploaded.
﻿
2. Retrieving Artifacts
Purpose:
Retrieve specific artifacts, like icons, images, documents, and permissions files, linked to a version of an application or solution. If you want to download a permissions file, use the download artifacts API﻿
Endpoint
﻿GET /developer/artifacts﻿
Query Parameters
Parameter
Description
appVersionId
The Version ID of the App.
solutionVersionId
The Version ID of the Soln. 
artifactType*

This ENUM attribute will specify the artifact type. Possible values:
ICON, IMAGE, DOCS, PERMFILE, PERMFILE_WEB_CLIENT, ALL
Example Request:
GET /developer/artifacts?&appVersionId=appversion:1f866da9-6205-5760-a82e-94acb79dcd1e&artifactType=ICON

Response:
A successful response returns all artifacts associated with the given appVersionId or solnVersionId.
Response
{
    "data": {
        "images": [
            {
                "artifactId": "c8a5a7b7-abc2-41b5-80c9-2bba4a7a2341",
                "fileName": "myimage.png",
                "fileDescription": "image/png",
                "fileUrl": "https://cdn.getos1.com/8d9b6bfe-41f0-4c27-af01-df7862ad0e82-OS1_-LocateOne.png",
                "filePath": ""
            }
        ]
    }
}

{
    "data": {
        "images": [
            {
                "artifactId": "c8a5a7b7-abc2-41b5-80c9-2bba4a7a2341",
                "fileName": "myimage.png",
                "fileDescription": "image/png",
                "fileUrl": "https://cdn.getos1.com/8d9b6bfe-41f0-4c27-af01-df7862ad0e82-OS1_-LocateOne.png",
                "filePath": ""
            }
        ]
    }
}
﻿
﻿
3. Deleting Artifacts
Purpose:
Remove specific artifacts, including icons, images, documents, and permission files, associated with a particular version of an application or solution.
Endpoint
﻿DELETE /developer/artifacts/{artifactId}﻿
Path Parameters
Parameter
Description
artifactId
The ID of the artifact.
Query Parameters
Parameter
Description
appVersionId
The Version ID of the App.
solutionVersionId
The Version ID of the Solution. 
artifactType*


This ENUM attribute will specify the artifact type. Possible values:
ICON, IMAGE, DOCS, PERMFILE, PERMFILE_WEB_CLIENT, ALL
Example Request:
DELETE /developer/artifacts/artifactId124?appversion:1f866da9-6205-5760-a82e-94acb79dcd1e&artifactType=ICON
Response:
The request will return an HTTP 200 status for successful deletions.
﻿
4. Downloading Artifacts
Purpose: 
Download the content for the permissions file (PERMFILE or PERMFILE_WEB_CLIENT file types) uploaded for a given app  or solution version.
Endpoint:
﻿GET /developer/artifacts/{artifactId}/download﻿
Path Parameters
Parameter
Description
artifactId
The ID of the artifact.
Query Parameters
Parameter
Description
appVersionId
The Version ID of the App.
solutionVersionId
The Version ID of the Solution. 
﻿

Parameter	Description
file	The file to be uploaded. Max size is 10MB.

Parameter	Description
appVersionId	The Version ID of the App. Provide this ID for app types.
solutionVersionId	The Version ID of the Solution. Provide this ID for solution types.
artifactType*	This ENUM attribute will specify the artifact type. Possible values: ICON, IMAGE, DOCS, PERMFILE, PERMFILE_WEB_CLIENT, ALL. Note that PERMFILE and PERMFILE_WEB_CLIENT or only valid for app types.

Parameter	Description
appVersionId	The Version ID of the App.
solutionVersionId	The Version ID of the Soln.
artifactType*	This ENUM attribute will specify the artifact type. Possible values: ICON, IMAGE, DOCS, PERMFILE, PERMFILE_WEB_CLIENT, ALL

Parameter	Description
artifactId	The ID of the artifact.

Parameter	Description
appVersionId	The Version ID of the App.
solutionVersionId	The Version ID of the Solution.
artifactType*	This ENUM attribute will specify the artifact type. Possible values: ICON, IMAGE, DOCS, PERMFILE, PERMFILE_WEB_CLIENT, ALL

Parameter	Description
artifactId	The ID of the artifact.

Parameter	Description
appVersionId	The Version ID of the App.
solutionVersionId	The Version ID of the Solution.

Updated 23 Feb 2024

Did this page help you?

Onboarding Troubleshooting Guide

Troubleshooting