Jump to

• Request
• Response
• Examples

Get list of machine images from data centers.

get

/appstore/publisher/v1/storageimages

Get a list of all the machine images available in default data center. Other data center names can be passed in query param, if user wants to fetch details from other data centers.

Request

Query Parameters

• datacenter(optional): string
  This is to specify from which all data centers machine image details need to be fetched. If no value is specified, details from default data center will be provided
• keyword(optional): string
  This is a filter option to filter the result set based on the keyword specified. Keyword value will be matched with Name, Version and Operating System
• limit(optional): integer(int32)
  Limit tells how many records to return (starting from the offset). Limit should be greater than zero and less than or equal to 100 (default=30).
• 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).

Back to Top

Response

Supported Media Types

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

200 Response

Successful Operation

Body ()

Root Schema : collection

Type: object

Show Source

• count(optional): integer(int32)
• hasMore(optional): boolean
  Default Value: false
• items(optional): array items
• links(optional): array link
• totalResults(optional): integer(int32)

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "xml":{
                "name":"items",
                "wrapped":true
            },
            "items":{
                "$ref":"#/definitions/MachineImageUploadRequest"
            }
        },
        "hasMore":{
            "type":"boolean",
            "default":false
        },
        "count":{
            "type":"integer",
            "format":"int32"
        },
        "totalResults":{
            "type":"integer",
            "format":"int32"
        },
        "links":{
            "type":"array",
            "xml":{
                "name":"link",
                "wrapped":true
            },
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "xml":{
        "name":"collection"
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object MachineImageUploadRequest

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

Nested Schema : link

Type: array

Show Source

• Array of: object Link

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

Nested Schema : MachineImageUploadRequest

Type: object

Show Source

• application(optional): string
• checkSum(optional): string
• createdBy(optional): string
• createdDate(optional): string
• dataCenterImageUploadRequests(optional): array dataCenterImageUploadRequests
• fileName(optional): string
• imageFilePath(optional): string
• lastModifiedBy(optional): string
• lastModifiedDate(optional): string
• operatingSystem(optional): string
• overwriteStorageFile(optional): boolean
• pendingChunks(optional): integer(int32)
• statusName(optional): string
• uploadedChunks(optional): integer(int32)
• uploadRequestId(optional): integer(int64)
• version(optional): string

{
    "type":"object",
    "properties":{
        "uploadRequestId":{
            "type":"integer",
            "format":"int64"
        },
        "application":{
            "type":"string"
        },
        "version":{
            "type":"string"
        },
        "operatingSystem":{
            "type":"string"
        },
        "fileName":{
            "type":"string"
        },
        "imageFilePath":{
            "type":"string"
        },
        "checkSum":{
            "type":"string"
        },
        "statusName":{
            "type":"string"
        },
        "uploadedChunks":{
            "type":"integer",
            "format":"int32"
        },
        "pendingChunks":{
            "type":"integer",
            "format":"int32"
        },
        "createdBy":{
            "type":"string"
        },
        "createdDate":{
            "type":"string"
        },
        "lastModifiedBy":{
            "type":"string"
        },
        "lastModifiedDate":{
            "type":"string"
        },
        "overwriteStorageFile":{
            "type":"boolean"
        },
        "dataCenterImageUploadRequests":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/DataCenterImageUploadRequest"
            }
        }
    }
}

Nested Schema : dataCenterImageUploadRequests

Type: array

Show Source

• Array of: object DataCenterImageUploadRequest

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

Nested Schema : DataCenterImageUploadRequest

Type: object

Show Source

• copyUpload(optional): boolean
• dataCenterName(optional): string
• lastUpdatedDate(optional): string
• overwriteUpload(optional): boolean
• region(optional): string
• replicateDataCenter(optional): boolean
• statusName(optional): string
• uploadProgress(optional): string

{
    "type":"object",
    "properties":{
        "dataCenterName":{
            "type":"string"
        },
        "statusName":{
            "type":"string"
        },
        "uploadProgress":{
            "type":"string"
        },
        "region":{
            "type":"string"
        },
        "lastUpdatedDate":{
            "type":"string"
        },
        "copyUpload":{
            "type":"boolean"
        },
        "overwriteUpload":{
            "type":"boolean"
        },
        "replicateDataCenter":{
            "type":"boolean"
        }
    }
}

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

Invalid Parameter Value

401 Response

Not Authorized

404 Response

Entity Not Found

500 Response

System Error

Back to Top

Examples

The following example fetches all the machineimage details from data centers, 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/storageimages"

Request Header

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

Request Body

None

HTTP Status Code:

200 OK

JSON Response:

{
  "items": [
    {
            "machineimage": {
                "application": "111",
                "version": "111",
                "operatingSystem": "111",
                "fileName": "jaxrs-ri-2.22.1.gz",
                "imageFilePath": "mi/111/111/111/jaxrs-ri-2.22.1.gz",
                "lastModifiedDate": "Apr 25, 2017 at 04:25 PM UTC"
            }
        },
        {
            "machineimage": {
                "application": "121212",
                "version": "121212",
                "operatingSystem": "121212",
                "fileName": "jaxrs-ri-2.22.1.gz",
                "imageFilePath": "mi/121212/121212/121212/jaxrs-ri-2.22.1.gz",
                "lastModifiedDate": "Apr 24, 2017 at 12:19 PM UTC"
            }
        }
  ],
  "hasMore": false,
  "count": 2,
  "totalResults": 2,
  "links": [
    {
      "rel": "CANONICAL",
      "href": "https://ocm-apis.cloud.oracle.com/appstore/publisher/v1/storageimages"
    },
    {
      "rel": "SELF",
      "href": "https://ocm-apis.cloud.oracle.com/appstore/publisher/v1/storageimages"
    }
  ]
}

Back to Top