REST API for Oracle Fusion Cloud HCM

Create a learning content item

post

/hcmRestApi/resources/11.13.18.05/learningContentItems

Request

Header Parameters

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.
Upsert-Mode:

Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

application/json

Root Schema : schema

Type: object

Show Source

AssessmentAttempts: integer

Indicates the number of attempts allowed for the assessment.
AssessmentCode: string

Unique identifier for the assessment.
AssessmentMasteryScore: number

Indicates the minimum score needed to pass the assessment.
AssessmentScoreVisibleToAdministrator: string

Indicates whether the assessment is visible to the administrator or not. This attribute doesn't have a default value. Valid values are Y and N.
AssessmentScoreVisibleToLearner: string

Indicates whether the assessment is visible to the learner or not. This attribute doesn't have a default value. Valid values are Y and N.
AssessmentTimeLimit: number

Indicates the time limit for the assessment.
AssessmentTimeLimitUOM: string

Indicates the unit of measure for the assessment time limit.
CompletedAssessmentVisibleToLearner: string

Indicates whether the completed assessment is visible to the learner or not. This attribute doesn't have a default value. Valid values are Y and N.
ContentId: integer

Unique identifier for the content object.
Description: string

Description of the content item.
EndDate: string (date)

End date of the content item.
FileName: string

File name of the content item to be uploaded. Depending on the tracking type, the extension should be zip, pdf, or mov.
IngestionStatus: string

Ingestion status of the content item. For Video and SCORM/AICC/HACP content, valid value is ORA_MED_TRANSCODING.
ItemNumber: string

Unique user key for the content item.
MarkCompleteOnOpen: string

Indicates whether the learning content item can be marked complete when opened. This attribute doesn't have a default value. Valid values are Y and N.
ReplaceStatus: string

Replacement status of the content item. For video, PDF, and SCORM/AICC/HACP content, valid values are ORA_MED_REPLACE_BEGIN and ORA_MED_REPLACE_END. Use ORA_MED_REPLACE_BEGIN to request the auth token for uploading a replacement to Akamai. Use ORA_MED_REPLACE_END to perform the replacement after the new media has been uploaded to Akamai.
StartDate: string (date)

Start date of the content item.
Status: string

Status of the content item. For PDF and WEBLINK content, valid values are ORA_CONT_INACTIVE, ORA_CONT_ACTIVE.
Title: string

Tiitle of the content item.
TrackingType: string

Tracking type for the content item. Valid values are ORA_SCORM_12, ORA_SCORM_2004, ORA_HACP, ORA_PDF, ORA_AUTO, and ORA_VIDEO.
UploadAuthToken: string

Upload authentication token generated for the learning content item.
UploadLocation: string

Upload location of the learning content item.
URL: string

Starting URL of the content item.
UUID: string

Internal value, no input required.

