Jump to

• Request
• Response
• Examples

Artifact details

get

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

Get the artifact details for a given artifactId.

Request

Path Parameters

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

Back to Top

Response

Supported Media Types

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

200 Response

Successful Operation

Body ()

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"
        }
    }
}

400 Response

Bad Request

401 Response

Not Authorized

500 Response

System Error

Back to Top

Examples

The following example returns details of an artifact of a partner by submitting a GET request on the REST resource using cURL.

cURL Example

curl -X GET -H "X-Oracle-UserId: partner-email" -H "Authorization: Bearer Access-token" "https://ocm-apis.cloud.oracle.com/appstore/publisher/v1/artifacts/15805025"

Request Header

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

Request Body

None

HTTP Status Code:

200 OK

JSON Response:

{  
   "artifactId":15805025,
   "artifactType":"OCI Compute Image",
   "name":"MODX 2.6.5pl-1",
   "status":"Available",
   "lastModifiedBy":"John Doe",
   "lastModifiedDate":"2018-10-05T14:07:15.199Z",
   "createdBy":"John Doe",
   "creationDate":"2018-10-05T14:07:15.000Z",
   "source": {
        "regionCode": "us-ashburn-1",
        "uniqueIdentifier": "ocid1.image.oc1.iad.aaaaaaaaypp76pttzvhkmtxqhvojbczcvpw3diyozxevig3ybnig2vs4vpiq"
   },
   "replicatedRegions": [{
        "name": "us-ashburn-1",
        "status": "Available",
        "uniqueIdentifier": "ocid1.image.region1..aaaaaaaamd3z6t4cftcojuledcrmrkkhug642w4a33amsn75efdorm6q5guq"
   },
   {
        "name": "eu-frankfurt-1",
        "status": "Unavailable"
   },
   {
        "name": "us-phoenix-1",
        "status": "Unavailable"
    }],
   "artifactProperties":[  
      {  
         "artifactTypePropertyName":"compartmentOCID",
         "value":"ocid1.compartment.region1..aaaaaaaaelzb6xjh2zsebgziqnbsdva7sk4ngmfq3m3r2vcgwkss4efum7gq"
      },
      {  
         "artifactTypePropertyName":"ociTenancyID",
         "value":"15786747"
      }
   ],
   "uploadRequest":{},
   "compatibleShapes": [
      {
         "shape": "VM.Standard2.4",
         "ocpuConstraints": {
            "min": 5,
            "max": 6
         },
         "memoryConstraints": {
            "minInGBs": 1,
            "maxInGBs": 5
         }
      }
   ]
}

Back to Top