Jump to

• Request
• Response
• Examples

Get Pricing Access Rights for a Group

get

/rest/v19/companies/{companyLoginName}/groups/{groupVarName}/segments/_pricing/subSegments/{segmentVarName}/accessRights

This endpoint retrieves group access rights for the specified pricing segment (Price Models or Price Agreements).

Request

Path Parameters

• companyLoginName(required): string
  Company login name.
• groupVarName(required): string
  Group variable name.
• segmentVarName(required): string
  Segment Variable Name

Back to Top

Response

Supported Media Types

• application/json

Default Response

Access rights.

Body ()

Root Schema : Pricing Segment Access Rights

Type: object

Title: Pricing Segment Access Rights

Show Source

• items: array items

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/pricingSegmentAccessRights_details"
            }
        }
    },
    "title":"Pricing Segment Access Rights"
}

Nested Schema : items

Type: array

Show Source

• Array of: object Pricing Segment Access Rights
  Title: Pricing Segment Access Rights

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/pricingSegmentAccessRights_details"
    }
}

Nested Schema : Pricing Segment Access Rights

Type: object

Title: Pricing Segment Access Rights

Show Source

• items: array items
• segmentVarName(required): string
  Title: SegmentVarName

  Segment variable name.

{
    "type":"object",
    "required":[
        "segmentVarName"
    ],
    "properties":{
        "segmentVarName":{
            "type":"string",
            "description":"Segment variable name.",
            "title":"SegmentVarName"
        },
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/segmentAccessDetails"
            }
        }
    },
    "title":"Pricing Segment Access Rights"
}

Nested Schema : items

Type: array

Show Source

• Array of: object Pricing Segment Access Rights
  Title: Pricing Segment Access Rights

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/segmentAccessDetails"
    }
}

Nested Schema : Pricing Segment Access Rights

Type: object

Title: Pricing Segment Access Rights

Show Source

• accessType(required): string
  Title: Access Type

  Allowed Values: [ "FULL", "READ", "EDIT", "EDIT_NO_DELETE", "NONE" ]

  Access type.
• name(required): string
  Title: Entity Name

  Name of the entity.
• variableName(required): string
  Title: Entity variable name

  Variable name of the entity.

{
    "type":"object",
    "required":[
        "accessType",
        "name",
        "variableName"
    ],
    "properties":{
        "name":{
            "type":"string",
            "description":"Name of the entity.",
            "title":"Entity Name"
        },
        "variableName":{
            "type":"string",
            "description":"Variable name of the entity.",
            "title":"Entity variable name"
        },
        "accessType":{
            "type":"string",
            "description":"Access type.",
            "title":"Access Type",
            "enum":[
                "FULL",
                "READ",
                "EDIT",
                "EDIT_NO_DELETE",
                "NONE"
            ]
        }
    },
    "title":"Pricing Segment Access Rights"
}

Back to Top

Examples

The following examples show how to retrieve group access rights for the specified pricing segment (Price Models or Price Agreements) by submitting a GET request to the REST resource using cURL. For more information about cURL, see Use cURL.

Price Model Example

curl - X GET -H "Authorization: Bearer <token>" - H "Content-type: application/json"
https://sitename.oracle.com/rest/v19/companies/dataSolutions/groups/pricingPartialAccess/segments/_pricing/subSegments/_priceModels/accessRights

Response Body Sample

{
  "segmentVarName": "_priceModels",
  "items": [{
      "name": "All Price Models",
      "variableName": "All Price Models",
      "accessType": "FULL"
    }, {
      "name": "Absolute Price",
      "variableName": "absolutePrice",
      "accessType": "READ"
    }
  ]
}

Price Agreement Example

curl - X GET -H "Authorization: Bearer <token>" - H "Content-type: application/json"
https://sitename.oracle.com/rest/v19/companies/dataSoluntions/groups/pricingPartialAccess/segments/_pricing/subSegments/_priceAgreements/accessRights

Response Body Sample

{
  "segmentVarName": "_priceAgreements",
  "items": [{
      "name": "All Price Agreements",
      "variableName": "All Price Agreements",
      "accessType": "FULL"
    }, {
      "name": "Maintenance Agreement",
      "variableName": "maintenanceAgreementaccount138",
      "accessType": "READ"
    }
  ]
}

Back to Top