1. REST API for Oracle Commerce Cloud December 2017
  2. Tasks
  3. Admin
  4. Organizations

Get site based Organization properties

get

/ccadmin/v1/organizations/{id}/siteOrganizationProperties

Get Organization. This operation is used to list the site based Organization properties from Oracle Commerce Cloud.

Request

Supported Media Types
  • application/json
Path Parameters
id
Type: string
Required: true
The ID of the Organization.
Query Parameters
allSites
Type: string
Its a Boolean parameter. if its value is true then it includes all b2b sites in the response. If false then returns only sites of current and parent account
include
Type: string
Currently (nullContracts ,notnullContracts , "" ) are supported values for this param. nullContracts - returns sites with only null contracts notNullContracts - returns sites only with not null contracts. If equals "'" - it returns both null and not null contracts
limit
Type: string
This is the field to determine number of records to be fetched per REST call.
offset
Type: string
This field determines the offset/starting index from which data to be fetched.
searchText
Type: string
Text that will be search across site, contract, price group, catalog
sort
Type: string
This field determines the sort order of the list to be fetched.

Response

Supported Media Types
  • application/json
200 Response
Following model is returned when operation succeeds.
Body
Root Schema : siteOrganizationProperties_response
Nested Schema : items
Type: array
list of Site Organization Properties
Nested Schema : items
Type: object
Nested Schema : inherited
Type: object
Inherited property information
Nested Schema : site
Type: object
Site information
Nested Schema : contract
Type: object
Contract
Nested Schema : catalog
Type: object
Catalog associated with contract
Nested Schema : priceListGroup
Type: object
Price ListGroup associated with contract
Example application/json

{
    "total":1,
    "totalResults":1,
    "offset":0,
    "limit":1,
    "links":[
        {
            "rel":"self",
            "href":"http://localhost:9080/ccadmin/v1/organizations/100001/siteOrganizationProperties?allSites=true"
        }
    ],
    "items":[
        {
            "site":{
                "productionURL":null,
                "name":"CloudLake US Site test",
                "id":"200002",
                "enabled":false
            },
            "inherited":{
                "approvalRequired":false,
                "contract":false,
                "delegateApprovalManagement":false,
                "orderPriceLimit":null
            },
            "properties":{
                "approvalRequired":false,
                "contract":{
                    "catalog":{
                        "displayName":"Master Catalog",
                        "repositoryId":"cloudCatalog"
                    },
                    "displayName":"20002 site",
                    "repositoryId":"400001",
                    "priceListGroup":{
                        "displayName":"Default Price Group",
                        "repositoryId":"defaultPriceGroup"
                    }
                },
                "delegateApprovalManagement":false,
                "useExternalApprovalWebhook":false,
                "orderPriceLimit":null
            }
        }
    ]
}
Default Response
The error response 100105 : Error while fetching site account properties 100106 : Invalid sort property 'sortString'. Allowed sort properties are [site, contract, catalog, priceListGroup] 100107 : Invalid input: 'inputOrgId' 100108 : Invalid organization id for fetching site account properties
Body
Root Schema : errorModel
Type: object
Nested Schema : errors
Type: array
An optional list of errors if multiple errors were encountered
Nested Schema : items
Type: object

Examples

Sample Response Payload returned by endpoint:

{
  "total": 1,
  "totalResults": 1,
  "offset": 0,
  "limit": 1,
  "links": [{
    "rel": "self",
    "href": "http://localhost:9080/ccadmin/v1/organizations/100001/siteOrganizationProperties?allSites=true"
  }],
  "items": [{
    "site": {
      "productionURL": null,
      "name": "CloudLake US Site test",
      "id": "200002",
      "enabled": false
    },
    "inherited": {
      "approvalRequired": false,
      "contract": false,
      "delegateApprovalManagement": false,
      "orderPriceLimit": null
    },
    "properties": {
      "approvalRequired": false,
      "contract": {
        "catalog": {
          "displayName": "Master Catalog",
          "repositoryId": "cloudCatalog"
        },
        "displayName": "20002 site",
        "repositoryId": "400001",
        "priceListGroup": {
          "displayName": "Default Price Group",
          "repositoryId": "defaultPriceGroup"
        }
      },
      "delegateApprovalManagement": false,
      "useExternalApprovalWebhook": false,
      "orderPriceLimit": null
    }
  }]
}