Retrieve Implementations
get
/mobile/tools/1.0/apis/{id}/implementations
Returns an array of custom API implementation metadata. You can filter the results, page through the results, and specify a sort order.
Request
Supported Media Types
- application/json
Path Parameters
-
id: string
The ID for the custom API implementation.
Query Parameters
-
limit(optional): integer(int64)
The maximum number of items to return. If the total number of items to return is greater than the limit, then the response returns a link to get the next set of items.
-
offset(optional): integer(int64)
The index where you want to start browsing the list of items. If you don't specify an offset, then the offset defaults to 0, which is the first item in the list. The response contains the offset used and a link to get the previous set of items.
-
totalResults(optional): boolean
Reserved for enabling the total number of available elements in the response. This parameter is ignored because the total elements count always is available and is provided in the response.
Response
Supported Media Types
- application/json
200 Response
An array of API implementations.
An array of API implementation elements with paging information.
Root Schema : apiImplementationDetailedPaging
Type:
object
An array of API implementation elements with paging information.
Match All
Show Source
-
object paging
The pagination information.
-
object apiImplementationDetailedPaging-allOf[1]
Nested Schema : paging
Type:
object
The pagination information.
Show Source
-
count:
integer(int64)
The number of elements in this response.
-
hasMore:
boolean
Indicates whether the collection has more elements to be retrieved.
-
limit(optional):
integer(int64)
The maximum number of items returned. If the total number of items to return is greater than the limit, then the response returns a link to get the next set of items.
-
links(optional):
array paginationLinksArray
Minimum Number of Items:
0
An array of links for paginated metadata. -
totalResults(optional):
integer(int64)
The total number of elements on the server side that satisfy the request. This attribute is returned only when the request includes the `totalResults` query parameter with a value of `true`.
Nested Schema : apiImplementationDetailedPaging-allOf[1]
Type:
Show Source
object
-
items(optional):
array apiImplementationArray
Minimum Number of Items:
0
An array of API implementations with artifact information.
Nested Schema : paginationLinksArray
Type:
array
Minimum Number of Items:
0
An array of links for paginated metadata.
Show Source
-
Array of:
object Link to the paginated metadata.
Title:
Link to the paginated metadata.
Nested Schema : Link to the paginated metadata.
Type:
object
Title:
Show Source
Link to the paginated metadata.
-
href:
string
Link value.
-
rel:
Allowed Values:
[ "self", "canonical", "next", "prev", "first", "last" ]
Link type.
Nested Schema : apiImplementationArray
Type:
array
Minimum Number of Items:
0
An array of API implementations with artifact information.
Show Source
-
Array of:
object apiImplementationGet
The API implementation service details.
Nested Schema : apiImplementationGet
Type:
object
The API implementation service details.
Match All
Show Source
-
object assetGet
The asset representation for GET requests.
-
object apiImplementationGet-allOf[1]
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 : apiImplementationGet-allOf[1]
Type:
Show Source
object
-
api(optional):
object assetShortQualified
An asset's information in qualified short form, which includes type and qualifiers.
-
artifacts(optional):
array artifactArray
Minimum Number of Items:
0
An array of artifact information.
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 : assetShortQualified
Type:
object
An asset's information in qualified short form, which includes type and qualifiers.
Match All
Show Source
-
object assetShort
Asset information (short form).
-
object assetQualifiers
Asset type name and qualifiers.
Nested Schema : artifactArray
Type:
array
Minimum Number of Items:
0
An array of artifact information.
Show Source
-
Array of:
object artifact
The artifact information.
Nested Schema : assetShort
Type:
object
Asset information (short form).
Show Source
-
id(optional):
string
Asset identifier.
-
name(optional):
string
Asset name.
-
namespace(optional):
string
Asset namespace.
-
version(optional):
string
Maximum Length:
100
Pattern:^[a-zA-Z0-9][\w.]*$
Asset version.
Nested Schema : assetQualifiers
Type:
object
Asset type name and qualifiers.
Show Source
-
qualifier(optional):
string
The asset qualifier. It may contain multiple values separated by commas (`,`).
-
type(optional):
Allowed Values:
[ "MobileBackend", "API", "APIImplementation", "Connector", "StorageCollection", "Role" ]
Nested Schema : artifact
Type:
object
The artifact information.
Show Source
-
downloadLink(optional):
string
The link to download the artifact.
-
id:
string
The artifact's ID.
-
name:
string
Maximum Length:
255
The name of the artifact. -
properties(optional):
object properties
Additional Properties Allowed: additionalProperties