REST API Reference for Oracle Mobile Cloud Enterprise - Tooling APIs

Upload Package

post

/mobile/tools/1.0/import/package/upload

Uploads a package file. After the upload completes successfully, use the POST /moble/tools/1.0/import/package/install operation to install the package.

Request

Supported Media Types

multipart/form-data

Form Parameters

file: Type: file

Required: true

The package file to upload.

Response

Supported Media Types

application/json

200 Response

The package file was uploaded, and the package details were returned in the response, including the artifact ID, which you use to identify the package when you install it.

Body

Package upload request.

Root Schema : packageUpload

Type: object

Package upload request.

Match All

Type: object packageImport

Additional Properties Allowed:

Information about the package that was uploaded or installed.
Type: object artifact

Additional Properties Allowed:

The artifact information.

Nested Schema : packageImport

Type: object

Information about the package that was uploaded or installed.

Properties

importResults: Type: object importReport

Additional Properties Allowed:

Import results.
package: Type: object packageGet

Required: true

Additional Properties Allowed:

The package representation for GET requests.
policies: Type: array policyArray

Additional Properties Allowed:

Minimum Number of Items: 0

Unique Items Required: true

An array of policy elements.
policyValidationReport: Type: object policyValidationReport

Additional Properties Allowed:

The result of validation of the properties file with policies.
status: Allowed Values: [ "SUCCESS", "FAILURE" ]

Nested Schema : artifact

Type: object

The artifact information.

Properties

downloadLink: Type: string

The link to download the artifact.
id: Type: string

Required: true

The artifact's ID.
name: Type: string

Required: true

Maximum Length: 255

The name of the artifact.
properties: Type: object properties

Additional Properties Allowed: { "type":"string" }

Nested Schema : importReport

Type: object

Import results.

Properties

dependencies: Type: object dependencies

Additional Properties Allowed:

Information about the asset and its dependencies.
records: Type: array checklistRecordArray

Required: true

Additional Properties Allowed:

Minimum Number of Items: 0

Unique Items Required: true

An array of checklist report records.

Nested Schema : packageGet

Type: object

The package representation for GET requests.

Match All

Type: object assetGet

Additional Properties Allowed:

The asset representation for GET requests.
Type: object packageGet-allOf[1]

Additional Properties Allowed:

Nested Schema : policyArray

Type: array

Minimum Number of Items: 0

Unique Items Required: true

An array of policy elements.

Items

Type: object policy

Additional Properties Allowed:

Policy object representation.

Nested Schema : policyValidationReport

Type: object

The result of validation of the properties file with policies.

Properties

valid: Type: boolean

Required: true
validationResults: Type: array validationResults

Additional Properties Allowed:

Minimum Number of Items: 0

Nested Schema : dependencies

Type: object

Information about the asset and its dependencies.

Properties

apis: Type: array apiDependencyArray

Additional Properties Allowed:

Minimum Number of Items: 0

Unique Items Required: true

An array of APIs as dependencies.
collections: Type: array collectionDependencyArray

Additional Properties Allowed:

Minimum Number of Items: 0

Unique Items Required: true

An array of storage collections as dependencies.
connectors: Type: array connectorDependencyArray

Additional Properties Allowed:

Minimum Number of Items: 0

Unique Items Required: true

An array of connectors as dependencies.
implementations: Type: array implDependencyArray

Additional Properties Allowed:

Minimum Number of Items: 0

Unique Items Required: true

An array of API implementations as dependencies.
mobilebackends: Type: array mbeDependencyArray

Additional Properties Allowed:

Minimum Number of Items: 0

Unique Items Required: true

An array of backends as dependencies.
packages: Type: array packageDependencyArray

Additional Properties Allowed:

Minimum Number of Items: 0

Unique Items Required: true

An array of packages as dependencies.
roles: Type: array roleArray

Additional Properties Allowed:

Minimum Number of Items: 0

Unique Items Required: true

An array of role elements.
unresolvedDependencies: Type: array unresolvedDependencyArray

Additional Properties Allowed:

Minimum Number of Items: 0

Unique Items Required: true

An array of unresolved dependencies for a custom API implementation.

Nested Schema : checklistRecordArray

Type: array

Minimum Number of Items: 0

Unique Items Required: true

An array of checklist report records.

Items

Type: object checklistRecord

Additional Properties Allowed:

An asset's checklist/import result.

Nested Schema : apiDependencyArray

Type: array

Minimum Number of Items: 0

