Jump to

• Request
• Response
• Examples

Upload a custom gateway artifact

post

/apiplatform/administration/v1/artifacts

Uploads a custom gateway artifact.

Users requesting this resource must be assigned the Administrator role.

Note: only a single artifact with a given name/type/version can be created on the tenant. Multiple revisions of the same version not supported. If an artifact exists with the same name/type/version it will be replaced.

Request

Supported Media Types

• multipart/form-data

Form Parameters

• artifact: file
  An artifact file.
• json: string(json)

  Metadata about the artifact file, in JSON format:

  {"name": "testArtifact","type": "zip","version": "1","revision": "1"}

  A description is optional.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Artifact successfully replaced.

201 Response

Artifact successfully created.

403 Response

Forbidden.

Body ()

Root Schema : Error

Type: object

Show Source

• detail(optional): string
  Detailed error message
• errorCode(optional): string
  Application specific error code
• errorDetails(optional): array errorDetails
  additional errors
• errorPath(optional): string
• instance(optional): string
  URI to the link that provides more detail about the error
• status(optional): string
  HTTP status code
• title: string
  Summary error message
• type: string
  Error type

{
    "type":"object",
    "required":[
        "title",
        "type"
    ],
    "properties":{
        "type":{
            "type":"string",
            "description":"Error type"
        },
        "title":{
            "type":"string",
            "description":"Summary error message"
        },
        "detail":{
            "type":"string",
            "description":"Detailed error message"
        },
        "instance":{
            "type":"string",
            "description":"URI to the link that provides more detail about the error"
        },
        "errorCode":{
            "type":"string",
            "description":"Application specific error code"
        },
        "errorPath":{
            "type":"string"
        },
        "status":{
            "type":"string",
            "description":"HTTP status code"
        },
        "errorDetails":{
            "type":"array",
            "description":"additional errors",
            "items":{
                "$ref":"#/definitions/Error"
            }
        }
    }
}

Nested Schema : errorDetails

Type: array

additional errors

Show Source

• Array of: object Error

{
    "type":"array",
    "description":"additional errors",
    "items":{
        "$ref":"#/definitions/Error"
    }
}

500 Response

Unexpected error.

Body ()

Root Schema : Error

Type: object

Show Source

• detail(optional): string
  Detailed error message
• errorCode(optional): string
  Application specific error code
• errorDetails(optional): array errorDetails
  additional errors
• errorPath(optional): string
• instance(optional): string
  URI to the link that provides more detail about the error
• status(optional): string
  HTTP status code
• title: string
  Summary error message
• type: string
  Error type

{
    "type":"object",
    "required":[
        "title",
        "type"
    ],
    "properties":{
        "type":{
            "type":"string",
            "description":"Error type"
        },
        "title":{
            "type":"string",
            "description":"Summary error message"
        },
        "detail":{
            "type":"string",
            "description":"Detailed error message"
        },
        "instance":{
            "type":"string",
            "description":"URI to the link that provides more detail about the error"
        },
        "errorCode":{
            "type":"string",
            "description":"Application specific error code"
        },
        "errorPath":{
            "type":"string"
        },
        "status":{
            "type":"string",
            "description":"HTTP status code"
        },
        "errorDetails":{
            "type":"array",
            "description":"additional errors",
            "items":{
                "$ref":"#/definitions/Error"
            }
        }
    }
}

Nested Schema : errorDetails

Type: array

additional errors

Show Source

• Array of: object Error

{
    "type":"array",
    "description":"additional errors",
    "items":{
        "$ref":"#/definitions/Error"
    }
}

Back to Top

Examples

The following example shows how to upload a custom artifact by submitting a POST request on the REST resource using cURL. For more information about cURL, see Use cURL.

curl -i -X POST 
-u apicsadmin:password
-H "Content-Type:multipart/form-data"
-F json=@artifact.json
-F artifact=@newArtifact.zip
https://example.com/apiplatform/administration/v1/artifacts

Example of Request Body

The following sample request body in JSON format (included with the request above in a file named artifact.json) contains metadata about the artifact you are uploading.

{
	"name": "newArtifact",
	"type": "zip",
	"version": "1",
	"revision": "1"
}

Example of Response Headers

The following shows an example of the response headers.

HTTP/1.1 204 No Content
Server: Oracle-Traffic-Director/12.2.1.0.0
Date: Mon, 02 Jan 2017 14:08:24 GMT
Content-length: 386
Content-type: application/json
X-oracle-dms-ecid: eD_kd0OmR00000000
X-oracle-dms-rid: 0:1
Via: 1.1 otd_opc
Proxy-agent: Oracle-Traffic-Director/12.2.1.0.0

Back to Top