Create new process

Description

Creates a new process

Endpoint

/path/process

Method

POST

Access Level Rules

Minimum Access Level

edit+ on parent folder or account holder in root.

Processing Units

Processing units

1

Parameters

Name
Description
Required
Default

name

The name of the new process.

true

process

A JSON with properties "parameters", "gitUrl" and "gitFile". "parameters" should be an array of objects. Each object should have a name, description and example. All should be of type string. "gitUrl" should be a string with the url of the git to run as string. "gitFile" should be the location of the file in the git as string.

true

parentId

The id of the parent folder of the new path.

If omitted the new path is placed in your myDrive root.

false

Default null.

publicAccess

Public access object with properties "hidden" and "accessTier" "accessTier" must be between "none" and "edit" and "hidden" must be a boolean.

false

Default {accessTier:"none", hidden:true}.

metadata

A JSON with property "description" with the description of the file.

false

Default null.

Example request:

{
  name: 'test process',
  metadata: { description: 'test description' },
  publicAccess: {hidden:true, accessTier:'view'},
  process: {
    parameters: [{"description":"first number to multiply", "example":"2", "name":"parameter 1" }, {"description":"second number to multiply", "example":"4", "name":"parameter 2" }],
    gitUrl: "https://github.com/multiplier/multiplication",
    gitFile: "multiply.py",
  },
};

Last updated