Jump to

• Request
• Response

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.

Body ()

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]

{
    "allOf":[
        {
            "$ref":"#/definitions/paging"
        },
        {
            "properties":{
                "items":{
                    "$ref":"#/definitions/apiImplementationArray"
                }
            }
        }
    ],
    "description":"An array of API implementation elements with paging information.",
    "type":"object",
    "required":[
        "hasMore",
        "count"
    ]
}

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: 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: array paginationLinksArray
  Minimum Number of Items: 0

  An array of links for paginated metadata.
• totalResults: 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`.

{
    "description":"The pagination information.",
    "type":"object",
    "properties":{
        "totalResults":{
            "format":"int64",
            "description":"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`.",
            "type":"integer"
        },
        "hasMore":{
            "description":"Indicates whether the collection has more elements to be retrieved.",
            "type":"boolean"
        },
        "count":{
            "format":"int64",
            "description":"The number of elements in this response.",
            "type":"integer"
        },
        "limit":{
            "format":"int64",
            "description":"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.",
            "type":"integer"
        },
        "links":{
            "$ref":"#/definitions/paginationLinksArray"
        }
    },
    "required":[
        "hasMore",
        "count"
    ]
}

Nested Schema : apiImplementationDetailedPaging-allOf[1]

Type: object

Show Source

• items: array apiImplementationArray
  Minimum Number of Items: 0

  An array of API implementations with artifact information.

{
    "properties":{
        "items":{
            "$ref":"#/definitions/apiImplementationArray"
        }
    }
}

Nested Schema : paginationLinksArray

Type: array

Minimum Number of Items: 0

An array of links for paginated metadata.

Show Source

• [0]: object Link to the paginated metadata.
  Title: Link to the paginated metadata.

{
    "minItems":0,
    "uniqueItems":false,
    "description":"An array of links for paginated metadata.",
    "type":"array",
    "items":{
        "type":"object",
        "title":"Link to the paginated metadata.",
        "properties":{
            "rel":{
                "description":"Link type.",
                "enum":[
                    "self",
                    "canonical",
                    "next",
                    "prev",
                    "first",
                    "last"
                ]
            },
            "href":{
                "description":"Link value.",
                "type":"string"
            }
        },
        "required":[
            "rel",
            "href"
        ]
    }
}

Nested Schema : Link to the paginated metadata.

Type: object

Title: Link to the paginated metadata.

Show Source

• href: string
  Link value.
• rel:
  Allowed Values: [ "self", "canonical", "next", "prev", "first", "last" ]

  Link type.

{
    "type":"object",
    "title":"Link to the paginated metadata.",
    "properties":{
        "rel":{
            "description":"Link type.",
            "enum":[
                "self",
                "canonical",
                "next",
                "prev",
                "first",
                "last"
            ]
        },
        "href":{
            "description":"Link value.",
            "type":"string"
        }
    },
    "required":[
        "rel",
        "href"
    ]
}

Nested Schema : apiImplementationArray

Type: array

Minimum Number of Items: 0

An array of API implementations with artifact information.

Show Source

• [0]: object apiImplementationGet
  The API implementation service details.

{
    "minItems":0,
    "uniqueItems":false,
    "description":"An array of API implementations with artifact information.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/apiImplementationGet"
    }
}

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]

{
    "allOf":[
        {
            "$ref":"#/definitions/assetGet"
        },
        {
            "properties":{
                "api":{
                    "$ref":"#/definitions/assetShortQualified"
                },
                "artifacts":{
                    "$ref":"#/definitions/artifactArray"
                }
            }
        }
    ],
    "description":"The API implementation service details.",
    "type":"object",
    "required":[
        "name",
        "id",
        "published",
        "version",
        "artifacts"
    ]
}

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]

