Retrieve Backend APIs
get
/mobile/tools/1.0/mobilebackends/{id}/apis
Returns an array of metadata about the custom APIs that are associated with the backend. 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 identifier of the backend.
Query Parameters
-
exclude(optional): array
Collection Format:
multi
Expression to exclude from the result the elements that have IDs in the list. Example:exclude=57165555-aa10-4838-938a-354c2b3a287sa&exclude=57165555-aa10-4838-938a-354c2b3a287s
-
filterType(optional): string
Allowed Values: [NOT_PUBLISHED, PUBLISHED, NOT_TRASH, TRASH, ENTERPRISE, IDENTITYPROVIDER, BO_EXCLUDE, BO_INCLUDE, BO_ONLY].
Filter APIs by the following filter types. You can provide multiple values as a comma-separated string. For example,
filterType=NOT_TRASH,ENTERPRISE
.IDENTITYPROVIDER
returns all APIs that have theloginType
attribute set toIDENTITYPROVIDER
ENTERPRISE
returns all APIs that have theloginType
attribute set toENTERPRISE
.BO_INCLUDE
(default) returns all APIs including those with thehasBusinessObjects
attribute set totrue
.BO_EXCLUDE
returns all APIS except those that have thehasBusinessObjects
attribute set totrue
.BO_ONLY
returns only APIs with thehasBusinessObjects
attribute set totrue
.TRASH
returns all APIs that have theinTrash
attribute set totrue
.NOT_TRASH
returns all APIs that have theinTrash
attribute set tofalse
.PUBLISHED
returns all APIs that are in the published state.NOT_PUBLISHED
returns all APIs that aren't in the published state.
-
fromTime(optional): string
Include only the assets that have been modified or deleted on or after the specified time. Example:
2016-03-03T15:13:39.419Z
.Filters by
modifiedOn
for assets that haven't been trashed and bydeletedOn
for trashed assests.Supported values:
- Number of milliseconds since January 1, 1970, 00:00:00 GMT
- Date in ISO 8601 format
- Relative value, such as -1s, -1m, and -1h
-
id(optional): array
Collection Format:
multi
Expression to return only the elements that have IDs in the list. Example:id=93079180-bb00-4838-938a-753c2b3a957a&id=57165555-aa10-4838-938a-354c2b3a287s
-
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.
-
orderBy(optional): string
The ordering for the query operations. The default sort order is ascending by name. When you use ordering with paging, the next and previous links MUST respect the ordering. Multiple values may be provided as a comma-separated string. The format: orderBy=attr[:("asc"|"desc")] [,attr[:("asc"|"desc")]], where the attr parameter may contain any attribute of entity [ name | version | modifiedOn | createdOn | deletedOn | deletedBy ]. Example: orderBy=name:asc,modifiedOn:desc.Default Value:
name:asc
-
q(optional): string
Performs a case-insensitive search for APIs that have a name, display name, or description that contains the string that's provided in this parameter. For example,
q=myApi
. This parameter doesn't support query languages. -
toTime(optional): string
Include only the assets that have been modified or deleted on or before the specified time. Example:
2016-03-03T15:13:39.419Z
.Filters by
modifiedOn
for assets that haven't been trashed and bydeletedOn
for trashed assests.Supported values:
- Number of milliseconds since January 1, 1970, 00:00:00 GMT
- Date in ISO 8601 format
- Relative value, such as -1s, -1m, and -1h
-
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.
Header Parameters
-
Accept-Language(optional): string
Indicates the preferred set of natural languages to use for the response. The results are sorted based on the language. Example:
da, en-gb;q=0.8, en;q=0.7
.
Response
Supported Media Types
- application/json
200 Response
An array of API metadata with pagination information.
An array of the APIs' metadata with paging information.
Root Schema : apiPaging
Type:
object
An array of the APIs' metadata with paging information.
Match All
Show Source
-
object paging
The pagination information.
-
object apiPaging-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 : apiPaging-allOf[1]
Type:
Show Source
object
-
items(optional):
array apiArray
Minimum Number of Items:
0
An array of metadata about the APIs.
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 : apiArray
Type:
array
Minimum Number of Items:
0
An array of metadata about the APIs.
Show Source
-
Array of:
object apiShort
The short API definition representation.
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 : 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