Jump to

• Request
• Response
• Examples

Get all access group extension rules

get

/crmRestApi/resources/11.13.18.05/accessGroupExtensionRules

Request

Query Parameters

• expand: string
  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).
• fields: string
  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
• finder: string
  Used as a predefined finder to search the collection.
  
  Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
  
  The following are the available finder names and corresponding finder variables:
  
  

  • ACC_EXT_RULES_AK: Finds an access group extension rule with the specified access group extension rule number.
    Finder Variables:
    • AccExtRuleNumber; string; The unique alternate identifier for the access group extension rule.
  • PrimaryKey: Finds an access group extension rule with the specified primary key.
    Finder Variables:
    • AccExtRuleId; integer; The unique identifier of the access group extension rule.
• limit: integer
  This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
• links: string
  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
  
• offset: integer
  Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
• q: string
  This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
  
  Format: ?q=expression1;expression2
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • AccExtRuleId; integer; The unique identifier of the access extension rule.
  • AccExtRuleNumber; string; The alternate key identifier for the access extension rule. It is a unique system generated sequence number.
  • ActiveFlag; boolean; Indicates whether the access extension rule is active or not.
  • CreatedBy; string; The user who created the access extension rule.
  • CreationDate; string; The date when the access extension rule was created.
  • DeleteFlag; boolean; Indicates whether the record can be deleted.
  • Description; string; The description of the access extension rule.
  • ExtendAllRulesFlag; boolean; Indicates the method used to identify which rules from the source object should be extended to the target object.
  • LastUpdateDate; string; The date when the access extension rule was last updated.
  • LastUpdateLogin; string; The login details of the user who last updated the access extension rule.
  • LastUpdatedBy; string; The user who last updated the access extension rule.
  • Name; string; The name of the access extension rule.
  • PredefinedFlag; boolean; Indicates whether the access extension rule is predefined.
  • RelationshipDisplayName; string; The display name of the relationship between the source and target objects.
  • RelationshipId; integer; The unique identifier of the relationship between the source and target objects.
  • RelationshipName; string; The name of the relationship between the source and target objects.
  • RelationshipTypeCode; string; The type of the relationship between the source and target objects.
  • SourceObjectCode; string; The code of the source object used in the access extension rule.
  • SourceObjectName; string; The name of the source object used in the access extension rule.
  • TargetObjectCode; string; The code of the target object used in the access extension rule.
  • TargetObjectName; string; The name of the target object used in the access extension rule.
  • UpdateFlag; boolean; Indicates whether the record can be updated.
• totalResults: boolean
  The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".

Header Parameters

• Metadata-Context: string
  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".
• REST-Framework-Version: string
  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

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context:
  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".
• REST-Framework-Version:
  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

Type: object

Show Source

• count(required): integer
  The number of resource instances returned in the current range.
• hasMore(required): boolean
  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array Items
  Title: Items

  The items in the collection.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The link relations associated with the resource instance.
