Upload Implementation Archive
post
/mobile/tools/1.0/apis/{id}/implementations
Creates or updates a custom API implementation using the information that's provided in the uploaded implementation archive. When an implementation is created, it's bound to the API.
Request
Supported Media Types
- multipart/form-data
Path Parameters
-
id: string
The ID for the custom API implementation.
Header Parameters
-
If-Match(optional): string
The request completes successfully only if the ETag of the corresponding asset matches the value of this HTTP request header. To force overwrite, pass the value `*`.
Form Parameters
-
file: file
The ZIP file that contains all the artifacts for the custom API implementation.
Response
Supported Media Types
- application/json
201 Response
The implementation was uploaded.
Headers
-
ETag: string
The ETag corresponds to the state of the API (that is, the value increments by one on each change operation). You can use this ETag with the `If-Match` HTTP header on a request.
Root Schema : Implementation Artifact Details
Type:
object
Title:
Implementation Artifact Details
The implementation artifact details returned after uploading the file.
Show Source
-
artifactId:
string
A service-generated unique identifier for the uploaded ZIP file.
-
implementationId:
string
A service-generated unique identifier for the custom API implementation.
-
unresolvedDependencies:
array unresolvedDependencyArray
Minimum Number of Items:
0
Unique Items Required:true
An array of unresolved dependencies for a custom API implementation.
Nested Schema : unresolvedDependencyArray
Type:
array
Minimum Number of Items:
0
Unique Items Required:
true
An array of unresolved dependencies for a custom API implementation.
Show Source
-
[0]:
object unresolvedDependency
Unresolved dependency for the custom API implementation.
Nested Schema : unresolvedDependency
Type:
object
Unresolved dependency for the custom API implementation.
Show Source
-
name:
string
The name of the custom API or connector.
-
version:
string
The version of the custom API or connector.
Example Response (application/json)
{
"implementationId":"17a5b053-4d99-4dcf-8cc7-4b7feb152ce4",
"unresolvedDependencies":[
{
"name":"custom/employees",
"version":"3.5.1"
},
{
"name":"connector/hcm",
"version":"1.0"
}
],
"artifactId":"7da44b1a-b3e0-4d2f-b696-ac7444fbdd68"
}
400 Response
There's an issue with the ZIP file. For example, the service can't unzip the file or it can't find the main JavaScript file.
Root Schema : error
Type:
Show Source
object
-
detail:
string
Message that provides the error details.
-
o:ecid:
string
Execution context ID, which is a unique identifier to correlate events or requests that are associated with the same transaction across several components.
-
o:errorCode:
string
The service's error code.
-
o:errorDetails:
object errorDetails
-
o:errorPath:
string
The relative point in the API path where the error occurred.
-
status:
integer(int64)
HTTP status code. See http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html for more details.
-
title:
string
Summary of the problem.
-
type:
string
The URI to the link that provides details about the HTTP status code.
Nested Schema : errorDetails
Type:
Show Source
object
-
detail:
string
-
o:errorDetails:
object errorDetails
-
title:
string
Summary of the problem.
-
type:
string
The URI to the link that provides details about the HTTP status code.
404 Response
A custom API doesn't exist for the ID in the id
path parameter.
Root Schema : error
Type:
Show Source
object
-
detail:
string
Message that provides the error details.
-
o:ecid:
string
Execution context ID, which is a unique identifier to correlate events or requests that are associated with the same transaction across several components.
-
o:errorCode:
string
The service's error code.
-
o:errorDetails:
object errorDetails
-
o:errorPath:
string
The relative point in the API path where the error occurred.
-
status:
integer(int64)
HTTP status code. See http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html for more details.
-
title:
string
Summary of the problem.
-
type:
string
The URI to the link that provides details about the HTTP status code.
Nested Schema : errorDetails
Type:
Show Source
object
-
detail:
string
-
o:errorDetails:
object errorDetails
-
title:
string
Summary of the problem.
-
type:
string
The URI to the link that provides details about the HTTP status code.
412 Response
The operation failed based on the `If-Match` condition. Typically, this is the result of concurrent modification detection. This also can be the result of improper values specified in the request headers.
Root Schema : error
Type:
Show Source
object
-
detail:
string
Message that provides the error details.
-
o:ecid:
string
Execution context ID, which is a unique identifier to correlate events or requests that are associated with the same transaction across several components.
-
o:errorCode:
string
The service's error code.
-
o:errorDetails:
object errorDetails
-
o:errorPath:
string
The relative point in the API path where the error occurred.
-
status:
integer(int64)
HTTP status code. See http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html for more details.
-
title:
string
Summary of the problem.
-
type:
string
The URI to the link that provides details about the HTTP status code.
Nested Schema : errorDetails
Type:
Show Source
object
-
detail:
string
-
o:errorDetails:
object errorDetails
-
title:
string
Summary of the problem.
-
type:
string
The URI to the link that provides details about the HTTP status code.