REST API for Oracle Commerce Cloud

listAdminSecurityCriteriaResources

get

/ccadmin/v1/adminSecurityCriteriaResources

List admin security criteria resources. Get all admin security criteria resources.

Request

Supported Media Types

application/json

Query Parameters

limit: string

This is the field to determine number of items to be fetched per REST call.
offset: string

This field determines the offset/starting index from which data to be fetched.
q: string

SCIM query to search on the security criteria resources properties.
sort: string

This is the field to provide sort on the security criteria resources properties

Response

Supported Media Types

application/json

200 Response

Following model is returned when operation succeeds.

Root Schema : listAdminSecurityCriteriaResources_response

Type: object

Show Source

items: array items

All admin security criteria resources
limit: string

Number of items to be fetched.
offset: string

The offset provided.
sort: array sort

An array that specifies the sort order.
total: string

Total number of items matching the searched string.
totalResults: string

Total number of items matching the searched string.

{
    "properties":{
        "total":{
            "description":"Total number of items matching the searched string.",
            "type":"string"
        },
        "totalResults":{
            "description":"Total number of items matching the searched string.",
            "type":"string"
        },
        "offset":{
            "description":"The offset provided.",
            "type":"string"
        },
        "limit":{
            "description":"Number of items to be fetched.",
            "type":"string"
        },
        "sort":{
            "description":"An array that specifies the sort order.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "property":{
                        "description":"The name of the property to use for sorting.",
                        "type":"string"
                    },
                    "order":{
                        "description":"Whether this property should be sorted ascending (\"asc\") or descending (\"dsc\").",
                        "type":"string"
                    }
                }
            }
        },
        "items":{
            "description":"All admin security criteria resources",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "constraintConfigurations":{
                        "description":"Constraint configurations of the security criteria resource",
                        "type":"array",
                        "items":{
                            "type":"object",
                            "properties":{
                                "constrainingAssetType":{
                                    "description":"Asset type of the constraining asset",
                                    "type":"string"
                                },
                                "displayName":{
                                    "description":"Display name of the constraint configuration",
                                    "type":"string"
                                },
                                "constrainingAssetDisplayNameProperty":{
                                    "description":"Asset display name property of the constraining asset type",
                                    "type":"string"
                                },
                                "id":{
                                    "description":"ID of the constraint configuration",
                                    "type":"string"
                                },
                                "constrainingAssetGroup":{
                                    "description":"Asset group of the constraining asset",
                                    "type":"string"
                                }
                            }
                        }
                    },
                    "name":{
                        "description":"Name of the security criteria resource",
                        "type":"string"
                    },
                    "id":{
                        "description":"ID of the security criteria resource",
                        "type":"string"
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: array

All admin security criteria resources

Show Source

Array of: object items

{
    "description":"All admin security criteria resources",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "constraintConfigurations":{
                "description":"Constraint configurations of the security criteria resource",
                "type":"array",
                "items":{
                    "type":"object",
                    "properties":{
                        "constrainingAssetType":{
                            "description":"Asset type of the constraining asset",
                            "type":"string"
                        },
                        "displayName":{
                            "description":"Display name of the constraint configuration",
                            "type":"string"
                        },
                        "constrainingAssetDisplayNameProperty":{
                            "description":"Asset display name property of the constraining asset type",
                            "type":"string"
                        },
                        "id":{
                            "description":"ID of the constraint configuration",
                            "type":"string"
                        },
                        "constrainingAssetGroup":{
                            "description":"Asset group of the constraining asset",
                            "type":"string"
                        }
                    }
                }
            },
            "name":{
                "description":"Name of the security criteria resource",
                "type":"string"
            },
            "id":{
                "description":"ID of the security criteria resource",
                "type":"string"
            }
        }
    }
}

Nested Schema : sort

Type: array

An array that specifies the sort order.

Show Source

Array of: object items

