Jump to

• Request
• Response

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

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "sourceType":{
            "maxLength":30,
            "type":"string",
            "description":"Source type for the user group. Valid values are ORA_LEARNING_ORGANIZATION and ORA_PERSON.",
            "nullable":false
        },
        "learningItemType":{
            "maxLength":30,
            "type":"string",
            "description":"Learning item type such as Course, Specialization, Community, eLearning Video, and Learning Journey. Valid values are defined in the LearningItemTypeLOVVA.",
            "nullable":false
        },
        "learnRelationNumber":{
            "maxLength":30,
            "type":"string",
            "description":"Friendly number identifying the person or user group associated with the learning item.",
            "nullable":false
        },
        "learnRelationId":{
            "type":"integer",
            "description":"Unique identifier for the association between the person or user group and the learning item.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "learningItemId":{
            "type":"integer",
            "description":"Unique identifier for the learning item, it's the internal primary key.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "createdById":{
            "type":"integer",
            "description":"Unique identifier for the learning audience creator.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "sourceTypeId":{
            "type":"integer",
            "description":"Unique identifier for the person or user group associated with the learning item.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        }
    }
}

Back to Top

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.

Body ()

Root Schema : learningItemAudiences-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "departmentName":{
            "maxLength":255,
            "type":"string",
            "description":"Person's department.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "departmentId":{
            "type":"integer",
            "description":"Person's department name.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "sourceTypeNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Friendly number identifying the person associated with the learning item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "learningItemType":{
            "maxLength":30,
            "type":"string",
            "description":"Learning item type such as Course, Specialization, Community, eLearning Video, and Learning Journey. Valid values are defined in the LearningItemTypeLOVVA.",
            "nullable":false,
            "x-queryable":true
        },
        "creationDate":{
            "type":"string",
            "description":"Date when the learning audience was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "learnRelationNumber":{
            "maxLength":30,
            "type":"string",
            "description":"Friendly number identifying the person or user group associated with the learning item.",
            "nullable":false,
            "x-queryable":true
        },
        "sourceTypeMeaning":{
            "maxLength":255,
            "type":"string",
            "description":"Description for the learning item audience source type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "sourceTypeId":{
            "type":"integer",
            "description":"Unique identifier for the person or user group associated with the learning item.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "sourceType":{
            "maxLength":30,
            "type":"string",
            "description":"Source type for the user group. Valid values are ORA_LEARNING_ORGANIZATION and ORA_PERSON.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "learnRelationId":{
            "type":"integer",
            "description":"Unique identifier for the association between the person or user group and the learning item.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "learningItemId":{
            "type":"integer",
            "description":"Unique identifier for the learning item, it's the internal primary key.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "sourceTypeDisplayName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the person or user group associated with the learning item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "createdById":{
            "type":"integer",
            "description":"Unique identifier for the learning audience creator.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top