Jump to

• Request
• Response
• Examples

Artifacts

get

/appstore/publisher/v1/artifacts

Get the list of Artifacts.

Request

Query Parameters

• artifactTypeCode(optional): string
  This parameter filters the artifacts based on type. Possible values are TERRAFORM_TEMPLATE and OCI_COMPUTe_IMAGE
• name(optional): string
  This parameter filters the list on the given name value
• offset(optional): integer(int32)
  Offset and limit together determine how many records to return from the collection. Offset is the starting index of the records to return, which should be greater than or equal to zero (default=0).
• orderby(optional): string
  This property sorts the result set. Acceptable values are NAME, LASTUPDATEDATE.
• sortorder(optional): string
  This property specifies the order in which to sort the result set. Acceptable values are ASC and DESC.
• status(optional): string
  This parameter filters the artifacts based on its status. Possible values are AVAILABLE,UNAVAILABLE and IN_PROGRESS

Back to Top

Response

Supported Media Types

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

200 Response

Successful Operation

Body ()

Root Schema : Artifacts

Type: object

Show Source

• artifactId(optional): integer(int64)
• artifactType(optional): string
• createdBy(optional): string
• creationDate(optional): string(date-time)
• lastModifiedBy(optional): string
• lastModifiedDate(optional): string(date-time)
• links(optional): array link
• name(optional): string
• status(optional): string
• username(optional): string

{
    "type":"object",
    "properties":{
        "artifactId":{
            "type":"integer",
            "format":"int64"
        },
        "artifactType":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "status":{
            "type":"string"
        },
        "lastModifiedBy":{
            "type":"string"
        },
        "lastModifiedDate":{
            "type":"string",
            "format":"date-time"
        },
        "createdBy":{
            "type":"string"
        },
        "creationDate":{
            "type":"string",
            "format":"date-time"
        },
        "username":{
            "type":"string"
        },
        "links":{
            "type":"array",
            "xml":{
                "name":"link",
                "wrapped":true
            },
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    }
}

Nested Schema : link

Type: array

Show Source

• Array of: object Link

{
    "type":"array",
    "xml":{
        "name":"link",
        "wrapped":true
    },
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : Link

Type: object

Show Source

• href(optional): string
• rel(optional): string
  Allowed Values: [ "SELF", "CANONICAL", "NEXT", "TEMPLATE", "PREV" ]

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string",
            "xml":{
                "attribute":true
            },
            "enum":[
                "SELF",
                "CANONICAL",
                "NEXT",
                "TEMPLATE",
                "PREV"
            ]
        },
        "href":{
            "type":"string",
            "xml":{
                "attribute":true
            }
        }
    }
}

400 Response

Bad Request

401 Response

Not Authorized

500 Response

System Error

Back to Top

Examples

The following example returns the list of all artifacts belonging to 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?offset=0&orderby=creation_date&sortorder=desc&limit=3"

Request Header

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

Request Body

   None

HTTP Status Code:

200 OK

JSON Response:

{  
   "items":[  
      {  
         "Artifact":{  
            "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"
         }
      },
      {  
         "Artifact":{  
            "artifactId":15800422,
            "artifactType":"Terraform Template",
            "name":"wordpress",
            "status":"Available",
            "processingStatusNote":"The artifact has been successfully created",
            "lastModifiedBy":"anonymous",
            "lastModifiedDate":"2018-10-03T20:13:39.000Z",
            "createdBy":"John Doe",
            "creationDate":"2018-10-03T20:13:35.000Z"
         }
      },      
      {  
         "Artifact":{  
            "artifactId":15764845,
            "artifactType":"Terraform Template",
            "name":"terraform-oci-kafka",
            "status":"Available",
            "processingStatusNote":"The artifact has been successfully created",
            "lastModifiedBy":"anonymous",
            "lastModifiedDate":"2018-09-17T09:41:57.000Z",
            "createdBy":"Admin Appstore",
            "creationDate":"2018-09-17T09:41:52.000Z"
         }
      },
      {  
         "Artifact":{  
            "artifactId":15764840,
            "artifactType":"Terraform Template",
            "name":"terraform-oci-jenkins",
            "status":"Available",
            "processingStatusNote":"The artifact has been successfully created",
            "lastModifiedBy":"anonymous",
            "lastModifiedDate":"2018-09-17T09:41:21.000Z",
            "createdBy":"Admin Appstore",
            "creationDate":"2018-09-17T09:41:20.000Z"
         }
      }
   ],
   "hasMore":true,
   "count":3,
   "totalResults":120,
   "links":[  
      {  
         "rel":"CANONICAL",
         "href":"https://ocm-apis.us.oracle.com/appstore/publisher/v1/artifacts"
      },
      {  
         "rel":"SELF",
         "href":"https://ocm-apis.us.oracle.com/appstore/publisher/v1/artifacts?offset=0&orderby=creation_date&sortorder=desc&limit=3"
      },
      {  
         "rel":"NEXT",
         "href":"https://ocm-apis.us.oracle.com/appstore/publisher/v1/artifacts?offset=3&orderby=creation_date&sortorder=desc&limit=20"
      }
   ]
}

Back to Top