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: file
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.
Package upload request.
Root Schema : packageUpload
Type:
object
Package upload request.
Match All
Show Source
-
object packageImport
Information about the package that was uploaded or installed.
-
object artifact
The artifact information.
Nested Schema : packageImport
Type:
object
Information about the package that was uploaded or installed.
Show Source
-
importResults(optional):
object importReport
Import results.
-
package:
object packageGet
The package representation for GET requests.
-
policies(optional):
array policyArray
Minimum Number of Items:
0
Unique Items Required:true
An array of policy elements. -
policyValidationReport(optional):
object policyValidationReport
The result of validation of the properties file with policies.
-
status(optional):
Allowed Values:
[ "SUCCESS", "FAILURE" ]
Nested Schema : artifact
Type:
object
The artifact information.
Show Source
-
downloadLink(optional):
string
The link to download the artifact.
-
id:
string
The artifact's ID.
-
name:
string
Maximum Length:
255
The name of the artifact. -
properties(optional):
object properties
Additional Properties Allowed: additionalProperties
Nested Schema : importReport
Type:
object
Import results.
Show Source
-
dependencies(optional):
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.
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]
Nested Schema : policyArray
Type:
array
Minimum Number of Items:
0
Unique Items Required:
true
An array of policy elements.
Show Source
-
Array of:
object policy
Policy object representation.
Nested Schema : policyValidationReport
Type:
object
The result of validation of the properties file with policies.
Show Source
-
valid:
boolean
-
validationResults(optional):
array validationResults
Minimum Number of Items:
0
Nested Schema : dependencies
Type:
object
Information about the asset and its dependencies.
Show Source
-
apis(optional):
array apiDependencyArray
Minimum Number of Items:
0
Unique Items Required:true
An array of APIs as dependencies. -
collections(optional):
array collectionDependencyArray
Minimum Number of Items:
0
Unique Items Required:true
An array of storage collections as dependencies. -
connectors(optional):
array connectorDependencyArray
Minimum Number of Items:
0
Unique Items Required:true
An array of connectors as dependencies. -
implementations(optional):
array implDependencyArray
Minimum Number of Items:
0
Unique Items Required:true
An array of API implementations as dependencies. -
mobilebackends(optional):
array mbeDependencyArray
Minimum Number of Items:
0
Unique Items Required:true
An array of backends as dependencies. -
packages(optional):
array packageDependencyArray
Minimum Number of Items:
0
Unique Items Required:true
An array of packages as dependencies. -
roles(optional):
array roleArray
Minimum Number of Items:
0
Unique Items Required:true
An array of role elements. -
unresolvedDependencies(optional):
array unresolvedDependencyArray
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.
Show Source
-
Array of:
object checklistRecord
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.
Show Source
-
Array of:
object apiDependency
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.
Show Source
-
Array of:
object collectionDependency
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.
Show Source
-
Array of:
object connectorDependency
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.
Show Source
-
Array of:
object implDependency
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.
Show Source
-
Array of:
object mbeDependency
Backend as a dependency.
Nested Schema : packageDependencyArray
Type:
array
Minimum Number of Items:
0
Unique Items Required:
true
An array of packages as dependencies.
Show Source
-
Array of:
object packageDependency
Package as a dependency.
Nested Schema : roleArray
Type:
array
Minimum Number of Items:
0
Unique Items Required:
true
An array of role elements.
Show Source
-
Array of:
object roleGet
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.
Show Source
-
Array of:
object unresolvedDependency
Unresolved dependency for the custom API implementation.
Nested Schema : apiDependency
Type:
object
API as a dependency.
Match All
Show Source
-
object apiShort
The short API definition representation.
-
object apiDependency-allOf[1]
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]
Nested Schema : apiDependency-allOf[1]
Type:
Show Source
object
-
implementation(optional):
object assetShort
Asset information (short form).
-
implementations(optional):
array assetShortQualifiedArray
Minimum Number of Items:
0
Unique Items Required:true
An array of qualified assets. -
mock(optional):
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(optional):
array roleArray
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
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]
Nested Schema : apiShort-allOf[1]
Type:
Show Source
object
-
basePath(optional):
string
The API base path in the format `/mobile/custom/{apiName}`.
-
hasBusinessObjects(optional):
boolean
Default Value:
false
Indicates whether the API is associated with API Express resources (business objects). -
icon(optional):
object icon
Information about the icon that's associated with the API or connector.
Nested Schema : assetUpdate
Type:
object
The asset representation for PUT requests.
Show Source
-
actionComment(optional):
string
-
desc(optional):
string
Maximum Length:
100
-
max(optional):
boolean
Default Value:
false
-
name:
string
Maximum Length:
100
Pattern:^[a-zA-Z][a-zA-Z0-9_]*$
-
namespace(optional):
string
Applicable to APIs and implementations only. This value is null for all other asset types.
-
title(optional):
string
Maximum Length:
255
-
version(optional):
string
Maximum Length:
100
Pattern:^[a-zA-Z0-9][\w.]*$
Asset version.
Nested Schema : assetIdEtag
Type:
object
The asset ID and entity tag (ETag) values.
Show Source
-
etag(optional):
string
The asset entity tag (ETag) value, which you can use to detect concurrent modification.
-
id:
string
Nested Schema : assetGet-allOf[3]
Type:
Show Source
object
-
createdOn(optional):
string
-
deletedBy(optional):
string
-
deletedOn(optional):
string
-
links(optional):
array entityLinksArray
Minimum Number of Items:
0
An array of links for an entity's metadata. -
modifiedBy(optional):
string
-
modifiedOn(optional):
string
-
published(optional):
boolean
An asset draft or published status representation.
Nested Schema : entityLinksArray
Type:
array
Minimum Number of Items:
0
An array of links for an entity's metadata.
Show Source
-
Array of:
object items
Link to the entity's metadata.
Nested Schema : items
Type:
object
Link to the entity's metadata.
Show Source
-
href:
string
Link value.
-
rel:
Allowed Values:
[ "self", "canonical" ]
Link type.
Nested Schema : icon
Type:
object
Information about the icon that's associated with the API or connector.
Show Source
Nested Schema : assetShort
Type:
object
Asset information (short form).
Show Source
-
id(optional):
string
Asset identifier.
-
name(optional):
string
Asset name.
-
namespace(optional):
string
Asset namespace.
-
version(optional):
string
Maximum Length:
100
Pattern:^[a-zA-Z0-9][\w.]*$
Asset version.
Nested Schema : assetShortQualifiedArray
Type:
array
Minimum Number of Items:
0
Unique Items Required:
true
An array of qualified assets.
Show Source
-
Array of:
object assetShortQualified
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
Show Source
-
object assetShort
Asset information (short form).
-
object assetQualifiers
Asset type name and qualifiers.
Nested Schema : assetQualifiers
Type:
object
Asset type name and qualifiers.
Show Source
-
qualifier(optional):
string
The asset qualifier. It may contain multiple values separated by commas (`,`).
-
type(optional):
Allowed Values:
[ "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]
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]
Nested Schema : collectionDependency-allOf[2]
Type:
Show Source
object
-
roles(optional):
array roleArray
Minimum Number of Items:
0
Unique Items Required:true
An array of role elements.
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]
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]
Nested Schema : connectorDependency-allOf[2]
Type:
Show Source
object
-
implementation(optional):
object assetShort
Asset information (short form).
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.
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.
Nested Schema : connectorBase
Type:
object
Base connector properties.
Show Source
-
basePath(optional):
string
The connector API base path in the format `/mobile/connector/{name}/{path}`.
-
connectorType(optional):
Allowed Values:
[ "REST", "SOAP", "DATABASE", "ICS", "FA" ]
-
icon(optional):
object icon
Information about the icon that's associated with the API or connector.
Nested Schema : connectorGetRest
Type:
object
REST connector get payload.
Match All
Show Source
-
object connectorUpdateRest
REST connector update payload.
-
object connectorGetRest-allOf[1]
Nested Schema : connectorUpdateSoap
Type:
object
SOAP connector update payload.
Match All
Show Source
-
object connectorCreateSoap
SOAP connector creation payload.
-
object connectorUpdateSoap-allOf[1]
Nested Schema : connectorUpdateDatabase
Type:
object
MOB DB connector update payload.
Match All
Show Source
-
object connectorCreateDatabase
REST connector creation payload.
-
object connectorUpdateDatabase-allOf[1]
Nested Schema : connectorUpdateIcsRest
Type:
object
ICS REST connector update payload.
Match All
Show Source
-
object connectorUpdateRest
REST connector update payload.
-
object connectorUpdateIcsRest-allOf[1]
Nested Schema : connectorUpdateIcsSoap
Type:
object
ICS SOAP connector update payload.
Match All
Show Source
-
object connectorUpdateSoap
SOAP connector update payload.
-
object connectorUpdateIcsSoap-allOf[1]
Nested Schema : connectorUpdateRest
Type:
object
REST connector update payload.
Show Source
-
httpConnectionTimeout(optional):
integer(int64)
-
httpReadTimeout(optional):
integer(int64)
-
remoteURL:
string
-
rules(optional):
array restRuleArray
Minimum Number of Items:
0
An array of REST rules. -
securityPolicies(optional):
array securityPolicyArray
Minimum Number of Items:
0
An array of security policy elements. -
workAreaTag(optional):
string
Nested Schema : connectorGetRest-allOf[1]
Type:
Show Source
object
-
descriptorInfo(optional):
object connectorDescriptorInfo
Connector descriptor information.
Nested Schema : restRuleArray
Type:
array
Minimum Number of Items:
0
An array of REST rules.
Show Source
-
Array of:
object restRule
REST connector rule definition.
Nested Schema : securityPolicyArray
Type:
array
Minimum Number of Items:
0
An array of security policy elements.
Show Source
-
Array of:
object securityPolicy
Connector OWSM security policy.
Nested Schema : restRule
Type:
object
REST connector rule definition.
Show Source
-
defaultParameters(optional):
array defaultParameters
Minimum Number of Items:
0
Unique Items Required:true
-
methods(optional):
array methods
Minimum Number of Items:
0
Unique Items Required:true
-
notAppliedToNested(optional):
boolean
-
resource(optional):
string
Nested Schema : defaultParameters
Type:
array
Minimum Number of Items:
0
Unique Items Required:
Show Source
true
-
Array of:
object restParameter
REST connector rule default parameter.
Nested Schema : methods
Type:
array
Minimum Number of Items:
0
Unique Items Required:
Show Source
true
-
Array of:
Allowed Values:
[ "GET", "POST", "PUT", "DELETE", "HEAD", "TRACE", "OPTIONS", "PATCH" ]
Nested Schema : restParameter
Type:
object
REST connector rule default parameter.
Show Source
-
name(optional):
string
-
type(optional):
Allowed Values:
[ "query", "header" ]
-
value(optional):
string
Nested Schema : securityPolicy
Type:
object
Connector OWSM security policy.
Show Source
-
name:
string
-
overrides(optional):
array securityPolicyOverrideArray
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.
Show Source
-
Array of:
object securityPolicyOverride
Security policy override property.
Nested Schema : connectorDescriptorInfo
Type:
object
Connector descriptor information.
Show Source
-
descriptorLocation(optional):
string
-
descriptorSource:
Allowed Values:
[ "URL", "FILE", "NONE" ]
-
designTimeUserName(optional):
string
-
isDesignTimePasswordSaved(optional):
boolean
Nested Schema : connectorUpdateSoap-allOf[1]
Type:
Show Source
object
-
httpConnectionTimeout(optional):
integer(int64)
-
httpReadTimeout(optional):
integer(int64)
-
operations(optional):
array operations
-
securityPolicies(optional):
array securityPolicyArray
Minimum Number of Items:
0
An array of security policy elements. -
svcEndpoint:
string
-
svcName:
string
-
svcPort:
string
Nested Schema : items
Type:
Show Source
object
-
custom(optional):
string
The custom name for the operation.
-
name:
string
-
uri:
string
The URI for the SOAPAction HTTP request header.
Nested Schema : connectorCreateDatabase
Type:
object
REST connector creation payload.
Show Source
-
databaseConnectorType:
Allowed Values:
[ "table", "customsql" ]
Nested Schema : connectorUpdateDatabase-allOf[1]
Type:
Show Source
object
-
dbConnectorMetadata(optional):
object dbConnectorMetadata
Database connector metadata model.
Nested Schema : dbConnectorMetadata
Type:
object
Database connector metadata model.
Show Source
-
calls:
array calls
Minimum Number of Items:
0
-
tableInfo(optional):
object tableInfo
Database connector table/view metadata.
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.
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.
Nested Schema : connectorUpdateIcsRest-allOf[1]
Type:
Show Source
object
-
ics(optional):
object icsConnectionReference
ICS configuration. This holds state about an ICS instance that should persist across connector sessions.
-
integration(optional):
object integration
ICS integration flow metadata.
Nested Schema : icsConnectionReference
Type:
object
ICS configuration. This holds state about an ICS instance that should persist across connector sessions.
Show Source
-
connectionName(optional):
string
The name of this logical construct describing connectivity to a particular ICS instance.
-
runtimeCsfKey(optional):
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`).
Nested Schema : integration
Type:
object
ICS integration flow metadata.
Show Source
-
builtBy(optional):
string
The author of the integration.
-
created(optional):
string
When this integration was created.
-
description(optional):
string
The description of the ICS integration.
-
icon(optional):
string
URL of the icon for the target.
-
integrationName:
string
The name of the ICS integration.
-
remoteUrl(optional):
string
The URL used to create the connector (remote URL or WSDL).
-
securityPolicy(optional):
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(optional):
string
The type of system being exposed in ICS.
-
technology(optional):
Allowed Values:
[ "SOAP", "REST" ]
-
updated(optional):
string
When this integration was updated.
-
version(optional):
string
The version in ICS.
Nested Schema : connectorUpdateIcsSoap-allOf[1]
Type:
Show Source
object
-
ics(optional):
object icsConnectionReference
ICS configuration. This holds state about an ICS instance that should persist across connector sessions.
-
integration(optional):
object integration
ICS integration flow metadata.
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]
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]
Nested Schema : implDependency-allOf[2]
Type:
Show Source
object
-
api(optional):
object assetShortQualified
An asset's information in qualified short form, which includes type and qualifiers.
-
uses(optional):
array assetShortQualifiedArray
Minimum Number of Items:
0
Unique Items Required:true
An array of qualified assets.
Nested Schema : apiImplementationGet-allOf[1]
Type:
Show Source
object
-
api(optional):
object assetShortQualified
An asset's information in qualified short form, which includes type and qualifiers.
-
artifacts(optional):
array artifactArray
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.
Show Source
-
Array of:
object artifact
The artifact information.
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]
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]
Nested Schema : mbeDependency-allOf[2]
Type:
Show Source
object
-
includes(optional):
array assetShortQualifiedArray
Minimum Number of Items:
0
Unique Items Required:true
An array of qualified assets. -
roles(optional):
array roleArray
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
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]
Nested Schema : mobilebackendGet-allOf[1]
Type:
Show Source
object
-
analyticsAppGuid(optional):
string
Analytics application ID resolved from the policy. If a new analytics application creation was requested on the backend creation and this attribute is null, then the application wasn't created. In this case you can check if it already exists, retry, or create one with another name and/or timezone, and then link it to the backend.
-
targetBackend(optional):
object assetShort
Asset information (short form).
-
targetBackendError(optional):
object localizedMessage
Localized error message for generic purposes.
Nested Schema : mobilebackendOAuthKeys
Type:
object
The client keys (client_id/client_secret) that are required for backend access using OAuth.
Show Source
Nested Schema : mobilebackendBasicAuthKeys
Type:
object
The mobile backend ID that's required for backend access when you use Basic access authorization.
Show Source
Nested Schema : mobilebackendShortGet-allOf[3]
Type:
Show Source
object
-
basic(optional):
boolean
-
inactive(optional):
boolean
-
oauth(optional):
boolean
-
roleAccess(optional):
object mobilebackendRoleAccess
The backend's role-access details.
Nested Schema : mobilebackendRoleAccess
Type:
object
The backend's role-access details.
Show Source
-
enabled(optional):
boolean
-
roles(optional):
array stringArray
Minimum Number of Items:
0
An array of string values.
Nested Schema : stringArray
Type:
array
Minimum Number of Items:
0
An array of string values.
Show Source
Nested Schema : localizedMessage
Type:
object
Localized error message for generic purposes.
Show Source
-
message:
string
-
messageId(optional):
string
-
params(optional):
array params
Minimum Number of Items:
0
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.
Nested Schema : unresolvedDependency
Type:
object
Unresolved dependency for the custom API implementation.
Show Source
-
name(optional):
string
The name of the custom API or connector.
-
version(optional):
string
The version of the custom API or connector.
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(optional):
array localizedMessageArray
Minimum Number of Items:
0
An array of localized messages. -
resolvedTo(optional):
object assetShort
Asset information (short form).
-
resultCode:
Allowed Values:
[ "CREATED", "PICKED", "RESOLVED", "CONFLICTS", "SKIPPED", "PRIVILEGES" ]
Nested Schema : localizedMessageArray
Type:
array
Minimum Number of Items:
0
An array of localized messages.
Show Source
-
Array of:
object localizedMessage
Localized error message for generic purposes.
Nested Schema : packageGet-allOf[1]
Type:
Show Source
object
-
documentation(optional):
boolean
-
packageType(optional):
Allowed Values:
[ "EXPORT", "IMPORT" ]
-
systemVersion(optional):
string
Nested Schema : policy
Type:
object
Policy object representation.
Show Source
-
desc(optional):
string
-
name:
string
Maximum Length:
506
-
value:
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 } }