Jump to

• Request
• Response
• Examples

Upload Custom API Implementation

post

/mobile/tools/1.0/apis/{id}/implementations

Creates or updates a version of a custom API implementation using the ZIP file provided in the request.

Permissions

To access this operation, you must be a team member with the MobileEnvironment_Develop role.

Request

Supported Media Types

• multipart/form-data

Path Parameters

• id: string

  The unique ID for the custom API. For example, b11b9844-d4e2-4da9-a0f9-f0a8a68ac9f8.

Form Parameters

• file: file
  The ZIP file that contains all the artifacts for the custom API implementation.

Back to Top

Response

Supported Media Types

• application/json

201 Response

Implementation ZIP file uploaded successfully.

Headers

• ETag: integer
  The ETag value is always 1.

Body ()

Root Schema : Implementation Artifact Details

Type: object

Title: Implementation Artifact Details

The artifact details for the uploaded implementation.

Show Source

• artifactId: string
  An MCS-generated unique identifier for the uploaded ZIP file.
• implementationId: string
  An MCS-generated unique identifier for the custom API implementation.
• unresolvedDependencies(optional): array Unresolved Dependencies
  Title: Unresolved Dependencies

  Minimum Number of Items: 0

  Unique Items Required: true

  Array of unresolved dependencies for the custom API implementation.

{
    "title":"Implementation Artifact Details",
    "description":"The artifact details for the uploaded implementation.",
    "required":[
        "implementationId",
        "artifactId"
    ],
    "type":"object",
    "properties":{
        "implementationId":{
            "type":"string",
            "description":"An MCS-generated unique identifier for the custom API implementation."
        },
        "artifactId":{
            "type":"string",
            "description":"An MCS-generated unique identifier for the uploaded ZIP file."
        },
        "unresolvedDependencies":{
            "type":"array",
            "title":"Unresolved Dependencies",
            "description":"Array of unresolved dependencies for the custom API implementation.",
            "items":{
                "$ref":"#/definitions/unresolvedDependency"
            },
            "minItems":0,
            "uniqueItems":true
        }
    }
}

Nested Schema : Unresolved Dependencies

Type: array

Title: Unresolved Dependencies

Minimum Number of Items: 0

Unique Items Required: true

Array of unresolved dependencies for the custom API implementation.

Show Source

• Array of: object Unresolved Dependency
  Title: Unresolved Dependency

  A custom API or connector that's declared as a dependency in the package.json file but doesn't exist in MCS.

{
    "type":"array",
    "title":"Unresolved Dependencies",
    "description":"Array of unresolved dependencies for the custom API implementation.",
    "items":{
        "$ref":"#/definitions/unresolvedDependency"
    },
    "minItems":0,
    "uniqueItems":true
}

Nested Schema : Unresolved Dependency

Type: object

Title: Unresolved Dependency

A custom API or connector that's declared as a dependency in the package.json file but doesn't exist in MCS.

Show Source

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

{
    "title":"Unresolved Dependency",
    "description":"A custom API or connector that's declared as a dependency in the <code>package.json</code> file but doesn't exist in MCS.",
    "required":[
        "name",
        "version"
    ],
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"The name of the custom API or connector."
        },
        "version":{
            "type":"string",
            "description":"The version of the custom API or connector."
        }
    }
}

Example Response (application/json)

{
    "implementationId":"17a5b053-4d99-4dcf-8cc7-4b7feb152ce4",
    "artifactId":"7da44b1a-b3e0-4d2f-b696-ac7444fbdd68",
    "unresolvedDependencies":[
        {
            "name":"custom/employees",
            "version":"3.5.1"
        },
        {
            "name":"connector/hcm",
            "version":"1.0"
        }
    ]
}

400 Response

There's an issue with the ZIP file. For example, MCS can't unzip the file or it can't find the main JavaScript file.

Body ()

Root Schema : Error

Type: object

Title: Error

The error JSON object returned by Mobile Cloud Service.

Show Source

• detail: string
  Message that provides the error details.
• o:ecid: string
  Execution context ID, which is a unique identifier to correlate events or requests that are associated with the same transaction across several components.
• o:errorCode: string
  Mobile Cloud Service error code.
• o:errorDetails(optional): array o:errorDetails
  Minimum Number of Items: 0

  List of the issues that cause the error. Included when the error is caused by multiple issues.
• o:errorPath: string
  The relative point in the API path where the error occurred.
• status: integer
  HTTP status code. See http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html for more details.
• title: string
  Summary of the problem.
• type: string
  The URI to the link that provides details about the HTTP status code.

