Jump to

• Request
• Response
• Examples

List of partners

get

/appstore/publisher/v1/users/{id}/partners

Fetch all the partners for the admins to impersonate.

Request

Path Parameters

• id: integer(int64)
  User Id of a valid admin user with partner-access enabled.

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

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

Nested Schema : link

Type: array

Show Source

• Array of: object Link

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

Nested Schema : Partner

Type: object

Show Source

• name(optional): string
• partnerId(optional): integer(int64)

{
    "type":"object",
    "properties":{
        "partnerId":{
            "type":"integer",
            "format":"int64"
        },
        "name":{
            "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
            }
        }
    }
}

401 Response

Not Authorized

404 Response

Entity Not Found

500 Response

System Error

Back to Top

Examples

The following example returns a list of all the partners, by submitting a GET request on the REST resource using cURL.

cURL Example

curl -X GET -H "X-Oracle-UserId:>admin-email" -H "Authorization: Bearer Access-token" "https://ocm-apis.cloud.oracle.com/appstore/publisher/v1/users/{id}/partners"

Request Header

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

Request Body

None

HTTP Status Code:

200 OK

JSON Response:

{
    "items": [
        {
            "partner": {
                "partnerId": 7079475,
                "name": "12c REST Partner"
            }
        },
        {
            "partner": {
                "partnerId": 1311448,
                "name": "2LA SRL"
            }
        }
    ],
    "hasMore": true,
    "count": 2,
    "totalResults": 2,
    "links": [
        {
            "rel": "CANONICAL",
            "href": "https://ocm-apis.cloud.oracle.com/appstore/publisher/v1/users/7217027/partners"
        },
        {
            "rel": "SELF",
            "href": "https://ocm-apis.cloud.oracle.com/appstore/publisher/v1/users/7217027/partners"
        },
        {
            "rel": "NEXT",
            "href": "https://ocm-apis.cloud.oracle.com/appstore/publisher/v1/users/7217027/partners?offset=20"
        }
    ]
}

Back to Top