Unique Items Required: true

An array of APIs as dependencies.

Items

Type: object apiDependency

Additional Properties Allowed:

API as a dependency.

Nested Schema : collectionDependencyArray

Type: array

Minimum Number of Items: 0

Unique Items Required: true

An array of storage collections as dependencies.

Items

Type: object collectionDependency

Additional Properties Allowed:

Storage collection as a dependency.

Nested Schema : connectorDependencyArray

Type: array

Minimum Number of Items: 0

Unique Items Required: true

An array of connectors as dependencies.

Items

Type: object connectorDependency

Additional Properties Allowed:

Connector as a dependency.

Nested Schema : implDependencyArray

Type: array

Minimum Number of Items: 0

Unique Items Required: true

An array of API implementations as dependencies.

Items

Type: object implDependency

Additional Properties Allowed:

API implementation as a dependency.

Nested Schema : mbeDependencyArray

Type: array

Minimum Number of Items: 0

Unique Items Required: true

An array of backends as dependencies.

Items

Type: object mbeDependency

Additional Properties Allowed:

Backend as a dependency.

Nested Schema : packageDependencyArray

Type: array

Minimum Number of Items: 0

Unique Items Required: true

An array of packages as dependencies.

Items

Type: object packageDependency

Additional Properties Allowed:

Package as a dependency.

Nested Schema : roleArray

Type: array

Minimum Number of Items: 0

Unique Items Required: true

An array of role elements.

Items

Type: object roleGet

Additional Properties Allowed:

The role representation.

Nested Schema : unresolvedDependencyArray

Type: array

Minimum Number of Items: 0

Unique Items Required: true

An array of unresolved dependencies for a custom API implementation.

Items

Type: object unresolvedDependency

Additional Properties Allowed:

Unresolved dependency for the custom API implementation.

Nested Schema : apiDependency

Type: object

API as a dependency.

Match All

Type: object apiShort

Additional Properties Allowed:

The short API definition representation.
Type: object apiDependency-allOf[1]

Additional Properties Allowed:

Nested Schema : apiShort

Type: object

The short API definition representation.

Match All

Type: object assetGet

Additional Properties Allowed:

The asset representation for GET requests.
Type: object apiShort-allOf[1]

Additional Properties Allowed:

Nested Schema : apiDependency-allOf[1]

Properties

implementation: Type: object assetShort

Additional Properties Allowed:

Asset information (short form).
implementations: Type: array assetShortQualifiedArray

Additional Properties Allowed:

Minimum Number of Items: 0

Unique Items Required: true

An array of qualified assets.
mock: Type: 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: Type: array roleArray

Additional Properties Allowed:

Minimum Number of Items: 0

Unique Items Required: true

An array of role elements.

Nested Schema : assetGet

Type: object

The asset representation for GET requests.

Match All

Type: object assetUpdate

Additional Properties Allowed:

The asset representation for PUT requests.
Type: object assetIdEtag

Additional Properties Allowed:

The asset ID and entity tag (ETag) values.
Type: object trash

Additional Properties Allowed:

Indicator of whether the asset is in the trash.
Type: object assetGet-allOf[3]

Additional Properties Allowed:

Nested Schema : apiShort-allOf[1]

Properties

basePath: Type: string

The API base path in the format `/mobile/custom/{apiName}`.
hasBusinessObjects: Type: boolean

Default Value: false

Indicates whether the API is associated with API Express resources (business objects).
icon: Type: object icon

Additional Properties Allowed:

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

Nested Schema : assetUpdate

Type: object

The asset representation for PUT requests.

Properties

actionComment: Type: string
desc: Type: string

Maximum Length: 100
max: Type: boolean

Default Value: false
name: Type: string

Required: true

Maximum Length: 100

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

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

Maximum Length: 255
version: Type: string

Maximum Length: 100

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

Asset version.

Nested Schema : assetIdEtag

Type: object

The asset ID and entity tag (ETag) values.

Properties

etag: Type: string

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

Required: true

Nested Schema : trash

Type: object

Indicator of whether the asset is in the trash.

Properties

inTrash: Type: boolean

Nested Schema : assetGet-allOf[3]

Properties

createdOn: Type: string
deletedBy: Type: string
deletedOn: Type: string
links: Type: array entityLinksArray

Additional Properties Allowed:

Minimum Number of Items: 0

An array of links for an entity's metadata.
modifiedBy: Type: string
modifiedOn: Type: string
published: Type: boolean

