Retrieve Backend

get

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

Returns the backend's metadata.

• Request
• Response

Request

Supported Media Types

• application/json

Path Parameters

id

Type: string

Required: true

The identifier of the backend.

Response

Supported Media Types

• application/json

200 Response

The backend's metadata was retrieved successfully.

Headers

ETag

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

• Type: object mobilebackendShortGet
  Additional Properties Allowed:
  The backend representation for GET requests.
• Type: object mobilebackendGet-allOf[1]
  Additional Properties Allowed:

Nested Schema : mobilebackendShortGet

Type: object

The backend representation for GET requests.

Match All

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

Nested Schema : mobilebackendGet-allOf[1]

Properties

analyticsAppGuid

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

Type: object assetShort

Additional Properties Allowed:

Asset information (short form).

targetBackendError

Type: object localizedMessage

Additional Properties Allowed:

Localized error message for generic purposes.

Nested Schema : assetGet

Type: object

The asset representation for GET requests.

Match All

• Type: object assetUpdate
  Additional Properties Allowed:
  The asset representation for PUT requests.
• Type: object assetIdEtag
  Additional Properties Allowed:
  The asset ID and entity tag (ETag) values.
• Type: object trash
  Additional Properties Allowed:
  Indicator of whether the asset is in the trash.
• Type: object assetGet-allOf[3]
  Additional Properties Allowed:

Nested Schema : mobilebackendOAuthKeys

Type: object

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

Properties

clientID

Type: string

Required: true

clientSecret

Type: string

Required: true

sso

Type: boolean

Nested Schema : mobilebackendBasicAuthKeys

Type: object

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

Properties

basicAuthBackendId

Type: string

Required: true

Nested Schema : mobilebackendShortGet-allOf[3]

Properties

basic

Type: boolean

inactive

Type: boolean

oauth

Type: boolean

roleAccess

Type: object mobilebackendRoleAccess

Additional Properties Allowed:

The backend's role-access details.

Nested Schema : assetUpdate

Type: object

The asset representation for PUT requests.

Properties

actionComment

Type: string

desc

Type: string

Maximum Length: 100

max

Type: boolean

Default Value: false

name

Type: string

Required: true

Maximum Length: 100

Pattern: ^[a-zA-Z][a-zA-Z0-9_]*$

namespace

Type: string

Applicable to APIs and implementations only. This value is null for all other asset types.

title

Type: string

Maximum Length: 255

version

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

Properties

etag

Type: string

The asset entity tag (ETag) value, which you can use to detect concurrent modification.

id

Type: string

Required: true

Nested Schema : trash

Type: object

Indicator of whether the asset is in the trash.

Properties

inTrash

Type: boolean

Nested Schema : assetGet-allOf[3]

Properties

createdOn

Type: string

deletedBy

Type: string

deletedOn

Type: string

links

Type: array entityLinksArray

Additional Properties Allowed:

Minimum Number of Items: 0

An array of links for an entity's metadata.

modifiedBy

Type: string

modifiedOn

Type: string

published

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

Items

• Type: object items
  Additional Properties Allowed:
  Link to the entity's metadata.

Nested Schema : items

Type: object

Link to the entity's metadata.

Properties

href

Type: string

Required: true

Link value.

rel

Required: true

Allowed Values: [ "self", "canonical" ]

Link type.

Nested Schema : mobilebackendRoleAccess

Type: object

The backend's role-access details.

Properties

enabled

Type: boolean

roles

Type: array stringArray

Additional Properties Allowed:

Minimum Number of Items: 0

An array of string values.

Nested Schema : stringArray

Type: array

Minimum Number of Items: 0

An array of string values.

Items

• Type: string

Nested Schema : assetShort

Type: object

Asset information (short form).

Properties

id

Type: string

Asset identifier.

name

Type: string

Asset name.

namespace

Type: string

Asset namespace.

version

Type: string

Maximum Length: 100

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

Asset version.

Nested Schema : localizedMessage

Type: object

Localized error message for generic purposes.

Properties

message

Type: string

Required: true

messageId

Type: string

params

Type: array params

Additional Properties Allowed:

Minimum Number of Items: 0

Nested Schema : params

Type: array

Minimum Number of Items: 0

Items

• Type: string

404 Response

The requested backend doesn't exist.

Body

Root Schema : error

Type: object

Properties

detail

Type: string

Required: true

Message that provides the error details.

o:ecid

Type: string

Required: true

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

Type: string

Required: true

The service's error code.

o:errorDetails

Type: object errorDetails

Additional Properties Allowed:

o:errorPath

Type: string

Required: true

The relative point in the API path where the error occurred.

status

Type: integer (int64)

Required: true

HTTP status code. See http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html for more details.

title

Type: string

Required: true

Summary of the problem.

type

Type: string

Required: true

The URI to the link that provides details about the HTTP status code.

Nested Schema : errorDetails

Type: object

Properties

detail

Type: string

Required: true

o:errorDetails

Type: object errorDetails

Additional Properties Allowed:

title

Type: string

Required: true

Summary of the problem.

type

Type: string

Required: true

The URI to the link that provides details about the HTTP status code.