PUT /api/apis/versions/{APIVersionID}
Updates information relating to an API version.
Note: Deprecated.
Instead, use the PUT /api/apis/versions/{ApiVersionID}/info operation.
Authorization Roles/Permissions: Must be logged in. Must have permission to modify the API; an API Admin or Business Admin.
This topic includes the following sections:
HTTP Method
PUT
URL
https://{hostname}/api/apis/versions/{APIVersionID}
Sample Request
The example below adds a third tag to the API version.
Sample Request URL
https://{hostname}/api/apis/versions/apiversion10022.acmepaymentscorp
Sample request headers
Content-Type: application/json Accept: application/json X-Csrf-Token_acmepaymentscorp: TokenID%3D8ed70a13-8469-11e8-b37a-b155e4eabeb8%2CexpirationTime%3D153...
Sample request body
{
"APIVersionID":"0b8c8beb-502b-418f-af4f-9bb56d3d2162.acmepaymentscorp",
"APIID":"bdb478d6-8221-4d27-85d7-fc9379a6428f.acmepaymentscorp",
"Name":"1.1",
"Description":"ADDITIONAL Update with enhancements and bug fixes.",
"Type":"shttp",
"DefaultProfile":"Any in and out",
"Tag":[
"payments"
],
"ProductionEndpoint":"http://acme_payments_api.10.1.20.137:9901/",
"SandboxEndpoint":"http://acme_payments_api.10.1.20.137:9901/",
"Operations":{
"Operation":[
{
"Method":"GET",
"Path":"/payments",
"Input":[
],
"InputContentType":"*/*",
"OutputContentType":"*/*",
"FaultContentType":"*/*",
"Name":"listPayments"
},
{
"Method":"GET",
"Path":"/payments/{PaymentID}",
"Input":[
{
"Name":"PaymentID",
"Type":"path"
}
],
"InputContentType":"*/*",
"OutputContentType":"*/*",
"FaultContentType":"*/*",
"Name":"getPayment"
},
{
"Method":"POST",
"Path":"/payments",
"Input":[
],
"InputContentType":"*/*",
"OutputContentType":"*/*",
"FaultContentType":"*/*",
"Name":"addPayment"
},
{
"Method":"PUT",
"Path":"/payments/{PaymentID}",
"Input":[
{
"Name":"PaymentID",
"Type":"path"
}
],
"InputContentType":"*/*",
"OutputContentType":"*/*",
"FaultContentType":"*/*",
"Name":"modifyPayment"
},
{
"Method":"DELETE",
"Path":"/payments/{PaymentID}",
"Input":[
{
"Name":"PaymentID",
"Type":"path"
}
],
"InputContentType":"*/*",
"OutputContentType":"*/*",
"FaultContentType":"*/*",
"Name":"deletePayment"
}
]
},
"Endpoints":{
"Endpoint":[
{
"Uri":"http://acme_payments_api.10.1.20.137:9901/",
"Category":"Production",
"CName":"acme_payments_api.10.1.20.137",
"DeploymentZoneRule":"1b16623b-1609-4664-9900-06f8441bdefault-http0"
},
{
"Uri":"http://acme_payments_api.10.1.20.137:9901/",
"Category":"Sandbox",
"CName":"acme_payments_api.10.1.20.137",
"DeploymentZoneRule":"1b16623b-1609-4664-9900-06f8441bdefault-http0"
}
]
},
"Policies":{
"Policy":[
{
"PolicyKey":"10001-AtmosphereApplicationSecurityPolicy",
"PolicyType":"Operational Policy"
},
{
"PolicyKey":"10001-DetailedAuditing",
"PolicyType":"Operational Policy"
}
]
},
"TargetAPI":{
"Endpoints":{
"Endpoint":[
{
"Uri":"http://acmepaymentscorp.com/payment",
"Category":"Production"
},
{
"Uri":"http://acmepaymentscorp.com/s/payment",
"Category":"Sandbox"
}
]
},
"Type":"shttp",
"Operations":{
"Operation":[
{
"Method":"GET",
"Path":"/payments",
"Input":[
],
"InputContentType":"*/*",
"OutputContentType":"*/*",
"FaultContentType":"*/*",
"Name":"listPayments"
},
{
"Method":"GET",
"Path":"/payments/{PaymentID}",
"Input":[
{
"Name":"PaymentID",
"Type":"path"
}
],
"InputContentType":"*/*",
"OutputContentType":"*/*",
"FaultContentType":"*/*",
"Name":"getPayment"
},
{
"Method":"POST",
"Path":"/payments",
"Input":[
],
"InputContentType":"*/*",
"OutputContentType":"*/*",
"FaultContentType":"*/*",
"Name":"addPayment"
},
{
"Method":"PUT",
"Path":"/payments/{PaymentID}",
"Input":[
{
"Name":"PaymentID",
"Type":"path"
}
],
"InputContentType":"*/*",
"OutputContentType":"*/*",
"FaultContentType":"*/*",
"Name":"modifyPayment"
},
{
"Method":"DELETE",
"Path":"/payments/{PaymentID}",
"Input":[
{
"Name":"PaymentID",
"Type":"path"
}
],
"InputContentType":"*/*",
"OutputContentType":"*/*",
"FaultContentType":"*/*",
"Name":"deletePayment"
}
]
},
"Policies":{
"Policy":[
]
},
"DefaultProfile":"Any in and out"
},
"Visibility":"Limited",
"State":"com.soa.api.state.open",
"ProductionEndpointAccessAutoApproved":true,
"SandboxEndpointAccessAutoApproved":true,
"SandboxAnonymousAccessAllowed":false,
"ProductionAnonymousAccessAllowed":false,
"ResourceLevelPermissionsSupported":true
}
Request Headers
For general information on request header values, refer to HTTP Request Headers.
| Header | Description |
|---|---|
| Accept |
application/json, application/xml application/vnd.soa.v71+json, application/vnd.soa.v71+xml application/vnd.soa.v72+json, application/vnd.soa.v72+xml application/vnd.soa.v80+json, application/vnd.soa.v80+xml |
| Content-Type |
Any one of the following media types is valid for the request Content-Type: application/json or application/xml application/vnd.soa.v71+json or application/vnd.soa.v71+xml application/vnd.soa.v72+json or application/vnd.soa.v72+xml application/vnd.soa.v80+json or application/vnd.soa.v80+xml |
| Cookie | AtmoAuthToken_{fedmemberid}={cookie value, which usually starts with TokenID}—The platform cookie. This is the Akana API Platform authorization token, and must be sent with every API request that requires login. For more information and an example, see Session cookies. |
| 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. |
Request Parameters
| Parameter | Parm Type | Data Type | Required | Description |
|---|---|---|---|---|
| APIVersionID | Path | String | Required | The unique ID for a specific API version. |
| APIVersion | Body | APIVersion | Required | Includes information about an API version. The entire version, including the changed data. |
Response
If successful, this operation returns HTTP status code 200, with the updated API version object.
Sample Response
The sample response below shows that the API version was successfully updated.
Sample response headers
Status Code: 200 OK Content-Type: application/json Date: Tue, 22 Apr 2014 17:03:56 GMT
Sample response body
{
"APIVersionID":"0b8c8beb-502b-418f-af4f-9bb56d3d2162.acmepaymentscorp",
"APIID":"bdb478d6-8221-4d27-85d7-fc9379a6428f.acmepaymentscorp",
"Name":"1.1",
"Description":"ADDITIONAL Update with enhancements and bug fixes.",
"Type":"shttp",
"DefaultProfile":"Any in and out",
"Tag":[
"payments"
],
"ProductionEndpoint":"http://acme_payments_api.10.1.20.137:9901/",
"SandboxEndpoint":"http://acme_payments_api.10.1.20.137:9901/",
"Operations":{
"Operation":[
{
"Method":"GET",
"Path":"/payments",
"Input":[
],
"InputContentType":"*/*",
"OutputContentType":"*/*",
"FaultContentType":"*/*",
"Name":"listPayments"
},
{
"Method":"GET",
"Path":"/payments/{PaymentID}",
"Input":[
{
"Name":"PaymentID",
"Type":"path"
}
],
"InputContentType":"*/*",
"OutputContentType":"*/*",
"FaultContentType":"*/*",
"Name":"getPayment"
},
{
"Method":"POST",
"Path":"/payments",
"Input":[
],
"InputContentType":"*/*",
"OutputContentType":"*/*",
"FaultContentType":"*/*",
"Name":"addPayment"
},
{
"Method":"PUT",
"Path":"/payments/{PaymentID}",
"Input":[
{
"Name":"PaymentID",
"Type":"path"
}
],
"InputContentType":"*/*",
"OutputContentType":"*/*",
"FaultContentType":"*/*",
"Name":"modifyPayment"
},
{
"Method":"DELETE",
"Path":"/payments/{PaymentID}",
"Input":[
{
"Name":"PaymentID",
"Type":"path"
}
],
"InputContentType":"*/*",
"OutputContentType":"*/*",
"FaultContentType":"*/*",
"Name":"deletePayment"
}
]
},
"Endpoints":{
"Endpoint":[
{
"Uri":"http://acme_payments_api.10.1.20.137:9901/",
"Category":"Production",
"CName":"acme_payments_api.10.1.20.137",
"DeploymentZoneRule":"1b16623b-1609-4664-9900-06f8441bdefault-http0"
},
{
"Uri":"http://acme_payments_api.10.1.20.137:9901/",
"Category":"Sandbox",
"CName":"acme_payments_api.10.1.20.137",
"DeploymentZoneRule":"1b16623b-1609-4664-9900-06f8441bdefault-http0"
}
]
},
"Policies":{
"Policy":[
{
"PolicyKey":"10001-AtmosphereApplicationSecurityPolicy",
"PolicyType":"Operational Policy"
},
{
"PolicyKey":"10001-DetailedAuditing",
"PolicyType":"Operational Policy"
}
]
},
"TargetAPI":{
"Endpoints":{
"Endpoint":[
{
"Uri":"http://acmepaymentscorp.com/payment",
"Category":"Production"
},
{
"Uri":"http://acmepaymentscorp.com/s/payment",
"Category":"Sandbox"
}
]
},
"Type":"shttp",
"Operations":{
"Operation":[
{
"Method":"GET",
"Path":"/payments",
"Input":[
],
"InputContentType":"*/*",
"OutputContentType":"*/*",
"FaultContentType":"*/*",
"Name":"listPayments"
},
{
"Method":"GET",
"Path":"/payments/{PaymentID}",
"Input":[
{
"Name":"PaymentID",
"Type":"path"
}
],
"InputContentType":"*/*",
"OutputContentType":"*/*",
"FaultContentType":"*/*",
"Name":"getPayment"
},
{
"Method":"POST",
"Path":"/payments",
"Input":[
],
"InputContentType":"*/*",
"OutputContentType":"*/*",
"FaultContentType":"*/*",
"Name":"addPayment"
},
{
"Method":"PUT",
"Path":"/payments/{PaymentID}",
"Input":[
{
"Name":"PaymentID",
"Type":"path"
}
],
"InputContentType":"*/*",
"OutputContentType":"*/*",
"FaultContentType":"*/*",
"Name":"modifyPayment"
},
{
"Method":"DELETE",
"Path":"/payments/{PaymentID}",
"Input":[
{
"Name":"PaymentID",
"Type":"path"
}
],
"InputContentType":"*/*",
"OutputContentType":"*/*",
"FaultContentType":"*/*",
"Name":"deletePayment"
}
]
},
"Policies":{
"Policy":[
]
},
"DefaultProfile":"Any in and out"
},
"Visibility":"Limited",
"State":"com.soa.api.state.open",
"ProductionEndpointAccessAutoApproved":true,
"SandboxEndpointAccessAutoApproved":true,
"SandboxAnonymousAccessAllowed":false,
"ProductionAnonymousAccessAllowed":false,
"ResourceLevelPermissionsSupported":true
}
Response Headers
For general information on response header values, refer to HTTP Response Headers.
| Header | Description |
|---|---|
| Content-Type |
application/json, application/xml application/vnd.soa.v71+json, application/vnd.soa.v71+xml application/vnd.soa.v72+json, application/vnd.soa.v72+xml application/vnd.soa.v80+json, application/vnd.soa.v80+xml |
Response Body
| Name | Type | Description |
|---|---|---|
| APIVersion | APIVersion | Includes information about an API version. The entire version, including the changed data, is returned. |
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.
