{ "swagger":"2.0", "info":{ "description":"
Last Updated February 2020
\n

You can use Oracle REST APIs to view and manage data stored in Taleo Learn.

", "version":"2020.02.18", "title":"REST API for Taleo Learn Cloud Service", "x-summary":"Last Updated February 2020 You can use Oracle REST APIs to view and manage data stored in Taleo Learn." }, "basePath":"/learn.rest/v1", "tags":[ { "name":"Catalog", "description":"Rest API endpoints for Meta-data Catalog." }, { "name":"Groups", "description":"The groups resource includes the groups service used to create, view, update, and delete groups for users." }, { "name":"LearnCenters", "description":"Rest API endpoints for LearnCenters." }, { "name":"Memberships", "description":"Rest API endpoints to create, fetch, update, and delete membership details." }, { "name":"Supervisor Accounts", "description":"Rest API endpoints for Supervisor Accounts" }, { "name":"Supervisor Roles", "description":"Rest API endpoints for Supervisor Roles" }, { "name":"System Processes", "description":"Rest API endpoints for System Processes" }, { "name":"System Registry Keys", "description":"System Registry keys are used to customize Learn settings, and apply to all LearnCenters, including root LearnCenter and all of its sub LearnCenters. The following keys are used with Learn REST API, and are categorized as RestApiSettings.\\n\\nGeneratePassword: Values = 0 or 1, Default = 0, Description = Enables automatic generation of password\\n\\nTriggerUserMessages: Values = 0 or 1, Default = 0, Description = Enables email notifications " }, { "name":"User Custom Fields", "description":"Rest API endpoints for User Custom Fields." }, { "name":"User Roles", "description":"Rest API endpoints for User Roles." }, { "name":"Users", "description":"Rest API endpoints for Users." } ], "schemes":[ "https" ], "security":[ { "auth":[ ] } ], "paths":{ "/metadata-catalog":{ "get":{ "tags":[ "Catalog" ], "summary":"Catalog of all API end points.", "description":"Catalog of API end points.", "produces":[ "application/xml", "application/json" ], "parameters":[ { "name":"totalResults", "in":"query", "description":"If set to true, payload includes the total number of rows that satisfies the request. Use of this parameter determines if the 'last' link is displayed for a pageable collection.", "required":false, "type":"boolean" } ], "responses":{ "200":{ "description":"metadata-catalog collection fetched.", "schema":{ "$ref":"#/definitions/CatalogResponse" } }, "401":{ "description":"Authentication refused for provided credentials or the token is invalid.", "headers":{ "WWW_Authenticate":{ "type":"string" } } }, "500":{ "description":"Internal server error." } }, "x-internal-id":"metadata-catalog-get", "x-filename-id":"metadata-catalog-get" } }, "/systemRegistryKeys":{ "get":{ "tags":[ "System Registry Keys" ], "summary":"Get a list of system registry keys.", "produces":[ "application/json" ], "parameters":[ { "name":"totalResults", "in":"query", "description":"If set to true, payload includes the total number of rows that satisfies the request. Use of parameter determines if the 'last' link is displayed for a pageable collection.", "required":false, "type":"boolean" } ], "responses":{ "200":{ "description":"Metadata-catalog collection fetched.", "schema":{ "$ref":"#/definitions/SystemRegistryKeysResponse" } }, "401":{ "description":"Authentication refused for provided credentials or token invalid.", "headers":{ "WWW_Authenticate":{ "type":"string" } } }, "500":{ "description":"Internal server error." } }, "security":[ { "auth":[ ] } ], "x-internal-id":"systemRegistryKeys-get", "x-filename-id":"systemregistrykeys-get" } }, "/systemRegistryKeys/{systemRegistryKey}":{ "get":{ "tags":[ "System Registry Keys" ], "summary":"Get a System Registry Key.", "produces":[ "application/json" ], "parameters":[ { "name":"systemRegistryKey", "in":"path", "description":"Name of the system registry key.", "required":true, "type":"string" } ], "responses":{ "200":{ "description":"The system registry key is fetched.", "schema":{ "$ref":"#/definitions/SystemRegistryKeyResponse" } }, "401":{ "description":"Authentication refused for provided credentials or the token is invalid.", "headers":{ "WWW_Authenticate":{ "type":"string" } } }, "500":{ "description":"Internal server error." } }, "security":[ { "auth":[ ] } ], "x-internal-id":"systemRegistryKeys-{systemRegistryKey}-get", "x-filename-id":"systemregistrykeys-systemregistrykey-get" }, "put":{ "tags":[ "System Registry Keys" ], "summary":"Update all properties of a System Registry Key.", "parameters":[ { "name":"systemRegistryKey", "in":"path", "description":"Name of the system registry key", "required":true, "type":"string" }, { "in":"body", "name":"body", "description":"Value of the key.", "required":true, "schema":{ "$ref":"#/definitions/SystemRegistryKeyRequest" } } ], "responses":{ "200":{ "description":"Resource updated.", "schema":{ "$ref":"#/definitions/SystemRegistryKeyResponse" } }, "400":{ "$ref":"#/responses/400Error" }, "401":{ "$ref":"#/responses/401Error" }, "404":{ "$ref":"#/responses/404Error" }, "422":{ "$ref":"#/responses/422Error" }, "500":{ "$ref":"#/responses/500Error" } }, "security":[ { "auth":[ ] } ], "x-internal-id":"systemRegistryKeys-{systemRegistryKey}-put", "x-filename-id":"systemregistrykeys-systemregistrykey-put" } }, "/systemProcesses":{ "get":{ "tags":[ "System Processes" ], "summary":"Get a list of system processes.", "operationId":"GET systemProcesses", "produces":[ "application/json" ], "responses":{ "200":{ "description":"System processes collections are fetched.", "schema":{ "$ref":"#/definitions/SystemProcessesResponse" } } }, "x-internal-id":"systemProcesses-get", "x-filename-id":"systemprocesses-get" } }, "/systemProcesses/{id}":{ "get":{ "tags":[ "System Processes" ], "summary":"Get the status of a specific system process.", "operationId":"GET systemProcesses/{id}", "produces":[ "application/json" ], "parameters":[ { "name":"id", "in":"path", "description":"Unique identifier of a system process.", "required":true, "type":"string" } ], "responses":{ "200":{ "description":"The system processes collection is fetched.", "schema":{ "$ref":"#/definitions/SystemProcessResponse" } }, "404":{ "$ref":"#/responses/404Error" } }, "x-internal-id":"systemProcesses-{id}-get", "x-filename-id":"systemprocesses-id-get" } }, "/learnCenters/{learnCenterId}/supervisorAccounts":{ "get":{ "tags":[ "Supervisor Accounts" ], "summary":"Get a list of supervisor accounts in a LearnCenter.", "operationId":"GET learnCenters/{learnCenterId}/supervisorAccounts", "produces":[ "application/json" ], "parameters":[ { "name":"learnCenterId", "in":"path", "description":"Unique identifier of a LearnCenter.", "required":true, "type":"number" }, { "name":"totalResults", "in":"query", "description":"If set to true, the payload includes total number of rows that satisfies the request. Use of this parameter determines if the 'last' link is displayed for a pageable collection.", "required":false, "type":"boolean" }, { "name":"limit", "in":"query", "description":"Specify how many items should be returned in a payload. Must be lower than server default limit size.", "required":false, "type":"integer" }, { "name":"offset", "in":"query", "description":"Specify the starting point of the response.", "required":false, "type":"integer", "default":0 } ], "responses":{ "200":{ "description":"Supervisor accounts collection fetched.", "schema":{ "$ref":"#/definitions/SupervisorAccountsResponse" } }, "401":{ "$ref":"#/responses/401Error" }, "500":{ "$ref":"#/responses/500Error" } }, "x-internal-id":"learnCenters-{learnCenterId}-supervisorAccounts-get", "x-filename-id":"learncenters-learncenterid-supervisoraccounts-get" }, "post":{ "tags":[ "Supervisor Accounts" ], "summary":"Creates a new supervisor account", "operationId":"POST learnCenters/{learnCenterId}/supervisorAccounts", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"learnCenterId", "in":"path", "description":"Unique identifier of a LearnCenter.", "required":true, "type":"number" }, { "in":"body", "name":"body", "description":"Supervisor account object that has to be created.", "required":true, "schema":{ "$ref":"#/definitions/SupervisorAccountRequest" } } ], "responses":{ "201":{ "description":"New supervisor account resource created.", "schema":{ "$ref":"#/definitions/SupervisorAccountResponse" } }, "400":{ "$ref":"#/responses/400Error" }, "409":{ "$ref":"#/responses/409Error" }, "500":{ "$ref":"#/responses/500Error" } }, "security":[ { "auth":[ ] } ], "x-internal-id":"learnCenters-{learnCenterId}-supervisorAccounts-post", "x-filename-id":"learncenters-learncenterid-supervisoraccounts-post" } }, "/learnCenters/{learnCenterId}/supervisorAccounts/{supervisorAccountId}":{ "get":{ "tags":[ "Supervisor Accounts" ], "summary":"Gets details of supervisor account", "operationId":"POST learnCenters/{learnCenterId}/supervisorAccounts/{supervisorAccountId}", "consumes":[ "application/json" ], "produces":[ "application/xml", "application/json" ], "parameters":[ { "name":"learnCenterId", "in":"path", "description":"Unique identifier of a LearnCenter.", "required":true, "type":"number" }, { "name":"supervisorAccountId", "in":"path", "description":"Unique identifier of a Supervisor Account.", "required":true, "type":"number" } ], "responses":{ "200":{ "description":"Supervisor account fetched.", "schema":{ "$ref":"#/definitions/SupervisorAccountResponse" } }, "401":{ "$ref":"#/responses/401Error" }, "404":{ "$ref":"#/responses/404Error" }, "500":{ "$ref":"#/responses/500Error" } }, "x-internal-id":"learnCenters-{learnCenterId}-supervisorAccounts-{supervisorAccountId}-get", "x-filename-id":"learncenters-learncenterid-supervisoraccounts-supervisoraccountid-get" }, "delete":{ "tags":[ "Supervisor Accounts" ], "summary":"Delete a supervisor account", "parameters":[ { "name":"learnCenterId", "in":"path", "description":"Unique identifier of LearnCenter.", "required":true, "type":"number" }, { "name":"supervisorAccountId", "in":"path", "description":"Unique identifier of supervisor account.", "required":true, "type":"number" } ], "responses":{ "204":{ "description":"Resource deleted." }, "401":{ "$ref":"#/responses/401Error" }, "404":{ "$ref":"#/responses/404Error" }, "500":{ "$ref":"#/responses/500Error" } }, "security":[ { "auth":[ ] } ], "x-internal-id":"learnCenters-{learnCenterId}-supervisorAccounts-{supervisorAccountId}-delete", "x-filename-id":"learncenters-learncenterid-supervisoraccounts-supervisoraccountid-delete" } }, "/learnCenters/{learnCenterId}/supervisorAccounts/{supervisorAccountId}/supervisees":{ "get":{ "tags":[ "Supervisor Accounts" ], "summary":"Get a list of supervisees mapped to a supervisor account in a LearnCenter", "operationId":"GET learnCenters/{learnCenterId}/supervisorAccounts/{supervisorAccountId}/supervisees", "produces":[ "application/json" ], "parameters":[ { "name":"learnCenterId", "in":"path", "description":"Unique identifier of a LearnCenter.", "required":true, "type":"number" }, { "name":"supervisorAccountId", "in":"path", "description":"Unique identifier of a supervisor account.", "required":true, "type":"string" }, { "name":"totalResults", "in":"query", "description":"If set to true, the payload includes the total number of rows that satisfies the request. Use of this parameter determines if the 'last' link is displayed for a pageable collection.", "required":false, "type":"boolean" }, { "name":"limit", "in":"query", "description":"Specify how many items should be returned in a payload. Must be lower than server default limit size.", "required":false, "type":"integer" }, { "name":"offset", "in":"query", "description":"Specify starting point of the response.", "required":false, "type":"integer", "default":0 } ], "responses":{ "200":{ "description":"Supervisees collection fetched.", "schema":{ "$ref":"#/definitions/SuperviseesResponse" } } }, "x-internal-id":"learnCenters-{learnCenterId}-supervisorAccounts-{supervisorAccountId}-supervisees-get", "x-filename-id":"learncenters-learncenterid-supervisoraccounts-supervisoraccountid-supervisees-get" }, "post":{ "tags":[ "Supervisor Accounts" ], "summary":"Creates a new supervisee", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"learnCenterId", "in":"path", "description":"Unique identifier of a LearnCenter.", "required":true, "type":"number" }, { "name":"supervisorAccountId", "in":"path", "description":"Unique identifier of a Supervisor Account.", "required":true, "type":"string" }, { "in":"body", "name":"body", "description":"Supervisor role object that needs to be created.", "required":true, "schema":{ "$ref":"#/definitions/SuperviseeRequest" } } ], "responses":{ "201":{ "description":"New supervisee created.", "schema":{ "$ref":"#/definitions/SuperviseeResponse" } }, "400":{ "$ref":"#/responses/400Error" }, "401":{ "$ref":"#/responses/401Error" }, "404":{ "$ref":"#/responses/404Error" }, "422":{ "$ref":"#/responses/422Error" }, "500":{ "$ref":"#/responses/500Error" } }, "security":[ { "auth":[ ] } ], "x-internal-id":"learnCenters-{learnCenterId}-supervisorAccounts-{supervisorAccountId}-supervisees-post", "x-filename-id":"learncenters-learncenterid-supervisoraccounts-supervisoraccountid-supervisees-post" } }, "/learnCenters/{learnCenterId}/supervisorAccounts/{supervisorAccountId}/supervisees/{superviseeId}":{ "get":{ "tags":[ "Supervisor Accounts" ], "summary":"Get supervisee details", "operationId":"GET learnCenters/{learnCenterId}/supervisorAccounts/{supervisorAccountId}/supervisees/{superviseeId}", "produces":[ "application/json" ], "parameters":[ { "name":"learnCenterId", "in":"path", "description":"Unique identifier of a LearnCenter.", "required":true, "type":"number" }, { "name":"supervisorAccountId", "in":"path", "description":"Unique identifier of a supervisor account.", "required":true, "type":"string" }, { "name":"superviseeId", "in":"path", "description":"Unique identifier of a supervisee.", "required":true, "type":"number" } ], "responses":{ "200":{ "description":"Supervisee details fetched.", "schema":{ "$ref":"#/definitions/SuperviseeResponse" } } }, "x-internal-id":"learnCenters-{learnCenterId}-supervisorAccounts-{supervisorAccountId}-supervisees-{superviseeId}-get", "x-filename-id":"learncenters-learncenterid-supervisoraccounts-supervisoraccountid-supervisees-superviseeid-get" }, "put":{ "tags":[ "Supervisor Accounts" ], "summary":"Update all properties of a supervisee", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"learnCenterId", "in":"path", "description":"Unique identifier of a LearnCenter.", "required":true, "type":"number" }, { "name":"supervisorAccountId", "in":"path", "description":"Unique identifier of a supervisor account.", "required":true, "type":"string" }, { "name":"superviseeId", "in":"path", "description":"Unique identifier of a supervisee.", "required":true, "type":"number" }, { "in":"body", "name":"body", "description":"Supervisee object that needs to be updated.", "required":true, "schema":{ "$ref":"#/definitions/SuperviseeRequest" } } ], "responses":{ "200":{ "description":"Resource updated." }, "400":{ "$ref":"#/responses/400Error" }, "401":{ "$ref":"#/responses/401Error" }, "404":{ "$ref":"#/responses/404Error" }, "422":{ "$ref":"#/responses/422Error" }, "500":{ "$ref":"#/responses/500Error" } }, "security":[ { "auth":[ ] } ], "x-internal-id":"learnCenters-{learnCenterId}-supervisorAccounts-{supervisorAccountId}-supervisees-{superviseeId}-put", "x-filename-id":"learncenters-learncenterid-supervisoraccounts-supervisoraccountid-supervisees-superviseeid-put" }, "delete":{ "tags":[ "Supervisor Accounts" ], "summary":"Delete a supervisee", "parameters":[ { "name":"learnCenterId", "in":"path", "description":"Unique identifier of LearnCenter.", "required":true, "type":"number" }, { "name":"supervisorAccountId", "in":"path", "description":"Unique identifier of supervisor account.", "required":true, "type":"string" }, { "name":"superviseeId", "in":"path", "description":"Unique identifier of supervisee", "required":true, "type":"number" } ], "responses":{ "204":{ "description":"Resource deleted." }, "401":{ "$ref":"#/responses/401Error" }, "404":{ "$ref":"#/responses/404Error" }, "500":{ "$ref":"#/responses/500Error" } }, "security":[ { "auth":[ ] } ], "x-internal-id":"learnCenters-{learnCenterId}-supervisorAccounts-{supervisorAccountId}-supervisees-{superviseeId}-delete", "x-filename-id":"learncenters-learncenterid-supervisoraccounts-supervisoraccountid-supervisees-superviseeid-delete" } }, "/learnCenters/{learnCenterId}/supervisorAccounts/{supervisorAccountId}/supervisorRoles":{ "get":{ "tags":[ "Supervisor Accounts" ], "summary":"Get a list of supervisor roles mapped to a supervisor account in a LearnCenter", "operationId":"GET learnCenters/{learnCenterId}/supervisorAccounts/{supervisorAccountId/supervisorRoles", "produces":[ "application/json" ], "parameters":[ { "name":"learnCenterId", "in":"path", "description":"Unique identifier of a LearnCenter.", "required":true, "type":"number" }, { "name":"supervisorAccountId", "in":"path", "description":"Unique identifier of a supervisor account.", "required":true, "type":"number" }, { "name":"totalResults", "in":"query", "description":"If set to true, the payload includes total number of rows that satisfies the request. Use of this parameter determines if the 'last' link is displayed for a pageable collection.", "required":false, "type":"boolean" }, { "name":"limit", "in":"query", "description":"Specify how many items should be returned in a payload. Must be lower than server default limit size.", "required":false, "type":"integer" }, { "name":"offset", "in":"query", "description":"Specify starting point of the response.", "required":false, "type":"integer", "default":0 } ], "responses":{ "200":{ "description":"Supervisor roles collection fetched successfully.", "schema":{ "$ref":"#/definitions/SupervisorAccountSupervisorRolesResponse" }, "examples":{ "application/json":{ "items":[ { "supervisorRoleId":1, "supervisorRole":{ "links":[ { "rel":"canonical", "href":"https://{url}/learn.rest/v1/learnCenters/178409/supervisorRoles/1" } ] }, "supervisorAccountId":"2F6AF602-965B-415A-B00C-EEDA1F37510B", "supervisorAccount":{ "links":[ { "rel":"canonical", "href":"https://{url}/learn.rest/v1/learnCenters/178409/supervisorAccounts/2F6AF602-965B-415A-B00C-EEDA1F37510B" } ] }, "createDateUtc":"2018-03-07T09:34:00", "statusFlag":true, "links":[ { "rel":"canonical", "href":"https://{url}/learn.rest/v1/learnCenters/178409/supervisorAccounts/2F6AF602-965B-415A-B00C-EEDA1F37510B/supervisorRoles" } ] }, { "...":null } ], "limit":100, "count":1, "hasMore":false, "links":[ { "rel":"canonical", "href":"https://{url}/learn.rest/v1/learnCenters/178409/supervisorAccounts/2F6AF602-965B-415A-B00C-EEDA1F37510B/supervisorRoles" } ] } } } }, "x-internal-id":"learnCenters-{learnCenterId}-supervisorAccounts-{supervisorAccountId}-supervisorRoles-get", "x-filename-id":"learncenters-learncenterid-supervisoraccounts-supervisoraccountid-supervisorroles-get" } }, "/learnCenters/{learnCenterId}/supervisorRoles/{supervisorRoleId}/supervisorAccounts":{ "get":{ "tags":[ "Supervisor Accounts" ], "summary":"Get a list of supervisor accounts mapped to a supervisor role in a LearnCenter.", "operationId":"GET learnCenters/{learnCenterId}/supervisorRoles/{supervisorRoleId}/supervisorAccounts", "produces":[ "application/json" ], "parameters":[ { "name":"learnCenterId", "in":"path", "description":"Unique identifier of a LearnCenter.", "required":true, "type":"number" }, { "name":"supervisorRoleId", "in":"path", "description":"Unique identifier of a supervisor role.", "required":true, "type":"number" }, { "name":"totalResults", "in":"query", "description":"If set to true, the payload includes total number of rows that satisfies the request. Use of this parameter determines if the 'last' link is displayed for a pageable collection.", "required":false, "type":"boolean" }, { "name":"limit", "in":"query", "description":"Specify how many items should be returned in a payload. Must be lower than server default limit size.", "required":false, "type":"integer" }, { "name":"offset", "in":"query", "description":"Specify starting point of the response.", "required":false, "type":"integer", "default":0 } ], "responses":{ "200":{ "description":"Supervisor accounts collection fetched.", "schema":{ "$ref":"#/definitions/SupervisorRoleSupervisorAccountsResponse" } }, "401":{ "$ref":"#/responses/401Error" }, "500":{ "$ref":"#/responses/500Error" } }, "x-internal-id":"learnCenters-{learnCenterId}-supervisorRoles-{supervisorRoleId}-supervisorAccounts-get", "x-filename-id":"learncenters-learncenterid-supervisorroles-supervisorroleid-supervisoraccounts-get" }, "post":{ "tags":[ "Supervisor Roles" ], "summary":"Map a new supervisor account with an existing supervisor role.", "description":"Map a new supervisor account with existing supervisor role.", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"learnCenterId", "in":"path", "description":"Unique identifier of a LearnCenter.", "required":true, "type":"number" }, { "name":"supervisorRoleId", "in":"path", "description":"Unique identifier of a supervisor role.", "required":true, "type":"number" }, { "in":"body", "name":"body", "description":"Supervisor role and supervisor account mapping object that needs to be created.", "required":true, "schema":{ "$ref":"#/definitions/SupervisorRoleAccountMappingRequest" } } ], "responses":{ "201":{ "description":"New supervisor role and supervisor account mapping is created.", "examples":{ "application/json":{ "supervisorAccountId":"086DEDC1-5B10-460F-AACF-1A7D2A71ACB4", "supervisorRoleId":1930, "supervisorAccount":{ "links":[ { "rel":"canonical", "href":"{url}/learn.rest/v1/learnCenters/189353/supervisorAccounts/086DEDC1-5B10-460F-AACF-1A7D2A71ACB4" } ] }, "supervisorRole":{ "links":[ { "rel":"canonical", "href":"{url}/learn.rest/v1/learnCenters/189353/supervisorRoles/1930" } ] }, "createDateUtc":"2019-02-05T10:48:00", "statusFlag":true, "links":[ { "rel":"canonical", "href":"{url}/learn.rest/v1/learnCenters/189353/supervisorRoles/1930/supervisorAccounts/086DEDC1-5B10-460F-AACF-1A7D2A71ACB4" } ] } } }, "400":{ "$ref":"#/responses/400Error" }, "401":{ "$ref":"#/responses/401Error" }, "404":{ "$ref":"#/responses/404Error" }, "422":{ "$ref":"#/responses/422Error" }, "500":{ "$ref":"#/responses/500Error" } }, "security":[ { "auth":[ ] } ], "x-internal-id":"learnCenters-{learnCenterId}-supervisorRoles-{supervisorRoleId}-supervisorAccounts-post", "x-filename-id":"learncenters-learncenterid-supervisorroles-supervisorroleid-supervisoraccounts-post" } }, "/memberships":{ "post":{ "tags":[ "Memberships" ], "summary":"Creates a new membership", "operationId":"POST memberships", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "in":"body", "name":"body", "description":"Membership object that needs to be created.", "required":true, "schema":{ "$ref":"#/definitions/MembershipRequest" } } ], "responses":{ "201":{ "description":"New membership resource created.", "schema":{ "$ref":"#/definitions/MembershipResponse" } }, "400":{ "$ref":"#/responses/400Error" }, "409":{ "$ref":"#/responses/409Error" }, "500":{ "$ref":"#/responses/500Error" } }, "security":[ { "auth":[ ] } ], "x-internal-id":"memberships-post", "x-filename-id":"memberships-post" } }, "/memberships/{membershipId}":{ "get":{ "tags":[ "Memberships" ], "summary":"Get a membership.", "operationId":"GET memberships/{membershipId}", "produces":[ "application/json" ], "parameters":[ { "name":"membershipId", "in":"path", "description":"Unique identifier of membership.", "required":true, "type":"number" } ], "responses":{ "200":{ "description":"Membership fetched.", "schema":{ "$ref":"#/definitions/MembershipResponse" } }, "401":{ "description":"Authentication refused for provided credentials or the token is invalid.", "headers":{ "WWW_Authenticate":{ "type":"string" } } }, "404":{ "description":"Resource not found." }, "500":{ "description":"Internal server error." } }, "security":[ { "auth":[ ] } ], "x-internal-id":"memberships-{membershipId}-get", "x-filename-id":"memberships-membershipid-get" }, "put":{ "tags":[ "Memberships" ], "summary":"Update all properties of a membership.", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"membershipId", "in":"path", "description":"Unique identifier of Membership.", "required":true, "type":"number" }, { "in":"body", "name":"body", "description":"Membership object that needs to be updated.", "required":true, "schema":{ "$ref":"#/definitions/MembershipRequest" } } ], "responses":{ "200":{ "description":"Resource updated." }, "400":{ "$ref":"#/responses/400Error" }, "401":{ "$ref":"#/responses/401Error" }, "404":{ "$ref":"#/responses/404Error" }, "422":{ "$ref":"#/responses/422Error" }, "500":{ "$ref":"#/responses/500Error" } }, "security":[ { "auth":[ ] } ], "x-internal-id":"memberships-{membershipId}-put", "x-filename-id":"memberships-membershipid-put" }, "patch":{ "tags":[ "Memberships" ], "summary":"Update subset of properties of a membership.", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"membershipId", "in":"path", "description":"Unique identifier of Membership.", "required":true, "type":"number" }, { "in":"body", "name":"body", "description":"Membership object that needs to be updated.", "required":true, "schema":{ "$ref":"#/definitions/MembershipRequest" } } ], "responses":{ "200":{ "description":"Resource updated." }, "400":{ "$ref":"#/responses/400Error" }, "401":{ "$ref":"#/responses/401Error" }, "404":{ "$ref":"#/responses/404Error" }, "422":{ "$ref":"#/responses/422Error" }, "500":{ "$ref":"#/responses/500Error" } }, "security":[ { "auth":[ ] } ], "x-internal-id":"memberships-{membershipId}-patch", "x-filename-id":"memberships-membershipid-patch" } }, "/memberships/{membershipId}/customFieldValues":{ "get":{ "tags":[ "Memberships" ], "summary":"Get a list of custom field values", "produces":[ "application/json" ], "parameters":[ { "name":"membershipId", "in":"path", "description":"Unique identifier of a Membership.", "required":true, "type":"number" }, { "name":"totalResults", "in":"query", "description":"If set to true, the payload includes the total number of rows that satisfies the request. Use of this parameter determines if the 'last' link is displayed for a pageable collection.", "required":false, "type":"boolean" }, { "name":"limit", "in":"query", "description":"Specify how many items should be returned in a payload. Must be lower than server default limit size.", "required":false, "type":"integer" }, { "name":"offset", "in":"query", "description":"Specify starting point of the response.", "required":false, "type":"integer", "default":0 } ], "responses":{ "200":{ "description":"Custom field values collection fetched.", "examples":{ "application/json":{ "items":[ { "id":509614, "customFieldId":67, "customField":{ "links":[ { "rel":"canonical", "href":"https://{url}/learn.rest/v1/learnCenters/178418/userCustomFields/67" } ] }, "value":"JK", "links":[ { "rel":"canonical", "href":"https://{url}}m/learn.rest/v1/memberships/1234/customFieldValues/509614" } ] }, { "...":null } ], "totalResults":1200, "limit":100, "count":100, "hasMore":true, "links":[ { "rel":"canonical", "href":"{url}/learn.rest/v1/collectionName" }, { "rel":"first", "href":"{url}/v1/collectionName?limit=100&offset=0" }, { "rel":"prev", "href":"{url}/learn.rest/v1/collectionName?limit=100&offset=0" }, { "rel":"next", "href":"{url}/learn.rest/v1/collectionName?limit=100&offset=10" }, { "rel":"last", "href":"{url}/learn.rest/v1/collectionName?limit=100&offset=1200" } ] } } }, "401":{ "description":"Authentication refused for provided credentials or the token is invalid.", "headers":{ "WWW_Authenticate":{ "type":"string" } } }, "500":{ "description":"Internal server error." } }, "security":[ { "auth":[ ] } ], "x-internal-id":"memberships-{membershipId}-customFieldValues-get", "x-filename-id":"memberships-membershipid-customfieldvalues-get" }, "post":{ "tags":[ "Memberships" ], "summary":"Create a new custom Field Value.", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"membershipId", "in":"path", "description":"Unique identifier of a Membership.", "required":true, "type":"number" }, { "in":"body", "name":"body", "description":"Custom Field Value object that needs to be created.", "required":true, "schema":{ "$ref":"#/definitions/CustomFieldValueRequest" } } ], "responses":{ "201":{ "description":"New custom Field Value created.", "examples":{ "application/json":{ "id":"1", "customFieldId":"456", "customField":{ "links":[ { "rel":"canonical", "href":"{url}/learn.rest/v1/learnCenters/123/userCustomFields/456" } ] }, "value":"User Custom Field Value", "links":[ { "rel":"canonical", "href":"{url}/learn.rest/v1/learnCenters/456/userCustomFields/1" } ] } } }, "400":{ "$ref":"#/responses/400Error" }, "409":{ "$ref":"#/responses/409Error" }, "500":{ "$ref":"#/responses/500Error" } }, "security":[ { "auth":[ ] } ], "x-internal-id":"memberships-{membershipId}-customFieldValues-post", "x-filename-id":"memberships-membershipid-customfieldvalues-post" } }, "/memberships/{membershipId}/customerFieldValues/{customFieldValueId}":{ "get":{ "tags":[ "Memberships" ], "summary":"Get a custom field value", "operationId":"GET memberships/{membershipId}/customerFieldValues/{customFieldValueId}", "produces":[ "application/json" ], "parameters":[ { "name":"membershipId", "in":"path", "description":"Unique identifier of Membership.", "required":true, "type":"number" }, { "name":"customFieldValueId", "in":"path", "description":"Unique identifier of custom field.", "required":true, "type":"number" } ], "responses":{ "200":{ "description":"Custom field fetched.", "schema":{ "$ref":"#/definitions/CustomFieldValueResponse" } }, "401":{ "description":"Authentication refused for provided credentials or the token is invalid.", "headers":{ "WWW_Authenticate":{ "type":"string" } } }, "404":{ "description":"Resource not found." }, "500":{ "$ref":"#/responses/500Error" } }, "security":[ { "auth":[ ] } ], "x-internal-id":"memberships-{membershipId}-customerFieldValues-{customFieldValueId}-get", "x-filename-id":"memberships-membershipid-customerfieldvalues-customfieldvalueid-get" }, "put":{ "tags":[ "Memberships" ], "summary":"Update all properties of a custom field value", "consumes":[ "application/json" ], "parameters":[ { "name":"membershipId", "in":"path", "description":"Unique identifier of Membership.", "required":true, "type":"number" }, { "name":"customFieldValueId", "in":"path", "description":"Unique identifier of custom field.", "required":true, "type":"number" }, { "in":"body", "name":"body", "description":"Custom field value object that needs to be updated.", "required":true, "schema":{ "$ref":"#/definitions/CustomFieldValueRequest" } } ], "responses":{ "200":{ "description":"Resource updated." }, "400":{ "$ref":"#/responses/400Error" }, "401":{ "$ref":"#/responses/401Error" }, "404":{ "$ref":"#/responses/404Error" }, "422":{ "$ref":"#/responses/422Error" }, "500":{ "$ref":"#/responses/500Error" } }, "security":[ { "auth":[ ] } ], "x-internal-id":"memberships-{membershipId}-customerFieldValues-{customFieldValueId}-put", "x-filename-id":"memberships-membershipid-customerfieldvalues-customfieldvalueid-put" }, "delete":{ "tags":[ "Memberships" ], "summary":"Delete a custom field value", "parameters":[ { "name":"membershipId", "in":"path", "description":"Unique identifier of Membership.", "required":true, "type":"number" }, { "name":"customFieldValueId", "in":"path", "description":"Unique identifier of custom field.", "required":true, "type":"number" } ], "responses":{ "204":{ "description":"Resource deleted." }, "401":{ "$ref":"#/responses/401Error" }, "404":{ "$ref":"#/responses/404Error" }, "500":{ "$ref":"#/responses/500Error" } }, "security":[ { "auth":[ ] } ], "x-internal-id":"memberships-{membershipId}-customerFieldValues-{customFieldValueId}-delete", "x-filename-id":"memberships-membershipid-customerfieldvalues-customfieldvalueid-delete" } }, "/memberships/{membershipId}/customFieldValues/{userCustomFieldValueId}":{ "get":{ "tags":[ "Memberships" ], "summary":"Get a user custom field value", "operationId":"GET memberships/{membershipId}/customFieldValues/{userCustomFieldValueId}", "produces":[ "application/json" ], "parameters":[ { "name":"membershipId", "in":"path", "description":"Unique identifier of Membership.", "required":true, "type":"number" }, { "name":"userCustomFieldValueId", "in":"path", "description":"Unique identifier of custom field.", "required":true, "type":"number" } ], "responses":{ "200":{ "description":"Custom field value fetched.", "examples":{ "application/json":{ "id":1661914, "customFieldId":354, "customField":{ "links":[ { "rel":"canonical", "href":"{url}/learn.rest/v1/learnCenters/178409/userCustomFields/354" }, { "rel":"canonical", "href":"{url}/learn.rest/v1/learnCenters/189353/userCustomFields/354" } ] }, "value":"", "links":[ { "rel":"canonical", "href":"{url}/learn.rest/v1/memberships/1235843/customFieldValues/1661914" } ] } } }, "401":{ "description":"Authentication refused for provided credentials or the token is invalid.", "headers":{ "WWW_Authenticate":{ "type":"string" } } }, "404":{ "description":"Resource not found." }, "500":{ "$ref":"#/responses/500Error" } }, "security":[ { "auth":[ ] } ], "x-internal-id":"memberships-{membershipId}-customFieldValues-{userCustomFieldValueId}-get", "x-filename-id":"memberships-membershipid-customfieldvalues-usercustomfieldvalueid-get" }, "put":{ "tags":[ "Memberships" ], "summary":"Update all the properties of a custom field value", "consumes":[ "application/json" ], "parameters":[ { "name":"membershipId", "in":"path", "description":"Unique identifier of Membership.", "required":true, "type":"number" }, { "name":"userCustomFieldValueId", "in":"path", "description":"Unique identifier of custom field.", "required":true, "type":"number" }, { "in":"body", "name":"body", "description":"Custom field value object that needs to be updated", "required":true, "schema":{ "$ref":"#/definitions/UserCustomFieldValueRequest" } } ], "responses":{ "200":{ "description":"Resource updated." }, "400":{ "$ref":"#/responses/400Error" }, "401":{ "$ref":"#/responses/401Error" }, "404":{ "$ref":"#/responses/404Error" }, "422":{ "$ref":"#/responses/422Error" }, "500":{ "$ref":"#/responses/500Error" } }, "security":[ { "auth":[ ] } ], "x-internal-id":"memberships-{membershipId}-customFieldValues-{userCustomFieldValueId}-put", "x-filename-id":"memberships-membershipid-customfieldvalues-usercustomfieldvalueid-put" }, "delete":{ "tags":[ "Memberships" ], "summary":"Delete a user custom field value", "parameters":[ { "name":"membershipId", "in":"path", "description":"Unique identifier of Membership.", "required":true, "type":"number" }, { "name":"userCustomFieldValueId", "in":"path", "description":"Unique identifier of the custom field.", "required":true, "type":"number" } ], "responses":{ "204":{ "description":"Resource deleted." }, "401":{ "$ref":"#/responses/401Error" }, "404":{ "$ref":"#/responses/404Error" }, "500":{ "$ref":"#/responses/500Error" } }, "security":[ { "auth":[ ] } ], "x-internal-id":"memberships-{membershipId}-customFieldValues-{userCustomFieldValueId}-delete", "x-filename-id":"memberships-membershipid-customfieldvalues-usercustomfieldvalueid-delete" } }, "/learnCenters/{learnCenterId}/userCustomFields":{ "get":{ "tags":[ "User Custom Fields" ], "summary":"Get a list of user Custom Fields.", "operationId":"GET learnCenters/{learnCenterId}/userCustomFields", "produces":[ "application/xml", "application/json" ], "parameters":[ { "name":"learnCenterId", "in":"path", "description":"Unique identifier of a Learn Center.", "required":true, "type":"number" }, { "name":"totalResults", "in":"query", "description":"If set to true, the payload includes the total number of rows that satisfies the request. Use of this parameter determines if the last link is displayed for a pageable collection.", "required":false, "type":"boolean" }, { "name":"limit", "in":"query", "description":"Specify how many items should be returned in a payload. Must be lower than server default limit size.", "required":false, "type":"integer" }, { "name":"offset", "in":"query", "description":"Specify the starting point of the response.", "required":false, "type":"integer", "default":0 } ], "responses":{ "200":{ "description":"The user custom fields collection is fetched.", "schema":{ "$ref":"#/definitions/UserCustomFieldsResponse" } }, "401":{ "$ref":"#/responses/401Error" }, "500":{ "$ref":"#/responses/500Error" } }, "x-internal-id":"learnCenters-{learnCenterId}-userCustomFields-get", "x-filename-id":"learncenters-learncenterid-usercustomfields-get" }, "post":{ "tags":[ "User Custom Fields" ], "summary":"Create a new user Custom Field.", "operationId":"POST learnCenters/{learnCenterId}/userCustomFields", "consumes":[ "application/json" ], "produces":[ "application/xml", "application/json" ], "parameters":[ { "name":"learnCenterId", "in":"path", "description":"Unique identifier of a LearnCenter.", "required":true, "type":"number" }, { "in":"body", "name":"body", "description":"Custom field object that has to be created.", "required":true, "schema":{ "$ref":"#/definitions/UserCustomFieldRequest" } } ], "responses":{ "201":{ "description":"New user Custom Field resource created.", "schema":{ "$ref":"#/definitions/UserCustomFieldResponse" } }, "400":{ "$ref":"#/responses/400Error" }, "409":{ "$ref":"#/responses/409Error" }, "422":{ "$ref":"#/responses/422Error" }, "500":{ "$ref":"#/responses/500Error" } }, "x-internal-id":"learnCenters-{learnCenterId}-userCustomFields-post", "x-filename-id":"learncenters-learncenterid-usercustomfields-post" } }, "/learnCenters/{learnCenterId}/userCustomFields/{userCustomFieldId}":{ "get":{ "tags":[ "User Custom Fields" ], "summary":"Get a user Custom Field.", "operationId":"GET learnCenters/{learnCenterId}/userCustomFields/{userCustomFieldId}", "produces":[ "application/xml", "application/json" ], "parameters":[ { "name":"learnCenterId", "in":"path", "description":"Unique identifier of a LearnCenter.", "required":true, "type":"number" }, { "name":"userCustomFieldId", "in":"path", "description":"Unique identifier of a User Custom Field definition.", "required":true, "type":"number" } ], "responses":{ "200":{ "description":"User role is fetched.", "schema":{ "$ref":"#/definitions/UserCustomFieldResponse" } }, "401":{ "$ref":"#/responses/401Error" }, "404":{ "$ref":"#/responses/404Error" }, "500":{ "$ref":"#/responses/500Error" } }, "x-internal-id":"learnCenters-{learnCenterId}-userCustomFields-{userCustomFieldId}-get", "x-filename-id":"learncenters-learncenterid-usercustomfields-usercustomfieldid-get" }, "put":{ "tags":[ "User Custom Fields" ], "summary":"Update all properties of a user Custom Field.", "consumes":[ "application/json" ], "produces":[ "application/xml", "application/json" ], "parameters":[ { "name":"learnCenterId", "in":"path", "description":"Unique identifier of a LearnCenter.", "required":true, "type":"number" }, { "name":"userCustomFieldId", "in":"path", "description":"Unique identifier of a User Custom Field definition.", "required":true, "type":"number" }, { "in":"body", "name":"body", "description":"Custom field object that needs to be updated.", "required":true, "schema":{ "$ref":"#/definitions/UserCustomFieldRequest" } } ], "responses":{ "200":{ "description":"Resource updated." }, "400":{ "$ref":"#/responses/400Error" }, "401":{ "$ref":"#/responses/401Error" }, "404":{ "$ref":"#/responses/404Error" }, "500":{ "$ref":"#/responses/500Error" } }, "security":[ { "auth":[ ] } ], "x-internal-id":"learnCenters-{learnCenterId}-userCustomFields-{userCustomFieldId}-put", "x-filename-id":"learncenters-learncenterid-usercustomfields-usercustomfieldid-put" }, "patch":{ "tags":[ "User Custom Fields" ], "summary":"Update subset of properties of a userCustomField", "operationId":"PATCH learnCenters/{learnCenterId}/userCustomFields/{userCustomFieldId}", "consumes":[ "application/json" ], "produces":[ "application/xml", "application/json" ], "parameters":[ { "name":"learnCenterId", "in":"path", "description":"Unique identifier of a LearnCenter.", "required":true, "type":"number" }, { "name":"userCustomFieldId", "in":"path", "description":"Unique identifier of a User Custom Field definition.", "required":true, "type":"number" }, { "in":"body", "name":"body", "description":"Custom field object that needs to be updated.", "required":true, "schema":{ "$ref":"#/definitions/UserCustomFieldPartialRequest" } } ], "responses":{ "200":{ "description":"Resource updated." }, "400":{ "$ref":"#/responses/400Error" }, "401":{ "$ref":"#/responses/401Error" }, "404":{ "$ref":"#/responses/404Error" }, "500":{ "$ref":"#/responses/500Error" } }, "security":[ { "auth":[ ] } ], "x-internal-id":"learnCenters-{learnCenterId}-userCustomFields-{userCustomFieldId}-patch", "x-filename-id":"learncenters-learncenterid-usercustomfields-usercustomfieldid-patch" } }, "/learnCenters/{learnCenterId}/supervisorRoles":{ "get":{ "tags":[ "Supervisor Roles" ], "summary":"Get a list of supervisor roles in a LearnCenter.", "operationId":"GET learnCenters/{learnCenterId}/supervisorRoles", "produces":[ "application/json" ], "parameters":[ { "name":"learnCenterId", "in":"path", "description":"Unique identifier of a LearnCenter.", "required":true, "type":"number" }, { "name":"totalResults", "in":"query", "description":"If set to true, the payload includes total number of rows that satisfies the request. Use of this parameter determines if the 'last' link is displayed for a pageable collection.", "required":false, "type":"boolean" }, { "name":"limit", "in":"query", "description":"Specify how many items should be returned in a payload. Must be lower than server default limit size.", "required":false, "type":"integer" }, { "name":"offset", "in":"query", "description":"Specify starting point of the response.", "required":false, "type":"integer", "default":0 } ], "responses":{ "200":{ "description":"supervisor roles collection fetched", "schema":{ "$ref":"#/definitions/SupervisorRolesResponse" } } }, "x-internal-id":"learnCenters-{learnCenterId}-supervisorRoles-get", "x-filename-id":"learncenters-learncenterid-supervisorroles-get" }, "post":{ "tags":[ "Supervisor Roles" ], "summary":"Creates a new supervisor role.", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"learnCenterId", "in":"path", "description":"Unique identifier of a LearnCenter.", "required":true, "type":"number" }, { "in":"body", "name":"body", "description":"Supervisor role object that needs to be created.", "required":true, "schema":{ "$ref":"#/definitions/SupervisorRoleRequest" } } ], "responses":{ "201":{ "description":"New supervisor role is created.", "schema":{ "$ref":"#/definitions/SupervisorRoleRequest" } }, "400":{ "$ref":"#/responses/400Error" }, "401":{ "$ref":"#/responses/401Error" }, "404":{ "$ref":"#/responses/404Error" }, "422":{ "$ref":"#/responses/422Error" }, "500":{ "$ref":"#/responses/500Error" } }, "security":[ { "auth":[ ] } ], "x-internal-id":"learnCenters-{learnCenterId}-supervisorRoles-post", "x-filename-id":"learncenters-learncenterid-supervisorroles-post" } }, "/learnCenters/{learnCenterId}/supervisorRoles/{supervisorRoleId}":{ "get":{ "tags":[ "Supervisor Roles" ], "summary":"Get supervisor role details", "operationId":"GET learnCenters/{learnCenterId}/supervisorRoles/{supervisorRoleId}", "produces":[ "application/json" ], "parameters":[ { "name":"learnCenterId", "in":"path", "description":"Unique identifier of a LearnCenter.", "required":true, "type":"number" }, { "name":"supervisorRoleId", "in":"path", "description":"Unique identifier of a supervisor role.", "required":true, "type":"number" } ], "responses":{ "200":{ "description":"Supervisor role fetched successfully.", "schema":{ "$ref":"#/definitions/SupervisorRoleResponse" } } }, "x-internal-id":"learnCenters-{learnCenterId}-supervisorRoles-{supervisorRoleId}-get", "x-filename-id":"learncenters-learncenterid-supervisorroles-supervisorroleid-get" }, "put":{ "tags":[ "Supervisor Roles" ], "summary":"Update all properties of a supervisor role.", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"learnCenterId", "in":"path", "description":"Unique identifier of a LearnCenter.", "required":true, "type":"number" }, { "name":"supervisorRoleId", "in":"path", "description":"Unique identifier of a supervisor role.", "required":true, "type":"number" }, { "in":"body", "name":"body", "description":"Supervisor role object that needs to be updated.", "required":true, "schema":{ "$ref":"#/definitions/SupervisorRoleRequest" } } ], "responses":{ "200":{ "description":"Resource updated." }, "400":{ "$ref":"#/responses/400Error" }, "401":{ "$ref":"#/responses/401Error" }, "404":{ "$ref":"#/responses/404Error" }, "422":{ "$ref":"#/responses/422Error" }, "500":{ "$ref":"#/responses/500Error" } }, "security":[ { "auth":[ ] } ], "x-internal-id":"learnCenters-{learnCenterId}-supervisorRoles-{supervisorRoleId}-put", "x-filename-id":"learncenters-learncenterid-supervisorroles-supervisorroleid-put" }, "patch":{ "tags":[ "Supervisor Roles" ], "summary":"Updates subset of properties for a supervisor role.", "operationId":"PATCH learnCenters/{learnCenterId}/supervisorRoles/{supervisorRoleId}", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"learnCenterId", "in":"path", "description":"Unique identifier of a LearnCenter.", "required":true, "type":"number" }, { "name":"supervisorRoleId", "in":"path", "description":"Unique identifier of a supervisor role.", "required":true, "type":"number" }, { "in":"body", "name":"body", "description":"Supervisor role object that needs to be created.", "required":true, "schema":{ "$ref":"#/definitions/SupervisorRoleRequest" } } ], "responses":{ "200":{ "description":"Resource updated." }, "400":{ "$ref":"#/responses/400Error" }, "401":{ "$ref":"#/responses/401Error" }, "404":{ "$ref":"#/responses/404Error" }, "422":{ "$ref":"#/responses/422Error" }, "500":{ "$ref":"#/responses/500Error" } }, "security":[ { "auth":[ ] } ], "x-internal-id":"learnCenters-{learnCenterId}-supervisorRoles-{supervisorRoleId}-patch", "x-filename-id":"learncenters-learncenterid-supervisorroles-supervisorroleid-patch" } }, "/learnCenters/{learnCenterId}/supervisorRoles/{supervisorRoleId}/supervisorAccounts/{supervisorAccountId}":{ "get":{ "tags":[ "Supervisor Roles" ], "summary":"Get mapping details of supervisor accounts mapped to a supervisor role in a LearnCenter", "operationId":"GET learnCenters/{learnCenterId}/supervisorRoles/{supervisorRoleId}/supervisorAccounts/{supervisorAccountId}", "produces":[ "application/json" ], "parameters":[ { "name":"learnCenterId", "in":"path", "description":"Unique identifier of a LearnCenter.", "required":true, "type":"number" }, { "name":"supervisorRoleId", "in":"path", "description":"Unique identifier of a supervisor role.", "required":true, "type":"number" }, { "name":"supervisorAccountId", "in":"path", "description":"Unique identifier of a supervisor account.", "required":true, "type":"string" } ], "responses":{ "200":{ "description":"Supervisor accounts collection fetched.", "schema":{ "$ref":"#/definitions/SupervisorAccountSupervisorRoleResponse" } }, "401":{ "$ref":"#/responses/401Error" }, "500":{ "$ref":"#/responses/500Error" } }, "x-internal-id":"learnCenters-{learnCenterId}-supervisorRoles-{supervisorRoleId}-supervisorAccounts-{supervisorAccountId}-get", "x-filename-id":"learncenters-learncenterid-supervisorroles-supervisorroleid-supervisoraccounts-supervisoraccountid-get" }, "put":{ "tags":[ "Supervisor Roles" ], "summary":"Update all properties of a supervisor role and supervisor account.", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"learnCenterId", "in":"path", "description":"Unique identifier of a LearnCenter.", "required":true, "type":"number" }, { "name":"supervisorRoleId", "in":"path", "description":"Unique identifier of a supervisor role.", "required":true, "type":"number" }, { "name":"supervisorAccountId", "in":"path", "description":"Unique identifier of a supervisor account.", "required":true, "type":"string" }, { "in":"body", "name":"body", "description":"Supervisor role and supervisor account mapping object that needs to be updated", "required":true, "schema":{ "$ref":"#/definitions/SupervisorRoleSupervisorAccountMappingRequest" } } ], "responses":{ "200":{ "description":"Resource updated." }, "400":{ "$ref":"#/responses/400Error" }, "401":{ "$ref":"#/responses/401Error" }, "404":{ "$ref":"#/responses/404Error" }, "422":{ "$ref":"#/responses/422Error" }, "500":{ "$ref":"#/responses/500Error" } }, "security":[ { "auth":[ ] } ], "x-internal-id":"learnCenters-{learnCenterId}-supervisorRoles-{supervisorRoleId}-supervisorAccounts-{supervisorAccountId}-put", "x-filename-id":"learncenters-learncenterid-supervisorroles-supervisorroleid-supervisoraccounts-supervisoraccountid-put" }, "patch":{ "tags":[ "Supervisor Roles" ], "summary":"Updates subset of properties for a supervisor role and supervisor account mapping.", "operationId":"PATCH learnCenters/{learnCenterId}/supervisorRoles/{supervisorRoleId}/supervisorAccounts/{supervisorAccountId}", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"learnCenterId", "in":"path", "description":"Unique identifier of a LearnCenter.", "required":true, "type":"number" }, { "name":"supervisorRoleId", "in":"path", "description":"Unique identifier of a supervisor role.", "required":true, "type":"number" }, { "name":"supervisorAccountId", "in":"path", "description":"Unique identifier of a supervisor account.", "required":true, "type":"string" }, { "in":"body", "name":"body", "description":"Supervisor role and supervisor account mapping object that needs to be updated.", "required":true, "schema":{ "$ref":"#/definitions/SupervisorRoleSupervisorAccountMappingRequest" } } ], "responses":{ "200":{ "description":"Resource updated." }, "400":{ "$ref":"#/responses/400Error" }, "401":{ "$ref":"#/responses/401Error" }, "404":{ "$ref":"#/responses/404Error" }, "422":{ "$ref":"#/responses/422Error" }, "500":{ "$ref":"#/responses/500Error" } }, "security":[ { "auth":[ ] } ], "x-internal-id":"learnCenters-{learnCenterId}-supervisorRoles-{supervisorRoleId}-supervisorAccounts-{supervisorAccountId}-patch", "x-filename-id":"learncenters-learncenterid-supervisorroles-supervisorroleid-supervisoraccounts-supervisoraccountid-patch" } }, "/learnCenters/{learnCenterId}/userRoles":{ "get":{ "tags":[ "User Roles" ], "summary":"Get a list of user role in a LearnCenter.", "operationId":"GET learnCenters/{learnCenterId}/userRoles", "produces":[ "application/json" ], "parameters":[ { "name":"learnCenterId", "in":"path", "description":"Unique identifier of a LearnCenter.", "required":true, "type":"number" }, { "name":"totalResults", "in":"query", "description":"If set to true, the payload includes a total number of rows that satisfies the request. Use of this parameter determines if the 'last' link is displayed for a pageable collection.", "required":false, "type":"boolean" }, { "name":"limit", "in":"query", "description":"Specify how many items should be returned in a payload. Must be lower than server default limit size.", "required":false, "type":"integer" }, { "name":"offset", "in":"query", "description":"Specify starting point of the response.", "required":false, "type":"integer", "default":0 } ], "responses":{ "200":{ "description":"The user roles collection is fetched.", "schema":{ "$ref":"#/definitions/UserRolesResponse" } } }, "x-internal-id":"learnCenters-{learnCenterId}-userRoles-get", "x-filename-id":"learncenters-learncenterid-userroles-get" }, "post":{ "tags":[ "User Roles" ], "summary":"Creates a new user role", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"learnCenterId", "in":"path", "description":"Unique identifier of a LearnCenter.", "required":true, "type":"number" }, { "in":"body", "name":"body", "description":"User role object that needs to be created.", "required":true, "schema":{ "$ref":"#/definitions/UserRoleRequest" } } ], "responses":{ "201":{ "description":"A new user role is created.", "schema":{ "$ref":"#/definitions/UserRoleResponse" } }, "400":{ "$ref":"#/responses/400Error" }, "401":{ "$ref":"#/responses/401Error" }, "404":{ "$ref":"#/responses/404Error" }, "422":{ "$ref":"#/responses/422Error" }, "500":{ "$ref":"#/responses/500Error" } }, "security":[ { "auth":[ ] } ], "x-internal-id":"learnCenters-{learnCenterId}-userRoles-post", "x-filename-id":"learncenters-learncenterid-userroles-post" } }, "/learnCenters/{learnCenterId}/userRoles/{userRoleId}":{ "get":{ "tags":[ "User Roles" ], "summary":"Get user role details", "operationId":"GET learnCenters/{learnCenterId}/userRoles/{userRoleId}", "produces":[ "application/xml", "application/json" ], "parameters":[ { "name":"learnCenterId", "in":"path", "description":"Unique identifier of a LearnCenter.", "required":true, "type":"number" }, { "name":"userRoleId", "in":"path", "description":"Unique identifier of a user role", "required":true, "type":"number" } ], "responses":{ "200":{ "description":"User role is fetched.", "schema":{ "$ref":"#/definitions/UserRoleResponse" } } }, "x-internal-id":"learnCenters-{learnCenterId}-userRoles-{userRoleId}-get", "x-filename-id":"learncenters-learncenterid-userroles-userroleid-get" }, "put":{ "tags":[ "User Roles" ], "summary":"Update all properties of a user role.", "consumes":[ "application/json" ], "produces":[ "application/xml", "application/json" ], "parameters":[ { "name":"learnCenterId", "in":"path", "description":"Unique identifier of a LearnCenter.", "required":true, "type":"number" }, { "name":"userRoleId", "in":"path", "description":"Unique identifier of a user role.", "required":true, "type":"number" }, { "in":"body", "name":"body", "description":"User role object that needs to be updated.", "required":true, "schema":{ "$ref":"#/definitions/UserRoleRequest" } } ], "responses":{ "200":{ "description":"Resource updated." }, "400":{ "$ref":"#/responses/400Error" }, "401":{ "$ref":"#/responses/401Error" }, "404":{ "$ref":"#/responses/404Error" }, "422":{ "$ref":"#/responses/422Error" }, "500":{ "$ref":"#/responses/500Error" } }, "security":[ { "auth":[ ] } ], "x-internal-id":"learnCenters-{learnCenterId}-userRoles-{userRoleId}-put", "x-filename-id":"learncenters-learncenterid-userroles-userroleid-put" }, "patch":{ "tags":[ "User Roles" ], "summary":"Updates subset of properties for a user role.", "operationId":"PATCH learnCenters/{learnCenterId}/userRoles", "consumes":[ "application/json" ], "produces":[ "application/xml", "application/json" ], "parameters":[ { "name":"learnCenterId", "in":"path", "description":"Unique identifier of a LearnCenter.", "required":true, "type":"number" }, { "name":"userRoleId", "in":"path", "description":"Unique identifier of a user role.", "required":true, "type":"number" }, { "in":"body", "name":"body", "description":"User role object that needs to be created.", "required":true, "schema":{ "$ref":"#/definitions/UserRoleRequest" } } ], "responses":{ "200":{ "description":"Resource updated." }, "400":{ "$ref":"#/responses/400Error" }, "401":{ "$ref":"#/responses/401Error" }, "404":{ "$ref":"#/responses/404Error" }, "422":{ "$ref":"#/responses/422Error" }, "500":{ "$ref":"#/responses/500Error" } }, "security":[ { "auth":[ ] } ], "x-internal-id":"learnCenters-{learnCenterId}-userRoles-{userRoleId}-patch", "x-filename-id":"learncenters-learncenterid-userroles-userroleid-patch" } }, "/learnCenters/{learnCenterId}/userRoles/{userRoleId}/users":{ "get":{ "tags":[ "User Roles" ], "summary":"Get a list of users mapped to a user role in a learnCenter.", "operationId":"GET learnCenters/{learnCenterId}/userRoles/{userRoleId}/users", "produces":[ "application/xml", "application/json" ], "parameters":[ { "name":"learnCenterId", "in":"path", "description":"Unique identifier of a LearnCenter.", "required":true, "type":"number" }, { "name":"userRoleId", "in":"path", "description":"Unique identifier of a user role.", "required":true, "type":"number" }, { "name":"totalResults", "in":"query", "description":"If set to true, the payload includes a total number of rows that satisfies the request. Use of this parameter determines if the 'last' link is displayed for a pageable collection.", "required":false, "type":"boolean" }, { "name":"limit", "in":"query", "description":"Specify how many items should be returned in a payload. Must be lower than server default limit size.", "required":false, "type":"integer" }, { "name":"offset", "in":"query", "description":"Specify starting point of the response.", "required":false, "type":"integer", "default":0 } ], "responses":{ "200":{ "description":"Users collection fetched.", "schema":{ "$ref":"#/definitions/UsersResponse" } }, "401":{ "$ref":"#/responses/401Error" }, "500":{ "$ref":"#/responses/500Error" } }, "x-internal-id":"learnCenters-{learnCenterId}-userRoles-{userRoleId}-users-get", "x-filename-id":"learncenters-learncenterid-userroles-userroleid-users-get" }, "post":{ "tags":[ "User Roles" ], "summary":"Creates a new user and role mapping.", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"learnCenterId", "in":"path", "description":"Unique identifier of a LearnCenter.", "required":true, "type":"number" }, { "name":"userRoleId", "in":"path", "description":"Unique identifier of a user role.", "required":true, "type":"number" }, { "in":"body", "name":"body", "description":"User and role mapping object that needs to be created.", "required":true, "schema":{ "$ref":"#/definitions/UserRolesMappingRequest" } } ], "responses":{ "201":{ "description":"New user and role mapping created.", "schema":{ "$ref":"#/definitions/UserRoleUserResponse" } }, "400":{ "$ref":"#/responses/400Error" }, "401":{ "$ref":"#/responses/401Error" }, "404":{ "$ref":"#/responses/404Error" }, "422":{ "$ref":"#/responses/422Error" }, "500":{ "$ref":"#/responses/500Error" } }, "security":[ { "auth":[ ] } ], "x-internal-id":"learnCenters-{learnCenterId}-userRoles-{userRoleId}-users-post", "x-filename-id":"learncenters-learncenterid-userroles-userroleid-users-post" } }, "/learnCenters/{learnCenterId}/groups":{ "get":{ "tags":[ "Groups" ], "summary":"Get a list of groups in LearnCenter.", "operationId":"GET learnCenters/{learnCenterId}/groups", "produces":[ "application/json" ], "parameters":[ { "name":"learnCenterId", "in":"path", "description":"Unique identifier for LearnCenter.", "required":true, "type":"number" }, { "name":"totalResults", "in":"query", "description":"If set to true, payload includes total number of rows that satisfies the request. Use of parameter determines if the 'last' link is displayed for a pageable collection.", "required":false, "type":"boolean" }, { "name":"limit", "in":"query", "description":"Specify how many items should be returned in a payload. Must be lower than server default limit size.", "required":false, "type":"integer" }, { "name":"offset", "in":"query", "description":"Specify starting point of the response.", "required":false, "type":"integer", "default":0 } ], "responses":{ "200":{ "description":"Groups collection fetched.", "schema":{ "$ref":"#/definitions/GroupsResponse" } }, "401":{ "$ref":"#/responses/401Error" }, "500":{ "$ref":"#/responses/500Error" } }, "x-internal-id":"learnCenters-{learnCenterId}-groups-get", "x-filename-id":"learncenters-learncenterid-groups-get" }, "post":{ "tags":[ "Groups" ], "summary":"Creates a new group", "operationId":"POST learnCenters/{learnCenterId}/groups", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"learnCenterId", "in":"path", "description":"Unique identifier of a LearnCenter.", "required":true, "type":"number" }, { "in":"body", "name":"body", "description":"Group object that needs to be created.", "required":true, "schema":{ "$ref":"#/definitions/GroupRequest" } } ], "responses":{ "201":{ "description":"New group resource created.", "schema":{ "$ref":"#/definitions/GroupResponse" } }, "400":{ "$ref":"#/responses/400Error" }, "409":{ "$ref":"#/responses/409Error" }, "500":{ "$ref":"#/responses/500Error" } }, "security":[ { "auth":[ ] } ], "x-internal-id":"learnCenters-{learnCenterId}-groups-post", "x-filename-id":"learncenters-learncenterid-groups-post" } }, "/learnCenters/{learnCenterId}/groups/{groupId}":{ "get":{ "tags":[ "Groups" ], "summary":"Get group details by group id.", "operationId":"GET learnCenters/{learnCenterId}/groups/{groupdId}", "produces":[ "application/json" ], "parameters":[ { "name":"learnCenterId", "in":"path", "description":"Unique identifier of LearnCenter.", "required":true, "type":"number" }, { "name":"groupId", "in":"path", "description":"Unique identifier of a group.", "required":true, "type":"number" } ], "responses":{ "200":{ "description":"Group fetched.", "schema":{ "$ref":"#/definitions/GroupResponse" } } }, "x-internal-id":"learnCenters-{learnCenterId}-groups-{groupId}-get", "x-filename-id":"learncenters-learncenterid-groups-groupid-get" }, "put":{ "tags":[ "Groups" ], "summary":"Update all properties of a group", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"learnCenterId", "in":"path", "description":"Unique identifier of LearnCenter.", "required":true, "type":"number" }, { "name":"groupId", "in":"path", "description":"Unique identifier of a group.", "required":true, "type":"number" }, { "in":"body", "name":"body", "description":"Group object that needs to be updated.", "required":true, "schema":{ "$ref":"#/definitions/GroupRequest" } } ], "responses":{ "200":{ "description":"Resource updated." }, "400":{ "$ref":"#/responses/400Error" }, "401":{ "$ref":"#/responses/401Error" }, "404":{ "$ref":"#/responses/404Error" }, "422":{ "$ref":"#/responses/422Error" }, "500":{ "$ref":"#/responses/500Error" } }, "security":[ { "auth":[ ] } ], "x-internal-id":"learnCenters-{learnCenterId}-groups-{groupId}-put", "x-filename-id":"learncenters-learncenterid-groups-groupid-put" }, "patch":{ "tags":[ "Groups" ], "summary":"Updates subset of properties for a group", "operationId":"learnCenters/{learnCenterId}/groups/PATCH", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"learnCenterId", "in":"path", "description":"Unique identifier of LearnCenter.", "required":true, "type":"number" }, { "name":"groupId", "in":"path", "description":"Unique identifier of a group.", "required":true, "type":"number" }, { "in":"body", "name":"body", "description":"Group object that needs to be created.", "required":true, "schema":{ "$ref":"#/definitions/GroupRequest" } } ], "responses":{ "200":{ "description":"Resource updated." }, "400":{ "$ref":"#/responses/400Error" }, "401":{ "$ref":"#/responses/401Error" }, "404":{ "$ref":"#/responses/404Error" }, "422":{ "$ref":"#/responses/422Error" }, "500":{ "$ref":"#/responses/500Error" } }, "security":[ { "auth":[ ] } ], "x-internal-id":"learnCenters-{learnCenterId}-groups-{groupId}-patch", "x-filename-id":"learncenters-learncenterid-groups-groupid-patch" } }, "/learnCenters/{learnCenterId}/groups/{groupId}/owners":{ "get":{ "tags":[ "Groups" ], "summary":"Get a list of owners for groups in LearnCenter.", "operationId":"GET learnCenters/{learnCenterId}/groups/{groupId}/owners", "produces":[ "application/json" ], "parameters":[ { "name":"learnCenterId", "in":"path", "description":"Unique identifier of LearnCenter.", "required":true, "type":"number" }, { "name":"groupId", "in":"path", "description":"Unique identifier of a group.", "required":true, "type":"number" }, { "name":"totalResults", "in":"query", "description":"If set to true, payload includes the total number of rows that satisfies the request. This parameter determines if the 'last' link is displayed for a pageable collection.", "required":false, "type":"boolean" }, { "name":"limit", "in":"query", "description":"Specify how many items should be returned in a payload. Must be lower than server default limit size.", "required":false, "type":"integer" }, { "name":"offset", "in":"query", "description":"Specify starting point of the response.", "required":false, "type":"integer", "default":0 } ], "responses":{ "200":{ "description":"Group owners collection fetched.", "schema":{ "$ref":"#/definitions/GroupOwnersResponse" }, "examples":{ "application/json":{ "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" } ] } } }, "401":{ "$ref":"#/responses/401Error" }, "500":{ "$ref":"#/responses/500Error" } }, "x-internal-id":"learnCenters-{learnCenterId}-groups-{groupId}-owners-get", "x-filename-id":"learncenters-learncenterid-groups-groupid-owners-get" } }, "/learnCenters/{learnCenterId}/groups/{groupId}/owners/{ownerId}":{ "get":{ "tags":[ "Groups" ], "summary":"Get the owner for a group in LearnCenter using Owner Id.", "operationId":"GET learnCenters/{learnCenterId}/groups/{groupId}/owners/{ownerId}", "produces":[ "application/json" ], "parameters":[ { "name":"learnCenterId", "in":"path", "description":"Unique identifier of LearnCenter.", "required":true, "type":"number" }, { "name":"groupId", "in":"path", "description":"Unique identifier of the Group.", "required":true, "type":"number" }, { "name":"ownerId", "in":"path", "description":"Unique identifier of the group owner.", "required":true, "type":"number" } ], "responses":{ "200":{ "description":"Group owner details fetched.", "schema":{ "$ref":"#/definitions/UserResponse" } }, "401":{ "$ref":"#/responses/401Error" }, "500":{ "$ref":"#/responses/500Error" } }, "x-internal-id":"learnCenters-{learnCenterId}-groups-{groupId}-owners-{ownerId}-get", "x-filename-id":"learncenters-learncenterid-groups-groupid-owners-ownerid-get" } }, "/learnCenters/{learnCenterId}/groups/{groupId}/users":{ "get":{ "tags":[ "Groups" ], "summary":"Get a list of users mapped to groups in LearnCenter", "operationId":"GET learnCenters/{learnCenterId}/groups/{groupId}/users", "produces":[ "application/json" ], "parameters":[ { "name":"learnCenterId", "in":"path", "description":"Unique identifier of LearnCenter.", "required":true, "type":"number" }, { "name":"groupId", "in":"path", "description":"Unique identifier of a Group.", "required":true, "type":"number" }, { "name":"totalResults", "in":"query", "description":"If set to true, the payload includes the total number of rows that satisfies the request. The use of this parameter determines if the 'last' link is displayed for a pageable collection.", "required":false, "type":"boolean" }, { "name":"limit", "in":"query", "description":"Specifies how many items should be returned in a payload. Must be lower than server default limit size.", "required":false, "type":"integer" }, { "name":"offset", "in":"query", "description":"Specify the starting point of the response.", "required":false, "type":"integer", "default":0 } ], "responses":{ "200":{ "description":"Group users collection fetched.", "schema":{ "$ref":"#/definitions/GroupUsersResponse" } }, "401":{ "$ref":"#/responses/401Error" }, "500":{ "$ref":"#/responses/500Error" } }, "x-internal-id":"learnCenters-{learnCenterId}-groups-{groupId}-users-get", "x-filename-id":"learncenters-learncenterid-groups-groupid-users-get" }, "post":{ "tags":[ "Groups" ], "summary":"Creates a new group user mapping", "operationId":"POST learnCenters/{learnCenterId}/groups/{groupId}/users", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"learnCenterId", "in":"path", "description":"Unique identifier of LearnCenter.", "required":true, "type":"number" }, { "name":"groupId", "in":"path", "description":"Unique identifier of a Group.", "required":true, "type":"number" }, { "in":"body", "name":"body", "description":"Group object that needs to be created.", "required":true, "schema":{ "$ref":"#/definitions/GroupUserRequest" } } ], "responses":{ "201":{ "description":"New group user mapping has been created." }, "400":{ "$ref":"#/responses/400Error" }, "409":{ "$ref":"#/responses/409Error" }, "500":{ "$ref":"#/responses/500Error" } }, "security":[ { "auth":[ ] } ], "x-internal-id":"learnCenters-{learnCenterId}-groups-{groupId}-users-post", "x-filename-id":"learncenters-learncenterid-groups-groupid-users-post" } }, "/learnCenters/{learnCenterId}/groups/{groupId}/Users/{userId}":{ "get":{ "tags":[ "Groups" ], "summary":"Get group user details by user id.", "operationId":"GET learnCenters/{learnCenterId}/groups/{groupId}/Users/{userId}", "produces":[ "application/json" ], "parameters":[ { "name":"learnCenterId", "in":"path", "description":"Unique identifier of LearnCenter.", "required":true, "type":"number" }, { "name":"groupId", "in":"path", "description":"Unique identifier of a group.", "required":true, "type":"number" }, { "name":"userId", "in":"path", "description":"Unique identifier of a user.", "required":true, "type":"number" } ], "responses":{ "200":{ "description":"Group user details fetched.", "examples":{ "application/json":{ "groupId":1202, "group":{ "links":[ { "rel":"canonical", "href":"{url}/learn.rest/v1/learnCenters/189353/groups/1202" } ] }, "userId":1137009, "user":{ "links":[ { "rel":"canonical", "href":"{url}/learn.rest/v1/users/1137009" } ] }, "statusFlag":true, "excludeFlag":false, "links":[ { "rel":"canonical", "href":"{url}/learn.rest/v1/learnCenters/189353/groups/1202/users/1137009" } ] } } } }, "x-internal-id":"learnCenters-{learnCenterId}-groups-{groupId}-Users-{userId}-get", "x-filename-id":"learncenters-learncenterid-groups-groupid-users-userid-get" }, "put":{ "tags":[ "Groups" ], "summary":"Updates a group user mapped item", "operationId":"PUT learnCenters/{learnCenterId}/groups/{groupId}/Users/{userId}", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"learnCenterId", "in":"path", "description":"Unique identifier of LearnCenter.", "required":true, "type":"number" }, { "name":"groupId", "in":"path", "description":"Unique identifier of a Group.", "required":true, "type":"number" }, { "name":"userId", "in":"path", "description":"Unique identifier of a user.", "required":true, "type":"number" }, { "in":"body", "name":"body", "description":"Group mapped item object that needs to be updated.", "required":true, "schema":{ "$ref":"#/definitions/GroupUserMappedItemRequest" } } ], "responses":{ "200":{ "description":"updated a mapping of group to an item." }, "400":{ "$ref":"#/responses/400Error" }, "409":{ "$ref":"#/responses/409Error" }, "500":{ "$ref":"#/responses/500Error" } }, "x-internal-id":"learnCenters-{learnCenterId}-groups-{groupId}-Users-{userId}-put", "x-filename-id":"learncenters-learncenterid-groups-groupid-users-userid-put" }, "delete":{ "tags":[ "Groups" ], "summary":"Deletes a group user mapped item", "operationId":"DELETE learnCenters/{learnCenterId}/groups/{groupId}/Users/{userId}", "consumes":[ "application/json" ], "produces":[ "application/xml", "application/json" ], "parameters":[ { "name":"learnCenterId", "in":"path", "description":"Unique identifier of a LearnCenter.", "required":true, "type":"number" }, { "name":"groupId", "in":"path", "description":"Unique identifier of a Group.", "required":true, "type":"number" }, { "name":"userId", "in":"path", "description":"Unique identifier of a user.", "required":true, "type":"number" } ], "responses":{ "200":{ "description":"Group user mapping is deleted." }, "400":{ "$ref":"#/responses/400Error" }, "409":{ "$ref":"#/responses/409Error" }, "500":{ "$ref":"#/responses/500Error" } }, "x-internal-id":"learnCenters-{learnCenterId}-groups-{groupId}-Users-{userId}-delete", "x-filename-id":"learncenters-learncenterid-groups-groupid-users-userid-delete" } }, "/learnCenters/{learnCenterId}/groups/{groupId}/mappedItems":{ "get":{ "tags":[ "Groups" ], "summary":"Get a list of items mapped to a group in LearnCenter.", "operationId":"GET learnCenters/{learnCenterId}/groups/{groupId}/mappedItems", "produces":[ "application/json" ], "parameters":[ { "name":"learnCenterId", "in":"path", "description":"Unique identifier of a LearnCenter.", "required":true, "type":"number" }, { "name":"groupId", "in":"path", "description":"Unique identifier of a Group.", "required":true, "type":"number" }, { "name":"totalResults", "in":"query", "description":"If set to true, payload includes the total number of rows that satisfies the request. Use of this parameter determines if the 'last' link is displayed for a pageable collection.", "required":false, "type":"boolean" }, { "name":"limit", "in":"query", "description":"Specify how many items should be returned in a payload. Must be lower than server default limit size.", "required":false, "type":"integer" }, { "name":"offset", "in":"query", "description":"Specify starting point of the response.", "required":false, "type":"integer", "default":0 } ], "responses":{ "200":{ "description":"Group owners collection fetched.", "schema":{ "$ref":"#/definitions/GroupMappedItemsResponse" } }, "401":{ "$ref":"#/responses/401Error" }, "500":{ "$ref":"#/responses/500Error" } }, "x-internal-id":"learnCenters-{learnCenterId}-groups-{groupId}-mappedItems-get", "x-filename-id":"learncenters-learncenterid-groups-groupid-mappeditems-get" }, "post":{ "tags":[ "Groups" ], "summary":"Creates a new group mapped item", "operationId":"POST learnCenters/{learnCenterId}/groups/{groupId}", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"learnCenterId", "in":"path", "description":"Unique identifier of a LearnCenter.", "required":true, "type":"number" }, { "name":"groupId", "in":"path", "description":"Unique identifier of a Group.", "required":true, "type":"number" }, { "in":"body", "name":"body", "description":"Group mapped item object that needs to be created.", "required":true, "schema":{ "$ref":"#/definitions/GroupMappedItemRequest" } } ], "responses":{ "201":{ "description":"Created a new mapping of the group to an item." }, "400":{ "$ref":"#/responses/400Error" }, "409":{ "$ref":"#/responses/409Error" }, "500":{ "$ref":"#/responses/500Error" } }, "x-internal-id":"learnCenters-{learnCenterId}-groups-{groupId}-mappedItems-post", "x-filename-id":"learncenters-learncenterid-groups-groupid-mappeditems-post" }, "put":{ "tags":[ "Groups" ], "summary":"Updates a group mapped item", "operationId":"PUT learnCenters/{learnCenterId}/groups/{groupId}", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"learnCenterId", "in":"path", "description":"Unique identifier of LearnCenter.", "required":true, "type":"number" }, { "name":"groupId", "in":"path", "description":"Unique identifier of a Group.", "required":true, "type":"number" }, { "in":"body", "name":"body", "description":"Group mapped item object that needs to be updated.", "required":true, "schema":{ "$ref":"#/definitions/GroupMappedItemRequest" } } ], "responses":{ "200":{ "description":"Updated the mapping of a group to an item." }, "400":{ "$ref":"#/responses/400Error" }, "409":{ "$ref":"#/responses/409Error" }, "500":{ "$ref":"#/responses/500Error" } }, "x-internal-id":"learnCenters-{learnCenterId}-groups-{groupId}-mappedItems-put", "x-filename-id":"learncenters-learncenterid-groups-groupid-mappeditems-put" }, "delete":{ "tags":[ "Groups" ], "summary":"Deletes a group mapped item", "operationId":"DELETE learnCenters/{learnCenterId}/groups/{groupId}", "consumes":[ "application/json" ], "produces":[ "application/xml", "application/json" ], "parameters":[ { "name":"learnCenterId", "in":"path", "description":"Unique identifier of LearnCenter.", "required":true, "type":"number" }, { "name":"groupId", "in":"path", "description":"Unique identifier of a Group.", "required":true, "type":"number" }, { "in":"body", "name":"body", "description":"Group mapped item object that needs to be deleted.", "required":true, "schema":{ "$ref":"#/definitions/GroupMappedItemRequest" } } ], "responses":{ "200":{ "description":"Deleted mapping of a group to an item." }, "400":{ "$ref":"#/responses/400Error" }, "409":{ "$ref":"#/responses/409Error" }, "500":{ "$ref":"#/responses/500Error" } }, "x-internal-id":"learnCenters-{learnCenterId}-groups-{groupId}-mappedItems-delete", "x-filename-id":"learncenters-learncenterid-groups-groupid-mappeditems-delete" }, "patch":{ "tags":[ "Groups" ], "summary":"Updates a group mapped item", "operationId":"PATCH learnCenters/{learnCenterId}/groups/{groupId}", "consumes":[ "application/json" ], "produces":[ "application/xml", "application/json" ], "parameters":[ { "name":"learnCenterId", "in":"path", "description":"Unique identifier of LearnCenter.", "required":true, "type":"number" }, { "name":"groupId", "in":"path", "description":"Unique identifier of a Group.", "required":true, "type":"number" }, { "in":"body", "name":"body", "description":"Group mapped item object that needs to be updated.", "required":true, "schema":{ "$ref":"#/definitions/GroupMappedItemRequest" } } ], "responses":{ "200":{ "description":"Updated mapping of a group to an item." }, "400":{ "$ref":"#/responses/400Error" }, "409":{ "$ref":"#/responses/409Error" }, "500":{ "$ref":"#/responses/500Error" } }, "security":[ { "auth":[ ] } ], "x-internal-id":"learnCenters-{learnCenterId}-groups-{groupId}-mappedItems-patch", "x-filename-id":"learncenters-learncenterid-groups-groupid-mappeditems-patch" } }, "/learnCenters":{ "get":{ "tags":[ "LearnCenters" ], "summary":"Get learnCenters", "description":"Returns LearnCenters.", "operationId":"learncenters/GET", "produces":[ "application/json" ], "parameters":[ { "name":"totalResults", "in":"query", "description":"If set to true, the payload includes total number of rows that satisfies the request. Use of this parameter determines if the 'last' link is displayed for a pageable collection.", "required":false, "type":"boolean" }, { "name":"limit", "in":"query", "description":"Specify how many items should be returned in a payload. Must be lower than server default limit size.", "required":false, "type":"integer" }, { "name":"offset", "in":"query", "description":"Specify the starting point of the response.", "required":false, "type":"integer", "default":0 }, { "name":"q", "in":"query", "description":"Search through LearnCenters collection items. Use Mongo DB Query format. Searchable properties are - name, path.\nexample: ?q={path:{$eq: 'home/api'}}", "required":true, "type":"string" } ], "responses":{ "200":{ "description":"LearnCenters collection fetched.", "schema":{ "$ref":"#/definitions/LearnCentersResponse" } }, "401":{ "$ref":"#/responses/401Error" }, "500":{ "$ref":"#/responses/500Error" } }, "x-internal-id":"learnCenters-get", "x-filename-id":"learncenters-get" } }, "/learnCenters/{learnCenterId}":{ "get":{ "tags":[ "LearnCenters" ], "summary":"Get a LearnCenter", "operationId":"GET learnCenters/{learnCenterId}", "produces":[ "application/json" ], "parameters":[ { "name":"learnCenterId", "in":"path", "description":"Unique identifier of a LearnCenter.", "required":true, "type":"number" } ], "responses":{ "200":{ "description":"LearnCenter details fetched.", "schema":{ "$ref":"#/definitions/LearnCenterResponse" } }, "401":{ "description":"Authentication refused for provided credentials or the token is invalid.", "headers":{ "WWW_Authenticate":{ "type":"string" } } }, "404":{ "description":"Resource not found." }, "500":{ "description":"Internal server error." } }, "security":[ { "auth":[ ] } ], "x-internal-id":"learnCenters-{learnCenterId}-get", "x-filename-id":"learncenters-learncenterid-get" } }, "/users":{ "get":{ "tags":[ "Users" ], "summary":"Get all users.", "produces":[ "application/xml", "application/json" ], "parameters":[ { "name":"totalResults", "in":"query", "description":"If set to true, the payload includes the total number of rows that satisfies the request. Use of this parameter determines if the 'last' link is displayed for a pageable collection.", "required":false, "type":"boolean" }, { "name":"limit", "in":"query", "description":"Specify how many items should be returned in a payload. Must be lower than server default limit size.", "required":false, "type":"integer" }, { "name":"offset", "in":"query", "description":"Specify starting point of the response.", "required":false, "type":"integer", "default":0 }, { "name":"q", "in":"query", "description":"Search through users collection items. Use Mongo DB Query format. Searchable properties are - username, email, employeeId. \nexample ?q={email:{$eq: 'user@example.com'}}", "required":true, "type":"string" } ], "responses":{ "200":{ "description":"Users collection fetched.", "schema":{ "$ref":"#/definitions/UsersResponse" } }, "401":{ "$ref":"#/responses/401Error" }, "500":{ "$ref":"#/responses/500Error" } }, "security":[ { "auth":[ ] } ], "x-internal-id":"users-get", "x-filename-id":"users-get" }, "post":{ "tags":[ "Users" ], "summary":"Creates a new user", "description":"Providing createMembershipResource for a User object is optional. if we provide this, you can create a membership for a newly created user in this post request.", "consumes":[ "application/json" ], "produces":[ "application/xml", "application/json" ], "parameters":[ { "in":"body", "name":"body", "description":"User object that needs to be created.", "required":true, "schema":{ "$ref":"#/definitions/CreateUserRequest" } } ], "responses":{ "201":{ "description":"New user created.", "schema":{ "$ref":"#/definitions/UsersResponse" } }, "400":{ "$ref":"#/responses/400Error" }, "409":{ "$ref":"#/responses/409Error" }, "500":{ "$ref":"#/responses/500Error" } }, "security":[ { "auth":[ ] } ], "x-internal-id":"users-post", "x-filename-id":"users-post" } }, "/users/{userId}":{ "get":{ "tags":[ "Users" ], "summary":"Get a user", "produces":[ "application/xml", "application/json" ], "parameters":[ { "name":"userId", "in":"path", "description":"Unique identifier of User.", "required":true, "type":"number" } ], "responses":{ "200":{ "description":"user fetched", "schema":{ "$ref":"#/definitions/UserResponse" } }, "401":{ "description":"Authentication refused for provided credentials or token invalid.", "headers":{ "WWW_Authenticate":{ "type":"string" } } }, "404":{ "description":"Resource not found." }, "500":{ "description":"Internal server error." } }, "security":[ { "auth":[ ] } ], "x-internal-id":"users-{userId}-get", "x-filename-id":"users-userid-get" }, "put":{ "tags":[ "Users" ], "summary":"Update all properties of a user", "consumes":[ "application/json" ], "produces":[ "application/xml", "application/json" ], "parameters":[ { "name":"userId", "in":"path", "description":"Unique identifier of User.", "required":true, "type":"number" }, { "in":"body", "name":"body", "description":"User object that needs to be updated", "required":true, "schema":{ "$ref":"#/definitions/UserRequest" } } ], "responses":{ "200":{ "description":"Resource updated." }, "400":{ "$ref":"#/responses/400Error" }, "401":{ "$ref":"#/responses/401Error" }, "404":{ "$ref":"#/responses/404Error" }, "500":{ "$ref":"#/responses/500Error" } }, "security":[ { "auth":[ ] } ], "x-internal-id":"users-{userId}-put", "x-filename-id":"users-userid-put" }, "patch":{ "tags":[ "Users" ], "summary":"Update subset of properties of a user", "consumes":[ "application/json" ], "produces":[ "application/xml", "application/json" ], "parameters":[ { "name":"userId", "in":"path", "description":"Unique identifier of User.", "required":true, "type":"number" }, { "in":"body", "name":"body", "description":"User object that needs to be updated", "required":true, "schema":{ "$ref":"#/definitions/UserRequest" } } ], "responses":{ "200":{ "description":"Resource updated." }, "400":{ "$ref":"#/responses/400Error" }, "401":{ "$ref":"#/responses/401Error" }, "404":{ "$ref":"#/responses/404Error" }, "500":{ "$ref":"#/responses/500Error" } }, "security":[ { "auth":[ ] } ], "x-internal-id":"users-{userId}-patch", "x-filename-id":"users-userid-patch" } }, "/users/{userId}/memberships":{ "get":{ "tags":[ "Users" ], "summary":"Get memberships for user", "produces":[ "application/xml", "application/json" ], "parameters":[ { "name":"userId", "in":"path", "description":"Unique identifier of User.", "required":true, "type":"number" }, { "name":"totalResults", "in":"query", "description":"If set to true, payload includes total number of rows that satisfies the request. Use of parameter determines if the 'last' link is displayed for a pageable collection.", "required":false, "type":"boolean" }, { "name":"limit", "in":"query", "description":"Specify how many items should be returned in a payload. Must be lower than server default limit size.", "required":false, "type":"integer" }, { "name":"offset", "in":"query", "description":"Specify starting point of the response.", "required":false, "type":"integer", "default":0 } ], "responses":{ "200":{ "description":"memberships collection for user fetched.", "schema":{ "$ref":"#/definitions/UserMembershipResponse" } }, "401":{ "description":"Authentication refused for provided credentials or token invalid.", "headers":{ "WWW_Authenticate":{ "type":"string" } } }, "500":{ "description":"Internal server error." } }, "security":[ { "auth":[ ] } ], "x-internal-id":"users-{userId}-memberships-get", "x-filename-id":"users-userid-memberships-get" } } }, "securityDefinitions":{ "auth":{ "description":"Basic Authentication", "type":"basic" }, "apitoken":{ "type":"apiKey", "name":"X-Learn-Access-Token", "in":"header" } }, "definitions":{ "CatalogItemLinkItems":{ "description":"Object comprising links to the Catalog items.", "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" } }, "CatalogItemResponse":{ "description":"Response Object of the Catalog Items.", "type":"object", "properties":{ "name":{ "type":"string", "description":"Name of the catalog item" }, "links":{ "description":"Array of Catalog Link Items.", "type":"array", "items":{ "$ref":"#/definitions/CatalogItemLinkItems" } } }, "example":[ { "name":"users", "links":[ { "rel":"canonical", "href":"https://{url}/learn.rest/v1/metadata-catalog/users", "mediaType":"application/json" }, { "rel":"alternate", "href":"https://{url}/learn.rest/v1/metadata-catalog/users", "mediaType":"application/json" }, { "rel":"describes", "href":"https://{url}/learn.rest/v1/metadata-catalog/users", "mediaType":"application/json" } ] } ], "xml":{ "name":"User" } }, "CatalogResponse":{ "description":"Response object of the catalog items.", "type":"object", "properties":{ "items":{ "type":"array", "items":{ "$ref":"#/definitions/CatalogItemResponse" } }, "links":{ "description":"Links to the catalog item.", "type":"array", "items":{ "properties":{ "rel":{ "type":"string" }, "href":{ "type":"string" } } } } }, "example":{ "items":[ { "name":"users", "links":[ { "rel":"canonical", "href":"{url}/learn.rest/v1/metadata-catalog/users", "mediaType":"application/json" }, { "rel":"alternate", "href":"https://{url}/learn.rest/v1/metadata-catalog/users", "mediaType":"application/json" }, { "rel":"describes", "href":"https://{url}/learn.rest/v1/metadata-catalog/users", "mediaType":"application/json" } ] }, { "...":null } ], "links":[ { "rel":"canonical", "href":"{url}/learn.rest/v1/users" } ] } }, "SystemRegistryKeyLinkItems":{ "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" } }, "SystemRegistryKeyRequest":{ "description":"Request object comprising the value of the key.", "properties":{ "value":{ "type":"string", "description":"Value of the key." } }, "example":{ "value":"0 or 1" } }, "SystemRegistryKeyResponse":{ "type":"object", "description":"Response object for system registry.", "properties":{ "id":{ "type":"string", "description":"Name of the key." }, "value":{ "type":"string", "description":"Value of the key." }, "category":{ "type":"string", "description":"Category of the key." }, "links":{ "type":"array", "description":"Array of System Registry links.", "items":{ "$ref":"#/definitions/SystemRegistryKeyLinkItems" } } }, "example":{ "id":"GeneratePassword", "value":"1", "category":"RestApiSettings", "links":[ { "rel":"canonical", "href":"https://{url}/learn.rest/v1/systemRegistryKeys/GeneratePassword" } ] }, "xml":{ "name":"User" } }, "SystemRegistryKeysResponse":{ "type":"object", "description":"Response object for System registry keys.", "properties":{ "items":{ "type":"array", "description":"array of items", "items":{ "$ref":"#/definitions/SystemRegistryKeyResponse" } }, "links":{ "type":"array", "description":"Array of links", "items":{ "properties":{ "rel":{ "type":"string" }, "href":{ "type":"string" } } } } }, "example":{ "items":[ { "id":"GeneratePassword", "value":"1", "category":"RestApiSettings", "links":[ { "rel":"canonical", "href":"https://{url}/learn.rest/v1/systemRegistryKeys/GeneratePassword" } ] }, { "id":"TriggerUserMessages", "value":"0 or 1", "category":"RestApiSettings", "links":[ { "rel":"canonical", "href":"https://{url}/learn.rest/v1/systemRegistryKeys/TriggerUserMessages" } ] } ], "links":[ { "rel":"canonical", "href":"https://{url}/learn.rest/v1/systemRegistryKeys" } ] } }, "CustomFieldValueResponse":{ "type":"object", "properties":{ "id":{ "type":"number", "example":519652 }, "customFieldId":{ "type":"number", "example":407 }, "customField":{ "type":"object", "properties":{ "links":{ "type":"array", "items":{ "$ref":"#/definitions/UserCustomFieldLink" } } } }, "value":{ "type":"string", "example":"JCK" }, "links":{ "type":"array", "items":{ "$ref":"#/definitions/CustomFieldValueLink" } } } }, "CustomFieldValuesResponse":{ "type":"object", "properties":{ "items":{ "type":"array", "items":{ "$ref":"#/definitions/CustomFieldValueResponse" } }, "limit":{ "type":"number", "example":100 }, "count":{ "type":"number", "example":100 }, "hasMore":{ "type":"boolean", "example":false }, "links":{ "type":"array", "items":{ "properties":{ "rel":{ "type":"string" }, "href":{ "type":"string" } } }, "example":[ { "rel":"canonical", "href":"{url}/learn.rest/v1/memberships/5042/customFieldValues" } ] } } }, "CustomFieldValueLink":{ "type":"object", "properties":{ "rel":{ "type":"string", "example":"canonical" }, "href":{ "type":"string", "example":"{url}/learn.rest/v1/memberships/178418/customFieldValues/456" } } }, "GroupLink":{ "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" } }, "GroupMappedItemRequest":{ "type":"object", "required":[ "itemid", "itemtype" ], "properties":{ "itemid":{ "maxLength":50, "type":"string", "description":"unique identifier of the mapped item(learning plan/job profile/skill)" }, "itemtype":{ "type":"string", "description":"the item type", "enum":[ "learningplan", "jobprofile", "skill" ] }, "retainMapping":{ "type":"boolean", "description":"flag to retain mapping", "enum":[ true, false ] } }, "example":{ "itemid":"83767656-81b2-422d-85c8-c0a4f7972620", "itemtype":"learningplan", "retainmapping":true } }, "GroupMappedItemResponse":{ "type":"object", "properties":{ "groupId":{ "type":"number" }, "group":{ "type":"object", "properties":{ "links":{ "type":"array", "items":{ "$ref":"#/definitions/GroupLink" } } } }, "itemId":{ "type":"string" }, "itemType":{ "type":"string" }, "itemName":{ "type":"string" }, "retainMapping":{ "type":"boolean" } }, "example":[ { "groupId":932, "group":{ "links":[ { "rel":"canonical", "href":"https://{url}/learn.rest/v1/learnCenters/178409/groups/932" } ] }, "itemId":"bd5207ea-d3b0-433c-9e9b-cd788d764a37", "itemType":"learningPlan", "itemName":"Name of the item", "retainMapping":false } ] }, "GroupMappedItemsResponse":{ "type":"object", "properties":{ "items":{ "$ref":"#/definitions/GroupMappedItemResponse" }, "limit":{ "type":"number" }, "count":{ "type":"number" }, "hasMore":{ "type":"boolean" }, "links":{ "type":"array", "items":{ "properties":{ "rel":{ "type":"string" }, "href":{ "type":"string" } } } } }, "example":{ "items":[ { "groupId":932, "group":{ "links":[ { "rel":"canonical", "href":"https://{url}/learn.rest/v1/learnCenters/178409/groups/932" } ] }, "itemId":"bd5207ea-d3b0-433c-9e9b-cd788d764a37", "itemType":"learningPlan", "itemName":"Name of the item", "retainMapping":false }, { "...":null } ], "limit":100, "count":1, "hasMore":false, "links":[ { "rel":"canonical", "href":"https://{url}/learn.rest/v1/learnCenters/178409/groups/932/mappedItems" } ] } }, "GroupOwnerLink":{ "type":"object", "properties":{ "rel":{ "type":"string", "example":"canonical" }, "href":{ "type":"string", "example":"{url}/learn.rest/v1/learnCenter/178409/groups/456/owners/112867" } } }, "GroupOwnersResponse":{ "type":"object", "properties":{ "items":{ "$ref":"#/definitions/GroupOwnerLink" }, "links":{ "type":"array", "items":{ "properties":{ "rel":{ "type":"string" }, "href":{ "type":"string" } }, "example":[ { "rel":"canonical", "href":"https://{url}/learn.rest/v1/learnCenters/178409/groups/766/owners" } ] } } } }, "GroupRequest":{ "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 ] } }, "GroupResponse":{ "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" } } } }, "GroupsResponse":{ "type":"object", "properties":{ "items":{ "type":"array", "items":{ "$ref":"#/definitions/GroupResponse" } }, "limit":{ "type":"number", "example":100 }, "count":{ "type":"number", "example":34 }, "hasMore":{ "type":"boolean", "example":false }, "links":{ "type":"array", "items":{ "properties":{ "rel":{ "type":"string" }, "href":{ "type":"string" } } }, "example":[ { "rel":"canonical", "href":"https://{url}/learn.rest/v1/learnCenters/178409/groups" } ] } } }, "GroupUserLink":{ "type":"object", "properties":{ "rel":{ "type":"string", "example":"canonical" }, "href":{ "type":"string", "example":"{url}/learn.rest/v1/learnCenter/{learnCenterId}/groups/{groupId}/users/{userId}" } } }, "GroupUserResponse":{ "type":"object", "properties":{ "groupId":{ "type":"number", "example":1234 }, "group":{ "type":"object", "properties":{ "links":{ "type":"array", "items":{ "$ref":"#/definitions/GroupLink" } } } }, "userId":{ "type":"number", "example":112112 }, "user":{ "type":"object", "properties":{ "links":{ "type":"array", "items":{ "$ref":"#/definitions/UserLink" } } } }, "statusFlag":{ "type":"boolean", "example":true }, "excludeFlag":{ "type":"boolean", "example":false }, "links":{ "type":"array", "items":{ "$ref":"#/definitions/GroupUserLink" } } } }, "GroupUsersResponse":{ "type":"object", "properties":{ "items":{ "$ref":"#/definitions/GroupUserResponse" }, "limit":{ "type":"number", "example":100 }, "count":{ "type":"number", "example":1 }, "hasMore":{ "type":"boolean", "example":false }, "links":{ "type":"array", "items":{ "properties":{ "rel":{ "type":"string" }, "href":{ "type":"string" } } }, "example":[ { "rel":"canonical", "href":"https:///learn.rest/v1/learnCenters/178942/groups/1232/users" } ] } } }, "MembershipLink":{ "type":"object", "properties":{ "rel":{ "type":"string", "example":"canonical" }, "href":{ "type":"string", "example":"{url}/learn.rest/v1/memberships/456" } } }, "MembershipRequest":{ "type":"object", "required":[ "learnCenterId", "status", "userId" ], "properties":{ "learnCenterId":{ "type":"number", "format":"int32", "example":178784, "minimum":178409, "maximum":1.0E18 }, "userId":{ "type":"number", "example":112900, "minimum":112867, "maximum":1.0E18 }, "status":{ "type":"string", "example":"approved" }, "validFromDate":{ "type":"string", "format":"date-time", "example":"2016-02-23T07:21:00-05:00" }, "validUntilDate":{ "type":"string", "format":"date-time", "example":"2016-02-23T07:21:00-05:00" } } }, "MembershipResponse":{ "type":"object", "properties":{ "id":{ "type":"number", "format":"int32", "example":1345 }, "learnCenterId":{ "type":"number", "format":"int32", "example":178784 }, "learnCenter":{ "type":"array", "items":{ "$ref":"#/definitions/LearnCenterLink" } }, "userId":{ "type":"number", "example":112900 }, "user":{ "type":"array", "items":{ "$ref":"#/definitions/UserLink" } }, "createdDate":{ "type":"string", "example":"2016-02-23T07:21:00-05:00" }, "status":{ "type":"string", "example":"approved" }, "statusChangedDate":{ "type":"string", "example":"2016-02-23T07:21:00-05:00" }, "statusChangedByUserId":{ "type":"string", "example":"135131" }, "statusChangedByUser":{ "type":"array", "items":{ "$ref":"#/definitions/UserLink" } }, "validFromDate":{ "type":"string", "format":"datetime", "example":"2016-02-23T07:21:00-05:00" }, "validUntilDate":{ "type":"string", "format":"datetime", "example":"2016-02-23T07:21:00-05:00" }, "links":{ "$ref":"#/definitions/MembershipLink" } } }, "LearnCenterLink":{ "type":"object", "properties":{ "rel":{ "type":"string", "example":"canonical" }, "href":{ "type":"string", "example":"{url}/learn.rest/v1/learnCenters/178409" } } }, "LearnCenterMembershipsLink":{ "type":"object", "properties":{ "rel":{ "type":"string", "example":"canonical" }, "href":{ "type":"string", "example":"{url}/learn.rest/v1/learnCenters/{learnCenterId}/memberships" } } }, "LearnCenterResponse":{ "type":"object", "properties":{ "id":{ "type":"number", "example":178000 }, "name":{ "type":"string", "description":"Name of the LearnCenter", "example":"Name of LearnCenter" }, "description":{ "type":"string", "example":"Description of LearnCenter" }, "url":{ "type":"string", "example":"{url}/xyz" }, "path":{ "type":"string", "example":"home/xyz" }, "publicFlag":{ "type":"string", "example":false }, "status":{ "type":"string", "example":"active" }, "memberships":{ "type":"object", "properties":{ "links":{ "type":"array", "items":{ "$ref":"#/definitions/LearnCenterMembershipsLink" } } } }, "userCustomFields":{ "type":"object", "properties":{ "links":{ "type":"array", "items":{ "$ref":"#/definitions/LearnCenterUserCustomFieldsLink" } } } }, "supervisorAccounts":{ "type":"object", "properties":{ "links":{ "type":"array", "items":{ "$ref":"#/definitions/SupervisorAccountsLink" } } } }, "links":{ "type":"array", "items":{ "$ref":"#/definitions/LearnCenterLink" } } } }, "LearnCentersResponse":{ "type":"object", "properties":{ "items":{ "type":"array", "items":{ "$ref":"#/definitions/LearnCenterResponse" } }, "limit":{ "type":"number", "example":100 }, "count":{ "type":"number", "example":100 }, "hasMore":{ "type":"boolean", "example":true }, "links":{ "type":"array", "items":{ "properties":{ "rel":{ "type":"string" }, "href":{ "type":"string" } } }, "example":[ { "rel":"canonical", "href":"{url}/learn.rest/v1/learnCenters" }, { "rel":"first", "href":"{url}/v1/learnCenters?limit=100&offset=0" }, { "rel":"prev", "href":"{url}/learn.rest/v1/learnCenters?limit=100&offset=0" }, { "rel":"next", "href":"{url}/learn.rest/v1/learnCenters?limit=100&offset=10" }, { "rel":"last", "href":"{url}/learn.rest/v1/learnCenters?limit=100&offset=1200" } ] } } }, "LearnCenterUserCustomFieldsLink":{ "type":"object", "properties":{ "rel":{ "type":"string", "example":"canonical" }, "href":{ "type":"string", "example":"{url}/learn.rest/v1/learnCenters/178409/userCustomFields" } } }, "SuperviseeLink":{ "type":"object", "properties":{ "rel":{ "type":"string", "example":"canonical" }, "href":{ "type":"string", "example":"{url}/learn.rest/v1/learnCenters/178409/supervisorAccounts/31D132DB-33E2-4EE3-870C-06ED25F6CE00/supervisees/123445" } } }, "SuperviseesLink":{ "type":"object", "properties":{ "rel":{ "type":"string", "example":"canonical" }, "href":{ "type":"string", "example":"{url}/learn.rest/v1/learnCenters/178409/supervisorAccounts/31D132DB-33E2-4EE3-870C-06ED25F6CE00/supervisees" } } }, "SuperviseeRequest":{ "type":"object", "properties":{ "supervisorAccountId":{ "type":"string", "example":"11445C48-D0BB-4581-AC5A-793DC6405FB8" }, "userId":{ "type":"number", "format":"int32", "example":123123 }, "integratedFlag":{ "type":"boolean", "default":false, "example":false } } }, "SuperviseeResponse":{ "type":"object", "properties":{ "supervisorAccountId":{ "type":"string", "example":"11445C48-D0BB-4581-AC5A-793DC6405FB8" }, "supervisorAccount":{ "type":"object", "properties":{ "link":{ "type":"array", "items":{ "$ref":"#/definitions/SupervisorAccountLink" } } } }, "userId":{ "type":"number", "format":"int32", "example":123123 }, "user":{ "type":"object", "properties":{ "link":{ "type":"array", "items":{ "$ref":"#/definitions/UserLink" } } } }, "integratedFlag":{ "type":"boolean", "example":false }, "links":{ "type":"array", "items":{ "$ref":"#/definitions/SuperviseeLink" } } } }, "SuperviseesResponse":{ "type":"object", "properties":{ "items":{ "$ref":"#/definitions/SuperviseeResponse" }, "limit":{ "type":"number", "example":100 }, "count":{ "type":"number", "example":1 }, "hasMore":{ "type":"boolean", "example":false }, "links":{ "type":"array", "items":{ "properties":{ "rel":{ "type":"string" }, "href":{ "type":"string" } } }, "example":[ { "rel":"canonical", "href":"https://{url}/learn.rest/v1/learnCenters/178409/supervisorAccounts/00B6ECA6-CAEC-4C7E-A4D8-DFF98AB42D21/supervisees" } ] } } }, "SupervisorAccountLink":{ "type":"object", "properties":{ "rel":{ "type":"string", "example":"canonical" }, "href":{ "type":"string", "example":"{url}/learn.rest/v1/learnCenters/{learnCenterId}/supervisorAccounts/31D132DB-33E2-4EE3-870C-06ED25F6CE00" } } }, "SupervisorAccountRequest":{ "type":"object", "properties":{ "membershipid":{ "type":"number", "minimum":1, "maximum":1.0E15, "example":1235891 } } }, "SupervisorAccountResponse":{ "type":"object", "properties":{ "id":{ "type":"string", "format":"guid", "example":"31D132DB-33E2-4EE3-870C-06ED25F6CE00" }, "membershipId":{ "type":"number", "example":1914 }, "membership":{ "type":"object", "properties":{ "links":{ "type":"array", "items":{ "$ref":"#/definitions/MembershipLink" } } } }, "createdInLearnCenterId":{ "type":"number", "example":178409 }, "createdInLearnCenter":{ "type":"object", "properties":{ "links":{ "type":"array", "items":{ "$ref":"#/definitions/LearnCenterLink" } } } }, "supervisorsees":{ "type":"object", "properties":{ "links":{ "type":"array", "items":{ "$ref":"#/definitions/SuperviseesLink" } } } }, "supervisorRoles":{ "type":"object", "properties":{ "links":{ "type":"array", "items":{ "$ref":"#/definitions/SupervisorAccountSupervisorRolesLink" } } } }, "links":{ "type":"array", "items":{ "$ref":"#/definitions/SupervisorAccountLink" } } } }, "SupervisorAccountsLink":{ "type":"object", "properties":{ "rel":{ "type":"string", "example":"canonical" }, "href":{ "type":"string", "example":"{url}/learn.rest/v1/learnCenters/178409/supervisorAccounts" } } }, "SupervisorAccountsResponse":{ "type":"object", "properties":{ "items":{ "$ref":"#/definitions/SupervisorAccountResponse" }, "limit":{ "type":"number", "example":100 }, "count":{ "type":"number", "example":1 }, "hasMore":{ "type":"boolean", "example":false }, "links":{ "type":"array", "items":{ "properties":{ "rel":{ "type":"string" }, "href":{ "type":"string" } } }, "example":[ { "rel":"canonical", "href":"https://{url}/learn.rest/v1/learnCenters/178409/supervisorAccounts" } ] } } }, "SupervisorAccountSupervisorRolesLink":{ "type":"object", "properties":{ "rel":{ "type":"string", "example":"canonical" }, "href":{ "type":"string", "example":"{url}/learn.rest/v1/learnCenters/178409/supervisorAccounts/00B6ECA6-CAEC-4C7E-A4D8-DFF98AB42D21/supervisorRoles" } } }, "SupervisorAccountSupervisorRolesResponse":{ "type":"object", "properties":{ "supervisorRoleId":{ "type":"number", "example":123 }, "supervisorRole":{ "type":"object", "properties":{ "links":{ "type":"array", "items":{ "$ref":"#/definitions/SupervisorRoleLink" } } } }, "supervisorAccountId":{ "type":"string", "example":"2F6AF602-965B-415A-B00C-EEDA1F37510B" }, "supervisorAccount":{ "type":"object", "properties":{ "links":{ "type":"array", "items":{ "$ref":"#/definitions/SupervisorAccountLink" } } } }, "createDateUtc":{ "type":"string", "format":"datetime", "example":"2018-03-07T09:34:00" }, "statusFlag":{ "type":"boolean", "default":true, "example":true }, "links":{ "type":"array", "items":{ "$ref":"#/definitions/SupervisorAccountSupervisorRolesLink" } } } }, "SupervisorRoleLink":{ "type":"object", "properties":{ "rel":{ "type":"string", "example":"canonical" }, "href":{ "type":"string", "example":"{url}/learn.rest/v1/learnCenters/178409/supervisorRoles/123" } } }, "SupervisorRoleRequest":{ "type":"object", "properties":{ "name":{ "type":"string", "example":"new test role" }, "description":{ "type":"string", "example":"new test role desc" }, "permissions":{ "type":"array", "items":{ "properties":{ "id":{ "type":"string" } } }, "example":[ "receiveComSystemMessages", "attachFilesToMessages" ] }, "statusFlag":{ "type":"boolean", "default":true, "example":true }, "globalFlag":{ "type":"boolean", "default":false, "example":false } } }, "SupervisorRoleResponse":{ "type":"object", "properties":{ "supervisorRoleId":{ "type":"number", "example":123 }, "supervisorRole":{ "type":"object", "properties":{ "links":{ "type":"array", "items":{ "$ref":"#/definitions/SupervisorRoleLink" } } } }, "supervisorAccountId":{ "type":"string", "example":"2F6AF602-965B-415A-B00C-EEDA1F37510B" }, "supervisorAccount":{ "type":"object", "properties":{ "links":{ "type":"array", "items":{ "$ref":"#/definitions/SupervisorAccountLink" } } } }, "createDateUtc":{ "type":"string", "format":"datetime", "example":"2018-03-07T09:34:00" }, "statusFlag":{ "type":"boolean", "default":true, "example":true }, "links":{ "type":"array", "items":{ "$ref":"#/definitions/SupervisorAccountSupervisorRolesLink" } } } }, "SupervisorRolesResponse":{ "type":"object", "properties":{ "items":{ "type":"array", "items":{ "$ref":"#/definitions/SupervisorRoleResponse" } }, "limit":{ "type":"number", "example":100 }, "count":{ "type":"number", "example":1 }, "hasMore":{ "type":"boolean", "example":false }, "links":{ "type":"array", "items":{ "properties":{ "rel":{ "type":"string" }, "href":{ "type":"string" } } }, "example":[ { "rel":"canonical", "href":"https://{url}/learn.rest/v1/learnCenters/178409/supervisorRoles" } ] } } }, "SupervisorRoleSupervisorAccountResponse":{ "type":"object", "properties":{ "supervisorAccountId":{ "type":"string", "format":"guid", "example":"31D132DB-33E2-4EE3-870C-06ED25F6CE00" }, "supervisorRoleId":{ "type":"number", "example":1914 }, "supervisorAccount":{ "type":"object", "properties":{ "links":{ "type":"array", "items":{ "$ref":"#/definitions/SupervisorAccountLink" } } } }, "supervisorRole":{ "type":"object", "properties":{ "links":{ "type":"array", "items":{ "$ref":"#/definitions/SupervisorRoleLink" } } } }, "createDateUtc":{ "type":"string", "format":"datetime", "example":"2018-12-18T22:10:00" }, "lastUpdateUtc":{ "type":"string", "format":"datetime", "example":"2018-12-18T22:10:00" }, "lastUpdateUserId":{ "type":"number", "example":2000 }, "statusFlag":{ "type":"boolean", "example":true }, "links":{ "type":"array", "items":{ "$ref":"#/definitions/SupervisorAccountLink" } } } }, "SupervisorRoleSupervisorAccountsLink":{ "type":"object", "properties":{ "rel":{ "type":"string", "example":"canonical" }, "href":{ "type":"string", "example":"{url}/learn.rest/v1/learnCenters/178409/supervisorRoles/123/supervisorAccounts" } } }, "SupervisorRoleSupervisorAccountsResponse":{ "type":"object", "properties":{ "items":{ "$ref":"#/definitions/SupervisorRoleSupervisorAccountResponse" }, "limit":{ "type":"number", "example":100 }, "count":{ "type":"number", "example":1 }, "hasMore":{ "type":"boolean", "example":false }, "links":{ "type":"array", "items":{ "properties":{ "rel":{ "type":"string" }, "href":{ "type":"string" } } }, "example":[ { "rel":"canonical", "href":"https://{url}/learn.rest/v1/learnCenters/178409/supervisorRoles/69/supervisorAccounts" } ] } } }, "SystemProcessLink":{ "type":"object", "properties":{ "rel":{ "type":"string", "example":"canonical" }, "href":{ "type":"string", "example":"{url}/learn.rest/v1/systemProcesses/GroupSync" } } }, "SystemProcessResponse":{ "type":"object", "description":"Object comprising the parameters returned when the system process collection is fetched.", "properties":{ "id":{ "type":"string", "example":"groupsync", "description":"Id of the system process." }, "enabledFlag":{ "type":"boolean", "example":true, "description":"Specifies whether the system process is enabled." }, "status":{ "type":"string", "example":"started", "description":"Specifies the status of the system process." }, "links":{ "type":"array", "description":"Links to the system process.", "items":{ "$ref":"#/definitions/SystemProcessLink" } } } }, "SystemProcessesResponse":{ "type":"object", "description":"The system process response object.", "properties":{ "items":{ "$ref":"#/definitions/SystemProcessResponse" }, "links":{ "description":"Links to the system processes.", "type":"array", "items":{ "properties":{ "rel":{ "type":"string" }, "href":{ "type":"string" } } }, "example":[ { "rel":"canonical", "href":"https://{url}/learn.rest/v1/systemProcesses" } ] } } }, "UserCustomFieldElementOptionsLink":{ "type":"object", "properties":{ "value":{ "type":"string", "example":"first value" }, "isDefault":{ "type":"boolean", "example":false } } }, "UserCustomFieldLink":{ "type":"object", "properties":{ "rel":{ "type":"string" }, "href":{ "type":"string" } }, "example":{ "rel":"canonical", "href":"https://{url}/learn.rest/v1/learnCenters/178409/userCustomFields/102" } }, "UserCustomFieldsLink":{ "type":"object", "properties":{ "rel":{ "type":"string" }, "href":{ "type":"string" } }, "example":{ "rel":"canonical", "href":"https://{url}/learn.rest/v1/learnCenters/178409/userCustomFields" } }, "UserCustomFieldRequest":{ "type":"object", "required":[ "name", "elementType" ], "properties":{ "name":{ "type":"string", "example":"User Custom Field 1" }, "defaultValue":{ "type":"string", "default":"", "example":"n/a" }, "elementType":{ "type":"string", "default":"textbox", "example":"radio" }, "elementShowSelectOne":{ "type":"boolean", "default":false, "example":false }, "elementOptions":{ "type":"array", "items":{ "$ref":"#/definitions/UserCustomFieldElementOptionsLink" } }, "sharedFlag":{ "type":"boolean", "example":true }, "status":{ "type":"string", "enum":[ "active", "inactive" ], "default":"active", "example":"active" } }, "xml":{ "name":"User Custom Fields" } }, "UserCustomFieldResponse":{ "type":"object", "properties":{ "id":{ "type":"number", "example":123 }, "learnCenterId":{ "type":"string", "example":178409 }, "learnCenter":{ "type":"object", "properties":{ "items":{ "$ref":"#/definitions/LearnCenterLink" } } }, "name":{ "type":"string", "example":"User Custom Field 1" }, "defaultValue":{ "type":"string", "example":"n/a" }, "elementType":{ "type":"string", "example":"radio" }, "elementShowSelectOne":{ "type":"boolean", "example":false }, "elementOptions":{ "type":"array", "items":{ "$ref":"#/definitions/UserCustomFieldElementOptionsLink" } }, "sharedFlag":{ "type":"boolean", "example":true }, "status":{ "type":"string", "enum":[ "active", "inactive" ], "example":"active" }, "links":{ "$ref":"#/definitions/UserCustomFieldLink" } }, "xml":{ "name":"User Custom Fields" } }, "UserCustomFieldsResponse":{ "type":"object", "properties":{ "items":{ "type":"array", "items":{ "$ref":"#/definitions/UserCustomFieldResponse" } }, "limit":{ "type":"number", "example":100 }, "count":{ "type":"number", "example":100 }, "hasMore":{ "type":"boolean", "example":false }, "links":{ "type":"array", "items":{ "properties":{ "rel":{ "type":"string" }, "href":{ "type":"string" } } }, "example":[ { "rel":"canonical", "href":"{url}/learn.rest/v1/learnCenters/178409/userCustomFields" } ] } } }, "UserLink":{ "type":"object", "properties":{ "rel":{ "type":"string", "example":"canonical" }, "href":{ "type":"string", "example":"{url}/learn.rest/v1/users/456" } } }, "UserResponse":{ "type":"object", "properties":{ "id":{ "type":"number", "example":123123 }, "username":{ "type":"string", "description":"Username of the user", "example":"cwallace" }, "firstName":{ "type":"string", "example":"cwal" }, "lastName":{ "type":"string", "example":"lace" }, "street1":{ "type":"string", "example":"500 Oracle Parkway" }, "street2":{ "type":"string", "example":"suite 500" }, "city":{ "type":"string", "example":"Redwood Shores" }, "postalCode":{ "type":"string", "example":"94065" }, "state":{ "type":"string", "example":"CA" }, "country":{ "type":"string", "example":"USA" }, "phoneDaytime":{ "type":"string", "example":"+1.800.392.2999" }, "phoneEvening":{ "type":"string", "example":"n/a" }, "phoneMobile":{ "type":"string", "example":"+1.800.392.2999" }, "fax":{ "type":"string", "example":"n/a" }, "pager":{ "type":"string", "example":"n/a" }, "pagerInteractive":{ "type":"string", "example":"n/a" }, "email":{ "type":"string", "example":"info@example.com" }, "email2":{ "type":"string", "example":"" }, "gender":{ "type":"string", "description":"enum for gender are: male, female", "enum":[ "male", "female" ], "example":"male" }, "ssn":{ "type":"string", "example":"n/a" }, "employeeId":{ "type":"string", "example":"H123" }, "company":{ "type":"string", "example":"oracle" }, "officeName":{ "type":"string", "example":"n/a" }, "department":{ "type":"string", "example":"sales" }, "jobTitle":{ "type":"string", "example":"sales manager" }, "profession":{ "type":"string", "example":"software engineer" }, "managerName":{ "type":"string", "example":"n/a" }, "createdDate":{ "type":"string", "format":"datetime", "example":"2013-10-12T11:00:00-04:00" }, "lastAccesedDate":{ "type":"string", "format":"datetime", "example":"2015-11-12T11:00:00-04:00" }, "lastUpdatedDate":{ "type":"string", "format":"datetime", "example":"2017-10-12T11:00:00-04:00" }, "lastUpdatedByUserId":{ "type":"number", "example":123123 }, "lastUpdatedByUser":{ "type":"array", "items":{ "$ref":"#/definitions/UserLink" } }, "passwordValidUntilDate":{ "type":"string", "format":"datetime", "example":"2016-10-12T11:00:00-04:00" }, "includeInSearchFlag":{ "type":"boolean", "example":false } }, "xml":{ "name":"User" } }, "UsersResponse":{ "type":"object", "properties":{ "items":{ "type":"array", "items":{ "$ref":"#/definitions/UserResponse" } }, "limit":{ "type":"number", "example":100 }, "count":{ "type":"number", "example":100 }, "hasMore":{ "type":"boolean", "example":true }, "links":{ "type":"array", "items":{ "properties":{ "rel":{ "type":"string" }, "href":{ "type":"string" } }, "example":[ { "rel":"canonical", "href":"{url}/learn.rest/v1/users" }, { "rel":"first", "href":"{url}/v1/users?limit=100&offset=0" }, { "rel":"prev", "href":"{url}/learn.rest/v1/users?limit=100&offset=0" }, { "rel":"next", "href":"{url}/learn.rest/v1/users?limit=100&offset=10" }, { "rel":"last", "href":"{url}/learn.rest/v1/users?limit=100&offset=1200" } ] } } } }, "UserRoleLink":{ "type":"object", "properties":{ "rel":{ "type":"string" }, "href":{ "type":"string" } }, "example":{ "rel":"canonical", "href":"https://{url}/learn.rest/v1/learnCenters/178409/userRoles/639" } }, "UserRoleRequest":{ "type":"object", "required":[ "name" ], "properties":{ "name":{ "type":"string", "example":"admin role" }, "description":{ "type":"string", "example":"test" }, "permissions":{ "type":"array", "items":{ "properties":{ "id":{ "type":"string" } } }, "example":[ "receiveComSystemMessages", "attachFilesToMessages", "emailCompletionCertificates", "useForums", "viewReviews", "addGlobalLCCalendarEvents", "insertNewReviews", "viewLearnCenterPages", "viewInsightReportingReports", "sendComSystemMessages", "viewCoursePages", "useComSystemAddressBook", "useChatRooms", "useCommunicationTools", "modifyReviews", "printCompletionCertificates", "viewCertificatesContent", "viewContent" ] }, "statusFlag":{ "type":"boolean", "default":true, "example":true } } }, "UserRoleResponse":{ "type":"object", "properties":{ "id":{ "type":"number", "example":234 }, "name":{ "type":"string", "example":"admin role" }, "description":{ "type":"string", "example":"test" }, "permissions":{ "type":"array", "items":{ "properties":{ "id":{ "type":"string" } } }, "example":[ "receiveComSystemMessages", "attachFilesToMessages", "emailCompletionCertificates", "useForums", "viewReviews", "addGlobalLCCalendarEvents", "insertNewReviews", "viewLearnCenterPages", "viewInsightReportingReports", "sendComSystemMessages", "viewCoursePages", "useComSystemAddressBook", "useChatRooms", "useCommunicationTools", "modifyReviews", "printCompletionCertificates", "viewCertificatesContent", "viewContent" ] }, "statusFlag":{ "type":"boolean", "default":true, "example":true }, "links":{ "type":"array", "items":{ "$ref":"#/definitions/UserRoleLink" } } } }, "UserRolesResponse":{ "type":"object", "properties":{ "items":{ "type":"array", "items":{ "$ref":"#/definitions/UserRoleResponse" } }, "limit":{ "type":"number", "example":100 }, "count":{ "type":"number", "example":1 }, "hasMore":{ "type":"boolean", "example":false }, "links":{ "type":"array", "items":{ "properties":{ "rel":{ "type":"string" }, "href":{ "type":"string" } } }, "example":[ { "rel":"canonical", "href":"https://{url}/learn.rest/v1/learnCenters/178409/userRoles" } ] } } }, "CustomFieldValueRequest":{ "description":"Request object comprising a custom field and it's values.", "type":"object", "required":[ "customFieldId", "value" ], "properties":{ "customFieldId":{ "description":"Unique identifier for the custom field.", "type":"number", "example":407 }, "value":{ "description":"Custom field values.", "type":"string", "example":"JCK" } }, "example":{ "customFieldId":407, "value":"JCK" } }, "CustomFieldValueLinkItems":{ "type":"object", "description":"Custom Field Value Link Object. This object comprises links to the custom field values.", "properties":{ "rel":{ "type":"string", "example":"canonical" }, "href":{ "type":"string", "example":"{url}/learn.rest/v1/memberships/178418/customFieldValues/456" } } }, "LearnCenterLinkItems":{ "type":"object", "description":"Learn Center Link Item object. This object comprises links to the Learn Center Items.", "properties":{ "rel":{ "type":"string", "example":"canonical" }, "href":{ "type":"string", "example":"{url}/learn.rest/v1/learncenters/123456" } }, "example":{ "rel":"canonical", "href":"{url}/learn.rest/v1/learncenters/123456" } }, "MembershipLinkItems":{ "type":"object", "properties":{ "rel":{ "type":"string", "example":"canonical" }, "href":{ "type":"string", "example":"{url}/learn.rest/v1/memberships/456" } }, "example":{ "rel":"canonical", "href":"{url}/learn.rest/v1/memberships/456" } }, "UserCustomFieldValueRequest":{ "description":"Request object containing custom field values.", "type":"object", "required":[ "CustomFieldId", "value" ], "properties":{ "CustomFieldId":{ "type":"number", "example":354, "description":"Custom field unique identifier." }, "value":{ "type":"string", "example":"JCK", "description":"Custom field value." } }, "example":{ "customFieldId":407, "value":"JCK" } }, "UserLinkItems":{ "description":"Object comprising user links.", "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" } }, "CustomFieldValueLinkItem":{ "type":"object", "properties":{ "rel":{ "type":"string", "example":"canonical" }, "href":{ "type":"string", "example":"{url}/learn.rest/v1/memberships/178784/customFieldValues/456" } } }, "LearnCenterLinkItem":{ "type":"object", "properties":{ "rel":{ "type":"string", "example":"canonical" }, "href":{ "type":"string", "example":"{url}/learn.rest/v1/learncenters/178784" } }, "example":{ "rel":"canonical", "href":"{url}/learn.rest/v1/learncenters/178784" } }, "GroupOwnerLinkItems":{ "type":"object", "properties":{ "rel":{ "type":"string", "example":"canonical" }, "href":{ "type":"string", "example":"{url}/learn.rest/v1/learnCenter/178784/groups/456/owners/112867" } }, "example":{ "rel":"canonical", "href":"{url}/learn.rest/v1/learnCenter/178784/groups/456/owners/112867" } }, "UserRequest":{ "type":"object", "properties":{ "username":{ "type":"string", "description":"Username of the user" }, "firstName":{ "type":"string" }, "lastName":{ "type":"string" }, "street1":{ "type":"string" }, "street2":{ "type":"string" }, "city":{ "type":"string" }, "postalCode":{ "type":"string" }, "state":{ "type":"string" }, "country":{ "type":"string" }, "phoneDaytime":{ "type":"string" }, "phoneEvening":{ "type":"string" }, "phoneMobile":{ "type":"string" }, "fax":{ "type":"string" }, "pager":{ "type":"string" }, "pagerInteractive":{ "type":"string" }, "email":{ "type":"string" }, "email2":{ "type":"string" }, "gender":{ "type":"string", "description":"enum for gender are: male, female", "enum":[ "male", "female" ] }, "ssn":{ "type":"string" }, "employeeId":{ "type":"string" }, "company":{ "type":"string" }, "officeName":{ "type":"string" }, "department":{ "type":"string" }, "jobTitle":{ "type":"string" }, "profession":{ "type":"string" }, "managerName":{ "type":"string" }, "passwordValidUntilDate":{ "type":"string" }, "includeInSearchFlag":{ "type":"boolean", "default":false } }, "example":{ "username":"cwallace", "firstName":"Chris", "lastName":"Wallace", "street1":"500 Oracle Parkway", "street2":"suite 500", "city":"Redwood Shores", "state":"CA", "postalCode":"94065", "country":"US", "officeName":"HQ", "gender":"male", "includeInSearchFlag":true, "jobTitle":"Product Manager", "managerName":"n/a", "pagerInteractive":"n/a", "ssn":"n/a", "email2":"n/a", "pager":"n/a", "company":"Oracle", "fax":"n/a", "department":"Product Development", "phoneEvening":"n/a", "email":"info@oracle.com", "phoneDaytime":"+1.650.506.7000", "profession":"Product Management", "phoneMobile":"+1.800.392.2999", "employeeId":"n/a", "passwordValidUntilDate":"2016-10-12T11:00:00-04:00" }, "xml":{ "name":"User" } }, "UserRoleLinkItem":{ "type":"object", "properties":{ "rel":{ "type":"string" }, "href":{ "type":"string" } }, "example":{ "rel":"canonical", "href":"https://{url}/learn.rest/v1/learnCenters/178784/userRoles/639" } }, "UserCustomFieldElementOptionsLinkItem":{ "type":"object", "properties":{ "value":{ "type":"string", "example":"first value" }, "isDefault":{ "type":"boolean", "example":false } } }, "UserCustomFieldLinkItem":{ "type":"object", "properties":{ "rel":{ "type":"string" }, "href":{ "type":"string" } }, "example":{ "rel":"canonical", "href":"https://{url}/learn.rest/v1/learnCenters/178784/userCustomFields/102" } }, "UserCustomFieldsLinkItem":{ "type":"object", "properties":{ "rel":{ "type":"string" }, "href":{ "type":"string" } }, "example":{ "rel":"canonical", "href":"https://{url}/learn.rest/v1/learnCenters/178784/userCustomFields" } }, "UserCustomFieldPartialRequest":{ "type":"object", "required":[ "name", "elementType" ], "properties":{ "name":{ "type":"string", "example":"User Custom Field 102", "description":"User custom field name." }, "elementType":{ "type":"string", "default":"textbox", "example":"radio", "description":"User custom field element type." }, "sharedFlag":{ "type":"boolean", "example":true, "description":"User custom field shared flag." }, "status":{ "type":"string", "enum":[ "active", "inactive" ], "default":"active", "example":"active", "description":"User custom field status." } }, "xml":{ "name":"User Custom Fields" } }, "SupervisorRoleAccountLink":{ "type":"object", "properties":{ "rel":{ "type":"string", "example":"canonical" }, "href":{ "type":"string", "example":"{url}/learn.rest/v1/learnCenters/{learnCenterId}/supervisorRoles/{supervisorRoleId}/supervisorAccounts/{supervisorAccountId} " } } }, "SupervisorRoleAccountMappingRequest":{ "type":"object", "description":"Object comprising supervisor Account mapping. ", "properties":{ "SupervisorAccountId":{ "type":"string", "description":"Unique identifier of the supervisor account." } }, "example":{ "SupervisorAccountId":"75AB137B-9C3E-40E2-A1D2-E20EA23719F0" } }, "SupervisorRoleSupervisorAccountMappingRequest":{ "type":"object", "description":"Object comprising supervisor Account mapping with the status. ", "properties":{ "statusFlag":{ "type":"boolean", "description":"Status os the mapping request." } }, "example":{ "StatusFlag":false } }, "SupervisorAccountSupervisorRoleResponse":{ "type":"object", "description":"Response object comprising the parameters for the supervisor role and account.", "properties":{ "supervisorAccountId":{ "type":"string", "format":"guid", "example":"31D132DB-33E2-4EE3-870C-06ED25F6CE00", "description":"Unique identifier for a supervisor account." }, "supervisorRoleId":{ "type":"number", "example":1914, "description":"Unique identifier for a supervisor role." }, "supervisorAccount":{ "type":"object", "description":"Object comprising supervisor account links.", "properties":{ "links":{ "type":"array", "items":{ "$ref":"#/definitions/SupervisorAccountLink" } } } }, "supervisorRole":{ "type":"object", "description":"Object comprising links to the Supervisor Roles.", "properties":{ "links":{ "type":"array", "items":{ "$ref":"#/definitions/SupervisorRoleLink" } } } }, "createDateUtc":{ "type":"string", "format":"datetime", "example":"2018-12-18T22:10:00", "description":"Date the supervisor role is created." }, "statusFlag":{ "type":"boolean", "example":true, "description":"Status of the supervisor role." }, "links":{ "type":"array", "description":"Links to the supervisor account.", "items":{ "$ref":"#/definitions/SupervisorRoleAccountLink" } } }, "example":{ "supervisorAccountId":"5E1E861F-311F-43B8-915A-0E4716C43EF1", "supervisorRoleId":474, "supervisorAccount":{ "links":[ { "rel":"canonical", "href":"{url}/learn.rest/v1/learnCenters/179177/supervisorAccounts/5E1E861F-311F-43B8-915A-0E4716C43EF1" } ] }, "supervisorRole":{ "links":[ { "ref":"canonical", "href":"{url}/learn.rest/v1/learnCenters/179177/supervisorRoles/474" } ] }, "createDateUtc":"2016-06-13T08:26:00", "statusFlag":true, "links":[ { "ref":"canonical", "href":"{url}/learn.rest/v1/learnCenters/179177/supervisorRoles/474/supervisorAccounts/5E1E861F-311F-43B8-915A-0E4716C43EF1" } ] } }, "MembershipLinkItem":{ "type":"object", "properties":{ "rel":{ "type":"string", "example":"canonical" }, "href":{ "type":"string", "example":"{url}/learn.rest/v1/memberships/456" } }, "example":{ "rel":"canonical", "href":"{url}/learn.rest/v1/memberships/456" } }, "GroupOwnerLinkItem":{ "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" } }, "UserLinkItem":{ "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" } }, "UserRolesMappingRequest":{ "type":"object", "description":"Object containing the user identifier parameters.", "required":[ "UserId" ], "properties":{ "UserId":{ "type":"string" } }, "example":{ "UserId":"995521" } }, "UserRoleUserResponse":{ "type":"object", "properties":{ "userId":{ "type":"number", "example":123123 }, "roleId":{ "type":"number", "example":640 }, "user":{ "type":"object", "properties":{ "links":{ "type":"array", "items":{ "$ref":"#/definitions/UserLinkItem" } } } }, "userRole":{ "type":"object", "properties":{ "links":{ "type":"array", "items":{ "$ref":"#/definitions/UserRoleLinkItem" } } } }, "createdDate":{ "type":"string", "example":"2019-02-04T10:46:21Z" }, "statusFlag":{ "type":"boolean", "example":true }, "links":{ "type":"array", "items":{ "properties":{ "rel":{ "type":"string" }, "href":{ "type":"string" } } }, "example":[ { "rel":"canonical", "href":"https://{url}/learn.rest/v1/learnCenters/178409/userRoles/123/users" } ] } } }, "UserRoleUsersResponse":{ "type":"object", "properties":{ "items":{ "type":"array", "items":{ "$ref":"#/definitions/UserRoleUserResponse" } }, "limit":{ "type":"number", "example":100 }, "count":{ "type":"number", "example":2 }, "hasMore":{ "type":"boolean", "example":false }, "links":{ "type":"array", "items":{ "properties":{ "rel":{ "type":"string" }, "href":{ "type":"string" } } }, "example":[ { "rel":"canonical", "href":"https://{url}/learn.rest/v1/learnCenters/178409/userRoles/640/users" } ] } } }, "GroupLinkItem":{ "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" } }, "GroupUserLinkItem":{ "description":"Object comprising links to the users in the group.", "type":"object", "properties":{ "rel":{ "type":"string", "example":"canonical" }, "href":{ "type":"string", "example":"{url}/learn.rest/v1/learnCenter/{learnCenterId}/groups/{groupId}/users/{userId}" } }, "example":{ "rel":"canonical", "href":"{url}/learn.rest/v1/learnCenter/178409/groups/456/users/112867" } }, "GroupUserMappedItemRequest":{ "description":"Request Payload for creating group user mapping.", "type":"object", "required":[ "ExcludeFlag" ], "properties":{ "ExcludeFlag":{ "description":" You can manually exclude Users from Dynamic Groups so that they are never automatically included even if they match the conditions for becoming members of the Dynamic Group.", "type":"boolean", "example":true } }, "example":{ "ExcludeFlag":true } }, "GroupUserRequest":{ "description":"Request object for user group mapping.", "type":"object", "required":[ "UserId" ], "properties":{ "UserId":{ "description":"Id of the users you want to map to a group.", "type":"number", "example":1137389 } }, "example":{ "UserId":1137389 } }, "CreateUserRequest":{ "type":"object", "description":"Object comprising the user parameters and the membership parameters to create a new user and to add a membership.", "properties":{ "username":{ "type":"string", "description":"Username of the user" }, "firstName":{ "type":"string", "description":"Description of the user." }, "lastName":{ "type":"string", "description":"Description of the user." }, "street1":{ "type":"string", "description":"The street text address of the user." }, "street2":{ "type":"string", "description":"The street text address of the user." }, "city":{ "type":"string", "description":"The city of the user." }, "postalCode":{ "type":"string", "description":"The postal code of the user." }, "state":{ "type":"string", "description":"The state of the user." }, "country":{ "type":"string", "description":"The country of the user." }, "phoneDaytime":{ "type":"string", "description":"The day time number of the user." }, "phoneEvening":{ "type":"string", "description":"The evening number of the user." }, "phoneMobile":{ "type":"string", "description":"The mobile number of the user." }, "fax":{ "type":"string", "description":"The fax number of the user." }, "pager":{ "type":"string", "description":"The pager number of the user." }, "pagerInteractive":{ "type":"string", "description":"The User's interactive pager number." }, "email":{ "type":"string", "description":"The User's email address." }, "email2":{ "type":"string", "description":"The secondary email address." }, "gender":{ "type":"string", "description":"User gender. Enum for gender are: male, female", "enum":[ "male", "female" ] }, "ssn":{ "type":"string", "description":"The user's social security number." }, "employeeId":{ "type":"string", "description":"Email address of the employee." }, "company":{ "type":"string", "description":"The User's place of work." }, "officeName":{ "type":"string", "description":"The User's office." }, "department":{ "type":"string", "description":"The User's department." }, "jobTitle":{ "type":"string", "description":"The User's job title." }, "profession":{ "type":"string" }, "managerName":{ "type":"string", "description":"The User's manager's name." }, "passwordValidUntilDate":{ "type":"string", "description":"The date until which the password is valid." }, "includeInSearchFlag":{ "type":"boolean", "default":false, "description":"Whether the user created should be visible in searches." }, "timeZone":{ "type":"string", "description":"The User's timezone" }, "participatesInDaylight":{ "type":"boolean", "default":true, "description":"Whether the user's timezone observes daylight savings" }, "createMembershipResourceForUser":{ "$ref":"#/definitions/MembershipForCreateUserRequest" } }, "example":{ "username":"cwallace", "firstName":"Chris", "lastName":"Wallace", "street1":"500 Oracle Parkway", "street2":"suite 500", "city":"Redwood Shores", "state":"CA", "postalCode":"94065", "country":"US", "officeName":"HQ", "gender":"male", "includeInSearchFlag":true, "jobTitle":"Product Manager", "managerName":"n/a", "pagerInteractive":"n/a", "ssn":"n/a", "email2":"n/a", "pager":"n/a", "company":"Oracle", "fax":"n/a", "department":"Product Development", "phoneEvening":"n/a", "email":"info@oracle.com", "phoneDaytime":"+1.650.506.7000", "profession":"Product Management", "phoneMobile":"+1.800.392.2999", "employeeId":"n/a", "passwordValidUntilDate":"2016-10-12T11:00:00-04:00", "timeZone":"Eastern Standard Time", "participatesInDaylight":true, "createMembershipResourceForUser":{ "learncenterId":"178409", "status":"Approved", "validFromDate":"2019-03-04T11:00:00-04:00", "validUntilDate":"2019-03-09T11:00:00-05:00" } } }, "MembershipForCreateUserRequest":{ "type":"object", "description":"Object comprising parameters to add users to a membership.", "required":[ "learncenterId", "status" ], "properties":{ "learncenterId":{ "type":"number", "format":"int32", "example":178409, "description":"Unique identifier of the LearnCenter." }, "status":{ "type":"string", "description":"Enum for membership status are: pending, approved, removed and denied.", "example":"approved" }, "validFromDate":{ "type":"string", "format":"date-time", "description":"Date from which the membership is valid." }, "validUntilDate":{ "type":"string", "format":"date-time", "description":"Date till which the membership is until." } }, "example":{ "learncenterId":"178409", "status":"approved", "validFromDate":"2019-03-04T11:00::00-04:00", "validUntilDate":"2019-03-09T11:00:00-05:00" } }, "UserMembershipResponse":{ "description":"The User Membership response object.", "type":"object", "properties":{ "items":{ "$ref":"#/definitions/UserAndMembbershipResponse" }, "limit":{ "type":"number", "description":"Limit implies the maximum number of records which can be displayed in the page." }, "count":{ "type":"number", "description":"Count is the current number of records displayed in the response." }, "hasMore":{ "type":"boolean", "description":" True indicates that we have more records to be displayed." }, "links":{ "type":"array", "items":{ "properties":{ "rel":{ "type":"string" }, "href":{ "type":"string" } } } } }, "example":{ "items":[ { "groupId":932, "group":{ "links":[ { "rel":"canonical", "href":"https://{url}/learn.rest/v1/learnCenters/178409/groups/932" } ] }, "itemId":"bd5207ea-d3b0-433c-9e9b-cd788d764a37", "itemType":"learningPlan", "itemName":"Name of the item", "retainMapping":false }, { "...":null } ], "limit":100, "count":1, "hasMore":false, "links":[ { "rel":"canonical", "href":"https://{url}/learn.rest/v1/learnCenters/178409/groups/932/mappedItems" } ] } }, "UserAndMembbershipResponse":{ "type":"object", "properties":{ "id":{ "type":"number", "format":"int32", "example":6597, "description":"Id of the user." }, "learnCenterId":{ "type":"number", "format":"int32", "example":178477, "description":"Unique identifier of the Learn Center." }, "learnCenter":{ "description":"Link to the LearnCenter items.", "type":"array", "items":{ "$ref":"#/definitions/LearnCenterLinkItems" } }, "userId":{ "type":"number", "example":456, "description":"Unique Identifier for the user." }, "user":{ "description":"Link to the users.", "type":"array", "items":{ "$ref":"#/definitions/UserLinkItems" } }, "createdDate":{ "type":"string", "example":"2016-02-23T07:21:00-05:00", "description":"Date the membership was created." }, "status":{ "type":"string", "example":"approved", "description":"Status of the membership." }, "statusChangedDate":{ "type":"string", "example":"2016-02-23T07:21:00-05:00", "description":"The date the status of the membership was changed." }, "statusChangedByUserId":{ "type":"string", "example":"135131", "description":"User Id of the user who changed the membership status." }, "statusChangedByUser":{ "description":"The link to the user who changed the status.", "type":"array", "items":{ "$ref":"#/definitions/UserLinkItems" } }, "supervisorAccount":{ "type":"object", "description":"Object comprising supervisor account links.", "properties":{ "links":{ "type":"array", "items":{ "$ref":"#/definitions/SupervisorAccountLink" } } } }, "supervisorAccountId":{ "type":"string", "description":"Unique identifier of the supervisor account.", "example":{ "SupervisorAccountId":"75AB137B-9C3E-40E2-A1D2-E20EA23719F0" } }, "userCustomFieldValues":{ "type":"object", "description":"Object comprising user custom fields links.", "properties":{ "links":{ "type":"array", "items":{ "$ref":"#/definitions/UserCustomFieldLink" } } } }, "links":{ "$ref":"#/definitions/MembershipLinkItems" } } } }, "responses":{ "204Response":{ "description":"Resource deleted." }, "400Error":{ "description":"Request has incorrect syntax or does not contain a field that is required." }, "401Error":{ "description":"Authentication refused for provided credentials or the token is invalid.", "headers":{ "WWW_Authenticate":{ "type":"string" } } }, "404Error":{ "description":"Resource not found." }, "409Error":{ "description":"Another resource with the same identifier already exists." }, "422Error":{ "description":"Request may contain validation errors." }, "500Error":{ "description":"Internal server error." } } }