An asset draft or published status representation.

Nested Schema : entityLinksArray

Type: array

Minimum Number of Items: 0

An array of links for an entity's metadata.

Items

Type: object items

Additional Properties Allowed:

Link to the entity's metadata.

Nested Schema : items

Type: object

Link to the entity's metadata.

Properties

href: Type: string

Required: true

Link value.
rel: Required: true

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

Link type.

Nested Schema : icon

Type: object

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

Properties

id: Type: string

Required: true
url: Type: string

Required: true

Nested Schema : assetShort

Type: object

Asset information (short form).

Properties

id: Type: string

Asset identifier.
name: Type: string

Asset name.
namespace: Type: string

Asset namespace.
version: Type: string

Maximum Length: 100

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

Asset version.

Nested Schema : assetShortQualifiedArray

Type: array

Minimum Number of Items: 0

Unique Items Required: true

An array of qualified assets.

Items

Type: object assetShortQualified

Additional Properties Allowed:

An asset's information in qualified short form, which includes type and qualifiers.

Nested Schema : assetShortQualified

Type: object

An asset's information in qualified short form, which includes type and qualifiers.

Match All

Type: object assetShort

Additional Properties Allowed:

Asset information (short form).
Type: object assetQualifiers

Additional Properties Allowed:

Asset type name and qualifiers.

Nested Schema : assetQualifiers

Type: object

Asset type name and qualifiers.

Properties

qualifier: Type: string

The asset qualifier. It may contain multiple values separated by commas (`,`).
type: Allowed Values: [ "MobileBackend", "API", "APIImplementation", "Connector", "StorageCollection", "Role" ]

Nested Schema : collectionDependency

Type: object

Storage collection as a dependency.

Match All

Type: object mosCollectionGet

Additional Properties Allowed:

The storage collection representation for GET requests.
Type: object assetQualifiers

Additional Properties Allowed:

Asset type name and qualifiers.
Type: object collectionDependency-allOf[2]

Additional Properties Allowed:

Nested Schema : mosCollectionGet

Type: object

The storage collection representation for GET requests.

Match All

Type: object assetGet

Additional Properties Allowed:

The asset representation for GET requests.
Type: object mosCollectionGet-allOf[1]

Additional Properties Allowed:

Nested Schema : collectionDependency-allOf[2]

Properties

roles: Type: array roleArray

Additional Properties Allowed:

Minimum Number of Items: 0

Unique Items Required: true

An array of role elements.

Nested Schema : mosCollectionGet-allOf[1]

Properties

guid: Type: string
syncControl: Type: boolean
userIsolated: Type: boolean

Nested Schema : connectorDependency

Type: object

Connector as a dependency.

Match All

Type: object connectorGet

Additional Properties Allowed:

The connector representation for GET requests.
Type: object assetQualifiers

Additional Properties Allowed:

Asset type name and qualifiers.
Type: object connectorDependency-allOf[2]

Additional Properties Allowed:

Nested Schema : connectorGet

Type: object

The connector representation for GET requests.

Match All

Type: object connectorShort

Additional Properties Allowed:

The short connector definition representation.
Type: connectorGet-allOf[1]

Additional Properties Allowed:

Nested Schema : connectorDependency-allOf[2]

Properties

implementation: Type: object assetShort

Additional Properties Allowed:

Asset information (short form).

Nested Schema : connectorShort

Type: object

The short connector definition representation.

Match All

Type: object assetGet

Additional Properties Allowed:

The asset representation for GET requests.
Type: object connectorBase

Additional Properties Allowed:

Base connector properties.

Nested Schema : connectorGet-allOf[1]

Match One

Type: object connectorGetRest

Additional Properties Allowed:

REST connector get payload.
Type: object connectorUpdateSoap

Additional Properties Allowed:

SOAP connector update payload.
Type: object connectorUpdateDatabase

Additional Properties Allowed:

MOB DB connector update payload.
Type: object connectorUpdateIcsRest

Additional Properties Allowed:

ICS REST connector update payload.
Type: object connectorUpdateIcsSoap

Additional Properties Allowed:

ICS SOAP connector update payload.

Nested Schema : connectorBase

Type: object

Base connector properties.

Properties

basePath: Type: string

The connector API base path in the format `/mobile/connector/{name}/{path}`.
connectorType: Allowed Values: [ "REST", "SOAP", "DATABASE", "ICS", "FA" ]
icon: Type: object icon

Additional Properties Allowed:

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

