Jump to

• Request
• Response

Creates a new group

post

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

Request

Supported Media Types

• application/json

Path Parameters

• learnCenterId: number
  Unique identifier of a LearnCenter.

Body ()

Group object that needs to be created.

Root Schema : GroupRequest

Type: object

Show Source

• activeFromDate(optional): string(date-time)
• activeUntilDate(optional): string(date-time)
• code(optional): string
• groupname: string
  Maximum Length: 50

  name of the group
• onlyAllowOwnersToEditGroup(optional): boolean
  Default Value: true
• owners(optional): array owners
• parentgroupid(optional): number
  id of the parent group
• selfServiceOptions(optional):
  Allowed Values: [ "private", "requiresApproval", "doesNotRequireApprovals" ]
• statusFlag(optional): string
  Allowed Values: [ "inactive", "active" ]

  status of group

{
    "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"
        },
        "activeFromDate":{
            "format":"date-time",
            "type":"string"
        },
        "activeUntilDate":{
            "format":"date-time",
            "type":"string"
        },
        "onlyAllowOwnersToEditGroup":{
            "default":true,
            "type":"boolean"
        },
        "selfServiceOptions":{
            "enum":[
                "private",
                "requiresApproval",
                "doesNotRequireApprovals"
            ]
        },
        "owners":{
            "type":"array",
            "items":{
                "properties":{
                    "id":{
                        "type":"number"
                    }
                }
            }
        }
    },
    "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

{
    "type":"array",
    "items":{
        "properties":{
            "id":{
                "type":"number"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• id(optional): number

{
    "properties":{
        "id":{
            "type":"number"
        }
    }
}

Security

• auth: basic
  Type: basic

  Description: Basic Authentication

Back to Top

Response

Supported Media Types

• application/json

201 Response

New group resource created.

Body ()

Root Schema : GroupResponse

Type: object

Show Source

• activeFromDate(optional): string(datetime)
  Example: 2017-05-06T00:00:00
• activeUntilDate(optional): string(datetime)
  Example: 2017-06-06T00:00:00
• code(optional): string
  Example: 481bacda-dc63-4d92-8a08-12f807eab82d
• createdBy(optional): array createdBy
• createdByUserId(optional): number
  Example: 123123
• createdDate(optional): string(datetime)
  Example: 2013-06-17T18:27:01.843
• id(optional): number
  Example: 766
• lastUpdatedBy(optional): array lastUpdatedBy
• lastUpdatedByUserId(optional): number
  Example: 123123
• lastUpdatedDate(optional): string(datetime)
  Example: 2018-03-20T05:00:01.553
• links(optional): array links
• name(optional): string
  Example: my group
• onlyAllowOwnersToEditGroup(optional): boolean
  Example: true
• owners(optional): array owners
• parentGroupId(optional): number
  Example: 123
• selfServiceOptions(optional): string
  Allowed Values: [ "open", "doesNotRequireApprovals", "requiresApproval" ]

  enum for selfServiceOptions are: open, doesNotRequireApprovals, requiresApproval

  Example: open
• statusFlag(optional): string
  Allowed Values: [ "active", "inactive" ]

  enum for statusFlag are: active, inactive

  Example: active

{
    "type":"object",
    "properties":{
        "id":{
            "type":"number",
            "example":766
        },
        "name":{
            "type":"string",
            "example":"my group"
        },
        "parentGroupId":{
            "type":"number",
            "example":123
        },
        "statusFlag":{
            "type":"string",
            "description":"enum for statusFlag are: active, inactive",
            "enum":[
                "active",
                "inactive"
            ],
            "example":"active"
        },
        "code":{
            "type":"string",
            "example":"481bacda-dc63-4d92-8a08-12f807eab82d"
        },
        "activeFromDate":{
            "type":"string",
            "format":"datetime",
            "example":"2017-05-06T00:00:00"
        },
        "activeUntilDate":{
            "type":"string",
            "format":"datetime",
            "example":"2017-06-06T00:00:00"
        },
        "createdDate":{
            "type":"string",
            "format":"datetime",
            "example":"2013-06-17T18:27:01.843"
        },
        "createdBy":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/UserLink"
            }
        },
        "createdByUserId":{
            "type":"number",
            "example":123123
        },
        "lastUpdatedDate":{
            "type":"string",
            "format":"datetime",
            "example":"2018-03-20T05:00:01.553"
        },
        "lastUpdatedBy":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/UserLink"
            }
        },
        "lastUpdatedByUserId":{
            "type":"number",
            "example":123123
        },
        "onlyAllowOwnersToEditGroup":{
            "type":"boolean",
            "example":true
        },
        "selfServiceOptions":{
            "type":"string",
            "description":"enum for selfServiceOptions are: open, doesNotRequireApprovals, requiresApproval",
            "enum":[
                "open",
                "doesNotRequireApprovals",
                "requiresApproval"
            ],
            "example":"open"
        },
        "owners":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/GroupOwnerLink"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/GroupLink"
            }
        }
    }
}

Nested Schema : createdBy

Type: array

Show Source

• Array of: object UserLink

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/UserLink"
    }
}

Nested Schema : lastUpdatedBy

Type: array

Show Source

• Array of: object UserLink

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/UserLink"
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object GroupLink

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/GroupLink"
    }
}

Nested Schema : owners

Type: array

Show Source

• Array of: object GroupOwnerLink

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/GroupOwnerLink"
    }
}

Nested Schema : UserLink

Type: object

Show Source

• href(optional): string
  Example: {url}/learn.rest/v1/users/456
• rel(optional): string
  Example: canonical

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string",
            "example":"canonical"
        },
        "href":{
            "type":"string",
            "example":"{url}/learn.rest/v1/users/456"
        }
    }
}

Nested Schema : GroupLink

Type: object

Show Source

• href(optional): string
  Example: {url}/learn.rest/v1/learnCenters/{learnCenterId}/groups/{groupId}
• rel(optional): string
  Example: canonical

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string",
            "example":"canonical"
        },
        "href":{
            "type":"string",
            "example":"{url}/learn.rest/v1/learnCenters/{learnCenterId}/groups/{groupId}"
        }
    },
    "example":{
        "rel":"canonical",
        "href":"{url}/learn.rest/v1/learnCenters/178409/groups/456"
    }
}

Example:

{
    "rel":"canonical",
    "href":"{url}/learn.rest/v1/learnCenters/178409/groups/456"
}

Nested Schema : GroupOwnerLink

Type: object

Show Source

• href(optional): string
  Example: {url}/learn.rest/v1/learnCenter/178409/groups/456/owners/112867
• rel(optional): string
  Example: canonical

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string",
            "example":"canonical"
        },
        "href":{
            "type":"string",
            "example":"{url}/learn.rest/v1/learnCenter/178409/groups/456/owners/112867"
        }
    }
}

400 Response

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

409 Response

Another resource with the same identifier already exists.

500 Response

Internal server error.

Back to Top