Get an access group extension rule

get

/crmRestApi/resources/11.13.18.05/accessGroupExtensionRules/{AccExtRuleNumber}

Request

Path Parameters
Query Parameters
  • This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2

    Format: <attr1>=<val1>,<attr2>=<value2>
  • When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
  • This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.

    Format: ?fields=Attribute1,Attribute2

    Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
  • This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>

    Example:
    self,canonical
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
Header Parameters
  • If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Body ()
Root Schema : accessGroupExtensionRules-item-response
Type: object
Show Source
  • Access Group Extension Rule Details
    Title: Access Group Extension Rule Details
    The access extension rule details resource is used to view, create, update, and delete details of access extension rules. Access extension rule details are used to extend the access defined for an object in an object sharing rule to a related object.
  • Title: Access Extension Rule ID
    The unique identifier of the access extension rule.
  • Title: Access Extension Rule Number
    Maximum Length: 30
    The alternate key identifier for the access extension rule. It is a unique system generated sequence number.
  • Title: Active
    Maximum Length: 1
    Default Value: true
    Indicates whether the access extension rule is active or not.
  • Title: Created By
    Read Only: true
    Maximum Length: 64
    The user who created the access extension rule.
  • Title: Creation Date
    Read Only: true
    The date when the access extension rule was created.
  • Title: Delete
    Read Only: true
    Indicates whether the record can be deleted.
  • Title: Description
    Maximum Length: 255
    The description of the access extension rule.
  • Title: Extend All Rules Indicator
    Maximum Length: 1
    Default Value: true
    Indicates the method used to identify which rules from the source object should be extended to the target object.
  • Title: Last Update Date
    Read Only: true
    The date when the access extension rule was last updated.
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 64
    The user who last updated the access extension rule.
  • Title: Last Update Login
    Read Only: true
    Maximum Length: 32
    The login details of the user who last updated the access extension rule.
  • Links
  • Title: Name
    Maximum Length: 200
    The name of the access extension rule.
  • Title: Predefined Indicator
    Read Only: true
    Maximum Length: 255
    Indicates whether the access extension rule is predefined.
  • Title: Relationship Display Name
    Read Only: true
    The display name of the relationship between the source and target objects.
  • Title: Related Object
    The unique identifier of the relationship between the source and target objects.
  • Title: Relationship Name
    The name of the relationship between the source and target objects.
  • Title: Relationship Type Code
    The type of the relationship between the source and target objects.
  • Title: Source Object Code
    Read Only: true
    The code of the source object used in the access extension rule.
  • Title: Source Object Name
    Read Only: true
    The name of the source object used in the access extension rule.
  • Title: Target Object Code
    Read Only: true
    The code of the target object used in the access extension rule.
  • Title: Target Object Name
    Read Only: true
    The name of the target object used in the access extension rule.
  • Title: Update
    Read Only: true
    Indicates whether the record can be updated.
Nested Schema : Access Group Extension Rule Details
Type: array
Title: Access Group Extension Rule Details
The access extension rule details resource is used to view, create, update, and delete details of access extension rules. Access extension rule details are used to extend the access defined for an object in an object sharing rule to a related object.
Show Source
Nested Schema : accessGroupExtensionRules-accessGroupExtensionRuleDetails-item-response
Type: object
Show Source
Back to Top

Examples

The following example shows how to get an access group extension rule by submitting a get request on the REST resource using cURL.

cURL Command

curl -u <username:password> \ -X https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/accessGroupExtensionRules/{AccExtRuleNumber}

Example of Response Body

The following shows an example of the response body in JSON format.

{
    "AccExtRuleId": 1,
    "ActiveFlag": false,
    "CreatedBy": "SEED_DATA_FROM_APPLICATION",
    "CreationDate": "2020-09-10T18:27:45.082+00:00",
    "Description": "Predefined rule for contacts of related account team.",
    "ExtendAllRulesFlag": false,
    "LastUpdateDate": "2021-06-10T09:44:00.456+00:00",
    "LastUpdateLogin": "-1",
    "LastUpdatedBy": "SEED_DATA_FROM_APPLICATION",
    "Name": "Contacts of Related Account Team",
    "RelationshipId": 100100216995688,
    "AccExtRuleNumber": "AccountContactRule1",
    "PredefinedFlag": true,
    "RelationshipName": "AccountToContact",
    "RelationshipDisplayName": "Account to Contact (Standard)",
    "SourceObjectCode": "Account",
    "TargetObjectCode": "Contact",
    "UpdateFlag": true,
    "DeleteFlag": false,
    "SourceObjectName": "Account",
    "TargetObjectName": "Contact",
    "RelationshipTypeCode": "STANDARD",
    "links": [
        {
            "rel": "self",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/accessGroupExtensionRules/AccountContactRule1",
            "name": "accessGroupExtensionRules",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
            }
        },
        {
            "rel": "canonical",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/accessGroupExtensionRules/AccountContactRule1",
            "name": "accessGroupExtensionRules",
            "kind": "item"
        },
        {
            "rel": "child",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/accessGroupExtensionRules/AccountContactRule1/child/accessGroupExtensionRuleDetails",
            "name": "accessGroupExtensionRuleDetails",
            "kind": "collection"
        }
    ]
}
Back to Top