PUT /api/apps/versions/{AppVersionID}

Changes one or more values associated with an app version.

This operation allows modifying the Shared Secret for the app only if this feature is enabled via platform settings and the account was created on the platform. Users who sign in using LDAP or another external identity account cannot modify the Shared Secret on the platform.

Note: If you are not sure of the ID for the app version, but you have the App ID, you can run the GET /api/apps/{AppID} operation to get the ID of the default version.

Workflow: This operation checks whether the resource is governed by a workflow, and if so whether the action is valid based on the current state of the resource. If the action is not valid, the operation will fail.

Authorization Roles/Permissions: Must be logged in. App team member, Business Admin

Authorization token renewal: This operation changes information that is reflected in the authorization token; therefore, when invoking this operation, you must also renew the token.

This topic includes the following sections:

HTTP Method

PUT

Back to top

URL

https://{hostname}/api/apps/versions/{AppVersionID}

Back to top

Sample Request

The example below modifies the name (version number) and tags of an app version. The operation sends the new app version information in JSON format.

Sample request URL

https://{hostname}/api/apps/versions/2kqqoq5DwNm6MOSrvpnRxC3V.acmepaymentscorp 

Sample request headers

Host: {hostname}
Accept: */*
Content-Type: application/json; charset=UTF-8
X-Csrf-Token_acmepaymentscorp":"TokenID%3D8ed70a13-8469-11e8-b37a-b155e4eabeb8%2CexpirationTime%3D153...

Sample request body #1

Modifies the name (version number) and description of an app version. App identity and shared secret either cannot be customized or are unchanged, so they are not used in the request.

{
  "Name":"1.1",
  "Description":"First version, great puzzle app.",
  "Tag":[
    "puzzle",
    "language",
    "learning"
  ],
  "AppID":"ae7f7f68-eb0d-4ca7-a89a-4530c2d01793.acmepaymentscorp",
  "InitialEnvironment":"Sandbox",
  "Visibility":"Public",
  "WebsiteAddress":"http://www.acmepaymentscorp.com/crosfhocal",
}

Sample request body #2

Modifies the app identity and shared secret value for an app version, so these fields are included in the request.

{
  "Name":"1.0",
  "Description":"Initial version",
  "Tag":[
    "puzzle",
    "language",
    "learning"
  ],
  "AppID":"ae7f7f68-eb0d-4ca7-a89a-4530c2d01793.acmepaymentscorp",
  "InitialEnvironment":"Sandbox",
  "Visibility":"Public",
  "WebsiteAddress":"http://www.acmepaymentscorp.com/crosfhocal",
  "Identity":"myappversionid",
  "SharedSecret":"23456000012"
}

Back to top

Request Headers

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

Header Description
Accept Any Accept header value that supports a response Content-Type of text/plain is valid; for example, */*.
Content-Type

Any one of the following media types is valid for the request Content-Type:

application/json, application/vnd.soa.v71+json, application/vnd.soa.v72+json, application/vnd.soa.v80+json, application/vnd.soa.v81+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
AppVersionID Path string Required The unique ID for a specific app version.
ApplicationVersion Body ApplicationVersion Required Modified information about the app.

Back to top

Response

If successful, this operation returns HTTP status code 200, with the AppVersionID in plain text.

Back to top

Sample Response

The sample response below shows the AppVersionID.

Sample response headers

HTTP/1.1 200 OK
Content-Type: text/plain
Expires: Thu, 24 Sep 2015 10:45:46 GMT
Atmo-Renew-Token: renew

Sample response body

2kqqoq5DwNm6MOSrvpnRxC3V.acmepaymentscorp

Back to top

Response Headers

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

Header Description
Content-Type text/plain
Atmo-Renew-Token renew

Back to top

Response Body

Name Type Description
AppVersionID string The unique ID for a specific app version.

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.
404 The resource could not be found.
500 An error occurred processing the call.

More information about Akana API Platform API error messages.

Back to top

Related Topics