Jump to

• Request
• Response
• Examples

List of Status comments

get

/appstore/publisher/v1/applications/{listingVersionId}/comments

Get the status comments for the application.

Request

Path Parameters

• listingVersionId: integer(int64)
  Unique identifier of the application for which to return status comments

Query Parameters

• limit: 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: 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/StatusComment"
            }
        },
        "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 StatusComment

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

Nested Schema : link

Type: array

Show Source

• Array of: object Link

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

Nested Schema : StatusComment

Type: object

Show Source

• createdBy(optional): string
• creationDate(optional): string(date-time)
• status(optional): string
• statusNote(optional): string
• statusNoteId(optional): integer(int64)

{
    "type":"object",
    "properties":{
        "createdBy":{
            "type":"string"
        },
        "statusNoteId":{
            "type":"integer",
            "format":"int64"
        },
        "creationDate":{
            "type":"string",
            "format":"date-time"
        },
        "statusNote":{
            "type":"string"
        },
        "status":{
            "type":"string"
        }
    },
    "xml":{
        "name":"StatusComment"
    }
}

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 a list of status comments for a listing, 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/applications/8574381/comments"

Request Header

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

Request Body

None

HTTP Status Code:

200 OK

JSON Response:

{
  "items": [
     {
       "comment": {
         "statusNoteId": 8574507,
         "createdBy": "fname lname",
         "creationDate": "2017-12-19T12:02:46.000Z",
         "statusNote": "Status Changed",
         "status": "New"
       }
     }
  ],
  "hasMore": false,
  "count": 1,
  "totalResults": 1,
  "links": [
    {
      "rel": "CANONICAL",
      "href": "https://ocm-apis.cloud.oracle.com/appstore/publisher/v1/applications/8574381/comments"
    },
    {
      "rel": "SELF",
      "href": "https://ocm-apis.cloud.oracle.com/appstore/publisher/v1/applications/8574381/comments"
    }
  ]
}

Back to Top