Jump to

• Request
• Response

Retrieve API

get

/mobile/tools/1.0/apis/{id}

Returns the API metadata.

Request

Supported Media Types

• application/json

Path Parameters

• id: string
  The identifier of the API.

Back to Top

Response

Supported Media Types

• application/json

200 Response

API metadata.

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.

Body ()

The API representation for GET requests.

Root Schema : apiGet

Type: object

The API representation for GET requests.

Match All

Show Source

• object apiShort
  The short API definition representation.
• object apiGet-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/definitions/apiShort"
        },
        {
            "properties":{
                "apiDefn":{
                    "$ref":"#/definitions/stringArray"
                },
                "security":{
                    "$ref":"#/definitions/apiSecurity"
                },
                "businessObjectsDefn":{
                    "type":"string"
                },
                "category":{
                    "enum":[
                        "CUSTOM",
                        "PLATFORM",
                        "SYSTEM",
                        "CONNECTOR"
                    ]
                }
            }
        }
    ],
    "description":"The API representation for GET requests.",
    "type":"object",
    "required":[
        "apiDefn",
        "basePath",
        "name",
        "links",
        "id",
        "published",
        "category",
        "title",
        "version"
    ]
}

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]

{
    "allOf":[
        {
            "$ref":"#/definitions/assetGet"
        },
        {
            "properties":{
                "basePath":{
                    "description":"The API base path in the format `/mobile/custom/{apiName}`.",
                    "type":"string"
                },
                "hasBusinessObjects":{
                    "default":false,
                    "description":"Indicates whether the API is associated with API Express resources (business objects).",
                    "type":"boolean"
                },
                "icon":{
                    "$ref":"#/definitions/icon"
                }
            }
        }
    ],
    "description":"The short API definition representation.",
    "type":"object",
    "required":[
        "basePath",
        "name",
        "links",
        "id",
        "published",
        "title",
        "version"
    ]
}

Nested Schema : apiGet-allOf[1]

Type: object

Show Source

• apiDefn(optional): array stringArray
  Minimum Number of Items: 0

  An array of string values.
• businessObjectsDefn(optional): string
• category(optional):
  Allowed Values: [ "CUSTOM", "PLATFORM", "SYSTEM", "CONNECTOR" ]
• security(optional): object apiSecurity
  The API security for POST and PUT requests.

{
    "properties":{
        "apiDefn":{
            "$ref":"#/definitions/stringArray"
        },
        "security":{
            "$ref":"#/definitions/apiSecurity"
        },
        "businessObjectsDefn":{
            "type":"string"
        },
        "category":{
            "enum":[
                "CUSTOM",
                "PLATFORM",
                "SYSTEM",
                "CONNECTOR"
            ]
        }
    }
}

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 : apiShort-allOf[1]

Type: object

Show Source

• 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.

{
    "properties":{
        "basePath":{
            "description":"The API base path in the format `/mobile/custom/{apiName}`.",
            "type":"string"
        },
        "hasBusinessObjects":{
            "default":false,
            "description":"Indicates whether the API is associated with API Express resources (business objects).",
            "type":"boolean"
        },
        "icon":{
            "$ref":"#/definitions/icon"
        }
    }
}

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.

{
    "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(optional): 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(optional): 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(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.

{
    "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

• Array of: 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 : icon

Type: object

Information about the icon that's associated with the API or connector.

Show Source

• id: string
• url: string

{
    "description":"Information about the icon that's associated with the API or connector.",
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "url":{
            "type":"string"
        }
    },
    "required":[
        "id",
        "url"
    ]
}

Nested Schema : stringArray

Type: array

Minimum Number of Items: 0

An array of string values.

Show Source

• Array of: string

{
    "minItems":0,
    "uniqueItems":false,
    "description":"An array of string values.",
    "type":"array",
    "items":{
        "type":"string"
    }
}

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.

{
    "description":"The API security for POST and PUT requests.",
    "type":"object",
    "properties":{
        "endpoints":{
            "$ref":"#/definitions/endpointSecurityArray"
        },
        "access":{
            "$ref":"#/definitions/securityAccess"
        },
        "loginType":{
            "description":"If the `required` attribute has a value of `true`, then the default is `ENTERPRISE`.",
            "enum":[
                "ENTERPRISE",
                "IDENTITYPROVIDER"
            ]
        },
        "required":{
            "description":"When `true`, either security access or a social identity provider configuration is required.",
            "type":"boolean"
        }
    },
    "required":[
        "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.

{
    "description":"Access details.",
    "type":"object",
    "properties":{
        "all":{
            "type":"boolean"
        },
        "roles":{
            "$ref":"#/definitions/stringArray"
        }
    }
}

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.

{
    "minItems":0,
    "uniqueItems":false,
    "description":"An array of endpoint security elements.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/endpointSecurity"
    }
}

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

{
    "description":"The API security for POST and PUT requests.",
    "type":"object",
    "properties":{
        "access":{
            "$ref":"#/definitions/securityAccess"
        },
        "method":{
            "type":"string"
        },
        "resource":{
            "type":"string"
        }
    },
    "required":[
        "method",
        "resource"
    ]
}

404 Response

An API with specified ID doesn't exist.

Body ()

Root Schema : error

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "o:errorCode":{
            "description":"The service's error code.",
            "type":"string"
        },
        "o:errorDetails":{
            "$ref":"#/definitions/errorDetails"
        },
        "detail":{
            "description":"Message that provides the error details.",
            "type":"string"
        },
        "type":{
            "description":"The URI to the link that provides details about the HTTP status code.",
            "type":"string"
        },
        "title":{
            "description":"Summary of the problem.",
            "type":"string"
        },
        "o:errorPath":{
            "description":"The relative point in the API path where the error occurred.",
            "type":"string"
        },
        "o:ecid":{
            "description":"Execution context ID, which is a unique identifier to correlate events or requests that are associated with the same transaction across several components.",
            "type":"string"
        },
        "status":{
            "format":"int64",
            "description":"HTTP status code. See http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html for more details.",
            "type":"integer"
        }
    },
    "required":[
        "o:errorCode",
        "detail",
        "type",
        "title",
        "o:errorPath",
        "o:ecid",
        "status"
    ]
}

Nested Schema : errorDetails

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "o:errorDetails":{
            "$ref":"#/definitions/errorDetails"
        },
        "detail":{
            "type":"string"
        },
        "type":{
            "description":"The URI to the link that provides details about the HTTP status code.",
            "type":"string"
        },
        "title":{
            "description":"Summary of the problem.",
            "type":"string"
        }
    },
    "required":[
        "detail",
        "type",
        "title"
    ]
}

Back to Top