Nested Schema : connectorGetRest

Type: object

REST connector get payload.

Match All

Type: object connectorUpdateRest

Additional Properties Allowed:

REST connector update payload.
Type: object connectorGetRest-allOf[1]

Additional Properties Allowed:

Nested Schema : connectorUpdateSoap

Type: object

SOAP connector update payload.

Match All

Type: object connectorCreateSoap

Additional Properties Allowed:

SOAP connector creation payload.
Type: object connectorUpdateSoap-allOf[1]

Additional Properties Allowed:

Nested Schema : connectorUpdateDatabase

Type: object

MOB DB connector update payload.

Match All

Type: object connectorCreateDatabase

Additional Properties Allowed:

REST connector creation payload.
Type: object connectorUpdateDatabase-allOf[1]

Additional Properties Allowed:

Nested Schema : connectorUpdateIcsRest

Type: object

ICS REST connector update payload.

Match All

Type: object connectorUpdateRest

Additional Properties Allowed:

REST connector update payload.
Type: object connectorUpdateIcsRest-allOf[1]

Additional Properties Allowed:

Nested Schema : connectorUpdateIcsSoap

Type: object

ICS SOAP connector update payload.

Match All

Type: object connectorUpdateSoap

Additional Properties Allowed:

SOAP connector update payload.
Type: object connectorUpdateIcsSoap-allOf[1]

Additional Properties Allowed:

Nested Schema : connectorUpdateRest

Type: object

REST connector update payload.

Properties

httpConnectionTimeout: Type: integer (int64)
httpReadTimeout: Type: integer (int64)
remoteURL: Type: string

Required: true
rules: Type: array restRuleArray

Additional Properties Allowed:

Minimum Number of Items: 0

An array of REST rules.
securityPolicies: Type: array securityPolicyArray

Additional Properties Allowed:

Minimum Number of Items: 0

An array of security policy elements.
workAreaTag: Type: string

Nested Schema : connectorGetRest-allOf[1]

Properties

descriptorInfo: Type: object connectorDescriptorInfo

Additional Properties Allowed:

Connector descriptor information.

Nested Schema : restRuleArray

Type: array

Minimum Number of Items: 0

An array of REST rules.

Items

Type: object restRule

Additional Properties Allowed:

REST connector rule definition.

Nested Schema : securityPolicyArray

Type: array

Minimum Number of Items: 0

An array of security policy elements.

Items

Type: object securityPolicy

Additional Properties Allowed:

Connector OWSM security policy.

Nested Schema : restRule

Type: object

REST connector rule definition.

Properties

defaultParameters: Type: array defaultParameters

Additional Properties Allowed:

Minimum Number of Items: 0

Unique Items Required: true
methods: Type: array methods

Additional Properties Allowed:

Minimum Number of Items: 0

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

Nested Schema : defaultParameters

Type: array

Minimum Number of Items: 0

Unique Items Required: true

Items

Type: object restParameter

Additional Properties Allowed:

REST connector rule default parameter.

Nested Schema : methods

Type: array

Minimum Number of Items: 0

Unique Items Required: true

Items

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

Nested Schema : restParameter

Type: object

REST connector rule default parameter.

Properties

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

Nested Schema : securityPolicy

Type: object

Connector OWSM security policy.

Properties

name: Type: string

Required: true
overrides: Type: array securityPolicyOverrideArray

Additional Properties Allowed:

Minimum Number of Items: 0

An array of security-policy override elements.

Nested Schema : securityPolicyOverrideArray

Type: array

Minimum Number of Items: 0

An array of security-policy override elements.

Items

Type: object securityPolicyOverride

Additional Properties Allowed:

Security policy override property.

Nested Schema : securityPolicyOverride

Type: object

Security policy override property.

Properties

propertyName: Type: string

Required: true
value: Type: string

Required: true

Nested Schema : connectorDescriptorInfo

Type: object

Connector descriptor information.

Properties

descriptorLocation: Type: string
descriptorSource: Required: true

Allowed Values: [ "URL", "FILE", "NONE" ]
designTimeUserName: Type: string
isDesignTimePasswordSaved: Type: boolean

Nested Schema : connectorCreateSoap

Type: object

SOAP connector creation payload.

Properties

wsdl: Type: string

Required: true

Nested Schema : connectorUpdateSoap-allOf[1]

Properties

httpConnectionTimeout: Type: integer (int64)
httpReadTimeout: Type: integer (int64)
operations: Type: array operations

