Jump to

• Request
• Response

Create a new member of a group

post

/fscmRestApi/resources/11.13.18.05/userAssignmentGroups/{GroupId}/child/members

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=

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

• GroupId: string
  Maximum Length: 100

  The member's group ID.
• Id: integer (int64)
  The member's ID.
• IsOrphan: integer (int32)
  Default Value: 0

  Either the member is valid or invalid.
• UserId: string
  Maximum Length: 100

  The member's GUID.

{
    "type":"object",
    "properties":{
        "Id":{
            "type":"integer",
            "description":"The member's ID.",
            "format":"int64",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "precision":"18",
                "GRC::SEQUENCE_NAME":"GTG_SC_USER_GROUP_S"
            }
        },
        "UserId":{
            "maxLength":"100",
            "type":"string",
            "description":"The member's GUID.",
            "nullable":false,
            "x-queryable":false
        },
        "IsOrphan":{
            "type":"integer",
            "description":"Either the member is valid or invalid.",
            "format":"int32",
            "nullable":false,
            "default":"0",
            "x-queryable":false,
            "x-hints":{
                "precision":"1"
            }
        },
        "GroupId":{
            "maxLength":"100",
            "type":"string",
            "description":"The member's group ID.",
            "nullable":false,
            "x-hints":{
                "Property":"Value"
            }
        }
    }
}

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-members-item-response

Type: object

Show Source

• Displayname: string
  Read Only: true

  Maximum Length: 302

  The member's display name.
• GroupId: string
  Maximum Length: 100

  The member's group ID.
• Id: integer (int64)
  The member's ID.
• IsOrphan: integer (int32)
  Default Value: 0

  Either the member is valid or invalid.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PersonId: integer (int64)
  Read Only: true

  The member's person ID.
• UserId: string
  Maximum Length: 100

  The member's GUID.
• Username: string
  Read Only: true

  Maximum Length: 100

  The member's user name.

{
    "type":"object",
    "properties":{
        "PersonId":{
            "type":"integer",
            "description":"The member's person ID.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "Username":{
            "maxLength":"100",
            "type":"string",
            "description":"The member's user name.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "UserId":{
            "maxLength":"100",
            "type":"string",
            "description":"The member's GUID.",
            "nullable":false,
            "x-queryable":false
        },
        "Displayname":{
            "maxLength":"302",
            "type":"string",
            "description":"The member's display name.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "Id":{
            "type":"integer",
            "description":"The member's ID.",
            "format":"int64",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "precision":"18",
                "GRC::SEQUENCE_NAME":"GTG_SC_USER_GROUP_S"
            }
        },
        "IsOrphan":{
            "type":"integer",
            "description":"Either the member is valid or invalid.",
            "format":"int32",
            "nullable":false,
            "default":"0",
            "x-queryable":false,
            "x-hints":{
                "precision":"1"
            }
        },
        "GroupId":{
            "maxLength":"100",
            "type":"string",
            "description":"The member's group ID.",
            "nullable":false,
            "x-hints":{
                "Property":"Value"
            },
            "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