GET /api/models/versions/{ModelVersionID}

Returns information about 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}

Back to top

Sample Request

The example below shows a request for information about the specified model object version. The optional includeReferences parameter is included.

Request URL

https://{hostname}/api/models/versions/bc90be73-3bb5-4411-9dae-ad90fc65a6ca.acmepaymentscorp?includeReferences=true

Sample request headers

Accept: application/json
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 application/json
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.
includeReferences Path Path Optional Indicates whether model references should be included in the response. Default: false.
IncludeTags Query boolean Optional Indicates whether tags should be returned in the response. Default: false.
IncludeActions Query boolean Optional

Indicates whether workflow actions currently valid for the resource should be included in the results. For valid workflow actions, see Workflow Actions. Default: false.

includeTargetResources Query boolean Optional If included with a value of true, idicates whether results should include information about target resources for each model version. Default: false.

Back to top

Response

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

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 21:48:32 GMT
Content-Type: application/json

Sample response body

In this example, although the optional includeReferences parameter was included in the request, there are no references, so none are included in the response.

{
    "ModelVersionID": "bc90be73-3bb5-4411-9dae-ad90fc65a6ca.acmepaymentscorp",
    "ModelID": "4a1c31f4-4c10-469a-85cf-3b918f7bbc01.acmepaymentscorp",
    "Name": "v1",
    "Description": "For use in multiple top-level model objects.",
    "Visibility": "Public",
    "Created": "2019-05-06T21:07:45Z",
    "Updated": "2019-05-06T21:07:45Z",
    "State": "com.akana.model.state.draft"
}

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
ModelVersion ModelVersion Contains information about a version for model objects 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