{
    "description":"An array that specifies the sort order.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "property":{
                "description":"The name of the property to use for sorting.",
                "type":"string"
            },
            "order":{
                "description":"Whether this property should be sorted ascending (\"asc\") or descending (\"dsc\").",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

constraintConfigurations: array constraintConfigurations

Constraint configurations of the security criteria resource
id: string

ID of the security criteria resource
name: string

Name of the security criteria resource

{
    "type":"object",
    "properties":{
        "constraintConfigurations":{
            "description":"Constraint configurations of the security criteria resource",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "constrainingAssetType":{
                        "description":"Asset type of the constraining asset",
                        "type":"string"
                    },
                    "displayName":{
                        "description":"Display name of the constraint configuration",
                        "type":"string"
                    },
                    "constrainingAssetDisplayNameProperty":{
                        "description":"Asset display name property of the constraining asset type",
                        "type":"string"
                    },
                    "id":{
                        "description":"ID of the constraint configuration",
                        "type":"string"
                    },
                    "constrainingAssetGroup":{
                        "description":"Asset group of the constraining asset",
                        "type":"string"
                    }
                }
            }
        },
        "name":{
            "description":"Name of the security criteria resource",
            "type":"string"
        },
        "id":{
            "description":"ID of the security criteria resource",
            "type":"string"
        }
    }
}

Nested Schema : constraintConfigurations

Type: array

Constraint configurations of the security criteria resource

Show Source

Array of: object items

{
    "description":"Constraint configurations of the security criteria resource",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "constrainingAssetType":{
                "description":"Asset type of the constraining asset",
                "type":"string"
            },
            "displayName":{
                "description":"Display name of the constraint configuration",
                "type":"string"
            },
            "constrainingAssetDisplayNameProperty":{
                "description":"Asset display name property of the constraining asset type",
                "type":"string"
            },
            "id":{
                "description":"ID of the constraint configuration",
                "type":"string"
            },
            "constrainingAssetGroup":{
                "description":"Asset group of the constraining asset",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

constrainingAssetDisplayNameProperty: string

Asset display name property of the constraining asset type
constrainingAssetGroup: string

Asset group of the constraining asset
constrainingAssetType: string

Asset type of the constraining asset
displayName: string

Display name of the constraint configuration
id: string

ID of the constraint configuration

{
    "type":"object",
    "properties":{
        "constrainingAssetType":{
            "description":"Asset type of the constraining asset",
            "type":"string"
        },
        "displayName":{
            "description":"Display name of the constraint configuration",
            "type":"string"
        },
        "constrainingAssetDisplayNameProperty":{
            "description":"Asset display name property of the constraining asset type",
            "type":"string"
        },
        "id":{
            "description":"ID of the constraint configuration",
            "type":"string"
        },
        "constrainingAssetGroup":{
            "description":"Asset group of the constraining asset",
            "type":"string"
        }
    }
}

Nested Schema : items

Type: object

Show Source

order: string

Whether this property should be sorted ascending ("asc") or descending ("dsc").
property: string

The name of the property to use for sorting.

{
    "type":"object",
    "properties":{
        "property":{
            "description":"The name of the property to use for sorting.",
            "type":"string"
        },
        "order":{
            "description":"Whether this property should be sorted ascending (\"asc\") or descending (\"dsc\").",
            "type":"string"
        }
    }
}

Example Response (application/json)

{
    "total":2,
    "totalResults":2,
    "offset":0,
    "limit":250,
    "sort":[
        {
            "property":"id",
            "order":"asc"
        }
    ],
    "items":[
        {
            "constraintConfigurations":[
                {
                    "constrainingAssetType":"catalog",
                    "displayName":"Catalogs",
                    "constrainingAssetDisplayNameProperty":"displayName",
                    "id":"ora.catalogConstraintConfiguration",
                    "constrainingAssetGroup":"/atg/commerce/catalog/ProductCatalog/"
                }
            ],
            "name":"Catalog Assets",
            "id":"ora.catalogAssetResource"
        },
        {
            "constraintConfigurations":[
                {
                    "constrainingAssetType":"priceListGroup",
                    "displayName":"Price Groups",
                    "constrainingAssetDisplayNameProperty":"displayName",
                    "id":"ora.pLGConstraintConfiguration",
                    "constrainingAssetGroup":"/atg/commerce/pricing/priceLists/PriceLists/"
                }
            ],
            "name":"Price Groups",
            "id":"ora.pLGAssetResource"
        }
    ]
}

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| |------------------|------------------| |22068|Invalid Query Expression|

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"
        }
    }
}