API Request Structure


Structure of a GET Request

This guide presents the Media Encoding Cluster GET requests as URLs, which can be used directly in a browser. The URL consists of:
  • Endpoint—The web service entry point to act on (e.g., http://api.encodingcluster.com or http://localhost:8080)
  • ActionUrl—The action you want to perform on the endpoint; for example: GetEncodingList (/api/v1/encoding)
  • Parameters—Any request parameters (id=072e8402-b401-48d3-a35e-414a485f18ba)
Format of an Url Request
http://[endpoint]/[ActionUrl]/[Parameters]

The following is an example GET request to get all Encodings.
http://localhost:8080/api/v1/encoding

The following is an example GET request to get the Encodings with the id=072e8402-b401-48d3-a35e-414a485f18ba.
http://localhost:8080/api/v1/encoding/072e8402-b401-48d3-a35e-414a485f18ba


Structure of a POST Request

This guide presents the Media Encoding Cluster POST requests, they are similar to GET Requests but in case you want to create a new Profile or add a new Encoding Job, you need to do this by POST Requests.
Always each POST Request have as Payload a JSON Data which Structure is defined in the desired Action.

  • Endpoint—The web service entry point to act on (e.g., http://api.encodingcluster.com or http://localhost:8080)
  • ActionUrl—The action you want to perform on the endpoint; for example: AddEncoding (/api/v1/encoding)
  • Parameters—Any request parameters (id=072e8402-b401-48d3-a35e-414a485f18ba)
Format of an Url Request
http://[endpoint]/[ActionUrl]/[Parameters]


The Structure of a Post request for submitting an Encoding Job
/api/v1/flow/{flow-uuid}/submit/{media-file}

The following is an example POST request to create a new Encoding Job.
http://localhost:8080/api/v1/flow/072e8402-b401-48d3-a35e-414a485f18ba/submit//media/video/example.mp4





Comments