AppPackages
POST
AppPackages
Creates an AppPackage module.
Before an AppPackage object can be created, you must make a request for a pre-signed URL that will be used to upload the module file.
To create an AppPackage, you must:
- Query for a pre-signed URL which will be used to upload module file with the GET AppPackages/Operations.GetUploadUrl endpoint.
- Upload the file to a cloud storage provider.
- Create an AppPackage referencing the module file.
Resource Information
| Method and URI | POST https://developer.api.autodesk.com/autocad.io/us-east/v2/AppPackages |
| 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 |
| Content-Type* string | Must be application/json |
* Required
Request
Body Structure
| Id* string | Unique name of the AppPackage |
| Resource* string: URL | Location of the bundle containing the files to be loaded into the AutoCAD core engine |
| References* array: string | AppPackages that this AppPackage depends on |
| RequiredEngineVersion* enum: string | Version of the AutoCAD core engine to execute the AppPackage. Possible values: 20.1, 21.0, 22.0. |
| Version* int | Version of the bundle referenced by the Resource attribute |
| Description string | Additional detail about the AppPackage |
| IsPublic bool | Specifies whether the entity can be publicly targeted |
| IsObjectEnabler bool | Indicates whether the AppApackage represents an object enabler |
* Required
Response
HTTP Status Code Summary
| 201 Created | AppPackage successfully created |
| 302 Found | An AppPackage with the same ID already exists; use PUT or PATCH to update it |
| 400 Bad Request | Request could not be understood by the server due to malformed syntax |
| 401 Unauthorized | Access token is invalid |
| 404 Not Found | Resource cannot be found |
| 429 Too Many Requests | Rate limit exceeded; wait some time before retrying |
| 500 Internal Server Error | An unexpected error occurred on the server |
Response
Body Structure (201)
| References array:string | AppPackages that this AppPackage depends on |
| Resource string: URL | Location of the bundle containing the files to be loaded into the AutoCAD core engine |
| RequiredEngineVersion enum: string | Version of the AutoCAD core engine to execute the AppPackage. Possible values: 20.1, 21.0, 22.0. |
| IsPublic bool | Specifies whether the entity can be publicly targeted |
| IsObjectEnabler bool | Indicates whether the AppApackage represents an object enabler |
| Id string | Unique name of the AppPackage |
| Version int | Version of the bundle referenced by the Resource attribute |
| Timestamp datetime: ISO 8601 | Timestamp of the last modification |
| Description string | Additional detail about the AppPackage |
Example
AppPackage Successfully Created (201)
Request
curl -v 'https://developer.api.autodesk.com/autocad.io/us-east/v2/AppPackages' \
-X 'POST' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer Js43z2DJnsYuaAxI4R2iT84b3UPy' \
-d '
{
"@odata.context": "https://developer.api.autodesk.com/autocad.io/us-east/v2/$metadata#AppPackages/$entity",
"References": [],
"Resource": "https://acesdev.s3-us-west-2.amazonaws.com/aces-apppackages/ClientConsole-Dev/8f4cae3e-c17e-4f7a-9df9-1c4703b69889?AWSAccessKeyId=AKIAJVT56CBNM4XOWBBA&Expires=1432146217&Signature=1L%2BUF8aGM%2BZFwjHOLsxXRDQ%2FhfY%3D",
"RequiredEngineVersion": "22.0",
"IsPublic": false,
"IsObjectEnabler": false,
"Id": "SampleApp",
"Version": 1,
"Timestamp": "2015-02-11T19:15:40.835Z",
"Description": ""
}'
Show More
Response
HTTP/1.1 201 Created
Cache-Control: no-cache
Content-Type: application/json; charset=utf-8
Date: Mon, 12 May 2014 21:13:50 GMT
Expires: -1
Location: https://developer.api.autodesk.com/autocad.io/us-east/v2/AppPackages('SampleApp')
Pragma: no-cache
Server: Microsoft-IIS/8.0
X-AspNet-Version: 4.0.30319
X-Powered-By: ASP.NET
Content-Length: 1175
Connection: keep-alive
{
"@odata.context": "https://developer.api.autodesk.com/autocad.io/us-east/v2/$metadata#AppPackages/$entity",
"References": [],
"Resource": "https://acesdev.s3-us-west-2.amazonaws.com/aces-apppackages/ClientConsole-Dev/8f4cae3e-c17e-4f7a-9df9-1c4703b69889?AWSAccessKeyId=AKIAJVT56CBNM4XOWBBA&Expires=1432146217&Signature=1L%2BUF8aGM%2BZFwjHOLsxXRDQ%2FhfY%3D",
"RequiredEngineVersion": "22.0",
"IsPublic": false,
"IsObjectEnabler": false,
"Id": "SampleApp",
"Version": 1,
"Timestamp": "2015-02-11T19:15:40.835Z",
"Description": ""
}
Show More
