Jump to

• Request
• Response

getCurrentAdminProfileAssetAccessDetails

post

/ccadmin/v1/adminProfiles/current/assetAccessDetails

Get access list for the current admin profile.

Request

Supported Media Types

• application/json

Body ()

Root Schema : getCurrentAdminProfileAssetAccessDetails_request

Type: object

Show Source

• items(optional): array items
  Array of items

{
    "properties":{
        "items":{
            "description":"Array of items",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "assetGroup":{
                        "description":"The assetGroup of the resource",
                        "type":"string"
                    },
                    "id":{
                        "description":"ID of the resource",
                        "type":"string"
                    },
                    "assetType":{
                        "description":"The assetType of the resource",
                        "type":"string"
                    }
                }
            }
        }
    },
    "example":{
        "items":[
            {
                "assetGroup":"/atg/commerce/catalog/ProductCatalog",
                "id":"cloudLakeCatalog",
                "assetType":"catalog"
            },
            {
                "assetGroup":"/atg/commerce/pricing/priceLists/PriceLists",
                "id":"defaultPriceGroup",
                "assetType":"priceListGroup"
            }
        ]
    }
}

Example:

{
    "items":[
        {
            "assetGroup":"/atg/commerce/catalog/ProductCatalog",
            "id":"cloudLakeCatalog",
            "assetType":"catalog"
        },
        {
            "assetGroup":"/atg/commerce/pricing/priceLists/PriceLists",
            "id":"defaultPriceGroup",
            "assetType":"priceListGroup"
        }
    ]
}

Nested Schema : items

Type: array

Array of items

Show Source

• Array of: object items

{
    "description":"Array of items",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "assetGroup":{
                "description":"The assetGroup of the resource",
                "type":"string"
            },
            "id":{
                "description":"ID of the resource",
                "type":"string"
            },
            "assetType":{
                "description":"The assetType of the resource",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• assetGroup(optional): string
  The assetGroup of the resource
• assetType(optional): string
  The assetType of the resource
• id(optional): string
  ID of the resource

{
    "type":"object",
    "properties":{
        "assetGroup":{
            "description":"The assetGroup of the resource",
            "type":"string"
        },
        "id":{
            "description":"ID of the resource",
            "type":"string"
        },
        "assetType":{
            "description":"The assetType of the resource",
            "type":"string"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Following model is returned when operation succeeds.

Body ()

Root Schema : getCurrentAdminProfileAssetAccessDetails_response

Type: object

Show Source

• hasCatalogRestrictions(optional): boolean
  Boolean indicating whether profile has restricted access to catalogs
• hasPriceGroupRestrictions(optional): boolean
  Boolean indicating whether profile has restricted access to price groups
• items(optional): array items
  Array of items

{
    "properties":{
        "hasPriceGroupRestrictions":{
            "description":"Boolean indicating whether profile has restricted access to price groups",
            "type":"boolean"
        },
        "hasCatalogRestrictions":{
            "description":"Boolean indicating whether profile has restricted access to catalogs",
            "type":"boolean"
        },
        "items":{
            "description":"Array of items",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "assetGroup":{
                        "description":"The assetGroup of the resource",
                        "type":"string"
                    },
                    "allowedActions":{
                        "description":"Array of actions allowed on the resource",
                        "type":"array",
                        "items":{
                            "description":"Name of the action",
                            "type":"string"
                        }
                    },
                    "id":{
                        "description":"ID of the resource",
                        "type":"string"
                    },
                    "assetType":{
                        "description":"The assetType of the resource",
                        "type":"string"
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: array

Array of items

Show Source

• Array of: object items

{
    "description":"Array of items",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "assetGroup":{
                "description":"The assetGroup of the resource",
                "type":"string"
            },
            "allowedActions":{
                "description":"Array of actions allowed on the resource",
                "type":"array",
                "items":{
                    "description":"Name of the action",
                    "type":"string"
                }
            },
            "id":{
                "description":"ID of the resource",
                "type":"string"
            },
            "assetType":{
                "description":"The assetType of the resource",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• allowedActions(optional): array allowedActions
  Array of actions allowed on the resource
• assetGroup(optional): string
  The assetGroup of the resource
• assetType(optional): string
  The assetType of the resource
• id(optional): string
  ID of the resource

{
    "type":"object",
    "properties":{
        "assetGroup":{
            "description":"The assetGroup of the resource",
            "type":"string"
        },
        "allowedActions":{
            "description":"Array of actions allowed on the resource",
            "type":"array",
            "items":{
                "description":"Name of the action",
                "type":"string"
            }
        },
        "id":{
            "description":"ID of the resource",
            "type":"string"
        },
        "assetType":{
            "description":"The assetType of the resource",
            "type":"string"
        }
    }
}

Nested Schema : allowedActions

Type: array

Array of actions allowed on the resource

Show Source

• Array of: string
  Name of the action

{
    "description":"Array of actions allowed on the resource",
    "type":"array",
    "items":{
        "description":"Name of the action",
        "type":"string"
    }
}

Example Response (application/json)

{
    "hasPriceGroupRestrictions":"false",
    "hasCatalogRestrictions":"true",
    "items":[
        {
            "assetGroup":"/atg/commerce/catalog/ProductCatalog",
            "allowedActions":[
                "create",
                "read"
            ],
            "id":"cloudLakeCatalog",
            "assetType":"catalog"
        },
        {
            "assetGroup":"/atg/commerce/pricing/priceLists/PriceLists",
            "allowedActions":[
                "create",
                "read",
                "update",
                "delete"
            ],
            "id":"defaultPriceGroup",
            "assetType":"priceListGroup"
        }
    ]
}

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| |------------------|------------------| |13037|If a required property is missing| |22058|If there was any internal error while getting the asser access details|

Body ()

Root Schema : errorModel

Type: object

Show Source

• devMessage(optional): string
  An optional non-localized message containing technical information for developers
• errorCode(optional): string
  The numerical code identifying the error
• errors(optional): array errors
  An optional list of errors if multiple errors were encountered
• message(optional): string
  The localized message describing the error
• moreInfo(optional): string
  An optional non-localized message with more information
• o:errorPath(optional): string
  An optional machine readable description of where the error occurred
• status(optional): string
  The HTTP status code
• type(optional): 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(optional): string
  An optional non-localized message containing technical information for developers
• errorCode(optional): string
  The numerical code identifying the error
• message(optional): string
  The localized message describing the error
• moreInfo(optional): string
  An optional non-localized message with more information
• o:errorPath(optional): string
  An optional machine readable description of where the error occurred
• status(optional): 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