GET /api/businesses/{BusinessID}/models

Returns a list of model objects defined for the business.

Authorization Roles/Permissions: Must be logged in. Must have Read permission for the resource. Site Admin.

This topic includes the following sections:

HTTP Method

GET

Back to top

URL

https://{hostname}/api/businesses/{BusinessID}/models

Back to top

Sample Request

The example below shows a request for the model objects for the specified business organization.

Request URL

https://{hostname}/api/businesses/tenantbusiness.acmepaymentscorp/models

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
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
BusinessID Path string Required The unique ID for a specific business organization on the platform.
IncludeDeleted Query boolean Optional By default, models that have been deleted are not included. If included with value of true, all models are returned.

Back to top

Response

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

Back to top

Sample Response

The sample response below shows successful completion of this operation.

Sample response headers: application/json

Date: Tue, 07 May 2019 13:43:54 GMT
Content-Type: application/json

Sample response body: application/json

{
  "Model":[
    {
      "ModelID":"a96eb202-e64d-4585-876d-8e59aa4d6074.acmepaymentscorp",
      "Name":"Cash Purchase",
      "Description":"For use in multiple top-level model objects.",
      "Summary":"Cash purchase transaction",
      "ModelCategory":"Transaction",
      "Visibility":"Public",
      "Created":"2019-05-07T13:43:03Z",
      "Updated":"2019-05-07T13:43:03Z",
      "State":"com.akana.model.state.draft",
      "BusinessID":"tenantbusiness.acmepaymentscorp"
    },
    {
      "ModelID":"b406b672-3056-4eb8-9ab3-97ff8424c025.acmepaymentscorp",
      "Name":"Check Purchase",
      "Description":"For use in multiple top-level model objects.",
      "Summary":"Check purchase transaction",
      "ModelCategory":"Transaction",
      "Visibility":"Public",
      "Created":"2019-05-07T13:43:01Z",
      "Updated":"2019-05-07T13:43:01Z",
      "State":"com.akana.model.state.draft",
      "BusinessID":"tenantbusiness.acmepaymentscorp"
    },
    {
      "ModelID":"5b125737-33ff-4b5e-b6bc-ca6d17221e3a.acmepaymentscorp",
      "Name":"Credit Card Purchase",
      "Description":"For use in multiple top-level model objects.",
      "Summary":"Credit card purchase transaction",
      "ModelCategory":"Transaction",
      "Visibility":"Public",
      "Created":"2019-05-07T13:42:57Z",
      "Updated":"2019-05-07T13:42:57Z",
      "State":"com.akana.model.state.draft",
      "BusinessID":"tenantbusiness.acmepaymentscorp"
    }
  ]
}

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
Models Models Contains information about 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