Additional Properties Allowed:
securityPolicies: Type: array securityPolicyArray

Additional Properties Allowed:

Minimum Number of Items: 0

An array of security policy elements.
svcEndpoint: Type: string

Required: true
svcName: Type: string

Required: true
svcPort: Type: string

Required: true

Nested Schema : operations

Type: array

Items

Type: object items

Additional Properties Allowed:

Nested Schema : items

Type: object

Properties

custom: Type: string

The custom name for the operation.
name: Type: string

Required: true
uri: Type: string

Required: true

The URI for the SOAPAction HTTP request header.

Nested Schema : connectorCreateDatabase

Type: object

REST connector creation payload.

Properties

databaseConnectorType: Required: true

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

Nested Schema : connectorUpdateDatabase-allOf[1]

Properties

dbConnectorMetadata: Type: object dbConnectorMetadata

Additional Properties Allowed:

Database connector metadata model.

Nested Schema : dbConnectorMetadata

Type: object

Database connector metadata model.

Properties

calls: Type: array calls

Required: true

Additional Properties Allowed:

Minimum Number of Items: 0
tableInfo: Type: object tableInfo

Additional Properties Allowed:

Database connector table/view metadata.

Nested Schema : calls

Type: array

Minimum Number of Items: 0

Items

Type: string

Nested Schema : tableInfo

Type: object

Database connector table/view metadata.

Properties

allColumns: Type: array allColumns

Required: true

Additional Properties Allowed:

Minimum Number of Items: 0
primaryKeys: Type: array primaryKeys

Required: true

Additional Properties Allowed:

Minimum Number of Items: 0
requiredColumns: Type: array requiredColumns

Required: true

Additional Properties Allowed:

Minimum Number of Items: 0
selectedColumns: Type: array selectedColumns

Required: true

Additional Properties Allowed:

Minimum Number of Items: 0
tableNameInfo: Type: object tableNameInfo

Required: true

Additional Properties Allowed:

Database connector table/view name/type metadata.

Nested Schema : allColumns

Type: array

Minimum Number of Items: 0

Items

Type: string

Nested Schema : primaryKeys

Type: array

Minimum Number of Items: 0

Items

Type: string

Nested Schema : requiredColumns

Type: array

Minimum Number of Items: 0

Items

Type: string

Nested Schema : selectedColumns

Type: array

Minimum Number of Items: 0

Items

Type: string

Nested Schema : tableNameInfo

Type: object

Database connector table/view name/type metadata.

Properties

databaseTableName: Type: string

Required: true

The true name of the database table, which might not be a legal JSON name.
tableName: Type: string

Required: true

The name of the table in JSON or URL.
tableType: Type: string

Required: true

Indicates whether the table is a table, view, or synonym.

Nested Schema : connectorUpdateIcsRest-allOf[1]

Properties

ics: Type: object icsConnectionReference

Additional Properties Allowed:

ICS configuration. This holds state about an ICS instance that should persist across connector sessions.
integration: Type: object integration

Additional Properties Allowed:

ICS integration flow metadata.

Nested Schema : icsConnectionReference

Type: object

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

Properties

connectionName: Type: string

The name of this logical construct describing connectivity to a particular ICS instance.
runtimeCsfKey: Type: string

The default CSF key entry to suggest using when reaching the ICS Security page (the one chosen/created last time).
serviceURL: Type: string

Required: true

The service URL to ICS (that is, `https:///ics`).

Nested Schema : integration

Type: object

ICS integration flow metadata.

Properties

builtBy: Type: string

The author of the integration.
created: Type: string

When this integration was created.
description: Type: string

The description of the ICS integration.
icon: Type: string

URL of the icon for the target.
integrationName: Type: string

Required: true

The name of the ICS integration.
remoteUrl: Type: string

The URL used to create the connector (remote URL or WSDL).
securityPolicy: Type: 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: Type: string

The type of system being exposed in ICS.
technology: Allowed Values: [ "SOAP", "REST" ]
updated: Type: string

When this integration was updated.
version: Type: string

The version in ICS.

Nested Schema : connectorUpdateIcsSoap-allOf[1]

Properties

ics: Type: object icsConnectionReference

Additional Properties Allowed:

ICS configuration. This holds state about an ICS instance that should persist across connector sessions.
integration: Type: object integration

Additional Properties Allowed:

ICS integration flow metadata.

Nested Schema : implDependency

Type: object

API implementation as a dependency.

Match All

