Jump to

• Request
• Response

Update a security role group

patch

/fscmRestApi/resources/11.13.18.05/hedRoleSecurityGroups/{GroupId}

Request

Path Parameters

• GroupId(required): integer(int64)
  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

• Description: string
  Title: Description

  Maximum Length: 4000

  The description of the security role group.
• GroupName(required): string
  Title: Name

  Maximum Length: 50

  The name of the security role group.
• hedRoleGroupMembers: array Role Security Group Members
  Title: Role Security Group Members

  The role security group members resource is used to view, create, or modify the memberships of role security groups.
• PredefinedDataFlag: boolean
  Title: Predefined Data

  A Boolean that identifies if the row is predefined data. Y indicates that the row is predefined. N, blank, or NULL indicates that the row isn't predefined.

{
    "required":[
        "GroupName"
    ],
    "type":"object",
    "properties":{
        "GroupName":{
            "title":"Name",
            "maxLength":"50",
            "type":"string",
            "description":"The name of the security role group.",
            "nullable":false
        },
        "hedRoleGroupMembers":{
            "title":"Role Security Group Members",
            "type":"array",
            "description":"The role security group members resource is used to view, create, or modify the memberships of role security groups.",
            "items":{
                "$ref":"#/components/schemas/hedRoleSecurityGroups-hedRoleGroupMembers-item-patch-request"
            }
        },
        "Description":{
            "title":"Description",
            "maxLength":"4000",
            "type":"string",
            "description":"The description of the security role group.",
            "nullable":true
        },
        "PredefinedDataFlag":{
            "title":"Predefined Data",
            "type":"boolean",
            "description":"A Boolean that identifies if the row is predefined data. Y indicates that the row is predefined. N, blank, or NULL indicates that the row isn't predefined.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "SeedDataLock"
                ]
            }
        }
    }
}

Nested Schema : Role Security Group Members

Type: array

Title: Role Security Group Members

The role security group members resource is used to view, create, or modify the memberships of role security groups.

Show Source

• Array of: object schema

{
    "title":"Role Security Group Members",
    "type":"array",
    "description":"The role security group members resource is used to view, create, or modify the memberships of role security groups.",
    "items":{
        "$ref":"#/components/schemas/hedRoleSecurityGroups-hedRoleGroupMembers-item-patch-request"
    }
}

Nested Schema : schema

Type: object

Show Source

{
    "type":"object",
    "properties":{
    }
}

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 : hedRoleSecurityGroups-item-response

Type: object

Show Source

• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  Who column: The user who first created the row for the identifier.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  Who column: The date and time of the creation of the row for the identifier.
• Description: string
  Title: Description

  Maximum Length: 4000

  The description of the security role group.
• GroupCode: string
  Title: Group Code

  Read Only: true

  Maximum Length: 50

  The alternate identifier for the security role group.
• GroupId: integer (int64)
  Title: Group ID

  Read Only: true

  The unique identifier for the security role group.
• GroupName: string
  Title: Name

  Maximum Length: 50

  The name of the security role group.