{
    "title":"Error",
    "description":"The error JSON object returned by Mobile Cloud Service.",
    "properties":{
        "title":{
            "description":"Summary of the problem.",
            "type":"string"
        },
        "detail":{
            "description":"Message that provides the error details.",
            "type":"string"
        },
        "status":{
            "description":"HTTP status code. See http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html for more details.",
            "type":"integer"
        },
        "o:errorCode":{
            "description":"Mobile Cloud Service error code.",
            "type":"string"
        },
        "o:errorPath":{
            "description":"The relative point in the API path where the error occurred.",
            "type":"string"
        },
        "o:errorDetails":{
            "items":{
                "$ref":"#/definitions/errorDetail"
            },
            "description":"List of the issues that cause the error. Included when the error is caused by multiple issues.",
            "minItems":0,
            "type":"array"
        },
        "o:ecid":{
            "description":"Execution context ID, which is a unique identifier to correlate events or requests that are associated with the same transaction across several components.",
            "type":"string"
        },
        "type":{
            "description":"The URI to the link that provides details about the HTTP status code.",
            "type":"string"
        }
    },
    "required":[
        "type",
        "status",
        "title",
        "detail",
        "o:ecid",
        "o:errorCode",
        "o:errorPath"
    ],
    "type":"object"
}

Nested Schema : o:errorDetails

Type: array

Minimum Number of Items: 0

List of the issues that cause the error. Included when the error is caused by multiple issues.

Show Source

• Array of: object Error Detail
  Title: Error Detail

{
    "items":{
        "$ref":"#/definitions/errorDetail"
    },
    "description":"List of the issues that cause the error. Included when the error is caused by multiple issues.",
    "minItems":0,
    "type":"array"
}

Nested Schema : Error Detail

Type: object

Title: Error Detail

Show Source

• instance: string
  The URI to the link that provides more detailed information about the error.
• o:errorCode: string
  Mobile Cloud Service error code.
• o:errorPath: string
  The relative point in the API path where the error occurred.
• title: string
  Summary of the problem.
• type: string
  The URI to the link that provides details about the HTTP status code.

{
    "title":"Error Detail",
    "properties":{
        "title":{
            "description":"Summary of the problem.",
            "type":"string"
        },
        "o:errorPath":{
            "description":"The relative point in the API path where the error occurred.",
            "type":"string"
        },
        "o:errorCode":{
            "description":"Mobile Cloud Service error code.",
            "type":"string"
        },
        "type":{
            "description":"The URI to the link that provides details about the HTTP status code.",
            "type":"string"
        },
        "instance":{
            "description":"The URI to the link that provides more detailed information about the error.",
            "type":"string"
        }
    },
    "required":[
        "type",
        "instance",
        "title",
        "o:errorPath",
        "o:errorCode"
    ],
    "type":"object"
}

401 Response

Bad or expired token. This can happen if the user or MCS revoked or expired an access token. You must re-authenticate the user.

Body ()

Root Schema : Error

Type: object

Title: Error

The error JSON object returned by Mobile Cloud Service.

Show Source

• detail: string
  Message that provides the error details.
• o:ecid: string
  Execution context ID, which is a unique identifier to correlate events or requests that are associated with the same transaction across several components.
• o:errorCode: string
  Mobile Cloud Service error code.
• o:errorDetails(optional): array o:errorDetails
  Minimum Number of Items: 0

  List of the issues that cause the error. Included when the error is caused by multiple issues.
• o:errorPath: string
  The relative point in the API path where the error occurred.
• status: integer
  HTTP status code. See http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html for more details.
• title: string
  Summary of the problem.
• type: string
  The URI to the link that provides details about the HTTP status code.

{
    "title":"Error",
    "description":"The error JSON object returned by Mobile Cloud Service.",
    "properties":{
        "title":{
            "description":"Summary of the problem.",
            "type":"string"
        },
        "detail":{
            "description":"Message that provides the error details.",
            "type":"string"
        },
        "status":{
            "description":"HTTP status code. See http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html for more details.",
            "type":"integer"
        },
        "o:errorCode":{
            "description":"Mobile Cloud Service error code.",
            "type":"string"
        },
        "o:errorPath":{
            "description":"The relative point in the API path where the error occurred.",
            "type":"string"
        },
        "o:errorDetails":{
            "items":{
                "$ref":"#/definitions/errorDetail"
            },
            "description":"List of the issues that cause the error. Included when the error is caused by multiple issues.",
            "minItems":0,
            "type":"array"
        },
        "o:ecid":{
            "description":"Execution context ID, which is a unique identifier to correlate events or requests that are associated with the same transaction across several components.",
            "type":"string"
        },
        "type":{
            "description":"The URI to the link that provides details about the HTTP status code.",
            "type":"string"
        }
    },
    "required":[
        "type",
        "status",
        "title",
        "detail",
        "o:ecid",
        "o:errorCode",
        "o:errorPath"
    ],
    "type":"object"
}

Nested Schema : o:errorDetails

Type: array

Minimum Number of Items: 0

List of the issues that cause the error. Included when the error is caused by multiple issues.

