REST API for Taleo Learn Cloud Service

Creates a new group

post

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

Request

Supported Media Types

application/json

Path Parameters

learnCenterId(required): number

Unique identifier of a LearnCenter.

Group object that needs to be created.

Root Schema : GroupRequest

Type: object

The Group request object.

Show Source

activeFromDate: string(date-time)

The created group will be active from the specified date.
activeUntilDate: string(date-time)

The created group will be active only until the specified date.
code: 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(required): string

Maximum Length: 50

Name of the group.
onlyAllowOwnersToEditGroup: boolean

Default Value: true

Indicates that only Group owners have the ability to make changes to the Dynamic Group properties.
owners: array owners
parentgroupid: number

Id of the parent group.
selfServiceOptions:

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: 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: number

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

Security

auth: basic

Type: basic

Description: Basic Authentication

Response

Supported Media Types

application/json

201 Response

New group resource created.

Root Schema : GroupResponse

Type: object

Show Source

activeFromDate: string(datetime)

The created group will be active from the specified date.
activeUntilDate: string(datetime)

The created group will be active until the specified date.
code: 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.
createdBy: array createdBy

Who the group is created by.
createdByUserId: number

User Id of the person who created the group.
createdDate: string(datetime)

The date the group is created on.
id: number

Unique Identifier of the group.
lastUpdatedBy: array lastUpdatedBy

The user who last updated the group.
lastUpdatedByUserId: number

The user id of the person who last updated the group.
lastUpdatedDate: string(datetime)

The date the group was last updated on.
links: array links

Link to the User Group Item.
name: string

Name of the group.
onlyAllowOwnersToEditGroup: boolean

Default Value: true

Indicates that only Group owners have the ability to make changes to the Dynamic Group properties.
owners: array owners

An array of the the owners assigned to the group.
parentGroupId: number

Unique Identifier of the parent group this group belongs to.
selfServiceOptions: string

Allowed Values: [ "open", "doesNotRequireApprovals", "requiresApproval" ]

What you specify here will determine whether Users can join Dynamic Groups if you provide the option to join on the dynamic object. Enum for selfServiceOptions are: open, doesNotRequireApprovals, requiresApproval.
statusFlag: string

Allowed Values: [ "active", "inactive" ]

Status of the Group. Enum for statusFlag are: active, inactive.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"number",
            "description":"Unique Identifier of the group."
        },
        "name":{
            "type":"string",
            "description":"Name of the group."
        },
        "parentGroupId":{
            "type":"number",
            "description":"Unique Identifier of the parent group this group belongs to."
        },
        "statusFlag":{
            "type":"string",
            "description":"Status of the Group. Enum for statusFlag are: active, inactive.",
            "enum":[
                "active",
                "inactive"
            ]
        },
        "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":{
            "type":"string",
            "format":"datetime",
            "description":"The created group will be active from the specified date."
        },
        "activeUntilDate":{
            "type":"string",
            "format":"datetime",
            "description":"The created group will be active until the specified date."
        },
        "createdDate":{
            "type":"string",
            "format":"datetime",
            "description":"The date the group is created on."
        },
        "createdBy":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/UserLinkItem"
            },
            "description":"Who the group is created by."
        },
        "createdByUserId":{
            "type":"number",
            "description":"User Id of the person who created the group."
        },
        "lastUpdatedDate":{
            "type":"string",
            "format":"datetime",
            "description":"The date the group was last updated on."
        },
        "lastUpdatedBy":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/UserLinkItem"
            },
            "description":"The user who last updated the group."
        },
        "lastUpdatedByUserId":{
            "type":"number",
            "description":"The user id of the person who last updated the group."
        },
        "onlyAllowOwnersToEditGroup":{
            "type":"boolean",
            "default":true,
            "description":"Indicates that only  Group owners have the ability to make changes to the Dynamic Group properties."
        },
        "selfServiceOptions":{
            "type":"string",
            "description":"What you specify here will determine whether Users can join Dynamic Groups if you provide the option to join on the dynamic object. Enum for selfServiceOptions are: open, doesNotRequireApprovals, requiresApproval.",
            "enum":[
                "open",
                "doesNotRequireApprovals",
                "requiresApproval"
            ]
        },
        "owners":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/GroupOwnerLinkItem"
            },
            "description":"An array of the the owners assigned to the group."
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/GroupLinkItem"
            },
            "description":"Link to the User Group Item."
        }
    },
    "example":{
        "id":766,
        "name":"ck test group",
        "parentGroupId":546,
        "statusFlag":"inactive",
        "code":"481bacda-dc63-4d92-8a08-12f807eab82d",
        "activeFromDate":"2017-05-06T00:00:00",
        "activeUntilDate":"2017-06-06T00:00:00",
        "createdDate":"2013-06-17T18:27:01.843",
        "createdBy":{
            "links":[
                {
                    "rel":"canonical",
                    "href":"https://{url}/learn.rest/v1/users/112867"
                }
            ]
        },
        "createdByUserId":112867,
        "lastUpdatedDate":"2018-03-20T05:00:01.553",
        "lastUpdatedBy":{
            "links":[
                {
                    "rel":"canonical",
                    "href":"https://{url}/learn.rest/v1/users/1000"
                }
            ]
        },
        "lastUpdatedByUserId":1000,
        "onlyAllowOwnersToEditGroup":false,
        "selfServiceOptions":"doesNotRequireApprovals",
        "owners":{
            "items":[
                {
                    "id":112867,
                    "links":[
                        {
                            "rel":"canonical",
                            "href":"https://{url}/learn.rest/v1/learnCenters/178409/groups/766/owners/112867"
                        }
                    ]
                }
            ],
            "links":[
                {
                    "rel":"canonical",
                    "href":"https://{url}/learn.rest/v1/learnCenters/178409/groups/766/owners"
                }
            ]
        },
        "links":[
            {
                "rel":"canonical",
                "href":"https://{url}/learn.rest/v1/learnCenters/178409/groups/766"
            }
        ]
    }
}

