Update API
put
/mobile/tools/1.0/apis/{id}
Overwrites the API metadata.
Request
Supported Media Types
- application/json
Path Parameters
-
id: string
The identifier of the API.
Header Parameters
-
If-Match(optional): string
The request completes successfully only if the ETag of the corresponding asset matches the value of this HTTP request header. To force overwrite, pass the value `*`.
The API representation for PUT requests.
Root Schema : apiUpdate
Type:
object
The API representation for PUT requests.
Match All
Show Source
-
object assetUpdate
The asset representation for PUT requests.
-
object apiUpdate-allOf[1]
Nested Schema : assetUpdate
Type:
object
The asset representation for PUT requests.
Show Source
-
actionComment(optional):
string
-
desc(optional):
string
Maximum Length:
100
-
max(optional):
boolean
Default Value:
false
-
name:
string
Maximum Length:
100
Pattern:^[a-zA-Z][a-zA-Z0-9_]*$
-
namespace(optional):
string
Applicable to APIs and implementations only. This value is null for all other asset types.
-
title(optional):
string
Maximum Length:
255
-
version(optional):
string
Maximum Length:
100
Pattern:^[a-zA-Z0-9][\w.]*$
Asset version.
Nested Schema : apiUpdate-allOf[1]
Type:
Show Source
object
-
apiDefn(optional):
array stringArray
Minimum Number of Items:
0
An array of string values. -
basePath(optional):
string
The API base path in the format `/mobile/custom/{apiName}`. This is required to define the API name.
-
businessObjectsDefn(optional):
string
-
hasBusinessObjects(optional):
boolean
Default Value:
false
Indicates whether the API is associated with API Express resources (business objects). -
icon(optional):
object icon
Information about the icon that's associated with the API or connector.
-
security(optional):
object apiSecurity
The API security for POST and PUT requests.
Nested Schema : stringArray
Type:
array
Minimum Number of Items:
0
An array of string values.
Show Source
Nested Schema : icon
Type:
object
Information about the icon that's associated with the API or connector.
Show Source
Nested Schema : apiSecurity
Type:
object
The API security for POST and PUT requests.
Show Source
-
access(optional):
object securityAccess
Access details.
-
endpoints(optional):
array endpointSecurityArray
Minimum Number of Items:
0
An array of endpoint security elements. -
loginType(optional):
Allowed Values:
[ "ENTERPRISE", "IDENTITYPROVIDER" ]
If the `required` attribute has a value of `true`, then the default is `ENTERPRISE`. -
required:
boolean
When `true`, either security access or a social identity provider configuration is required.
Nested Schema : securityAccess
Type:
object
Access details.
Show Source
-
all(optional):
boolean
-
roles(optional):
array stringArray
Minimum Number of Items:
0
An array of string values.
Nested Schema : endpointSecurityArray
Type:
array
Minimum Number of Items:
0
An array of endpoint security elements.
Show Source
-
Array of:
object endpointSecurity
The API security for POST and PUT requests.
Nested Schema : endpointSecurity
Type:
object
The API security for POST and PUT requests.
Show Source
-
access(optional):
object securityAccess
Access details.
-
method:
string
-
resource:
string
Response
Supported Media Types
- application/json
200 Response
The API metadata was updated, and metadata for the new API was returned.
Headers
-
ETag: string
The ETag corresponds to the state of the API (that is, the value increments by one on each change operation). You can use this ETag with the `If-Match` HTTP header on a request.
Information about the API (short form) and the RAML-validation result. This information doesn't include the RAML descriptor.
Root Schema : apiCreatedWithRamlValidation
Type:
object
Information about the API (short form) and the RAML-validation result. This information doesn't include the RAML descriptor.
Match All
Show Source
-
object apiShort
The short API definition representation.
-
object apiCreatedWithRamlValidation-allOf[1]
Nested Schema : apiShort
Type:
object
The short API definition representation.
Match All
Show Source
-
object assetGet
The asset representation for GET requests.
-
object apiShort-allOf[1]
Nested Schema : apiCreatedWithRamlValidation-allOf[1]
Type:
Show Source
object
-
ramlValidationReport(optional):
object ramlValidationReport
The result of the RAML validation.
-
security(optional):
object apiSecurity
The API security for POST and PUT requests.
Nested Schema : assetGet
Type:
object
The asset representation for GET requests.
Match All
Show Source
-
object assetUpdate
The asset representation for PUT requests.
-
object assetIdEtag
The asset ID and entity tag (ETag) values.
-
object trash
Indicator of whether the asset is in the trash.
-
object assetGet-allOf[3]
Nested Schema : apiShort-allOf[1]
Type:
Show Source
object
-
basePath(optional):
string
The API base path in the format `/mobile/custom/{apiName}`.
-
hasBusinessObjects(optional):
boolean
Default Value:
false
Indicates whether the API is associated with API Express resources (business objects). -
icon(optional):
object icon
Information about the icon that's associated with the API or connector.
Nested Schema : assetUpdate
Type:
object
The asset representation for PUT requests.
Show Source
-
actionComment(optional):
string
-
desc(optional):
string
Maximum Length:
100
-
max(optional):
boolean
Default Value:
false
-
name:
string
Maximum Length:
100
Pattern:^[a-zA-Z][a-zA-Z0-9_]*$
-
namespace(optional):
string
Applicable to APIs and implementations only. This value is null for all other asset types.
-
title(optional):
string
Maximum Length:
255
-
version(optional):
string
Maximum Length:
100
Pattern:^[a-zA-Z0-9][\w.]*$
Asset version.
Nested Schema : assetIdEtag
Type:
object
The asset ID and entity tag (ETag) values.
Show Source
-
etag(optional):
string
The asset entity tag (ETag) value, which you can use to detect concurrent modification.
-
id:
string
Nested Schema : assetGet-allOf[3]
Type:
Show Source
object
-
createdOn(optional):
string
-
deletedBy(optional):
string
-
deletedOn(optional):
string
-
links(optional):
array entityLinksArray
Minimum Number of Items:
0
An array of links for an entity's metadata. -
modifiedBy(optional):
string
-
modifiedOn(optional):
string
-
published(optional):
boolean
An asset draft or published status representation.
Nested Schema : entityLinksArray
Type:
array
Minimum Number of Items:
0
An array of links for an entity's metadata.
Show Source
-
Array of:
object items
Link to the entity's metadata.
Nested Schema : items
Type:
object
Link to the entity's metadata.
Show Source
-
href:
string
Link value.
-
rel:
Allowed Values:
[ "self", "canonical" ]
Link type.
Nested Schema : icon
Type:
object
Information about the icon that's associated with the API or connector.
Show Source
Nested Schema : ramlValidationReport
Type:
object
The result of the RAML validation.
Show Source
-
valid:
boolean
-
validationResults(optional):
array validationResults
Minimum Number of Items:
0
Nested Schema : apiSecurity
Type:
object
The API security for POST and PUT requests.
Show Source
-
access(optional):
object securityAccess
Access details.
-
endpoints(optional):
array endpointSecurityArray
Minimum Number of Items:
0
An array of endpoint security elements. -
loginType(optional):
Allowed Values:
[ "ENTERPRISE", "IDENTITYPROVIDER" ]
If the `required` attribute has a value of `true`, then the default is `ENTERPRISE`. -
required:
boolean
When `true`, either security access or a social identity provider configuration is required.
Nested Schema : securityAccess
Type:
object
Access details.
Show Source
-
all(optional):
boolean
-
roles(optional):
array stringArray
Minimum Number of Items:
0
An array of string values.
Nested Schema : endpointSecurityArray
Type:
array
Minimum Number of Items:
0
An array of endpoint security elements.
Show Source
-
Array of:
object endpointSecurity
The API security for POST and PUT requests.
Nested Schema : stringArray
Type:
array
Minimum Number of Items:
0
An array of string values.
Show Source
Nested Schema : endpointSecurity
Type:
object
The API security for POST and PUT requests.
Show Source
-
access(optional):
object securityAccess
Access details.
-
method:
string
-
resource:
string
400 Response
Missing API specification.
Root Schema : error
Type:
Show Source
object
-
detail:
string
Message that provides the error details.
-
o:ecid:
string
Execution context ID, which is a unique identifier to correlate events or requests that are associated with the same transaction across several components.
-
o:errorCode:
string
The service's error code.
-
o:errorDetails(optional):
object errorDetails
-
o:errorPath:
string
The relative point in the API path where the error occurred.
-
status:
integer(int64)
HTTP status code. See http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html for more details.
-
title:
string
Summary of the problem.
-
type:
string
The URI to the link that provides details about the HTTP status code.
Nested Schema : errorDetails
Type:
Show Source
object
-
detail:
string
-
o:errorDetails(optional):
object errorDetails
-
title:
string
Summary of the problem.
-
type:
string
The URI to the link that provides details about the HTTP status code.
409 Response
The update modified either the name or the version, and an API with the same name and version as the updated API already exists.
Root Schema : error
Type:
Show Source
object
-
detail:
string
Message that provides the error details.
-
o:ecid:
string
Execution context ID, which is a unique identifier to correlate events or requests that are associated with the same transaction across several components.
-
o:errorCode:
string
The service's error code.
-
o:errorDetails(optional):
object errorDetails
-
o:errorPath:
string
The relative point in the API path where the error occurred.
-
status:
integer(int64)
HTTP status code. See http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html for more details.
-
title:
string
Summary of the problem.
-
type:
string
The URI to the link that provides details about the HTTP status code.
Nested Schema : errorDetails
Type:
Show Source
object
-
detail:
string
-
o:errorDetails(optional):
object errorDetails
-
title:
string
Summary of the problem.
-
type:
string
The URI to the link that provides details about the HTTP status code.
412 Response
The operation failed based on the `If-Match` condition. Typically, this is the result of concurrent modification detection. It also can be the result of improper values specified in the request headers.
Root Schema : error
Type:
Show Source
object
-
detail:
string
Message that provides the error details.
-
o:ecid:
string
Execution context ID, which is a unique identifier to correlate events or requests that are associated with the same transaction across several components.
-
o:errorCode:
string
The service's error code.
-
o:errorDetails(optional):
object errorDetails
-
o:errorPath:
string
The relative point in the API path where the error occurred.
-
status:
integer(int64)
HTTP status code. See http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html for more details.
-
title:
string
Summary of the problem.
-
type:
string
The URI to the link that provides details about the HTTP status code.
Nested Schema : errorDetails
Type:
Show Source
object
-
detail:
string
-
o:errorDetails(optional):
object errorDetails
-
title:
string
Summary of the problem.
-
type:
string
The URI to the link that provides details about the HTTP status code.