Show Source

• Array of: object Error Detail
  Title: Error Detail

{
    "items":{
        "$ref":"#/definitions/errorDetail"
    },
    "description":"List of the issues that cause the error. Included when the error is caused by multiple issues.",
    "minItems":0,
    "type":"array"
}

Nested Schema : Error Detail

Type: object

Title: Error Detail

Show Source

• instance: string
  The URI to the link that provides more detailed information about the error.
• o:errorCode: string
  Mobile Cloud Service error code.
• o:errorPath: string
  The relative point in the API path where the error occurred.
• title: string
  Summary of the problem.
• type: string
  The URI to the link that provides details about the HTTP status code.

{
    "title":"Error Detail",
    "properties":{
        "title":{
            "description":"Summary of the problem.",
            "type":"string"
        },
        "o:errorPath":{
            "description":"The relative point in the API path where the error occurred.",
            "type":"string"
        },
        "o:errorCode":{
            "description":"Mobile Cloud Service error code.",
            "type":"string"
        },
        "type":{
            "description":"The URI to the link that provides details about the HTTP status code.",
            "type":"string"
        },
        "instance":{
            "description":"The URI to the link that provides more detailed information about the error.",
            "type":"string"
        }
    },
    "required":[
        "type",
        "instance",
        "title",
        "o:errorPath",
        "o:errorCode"
    ],
    "type":"object"
}

403 Response

Bad OAuth request, such as wrong consumer key, bad nonce, or expired timestamp. Unfortunately, re-authenticating the user won't help here.

Body ()

Root Schema : Error

Type: object

Title: Error

The error JSON object returned by Mobile Cloud Service.

Show Source

• detail: string
  Message that provides the error details.
• o:ecid: string
  Execution context ID, which is a unique identifier to correlate events or requests that are associated with the same transaction across several components.
• o:errorCode: string
  Mobile Cloud Service error code.
• o:errorDetails(optional): array o:errorDetails
  Minimum Number of Items: 0

  List of the issues that cause the error. Included when the error is caused by multiple issues.
• o:errorPath: string
  The relative point in the API path where the error occurred.
• status: integer
  HTTP status code. See http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html for more details.
• title: string
  Summary of the problem.
• type: string
  The URI to the link that provides details about the HTTP status code.

{
    "title":"Error",
    "description":"The error JSON object returned by Mobile Cloud Service.",
    "properties":{
        "title":{
            "description":"Summary of the problem.",
            "type":"string"
        },
        "detail":{
            "description":"Message that provides the error details.",
            "type":"string"
        },
        "status":{
            "description":"HTTP status code. See http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html for more details.",
            "type":"integer"
        },
        "o:errorCode":{
            "description":"Mobile Cloud Service error code.",
            "type":"string"
        },
        "o:errorPath":{
            "description":"The relative point in the API path where the error occurred.",
            "type":"string"
        },
        "o:errorDetails":{
            "items":{
                "$ref":"#/definitions/errorDetail"
            },
            "description":"List of the issues that cause the error. Included when the error is caused by multiple issues.",
            "minItems":0,
            "type":"array"
        },
        "o:ecid":{
            "description":"Execution context ID, which is a unique identifier to correlate events or requests that are associated with the same transaction across several components.",
            "type":"string"
        },
        "type":{
            "description":"The URI to the link that provides details about the HTTP status code.",
            "type":"string"
        }
    },
    "required":[
        "type",
        "status",
        "title",
        "detail",
        "o:ecid",
        "o:errorCode",
        "o:errorPath"
    ],
    "type":"object"
}

Nested Schema : o:errorDetails

Type: array

Minimum Number of Items: 0

List of the issues that cause the error. Included when the error is caused by multiple issues.

Show Source

• Array of: object Error Detail
  Title: Error Detail

{
    "items":{
        "$ref":"#/definitions/errorDetail"
    },
    "description":"List of the issues that cause the error. Included when the error is caused by multiple issues.",
    "minItems":0,
    "type":"array"
}

Nested Schema : Error Detail

Type: object

Title: Error Detail

Show Source

• instance: string
  The URI to the link that provides more detailed information about the error.
• o:errorCode: string
  Mobile Cloud Service error code.
• o:errorPath: string
  The relative point in the API path where the error occurred.
• title: string
  Summary of the problem.
• type: string
  The URI to the link that provides details about the HTTP status code.

{
    "title":"Error Detail",
    "properties":{
        "title":{
            "description":"Summary of the problem.",
            "type":"string"
        },
        "o:errorPath":{
            "description":"The relative point in the API path where the error occurred.",
            "type":"string"
        },
        "o:errorCode":{
            "description":"Mobile Cloud Service error code.",
            "type":"string"
        },
        "type":{
            "description":"The URI to the link that provides details about the HTTP status code.",
            "type":"string"
        },
        "instance":{
            "description":"The URI to the link that provides more detailed information about the error.",
            "type":"string"
        }
    },
    "required":[
        "type",
        "instance",
        "title",
        "o:errorPath",
        "o:errorCode"
    ],
    "type":"object"
}