Type: object apiImplementationGet

Additional Properties Allowed:

The API implementation service details.
Type: object assetQualifiers

Additional Properties Allowed:

Asset type name and qualifiers.
Type: object implDependency-allOf[2]

Additional Properties Allowed:

Nested Schema : apiImplementationGet

Type: object

The API implementation service details.

Match All

Type: object assetGet

Additional Properties Allowed:

The asset representation for GET requests.
Type: object apiImplementationGet-allOf[1]

Additional Properties Allowed:

Nested Schema : implDependency-allOf[2]

Properties

api: Type: object assetShortQualified

Additional Properties Allowed:

An asset's information in qualified short form, which includes type and qualifiers.
uses: Type: array assetShortQualifiedArray

Additional Properties Allowed:

Minimum Number of Items: 0

Unique Items Required: true

An array of qualified assets.

Nested Schema : apiImplementationGet-allOf[1]

Properties

api: Type: object assetShortQualified

Additional Properties Allowed:

An asset's information in qualified short form, which includes type and qualifiers.
artifacts: Type: array artifactArray

Additional Properties Allowed:

Minimum Number of Items: 0

An array of artifact information.

Nested Schema : artifactArray

Type: array

Minimum Number of Items: 0

An array of artifact information.

Items

Type: object artifact

Additional Properties Allowed:

The artifact information.

Nested Schema : mbeDependency

Type: object

Backend as a dependency.

Match All

Type: object mobilebackendGet

Additional Properties Allowed:

The backend representation for GET requests.
Type: object assetQualifiers

Additional Properties Allowed:

Asset type name and qualifiers.
Type: object mbeDependency-allOf[2]

Additional Properties Allowed:

Nested Schema : mobilebackendGet

Type: object

The backend representation for GET requests.

Match All

Type: object mobilebackendShortGet

Additional Properties Allowed:

The backend representation for GET requests.
Type: object mobilebackendGet-allOf[1]

Additional Properties Allowed:

Nested Schema : mbeDependency-allOf[2]

Properties

includes: Type: array assetShortQualifiedArray

Additional Properties Allowed:

Minimum Number of Items: 0

Unique Items Required: true

An array of qualified assets.
roles: Type: array roleArray

Additional Properties Allowed:

Minimum Number of Items: 0

Unique Items Required: true

An array of role elements.

Nested Schema : mobilebackendShortGet

Type: object

The backend representation for GET requests.

Match All

Type: object assetGet

Additional Properties Allowed:

The asset representation for GET requests.
Type: object mobilebackendOAuthKeys

Additional Properties Allowed:

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

Additional Properties Allowed:

The mobile backend ID that's required for backend access when you use Basic access authorization.
Type: object mobilebackendShortGet-allOf[3]

Additional Properties Allowed:

Nested Schema : mobilebackendGet-allOf[1]

Properties

analyticsAppGuid: Type: string

Analytics application ID resolved from the policy. If a new analytics application creation was requested on the backend creation and this attribute is null, then the application wasn't created. In this case you can check if it already exists, retry, or create one with another name and/or timezone, and then link it to the backend.
targetBackend: Type: object assetShort

Additional Properties Allowed:

Asset information (short form).
targetBackendError: Type: object localizedMessage

Additional Properties Allowed:

Localized error message for generic purposes.

Nested Schema : mobilebackendOAuthKeys

Type: object

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

Properties

clientID: Type: string

Required: true
clientSecret: Type: string

Required: true
sso: Type: boolean

Nested Schema : mobilebackendBasicAuthKeys

Type: object

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

Properties

basicAuthBackendId: Type: string

Required: true

Nested Schema : mobilebackendShortGet-allOf[3]

Properties

basic: Type: boolean
inactive: Type: boolean
oauth: Type: boolean
roleAccess: Type: object mobilebackendRoleAccess

Additional Properties Allowed:

The backend's role-access details.

Nested Schema : mobilebackendRoleAccess

Type: object

The backend's role-access details.

Properties

enabled: Type: boolean
roles: Type: array stringArray

Additional Properties Allowed:

Minimum Number of Items: 0

An array of string values.

Nested Schema : stringArray

Type: array

Minimum Number of Items: 0

An array of string values.

Items

Type: string

Nested Schema : localizedMessage

Type: object

Localized error message for generic purposes.

Properties

message: Type: string

Required: true
messageId: Type: string
params: Type: array params

Additional Properties Allowed:

Minimum Number of Items: 0

