VidiNet

Cost estimation

Retrieve cost estimates from VidiNet.

The following resources support cost estimation:

• POST /item/(item-id)/transcode
• POST /item/(item-id)/shape/(shape-id)/analyze
• POST /item/(item-id)/shape/(shape-id)/component/(component-id)/analyze
• POST /import
• POST /storage/(storage-id)/file/(file-id)/import
• POST /storage/file/(file-id)/import

Request a cost estimate

POST /cost/(path)

Requests a cost estimate for performing a specific operation.

The same query parameters and request body as used by the target request should be specified in the cost estimate request.

No additional roles or permissions are required to request a cost estimate. If a user has permission to for example transcode an item, then that user may also request a cost estimate for that operation.

Produces:

• application/xml, application/json – CostEstimateDocument

Retrieve the cost estimate results

GET /cost/estimate/(id)

Retrieves the cost estimate.

Produces:

• application/xml, application/json – CostEstimateDocument

Examples

Item transcode cost estimation

Requesting a cost estimate for transcoding an item to __mp4 using the VidiNet TRANSCODE resource VX-5:

POST /cost/item/VX-45/transcode?tag=__mp4&resource=VX-5

<CostEstimateDocument xmlns="http://xml.vidispine.com/schema/vidispine">
  <id>dGVzdA==</id>
  <url>http://localhost:8080/API/cost/estimate/dGVzdA==</url>
</CostEstimateDocument>

Retrieving the cost estimate status and amount.

GET /cost/estimate/dGVzdA==

<CostEstimateDocument xmlns="http://xml.vidispine.com/schema/vidispine">
  <id>dGVzdA==</id>
  <url>http://localhost:8080/API/cost/estimate/dGVzdA==</url>
  <state>FINISHED</state>
  <service>
    <resource>VX-5</resource>
    <type>TRANSCODER</type>
    <state>ONLINE</state>
  </service>
</CostEstimateDocument>