{
    "type":"object",
    "properties":{
        "Description":{
            "type":"string",
            "description":"Description of the content item.",
            "nullable":true
        },
        "ReplaceStatus":{
            "type":"string",
            "description":"Replacement status of the content item. For video, PDF, and SCORM/AICC/HACP content, valid values are ORA_MED_REPLACE_BEGIN and ORA_MED_REPLACE_END. Use ORA_MED_REPLACE_BEGIN to request the auth token for uploading a replacement to Akamai. Use ORA_MED_REPLACE_END to perform the replacement after the new media has been uploaded to Akamai.",
            "nullable":true
        },
        "FileName":{
            "type":"string",
            "description":"File name of the content item to be uploaded. Depending on the tracking type, the extension should be zip, pdf, or mov.",
            "nullable":true
        },
        "AssessmentMasteryScore":{
            "type":"number",
            "description":"Indicates the minimum score needed to pass the assessment.",
            "nullable":true
        },
        "AssessmentScoreVisibleToLearner":{
            "type":"string",
            "description":"Indicates whether the assessment is visible to the learner or not. This attribute doesn't have a default value. Valid values are Y and N.",
            "nullable":true
        },
        "URL":{
            "type":"string",
            "description":"Starting URL of the content item.",
            "nullable":true
        },
        "StartDate":{
            "type":"string",
            "description":"Start date of the content item.",
            "format":"date",
            "nullable":true
        },
        "CompletedAssessmentVisibleToLearner":{
            "type":"string",
            "description":"Indicates whether the completed assessment is visible to the learner or not. This attribute doesn't have a default value. Valid values are Y and N.",
            "nullable":true
        },
        "ItemNumber":{
            "type":"string",
            "description":"Unique user key for the content item.",
            "nullable":true
        },
        "IngestionStatus":{
            "type":"string",
            "description":"Ingestion status of the content item. For Video and SCORM/AICC/HACP content,\nvalid value is ORA_MED_TRANSCODING.",
            "nullable":true
        },
        "AssessmentAttempts":{
            "type":"integer",
            "description":"Indicates the number of attempts allowed for the assessment.",
            "nullable":true
        },
        "UUID":{
            "type":"string",
            "description":"Internal value, no input required.",
            "nullable":true
        },
        "Status":{
            "type":"string",
            "description":"Status of the content item. For PDF and WEBLINK content, valid values are ORA_CONT_INACTIVE, ORA_CONT_ACTIVE.",
            "nullable":true
        },
        "UploadAuthToken":{
            "type":"string",
            "description":"Upload authentication token generated for the learning content item.",
            "nullable":true
        },
        "AssessmentTimeLimitUOM":{
            "type":"string",
            "description":"Indicates the unit of measure for the assessment time limit.",
            "nullable":true
        },
        "Title":{
            "type":"string",
            "description":"Tiitle of the content item.",
            "nullable":true
        },
        "EndDate":{
            "type":"string",
            "description":"End date of the content item.",
            "format":"date",
            "nullable":true
        },
        "TrackingType":{
            "type":"string",
            "description":"Tracking type for the content item. Valid values are ORA_SCORM_12,\nORA_SCORM_2004, ORA_HACP,\nORA_PDF,\nORA_AUTO, and ORA_VIDEO.",
            "nullable":true
        },
        "AssessmentCode":{
            "type":"string",
            "description":"Unique identifier for the assessment.",
            "nullable":true
        },
        "AssessmentScoreVisibleToAdministrator":{
            "type":"string",
            "description":"Indicates whether the assessment is visible to the administrator or not. This attribute doesn't have a default value. Valid values are Y and N.",
            "nullable":true
        },
        "AssessmentTimeLimit":{
            "type":"number",
            "description":"Indicates the time limit for the assessment.",
            "nullable":true
        },
        "ContentId":{
            "type":"integer",
            "description":"Unique identifier for the content object.",
            "nullable":true
        },
        "UploadLocation":{
            "type":"string",
            "description":"Upload location of the learning content item.",
            "nullable":true
        },
        "MarkCompleteOnOpen":{
            "type":"string",
            "description":"Indicates whether the learning content item can be marked complete when opened. This attribute doesn't have a default value. Valid values are Y and N.",
            "nullable":true
        }
    }
}

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 : learningContentItems-item-response

Type: object

Show Source

AssessmentAttempts: integer

Indicates the number of attempts allowed for the assessment.
AssessmentCode: string

Unique identifier for the assessment.
AssessmentMasteryScore: number

Indicates the minimum score needed to pass the assessment.
AssessmentScoreVisibleToAdministrator: string

Indicates whether the assessment is visible to the administrator or not. This attribute doesn't have a default value. Valid values are Y and N.
AssessmentScoreVisibleToLearner: string

Indicates whether the assessment is visible to the learner or not. This attribute doesn't have a default value. Valid values are Y and N.
AssessmentTimeLimit: number

Indicates the time limit for the assessment.
AssessmentTimeLimitUOM: string

Indicates the unit of measure for the assessment time limit.
CompletedAssessmentVisibleToLearner: string

Indicates whether the completed assessment is visible to the learner or not. This attribute doesn't have a default value. Valid values are Y and N.
ContentId: integer

Unique identifier for the content object.
Description: string

Description of the content item.
EndDate: string (date)

End date of the content item.
FileName: string

File name of the content item to be uploaded. Depending on the tracking type, the extension should be zip, pdf, or mov.
IngestionStatus: string

Ingestion status of the content item. For Video and SCORM/AICC/HACP content, valid value is ORA_MED_TRANSCODING.
ItemNumber: string

Unique user key for the content item.
links: array Links

Title: Links

The link relations associated with the resource instance.
MarkCompleteOnOpen: string

Indicates whether the learning content item can be marked complete when opened. This attribute doesn't have a default value. Valid values are Y and N.
ReplaceStatus: string

