GET
appbundles/:id
Gets the details of the specified AppBundle. Note that the {id} parameter must be a QualifiedId (owner.name+label).
Resource Information
Method and URI | GET https://developer.api.autodesk.com/da/us-east/v3/appbundles/:id |
Authentication Context | app only |
Required OAuth Scopes | code:all |
Data Format | JSON |
Request
Headers
Authorization* string | Must be Bearer <token> , where <token> is obtained via OAuth |
* Required
Request
URI Parameters
id string | Full qualified id of the AppBundle (owner.name+label). |
Response
HTTP Status Code Summary
200 OK | Successfully get the details of an AppBundle. |
400 Bad Request | The request is invalid. |
403 Forbidden | Forbidden. |
404 Not Found | Resource cannot be found. Note that the server will return this result if a valid but unqualified id is passed. |
500 Internal Server Error | Unknown error. |
Response
Body Structure (200)
Expand all
package string | The URL that points to the zip package for the AppBundle or Engine. | ||||||
uploadParameters object | The parameters needed to POST an AppBundle. | ||||||
endpointURL string | The URL to upload the AppBundle package to. | ||||||
formData object | FormData parameters to be used in the body of the AppBundle package upload request. Must be followed by a ‘file’ parameter indicating the package file location. | ||||||
* string | Type: dictionary<string, *> | ||||||
id string | Name of AppBundle, see the example section. | ||||||
engine string | The actual processing engine that runs the WorkItem job and processes the Activity. | ||||||
appbundles array: string | A module referenced by an Activity in order to perform specific functions. Typically this is a DLL or some other form of custom code. | ||||||
settings object | The url/string Settings for a given set of AppBundles. | ||||||
* any of | Type: dictionary<string, *> | ||||||
StringSetting object | |||||||
value string | |||||||
isEnvironmentVariable boolean | |||||||
UrlSetting object | |||||||
url string | Url. | ||||||
headers object | Headers. | ||||||
* string | Type: dictionary<string, *> | ||||||
verb enum:string | Defines the operation for a parameter. get, put, post, patch imply an HTTP operation on the url in the parameter. read implies that the string value of parameter should be read. get and read imply input parameters all others are output.
Possible values: get , head , put , post , patch , read | ||||||
multiparts object | Provide multipart post method to upload the results and multiparts can be empty if there is no “parameter” to provide.
It supports Box, Google Drive and Amazon Simple Storage Service (S3) services. Examples of using argument “multiparts”: Box:
Google Drive:
Amazon Simple Storage Service (S3):
| ||||||
* object | Type: dictionary<string, *> | ||||||
description string | Human readable description of the object. | ||||||
version int |
Example
Successfully get the details of an AppBundle.
Request
curl -v 'https://developer.api.autodesk.com/da/us-east/v3/appbundles/:id' \
-H 'Authorization: Bearer AuIPTf4KYLTYGVnOHQ0cuolwCW2a'
Response
{
"package": "https://dasprod-store.s3.us-east-1.amazonaws.com/apps/hcX",
"id": "owner.ChangeParams+test"
"engine": "Autodesk.Inventor+23",
"version": 10
}