• offset(required): integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/accessGroupExtensionRules-item-response"
            }
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        }
    },
    "x-hints":{
        "usage":"BusinessObject",
        "group":"OEC"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object accessGroupExtensionRules-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/accessGroupExtensionRules-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : accessGroupExtensionRules-item-response

Type: object

Show Source

• accessGroupExtensionRuleDetails: array 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.
• AccExtRuleId: integer (int64)
  Title: Access Extension Rule ID

  The unique identifier of the access extension rule.
• AccExtRuleNumber: string
  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.
• ActiveFlag: boolean
  Title: Active

  Maximum Length: 1

  Default Value: true

  Indicates whether the access extension rule is active or not.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the access extension rule.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date when the access extension rule was created.
• DeleteFlag: boolean
  Title: Delete

  Read Only: true

  Indicates whether the record can be deleted.
• Description: string
  Title: Description

  Maximum Length: 255

  The description of the access extension rule.
• ExtendAllRulesFlag: boolean
  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.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

  The date when the access extension rule was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the access extension rule.
• LastUpdateLogin: string
  Title: Last Update Login

  Read Only: true

  Maximum Length: 32

  The login details of the user who last updated the access extension rule.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Name: string
  Title: Name

  Maximum Length: 200

  The name of the access extension rule.
• PredefinedFlag: boolean
  Title: Predefined Indicator

  Read Only: true

  Maximum Length: 255

  Indicates whether the access extension rule is predefined.
• RelationshipDisplayName: string
  Title: Relationship Display Name

  Read Only: true

  The display name of the relationship between the source and target objects.
• RelationshipId: integer (int64)
  Title: Related Object

  The unique identifier of the relationship between the source and target objects.
• RelationshipName: string
  Title: Relationship Name

  The name of the relationship between the source and target objects.
• RelationshipTypeCode: string
  Title: Relationship Type Code

  The type of the relationship between the source and target objects.
• SourceObjectCode: string
  Title: Source Object Code

  Read Only: true

  The code of the source object used in the access extension rule.
• SourceObjectName: string
  Title: Source Object Name

  Read Only: true

  The name of the source object used in the access extension rule.
• TargetObjectCode: string
  Title: Target Object Code

  Read Only: true

  The code of the target object used in the access extension rule.
• TargetObjectName: string
  Title: Target Object Name

  Read Only: true

  The name of the target object used in the access extension rule.
• UpdateFlag: boolean
  Title: Update

  Read Only: true

  Indicates whether the record can be updated.

{
    "type":"object",
    "properties":{
        "AccExtRuleId":{
            "title":"Access Extension Rule ID",
            "type":"integer",
            "description":"The unique identifier of the access extension rule.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "AccExtRuleNumber":{
            "title":"Access Extension Rule Number",
            "maxLength":30,
            "type":"string",
            "description":"The alternate key identifier for the access extension rule. It is a unique system generated sequence number.",
            "nullable":false,
            "x-queryable":true
        },
        "ActiveFlag":{
            "title":"Active",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the access extension rule is active or not.",
            "nullable":false,
            "default":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the access extension rule.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the access extension rule was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DeleteFlag":{
            "title":"Delete",
            "type":"boolean",
            "description":"Indicates whether the record can be deleted.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "ATTR_INTERNAL_USE":"Y"
            },
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":255,
            "type":"string",
            "description":"The description of the access extension rule.",
            "nullable":true,
            "x-queryable":true
        },
        "ExtendAllRulesFlag":{
            "title":"Extend All Rules Indicator",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates the method used to identify which rules from the source object should be extended to the target object.",
            "nullable":false,
            "default":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date when the access extension rule was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"The login details of the user who last updated the access extension rule.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the access extension rule.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Name":{
            "title":"Name",
            "maxLength":200,
            "type":"string",
            "description":"The name of the access extension rule.",
            "nullable":false,
            "x-queryable":true
        },
        "PredefinedFlag":{
            "title":"Predefined Indicator",
            "maxLength":255,
            "type":"boolean",
            "description":"Indicates whether the access extension rule is predefined.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RelationshipDisplayName":{
            "title":"Relationship Display Name",
            "type":"string",
            "description":"The display name of the relationship between the source and target objects.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RelationshipId":{
            "title":"Related Object",
            "type":"integer",
            "description":"The unique identifier of the relationship between the source and target objects.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "RelationshipName":{
            "title":"Relationship Name",
            "type":"string",
            "description":"The name of the relationship between the source and target objects.",
            "nullable":true,
            "x-queryable":true
        },
        "RelationshipTypeCode":{
            "title":"Relationship Type Code",
            "type":"string",
            "description":"The type of the relationship between the source and target objects.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceObjectCode":{
            "title":"Source Object Code",
            "type":"string",
            "description":"The code of the source object used in the access extension rule.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceObjectName":{
            "title":"Source Object Name",
            "type":"string",
            "description":"The name of the source object used in the access extension rule.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TargetObjectCode":{
            "title":"Target Object Code",
            "type":"string",
            "description":"The code of the target object used in the access extension rule.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TargetObjectName":{
            "title":"Target Object Name",
            "type":"string",
            "description":"The name of the target object used in the access extension rule.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "UpdateFlag":{
            "title":"Update",
            "type":"boolean",
            "description":"Indicates whether the record can be updated.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "ATTR_INTERNAL_USE":"Y"
            },
            "x-queryable":true
        },
        "accessGroupExtensionRuleDetails":{
            "title":"Access Group Extension Rule Details",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/accessGroupExtensionRules-accessGroupExtensionRuleDetails-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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

• Array of: object accessGroupExtensionRules-accessGroupExtensionRuleDetails-item-response

{
    "title":"Access Group Extension Rule Details",
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/accessGroupExtensionRules-accessGroupExtensionRuleDetails-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : accessGroupExtensionRules-accessGroupExtensionRuleDetails-item-response

Type: object

Show Source

• AccessGroupNumber: string
  Title: Group Number

  The alternate key identifier of the access group associated to the rule on the source object.
• AccExtRuleDetailId: integer (int64)
  Title: Access Extension Rule Detail ID

  The unique identifier of the access extension rule details.
• AccExtRuleId: integer (int64)
  Title: Access Extension Rule ID

  The unique identifier of the access extension rule.
• AccExtRuleNumber: string
  Title: Access Extension Rule Number

  Read Only: true

  Maximum Length: 30

  The alternate key identifier for the access extension rule. It is a unique system generated sequence number.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the access extension rule.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date when the access extension rule was created.
• DeleteAccessPermissionFlag: boolean
  Title: Delete Access Permission Indicator

  Maximum Length: 1

  Default Value: false

  Indicates whether delete access is granted.
• DeleteFlag: boolean
  Title: Delete

  Read Only: true

  Indicates whether the record can be deleted.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

  The date when the access extension rule was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the access extension rule.
• LastUpdateLogin: string
  Title: Last Update Login

  Read Only: true

  Maximum Length: 32

  The login details of the user who last updated the access extension rule.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ReadAccessPermissionFlag: boolean
  Title: Read Access Permission Indicator

  Maximum Length: 1

  Default Value: false

  Indicates whether read access is granted.
• SrcObjAccessGroupId: integer (int64)
  Title: Source Object Access Group ID

  The unique identifier of the access group associated to the rule on the source object.
• SrcObjectRuleGuid: string
  Title: Source Object Rule GUID

  Maximum Length: 64

  The unique identifier of the rule on the source object.
• SrcObjectRuleNumber: string
  Title: Source Object Rule Number

  The alternate key identifier of the rule on the source object.
• UpdateAccessPermissionFlag: boolean
  Title: Update Access Permission Indicator

  Maximum Length: 1

  Default Value: false

  Indicates whether update access is granted.
• UpdateFlag: boolean
  Title: Update

  Read Only: true

  Indicates whether the record can be updated.

{
    "type":"object",
    "properties":{
        "AccExtRuleDetailId":{
            "title":"Access Extension Rule Detail ID",
            "type":"integer",
            "description":"The unique identifier of the access extension rule details.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "AccExtRuleId":{
            "title":"Access Extension Rule ID",
            "type":"integer",
            "description":"The unique identifier of the access extension rule.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AccExtRuleNumber":{
            "title":"Access Extension Rule Number",
            "maxLength":30,
            "type":"string",
            "description":"The alternate key identifier for the access extension rule. It is a unique system generated sequence number.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AccessGroupNumber":{
            "title":"Group Number",
            "type":"string",
            "description":"The alternate key identifier of the access group associated to the rule on the source object.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the access extension rule.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the access extension rule was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DeleteAccessPermissionFlag":{
            "title":"Delete Access Permission Indicator",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether delete access is granted.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "DeleteFlag":{
            "title":"Delete",
            "type":"boolean",
            "description":"Indicates whether the record can be deleted.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "ATTR_INTERNAL_USE":"Y"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date when the access extension rule was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"The login details of the user who last updated the access extension rule.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the access extension rule.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ReadAccessPermissionFlag":{
            "title":"Read Access Permission Indicator",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether read access is granted.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "SrcObjAccessGroupId":{
            "title":"Source Object Access Group ID",
            "type":"integer",
            "description":"The unique identifier of the access group associated to the rule on the source object.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SrcObjectRuleGuid":{
            "title":"Source Object Rule GUID",
            "maxLength":64,
            "type":"string",
            "description":"The unique identifier of the rule on the source object.",
            "nullable":false,
            "x-queryable":true
        },
        "SrcObjectRuleNumber":{
            "title":"Source Object Rule Number",
            "type":"string",
            "description":"The alternate key identifier of the rule on the source object.",
            "nullable":true,
            "x-queryable":true
        },
        "UpdateAccessPermissionFlag":{
            "title":"Update Access Permission Indicator",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether update access is granted.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "UpdateFlag":{
            "title":"Update",
            "type":"boolean",
            "description":"Indicates whether the record can be updated.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "ATTR_INTERNAL_USE":"Y"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top

Examples

The following example shows how to get all access group extension rules 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

Example of Response Body

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

{
    "items": [
        {
            "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"
            }
      },
      .....
      ],
  }
      ]
    "count": 25,
    "hasMore": true,
    "limit": 25,
    "offset": 0,
    "links": [
        {
            "rel": "self",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/accessGroupExtensionRules",
            "name": "accessGroupExtensionRules",
            "kind": "collection"
        }
    ]
}

Back to Top