Jump to

• Request
• Response
• Examples

Install Package

post

/mobile/tools/1.0/import/package/install

Installs the uploaded package file that's identified by the artifact ID and name in the request body.

Note that when you import (upload) the package, you can copy the artifact object from the upload response body to use in the request body for this operation.

Request

Supported Media Types

• application/json

Body ()

Root Schema : Request Body for Package Installation

Type: object

Title: Request Body for Package Installation

Artifact information about the package to install.

Match All

Show Source

• object artifact
  The artifact information.

{
    "allOf":[
        {
            "$ref":"#/definitions/artifact"
        }
    ],
    "description":"Artifact information about the package to install.",
    "title":"Request Body for Package Installation",
    "type":"object",
    "required":[
        "artifact"
    ]
}

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

Response

Supported Media Types

• application/json

200 Response

The package file was installed.

Body ()

Information about the package that was uploaded or installed.

Root Schema : packageImport

Type: object

Information about the package that was uploaded or installed.

Show Source

• importResults: object importReport
  Import results.
• package: object packageGet
  The package representation for GET requests.
• policies: array policyArray
  Minimum Number of Items: 0

  Unique Items Required: true

  An array of policy elements.
• policyValidationReport: object policyValidationReport
  The result of validation of the properties file with policies.
• status:
  Allowed Values: [ "SUCCESS", "FAILURE" ]

{
    "description":"Information about the package that was uploaded or installed.",
    "type":"object",
    "properties":{
        "package":{
            "$ref":"#/definitions/packageGet"
        },
        "policyValidationReport":{
            "$ref":"#/definitions/policyValidationReport"
        },
        "policies":{
            "$ref":"#/definitions/policyArray"
        },
        "importResults":{
            "$ref":"#/definitions/importReport"
        },
        "status":{
            "enum":[
                "SUCCESS",
                "FAILURE"
            ]
        }
    },
    "required":[
        "package"
    ]
}

Nested Schema : importReport

Type: object

Import results.

Show Source

• dependencies: object dependencies
  Information about the asset and its dependencies.
• records: array checklistRecordArray
  Minimum Number of Items: 0

  Unique Items Required: true

  An array of checklist report records.

{
    "description":"Import results.",
    "type":"object",
    "properties":{
        "records":{
            "$ref":"#/definitions/checklistRecordArray"
        },
        "dependencies":{
            "$ref":"#/definitions/dependencies"
        }
    },
    "required":[
        "records"
    ]
}

Nested Schema : packageGet

Type: object

The package representation for GET requests.

Match All

Show Source

• object assetGet
  The asset representation for GET requests.
• object packageGet-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/definitions/assetGet"
        },
        {
            "properties":{
                "documentation":{
                    "type":"boolean"
                },
                "packageType":{
                    "enum":[
                        "EXPORT",
                        "IMPORT"
                    ]
                },
                "systemVersion":{
                    "type":"string"
                }
            }
        }
    ],
    "description":"The package representation for GET requests.",
    "type":"object"
}

Nested Schema : policyArray

Type: array

Minimum Number of Items: 0

Unique Items Required: true

An array of policy elements.

Show Source

• [0]: object policy
  Policy object representation.

{
    "minItems":0,
    "uniqueItems":true,
    "description":"An array of policy elements.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/policy"
    }
}

Nested Schema : policyValidationReport

Type: object

The result of validation of the properties file with policies.

Show Source

• valid: boolean
• validationResults: array validationResults
  Minimum Number of Items: 0

{
    "description":"The result of validation of the properties file with policies.",
    "type":"object",
    "properties":{
        "valid":{
            "type":"boolean"
        },
        "validationResults":{
            "minItems":0,
            "uniqueItems":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    },
    "required":[
        "valid"
    ]
}

Nested Schema : dependencies

Type: object

Information about the asset and its dependencies.

Show Source

• apis: array apiDependencyArray
  Minimum Number of Items: 0

  Unique Items Required: true

  An array of APIs as dependencies.
• collections: array collectionDependencyArray
  Minimum Number of Items: 0

  Unique Items Required: true

  An array of storage collections as dependencies.
• connectors: array connectorDependencyArray
  Minimum Number of Items: 0

  Unique Items Required: true

  An array of connectors as dependencies.
• implementations: array implDependencyArray
  Minimum Number of Items: 0

  Unique Items Required: true

  An array of API implementations as dependencies.
• mobilebackends: array mbeDependencyArray
  Minimum Number of Items: 0

  Unique Items Required: true

  An array of backends as dependencies.
• packages: array packageDependencyArray
  Minimum Number of Items: 0

  Unique Items Required: true

  An array of packages as dependencies.
• roles: array roleArray
  Minimum Number of Items: 0

  Unique Items Required: true

  An array of role elements.
• unresolvedDependencies: array unresolvedDependencyArray
  Minimum Number of Items: 0

  Unique Items Required: true

  An array of unresolved dependencies for a custom API implementation.

{
    "description":"Information about the asset and its dependencies.",
    "type":"object",
    "properties":{
        "connectors":{
            "$ref":"#/definitions/connectorDependencyArray"
        },
        "apis":{
            "$ref":"#/definitions/apiDependencyArray"
        },
        "collections":{
            "$ref":"#/definitions/collectionDependencyArray"
        },
        "unresolvedDependencies":{
            "$ref":"#/definitions/unresolvedDependencyArray"
        },
        "roles":{
            "$ref":"#/definitions/roleArray"
        },
        "mobilebackends":{
            "$ref":"#/definitions/mbeDependencyArray"
        },
        "packages":{
            "$ref":"#/definitions/packageDependencyArray"
        },
        "implementations":{
            "$ref":"#/definitions/implDependencyArray"
        }
    }
}

Nested Schema : checklistRecordArray

Type: array

Minimum Number of Items: 0

Unique Items Required: true

An array of checklist report records.

Show Source

• [0]: object checklistRecord
  An asset's checklist/import result.

{
    "minItems":0,
    "uniqueItems":true,
    "description":"An array of checklist report records.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/checklistRecord"
    }
}

Nested Schema : apiDependencyArray

Type: array

Minimum Number of Items: 0

Unique Items Required: true

An array of APIs as dependencies.

Show Source

• [0]: object apiDependency
  API as a dependency.

{
    "minItems":0,
    "uniqueItems":true,
    "description":"An array of APIs as dependencies.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/apiDependency"
    }
}

