Get site based Organization properties
get
/ccapp/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(required): string
The ID of the Organization.
Query Parameters
-
allSites: 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: 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: 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.
-
searchText : string
Text that will be search across site, contract, price group, catalog
-
sort: 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.
Root Schema : siteOrganizationProperties_response
Type:
Show Source
object
-
items:
array items
list of Site Organization Properties
-
limit:
integer
Number of records to be fetched.
-
offset:
integer
The offset provided.
-
total:
integer
Total number of records present in database matching the searched string.
-
totalResults:
integer
Total number of records present in database matching the searched string.
Nested Schema : items
Type:
Show Source
object
-
inherited:
object inherited
Inherited property information
-
properties:
number
Site based properties
-
site:
object site
Site information
Nested Schema : inherited
Type:
object
Inherited property information
Show Source
-
approvalRequired:
boolean
A boolean flag to indicate whether this property is inherited or not, if true then it is inherited
-
contract:
boolean
A boolean flag to indicate whether this property is inherited or not, if true then it is inherited
-
delegateApprovalManagement:
boolean
A boolean flag to indicate whether this property is inherited or not, if true then it is inherited
-
orderPriceLimit:
number
A boolean flag to indicate whether this property is inherited or not, if true then it is inherited
Nested Schema : site
Type:
object
Site information
Show Source
-
enabled:
boolean
The enabled flag for the site
-
id:
string
The id for Site
-
name:
string
The name for the site
-
productionURL:
string
The production url of the site
Nested Schema : contract
Type:
object
Contract
Show Source
-
catalog:
object catalog
Catalog associated with contract
-
displayName:
string
Display name for contract
-
priceListGroup:
object priceListGroup
Price ListGroup associated with contract
-
repositoryId:
string
Repository Id of the contract
Nested Schema : catalog
Type:
object
Catalog associated with contract
Show Source
-
repositoryId:
string
Repository Id of the catalog
Nested Schema : priceListGroup
Type:
object
Price ListGroup associated with contract
Show Source
-
repositoryId:
string
Repository Id of the price list group
Example Response (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
Root Schema : errorModel
Type:
Show Source
object
-
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
Nested Schema : errors
Type:
array
An optional list of errors if multiple errors were encountered
Show Source
Nested Schema : items
Type:
Show Source
object
-
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