Jump to

• Request
• Response

Update a field group permission

patch

/crmRestApi/resources/11.13.18.05/fieldGroups/{FieldGroupNumber}/child/permissions/{PermissionNumber}

Request

Path Parameters

• FieldGroupNumber(required): string
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
• PermissionNumber(required): string
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=

Header Parameters

• 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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• AccessGroupNumber: string
  Maximum Length: 4000

  The public unique identifier of the access group.
• AccessLevelCd: string
  Title: Access Level

  Maximum Length: 30

  Default Value: ORA_SVC_FS_READ

  The code indicating the level of access that the access group members have to the field such as, ORA_SVC_FS_READ and ORA_SVC_FS_UPDATE.

{
    "type":"object",
    "properties":{
        "AccessLevelCd":{
            "title":"Access Level",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the level of access that the access group members have to the field such as, ORA_SVC_FS_READ and ORA_SVC_FS_UPDATE.",
            "nullable":false,
            "default":"ORA_SVC_FS_READ",
            "x-hints":{
                "controlType":"choice"
            }
        },
        "AccessGroupNumber":{
            "maxLength":"4000",
            "type":"string",
            "description":"The public unique identifier of the access group.",
            "nullable":false
        }
    }
}

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 : fieldGroups-permissions-item-response

Type: object

Show Source

• AccessGroupId: integer (int64)
  Title: Access Group ID

  The unique identifier of the access group.
• AccessGroupNumber: string
  Maximum Length: 4000

  The public unique identifier of the access group.
• AccessLevelCd: string
  Title: Access Level

  Maximum Length: 30

  Default Value: ORA_SVC_FS_READ

  The code indicating the level of access that the access group members have to the field such as, ORA_SVC_FS_READ and ORA_SVC_FS_UPDATE.
• AccessLevelCdMeaning: string
  Title: Access Level Value

  Read Only: true

  Maximum Length: 255

  The level of access that the access group members have to the field such as, Read, Update.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The person who created the record.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The creation date of the record.
• FieldGroupId: integer (int64)
  Title: Field Group ID

  The unique identifier of the field group.
• FieldGroupNumber: string
  Title: Field Group Number

  Maximum Length: 64

  The public unique identifier of the field group.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The last updated date of the record.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The person who last updated the record.
• LastUpdateLogin: string
  Title: Last Update Login

  Read Only: true

  Maximum Length: 32

  The login of the user who last updated the record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PermissionId: integer (int64)
  Title: Permission ID

  Read Only: true

  The unique identifier of the field group permission.
• PermissionNumber: string
  Title: Permission Number

  Maximum Length: 64

  The public unique identifier of the field group permission.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The person who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The creation date of the record.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The person who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "FieldGroupId":{
            "title":"Field Group ID",
            "type":"integer",
            "description":"The unique identifier of the field group.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "AccessLevelCd":{
            "title":"Access Level",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the level of access that the access group members have to the field such as, ORA_SVC_FS_READ and ORA_SVC_FS_UPDATE.",
            "nullable":false,
            "default":"ORA_SVC_FS_READ",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "AccessGroupId":{
            "title":"Access Group ID",
            "type":"integer",
            "description":"The unique identifier of the access group.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PermissionNumber":{
            "title":"Permission Number",
            "maxLength":"64",
            "type":"string",
            "description":"The public unique identifier of the field group permission.",
            "nullable":false,
            "x-queryable":true
        },
        "FieldGroupNumber":{
            "title":"Field Group Number",
            "maxLength":"64",
            "type":"string",
            "description":"The public unique identifier of the field group.",
            "nullable":false,
            "x-queryable":true
        },
        "AccessLevelCdMeaning":{
            "title":"Access Level Value",
            "maxLength":"255",
            "type":"string",
            "description":"The level of access that the access group members have to the field such as, Read, Update.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "AccessLevelCd"
                ]
            },
            "x-queryable":true
        },
        "AccessGroupNumber":{
            "maxLength":"4000",
            "type":"string",
            "description":"The public unique identifier of the access group.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "PermissionId":{
            "title":"Permission ID",
            "type":"integer",
            "description":"The unique identifier of the field group permission.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The last updated date of the record.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":"32",
            "type":"string",
            "description":"The login of the user who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

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."
        }
    }
}

Links

AccessLevelCdLookup

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DORA_SVC_FS_ACCESS_LEVEL

The following properties are defined on the LOV link relation:

• Source Attribute: AccessLevelCd; Target Attribute: LookupCode
• Display Attribute: Meaning

Back to Top