Jump to

• Request
• Response

Retrieve Backend

get

/mobile/tools/1.0/mobilebackends/{id}

Returns the backend's metadata.

Request

Supported Media Types

• application/json

Path Parameters

• id: string
  The identifier of the backend.

Back to Top

Response

Supported Media Types

• application/json

200 Response

The backend's metadata was retrieved successfully.

Headers

• ETag: string
  The ETag corresponds to the state of the backend (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 backend representation for GET requests.

Root Schema : mobilebackendGet

Type: object

The backend representation for GET requests.

Match All

Show Source

• object mobilebackendShortGet
  The backend representation for GET requests.
• object mobilebackendGet-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/definitions/mobilebackendShortGet"
        },
        {
            "properties":{
                "targetBackend":{
                    "description":"Dynamically resolved target backend to which runtime calls will be re-routed.",
                    "$ref":"#/definitions/assetShort"
                },
                "targetBackendError":{
                    "description":"Error message for routing policies that are assigned but a target backend can't be resolved (the same failure should be expected in runtime).",
                    "$ref":"#/definitions/localizedMessage"
                },
                "analyticsAppGuid":{
                    "description":"Analytics application ID resolved from the policy. If a new analytics application creation was requested on the backend creation and this attribute is null, then the application wasn't created. In this case you can check if it already exists, retry, or create one with another name and/or timezone, and then link it to the backend.",
                    "type":"string"
                }
            }
        }
    ],
    "description":"The backend representation for GET requests.",
    "type":"object",
    "required":[
        "name",
        "links",
        "id",
        "published",
        "version"
    ]
}

Nested Schema : mobilebackendShortGet

Type: object

The backend representation for GET requests.

Match All

Show Source

• object assetGet
  The asset representation for GET requests.
• object mobilebackendOAuthKeys
  The client keys (client_id/client_secret) that are required for backend access using OAuth.
• object mobilebackendBasicAuthKeys
  The mobile backend ID that's required for backend access when you use Basic access authorization.
• object mobilebackendShortGet-allOf[3]

{
    "allOf":[
        {
            "$ref":"#/definitions/assetGet"
        },
        {
            "$ref":"#/definitions/mobilebackendOAuthKeys"
        },
        {
            "$ref":"#/definitions/mobilebackendBasicAuthKeys"
        },
        {
            "properties":{
                "inactive":{
                    "type":"boolean"
                },
                "roleAccess":{
                    "$ref":"#/definitions/mobilebackendRoleAccess"
                },
                "basic":{
                    "type":"boolean"
                },
                "oauth":{
                    "type":"boolean"
                }
            }
        }
    ],
    "description":"The backend representation for GET requests.",
    "type":"object",
    "required":[
        "name",
        "links",
        "id",
        "published",
        "version"
    ]
}

Nested Schema : mobilebackendGet-allOf[1]

Type: object

Show Source

• analyticsAppGuid(optional): string
  Analytics application ID resolved from the policy. If a new analytics application creation was requested on the backend creation and this attribute is null, then the application wasn't created. In this case you can check if it already exists, retry, or create one with another name and/or timezone, and then link it to the backend.
• targetBackend(optional): object assetShort
  Asset information (short form).
• targetBackendError(optional): object localizedMessage
  Localized error message for generic purposes.

{
    "properties":{
        "targetBackend":{
            "description":"Dynamically resolved target backend to which runtime calls will be re-routed.",
            "$ref":"#/definitions/assetShort"
        },
        "targetBackendError":{
            "description":"Error message for routing policies that are assigned but a target backend can't be resolved (the same failure should be expected in runtime).",
            "$ref":"#/definitions/localizedMessage"
        },
        "analyticsAppGuid":{
            "description":"Analytics application ID resolved from the policy. If a new analytics application creation was requested on the backend creation and this attribute is null, then the application wasn't created. In this case you can check if it already exists, retry, or create one with another name and/or timezone, and then link it to the backend.",
            "type":"string"
        }
    }
}

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 : mobilebackendOAuthKeys

Type: object

The client keys (client_id/client_secret) that are required for backend access using OAuth.

Show Source

• clientID: string
• clientSecret: string
• sso(optional): boolean

{
    "description":"The client keys (client_id/client_secret) that are required for backend access using OAuth.",
    "type":"object",
    "properties":{
        "clientID":{
            "type":"string"
        },
        "clientSecret":{
            "type":"string"
        },
        "sso":{
            "type":"boolean"
        }
    },
    "required":[
        "clientID",
        "clientSecret"
    ]
}

Nested Schema : mobilebackendBasicAuthKeys

Type: object

The mobile backend ID that's required for backend access when you use Basic access authorization.

Show Source

• basicAuthBackendId: string

{
    "description":"The mobile backend ID that's required for backend access when you use Basic access authorization.",
    "type":"object",
    "properties":{
        "basicAuthBackendId":{
            "type":"string"
        }
    },
    "required":[
        "basicAuthBackendId"
    ]
}

Nested Schema : mobilebackendShortGet-allOf[3]

Type: object

Show Source

• basic(optional): boolean
• inactive(optional): boolean
• oauth(optional): boolean
• roleAccess(optional): object mobilebackendRoleAccess
  The backend's role-access details.

{
    "properties":{
        "inactive":{
            "type":"boolean"
        },
        "roleAccess":{
            "$ref":"#/definitions/mobilebackendRoleAccess"
        },
        "basic":{
            "type":"boolean"
        },
        "oauth":{
            "type":"boolean"
        }
    }
}

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 : mobilebackendRoleAccess

Type: object

The backend's role-access details.

Show Source

• enabled(optional): boolean
• roles(optional): array stringArray
  Minimum Number of Items: 0

  An array of string values.

{
    "description":"The backend's role-access details.",
    "type":"object",
    "properties":{
        "roles":{
            "$ref":"#/definitions/stringArray"
        },
        "enabled":{
            "type":"boolean"
        }
    }
}

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

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

Type: object

Localized error message for generic purposes.

Show Source

• message: string
• messageId(optional): string
• params(optional): array params
  Minimum Number of Items: 0

{
    "description":"Localized error message for generic purposes.",
    "type":"object",
    "properties":{
        "messageId":{
            "type":"string"
        },
        "message":{
            "type":"string"
        },
        "params":{
            "minItems":0,
            "uniqueItems":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    },
    "required":[
        "message"
    ]
}

Nested Schema : params

Type: array

Minimum Number of Items: 0

Show Source

• Array of: string

{
    "minItems":0,
    "uniqueItems":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

404 Response

The requested backend 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