Nested Schema : collectionDependencyArray

Type: array

Minimum Number of Items: 0

Unique Items Required: true

An array of storage collections as dependencies.

Show Source

• [0]: object collectionDependency
  Storage collection as a dependency.

{
    "minItems":0,
    "uniqueItems":true,
    "description":"An array of storage collections as dependencies.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/collectionDependency"
    }
}

Nested Schema : connectorDependencyArray

Type: array

Minimum Number of Items: 0

Unique Items Required: true

An array of connectors as dependencies.

Show Source

• [0]: object connectorDependency
  Connector as a dependency.

{
    "minItems":0,
    "uniqueItems":true,
    "description":"An array of connectors as dependencies.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/connectorDependency"
    }
}

Nested Schema : implDependencyArray

Type: array

Minimum Number of Items: 0

Unique Items Required: true

An array of API implementations as dependencies.

Show Source

• [0]: object implDependency
  API implementation as a dependency.

{
    "minItems":0,
    "uniqueItems":true,
    "description":"An array of API implementations as dependencies.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/implDependency"
    }
}

Nested Schema : mbeDependencyArray

Type: array

Minimum Number of Items: 0

Unique Items Required: true

An array of backends as dependencies.

Show Source

• [0]: object mbeDependency
  Backend as a dependency.

{
    "minItems":0,
    "uniqueItems":true,
    "description":"An array of backends as dependencies.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/mbeDependency"
    }
}

Nested Schema : packageDependencyArray

Type: array

Minimum Number of Items: 0

Unique Items Required: true

An array of packages as dependencies.

Show Source

• [0]: object packageDependency
  Package as a dependency.

{
    "minItems":0,
    "uniqueItems":true,
    "description":"An array of packages as dependencies.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/packageDependency"
    }
}

Nested Schema : roleArray

Type: array

Minimum Number of Items: 0

Unique Items Required: true

An array of role elements.

Show Source

• [0]: object roleGet
  The role representation.

{
    "minItems":0,
    "uniqueItems":true,
    "description":"An array of role elements.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/roleGet"
    }
}

Nested Schema : unresolvedDependencyArray

Type: array

Minimum Number of Items: 0

Unique Items Required: true

An array of unresolved dependencies for a custom API implementation.

Show Source

• [0]: object unresolvedDependency
  Unresolved dependency for the custom API implementation.

{
    "minItems":0,
    "uniqueItems":true,
    "description":"An array of unresolved dependencies for a custom API implementation.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/unresolvedDependency"
    }
}

Nested Schema : apiDependency

Type: object

API as a dependency.

Match All

Show Source

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

{
    "allOf":[
        {
            "$ref":"#/definitions/apiShort"
        },
        {
            "properties":{
                "implementation":{
                    "description":"The default API implementation for the API.",
                    "$ref":"#/definitions/assetShort"
                },
                "roles":{
                    "description":"The list of roles used by this API.",
                    "$ref":"#/definitions/roleArray"
                },
                "mock":{
                    "description":"The <code>Routing_BindAPIToMock</code> environment policy that's defined for the API. When this value is true, the service resolves the API request to a mock service instead of the implementation that's bound to the API. This is returned only in the context of the backend.",
                    "type":"boolean"
                },
                "implementations":{
                    "description":"A list of short representations of the API implementations that are connected to the API.",
                    "$ref":"#/definitions/assetShortQualifiedArray"
                }
            }
        }
    ],
    "description":"API as a dependency.",
    "type":"object"
}

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

Type: object

Show Source

• implementation: object assetShort
  Asset information (short form).
• implementations: array assetShortQualifiedArray
  Minimum Number of Items: 0

  Unique Items Required: true

  An array of qualified assets.
• mock: boolean
  The Routing_BindAPIToMock environment policy that's defined for the API. When this value is true, the service resolves the API request to a mock service instead of the implementation that's bound to the API. This is returned only in the context of the backend.
• roles: array roleArray
  Minimum Number of Items: 0

  Unique Items Required: true

  An array of role elements.

{
    "properties":{
        "implementation":{
            "description":"The default API implementation for the API.",
            "$ref":"#/definitions/assetShort"
        },
        "roles":{
            "description":"The list of roles used by this API.",
            "$ref":"#/definitions/roleArray"
        },
        "mock":{
            "description":"The <code>Routing_BindAPIToMock</code> environment policy that's defined for the API. When this value is true, the service resolves the API request to a mock service instead of the implementation that's bound to the API. This is returned only in the context of the backend.",
            "type":"boolean"
        },
        "implementations":{
            "description":"A list of short representations of the API implementations that are connected to the API.",
            "$ref":"#/definitions/assetShortQualifiedArray"
        }
    }
}

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: string
  The API base path in the format `/mobile/custom/{apiName}`.
• hasBusinessObjects: boolean
  Default Value: false

  Indicates whether the API is associated with API Express resources (business objects).
• icon: 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: 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 : 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 : 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 : assetShortQualifiedArray

Type: array

Minimum Number of Items: 0

Unique Items Required: true

An array of qualified assets.

Show Source

• [0]: object assetShortQualified
  An asset's information in qualified short form, which includes type and qualifiers.

{
    "minItems":0,
    "uniqueItems":true,
    "description":"An array of qualified assets.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/assetShortQualified"
    }
}

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

Type: object

Storage collection as a dependency.

Match All

Show Source

• object mosCollectionGet
  The storage collection representation for GET requests.
• object assetQualifiers
  Asset type name and qualifiers.
• object collectionDependency-allOf[2]

{
    "allOf":[
        {
            "$ref":"#/definitions/mosCollectionGet"
        },
        {
            "$ref":"#/definitions/assetQualifiers"
        },
        {
            "properties":{
                "roles":{
                    "description":"The list of roles used by this collection.",
                    "$ref":"#/definitions/roleArray"
                }
            }
        }
    ],
    "description":"Storage collection as a dependency.",
    "type":"object"
}

Nested Schema : mosCollectionGet

Type: object

The storage collection representation for GET requests.

Match All

Show Source

• object assetGet
  The asset representation for GET requests.
