Jump to

• Request
• Response

Updates subset of properties for a group

patch

/learn.rest/v1/learnCenters/{learnCenterId}/groups/{groupId}

Request

Supported Media Types

• application/json

Path Parameters

• groupId: number
  Unique identifier of a group.
• learnCenterId: number
  Unique identifier of LearnCenter.

Body ()

Group object that needs to be created.

Root Schema : GroupRequest

Type: object

The Group request object.

Show Source

• activeFromDate(optional): string(date-time)
  The created group will be active from the specified date.
• activeUntilDate(optional): string(date-time)
  The created group will be active only until the specified date.
• code(optional): string
  Each group has a unique code. You can keep the default code generated automatically by LearnCenter, or optionally type a new Code for the Dynamic Group.
• groupname: string
  Maximum Length: 50

  Name of the group.
• onlyAllowOwnersToEditGroup(optional): boolean
  Default Value: true

  Indicates that only Group owners have the ability to make changes to the Dynamic Group properties.
• owners(optional): array owners
• parentgroupid(optional): number
  Id of the parent group.
• selfServiceOptions(optional):
  Allowed Values: [ "private", "requiresApproval", "doesNotRequireApprovals" ]

  What you specify here will determine whether Users can join Dynamic Groups if you provide the option to join on the dynamic object.
• statusFlag(optional): string
  Allowed Values: [ "inactive", "active" ]

  Status of group.

{
    "description":"The Group request object.",
    "type":"object",
    "required":[
        "groupname"
    ],
    "properties":{
        "groupname":{
            "maxLength":50,
            "type":"string",
            "description":"Name of the group."
        },
        "parentgroupid":{
            "type":"number",
            "description":"Id of the parent group."
        },
        "statusFlag":{
            "type":"string",
            "description":"Status of group.",
            "enum":[
                "inactive",
                "active"
            ]
        },
        "code":{
            "type":"string",
            "description":"Each group has a unique code. You can keep the default code generated automatically by LearnCenter, or optionally type a new Code for the Dynamic Group."
        },
        "activeFromDate":{
            "format":"date-time",
            "type":"string",
            "description":"The created group will be active from the specified date."
        },
        "activeUntilDate":{
            "format":"date-time",
            "type":"string",
            "description":"The created group will be active only until the specified date."
        },
        "onlyAllowOwnersToEditGroup":{
            "default":true,
            "type":"boolean",
            "description":"Indicates that only  Group owners have the ability to make changes to the Dynamic Group properties."
        },
        "selfServiceOptions":{
            "enum":[
                "private",
                "requiresApproval",
                "doesNotRequireApprovals"
            ],
            "description":"What you specify here will determine whether Users can join Dynamic Groups if you provide the option to join on the dynamic object."
        },
        "owners":{
            "type":"array",
            "items":{
                "properties":{
                    "id":{
                        "type":"number"
                    }
                },
                "description":"Owner of the Dynamic Group."
            }
        }
    },
    "example":{
        "name":"ck test group test 123",
        "parentGroupId":766,
        "statusFlag":"active",
        "code":"481werfa-dc63-4d92-8a08-12f807eab82d",
        "activeFromDate":"2017-05-06T00:00:00",
        "activeUntilDate":"2017-06-06T00:00:00",
        "createdDate":"2013-06-17T18:27:01.843",
        "createdByUserId":113458,
        "lastUpdatedDate":"2018-03-20T05:00:01.553",
        "lastUpdatedByUserId":1000,
        "onlyAllowOwnersToEditGroup":false,
        "selfServiceOptions":"doesNotRequireApprovals",
        "owners":[
            113458,
            112898
        ]
    }
}

Example:

{
    "name":"ck test group test 123",
    "parentGroupId":766,
    "statusFlag":"active",
    "code":"481werfa-dc63-4d92-8a08-12f807eab82d",
    "activeFromDate":"2017-05-06T00:00:00",
    "activeUntilDate":"2017-06-06T00:00:00",
    "createdDate":"2013-06-17T18:27:01.843",
    "createdByUserId":113458,
    "lastUpdatedDate":"2018-03-20T05:00:01.553",
    "lastUpdatedByUserId":1000,
    "onlyAllowOwnersToEditGroup":false,
    "selfServiceOptions":"doesNotRequireApprovals",
    "owners":[
        113458,
        112898
    ]
}

Nested Schema : owners

Type: array

Show Source

• Array of: object items
  Owner of the Dynamic Group.

{
    "type":"array",
    "items":{
        "properties":{
            "id":{
                "type":"number"
            }
        },
        "description":"Owner of the Dynamic Group."
    }
}

Nested Schema : items

Type: object

Owner of the Dynamic Group.

Show Source

• id(optional): number

{
    "properties":{
        "id":{
            "type":"number"
        }
    },
    "description":"Owner of the Dynamic Group."
}

Security

• auth: basic
  Type: basic

  Description: Basic Authentication

Back to Top

Response

Supported Media Types

• application/json

200 Response

Resource updated.

400 Response

Request has incorrect syntax or does not contain a field that is required.

401 Response

Authentication refused for provided credentials or token invalid.

Headers

• WWW_Authenticate: string

404 Response

Resource not found.

422 Response

Request may contain validation errors.

500 Response

Internal server error.

Back to Top