GET /api/models/{ModelID}

Includes information about a model object defined for an organization.

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

This topic includes the following sections:

HTTP Method


Back to top



Back to top

Sample Request

Sample request #1

The example below shows a request for information about the specified model. For the response, see Sample response body #1: no parameters.


Sample request #2

In the example below, the optional IncludeVersions parameter is included, so version information is returned. For the response, see Sample response body #2: includes versions.


Sample request headers

Accept: application/json

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 application/json
Cookie AtmoAuthToken_{fedmemberid}—The platform cookie. This is the Akana API Platform authorization token, and must be sent with every API request that requires login. For more information and an example, see Session cookies.
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
ModelID Path string Required The unique ID for a model object defined for a business organization.
IncludeVersions Query boolean Optional Indicates whether results should include information about model versions. Defaults to false, so model versions are not included unless this parameter is set to true.

Back to top


If successful, this operation returns HTTP status code 200, with information about the specified model.

Back to top

Sample Response

The sample response below shows successful completion of this operation.

Sample response headers

HTTP/1.1 200 OK
Date: Mon, 06 May 2019 18:56:41 GMT
Content-Type: application/json

Sample response body #1: no parameters

In the example below, no optional parameters were included.

  "ModelID": "e2d2af5b-cf21-4e68-8635-387e5ec117b6.acmepaymentscorp",
  "Name": "Credit Card Purchase",
  "Description": "For use in multiple top-level model objects.",
  "Summary": "Credit card purchase transaction",
  "ModelCategory": "Transaction",
  "LatestVersionID": "c5f440ee-d57c-4ee2-9082-6c40557c1593.acmepaymentscorp",
  "Visibility": "Public",
  "Created": "2019-05-06T18:23:09Z",
  "Updated": "2019-05-06T18:23:09Z",
  "State": "com.akana.model.state.draft",
  "BusinessID": "tenantbusiness.acmepaymentscorp"

Sample response body #2: includes versions

In the example below, the optional IncludeVersions parameter was included in the request, so version information is included in the response. This is the response to Sample request #2.

  "Description":"Model object for any pet category",
  "Summary":"Category model",
        "Description":"First version",
        "Description":"Version 2",
        "Description":"Version 3",

Back to top

Response Headers

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

Header Description
Content-Type application/json

Back to top

Response Body

Name Type Description
Model Model Contains information about a model object defined at the organization level.

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