• object mosCollectionGet-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/definitions/assetGet"
        },
        {
            "properties":{
                "userIsolated":{
                    "type":"boolean"
                },
                "guid":{
                    "type":"string"
                },
                "syncControl":{
                    "type":"boolean"
                }
            }
        }
    ],
    "description":"The storage collection representation for GET requests.",
    "type":"object",
    "required":[
        "name",
        "userIsolated",
        "guid",
        "links",
        "id",
        "published",
        "syncControl",
        "version"
    ]
}

Nested Schema : collectionDependency-allOf[2]

Type: object

Show Source

• roles: array roleArray
  Minimum Number of Items: 0

  Unique Items Required: true

  An array of role elements.

{
    "properties":{
        "roles":{
            "description":"The list of roles used by this collection.",
            "$ref":"#/definitions/roleArray"
        }
    }
}

Nested Schema : mosCollectionGet-allOf[1]

Type: object

Show Source

• guid: string
• syncControl: boolean
• userIsolated: boolean

{
    "properties":{
        "userIsolated":{
            "type":"boolean"
        },
        "guid":{
            "type":"string"
        },
        "syncControl":{
            "type":"boolean"
        }
    }
}

Nested Schema : connectorDependency

Type: object

Connector as a dependency.

Match All

Show Source

• object connectorGet
  The connector representation for GET requests.
• object assetQualifiers
  Asset type name and qualifiers.
• object connectorDependency-allOf[2]

{
    "allOf":[
        {
            "$ref":"#/definitions/connectorGet"
        },
        {
            "$ref":"#/definitions/assetQualifiers"
        },
        {
            "properties":{
                "implementation":{
                    "description":"Connector implementation information.",
                    "$ref":"#/definitions/assetShort"
                }
            }
        }
    ],
    "description":"Connector as a dependency.",
    "type":"object"
}

Nested Schema : connectorGet

Type: object

The connector representation for GET requests.

Match All

Show Source

• object connectorShort
  The short connector definition representation.
• connectorGet-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/definitions/connectorShort"
        },
        {
            "x-oneOf":[
                {
                    "$ref":"#/definitions/connectorGetRest"
                },
                {
                    "$ref":"#/definitions/connectorUpdateSoap"
                },
                {
                    "$ref":"#/definitions/connectorUpdateDatabase"
                },
                {
                    "$ref":"#/definitions/connectorUpdateIcsRest"
                },
                {
                    "$ref":"#/definitions/connectorUpdateIcsSoap"
                }
            ]
        }
    ],
    "description":"The connector representation for GET requests.",
    "type":"object",
    "required":[
        "connectorType",
        "name",
        "links",
        "id",
        "published",
        "version"
    ]
}

Nested Schema : connectorDependency-allOf[2]

Type: object

Show Source

• implementation: object assetShort
  Asset information (short form).

{
    "properties":{
        "implementation":{
            "description":"Connector implementation information.",
            "$ref":"#/definitions/assetShort"
        }
    }
}

Nested Schema : connectorShort

Type: object

The short connector definition representation.

Match All

Show Source

• object assetGet
  The asset representation for GET requests.
• object connectorBase
  Base connector properties.

{
    "allOf":[
        {
            "$ref":"#/definitions/assetGet"
        },
        {
            "$ref":"#/definitions/connectorBase"
        }
    ],
    "description":"The short connector definition representation.",
    "type":"object",
    "required":[
        "connectorType",
        "name",
        "links",
        "id",
        "published",
        "version"
    ]
}

Nested Schema : connectorGet-allOf[1]

Match One

Show Source

• object connectorGetRest
  REST connector get payload.
• object connectorUpdateSoap
  SOAP connector update payload.
• object connectorUpdateDatabase
  MOB DB connector update payload.
• object connectorUpdateIcsRest
  ICS REST connector update payload.
• object connectorUpdateIcsSoap
  ICS SOAP connector update payload.

{
    "x-oneOf":[
        {
            "$ref":"#/definitions/connectorGetRest"
        },
        {
            "$ref":"#/definitions/connectorUpdateSoap"
        },
        {
            "$ref":"#/definitions/connectorUpdateDatabase"
        },
        {
            "$ref":"#/definitions/connectorUpdateIcsRest"
        },
        {
            "$ref":"#/definitions/connectorUpdateIcsSoap"
        }
    ]
}

Nested Schema : connectorBase

Type: object

Base connector properties.

Show Source

• basePath: string
  The connector API base path in the format `/mobile/connector/{name}/{path}`.
• connectorType:
  Allowed Values: [ "REST", "SOAP", "DATABASE", "ICS", "FA" ]
• icon: object icon
  Information about the icon that's associated with the API or connector.

{
    "description":"Base connector properties.",
    "type":"object",
    "properties":{
        "connectorType":{
            "enum":[
                "REST",
                "SOAP",
                "DATABASE",
                "ICS",
                "FA"
            ]
        },
        "basePath":{
            "description":"The connector API base path in the format `/mobile/connector/{name}/{path}`.",
            "type":"string"
        },
        "icon":{
            "$ref":"#/definitions/icon"
        }
    }
}

Nested Schema : connectorGetRest

Type: object

REST connector get payload.

Match All

Show Source

• object connectorUpdateRest
  REST connector update payload.
• object connectorGetRest-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/definitions/connectorUpdateRest"
        },
        {
            "properties":{
                "descriptorInfo":{
                    "$ref":"#/definitions/connectorDescriptorInfo"
                }
            }
        }
    ],
    "description":"REST connector get payload.",
    "type":"object"
}

Nested Schema : connectorUpdateSoap

Type: object

SOAP connector update payload.

Match All

Show Source

• object connectorCreateSoap
  SOAP connector creation payload.
• object connectorUpdateSoap-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/definitions/connectorCreateSoap"
        },
        {
            "properties":{
                "svcPort":{
                    "type":"string"
                },
                "operations":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "custom":{
                                "description":"The custom name for the operation.",
                                "type":"string"
                            },
                            "name":{
                                "type":"string"
                            },
                            "uri":{
                                "description":"The URI for the SOAPAction HTTP request header.",
                                "type":"string"
                            }
                        },
                        "required":[
                            "name",
                            "uri"
                        ]
                    }
                },
                "httpReadTimeout":{
                    "format":"int64",
                    "type":"integer"
                },
                "httpConnectionTimeout":{
                    "format":"int64",
                    "type":"integer"
                },
                "securityPolicies":{
                    "$ref":"#/definitions/securityPolicyArray"
                },
                "svcName":{
                    "type":"string"
                },
                "svcEndpoint":{
                    "type":"string"
                }
            },
            "required":[
                "svcPort",
                "svcName",
                "svcEndpoint"
            ]
        }
    ],
    "description":"SOAP connector update payload.",
    "type":"object"
}

