Jump to

• Request
• Response

getAdminSecurityCriteriaResource

get

/ccadmin/v1/adminSecurityCriteriaResources/{id}

Get Admin Security Criteria Resource. Returns a admin security criteria resource by ID.

Request

Supported Media Types

• application/json

Path Parameters

• id: string
  The admin Security Criteria Resource ID.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Following model is returned when operation succeeds.

Body ()

Root Schema : getAdminSecurityCriteriaResource_response

Type: object

Show Source

• constraintConfigurations(optional): array constraintConfigurations
  Constraint configurations of the security criteria resource
• id(optional): string
  ID of the security criteria resource
• name(optional): string
  Name of the security criteria resource

{
    "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(optional): string
  Asset display name property of the constraining asset type
• constrainingAssetGroup(optional): string
  Asset group of the constraining asset
• constrainingAssetType(optional): string
  Asset type of the constraining asset
• displayName(optional): string
  Display name of the constraint configuration
• id(optional): 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"
        }
    }
}

Example Response (application/json)

{
    "constraintConfigurations":[
        {
            "constrainingAssetType":"catalog",
            "displayName":"Catalogs",
            "constrainingAssetDisplayNameProperty":"displayName",
            "id":"ora.catalogConstraintConfiguration",
            "constrainingAssetGroup":"/atg/commerce/catalog/ProductCatalog/"
        }
    ],
    "name":"Catalog Assets",
    "id":"ora.catalogAssetResource"
}

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| |------------------|------------------| |22067|If there was no security criteria resource found with the given id|

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