Handles the result of an Ingestion process

$ curl 'http://www.wim.tv:8080/rest/ingestion/ingestionResults' -i -X POST -H 'Content-Type: application/json' -H 'Accept: application/json' -d '{
  "contentId" : "82f8e86f-aa3e-44a1-bda1-df0f3e8c1367",
  "srcType" : "S3",
  "result" : "SUCCESSFULLY_TRANSCODED"
}'

Request headers

Name Description

Content-Type

application/json

* Required.

Accept

application/json

* Required.

Request fields

Path Type Description

result

Result

Status of the Ingestion process.

* Required.
* Must not be null.

srcType

Repository type

Repository type.

* Required.
* Must not be null.

contentId

String

The resource identifier.

* Required.
* Must not be blank.

errorMsg

String

Error message.

* Optional.

Response

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 26

{
  "result" : "SUCCESS"
}

Response fields

Path Type Description

result

Result

Result sent back to Ingestion service.

error

Object

Error information. May be not provided.

Error fields

Path Type Description

message

String

Error message.

field

String

Name of the field on which the error is detected. May be not provided.

Handles the result of an FFmpeg process

$ curl 'http://www.wim.tv:8080/rest/ffmpeg/result' -i -X POST -H 'Content-Type: application/json' -H 'Accept: application/json' -d '{
  "resourceId" : "0e54ec7b-78f7-4ebc-9dc1-4dfc7d2129ec",
  "contentId" : "urn:wim:tv:content:a7f501df-0449-4b56-92e9-4d462b0a6f30",
  "duration" : 600000,
  "thumbnailName" : "thumbnail.png",
  "srcType" : "S3"
}'

Request headers

Name Description

Content-Type

application/json

* Required.

Accept

application/json

* Required.

Request fields

Path Type Description

srcType

Repository type

Repository type.

* Required.
* Must not be null.

contentId

String

The content identifier.

* Required.
* Must not be blank.

resourceId

String

The resource identifier.

* Required.
* Must not be blank.

thumbnailName

String

The thumbnail name.

* Optional.

duration

Number

The duration of the video (millisecs).

* Optional.

Response

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 26

{
  "result" : "SUCCESS"
}

Response fields

Path Type Description

result

Result

Result sent back to FFmpeg service.

error

Object

Error information. May be not provided.

Error fields

Path Type Description

message

String

Error message.

field

String

Name of the field on which the error is detected. May be not provided.

Authentication

The WimTV-Ingestion integration APIs require BASIC authentication.

Custom types

Ingestion repository types

Value Description

LOCAL

Local file system.

S3

AWS S3 bucket.

Status of an Ingestion process

Value Description

SUCCESSFULLY_TRANSCODED

Success.

TRANSCODING_FAILED

Failure.

Result sent back to the service

Value Description

SUCCESS

Success.

FAILURE

Failure.