Nested Schema : connectorUpdateDatabase

Type: object

MOB DB connector update payload.

Match All

Show Source

• object connectorCreateDatabase
  REST connector creation payload.
• object connectorUpdateDatabase-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/definitions/connectorCreateDatabase"
        },
        {
            "properties":{
                "dbConnectorMetadata":{
                    "description":"The full table and call metadata.",
                    "$ref":"#/definitions/dbConnectorMetadata"
                }
            }
        }
    ],
    "description":"MOB DB connector update payload.",
    "type":"object"
}

Nested Schema : connectorUpdateIcsRest

Type: object

ICS REST connector update payload.

Match All

Show Source

• object connectorUpdateRest
  REST connector update payload.
• object connectorUpdateIcsRest-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/definitions/connectorUpdateRest"
        },
        {
            "properties":{
                "integration":{
                    "$ref":"#/definitions/integration"
                },
                "ics":{
                    "$ref":"#/definitions/icsConnectionReference"
                }
            }
        }
    ],
    "description":"ICS REST connector update payload.",
    "type":"object"
}

Nested Schema : connectorUpdateIcsSoap

Type: object

ICS SOAP connector update payload.

Match All

Show Source

• object connectorUpdateSoap
  SOAP connector update payload.
• object connectorUpdateIcsSoap-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/definitions/connectorUpdateSoap"
        },
        {
            "properties":{
                "integration":{
                    "$ref":"#/definitions/integration"
                },
                "ics":{
                    "$ref":"#/definitions/icsConnectionReference"
                }
            }
        }
    ],
    "description":"ICS SOAP connector update payload.",
    "type":"object"
}

Nested Schema : connectorUpdateRest

Type: object

REST connector update payload.

Show Source

• httpConnectionTimeout: integer(int64)
• httpReadTimeout: integer(int64)
• remoteURL: string
• rules: array restRuleArray
  Minimum Number of Items: 0

  An array of REST rules.
• securityPolicies: array securityPolicyArray
  Minimum Number of Items: 0

  An array of security policy elements.
• workAreaTag: string

{
    "description":"REST connector update payload.",
    "type":"object",
    "properties":{
        "httpReadTimeout":{
            "format":"int64",
            "type":"integer"
        },
        "workAreaTag":{
            "type":"string"
        },
        "httpConnectionTimeout":{
            "format":"int64",
            "type":"integer"
        },
        "remoteURL":{
            "type":"string"
        },
        "rules":{
            "$ref":"#/definitions/restRuleArray"
        },
        "securityPolicies":{
            "$ref":"#/definitions/securityPolicyArray"
        }
    },
    "required":[
        "remoteURL"
    ]
}

Nested Schema : connectorGetRest-allOf[1]

Type: object

Show Source

• descriptorInfo: object connectorDescriptorInfo
  Connector descriptor information.

{
    "properties":{
        "descriptorInfo":{
            "$ref":"#/definitions/connectorDescriptorInfo"
        }
    }
}

Nested Schema : restRuleArray

Type: array

Minimum Number of Items: 0

An array of REST rules.

Show Source

• [0]: object restRule
  REST connector rule definition.

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

Nested Schema : securityPolicyArray

Type: array

Minimum Number of Items: 0

An array of security policy elements.

Show Source

• [0]: object securityPolicy
  Connector OWSM security policy.

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

Nested Schema : restRule

Type: object

REST connector rule definition.

Show Source

• defaultParameters: array defaultParameters
  Minimum Number of Items: 0

  Unique Items Required: true
• methods: array methods
  Minimum Number of Items: 0

  Unique Items Required: true
• notAppliedToNested: boolean
• resource: string

{
    "description":"REST connector rule definition.",
    "type":"object",
    "properties":{
        "defaultParameters":{
            "minItems":0,
            "uniqueItems":true,
            "type":"array",
            "items":{
                "$ref":"#/definitions/restParameter"
            }
        },
        "resource":{
            "type":"string"
        },
        "notAppliedToNested":{
            "type":"boolean"
        },
        "methods":{
            "minItems":0,
            "uniqueItems":true,
            "type":"array",
            "items":{
                "enum":[
                    "GET",
                    "POST",
                    "PUT",
                    "DELETE",
                    "HEAD",
                    "TRACE",
                    "OPTIONS",
                    "PATCH"
                ]
            }
        }
    }
}

Nested Schema : defaultParameters

Type: array

Minimum Number of Items: 0

Unique Items Required: true

Show Source

• [0]: object restParameter
  REST connector rule default parameter.

{
    "minItems":0,
    "uniqueItems":true,
    "type":"array",
    "items":{
        "$ref":"#/definitions/restParameter"
    }
}

Nested Schema : methods

Type: array

Minimum Number of Items: 0

Unique Items Required: true

Show Source

• [0]:
  Allowed Values: [ "GET", "POST", "PUT", "DELETE", "HEAD", "TRACE", "OPTIONS", "PATCH" ]

{
    "minItems":0,
    "uniqueItems":true,
    "type":"array",
    "items":{
        "enum":[
            "GET",
            "POST",
            "PUT",
            "DELETE",
            "HEAD",
            "TRACE",
            "OPTIONS",
            "PATCH"
        ]
    }
}

Nested Schema : restParameter

Type: object

REST connector rule default parameter.

Show Source

• name: string
• type:
  Allowed Values: [ "query", "header" ]
• value: string

{
    "description":"REST connector rule default parameter.",
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "type":{
            "enum":[
                "query",
                "header"
            ]
        },
        "value":{
            "type":"string"
        }
    }
}

Nested Schema : securityPolicy

Type: object

Connector OWSM security policy.

Show Source

• name: string
• overrides: array securityPolicyOverrideArray
  Minimum Number of Items: 0

  An array of security-policy override elements.

{
    "description":"Connector OWSM security policy.",
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "overrides":{
            "$ref":"#/definitions/securityPolicyOverrideArray"
        }
    },
    "required":[
        "name"
    ]
}

Nested Schema : securityPolicyOverrideArray

Type: array

Minimum Number of Items: 0

An array of security-policy override elements.

Show Source

• [0]: object securityPolicyOverride
  Security policy override property.

