Create a Job

PUT

https://app.mk.io/api/v1/projects/:project_name/media/transforms/:transform_name/jobs/:job_name

PUT

/api/v1/projects/:project_name/media/transforms/:transform_name/jobs/:job_name

curl -X PUT https://app.mk.io/api/v1/projects/project_name/media/transforms/transform_name/jobs/job_name \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "properties": {
    "input": {
      "@odata.type": "string",
      "assetName": "string"
    },
    "outputs": [
      {
        "@odata.type": "string",
        "assetName": "string"
      }
    ]
  }
}'

{
  "properties": {
    "input": {
      "@odata.type": "string",
      "assetName": "string",
      "end": {
        "@odata.type": "string",
        "time": "string"
      },
      "files": [
        "string"
      ],
      "label": "string",
      "start": {
        "@odata.type": "string",
        "time": "string"
      }
    },
    "outputs": [
      {
        "@odata.type": "string",
        "assetName": "string",
        "endTime": "string",
        "error": {
          "category": "Account",
          "code": "ConfigurationUnsupported",
          "message": "string",
          "retry": "DoNotRetry"
        },
        "label": "string",
        "progress": 0,
        "startTime": "string",
        "state": "Queued"
      }
    ],
    "correlationData": {},
    "created": "2024-01-15T09:30:00Z",
    "description": "string",
    "endTime": "string",
    "lastModified": "2024-01-15T09:30:00Z",
    "priority": "Normal",
    "recording": {
      "actualEndTime": "string",
      "actualStartTime": "string",
      "details": "string",
      "state": "Scheduled",
      "targetEndTime": "string",
      "targetStartTime": "string"
    },
    "startTime": "2024-01-15T09:30:00Z",
    "state": "Queued"
  },
  "id": "string",
  "name": "name",
  "systemData": {
    "createdAt": "2024-01-15T09:30:00Z",
    "createdBy": "string",
    "createdByType": "User",
    "internalId": "string",
    "lastModifiedAt": "2024-01-15T09:30:00Z",
    "lastModifiedBy": "string",
    "lastModifiedByType": "User"
  },
  "type": "string"
}

Create a new Job.

RBAC Capability Required: ams.job.create

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

project_namestringRequired

transform_namestringRequired

job_namestringRequired

Request

This endpoint expects an object.

propertiesobjectRequired

Properties of the job

Response

Job was created

propertiesobject

Properties of the job

idstringOptionalRead-only

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

namestringOptionalRead-onlyformat: "^[^\^\'<>%&:\\?/*+]+$"1-260 characters

The name of the resource

systemDataobjectOptional

Metadata pertaining to creation and last modification of the resource.

typestringOptionalRead-only

The type of the resource. E.g. "Microsoft.Media/mediaservices/assets"

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

409

Conflict Error

422

Unprocessable Entity Error

429

Too Many Requests Error

500

Internal Server Error