Example:

{
    "id":766,
    "name":"ck test group",
    "parentGroupId":546,
    "statusFlag":"inactive",
    "code":"481bacda-dc63-4d92-8a08-12f807eab82d",
    "activeFromDate":"2017-05-06T00:00:00",
    "activeUntilDate":"2017-06-06T00:00:00",
    "createdDate":"2013-06-17T18:27:01.843",
    "createdBy":{
        "links":[
            {
                "rel":"canonical",
                "href":"https://{url}/learn.rest/v1/users/112867"
            }
        ]
    },
    "createdByUserId":112867,
    "lastUpdatedDate":"2018-03-20T05:00:01.553",
    "lastUpdatedBy":{
        "links":[
            {
                "rel":"canonical",
                "href":"https://{url}/learn.rest/v1/users/1000"
            }
        ]
    },
    "lastUpdatedByUserId":1000,
    "onlyAllowOwnersToEditGroup":false,
    "selfServiceOptions":"doesNotRequireApprovals",
    "owners":{
        "items":[
            {
                "id":112867,
                "links":[
                    {
                        "rel":"canonical",
                        "href":"https://{url}/learn.rest/v1/learnCenters/178409/groups/766/owners/112867"
                    }
                ]
            }
        ],
        "links":[
            {
                "rel":"canonical",
                "href":"https://{url}/learn.rest/v1/learnCenters/178409/groups/766/owners"
            }
        ]
    },
    "links":[
        {
            "rel":"canonical",
            "href":"https://{url}/learn.rest/v1/learnCenters/178409/groups/766"
        }
    ]
}

Nested Schema : createdBy

Type: array

Who the group is created by.

Show Source

Array of: object UserLinkItem

Object of the User Link Item.

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/UserLinkItem"
    },
    "description":"Who the group is created by."
}

Nested Schema : lastUpdatedBy

Type: array

The user who last updated the group.

Show Source

Array of: object UserLinkItem

Object of the User Link Item.

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/UserLinkItem"
    },
    "description":"The user who last updated the group."
}

Nested Schema : links

Type: array

Link to the User Group Item.

Show Source

Array of: object GroupLinkItem

Link to a group item.

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/GroupLinkItem"
    },
    "description":"Link to the User Group Item."
}

Nested Schema : owners

Type: array

An array of the the owners assigned to the group.

Show Source

Array of: object GroupOwnerLinkItem

Link to the list of group owners.

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/GroupOwnerLinkItem"
    },
    "description":"An array of the the owners assigned to the group."
}

Nested Schema : UserLinkItem

Type: object

Object of the User Link Item.

Show Source

href: string

Example: {url}/learn.rest/v1/users/456
rel: string

Example: canonical

{
    "description":"Object of the User Link Item.",
    "type":"object",
    "properties":{
        "rel":{
            "type":"string",
            "example":"canonical"
        },
        "href":{
            "type":"string",
            "example":"{url}/learn.rest/v1/users/456"
        }
    },
    "example":{
        "rel":"canonical",
        "href":"{url}/learn.rest/v1/users/456"
    }
}

Example:

{
    "rel":"canonical",
    "href":"{url}/learn.rest/v1/users/456"
}

Nested Schema : GroupLinkItem

Type: object

Link to a group item.

Show Source

href: string

Example: {url}/learn.rest/v1/learnCenters/{learnCenterId}/groups/{groupId}
rel: string

Example: canonical

{
    "description":"Link to a group item.",
    "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 : GroupOwnerLinkItem

Type: object

Link to the list of group owners.

Show Source

href: string

Example: {url}/learn.rest/v1/learnCenter/178409/groups/456/owners/112867
rel: string

Example: canonical

{
    "description":"Link to the list of group owners.",
    "type":"object",
    "properties":{
        "rel":{
            "type":"string",
            "example":"canonical"
        },
        "href":{
            "type":"string",
            "example":"{url}/learn.rest/v1/learnCenter/178409/groups/456/owners/112867"
        }
    },
    "example":{
        "rel":"canonical",
        "href":"{url}/learn.rest/v1/learnCenter/178409/groups/456/owners/112867"
    }
}

Example:

{
    "rel":"canonical",
    "href":"{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.