GET /api/models/versions/{ModelVersionID}/schema

Returns information about the schema for the specified model object version.

Authorization Roles/Permissions: Must have Read permission for the resource.

This topic includes the following sections:

HTTP Method

GET

Back to top

URL

https://{hostname}/api/models/versions/{ModelVersionID}/schema

Back to top

Sample Request

The example below shows a request for the schema for the specified model version.

Request URL

https://{hostname}/api/models/versions/b34801d8-4c05-4f26-a516-6c3a460818c8.acmepaymentscorp/schema

Sample request headers

Accept: text/plain
X-Csrf-Token_acmepaymentscorp":"TokenID%3D8ed70a13-8469-11e8-b37a-b155e4eabeb8%2CexpirationTime%3D153...

Sample request body

Not applicable.

Back to top

Request Headers

For general information on request header values, refer to HTTP Request Headers.

Header Description
Accept Any Accept header value that supports a response Content-Type of text/plain is valid; for example, */*.
AtmoAuthToken_{fedmemberid} The platform cookie. This is the Akana API Platform authorization token, and must be sent with every API request that requires login.
X-Csrf-Token_{fedmemberID} The CSRF prevention header; may or may not be required, depending on platform settings. See CSRF Prevention on the Platform. By default, the CSRF header is not required for GET operations and is required for all others, with a few exceptions relating to user login.

Back to top

Request Parameters

Parameter Parm Type Data Type Required Description
ModelVersionID Path String Required The unique ID for a specific version of a model object defined for a business organization. Same format as ModelID.
resolveReferences Query String Optional

Indicates whether, if a model includes references to other models inside the schema, the references are resolved. /p>

Default: true. When set to true or not specified, references are resolved.

If set to false, and the model includes references to other models, the schema is returned as is. For example, if a model named Pet includes references to a model names Category, the Category reference is returned as is rather than getting resolved to the full Category model. In this scenario, Category would be listed in the Definitions section of the schema.

Back to top

Response

If successful, this operation returns HTTP status code 200, with the requested schema.

Back to top

Sample Response

The sample response below shows successful completion of this operation.

Sample response headers

HTTP/1.1 200 OK
Date: Fri, 10 May 2019 18:06:05 GMT
Content-Type: text/plain

Sample response body

{
  "type":"object",
  "required":[
    "name",
    "photoUrls"
  ],
  "properties":{
    "id":{
      "type":"integer",
      "format":"int64"
    },
    "category":{
      "$ref":"#/definitions/Category"
    },
    "name":{
      "type":"string",
      "example":"doggie"
    },
    "photoUrls":{
      "type":"array",
      "xml":{
        "name":"photoUrl",
        "wrapped":true
      },
      "items":{
        "type":"string"
      }
    }
  }
}

Back to top

Response Headers

For general information on response header values, refer to HTTP Response Headers.

Header Description
Content-Type text/plain

Back to top

Response Body

Name Type Description
Schema String The schema for a model object on the platform.

Back to top

Error Codes/Messages

If the call is unsuccessful an error code/message is returned. One or more examples of possible errors for this operation are shown below.

Item Value
401 Unauthorized. For example, you would get this response if you didn't include the custom X-Csrf-Token_{fedmemberID} header in the request, when it was required by the platform settings; or if you included an invalid or expired value for this header. You would also get this response for any operation that requires login (almost all) if the login cookie was missing.
500 An error occurred processing the call.

More information about Akana API Platform API error messages.

Back to top

Related Topics