Jump to

• Request
• Response
• Examples

Partially Update Artifact

patch

/appstore/publisher/v1/artifacts/{artifactId}

Partially Update an Artifact.

Request

Supported Media Types

• application/xml
• application/json

Path Parameters

• artifactId: integer(int64)
  artifact ID of the artifact to be updated.

Back to Top

Response

Supported Media Types

• application/json;qs=1
• application/xml;qs=.5

200 Response

Successful Operation

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object acknowledgement

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Acknowledgement"
    }
}

Nested Schema : acknowledgement

Type: object

Show Source

• contentURL(optional): string
• entityId(optional): string
• message(optional): string
• name(optional): string
• uri(optional): string

{
    "type":"object",
    "properties":{
        "message":{
            "type":"string"
        },
        "entityId":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "uri":{
            "type":"string"
        },
        "contentURL":{
            "type":"string"
        }
    },
    "xml":{
        "name":"acknowledgement"
    }
}

400 Response

Bad Request

401 Response

Not Authorized

404 Response

Entity Not Found

500 Response

System Error

Back to Top

Examples

The following example partially updates the artifact name of a partner, by submitting a PATCH request on the REST resource using cURL.

cURL Example

curl -X PATCH -H "X-Oracle-UserId: partner-email" -H "Authorization: Bearer Access-token" -H "Content-Type: multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW " -F "file=@file-path" -F "json=JSON-data-as-shown-in-following-example" "https://ocm-apis.cloud.oracle.com/appstore/publisher/v1/artifacts/15767211"

Request Header

X-Oracle-UserId: [e-mail] 
Authorization: Bearer Access-token 

Request Body

{
    "name":"terraform-oci-compute-instance1",
    "artifactProperties":[
        {
            "artifactTypePropertyName":"compartmentOCID",
            "value":"ocid1.compartment.region1..aaaaaaaa5ycdiq2xtxc5ttvjqp5jkplnh4xjcvnvx6sn75irg656efsn7uia"
        },
        {
            "artifactTypePropertyName":"ociTenancyID",
            "value":"16801898"
        },
        {
            "artifactTypePropertyName":"dstRealmImageMapping",
            "value":"OC2:test:test"
        },
        {
            "artifactTypePropertyName":"dstRealmImageMapping",
            "value":"OC3:test:test"
        },
        {
            "artifactTypePropertyName":"dstRealmImageMapping",
            "value":"OC4:test:test"
        }
    ],
    "compatibleShapes": [
        {
            "shape": "VM.Standard2.4",
            "ocpuConstraints": {
                "min":5,
                "max":6
            },
            "memoryConstraints": {
               "minInGBs":1,
               "maxInGBs":5
            }
        }
    ]
}

HTTP Status Code:

200 OK

JSON Response:

{
    "message":"Artifact was renamed.",
    "entityId":"15767211"
}

Back to Top