Jump to

• Request
• Response

listOrganizations

get

/ccstore/v1/organizations

List Organizations. This operation is used to get the collection of customer organizations from Oracle Commerce Cloud. It can also be used to return the list on a searched string and in a sorted order against various properties of organization.Optionally takes the X-CCOrganization header to specify current Organization id of logged in user.

Request

Supported Media Types

• application/json

Query Parameters

• includeDetails: boolean
  Set to true to include all attributes and properties of the organizations in the response. Default is false.

  Default Value: false
• includeUserRoles: boolean
  Set to true to include the roles of the currently logged-in user across all organizations they are part of. Default is false.

  Default Value: false
• limit: string
  This is the field to determine number of records to be fetched per REST call.
• offset: string
  This field determines the offset/starting index from which data to be fetched.
• q: string
  Query string built as per the SCIM standards that helps to search entered string across account properties like 'name'.
• sort: string
  This field determines the sort order of the list to be fetched.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Following model is returned when operation succeeds.

Body ()

Root Schema : listOrganizations_response

Type: object

Show Source

• items: array items
  list of organizations
• limit: string
  Number of records to be fetched.
• offset: string
  The offset provided.
• total: string
  Total number of records present in database matching the searched string.
• totalResults: string
  Total number of records present in database matching the searched string.

{
    "properties":{
        "total":{
            "description":"Total number of records present in database matching the searched string.",
            "type":"string"
        },
        "totalResults":{
            "description":"Total number of records present in database matching the searched string.",
            "type":"string"
        },
        "offset":{
            "description":"The offset provided.",
            "type":"string"
        },
        "limit":{
            "description":"Number of records to be fetched.",
            "type":"string"
        },
        "items":{
            "description":"list of organizations",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "name":{
                        "description":"The name for Organization",
                        "type":"string"
                    },
                    "repositoryId":{
                        "description":"repository Id of the Organization",
                        "type":"string"
                    },
                    "active":{
                        "description":"Active status of an Organization. Should be true or false. By default the value is set to true",
                        "type":"boolean"
                    },
                    "id":{
                        "description":"Id of the Organization",
                        "type":"string"
                    },
                    "externalOrganizationId":{
                        "description":"External organization id",
                        "type":"string"
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: array

list of organizations

Show Source

• Array of: object items

{
    "description":"list of organizations",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "name":{
                "description":"The name for Organization",
                "type":"string"
            },
            "repositoryId":{
                "description":"repository Id of the Organization",
                "type":"string"
            },
            "active":{
                "description":"Active status of an Organization. Should be true or false. By default the value is set to true",
                "type":"boolean"
            },
            "id":{
                "description":"Id of the Organization",
                "type":"string"
            },
            "externalOrganizationId":{
                "description":"External organization id",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• active: boolean
  Active status of an Organization. Should be true or false. By default the value is set to true
• externalOrganizationId: string
  External organization id
• id: string
  Id of the Organization
• name: string
  The name for Organization
• repositoryId: string
  repository Id of the Organization

{
    "type":"object",
    "properties":{
        "name":{
            "description":"The name for Organization",
            "type":"string"
        },
        "repositoryId":{
            "description":"repository Id of the Organization",
            "type":"string"
        },
        "active":{
            "description":"Active status of an Organization. Should be true or false. By default the value is set to true",
            "type":"boolean"
        },
        "id":{
            "description":"Id of the Organization",
            "type":"string"
        },
        "externalOrganizationId":{
            "description":"External organization id",
            "type":"string"
        }
    }
}

Example Response (application/json)

{
    "total":1,
    "totalResults":1,
    "offset":0,
    "limit":1,
    "links":[
        {
            "rel":"self",
            "href":"http://localhost:8080/ccstoreui/v1/organizations?members=bb-110034"
        }
    ],
    "sort":[
        {
            "property":"name",
            "order":"asc"
        }
    ],
    "items":[
        {
            "name":"National Discount Auto Parts",
            "repositoryId":"or-100001",
            "active":true,
            "id":"or-100001",
            "externalOrganizationId":"EXT_ORG_1"
        }
    ]
}

Default Response

The error response. The following are the internal error codes thrown by this API when the request processing fails in Oracle Commerce Cloud: |Error Code|Description| |------------------|------------------| |100070|Invalid Query Expression.| |10002|The value x for parameter 'y' is invalid. 'y' can be 'limit', 'offset' or 'sort'.| |100018|If invalid input is passed.| |100019|If there was any internal error while getting organizations list.|

Body ()

Root Schema : errorModel

Type: object

Show Source

• devMessage: string
  An optional non-localized message containing technical information for developers
• errorCode: string
  The numerical code identifying the error
• errors: array errors
  An optional list of errors if multiple errors were encountered
• message: string
  The localized message describing the error
• moreInfo: string
  An optional non-localized message with more information
• o:errorPath: string
  An optional machine readable description of where the error occurred
• status: string
  The HTTP status code
• type: string
  The URI to the HTTP state code definition

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "type":{
            "description":"The URI to the HTTP state code definition",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "errors":{
            "description":"An optional list of errors if multiple errors were encountered",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "errorCode":{
                        "description":"The numerical code identifying the error",
                        "type":"string"
                    },
                    "message":{
                        "description":"The localized message describing the error",
                        "type":"string"
                    },
                    "devMessage":{
                        "description":"An optional non-localized message containing technical information for developers",
                        "type":"string"
                    },
                    "moreInfo":{
                        "description":"An optional non-localized message with more information",
                        "type":"string"
                    },
                    "o:errorPath":{
                        "description":"An optional machine readable description of where the error occurred",
                        "type":"string"
                    },
                    "status":{
                        "description":"The HTTP status code",
                        "type":"string"
                    }
                }
            }
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Nested Schema : errors

Type: array

An optional list of errors if multiple errors were encountered

Show Source

• Array of: object items

{
    "description":"An optional list of errors if multiple errors were encountered",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "errorCode":{
                "description":"The numerical code identifying the error",
                "type":"string"
            },
            "message":{
                "description":"The localized message describing the error",
                "type":"string"
            },
            "devMessage":{
                "description":"An optional non-localized message containing technical information for developers",
                "type":"string"
            },
            "moreInfo":{
                "description":"An optional non-localized message with more information",
                "type":"string"
            },
            "o:errorPath":{
                "description":"An optional machine readable description of where the error occurred",
                "type":"string"
            },
            "status":{
                "description":"The HTTP status code",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• devMessage: string
  An optional non-localized message containing technical information for developers
• errorCode: string
  The numerical code identifying the error
• message: string
  The localized message describing the error
• moreInfo: string
  An optional non-localized message with more information
• o:errorPath: string
  An optional machine readable description of where the error occurred
• status: string
  The HTTP status code

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Back to Top