Replacement status of the content item. For video, PDF, and SCORM/AICC/HACP content, valid values are ORA_MED_REPLACE_BEGIN and ORA_MED_REPLACE_END. Use ORA_MED_REPLACE_BEGIN to request the auth token for uploading a replacement to Akamai. Use ORA_MED_REPLACE_END to perform the replacement after the new media has been uploaded to Akamai.
StartDate: string (date)

Start date of the content item.
Status: string

Status of the content item. For PDF and WEBLINK content, valid values are ORA_CONT_INACTIVE, ORA_CONT_ACTIVE.
Title: string

Tiitle of the content item.
TrackingType: string

Tracking type for the content item. Valid values are ORA_SCORM_12, ORA_SCORM_2004, ORA_HACP, ORA_PDF, ORA_AUTO, and ORA_VIDEO.
UploadAuthToken: string

Upload authentication token generated for the learning content item.
UploadLocation: string

Upload location of the learning content item.
URL: string

Starting URL of the content item.
UUID: string

Internal value, no input required.

{
    "type":"object",
    "properties":{
        "Description":{
            "type":"string",
            "description":"Description of the content item.",
            "nullable":true,
            "x-queryable":true
        },
        "ReplaceStatus":{
            "type":"string",
            "description":"Replacement status of the content item. For video, PDF, and SCORM/AICC/HACP content, valid values are ORA_MED_REPLACE_BEGIN and ORA_MED_REPLACE_END. Use ORA_MED_REPLACE_BEGIN to request the auth token for uploading a replacement to Akamai. Use ORA_MED_REPLACE_END to perform the replacement after the new media has been uploaded to Akamai.",
            "nullable":true,
            "x-queryable":true
        },
        "FileName":{
            "type":"string",
            "description":"File name of the content item to be uploaded. Depending on the tracking type, the extension should be zip, pdf, or mov.",
            "nullable":true,
            "x-queryable":true
        },
        "AssessmentMasteryScore":{
            "type":"number",
            "description":"Indicates the minimum score needed to pass the assessment.",
            "nullable":true,
            "x-queryable":true
        },
        "AssessmentScoreVisibleToLearner":{
            "type":"string",
            "description":"Indicates whether the assessment is visible to the learner or not. This attribute doesn't have a default value. Valid values are Y and N.",
            "nullable":true,
            "x-queryable":true
        },
        "URL":{
            "type":"string",
            "description":"Starting URL of the content item.",
            "nullable":true,
            "x-queryable":true
        },
        "StartDate":{
            "type":"string",
            "description":"Start date of the content item.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "CompletedAssessmentVisibleToLearner":{
            "type":"string",
            "description":"Indicates whether the completed assessment is visible to the learner or not. This attribute doesn't have a default value. Valid values are Y and N.",
            "nullable":true,
            "x-queryable":true
        },
        "ItemNumber":{
            "type":"string",
            "description":"Unique user key for the content item.",
            "nullable":true,
            "x-queryable":true
        },
        "IngestionStatus":{
            "type":"string",
            "description":"Ingestion status of the content item. For Video and SCORM/AICC/HACP content,\nvalid value is ORA_MED_TRANSCODING.",
            "nullable":true,
            "x-queryable":true
        },
        "AssessmentAttempts":{
            "type":"integer",
            "description":"Indicates the number of attempts allowed for the assessment.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "UUID":{
            "type":"string",
            "description":"Internal value, no input required.",
            "nullable":true,
            "x-queryable":true
        },
        "Status":{
            "type":"string",
            "description":"Status of the content item. For PDF and WEBLINK content, valid values are ORA_CONT_INACTIVE, ORA_CONT_ACTIVE.",
            "nullable":true,
            "x-queryable":true
        },
        "UploadAuthToken":{
            "type":"string",
            "description":"Upload authentication token generated for the learning content item.",
            "nullable":true,
            "x-queryable":true
        },
        "AssessmentTimeLimitUOM":{
            "type":"string",
            "description":"Indicates the unit of measure for the assessment time limit.",
            "nullable":true,
            "x-queryable":true
        },
        "Title":{
            "type":"string",
            "description":"Tiitle of the content item.",
            "nullable":true,
            "x-queryable":true
        },
        "EndDate":{
            "type":"string",
            "description":"End date of the content item.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "TrackingType":{
            "type":"string",
            "description":"Tracking type for the content item. Valid values are ORA_SCORM_12,\nORA_SCORM_2004, ORA_HACP,\nORA_PDF,\nORA_AUTO, and ORA_VIDEO.",
            "nullable":true,
            "x-queryable":true
        },
        "AssessmentCode":{
            "type":"string",
            "description":"Unique identifier for the assessment.",
            "nullable":true,
            "x-queryable":true
        },
        "AssessmentScoreVisibleToAdministrator":{
            "type":"string",
            "description":"Indicates whether the assessment is visible to the administrator or not. This attribute doesn't have a default value. Valid values are Y and N.",
            "nullable":true,
            "x-queryable":true
        },
        "AssessmentTimeLimit":{
            "type":"number",
            "description":"Indicates the time limit for the assessment.",
            "nullable":true,
            "x-queryable":true
        },
        "ContentId":{
            "type":"integer",
            "description":"Unique identifier for the content object.",
            "nullable":true,
            "x-queryable":true
        },
        "UploadLocation":{
            "type":"string",
            "description":"Upload location of the learning content item.",
            "nullable":true,
            "x-queryable":true
        },
        "MarkCompleteOnOpen":{
            "type":"string",
            "description":"Indicates whether the learning content item can be marked complete when opened. This attribute doesn't have a default value. Valid values are Y and N.",
            "nullable":true,
            "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."
        }
    }
}