• hedRoleGroupMembers: array Role Security Group Members
  Title: Role Security Group Members

  The role security group members resource is used to view, create, or modify the memberships of role security groups.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  Who column: The date and time when the row for the identifier was updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  Who column: The user who last updated the row for the identifier.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PredefinedDataFlag: boolean
  Title: Predefined Data

  A Boolean that identifies if the row is predefined data. Y indicates that the row is predefined. N, blank, or NULL indicates that the row isn't predefined.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"Who column: The user who last updated the row for the identifier.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "GroupName":{
            "title":"Name",
            "maxLength":"50",
            "type":"string",
            "description":"The name of the security role group.",
            "nullable":false,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Who column: The date and time of the creation of the row for the identifier.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "hedRoleGroupMembers":{
            "title":"Role Security Group Members",
            "type":"array",
            "description":"The role security group members resource is used to view, create, or modify the memberships of role security groups.",
            "items":{
                "$ref":"#/components/schemas/hedRoleSecurityGroups-hedRoleGroupMembers-item-response"
            }
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"Who column: The user who first created the row for the identifier.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":"4000",
            "type":"string",
            "description":"The description of the security role group.",
            "nullable":true,
            "x-queryable":true
        },
        "GroupCode":{
            "title":"Group Code",
            "maxLength":"50",
            "type":"string",
            "description":"The alternate identifier for the security role group.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "PredefinedDataFlag":{
            "title":"Predefined Data",
            "type":"boolean",
            "description":"A Boolean that identifies if the row is predefined data. Y indicates that the row is predefined. N, blank, or NULL indicates that the row isn't predefined.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "SeedDataLock"
                ]
            },
            "x-queryable":true
        },
        "GroupId":{
            "title":"Group ID",
            "type":"integer",
            "description":"The unique identifier for the security role group.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"Who column: The date and time when the row for the identifier was updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Role Security Group Members

Type: array

Title: Role Security Group Members

The role security group members resource is used to view, create, or modify the memberships of role security groups.

Show Source

• Array of: object hedRoleSecurityGroups-hedRoleGroupMembers-item-response

{
    "title":"Role Security Group Members",
    "type":"array",
    "description":"The role security group members resource is used to view, create, or modify the memberships of role security groups.",
    "items":{
        "$ref":"#/components/schemas/hedRoleSecurityGroups-hedRoleGroupMembers-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 : hedRoleSecurityGroups-hedRoleGroupMembers-item-response

Type: object

Show Source

• AbstractRoleFlag: boolean
  Title: Abstract Role

  Read Only: true

  Maximum Length: 30

  A Boolean that indicates whether this is an abstract role.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  Who column: The user who first created the row for the identifier.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  Who column: The date and time of the creation of the row for the identifier.
• DataRoleFlag: boolean
  Title: Data Role

  Read Only: true

  Maximum Length: 30

  A Boolean that indicates whether this is a job role.
• Description: string
  Title: Description

  Read Only: true

  Maximum Length: 240

  The description of the associated member role.
• GroupMemberId: integer (int64)
  Title: Group Member ID

  Read Only: true

  The unique identifier for the security role group member.
• JobRoleFlag: boolean
  Title: Job Role

  Read Only: true

  Maximum Length: 30

  A Boolean that indicates whether this is a data role.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  Who column: The date and time when the row for the identifier was updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  Who column: The user who last updated the row for the identifier.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PredefinedDataFlag: boolean
  Title: Predefined Data

  Read Only: true

  A Boolean that identifies if the row is predefined data. Y indicates that the row is predefined. N, blank, or NULL indicates that the row isn't predefined.
• RoleCode: string
  Title: Role Code

  Maximum Length: 1000

  A code that identifies the member security role.
• RoleGUID: string
  Title: GUID

  Read Only: true

  Maximum Length: 64

  The GUID of the associated member role.
• RoleId: integer (int64)
  Title: Role ID

  Read Only: true

  The unique identifier for the security role table.
• RoleName: string
  Title: Role Name

  Read Only: true

  Maximum Length: 240

  The name of the associated member role.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"Who column: The user who last updated the row for the identifier.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AbstractRoleFlag":{
            "title":"Abstract Role",
            "maxLength":"30",
            "type":"boolean",
            "description":"A Boolean that indicates whether this is an abstract role.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Who column: The date and time of the creation of the row for the identifier.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":"240",
            "type":"string",
            "description":"The description of the associated member role.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"Who column: The user who first created the row for the identifier.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "JobRoleFlag":{
            "title":"Job Role",
            "maxLength":"30",
            "type":"boolean",
            "description":"A Boolean that indicates whether this is a data role.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RoleId":{
            "title":"Role ID",
            "type":"integer",
            "description":"The unique identifier for the security role table.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "RoleCode":{
            "title":"Role Code",
            "maxLength":"1000",
            "type":"string",
            "description":"A code that identifies the member security role.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "RoleGUID":{
            "title":"GUID",
            "maxLength":"64",
            "type":"string",
            "description":"The GUID of the associated member role.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DataRoleFlag":{
            "title":"Data Role",
            "maxLength":"30",
            "type":"boolean",
            "description":"A Boolean that indicates whether this is a job role.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RoleName":{
            "title":"Role Name",
            "maxLength":"240",
            "type":"string",
            "description":"The name of the associated member role.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "GroupMemberId":{
            "title":"Group Member ID",
            "type":"integer",
            "description":"The unique identifier for the security role group member.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "PredefinedDataFlag":{
            "title":"Predefined Data",
            "type":"boolean",
            "description":"A Boolean that identifies if the row is predefined data. Y indicates that the row is predefined. N, blank, or NULL indicates that the row isn't predefined.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "SeedDataLock"
                ]
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"Who column: The date and time when the row for the identifier was updated.",
            "format":"date-time",
            "nullable":false,
            "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

hedRoleGroupMembers

Operation: /fscmRestApi/resources/11.13.18.05/hedRoleSecurityGroups/{GroupId}/child/hedRoleGroupMembers

Parameters:

• GroupId: $request.path.GroupId

The role security group members resource is used to view, create, or modify the memberships of role security groups.

Back to Top