Nested Schema : params

Type: array

Minimum Number of Items: 0

Items

Type: string

Nested Schema : packageDependency

Type: object

Package as a dependency.

Match All

Type: object packageGet

Additional Properties Allowed:

The package representation for GET requests.
Type: object assetQualifiers

Additional Properties Allowed:

Asset type name and qualifiers.

Nested Schema : roleGet

Type: object

The role representation.

Match All

Type: object assetGet

Additional Properties Allowed:

The asset representation for GET requests.

Nested Schema : unresolvedDependency

Type: object

Unresolved dependency for the custom API implementation.

Properties

name: Type: string

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

The version of the custom API or connector.

Nested Schema : checklistRecord

Type: object

An asset's checklist/import result.

Properties

assetId: Type: string

Required: true
assetType: Required: true

Allowed Values: [ "MobileBackend", "API", "APIImplementation", "Connector", "StorageCollection", "Role" ]
messages: Type: array localizedMessageArray

Additional Properties Allowed:

Minimum Number of Items: 0

An array of localized messages.
resolvedTo: Type: object assetShort

Additional Properties Allowed:

Asset information (short form).
resultCode: Required: true

Allowed Values: [ "CREATED", "PICKED", "RESOLVED", "CONFLICTS", "SKIPPED", "PRIVILEGES" ]

Nested Schema : localizedMessageArray

Type: array

Minimum Number of Items: 0

An array of localized messages.

Items

Type: object localizedMessage

Additional Properties Allowed:

Localized error message for generic purposes.

Nested Schema : packageGet-allOf[1]

Properties

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

Nested Schema : policy

Type: object

Policy object representation.

Properties

desc: Type: string
name: Type: string

Required: true

Maximum Length: 506
value: Type: string

Required: true

Nested Schema : validationResults

Type: array

Minimum Number of Items: 0

Items

Type: string

Nested Schema : properties

Type: object

Additional Properties Allowed

Type: string

Examples

The following example shows how to use cURL to upload a package that you had exported. After you upload the package, use the POST /mobile/tools/1.0/import/package/install operation to install it. For more information about cURL, see Use cURL.

curl -i -X POST --form file=@package-mcs_examples_sync_salesplus.zip -H "Authorization: Bearer $TOKEN" "$BASE_URL/mobile/tools/1.0/import/package/upload"

Example of Response Header

The following shows an example of the response headers:

200 OK
Content-Length: 5122
Content-Type: application/json
Date: Wed, 28 Jun 2017 20:00:11 GMT

Example of Response Body

The following example shows the contents of the response body in JSON format. Note that you can use the artifact JSON object in the request body for the install operation.