Examples

The following examples show how to create these learning content items by submitting a POST request on the REST resource using cURL.

SCORM learning content
Video learning content
PDF learning content
Web Link learning content

SCORM Learning Content

The following example shows how to create a SCORM learning content item by submitting a POST request on the REST resource using cURL. To create a SCORM learning content item:

Create the metadata for the SCORM content item. (POST)
Upload the SCORM package file to Oracle Learning Cloud. (POST)
Initiate the SCORM zip file ingestion into Oracle Learning Cloud. (PATCH)

Creating the Metadata

Example of cURL Command

The following is an example of the cURL command.

curl -vs -u '<username>:<password>' -H 'Content-Type: application/vnd.oracle.adf.resourceitem+json' -d "@WebContentPayload.txt"  https://<host>:<port>/hcmRestApi/resources/11.13.18.05/learningContentItems &> NewWebContentDetails.out

Example of Payload

The following is an example of the payload.

{
  "Title" : "REST: SS 201710081350 Jefferson",
  "FileName" : "JefferSonSCORM12.zip",
  "Description" : "REST: SS 201710081350 Jefferson Desc",
  "ItemNumber" : "REST-201710081350-SCORM",
  "TrackingType" : "ORA_SCORM_12",
  "StartDate" : "2017-06-15",
  "EndDate" : "2018-06-14"
}

Example of Response Header

The following is an example of the response header.

Status: HTTP/1.1 201 Created
Content-Type: application/vnd.oracle.adf.resourceitem+json

Example of Response Body

The following example shows the contents of the response body in JSON format.

{
  "ContentId" : 300100101142985,
  "Title" : "REST: SS 201710081350 Jefferson",
  "FileName" : "JefferSonSCORM12.zip", 
  "ItemNumber" : "REST-201710081350-SCORM",
  "TrackingType" : "ORA_SCORM_12",
  "Description" : "REST: SS 201710081350 Jefferson Desc",
  "StartDate" : "2017-06-15",
  "EndDate" : "2018-06-14",
  "UUID" : "92cfc80e-953b-449c-90a6-18afa401628f",
  "Status" : "ORA_CONT_INACTIVE",
  "URL" : null,
  "AuthToken" : "X-Akamai-ACS-Action:action=upload&version=1&index-zip=1||X-Akamai-ACS-Auth-Data:5, 0.0.0.0, 0.0.0.0, 1507582333, 457024713, Oraclemedia||X-Akamai-ACS-Auth-Sign:7cQB5HotJLxYBh6X4o0mO3Dma47UGZ1TPG9xLMWUiz0=",
 "Location" : "scorm/FA.HCM.PER.HcmEngmtVideoShare-92cfc80e-953b-449c-90a6-18afa401628f_private/92cfc80e-953b-449c-90a6-18afa401628f.zip",
  "IngestionStatus" : "ORA_MED_NEW",
  "Operation" : null,
		"links":[8]
         0:  {...
            ...}
}

