Jump to

• Request
• Response
• Examples

Get Price Model Access Rights

get

/rest/v19/pricingSetup/models/{modelVariableName}/accessRights

Use this endpoint to retrieve access rights for the specified price model.

Request

Path Parameters

• modelVariableName(required): string

Query Parameters

• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link).More than one child can be specified using comma as a separator. Example: ?expand=groupName,groupLabel.To include all the children,grandChildren,specify the value of this query parameter to be "all".
• fields: string
  This parameter filters the resource attributes. Only the specified attributes are returned, which means that if no attributes are specified, all attributes are returned.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Success

Body ()

Root Schema : AccessRights

Type: object

Show Source

• accessType: string()
  Title: Access Type

  The type of access which the group has to a particular entity
• createdBy: Created By
  Title: Created By

  Read Only: true

  The details of the user who created the record.
• groupAccessEnabled: boolean()
  Title: Group Access Enabled

  Read Only: true

  Indicates whether the user has access to the groups segment
• groupLabel: string()
  Title: Group Label

  The label of Group
• groupName: string()
  Title: Group Name

  The name of Group
• lastModifiedBy: Last Modified By
  Title: Last Modified By

  Read Only: true

  The details of the user who modified the record.
• links: array Links
  Title: Links

  Read Only: true

  The link relations associated with the resource instance.
• segmentLevelAccessType: string()
  Title: Segment-level Access Type

  Read Only: true

  Segment-level Access Type

{
    "properties":{
        "segmentLevelAccessType":{
            "type":"string",
            "format":"",
            "description":"Segment-level Access Type",
            "title":"Segment-level Access Type",
            "readOnly":true
        },
        "groupAccessEnabled":{
            "type":"boolean",
            "format":"",
            "description":"Indicates whether the user has access to the groups segment",
            "title":"Group Access Enabled",
            "readOnly":true
        },
        "createdBy":{
            "format":"",
            "description":"The details of the user who created the record.",
            "title":"Created By",
            "readOnly":true,
            "allOf":[
                {
                    "$ref":"#/definitions/UserDetails"
                }
            ]
        },
        "lastModifiedBy":{
            "format":"",
            "description":"The details of the user who modified the record.",
            "title":"Last Modified By",
            "readOnly":true,
            "allOf":[
                {
                    "$ref":"#/definitions/UserDetails"
                }
            ]
        },
        "links":{
            "type":"array",
            "format":"",
            "description":"The link relations associated with the resource instance.",
            "title":"Links",
            "readOnly":true,
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "groupLabel":{
            "type":"string",
            "format":"",
            "description":"The label of Group",
            "title":"Group Label"
        },
        "groupName":{
            "type":"string",
            "format":"",
            "description":"The name of Group",
            "title":"Group Name"
        },
        "accessType":{
            "type":"string",
            "format":"",
            "description":"The type of access which the group has to a particular entity",
            "title":"Access Type"
        }
    }
}

Nested Schema : Created By

Title: Created By

Read Only: true

The details of the user who created the record.

Match All

The details of the user who created the record.

Show Source

• object UserDetails

{
    "format":"",
    "description":"The details of the user who created the record.",
    "title":"Created By",
    "readOnly":true,
    "allOf":[
        {
            "$ref":"#/definitions/UserDetails"
        }
    ]
}

Nested Schema : Last Modified By

Title: Last Modified By

Read Only: true

The details of the user who modified the record.

Match All

The details of the user who modified the record.

Show Source

• object UserDetails

{
    "format":"",
    "description":"The details of the user who modified the record.",
    "title":"Last Modified By",
    "readOnly":true,
    "allOf":[
        {
            "$ref":"#/definitions/UserDetails"
        }
    ]
}

Nested Schema : Links

Type: array

Title: Links

Read Only: true

The link relations associated with the resource instance.

Show Source

• Array of: object Link

{
    "type":"array",
    "format":"",
    "description":"The link relations associated with the resource instance.",
    "title":"Links",
    "readOnly":true,
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : UserDetails

Type: object

Show Source

• emailId: string()
  Title: Email Id

  Email Id of the user
• firstName: string()
  Title: First Name

  First Name of the user
• lastName: string()
  Title: Last Name

  Last Name of the user

{
    "properties":{
        "firstName":{
            "type":"string",
            "format":"",
            "description":"First Name of the user",
            "title":"First Name"
        },
        "lastName":{
            "type":"string",
            "format":"",
            "description":"Last Name of the user",
            "title":"Last Name"
        },
        "emailId":{
            "type":"string",
            "format":"",
            "description":"Email Id of the user",
            "title":"Email Id"
        }
    }
}

Nested Schema : Link

Type: object

Show Source

• href: string
• name: string
• rel: string

{
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        },
        "name":{
            "type":"string"
        }
    }
}

Back to Top

Examples

The following examples show how to retrieve access rights for the specified price model by submitting a GET request to the REST resource using cURL. For more information about cURL, see Use cURL.

curl - X GET -H "Authorization: Bearer <token>" - H "Content-type: application/json"
https://sitename.oracle.com/rest/v19/pricingSetup/models/absolutePrice/accessRights

Response Body Sample

{
  "items": [{
      "groupLabel": "Segments Partial Access",
      "groupName": "segmentsPartialAccess",
      "accessType": "EDIT_NO_DELETE"
    }, {
      "groupLabel": "Access Restrictions",
      "groupName": "accessRestrictions",
      "accessType": "FULL"
    }, {
      "groupLabel": "Products",
      "groupName": "products",
      "accessType": "FULL"
    }, {
      "groupLabel": "Pricing Partial Access",
      "groupName": "pricingPartialAccess",
      "accessType": "READ"
    }
  ]
}

Back to Top