Create a learning item audience
post
/hcmRestApi/resources/11.13.18.05/learningItemAudiences
Request
Header Parameters
-
Metadata-Context: string
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version: string
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
createdById: integer
(int64)
Unique identifier for the learning audience creator.
-
learningItemId: integer
(int64)
Unique identifier for the learning item, it's the internal primary key.
-
learningItemType: string
Maximum Length:
30
Learning item type such as Course, Specialization, Community, eLearning Video, and Learning Journey. Valid values are defined in the LearningItemTypeLOVVA. -
learnRelationId: integer
(int64)
Unique identifier for the association between the person or user group and the learning item.
-
learnRelationNumber: string
Maximum Length:
30
Friendly number identifying the person or user group associated with the learning item. -
sourceType: string
Maximum Length:
30
Source type for the user group. Valid values are ORA_LEARNING_ORGANIZATION and ORA_PERSON. -
sourceTypeId: integer
(int64)
Unique identifier for the person or user group associated with the learning item.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : learningItemAudiences-item-response
Type:
Show Source
object
-
createdById: integer
(int64)
Unique identifier for the learning audience creator.
-
creationDate: string
(date-time)
Read Only:
true
Date when the learning audience was created. -
departmentId: integer
Read Only:
true
Person's department name. -
departmentName: string
Read Only:
true
Maximum Length:255
Person's department. -
learningItemId: integer
(int64)
Unique identifier for the learning item, it's the internal primary key.
-
learningItemType: string
Maximum Length:
30
Learning item type such as Course, Specialization, Community, eLearning Video, and Learning Journey. Valid values are defined in the LearningItemTypeLOVVA. -
learnRelationId: integer
(int64)
Unique identifier for the association between the person or user group and the learning item.
-
learnRelationNumber: string
Maximum Length:
30
Friendly number identifying the person or user group associated with the learning item. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
sourceType: string
Maximum Length:
30
Source type for the user group. Valid values are ORA_LEARNING_ORGANIZATION and ORA_PERSON. -
sourceTypeDisplayName: string
Read Only:
true
Maximum Length:255
Name of the person or user group associated with the learning item. -
sourceTypeId: integer
(int64)
Unique identifier for the person or user group associated with the learning item.
-
sourceTypeMeaning: string
Read Only:
true
Maximum Length:255
Description for the learning item audience source type. -
sourceTypeNumber: string
Read Only:
true
Maximum Length:255
Friendly number identifying the person associated with the learning item.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.