{
    "allOf":[
        {
            "$ref":"#/definitions/assetUpdate"
        },
        {
            "$ref":"#/definitions/assetIdEtag"
        },
        {
            "$ref":"#/definitions/trash"
        },
        {
            "properties":{
                "modifiedOn":{
                    "type":"string"
                },
                "deletedOn":{
                    "type":"string"
                },
                "modifiedBy":{
                    "type":"string"
                },
                "links":{
                    "$ref":"#/definitions/entityLinksArray"
                },
                "published":{
                    "description":"An asset draft or published status representation.",
                    "type":"boolean"
                },
                "createdOn":{
                    "type":"string"
                },
                "deletedBy":{
                    "type":"string"
                }
            }
        }
    ],
    "description":"The asset representation for GET requests.",
    "type":"object",
    "required":[
        "name",
        "links",
        "id",
        "published",
        "version"
    ]
}

Nested Schema : apiImplementationGet-allOf[1]

Type: object

Show Source

• api: object assetShortQualified
  An asset's information in qualified short form, which includes type and qualifiers.
• artifacts: array artifactArray
  Minimum Number of Items: 0

  An array of artifact information.

{
    "properties":{
        "api":{
            "$ref":"#/definitions/assetShortQualified"
        },
        "artifacts":{
            "$ref":"#/definitions/artifactArray"
        }
    }
}

Nested Schema : assetUpdate

Type: object

The asset representation for PUT requests.

Show Source

• actionComment: string
• desc: string
  Maximum Length: 100
• max: boolean
  Default Value: false
• name: string
  Maximum Length: 100

  Pattern: ^[a-zA-Z][a-zA-Z0-9_]*$
• namespace: string
  Applicable to APIs and implementations only. This value is null for all other asset types.
• title: string
  Maximum Length: 255
• version: string
  Maximum Length: 100

  Pattern: ^[a-zA-Z0-9][\w.]*$

  Asset version.

{
    "description":"The asset representation for PUT requests.",
    "type":"object",
    "properties":{
        "max":{
            "default":false,
            "type":"boolean"
        },
        "namespace":{
            "description":"Applicable to APIs and implementations only. This value is null for all other asset types.",
            "type":"string"
        },
        "name":{
            "pattern":"^[a-zA-Z][a-zA-Z0-9_]*$",
            "type":"string",
            "maxLength":100
        },
        "title":{
            "type":"string",
            "maxLength":255
        },
        "version":{
            "$ref":"#/definitions/version"
        },
        "actionComment":{
            "type":"string"
        },
        "desc":{
            "type":"string",
            "maxLength":100
        }
    },
    "required":[
        "name"
    ]
}

Nested Schema : assetIdEtag

Type: object

The asset ID and entity tag (ETag) values.

Show Source

• etag: string
  The asset entity tag (ETag) value, which you can use to detect concurrent modification.
• id: string

{
    "description":"The asset ID and entity tag (ETag) values.",
    "type":"object",
    "properties":{
        "etag":{
            "description":"The asset entity tag (ETag) value, which you can use to detect concurrent modification.",
            "type":"string"
        },
        "id":{
            "type":"string"
        }
    },
    "required":[
        "id"
    ]
}

Nested Schema : trash

Type: object

Indicator of whether the asset is in the trash.

Show Source

• inTrash: boolean

{
    "description":"Indicator of whether the asset is in the trash.",
    "type":"object",
    "properties":{
        "inTrash":{
            "type":"boolean"
        }
    }
}

Nested Schema : assetGet-allOf[3]

Type: object

Show Source

• createdOn: string
• deletedBy: string
• deletedOn: string
• links: array entityLinksArray
  Minimum Number of Items: 0

  An array of links for an entity's metadata.
• modifiedBy: string
• modifiedOn: string
• published: boolean
  An asset draft or published status representation.

{
    "properties":{
        "modifiedOn":{
            "type":"string"
        },
        "deletedOn":{
            "type":"string"
        },
        "modifiedBy":{
            "type":"string"
        },
        "links":{
            "$ref":"#/definitions/entityLinksArray"
        },
        "published":{
            "description":"An asset draft or published status representation.",
            "type":"boolean"
        },
        "createdOn":{
            "type":"string"
        },
        "deletedBy":{
            "type":"string"
        }
    }
}

Nested Schema : entityLinksArray

Type: array

Minimum Number of Items: 0

An array of links for an entity's metadata.

Show Source

