App and Solution
Common
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 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 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" "" } ] } } 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