Jump to

• Request
• Response
• Examples

Machine Image Upload Request Search

get

/appstore/publisher/v1/machineimages

Get the list of machine image upload requests

Request

Query Parameters

• keyword(optional): string
  This is a filter option to filter the result set based on the keyword specified
• 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).
• machineimagestatus(optional): string
  This is a filter option to filter the result set based on the specified machineimage statuses. It accepts multiple comma seperated values. Acceptable values are COMPLETED, DELETED, DELECTION FAILED, FAILED, IN PROGESS, INITIATED, PENDING, REJECTED, VIRUS SCAN IN PROGRESS
• 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 and LASTUPDATEDATE
• sortorder(optional): string
  This property specifies the order in which to sort the result set. Acceptable values are ASC and DESC.

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 machineimages, 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/machineimages?keyword=2016&limit=1"

Request Header

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

Request Body

None

HTTP Status Code:

200 OK

JSON Response:

{
  "items": [
    {
    "machineimage": {
      "uploadRequestId": 2684317,
      "application": "2016-April-0330",
      "version": "9.0",
      "operatingSystem": "linux",
      "fileName": "TestCrome.gz",
      "statusName": "Pending",
      "createdBy": "Fname Lname",
      "createdDate": "Mon, 04 Apr 2016 12:08:59 GMT",
      "lastModifiedBy": "Fname Lname",
      "lastModifiedDate": "2017-02-22T11:06:59.001Z"
      }
    },
    {
    "machineimage": {
      "uploadRequestId": 2684283,
      "application": "2016-April-0330",
      "version": "9.0",
      "operatingSystem": "linux",
      "fileName": "TestCrome.gz",
      "statusName": "Initiated",
      "createdBy": "Fname Lname",
      "createdDate": "Mon, 04 Apr 2016 11:54:21 GMT",
      "lastModifiedBy": "Fname Lname",
      "lastModifiedDate": "2017-02-22T11:06:59.001Z"
      }
    }
  ],
  "hasMore": false,
  "count": 2,
  "totalResults": 2,
  "links": [
    {
      "rel": "CANONICAL",
      "href": "https://ocm-apis.cloud.oracle.com/appstore/publisher/v1/machineimages"
    },
    {
      "rel": "SELF",
      "href": "https://ocm-apis.cloud.oracle.com/appstore/publisher/v1/machineimages?keyword=2016&limit=2"
    }
  ]
}

Back to Top