{
    "minItems":0,
    "uniqueItems":false,
    "description":"An array of security-policy override elements.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/securityPolicyOverride"
    }
}

Nested Schema : securityPolicyOverride

Type: object

Security policy override property.

Show Source

• propertyName: string
• value: string

{
    "description":"Security policy override property.",
    "type":"object",
    "properties":{
        "propertyName":{
            "type":"string"
        },
        "value":{
            "type":"string"
        }
    },
    "required":[
        "propertyName",
        "value"
    ]
}

Nested Schema : connectorDescriptorInfo

Type: object

Connector descriptor information.

Show Source

• descriptorLocation: string
• descriptorSource:
  Allowed Values: [ "URL", "FILE", "NONE" ]
• designTimeUserName: string
• isDesignTimePasswordSaved: boolean

{
    "description":"Connector descriptor information.",
    "type":"object",
    "properties":{
        "designTimeUserName":{
            "type":"string"
        },
        "descriptorLocation":{
            "type":"string"
        },
        "descriptorSource":{
            "enum":[
                "URL",
                "FILE",
                "NONE"
            ]
        },
        "isDesignTimePasswordSaved":{
            "type":"boolean"
        }
    },
    "required":[
        "descriptorSource"
    ]
}

Nested Schema : connectorCreateSoap

Type: object

SOAP connector creation payload.

Show Source

• wsdl: string

{
    "description":"SOAP connector creation payload.",
    "type":"object",
    "properties":{
        "wsdl":{
            "type":"string"
        }
    },
    "required":[
        "wsdl"
    ]
}

Nested Schema : connectorUpdateSoap-allOf[1]

Type: object

Show Source

• httpConnectionTimeout: integer(int64)
• httpReadTimeout: integer(int64)
• operations: array operations
• securityPolicies: array securityPolicyArray
  Minimum Number of Items: 0

  An array of security policy elements.
• svcEndpoint: string
• svcName: string
• svcPort: string

{
    "properties":{
        "svcPort":{
            "type":"string"
        },
        "operations":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "custom":{
                        "description":"The custom name for the operation.",
                        "type":"string"
                    },
                    "name":{
                        "type":"string"
                    },
                    "uri":{
                        "description":"The URI for the SOAPAction HTTP request header.",
                        "type":"string"
                    }
                },
                "required":[
                    "name",
                    "uri"
                ]
            }
        },
        "httpReadTimeout":{
            "format":"int64",
            "type":"integer"
        },
        "httpConnectionTimeout":{
            "format":"int64",
            "type":"integer"
        },
        "securityPolicies":{
            "$ref":"#/definitions/securityPolicyArray"
        },
        "svcName":{
            "type":"string"
        },
        "svcEndpoint":{
            "type":"string"
        }
    },
    "required":[
        "svcPort",
        "svcName",
        "svcEndpoint"
    ]
}

Nested Schema : operations

Type: array

Show Source

• [0]: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "custom":{
                "description":"The custom name for the operation.",
                "type":"string"
            },
            "name":{
                "type":"string"
            },
            "uri":{
                "description":"The URI for the SOAPAction HTTP request header.",
                "type":"string"
            }
        },
        "required":[
            "name",
            "uri"
        ]
    }
}

Nested Schema : items

Type: object

Show Source

• custom: string
  The custom name for the operation.
• name: string
• uri: string
  The URI for the SOAPAction HTTP request header.

