Command.38 Create or Update WorkflowAsLibrary

Overview

• Create a Workflow As Library if it does not exist
• Update a Workflow As Library if it is already present

URI

/catramms/v1/workflowLibrary

Method

PUT

URL Params

Required

None

Optional

None

Payload Data

• The workflow (json) that has to be created/updated into MMS.

{
  "Label": "Picture of the Video",
  "Task": {
    "Label": "${Label}",
    "Parameters": {
      "ExecutionType": "parallel",
      "ReferencesOutput": [
        {"ReferenceLabel": "Frame Containing Face: ${Title}"},
        {"ReferenceLabel": "Frame: ${Title}"}
      ],
      "Tasks": [{
        "Label": "Frame Containing Face: ${Title}",
        "OnError": {"Task": {
          "Label": "Frame: ${Title}",
          "OnSuccess": {"Task": {
            "Label": "Encode image (Frame): ${title}",
            "Parameters": {
              "ContentType": "image",
              "EncodingPriority": "High",
              "EncodingProfileLabel": "MMS_JPG_240"
            },
            "Type": "Encode"
          }},
          "Parameters": {
            "Height": 480,
            "Ingester": "Giuliano",
            "InstantInSeconds": 0,
            "Retention": "${ImageRetention}",
            "Tags": "[\"[\\\"[\\\\\\\"[\\\\\\\\\\\\\\\"${ImageTags}\\\\\\\\\\\\\\\"]\\\\\\\"]\\\"]\"]",
            "Title": "${Title}",
            "Width": 640
          },
          "Type": "Frame"
        }},
        "OnSuccess": {"Task": {
          "Label": "Encode image (FrameContainingFace): ${Title}",
          "Parameters": {
            "ContentType": "image",
            "EncodingPriority": "High",
            "EncodingProfileLabel": "MMS_JPG_240"
          },
          "Type": "Encode"
        }},
        "Parameters": {
          "CascadeName": "haarcascade_frontalface_alt_tree",
          "EncodingPriority": "High",
          "Ingester": "Giuliano",
          "InitialFramesNumberToBeSkipped": "${FaceRecognition_InitialFramesNumberToBeSkipped}",
          "OneFramePerSecond": true,
          "Output": "FrameContainingFace",
          "Retention": "${ImageRetention}",
          "Tags": "${ImageTags}",
          "Title": "${Title}"
        },
        "Type": "Face-Recognition"
      }]
    },
    "Type": "GroupOfTasks"
  },
  "Type": "Workflow",
  "Variables": {
    "FaceRecognition_InitialFramesNumberToBeSkipped": {
      "Type": "integer",
      "Value": 1500
    },
    "FrameCaptureSeconds": {
      "Type": "decimal",
      "Value": 60
    },
    "ImageRetention": {
      "Type": "string",
      "Value": "1d"
    },
    "ImageTags": {
      "Type": "string",
      "Value": "FACE"
    },
    "Ingester": {
      "Type": "string",
      "Value": "Admin"
    },
    "Label": {
      "Type": "string",
      "Value": "Image label"
    },
    "Title": {
      "Type": "string",
      "Value": "My Title"
    }
  }
}

Success Response

Code

201 Created

Content

{ 
   "workflowLibraryKey": 12,
   "Label": "Picture of the Video"
}

Error Response

See Common Error Responses

Sample Call

curl -k -v -X PUT -d '...' https://mms-api.catrasoft.cloud/catramms/v1/workflowLibrary