Jump to

• Request
• Response

Update Backend

put

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

Updates the backend's metadata.

Request

Supported Media Types

• application/json

Path Parameters

• id: string
  The identifier of the backend.

Header Parameters

• If-Match(optional): string
  The request completes successfully only if the ETag of the corresponding asset matches the value of this HTTP request header. To force overwrite, pass the value `*`.

Body ()

The backend representation for PUT requests.

Root Schema : mobilebackendUpdate

Type: object

The backend representation for PUT requests.

Match All

Show Source

• object assetUpdate
  The asset representation for PUT requests.
• object mobilebackendUpdate-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/definitions/assetUpdate"
        },
        {
            "properties":{
                "roleAccess":{
                    "$ref":"#/definitions/mobilebackendRoleAccess"
                },
                "basic":{
                    "type":"boolean"
                },
                "oauth":{
                    "type":"boolean"
                }
            }
        }
    ],
    "description":"The backend representation for PUT requests.",
    "type":"object",
    "required":[
        "name",
        "version"
    ]
}

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

Type: object

Show Source

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

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

Nested Schema : mobilebackendRoleAccess

Type: object

The backend's role-access details.

Show Source

• enabled: boolean
• roles: 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

• [0]: string

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

Response

Supported Media Types

• application/json

204 Response

The backend metadata was updated. No content was returned in this response.

400 Response

The backend specification is missing.

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: 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: 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"
    ]
}

409 Response

The update modifies the backend's name or version and a backend with the same name or version (or both) already exists.

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: 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: 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"
    ]
}

412 Response

The operation failed based on the `If-Match` condition. Typically, this is the result of concurrent modification detection. It also can be the result of improper values specified in the request headers.

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: 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: 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"
    ]
}