404 Response

A Custom API doesn't exist for ID in the id path parameter.

Body ()

Root Schema : Error

Type: object

Title: Error

The error JSON object returned by Mobile Cloud Service.

Show Source

• detail: string
  Message that provides the error details.
• o:ecid: string
  Execution context ID, which is a unique identifier to correlate events or requests that are associated with the same transaction across several components.
• o:errorCode: string
  Mobile Cloud Service error code.
• o:errorDetails(optional): array o:errorDetails
  Minimum Number of Items: 0

  List of the issues that cause the error. Included when the error is caused by multiple issues.
• o:errorPath: string
  The relative point in the API path where the error occurred.
• status: integer
  HTTP status code. See http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html for more details.
• title: string
  Summary of the problem.
• type: string
  The URI to the link that provides details about the HTTP status code.

{
    "title":"Error",
    "description":"The error JSON object returned by Mobile Cloud Service.",
    "properties":{
        "title":{
            "description":"Summary of the problem.",
            "type":"string"
        },
        "detail":{
            "description":"Message that provides the error details.",
            "type":"string"
        },
        "status":{
            "description":"HTTP status code. See http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html for more details.",
            "type":"integer"
        },
        "o:errorCode":{
            "description":"Mobile Cloud Service error code.",
            "type":"string"
        },
        "o:errorPath":{
            "description":"The relative point in the API path where the error occurred.",
            "type":"string"
        },
        "o:errorDetails":{
            "items":{
                "$ref":"#/definitions/errorDetail"
            },
            "description":"List of the issues that cause the error. Included when the error is caused by multiple issues.",
            "minItems":0,
            "type":"array"
        },
        "o:ecid":{
            "description":"Execution context ID, which is a unique identifier to correlate events or requests that are associated with the same transaction across several components.",
            "type":"string"
        },
        "type":{
            "description":"The URI to the link that provides details about the HTTP status code.",
            "type":"string"
        }
    },
    "required":[
        "type",
        "status",
        "title",
        "detail",
        "o:ecid",
        "o:errorCode",
        "o:errorPath"
    ],
    "type":"object"
}

Nested Schema : o:errorDetails

Type: array

Minimum Number of Items: 0

List of the issues that cause the error. Included when the error is caused by multiple issues.

Show Source

• Array of: object Error Detail
  Title: Error Detail

{
    "items":{
        "$ref":"#/definitions/errorDetail"
    },
    "description":"List of the issues that cause the error. Included when the error is caused by multiple issues.",
    "minItems":0,
    "type":"array"
}

Nested Schema : Error Detail

Type: object

Title: Error Detail

Show Source

• instance: string
  The URI to the link that provides more detailed information about the error.
• o:errorCode: string
  Mobile Cloud Service error code.
• o:errorPath: string
  The relative point in the API path where the error occurred.
• title: string
  Summary of the problem.
• type: string
  The URI to the link that provides details about the HTTP status code.

{
    "title":"Error Detail",
    "properties":{
        "title":{
            "description":"Summary of the problem.",
            "type":"string"
        },
        "o:errorPath":{
            "description":"The relative point in the API path where the error occurred.",
            "type":"string"
        },
        "o:errorCode":{
            "description":"Mobile Cloud Service error code.",
            "type":"string"
        },
        "type":{
            "description":"The URI to the link that provides details about the HTTP status code.",
            "type":"string"
        },
        "instance":{
            "description":"The URI to the link that provides more detailed information about the error.",
            "type":"string"
        }
    },
    "required":[
        "type",
        "instance",
        "title",
        "o:errorPath",
        "o:errorCode"
    ],
    "type":"object"
}

Back to Top

Examples

The following example shows how to upload a custom API implementation ZIP file by submitting a POST request on the REST resource using cURL. Note that you must use OAuth authorization for this API. For more information about cURL, see Use cURL.

curl -i
-X POST
-F file=@myCustomAPI.zip
-H "Authorization: Bearer ${OAUTH_TOKEN}"
https://fif.cloud.oracle.com/mobile/tools/1.0/apis/b11b9844-d4e2-4da9-a0f9-f0a8a68ac9f8/implementations

Example of Response Header

The following shows an example of the response header:

201 CREATED
Content-Type: application/json
Date: Mon, 23 Jan 2017 18:37:58 GMT
ETag: 1

Example of Response Body

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

{
  "implementationId": "2a60feb3-aaa9-4210-8d18-3ac62d818c19",
  "artifactId": "413ae322-1d50-4431-8709-84ebf7db4301",
  "unresolvedDependencies": []
}

Back to Top