Jump to

• Request
• Response
• Examples

Create Artifact

post

/appstore/publisher/v1/artifacts

Create a Artifact.

Request

Supported Media Types

• application/xml
• application/json

Body ()

Provide the body with required information. Mandatory only when creating artifact of OCI Compute Image type. Provide FormDataMultiPart data while creating artifact of Terraform Template type. It consumes multipart/form-data

Root Schema : Artifact

Type: object

Show Source

• artifactId(optional): integer(int64)
• artifactProperties(optional): array artifactProperties
• artifactType(optional): string
• createdBy(optional): string
• creationDate(optional): string(date-time)
• lastModifiedBy(optional): string
• lastModifiedDate(optional): string(date-time)
• name(optional): string
• processingStatusNote(optional): string
• replicatedRegions(optional): array replicatedRegions
• source(optional): object ArtifactSource
• status(optional): string
• triggerImageValidation(optional): boolean
• uploadRequest(optional): object UploadRequest
• username(optional): string

{
    "type":"object",
    "properties":{
        "artifactId":{
            "type":"integer",
            "format":"int64"
        },
        "artifactType":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "status":{
            "type":"string"
        },
        "processingStatusNote":{
            "type":"string"
        },
        "lastModifiedBy":{
            "type":"string"
        },
        "lastModifiedDate":{
            "type":"string",
            "format":"date-time"
        },
        "createdBy":{
            "type":"string"
        },
        "creationDate":{
            "type":"string",
            "format":"date-time"
        },
        "username":{
            "type":"string"
        },
        "triggerImageValidation":{
            "type":"boolean"
        },
        "source":{
            "$ref":"#/definitions/ArtifactSource"
        },
        "replicatedRegions":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ArtifactRegion"
            }
        },
        "artifactProperties":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ArtifactProperty"
            }
        },
        "uploadRequest":{
            "$ref":"#/definitions/UploadRequest"
        }
    }
}

Nested Schema : artifactProperties

Type: array

Show Source

• Array of: object ArtifactProperty

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

Nested Schema : replicatedRegions

Type: array

Show Source

• Array of: object ArtifactRegion

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

Nested Schema : ArtifactSource

Type: object

Show Source

• regionCode(optional): string
• uniqueIdentifier(optional): string

{
    "type":"object",
    "properties":{
        "regionCode":{
            "type":"string"
        },
        "uniqueIdentifier":{
            "type":"string"
        }
    }
}

Nested Schema : UploadRequest

Type: object

Show Source

• artifactUploadRequestId(optional): integer(int64)
• fileName(optional): string
• numberOfMultiparts(optional): integer(int32)
• status(optional): string
• uploadParts(optional): array uploadParts

{
    "type":"object",
    "properties":{
        "artifactUploadRequestId":{
            "type":"integer",
            "format":"int64"
        },
        "numberOfMultiparts":{
            "type":"integer",
            "format":"int32"
        },
        "status":{
            "type":"string"
        },
        "fileName":{
            "type":"string"
        },
        "uploadParts":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/UploadPart"
            }
        }
    }
}

Nested Schema : ArtifactProperty

Type: object

Show Source

• artifactTypePropertyName(optional): string
• value(optional): string

{
    "type":"object",
    "properties":{
        "artifactTypePropertyName":{
            "type":"string"
        },
        "value":{
            "type":"string"
        }
    }
}

Nested Schema : ArtifactRegion

Type: object

Show Source

• name(optional): string
• status(optional): string
• uniqueIdentifier(optional): string
• uri(optional): string

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "status":{
            "type":"string"
        },
        "uri":{
            "type":"string"
        },
        "uniqueIdentifier":{
            "type":"string"
        }
    }
}

Nested Schema : uploadParts

Type: array

Show Source

• Array of: object UploadPart

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

Nested Schema : UploadPart

Type: object

Show Source

• partFileName(optional): string
• partNumber(optional): integer(int32)
• sizeInBytes(optional): integer(int64)

{
    "type":"object",
    "properties":{
        "partNumber":{
            "type":"integer",
            "format":"int32"
        },
        "partFileName":{
            "type":"string"
        },
        "sizeInBytes":{
            "type":"integer",
            "format":"int64"
        }
    }
}

Back to Top

Response

Supported Media Types

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

200 Response

Successful Operation

Body ()

Root 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

Invalid Parameter Value/Bad Request

401 Response

Not Authorized

500 Response

System Error

Back to Top

Examples

The following example creates a new artifact for a partner and return the newly created artifact ID by submitting a POST request on the REST resource using cURL.

cURL Example

curl -X POST -H "X-Oracle-UserId: partner-email" -H "Content-Type: application/json" -H "Authorization: Bearer Access-token -d JSON-data-as-shown-in-below-example' "https://ocm-apis.cloud.oracle.com/appstore/publisher/v1/artifacts"

Request Header

X-Oracle-UserId: [e-mail]
Authorization: Bearer Access-token
Content-Type: application/json

Request Body

{  
   "name":"OCI_Image_test1",
   "artifactType":"OCI_COMPUTE_IMAGE",
   "source" : {
        "regionCode": "us-ashburn-1",
        "uniqueIdentifier": "ocid1.image.oc1.iad.aaaaaaaaypp76pttzvhkmtxqhvojbczcvpw3diyozxevig3ybnig2vs4vpiq"
   },
   "artifactProperties":[  
      {  
         "artifactTypePropertyName":"compartmentOCID",
         "value":"ocid1.compartment.region1..aaaaaaaa3wbgnc7d4644drvokszlp6usigamqdwzofzb2qjdxfwvxf6od5jq"
      },
      {  
         "artifactTypePropertyName":"ociTenancyID",
         "value":"15786747"
      }
   ],
   "compatibleShapes": [
       {
           "shape": "VM.Standard2.1",
           "ocpuConstraints": {
               "min":5,
               "max":6
           },
           "memoryConstraints": {
              "minInGBs":1,
              "maxInGBs":5
           }
       },
       {
           "shape": "VM.Standard2.2"
       }
   ]
}

HTTP Status Code:

201 Created

JSON Response:

{  
   "message":"OK",
   "entityId":"15812945"
}

Back to Top