{
    "policies": null,
    "importResults": {
        "records": [
            {
                "assetId": "fd11a5739507b3bb2a371b45b0eda6c7",
                "assetType": "Role",
                "resultCode": "CREATED",
                "resolvedTo": null,
                "messages": []
            },
            {
                "assetId": "d66b5c81-2531-46c8-bda7-f4cc8e83ce2e",
                "assetType": "APIImplementation",
                "resultCode": "CREATED",
                "resolvedTo": null,
                "messages": []
            },
            {
                "assetId": "fd42ebc04bff72fdd9adf34fd3732c12",
                "assetType": "Role",
                "resultCode": "CREATED",
                "resolvedTo": null,
                "messages": []
            },
            {
                "assetId": "4c5cc3c5-c3e4-47f9-a87a-f7b88aa2e7c7",
                "assetType": "StorageCollection",
                "resultCode": "CREATED",
                "resolvedTo": null,
                "messages": []
            },
            {
                "assetId": "9a8d49ad-fa9b-43b7-88a0-1dd401039e47",
                "assetType": "API",
                "resultCode": "CREATED",
                "resolvedTo": null,
                "messages": []
            },
            {
                "assetId": "7cc615fa-bc6e-4e0f-a599-73c264d5249a",
                "assetType": "MobileBackend",
                "resultCode": "CREATED",
                "resolvedTo": null,
                "messages": []
            }
        ],
        "dependencies": {
            "mobilebackends": [
                {
                    "id": "7cc615fa-bc6e-4e0f-a599-73c264d5249a",
                    "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": "2017-07-11T20:10:42.348Z",
                    "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": "9a8d49ad-fa9b-43b7-88a0-1dd401039e47",
                    "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": "d66b5c81-2531-46c8-bda7-f4cc8e83ce2e",
                            "name": "mcs_examples_sync_salesplus",
                            "version": "1.0.0",
                            "type": "APIImplementation"
                        }
                    ],
                    "implementation": {
                        "id": "d66b5c81-2531-46c8-bda7-f4cc8e83ce2e",
                        "name": "mcs_examples_sync_salesplus",
                        "version": "1.0.0"
                    },
                    "roles": []
                }
            ],
            "implementations": [
                {
                    "id": "d66b5c81-2531-46c8-bda7-f4cc8e83ce2e",
                    "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": "c2822b7f-ba4e-4693-a7f5-2c7cf91dcdd4",
                            "properties": {
                                "customcode.api.implementation.artifact": "true"
                            },
                            "downloadLink": null
                        }
                    ],
                    "api": null,
                    "uses": []
                }
            ],
            "connectors": [],
            "collections": [
                {
                    "id": "4c5cc3c5-c3e4-47f9-a87a-f7b88aa2e7c7",
                    "name": "images",
                    "version": "1.0",
                    "desc": "Customer and technician photos",
                    "links": [],
                    "published": false,
                    "inTrash": false,
                    "actionComment": null,
                    "etag": "0",
                    "createdOn": "2017-07-11T20:10:41.563Z",
                    "modifiedOn": "2017-07-11T20:37:49.911Z",
                    "modifiedBy": "jdoe",
                    "deletedOn": null,
                    "deletedBy": null,
                    "userIsolated": false,
                    "syncControl": true,
                    "guid": "OW2V7PVFUNAZDDQLLFFUVA24PQ",
                    "roles": [
                        {
                            "id": "fd42ebc04bff72fdd9adf34fd3732c12",
                            "name": "manager",
                            "version": "1.0",
                            "desc": "Company manager",
                            "links": [],
                            "published": true,
                            "inTrash": false,
                            "actionComment": null,
                            "etag": "0",
                            "createdOn": null,
                            "modifiedOn": null,
                            "modifiedBy": null,
                            "deletedOn": null,
                            "deletedBy": null
                        },
                        {
                            "id": "fd11a5739507b3bb2a371b45b0eda6c7",
                            "name": "customer",
                            "version": "1.0",
                            "desc": "Client application user",
                            "links": [],
                            "published": true,
                            "inTrash": false,
                            "actionComment": null,
                            "etag": "0",
                            "createdOn": null,
                            "modifiedOn": null,
                            "modifiedBy": null,
                            "deletedOn": null,
                            "deletedBy": null
                        }
                    ]
                }
            ],
            "unresolvedDependencies": [],
            "roles": [
                {
                    "id": "fd11a5739507b3bb2a371b45b0eda6c7",
                    "name": "customer",
                    "version": "1.0",
                    "desc": "Client application user",
                    "links": [],
                    "published": true,
                    "inTrash": false,
                    "actionComment": null,
                    "etag": "0",
                    "createdOn": null,
                    "modifiedOn": null,
                    "modifiedBy": null,
                    "deletedOn": null,
                    "deletedBy": null
                },
                {
                    "id": "fd42ebc04bff72fdd9adf34fd3732c12",
                    "name": "manager",
                    "version": "1.0",
                    "desc": "Company manager",
                    "links": [],
                    "published": true,
                    "inTrash": false,
                    "actionComment": null,
                    "etag": "0",
                    "createdOn": null,
                    "modifiedOn": null,
                    "modifiedBy": null,
                    "deletedOn": null,
                    "deletedBy": null
                }
            ],
            "packages": [],
            "clients": []
        }
    },
    "status": "SUCCESS",
    "policyValidationReport": null,
    "artifact": {
        "name": "package-salesPlusPackage.zip",
        "id": "5132ec5c-5fa2-4487-bcde-3854cffef086",
        "properties": {
            "is.package": "true"
        },
        "downloadLink": "/mobile/tools/1.0/artifacts/5132ec5c-5fa2-4487-bcde-3854cffef086"
    },
    "package": {
        "id": null,
        "name": "salesPlusPackage",
        "version": "1.0",
        "desc": null,
        "links": [],
        "published": null,
        "inTrash": null,
        "actionComment": null,
        "etag": null,
        "createdOn": null,
        "modifiedOn": null,
        "modifiedBy": null,
        "deletedOn": null,
        "deletedBy": null,
        "packageType": null,
        "documentation": "Using Export Package REST API",
        "systemVersion": "17.3.1.0.0.170711.0502",
        "formatVersion": 6
    }
}