• [0]: object items
  Link to the entity's metadata.

{
    "minItems":0,
    "uniqueItems":false,
    "description":"An array of links for an entity's metadata.",
    "type":"array",
    "items":{
        "description":"Link to the entity's metadata.",
        "type":"object",
        "properties":{
            "rel":{
                "description":"Link type.",
                "enum":[
                    "self",
                    "canonical"
                ]
            },
            "href":{
                "description":"Link value.",
                "type":"string"
            }
        },
        "required":[
            "rel",
            "href"
        ]
    }
}

Nested Schema : items

Type: object

Link to the entity's metadata.

Show Source

• href: string
  Link value.
• rel:
  Allowed Values: [ "self", "canonical" ]

  Link type.

{
    "description":"Link to the entity's metadata.",
    "type":"object",
    "properties":{
        "rel":{
            "description":"Link type.",
            "enum":[
                "self",
                "canonical"
            ]
        },
        "href":{
            "description":"Link value.",
            "type":"string"
        }
    },
    "required":[
        "rel",
        "href"
    ]
}

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.

{
    "allOf":[
        {
            "$ref":"#/definitions/assetShort"
        },
        {
            "$ref":"#/definitions/assetQualifiers"
        }
    ],
    "description":"An asset's information in qualified short form, which includes type and qualifiers.",
    "type":"object",
    "required":[
        "name",
        "id",
        "version"
    ]
}

Nested Schema : artifactArray

Type: array

Minimum Number of Items: 0

An array of artifact information.

Show Source

• [0]: object artifact
  The artifact information.

{
    "minItems":0,
    "uniqueItems":false,
    "description":"An array of artifact information.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/artifact"
    }
}

Nested Schema : assetShort

Type: object

Asset information (short form).

Show Source

• id: string
  Asset identifier.
• name: string
  Asset name.
• namespace: string
  Asset namespace.
• version: string
  Maximum Length: 100

  Pattern: ^[a-zA-Z0-9][\w.]*$

  Asset version.

{
    "description":"Asset information (short form).",
    "type":"object",
    "properties":{
        "name":{
            "description":"Asset name.",
            "type":"string"
        },
        "namespace":{
            "description":"Asset namespace.",
            "type":"string"
        },
        "id":{
            "description":"Asset identifier.",
            "type":"string"
        },
        "version":{
            "description":"Asset version.",
            "$ref":"#/definitions/version"
        }
    }
}

Nested Schema : assetQualifiers

Type: object

Asset type name and qualifiers.

Show Source

• qualifier: string
  The asset qualifier. It may contain multiple values separated by commas (`,`).
• type:
  Allowed Values: [ "MobileBackend", "API", "APIImplementation", "Connector", "StorageCollection", "Role" ]

{
    "description":"Asset type name and qualifiers.",
    "type":"object",
    "properties":{
        "qualifier":{
            "description":"The asset qualifier. It may contain multiple values separated by commas (`,`).",
            "type":"string"
        },
        "type":{
            "enum":[
                "MobileBackend",
                "API",
                "APIImplementation",
                "Connector",
                "StorageCollection",
                "Role"
            ]
        }
    }
}

Nested Schema : artifact

Type: object

The artifact information.

Show Source

• downloadLink: string
  The link to download the artifact.
• id: string
  The artifact's ID.
• name: string
  Maximum Length: 255

  The name of the artifact.
• properties: object properties
  Additional Properties Allowed: additionalProperties

{
    "description":"The artifact information.",
    "type":"object",
    "properties":{
        "downloadLink":{
            "description":"The link to download the artifact.",
            "type":"string"
        },
        "name":{
            "description":"The name of the artifact.",
            "type":"string",
            "maxLength":255
        },
        "id":{
            "description":"The artifact's ID.",
            "type":"string"
        },
        "properties":{
            "$ref":"#/definitions/properties"
        }
    },
    "required":[
        "name",
        "id"
    ]
}

Nested Schema : properties

Type: object

Additional Properties Allowed

Show Source

• string

{
    "additionalProperties":{
        "type":"string"
    },
    "type":"object"
}