PUT /api/businesses/{BusinessID}/modelsettings

Returns information about a model category defined for a business organization.

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

This topic includes the following sections:

HTTP Method


Back to top



Back to top

Sample Request

The example below shows a request to update the custom workflow for model objects.

Request URL


Sample request headers

Accept: application/json
Content-Type: application/json

Sample request body


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
BusinessID Path string Required The unique ID for a specific business organization on the platform.
BusinessModelSettings Body BusinessModelSettings Required Contains information about the business model settings.

Back to top


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

Back to top

Sample Response

The sample response below shows successful completion of this operation.

Sample response headers: application/json

Date: Tue, 30 Apr 2019 19:26:50 GMT
Content-Type: application/json

Sample response body: application/json

  "ModelVersionWorkflowDefKey" : "f2b357db-e635-4439-bc5e-6661c0a19fa0"

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
BusinessModelSettings BusinessModelSettings

Contains information about default settings to apply to all business models within the business.

In this scenario, only information on changed values is returned.

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