Jump to

• Request
• Response
• Examples

App Install Request

get

/appstore/publisher/v1/installrequests

Get the list of application install requests for all your published apps.

Request

Query Parameters

• installstatus(optional): string
  This is a filter option used to get the result set with the specified installation status. Allowed statuses are SUBMITTED, STARTED, INSTALLED, INSTALLATION_IN_PROGRESS, PENDING_APPROVAL, FAILED, DOWNLOADED
• installtype(optional): string
  This is a filter option used to get the result set with the specified install type. Allowed install types are PRODUCTION and TEST
• 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).
• listingid(optional): integer(int64)
  This is a filter option used to get the result set with the specified listing ID.
• listingname(optional): string
  This is a filter option used to get the result set with the specified listing name
• 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).
• requestedonrangeend(optional): string
  This is a filter option used to get the result set before the specified date.
• requestedonrangestart(optional): string
  This is a filter option used to get the result set after the specified date.

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/AppInstallRequest"
            }
        },
        "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 installRequest

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

Nested Schema : link

Type: array

Show Source

• Array of: object Link

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

Nested Schema : installRequest

Type: object

Show Source

• companyName(optional): string
• email(optional): string
• firstName(optional): string
• installType(optional): string
• lastName(optional): string
• links(optional): array link
• listingName(optional): string
• oracleTcId(optional): integer(int64)
• partnerTcId(optional): integer(int64)
• requestedDate(optional): string(date-time)
• status(optional): string
• tasErrorHierarchy(optional): object TasErrorHierarchy
• tasErrorId(optional): integer(int64)

{
    "type":"object",
    "properties":{
        "installType":{
            "type":"string"
        },
        "listingName":{
            "type":"string"
        },
        "status":{
            "type":"string"
        },
        "email":{
            "type":"string"
        },
        "firstName":{
            "type":"string"
        },
        "lastName":{
            "type":"string"
        },
        "oracleTcId":{
            "type":"integer",
            "format":"int64"
        },
        "partnerTcId":{
            "type":"integer",
            "format":"int64"
        },
        "requestedDate":{
            "type":"string",
            "format":"date-time"
        },
        "companyName":{
            "type":"string"
        },
        "tasErrorId":{
            "type":"integer",
            "format":"int64"
        },
        "tasErrorHierarchy":{
            "$ref":"#/definitions/TasErrorHierarchy"
        },
        "links":{
            "type":"array",
            "xml":{
                "name":"link",
                "wrapped":true
            },
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "xml":{
        "name":"installRequest"
    }
}

Nested Schema : link

Type: array

Show Source

• Array of: object Link

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

Nested Schema : TasErrorHierarchy

Type: object

Show Source

• detail(optional): string
• errorCode(optional): string
• errorKey(optional): string
• errorKeyArg0(optional): string
• errorMessage(optional): string
• errorPath(optional): string
• id(optional): integer(int64)
• instance(optional): string
• partnerId(optional): integer(int64)
• status(optional): string
• title(optional): string
• type(optional): string

{
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "status":{
            "type":"string"
        },
        "detail":{
            "type":"string"
        },
        "instance":{
            "type":"string"
        },
        "errorCode":{
            "type":"string"
        },
        "errorPath":{
            "type":"string"
        },
        "partnerId":{
            "type":"integer",
            "format":"int64"
        },
        "id":{
            "type":"integer",
            "format":"int64"
        },
        "errorMessage":{
            "type":"string"
        },
        "errorKey":{
            "type":"string"
        },
        "errorKeyArg0":{
            "type":"string"
        }
    }
}

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/Bad Request

401 Response

Not Authorized

500 Response

System Error

Back to Top

Examples

The following example gets a list of install requests by a publisher, 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/installrequests?installstatus=FAILED&requestedOnRangeStart=2015-01-01&requestedOnRangeEnd=2016-06-01&listingid=233434&limit=1"

Request Header

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

Request Body

None

HTTP Status Code:

200 OK

JSON Response:

{    
    "items": [
    {
      "installRequest": {
         "installtype": "TEST",
                "listingName": "Test_App_17_10_12_try_001",
                "status": "Started",
                "email": "[e-mail]",
                "firstName": "Stephen",
                "lastName": "Cross",
                "oracleTncId": 2526247,
                "partnerTncId": 3200417,
                "requestedDate": "2015-06-08T21:22:41.000Z",
                "companyName": "Marketplace Technologies Bangalore",
                "tasErrorId": 2734888,
                "tasErrorHierarchy": {
                    "type": null,
                    "title": "Unable to connect to Marketplace server to retrive template data",
                    "status": "null",
                    "detail": "Unable to connect to Marketplace server to retrive template data",
                    "instance": null,
                    "errorCode": "InternalError",
                    "errorPath": null,
                    "parentId": null,
                    "id": 2734888,
                    "errorMessage": "We can't complete the provisioning of your app because our system encountered an unexpected error. 
 Try again later. If the problem continues, send an email to [e-mail]. We'll do our best to help.",
                    "errorKey": "oracle.cloud.appstore.getapp.genericError",
                    "errorKeyArg0": "[e-mail]",
                    "errorKeyArg1": null,
                    "errorKeyArg2": null,
                    "errorKeyArg3": null,
                    "errorKeyArg4": null
                }
      }
    }
  ],
  "hasMore": true,
  "count": 1,
  "totalResults": 11,
  "links": [
    {
      "rel": "CANONICAL",
      "href": "https://ocm-apis.cloud.oracle.com/appstore/publisher/v1/installrequests"
    },
    {
      "rel": "SELF",
      "href": "https://ocm-apis.cloud.oracle.com/appstore/publisher/v1/installrequests?installstatus=FAILED=30=233434=1"
    },
    {
      "rel": "NEXT",
      "href": "https://ocm-apis.cloud.oracle.com/appstore/publisher/v1/installrequests?requestdate=30=FAILED=233434=1=1"
    }
  ]
}

Back to Top