Request

Response

    Create a proposal
    POST

    v1alpha/proposals

    Create a proposal

    Resource Information

    Method and URI
    POST
    https://developer.api.autodesk.com/forma/proposal/v1alpha/proposals
    Authentication Context
    user context required
    Required OAuth Scopes
    data:read data:write
    Data Format
    JSON

    Request

    Headers

    Authorization*
    string
    Must be Bearer <token>, where <token> is obtained via a three-legged OAuth flow.
    X-Ads-Region
    string
    Specifies the geographical location (region) of the service. US or EMEA. Defaults to US.
    Content-Type*
    string
    Must be application/json
    * Required

    Request

    Query String Parameters

    authcontext*
    string
    The authcontext of the resource you are requesting.
    * Required

    Request

    Body Structure

    Expand all
    name
    string
    A human-readable name for the proposal
    terrain*
    object
    The terrain element (required). Must be an element from the “terrain” element system
    urn*
    string
    A Forma element URN
    key*
    string
    Unique id under parent. Used to build up paths. Prefer short values for space efficiency. Since element URNs cannot be used to identify _instances_ of elements, children have unique keys under their parent which are used to build up a path in context of the root of an element tree.
    transform
    array: number
    A 4x4 matrix representing the transformation of the element
    name
    string
    User defined naming of this specific reference, typically used to distinguish elements in eg. UI listings
    base*
    object
    The base element. Must be an element from the “group” element system
    urn*
    string
    A Forma element URN
    key*
    string
    Unique id under parent. Used to build up paths. Prefer short values for space efficiency. Since element URNs cannot be used to identify _instances_ of elements, children have unique keys under their parent which are used to build up a path in context of the root of an element tree.
    transform
    array: number
    A 4x4 matrix representing the transformation of the element
    name
    string
    User defined naming of this specific reference, typically used to distinguish elements in eg. UI listings
    children*
    array: object
    A collection of child elements
    urn*
    string
    A Forma element URN
    key*
    string
    Unique id under parent. Used to build up paths. Prefer short values for space efficiency. Since element URNs cannot be used to identify _instances_ of elements, children have unique keys under their parent which are used to build up a path in context of the root of an element tree.
    transform
    array: number
    A 4x4 matrix representing the transformation of the element
    name
    string
    User defined naming of this specific reference, typically used to distinguish elements in eg. UI listings
    * Required

    Response

    HTTP Status Code Summary

    201
    Created
    400
    Bad Request
    Malformed request. The request body is not valid according to the schema. See response for details.
    401
    Unauthorized
    Bearer token is not valid
    403
    Forbidden
    Token does not have access to the specified project. Are you in the right region?
    404
    Not Found
    The specified proposal does not exist
    412
    Precondition failed. One or more preconditions for this endpoint was not met. See response for details.
    500
    Internal Server Error
    Internal server error

    Response

    Body Structure (201)

    urn
    string

    Example

    Request

    curl -v 'https://developer.api.autodesk.com/forma/proposal/v1alpha/proposals?authcontext=pro_123' \
      -X 'POST' \
      -H 'Authorization: Bearer AuIPTf4KYLTYGVnOHQ0cuolwCW2a' \
      -H 'Content-Type: application/json' \
      -d '{
            "name": "My proposal",
            "terrain": {
              "urn": "urn:adsk-forma-elements:terrain:pro_123:id134unique:1707471576213",
              "key": "123-terrain"
            },
            "base": {
              "urn": "urn:adsk-forma-elements:group:pro_123:id204unique:1707471576542",
              "key": "123-base"
            },
            "children": []
          }'
    
    Show More

    Response

    {
      "urn": "urn:adsk-forma-elements:proposal:pro_123:id134unique:1707471576213"
    }