PUT /api/models/{ModelID}

Updates an existing model object for the business organization.

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

This topic includes the following sections:

HTTP Method

PUT

Back to top

URL

https://{hostname}/api/models/{ModelID}

Back to top

Sample Request

The example below shows a request to update the specified model. In this example, the model is assigned to a different category.

Request URL

https://{hostname}/api/models/6ae0efaf-2e3d-4706-95ea-e0bd8b4492f1.acmepaymentscorp

Sample request headers

Accept: application/json
Content-Type: application/json
X-Csrf-Token_acmepaymentscorp":"TokenID%3D8ed70a13-8469-11e8-b37a-b155e4eabeb8%2CexpirationTime%3D153...

Sample request body

{
  "ModelID": "6ae0efaf-2e3d-4706-95ea-e0bd8b4492f1.acmepaymentscorp",
  "Name": "Cash Purchase",
  "Description": "For use in multiple top-level model objects.",
  "Summary": "Cash purchase transaction",
  "ModelCategory": "Income",
  "LatestVersionID": "b45ce9ef-eaf3-406f-b32c-0bb17a28156b.acmepaymentscorp",
  "Visibility": "Public",
  "Created": "2019-05-09T13:39:07Z",
  "Updated": "2019-05-09T13:40:58Z",
  "State": "com.akana.model.state.draft",
  "BusinessID": "tenantbusiness.acmepaymentscorp"
}

Back to top

Request Headers

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

Header Description
Accept application/json
Content-Type 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
ModelID Path string Required The unique ID for a model object defined for a business organization.
Model Model body Required Contains information about a model object defined at the organization level.

Back to top

Response

If successful, this operation returns HTTP status code 200, with the updated 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: Thu, 09 May 2019 13:40:56 GMT
Content-Type: application/json

Sample response body

{
  "ModelID": "6ae0efaf-2e3d-4706-95ea-e0bd8b4492f1.acmepaymentscorp",
  "Name": "Cash Purchase",
  "Description": "For use in multiple top-level model objects.",
  "Summary": "Cash purchase transaction",
  "ModelCategory": "Income",
  "LatestVersionID": "b45ce9ef-eaf3-406f-b32c-0bb17a28156b.acmepaymentscorp",
  "Visibility": "Public",
  "Created": "2019-05-09T13:39:07Z",
  "Updated": "2019-05-09T13:40:58Z",
  "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
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