Uploading the SCORM File

Example of cURL Command

The following is an example of the cURL command.

curl -vs 'https://oraclemedia-nsu.akamaihd.net/335633/scorm/FA.HCM.PER.HcmEngmtVideoShare-<UUID>_private/<UUID>.zip'
-H 'X-Akamai-ACS-Action: action=upload&version=1&index-zip=1' 
-H 'X-Akamai-ACS-Auth-Data:<Auth_Data_From_Create_CONTENT_Metadata_response>'
-H 'X-Akamai-ACS-Auth-Sign:<Auth_Sign_From_Create_CONTENT_Metadata_response>'
-X POST --upload-file<SCORM_zip_File>&>UploadWebContentFile.out

Example of Payload

SCORM .zip file

Example of Response Header

The following is an example of the response header.

Status: HTTP/1.1 200 OK

Example of Response Body

The following example shows the contents of the response body.

Accept: */*
> X-Akamai-ACS-Action: action=upload&version=1&index-zip=1
> X-Akamai-ACS-Auth-Data:5, 0.0.0.0, 0.0.0.0, 1507582333, 457024713, Oraclemedia
> X-Akamai-ACS-Auth-Sign:7cQB5HotJLxYBh6X4o0mO3Dma47UGZ1TPG9xLMWUiz0=
> Content-Length: 457453
> Expect: 100-continue
> 
< HTTP/1.1 100 Continue
< Expires: Mon, 09 Oct 2017 20:52:28 GMT
< Cache-Control: max-age=0, no-cache, no-store
< Pragma: no-cache
} [16384 bytes data]
* We are completely uploaded and fine
< HTTP/1.1 200 OK
< Server: Apache
< Content-Type: text/html
< Expires: Mon, 09 Oct 2017 20:52:28 GMT
< Cache-Control: max-age=0, no-cache, no-store
< Pragma: no-cache
< Date: Mon, 09 Oct 2017 20:52:28 GMT
< Content-Length: 31
< Connection: keep-alive

Initiating SCORM File Ingestion

Example of cURL Command

The following is an example of the cURL command.

curl -vs -u '<username>:<password>' -H 'Content-Type: application/vnd.oracle.adf.resourceitem+json' -d "@WebContentPayloadForUpdate.txt" -X PATCH  https://<host>:<port>/hcmRestApi/resources/11.13.18.05/learningContentItems/<CONTENT_ID> &> UpdateWebContentFile.out

Example of Payload

The following is an example of the payload.

{
  "Title" : "REST: SS 201710081350 Jefferson",
  "Description" : "REST: SS 201710081350 Jefferson Desc",
  "StartDate" : "2017-06-15",
  "EndDate" : "2018-06-14"
}

Example of Response Header

The following is an example of the response header.

Status: HTTP/1.1 200 OK
Content-Type: application/vnd.oracle.adf.resourceitem+json

Example of Response Body

The following example shows the contents of the response body in JSON format.

{
  "ContentId" : 300100101142985,
  "Title" : "REST: SS 201710081350 Jefferson",
  "FileName" : null,
  "ItemNumber" : "REST-201710081350-SCORM",
  "TrackingType" : "ORA_UNKNOWN",
  "Description" : "REST: SS 201710081350 Jefferson Desc",
  "StartDate" : "2017-06-15",
  "EndDate" : "2018-06-14",
  "UUID" : "92cfc80e-953b-449c-90a6-18afa401628f",
  "Status" : "ORA_CONT_INACTIVE",
  "URL" : null,
  "AuthToken" : null,
  "Location" : "scorm/FA.HCM.PER.HcmEngmtVideoShare-92cfc80e-953b-449c-90a6-18afa401628f_private/92cfc80e-953b-449c-90a6-18afa401628f.zip",
  "IngestionStatus" : "ORA_MED_TRANSCODING",
  "Operation" :"",
    		"links":[8]
         	0:  {...
            ...}
}

Video Learning Content

The following example shows how to create a video learning content item by submitting a POST request on the REST resource using cURL. To create a video learning content item:

Create the metadata for the video content item. (POST)
Upload the video file to Oracle Learning Cloud. (POST)
Initiate the video file ingestion into Oracle Learning Cloud. (PATCH)

Creating the Metadata

Example of cURL Command

The following is an example of the cURL command.

curl -vs -u '<username>:<password>' -H 'Content-Type: application/vnd.oracle.adf.resourceitem+json' -d "@VideoContentPayload.txt"  https://<host>:<port>/hcmRestApi/resources/11.13.18.05/learningContentItems &> NewVideoContentDetails.out

Example of Payload

The following is an example of the payload.

{
  "Title" : "REST: SS 201710091906 video_4_secs",
  "FileName" : "video_4_secs.mov",
  "Description" : "REST: SS 201710091906 video_4_secs Desc",
  "ItemNumber" : "REST-201710091906",
  "TrackingType" : "ORA_CONTENT_VIDEO",
  "StartDate" : "2017-06-15",
  "EndDate" : "2018-06-14"
}

Example of Response Header

The following is an example of the response header.

Status: HTTP/1.1 201 Created
Content-Type: application/vnd.oracle.adf.resourceitem+json

Example of Response Body

The following example shows the contents of the response body in JSON format.

{
  "ContentId" : 300100101257750,
  "Title" : "REST: SS 201710091906 video_4_secs",
  "FileName" : "video_4_secs.mov",
  "ItemNumber" : "REST-201710091906",
  "TrackingType" : "ORA_CONTENT_VIDEO",
  "Description" : "REST: SS 201710091906 video_4_secs Desc",
  "StartDate" : "2017-06-15",
  "EndDate" : "2018-06-14",
  "UUID" : "e778388a-15f8-4261-9338-d3b702aa8323",
  "Status" : "ORA_CONT_INACTIVE",
  "URL" : null,
  "AuthToken" : "X-Akamai-ACS-Action:action=upload&version=1||X-Akamai-ACS-Auth-Data:5, 0.0.0.0	, 	0.0.0.0, 1507601292, 604982616, Oraclemedia||X-Akamai-ACS-Auth-Sign:ktzX85LZYJvFYJbJ6pnSOoY8xBr9EynBw0B8hFg1+aE=",
	"Location" : "src/FA.HCM.PER.HcmEngmtVideoShare-e778388a-15f8-4261-9338-d3b702aa8323_private	/	e778388a-15f8-4261-9338-d3b702aa8323.mov",
  "IngestionStatus" : "ORA_MED_NEW",
  "Operation" : null,
			"links":[8]
         	0:  {...
           	 ...}
}

Uploading the Video File

Example of cURL Command

The following is an example of the cURL command.

curl -vs 'https://oraclemedia-nsu.akamaihd.net/335633/scorm/FA.HCM.PER.HcmEngmtVideoShare-<UUID>_private/<UUID>.zip'
-H 'X-Akamai-ACS-Action: action=upload&version=1&index-zip=1' 
-H 'X-Akamai-ACS-Auth-Data:<Auth_Data_From_Create_CONTENT_Metadata_response>'
-H 'X-Akamai-ACS-Auth-Sign:<Auth_Sign_From_Create_CONTENT_Metadata_response>'
-X POST --upload-file<Video_File> &> UploadVideoContentFile.out

Example of Payload

Video file

Example of Response Header

The following is an example of the response header.

Status: HTTP/1.1 200 OK

Example of Response Body

The following example shows the contents of the response body.

> Accept: */*
> X-Akamai-ACS-Action: action=upload&version=1
> X-Akamai-ACS-Auth-Data:5, 0.0.0.0, 0.0.0.0, 1507601292, 604982616, Oraclemedia
> X-Akamai-ACS-Auth-Sign:ktzX85LZYJvFYJbJ6pnSOoY8xBr9EynBw0B8hFg1+aE=
> Content-Length: 1603769
> Expect: 100-continue
> 
< HTTP/1.1 100 Continue
< Expires: Tue, 10 Oct 2017 02:08:33 GMT
< Cache-Control: max-age=0, no-cache, no-store
< Pragma: no-cache
} [16384 bytes data]
* We are completely uploaded and fine
< HTTP/1.1 200 OK
< Server: Apache
< Content-Type: text/html
< Expires: Tue, 10 Oct 2017 02:08:36 GMT
< Cache-Control: max-age=0, no-cache, no-store
< Pragma: no-cache
< Date: Tue, 10 Oct 2017 02:08:36 GMT
< Content-Length: 31
< Connection: keep-alive
< 
{ [31 bytes data]
* Connection #0 to host oraclemedia-nsu.akamaihd.net left intact<HTML>Request Processed</HTML>

Initiating Video File Ingestion

Example of cURL Command

The following is an example of the cURL command.

curl -vs -u '<username>:<password>' -H 'Content-Type: application/vnd.oracle.adf.resourceitem+json' -d "@VideoContentPayloadForUpdate.txt" -X PATCH  https://<host>:<port>/hcmRestApi/resources/11.13.18.05/learningContentItems/<CONTENT_ID> &> UpdateVideoContentFile.out

Example of Payload

The following is an example of the payload.

{
  "IngestionStatus" : "ORA_MED_TRANSCODING"
}

Example of Response Header

The following is an example of the response header.

Status: HTTP/1.1 200 OK
Content-Type: application/vnd.oracle.adf.resourceitem+json

Example of Response Body

The following example shows the contents of the response body in JSON format.

{
  "ContentId" : 300100101257750,
  "Title" : "REST: SS 201710091906 video_4_secs",
  "FileName" : "video_4_secs.mov",
  "ItemNumber" : "REST-201710091906",
  "TrackingType" : "ORA_CONTENT_VIDEO",
  "Description" : "REST: SS 201710091906 video_4_secs Desc",
  "StartDate" : "2017-06-15",
  "EndDate" : "2018-06-14",
  "UUID" : "e778388a-15f8-4261-9338-d3b702aa8323",
  "Status" : "ORA_CONT_INACTIVE",
  "URL" : null,
  "AuthToken" : null,
  "Location" : "src/FA.HCM.PER.HcmEngmtVideoShare-e778388a-15f8-4261-9338-d3b702aa8323_private/e778388a-15f8-4261-9338-d3b702aa8323.mov",
  "IngestionStatus" : "ORA_MED_TRANSCODING",
  "Operation" : "",
		 "links":[8]
         	0:  {...
           	 ...}
}

PDF Learning Content

The following example shows how to create a PDF learning content item by submitting a POST request on the REST resource using cURL. To create a PDF learning content item:

Create the metadata for the PDF content item. (POST)
Upload the PDF file to Oracle Learning Cloud. (POST)

Creating the Metadata

Example of cURL Command

The following is an example of the cURL command.

curl -vs -u '<username>:<password>' -H 'Content-Type: application/vnd.oracle.adf.resourceitem+json' -d "@PDFContentPayload.txt"  https://<host>:<port>/hcmRestApi/resources/11.13.18.05/learningContentItems &> NewPDFContentDetails.out

Example of Payload

The following is an example of the payload.

{
  "Title" : "REST: SS 201710091949 TLearn",
  "FileName" : "TLearn.pdf",
  "Description" : "REST: SS 201710091949 TLearn Desc",
  "ItemNumber" : "REST-201710091949-PDF",
  "TrackingType" : "ORA_PDF",
  "Status" : "ORA_CONT_ACTIVE",
  "StartDate" : "2017-06-15",
  "EndDate" : "2018-06-14"
}

Example of Response Header

The following is an example of the response header.

Status: HTTP/1.1 201 Created
Content-Type: application/vnd.oracle.adf.resourceitem+json

Example of Response Body

The following example shows the contents of the response body in JSON format.

{
  "ContentId" : 300100101257756,
  "Title" : "REST: SS 201710091949 TLearn",
  "FileName" : "TLearn.pdf",
  "ItemNumber" : "REST-201710091949-PDF",
  "TrackingType" : "ORA_PDF",
  "Description" : "REST: SS 201710091949 video_4_secs Desc",
  "StartDate" : "2017-06-15",
  "EndDate" : "2018-06-14",
  "UUID" : "60c5e47d-bc50-44c0-b6ed-736508eb73e8",
  "Status" : "ORA_CONT_ACTIVE",
  "URL" : null,
  "AuthToken" : "X-Akamai-ACS-Action:action=upload&version=1||X-Akamai-ACS-Auth-Data:5, 0.0.0.0, 0.0.0.0, 1507604022, 2097491649, Oraclemedia||X-Akamai-ACS-Auth-Sign:6szYsIlcztab31lygNDWghM4pj/IVqBEG7JqTxaYQmg=",
  "Location" : "scorm/FA.HCM.PER.HcmEngmtVideoShare-60c5e47d-bc50-44c0-b6ed-736508eb73e8_private/60c5e47d-bc50-44c0-b6ed-736508eb73e8.pdf",
  "IngestionStatus" : null,
  "Operation" : null,
		 "links":[8]
         	0:  {...
           	 ...}
}

Uploading the PDF File

Example of cURL Command

The following is an example of the cURL command.

curl -vs 'https://oraclemedia-nsu.akamaihd.net/335633/scorm/FA.HCM.PER.HcmEngmtVideoShare-<UUID>_private/<UUID>.zip'
-H 'X-Akamai-ACS-Action: action=upload&version=1&index-zip=1' 
-H 'X-Akamai-ACS-Auth-Data:<Auth_Data_From_Create_CONTENT_Metadata_response>'
-H 'X-Akamai-ACS-Auth-Sign:<Auth_Sign_From_Create_CONTENT_Metadata_response>'
-X POST --upload-file<PDF_File> &> UploadPDFContentFile.out

Example of Payload

PDF file

Example of Response Header

The following is an example of the response header.

Status: HTTP/1.1 200 OK

Example of Response Body

The following example shows the contents of the response body.

> Accept: */*
> X-Akamai-ACS-Action: action=upload&version=1
> X-Akamai-ACS-Auth-Data:5, 0.0.0.0, 0.0.0.0, 1507604022, 2097491649, Oraclemedia
> X-Akamai-ACS-Auth-Sign:6szYsIlcztab31lygNDWghM4pj/IVqBEG7JqTxaYQmg=
> Content-Length: 2795
> Expect: 100-continue
> 
< HTTP/1.1 100 Continue
< Expires: Tue, 10 Oct 2017 02:54:03 GMT
< Cache-Control: max-age=0, no-cache, no-store
< Pragma: no-cache
} [2795 bytes data]
* We are completely uploaded and fine
< HTTP/1.1 200 OK
< Server: Apache
< Content-Type: text/html
< Expires: Tue, 10 Oct 2017 02:54:03 GMT
< Cache-Control: max-age=0, no-cache, no-store
< Pragma: no-cache
< Date: Tue, 10 Oct 2017 02:54:03 GMT
< Content-Length: 31
< Connection: keep-alive
< 
{ [31 bytes data]
* Connection #0 to host oraclemedia-nsu.akamaihd.net left intact<HTML>Request ProcessedRequest Processed</HTML>

Web Links Content

The following example shows how to create a web links learning content item by submitting a POST request on the REST resource using cURL.

curl -vs -u '<username>:<password>' -H 'Content-Type: application/vnd.oracle.adf.resourceitem+json' -d "@WebLinkContentPayload.txt"  https://<host>:<port>/hcmRestApi/resources/11.13.18.05/learningContentItems &> NewWebLinkContentDetails.out

Example of Payload

The following is an example of the payload.

{
  "Title" : "REST: SS 201710092052 WebLink leadership-skills",
  "Description" : "REST: SS 201710092052 WebLink leadership-skills Desc",
  "ItemNumber" : "REST-201710092052-WebLink",
  "TrackingType" : "ORA_AUTO",
  "URL" : "https://www.coursera.org/learn/leadership-skills",
  "Status" : "ORA_CONT_ACTIVE",
  "StartDate" : "2017-06-15",
  "EndDate" : "2018-06-14"
}

Example of Response Header

The following is an example of the response header.

Status: HTTP/1.1 201 Created
Content-Type: application/vnd.oracle.adf.resourceitem+json

Example of Response Body

The following example shows the contents of the response body in JSON format.

{
  "ContentId" : 300100101257996,
  "Title" : "REST: SS 201710092052 WebLink leadership-skills",
  "FileName" : null,
  "ItemNumber" : "REST-201710092052-WebLink",
  "TrackingType" : "ORA_AUTO",
  "Description" : "REST: SS 201710092052 WebLink leadership-skills Desc",
  "StartDate" : "2017-06-15",
  "EndDate" : "2018-06-14",
  "UUID" : "5fec638b-7a52-43af-a322-49f21cc5f81c",
  "Status" : "ORA_CONT_ACTIVE",
  "URL" : "https://www.coursera.org/learn/leadership-skills",
  "AuthToken" : null,
  "Location" : null,
  "IngestionStatus" : null,
  "Operation" : null,
		 "links":[8]
         	0:  {...
           	 ...}
}