Jump to

• Request
• Response

Update a security assignment

patch

/fscmRestApi/resources/11.13.18.05/userAssignmentGroups/{GroupId}/child/securityAssignments/{Id}

Request

Path Parameters

• GroupId(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=
• Id(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

• Id: integer (int64)
  The unique identifier of the security assignment.
• IsEditor: integer (int32)
  Indicates the user is assigned as an editor.
• IsOwner: integer (int32)
  Indicates the user is assigned as an owner.
• IsViewer: integer (int32)
  Indicates the user is assigned as a viewer.

{
    "type":"object",
    "properties":{
        "Id":{
            "type":"integer",
            "description":"The unique identifier of the security assignment.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "GRC::SEQUENCE_NAME":"GTG_SC_GROUP_SECURITY_S"
            }
        },
        "IsEditor":{
            "type":"integer",
            "description":"Indicates the user is assigned as an editor.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":9
            }
        },
        "IsOwner":{
            "type":"integer",
            "description":"Indicates the user is assigned as an owner.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":9
            }
        },
        "IsViewer":{
            "type":"integer",
            "description":"Indicates the user is assigned as a viewer.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":9
            }
        }
    }
}

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 : userAssignmentGroups-securityAssignments-item-response

Type: object

Show Source

• AccessorDisplayName: string
  Read Only: true

  Maximum Length: 240

  The display name of a user, or the name of a group, granted a security assignment for a user assignment group.
• AccessorId: string
  Maximum Length: 100

  The GUID of a user, or the ID of a group, granted a security assignment for the group.
• AccessorType: string
  Maximum Length: 20

  A type value, USER or GROUP, identifying whether the actor granted a security assignment is a user or a group.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who created the security assignment.
• CreationDate: string (date-time)
  Read Only: true

  The date and time when the security assignment was created.
• Id: integer (int64)
  The unique identifier of the security assignment.
• IsEditor: integer (int32)
  Indicates the user is assigned as an editor.
• IsOwner: integer (int32)
  Indicates the user is assigned as an owner.
• IsViewer: integer (int32)
  Indicates the user is assigned as a viewer.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date and time when the security assignment was most recently updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who most recently updated the security assignment.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• SecurableId: string
  Maximum Length: 100

  ID of the group that's being secured.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who most recently updated the security assignment.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date and time when the security assignment was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the security assignment.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "IsEditor":{
            "type":"integer",
            "description":"Indicates the user is assigned as an editor.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "IsViewer":{
            "type":"integer",
            "description":"Indicates the user is assigned as a viewer.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "SecurableId":{
            "maxLength":100,
            "type":"string",
            "description":"ID of the group that's being secured.",
            "nullable":false,
            "x-queryable":true
        },
        "AccessorId":{
            "maxLength":100,
            "type":"string",
            "description":"The GUID of a user, or the ID of a group, granted a security assignment for the 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"
            }
        },
        "AccessorDisplayName":{
            "maxLength":240,
            "type":"string",
            "description":"The display name of a user, or the name of a group, granted a security assignment for a user assignment group.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Id":{
            "type":"integer",
            "description":"The unique identifier of the security assignment.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "GRC::SEQUENCE_NAME":"GTG_SC_GROUP_SECURITY_S"
            },
            "x-queryable":true
        },
        "IsOwner":{
            "type":"integer",
            "description":"Indicates the user is assigned as an owner.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date and time when the security assignment was most recently updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AccessorType":{
            "maxLength":20,
            "type":"string",
            "description":"A type value, USER or GROUP, identifying whether the actor granted a security assignment is a user or a group.",
            "nullable":false,
            "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."
        }
    }
}

Back to Top