{
    "type":"object",
    "properties":{
        "custom":{
            "description":"The custom name for the operation.",
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "uri":{
            "description":"The URI for the SOAPAction HTTP request header.",
            "type":"string"
        }
    },
    "required":[
        "name",
        "uri"
    ]
}

Nested Schema : connectorCreateDatabase

Type: object

REST connector creation payload.

Show Source

• databaseConnectorType:
  Allowed Values: [ "table", "customsql" ]

{
    "description":"REST connector creation payload.",
    "type":"object",
    "properties":{
        "databaseConnectorType":{
            "enum":[
                "table",
                "customsql"
            ]
        }
    },
    "required":[
        "databaseConnectorType"
    ]
}

Nested Schema : connectorUpdateDatabase-allOf[1]

Type: object

Show Source

• dbConnectorMetadata: object dbConnectorMetadata
  Database connector metadata model.

{
    "properties":{
        "dbConnectorMetadata":{
            "description":"The full table and call metadata.",
            "$ref":"#/definitions/dbConnectorMetadata"
        }
    }
}

Nested Schema : dbConnectorMetadata

Type: object

Database connector metadata model.

Show Source

• calls: array calls
  Minimum Number of Items: 0
• tableInfo: object tableInfo
  Database connector table/view metadata.

{
    "description":"Database connector metadata model.",
    "type":"object",
    "properties":{
        "calls":{
            "minItems":0,
            "uniqueItems":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "tableInfo":{
            "$ref":"#/definitions/tableInfo"
        }
    },
    "required":[
        "calls"
    ]
}

Nested Schema : calls

Type: array

Minimum Number of Items: 0

Show Source

• [0]: string

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

Nested Schema : tableInfo

Type: object

Database connector table/view metadata.

Show Source

• allColumns: array allColumns
  Minimum Number of Items: 0
• primaryKeys: array primaryKeys
  Minimum Number of Items: 0
• requiredColumns: array requiredColumns
  Minimum Number of Items: 0
• selectedColumns: array selectedColumns
  Minimum Number of Items: 0
• tableNameInfo: object tableNameInfo
  Database connector table/view name/type metadata.

{
    "description":"Database connector table/view metadata.",
    "type":"object",
    "properties":{
        "selectedColumns":{
            "minItems":0,
            "uniqueItems":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "primaryKeys":{
            "minItems":0,
            "uniqueItems":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "tableNameInfo":{
            "$ref":"#/definitions/tableNameInfo"
        },
        "requiredColumns":{
            "minItems":0,
            "uniqueItems":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "allColumns":{
            "minItems":0,
            "uniqueItems":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    },
    "required":[
        "selectedColumns",
        "primaryKeys",
        "tableNameInfo",
        "requiredColumns",
        "allColumns"
    ]
}

Nested Schema : allColumns

Type: array

Minimum Number of Items: 0

Show Source

• [0]: string

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

Nested Schema : primaryKeys

Type: array

Minimum Number of Items: 0

Show Source

• [0]: string

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

Nested Schema : requiredColumns

Type: array

Minimum Number of Items: 0

Show Source

• [0]: string

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

Nested Schema : selectedColumns

Type: array

Minimum Number of Items: 0

Show Source

• [0]: string

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

Nested Schema : tableNameInfo

Type: object

Database connector table/view name/type metadata.

Show Source

• databaseTableName: string
  The true name of the database table, which might not be a legal JSON name.
• tableName: string
  The name of the table in JSON or URL.
• tableType: string
  Indicates whether the table is a table, view, or synonym.

{
    "description":"Database connector table/view name/type metadata.",
    "type":"object",
    "properties":{
        "tableType":{
            "description":"Indicates whether the table is a table, view, or synonym.",
            "type":"string"
        },
        "databaseTableName":{
            "description":"The true name of the database table, which might not be a legal JSON name.",
            "type":"string"
        },
        "tableName":{
            "description":"The name of the table in JSON or URL.",
            "type":"string"
        }
    },
    "required":[
        "tableType",
        "databaseTableName",
        "tableName"
    ]
}

Nested Schema : connectorUpdateIcsRest-allOf[1]

Type: object

Show Source

• ics: object icsConnectionReference
  ICS configuration. This holds state about an ICS instance that should persist across connector sessions.
• integration: object integration
  ICS integration flow metadata.

{
    "properties":{
        "integration":{
            "$ref":"#/definitions/integration"
        },
        "ics":{
            "$ref":"#/definitions/icsConnectionReference"
        }
    }
}

Nested Schema : icsConnectionReference

Type: object

ICS configuration. This holds state about an ICS instance that should persist across connector sessions.

Show Source

• connectionName: string
  The name of this logical construct describing connectivity to a particular ICS instance.
• runtimeCsfKey: string
  The default CSF key entry to suggest using when reaching the ICS Security page (the one chosen/created last time).
• serviceURL: string
  The service URL to ICS (that is, `https:///ics`).

{
    "description":"ICS configuration. This holds state about an ICS instance that should persist across connector sessions.",
    "type":"object",
    "properties":{
        "runtimeCsfKey":{
            "description":"The default CSF key entry to suggest using when reaching the ICS Security page (the one chosen/created last time).",
            "type":"string"
        },
        "serviceURL":{
            "description":"The service URL to ICS (that is, `https://<host>/ics`).",
            "type":"string"
        },
        "connectionName":{
            "description":"The name of this logical construct describing connectivity to a particular ICS instance.",
            "type":"string"
        }
    },
    "required":[
        "serviceURL"
    ]
}

Nested Schema : integration

Type: object

ICS integration flow metadata.

Show Source

• builtBy: string
  The author of the integration.
• created: string
  When this integration was created.
• description: string
  The description of the ICS integration.
• icon: string
  URL of the icon for the target.
• integrationName: string
  The name of the ICS integration.
• remoteUrl: string
  The URL used to create the connector (remote URL or WSDL).
• securityPolicy: string
  The WSS security policy to use to talk to this endpoint. That is, `oracle/http_basic_auth_over_ssl_client_policy`. Note that this value isn't shown on the discovery page in the connector UI.
• targetService: string
  The type of system being exposed in ICS.
• technology:
  Allowed Values: [ "SOAP", "REST" ]
• updated: string
  When this integration was updated.
• version: string
  The version in ICS.

{
    "description":"ICS integration flow metadata.",
    "type":"object",
    "properties":{
        "builtBy":{
            "description":"The author of the integration.",
            "type":"string"
        },
        "targetService":{
            "description":"The type of system being exposed in ICS.",
            "type":"string"
        },
        "integrationName":{
            "description":"The name of the ICS integration.",
            "type":"string"
        },
        "created":{
            "description":"When this integration was created.",
            "type":"string"
        },
        "icon":{
            "description":"URL of the icon for the target.",
            "type":"string"
        },
        "description":{
            "description":"The description of the ICS integration.",
            "type":"string"
        },
        "remoteUrl":{
            "description":"The URL used to create the connector (remote URL or WSDL).",
            "type":"string"
        },
        "technology":{
            "enum":[
                "SOAP",
                "REST"
            ]
        },
        "securityPolicy":{
            "description":"The WSS security policy to use to talk to this endpoint. That is, `oracle/http_basic_auth_over_ssl_client_policy`. Note that this value isn't shown on the discovery page in the connector UI.",
            "type":"string"
        },
        "version":{
            "description":"The version in ICS.",
            "type":"string"
        },
        "updated":{
            "description":"When this integration was updated.",
            "type":"string"
        }
    },
    "required":[
        "integrationName"
    ]
}

Nested Schema : connectorUpdateIcsSoap-allOf[1]

Type: object

Show Source

• ics: object icsConnectionReference
  ICS configuration. This holds state about an ICS instance that should persist across connector sessions.
• integration: object integration
  ICS integration flow metadata.

{
    "properties":{
        "integration":{
            "$ref":"#/definitions/integration"
        },
        "ics":{
            "$ref":"#/definitions/icsConnectionReference"
        }
    }
}

Nested Schema : implDependency

Type: object

API implementation as a dependency.

Match All

Show Source

• object apiImplementationGet
  The API implementation service details.
• object assetQualifiers
  Asset type name and qualifiers.
• object implDependency-allOf[2]

{
    "allOf":[
        {
            "$ref":"#/definitions/apiImplementationGet"
        },
        {
            "$ref":"#/definitions/assetQualifiers"
        },
        {
            "properties":{
                "uses":{
                    "description":"APIs used by this implementation.",
                    "$ref":"#/definitions/assetShortQualifiedArray"
                },
                "api":{
                    "description":"Implemented API information.",
                    "$ref":"#/definitions/assetShortQualified"
                }
            }
        }
    ],
    "description":"API implementation as a dependency.",
    "type":"object"
}

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 : implDependency-allOf[2]

Type: object

Show Source

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

  Unique Items Required: true

  An array of qualified assets.

{
    "properties":{
        "uses":{
            "description":"APIs used by this implementation.",
            "$ref":"#/definitions/assetShortQualifiedArray"
        },
        "api":{
            "description":"Implemented API information.",
            "$ref":"#/definitions/assetShortQualified"
        }
    }
}

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

Nested Schema : mbeDependency

Type: object

Backend as a dependency.

Match All

Show Source

• object mobilebackendGet
  The backend representation for GET requests.
• object assetQualifiers
  Asset type name and qualifiers.
• object mbeDependency-allOf[2]

{
    "allOf":[
        {
            "$ref":"#/definitions/mobilebackendGet"
        },
        {
            "$ref":"#/definitions/assetQualifiers"
        },
        {
            "properties":{
                "roles":{
                    "description":"The list of roles used by this backend.",
                    "$ref":"#/definitions/roleArray"
                },
                "includes":{
                    "description":"The APIs included in this backend.",
                    "$ref":"#/definitions/assetShortQualifiedArray"
                }
            }
        }
    ],
    "description":"Backend as a dependency.",
    "type":"object"
}

Nested 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 : mbeDependency-allOf[2]

Type: object

Show Source

• includes: array assetShortQualifiedArray
  Minimum Number of Items: 0

  Unique Items Required: true

  An array of qualified assets.
• roles: array roleArray
  Minimum Number of Items: 0

  Unique Items Required: true

  An array of role elements.

{
    "properties":{
        "roles":{
            "description":"The list of roles used by this backend.",
            "$ref":"#/definitions/roleArray"
        },
        "includes":{
            "description":"The APIs included in this backend.",
            "$ref":"#/definitions/assetShortQualifiedArray"
        }
    }
}

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: 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: object assetShort
  Asset information (short form).
• targetBackendError: 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 : 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: 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: boolean
• inactive: boolean
• oauth: boolean
• roleAccess: object mobilebackendRoleAccess
  The backend's role-access details.

{
    "properties":{
        "inactive":{
            "type":"boolean"
        },
        "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"
    }
}

Nested Schema : localizedMessage

Type: object

Localized error message for generic purposes.

Show Source

• message: string
• messageId: string
• params: 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

• [0]: string

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

Nested Schema : packageDependency

Type: object

Package as a dependency.

Match All

Show Source

• object packageGet
  The package representation for GET requests.
• object assetQualifiers
  Asset type name and qualifiers.

{
    "allOf":[
        {
            "$ref":"#/definitions/packageGet"
        },
        {
            "$ref":"#/definitions/assetQualifiers"
        }
    ],
    "description":"Package as a dependency.",
    "type":"object"
}

Nested Schema : roleGet

Type: object

The role representation.

Match All

Show Source

• object assetGet
  The asset representation for GET requests.

{
    "allOf":[
        {
            "$ref":"#/definitions/assetGet"
        }
    ],
    "description":"The role representation.",
    "type":"object"
}

Nested Schema : unresolvedDependency

Type: object

Unresolved dependency for the custom API implementation.

Show Source

• name: string
  The name of the custom API or connector.
• version: string
  The version of the custom API or connector.

{
    "description":"Unresolved dependency for the custom API implementation.",
    "type":"object",
    "properties":{
        "name":{
            "description":"The name of the custom API or connector.",
            "type":"string"
        },
        "version":{
            "description":"The version of the custom API or connector.",
            "type":"string"
        }
    }
}

Nested Schema : checklistRecord

Type: object

An asset's checklist/import result.

Show Source

• assetId: string
• assetType:
  Allowed Values: [ "MobileBackend", "API", "APIImplementation", "Connector", "StorageCollection", "Role" ]
• messages: array localizedMessageArray
  Minimum Number of Items: 0

  An array of localized messages.
• resolvedTo: object assetShort
  Asset information (short form).
• resultCode:
  Allowed Values: [ "CREATED", "PICKED", "RESOLVED", "CONFLICTS", "SKIPPED", "PRIVILEGES" ]

{
    "description":"An asset's checklist/import result.",
    "type":"object",
    "properties":{
        "assetId":{
            "type":"string"
        },
        "resultCode":{
            "enum":[
                "CREATED",
                "PICKED",
                "RESOLVED",
                "CONFLICTS",
                "SKIPPED",
                "PRIVILEGES"
            ]
        },
        "messages":{
            "$ref":"#/definitions/localizedMessageArray"
        },
        "resolvedTo":{
            "$ref":"#/definitions/assetShort"
        },
        "assetType":{
            "enum":[
                "MobileBackend",
                "API",
                "APIImplementation",
                "Connector",
                "StorageCollection",
                "Role"
            ]
        }
    },
    "required":[
        "assetId",
        "resultCode",
        "assetType"
    ]
}

Nested Schema : localizedMessageArray

Type: array

Minimum Number of Items: 0

An array of localized messages.

Show Source

• [0]: object localizedMessage
  Localized error message for generic purposes.

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

Nested Schema : packageGet-allOf[1]

Type: object

Show Source

• documentation: boolean
• packageType:
  Allowed Values: [ "EXPORT", "IMPORT" ]
• systemVersion: string

{
    "properties":{
        "documentation":{
            "type":"boolean"
        },
        "packageType":{
            "enum":[
                "EXPORT",
                "IMPORT"
            ]
        },
        "systemVersion":{
            "type":"string"
        }
    }
}

Nested Schema : policy

Type: object

Policy object representation.

Show Source

• desc: string
• name: string
  Maximum Length: 506
• value: string

{
    "description":"Policy object representation.",
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "maxLength":506
        },
        "value":{
            "type":"string"
        },
        "desc":{
            "type":"string"
        }
    },
    "required":[
        "name",
        "value"
    ]
}

Nested Schema : validationResults

Type: array

Minimum Number of Items: 0

Show Source

• [0]: string

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

Examples

The following example shows how to install an imported package using cURL. Before you call this operation, you must first upload the package by sending a POST /mobile/tools/1.0/import/package/upload request. For more information about cURL, see Use cURL.

curl -i -X POST -d @body.json -H "Authorization: Bearer $TOKEN" -H "Content-Type: application/json" "$BASE_URL/mobile/tools/1.0/import/package/install"

Example of Request Body

You can use the artifact object from the response body for your POST /mobile/tools/1.0/import/package/upload request to form the request body, as shown here.

{  
   "artifact":{  
      "name":"package-mcs_examples_sync_salesplus.zip",
      "id":"04c56716-ab47-4ad0-997d-541d904f99ef",
      "properties":{  
         "is.package":"true"
      },
      "downloadLink":"/mobile/tools/1.0/artifacts/04c56716-ab47-4ad0-997d-541d904f99ef"
   }
}

Example of Response Header

The following shows an example of the response headers:

200 OK
Date: Wed, 28 Jun 2017 20:00:11 GMT
Content-length: 4413
Content-type: application/json

Example of Response Body

The following example shows the contents of the response body in JSON format:

{
    "policies": [
        {
            "name": "*.custom/mcs_examples_sync_salesplus(1.0).Routing_BindApiToImpl",
            "value": "mcs_examples_sync_salesplus(1.0.0)",
            "desc": null
        }
    ],
    "importResults": {
        "records": [
            {
                "assetId": "284efd91-e0bd-4459-be6c-e57618b649a4",
                "assetType": "MobileBackend",
                "resultCode": "CREATED",
                "resolvedTo": null,
                "messages": []
            },
            {
                "assetId": "b5684f31-3984-46dc-8e6f-68712d63c224",
                "assetType": "APIImplementation",
                "resultCode": "CREATED",
                "resolvedTo": null,
                "messages": []
            },
            {
                "assetId": "d406905a-b2b1-4b9e-a220-5b0b8a49ed39",
                "assetType": "API",
                "resultCode": "CREATED",
                "resolvedTo": null,
                "messages": []
            }
        ],
        "dependencies": {
            "mobilebackends": [
                {
                    "id": "284efd91-e0bd-4459-be6c-e57618b649a4",
                    "name": "mcs_examples_sync_salesplus",
                    "version": "1.0",
                    "qualifier": "self",
                    "desc": "MBE for the SalesPlus app which demonstrates several of the MCS Sync Client SDK features.",
                    "links": [],
                    "published": false,
                    "inTrash": false,
                    "actionComment": null,
                    "etag": "0",
                    "createdOn": "2016-09-13T03:20:24.878Z",
                    "modifiedOn": "2016-09-15T04:15:14.724Z",
                    "modifiedBy": "jdoe",
                    "deletedOn": null,
                    "deletedBy": null,
                    "clientId": null,
                    "clientSecret": null,
                    "basicAuthBackendId": null,
                    "oauth": true,
                    "basicAuth": true,
                    "inactive": false,
                    "roleAccess": {
                        "enabled": false,
                        "roles": []
                    },
                    "includes": [],
                    "roles": []
                }
            ],
            "apis": [
                {
                    "id": "d406905a-b2b1-4b9e-a220-5b0b8a49ed39",
                    "namespace": "custom",
                    "name": "mcs_examples_sync_salesplus",
                    "version": "1.0",
                    "desc": "Supports the SalesPlus app which demonstrates several of the MCS Sync Client SDK features.",
                    "links": [],
                    "published": false,
                    "inTrash": false,
                    "actionComment": null,
                    "etag": "0",
                    "createdOn": "2016-09-13T03:08:21.030Z",
                    "modifiedOn": "2016-12-21T16:52:17.155Z",
                    "modifiedBy": "jdoe",
                    "deletedOn": null,
                    "deletedBy": null,
                    "title": "REST API for the SalesPlus App",
                    "basePath": "/mobile/custom/mcs_examples_sync_salesplus",
                    "icon": null,
                    "category": "CUSTOM",
                    "hasBusinessObjects": false,
                    "mock": null,
                    "implementations": [
                        {
                            "id": "b5684f31-3984-46dc-8e6f-68712d63c224",
                            "name": "mcs_examples_sync_salesplus",
                            "version": "1.0.0",
                            "type": "APIImplementation"
                        }
                    ],
                    "implementation": {
                        "id": "b5684f31-3984-46dc-8e6f-68712d63c224",
                        "name": "mcs_examples_sync_salesplus",
                        "version": "1.0.0"
                    },
                    "roles": []
                }
            ],
            "implementations": [
                {
                    "id": "b5684f31-3984-46dc-8e6f-68712d63c224",
                    "name": "mcs_examples_sync_salesplus",
                    "version": "1.0.0",
                    "desc": "Custom API for MCS SalesPlus example app",
                    "links": [],
                    "published": false,
                    "inTrash": false,
                    "actionComment": null,
                    "etag": "0",
                    "createdOn": "2016-09-15T04:05:33.880Z",
                    "modifiedOn": "2016-12-21T17:16:25.640Z",
                    "modifiedBy": "jdoe",
                    "deletedOn": null,
                    "deletedBy": null,
                    "artifacts": [
                        {
                            "name": "impl 2.zip",
                            "id": "dd6430a5-e4ed-458d-a008-2eeae28864a6",
                            "properties": {
                                "customcode.api.implementation.artifact": "true"
                            },
                            "downloadLink": null
                        }
                    ],
                    "api": null,
                    "uses": []
                }
            ],
            "connectors": [],
            "collections": [],
            "unresolvedDependencies": [],
            "roles": [],
            "packages": [],
            "clients": []
        }
    },
    "status": "SUCCESS",
    "policyValidationReport": {
        "valid": true,
        "validationResults": [
            {
                "message": "We successfully uploaded the policies properties file but it failed the validation check. The format error could be due to a corrupted header or the policies file could've been generated from an earlier version of MCS. Ask your mobile cloud administrator to export the policies file from the Administration tab so you can check the file and verify its contents.",
                "messageId": "MOBILE-58176",
                "level": "WARNING"
            }
        ]
    },
    "package": {
        "id": "25f48bf7-bcc2-4e28-aeac-28069323d96e",
        "name": "mcs_examples_sync_salesplus",
        "version": "16.4.5",
        "desc": null,
        "links": [],
        "published": false,
        "inTrash": false,
        "actionComment": null,
        "etag": "0",
        "createdOn": "2017-07-07T01:06:06.221Z",
        "modifiedOn": "2017-07-07T01:06:06.221Z",
        "modifiedBy": "uimcs",
        "deletedOn": null,
        "deletedBy": null,
        "packageType": "IMPORT",
        "documentation": "MBE and REST API for the SalesPlus app in the SDK's examples.zip. SalesPlus is a mobile app that displays and maintains contacts. It also displays reminders. You can use this app both online and offline. If you make changes to your contact info while you're offline, the app syncs with the server automatically when your device goes online. \nThis mobile app demonstrates several of the MCS Sync Client SDK features. It also provides end-to-end example code for building a mobile app that continues to work when the device is offline, including code that detects and handles conflicts between changes on the server and changes made in an offline device.",
        "systemVersion": "16.4.5-201611092203",
        "formatVersion": 0
    }
}