(Click to open topic with navigation)

4.55 Create Template

In this topic:

4.55.1 URL

POST /api/templates/

4.55.2 Example

POST /api/templates/

4.55.2.A Request Body

ClosedRequest Body 
{
  "name": "Template Name",
  "published": true,
  "widgets": [
    {
      "default_value": "",
      "label": "Name",
      "variable_name": "NAME",
      "visible": true,
      "editable": true,
      "properties": [
        {
          "name": "id",
          "value": "name"
        }
      ],
      "tooltip": "Allows you to specify a more friendly name (note: name must be alphanumeric)"
    },
    {
      "default_value": 0,
      "label": "Duration",
      "variable_name": "DURATION",
      "visible": true,
      "editable": true,
      "properties": [
        {
          "name": "id",
          "value": "duration"
        }
      ],
      "tooltip": "The amount of time the job is expected to run for"
    },
    {
      "default_value": "",
      "label": "Job Arrays",
      "variable_name": "arrays",
      "visible": true,
      "editable": true,
      "properties": [
        {
          "name": "id",
          "value": "arrays"
        },
        {
          "name": "enable",
          "value": "true"
        },
        {
          "name": "start-value",
          "value": "0"
        },
        {
          "name": "end-value",
          "value": "1"
        },
        {
          "name": "start-variable",
          "value": "STARTINDEX"
        },
        {
          "name": "end-variable",
          "value": "ENDINDEX"
        }
      ]
    },
    {
      "default_value": 0,
      "label": "Delay Start By",
      "variable_name": "ELIGIBLEDATE",
      "visible": false,
      "editable": false,
      "properties": [
        {
          "name": "id",
          "value": "eligibledate"
        }
      ],
      "tooltip": "Declares the time after which the job is eligible for execution"
    },
    {
      "default_value": "0",
      "label": "User Priority",
      "variable_name": "USERPRIORITY",
      "visible": false,
      "editable": false,
      "properties": [
        {
          "name": "id",
          "value": "priority"
        },
        {
          "name": "enable",
          "value": "false"
        }
      ],
      "tooltip": "Defines the priority of the job"
    },
    {
      "default_value": "",
      "label": "Submission Script",
      "variable_name": "SCRIPT",
      "visible": true,
      "editable": true,
      "properties": [
        {
          "name": "id",
          "value": "script"
        }
      ]
    },
    {
      "default_value": "",
      "label": "Account",
      "variable_name": "ACCOUNT",
      "visible": false,
      "editable": true,
      "properties": [
        {
          "name": "id",
          "value": "account"
        }
      ],
      "tooltip": "Defines the account associated with the job"
    },
    {
      "default_value": "",
      "label": "Queue / Class",
      "variable_name": "DESTINATIONQUEUE",
      "visible": false,
      "editable": true,
      "properties": [
        {
          "name": "id",
          "value": "destinationQueue"
        }
      ],
      "tooltip": "Defines the destination queue / class of the job"
    },
    {
      "default_value": "",
      "label": "Quality of Service",
      "variable_name": "QOS",
      "visible": false,
      "editable": true,
      "properties": [
        {
          "name": "id",
          "value": "qos"
        }
      ],
      "tooltip": "Defines the desired QoS for the job"
    },
    {
      "default_value": "",
      "label": "Number of Cores",
      "variable_name": "NUMOFCORES",
      "visible": true,
      "editable": true,
      "properties": [
        {
          "name": "id",
          "value": "cpupernode"
        }
      ],
      "tooltip": "Defines the resources that are required by the job and establishes a limit to the amount of resource that can be consumed"
    },
    {
      "default_value": "0.5",
      "label": "Total Memory (GB)",
      "variable_name": "MEMORYPERNODE",
      "visible": true,
      "editable": true,
      "properties": [
        {
          "name": "id",
          "value": "memorypernode"
        }
      ],
      "tooltip": "Defines the resources that are required by the job and establishes a limit to the amount of resource that can be consumed"
    },
    {
      "default_value": "",
      "label": "Architecture",
      "variable_name": "ARCHITECTURE",
      "visible": true,
      "editable": true,
      "properties": [
        {
          "name": "id",
          "value": "architecture"
        }
      ],
      "tooltip": "Defines the resources that are required by the job and establishes a limit to the amount of resource that can be consumed"
    },
    {
      "default_value": "",
      "label": "Execution Path",
      "variable_name": "EXECUTIONDIRECTORY",
      "visible": false,
      "editable": true,
      "properties": [
        {
          "name": "id",
          "value": "exedir"
        }
      ],
      "tooltip": "Your job’s execution directory"
    },
    {
      "default_value": "",
      "label": "Error Path",
      "variable_name": "ERRORPATH",
      "visible": false,
      "editable": true,
      "properties": [
        {
          "name": "id",
          "value": "errorpath"
        }
      ],
      "tooltip": "Defines the path to be used for the standard error stream of the job"
    },
    {
      "default_value": "",
      "label": "Output Path",
      "variable_name": "OUTPUTPATH",
      "visible": false,
      "editable": true,
      "properties": [
        {
          "name": "id",
          "value": "outputpath"
        }
      ],
      "tooltip": "Defines the path to be used for the standard output stream of the job"
    },
    {
      "default_value": "false",
      "label": "Merge Streams",
      "variable_name": "JOIN",
      "visible": false,
      "editable": false,
      "properties": [
        {
          "name": "id",
          "value": "join"
        }
      ],
      "tooltip": "Merge stderr and stdout streams?"
    },
    {
      "default_value": "false",
      "label": "Hold Job",
      "variable_name": "HOLD",
      "visible": false,
      "editable": false,
      "properties": [
        {
          "name": "id",
          "value": "hold"
        }
      ],
      "tooltip": "Specifies that a user hold be applied to the job at submission time"
    },
    {
      "default_value": "",
      "label": "Script Shell",
      "variable_name": "SHELL",
      "visible": false,
      "editable": false,
      "properties": [
        {
          "name": "id",
          "value": "shell"
        }
      ],
      "tooltip": "Declares the shell that interprets the job script, e.g. /bin/bash"
    },
    {
      "default_value": "true",
      "label": "Moab Environment Variables",
      "variable_name": "MOABENVIRONMENTVARIABLES",
      "visible": false,
      "editable": false,
      "properties": [
        {
          "name": "id",
          "value": "moabenvironmentvariables"
        }
      ],
      "tooltip": "Push Moab environment variables to job?"
    },
    {
      "default_value": "",
      "label": "Email Notification List",
      "variable_name": "MAILLIST",
      "visible": false,
      "editable": false,
      "properties": [
        {
          "name": "id",
          "value": "maillist"
        }
      ],
      "tooltip": "Specifies the list of users to whom mail is sent by the execution server. Overrides the EMAILADDRESS specified on the USERCFG [credential]"
    },
    {
      "default_value": "",
      "label": "Email Options",
      "variable_name": "EMAILOPTIONS",
      "visible": false,
      "editable": false,
      "properties": [
        {
          "name": "id",
          "value": "emailoptions"
        }
      ],
      "tooltip": "A list of requested email options"
    },
    {
      "default_value": "",
      "label": "Generic Resources",
      "variable_name": "GENERICRESOURCES",
      "visible": false,
      "editable": false,
      "properties": [
        {
          "name": "id",
          "value": "genericresources"
        }
      ],
      "tooltip": "Allows for specification of additional job attributes"
    },
    {
      "default_value": "",
      "label": "Feature Tags",
      "variable_name": "FEATURETAGS",
      "visible": false,
      "editable": false,
      "properties": [
        {
          "name": "id",
          "value": "featuretags"
        }
      ],
      "tooltip": "The feature tags of compute node"
    }
  ],
  "sections": [
    {
      "name": "defaults",
      "value": "Basic Job Settings"
    },
    {
      "name": "timeManagement",
      "value": "Time Management"
    },
    {
      "name": "credentials",
      "value": "Credentials"
    },
    {
      "name": "resources",
      "value": "Resources"
    },
    {
      "name": "dataManagement",
      "value": "Data Management"
    },
    {
      "name": "custom",
      "value": "Custom Settings"
    },
    {
      "name": "basic",
      "value": "Basic Settings"
    },
    {
      "name": "advanced",
      "value": "Advanced Settings"
    }
  ],
  "permissions": [
    {
      "name": "ALL",
      "type": "user"
    },
    {
      "name": "ALL",
      "type": "group"
    },
    {
      "name": "ALL",
      "type": "account"
    }
  ]
}

4.55.2.B Response

ClosedResponse 
{
  "url": "http://localhost:8080/api/templates/8/",
  "assigned": "ALL",
  "date": "2015-09-01",
  "id": 8,
  "name": "Template Name",
  "owner": "hpotter",
  "permissions": [
    {
      "name": "ALL",
      "type": "account"
    },
    {
      "name": "ALL",
      "type": "group"
    },
    {
      "name": "ALL",
      "type": "user"
    }
  ],
  "published": true,
  "sections": [
    {
      "name": "defaults",
      "value": "Basic Job Settings"
    },
    {
      "name": "timeManagement",
      "value": "Time Management"
    },
    {
      "name": "credentials",
      "value": "Credentials"
    },
    {
      "name": "resources",
      "value": "Resources"
    },
    {
      "name": "dataManagement",
      "value": "Data Management"
    },
    {
      "name": "custom",
      "value": "Custom Settings"
    },
    {
      "name": "basic",
      "value": "Basic Settings"
    },
    {
      "name": "advanced",
      "value": "Advanced Settings"
    }
  ],
  "use": 0,
  "widgets": [
    {
      "default_value": "",
      "editable": true,
      "label": "Name",
      "variable_name": "NAME",
      "visible": true,
      "properties": [
        {
          "name": "id",
          "value": "name"
        }
      ]
    },
    {
      "default_value": "0",
      "editable": true,
      "label": "Duration",
      "variable_name": "DURATION",
      "visible": true,
      "properties": [
        {
          "name": "id",
          "value": "duration"
        }
      ]
    },
    {
      "default_value": "",
      "editable": true,
      "label": "Job Arrays",
      "variable_name": "arrays",
      "visible": true,
      "properties": [
        {
          "name": "id",
          "value": "arrays"
        },
        {
          "name": "enable",
          "value": "true"
        },
        {
          "name": "start-value",
          "value": "0"
        },
        {
          "name": "end-value",
          "value": "1"
        },
        {
          "name": "start-variable",
          "value": "STARTINDEX"
        },
        {
          "name": "end-variable",
          "value": "ENDINDEX"
        }
      ]
    },
    {
      "default_value": "0",
      "editable": false,
      "label": "Delay Start By",
      "variable_name": "ELIGIBLEDATE",
      "visible": false,
      "properties": [
        {
          "name": "id",
          "value": "eligibledate"
        }
      ]
    },
    {
      "default_value": "0",
      "editable": false,
      "label": "User Priority",
      "variable_name": "USERPRIORITY",
      "visible": false,
      "properties": [
        {
          "name": "id",
          "value": "priority"
        },
        {
          "name": "enable",
          "value": "false"
        }
      ]
    },
    {
      "default_value": "",
      "editable": true,
      "label": "Submission Script",
      "variable_name": "SCRIPT",
      "visible": true,
      "properties": [
        {
          "name": "id",
          "value": "script"
        }
      ]
    },
    {
      "default_value": "",
      "editable": true,
      "label": "Account",
      "variable_name": "ACCOUNT",
      "visible": false,
      "properties": [
        {
          "name": "id",
          "value": "account"
        }
      ]
    },
    {
      "default_value": "",
      "editable": true,
      "label": "Queue / Class",
      "variable_name": "DESTINATIONQUEUE",
      "visible": false,
      "properties": [
        {
          "name": "id",
          "value": "destinationQueue"
        }
      ]
    },
    {
      "default_value": "",
      "editable": true,
      "label": "Quality of Service",
      "variable_name": "QOS",
      "visible": false,
      "properties": [
        {
          "name": "id",
          "value": "qos"
        }
      ]
    },
    {
      "default_value": "",
      "editable": true,
      "label": "Number of Cores",
      "variable_name": "NUMOFCORES",
      "visible": true,
      "properties": [
        {
          "name": "id",
          "value": "cpupernode"
        }
      ]
    },
    {
      "default_value": "0.5",
      "editable": true,
      "label": "Total Memory (GB)",
      "variable_name": "MEMORYPERNODE",
      "visible": true,
      "properties": [
        {
          "name": "id",
          "value": "memorypernode"
        }
      ]
    },
    {
      "default_value": "",
      "editable": true,
      "label": "Architecture",
      "variable_name": "ARCHITECTURE",
      "visible": true,
      "properties": [
        {
          "name": "id",
          "value": "architecture"
        }
      ]
    },
    {
      "default_value": "",
      "editable": true,
      "label": "Execution Path",
      "variable_name": "EXECUTIONDIRECTORY",
      "visible": false,
      "properties": [
        {
          "name": "id",
          "value": "exedir"
        }
      ]
    },
    {
      "default_value": "",
      "editable": true,
      "label": "Error Path",
      "variable_name": "ERRORPATH",
      "visible": false,
      "properties": [
        {
          "name": "id",
          "value": "errorpath"
        }
      ]
    },
    {
      "default_value": "",
      "editable": true,
      "label": "Output Path",
      "variable_name": "OUTPUTPATH",
      "visible": false,
      "properties": [
        {
          "name": "id",
          "value": "outputpath"
        }
      ]
    },
    {
      "default_value": "false",
      "editable": false,
      "label": "Merge Streams",
      "variable_name": "JOIN",
      "visible": false,
      "properties": [
        {
          "name": "id",
          "value": "join"
        }
      ]
    },
    {
      "default_value": "false",
      "editable": false,
      "label": "Hold Job",
      "variable_name": "HOLD",
      "visible": false,
      "properties": [
        {
          "name": "id",
          "value": "hold"
        }
      ]
    },
    {
      "default_value": "",
      "editable": false,
      "label": "Script Shell",
      "variable_name": "SHELL",
      "visible": false,
      "properties": [
        {
          "name": "id",
          "value": "shell"
        }
      ]
    },
    {
      "default_value": "true",
      "editable": false,
      "label": "Moab Environment Variables",
      "variable_name": "MOABENVIRONMENTVARIABLES",
      "visible": false,
      "properties": [
        {
          "name": "id",
          "value": "moabenvironmentvariables"
        }
      ]
    },
    {
      "default_value": "",
      "editable": false,
      "label": "Email Notification List",
      "variable_name": "MAILLIST",
      "visible": false,
      "properties": [
        {
          "name": "id",
          "value": "maillist"
        }
      ]
    },
    {
      "default_value": "",
      "editable": false,
      "label": "Email Options",
      "variable_name": "EMAILOPTIONS",
      "visible": false,
      "properties": [
        {
          "name": "id",
          "value": "emailoptions"
        }
      ]
    },
    {
      "default_value": "",
      "editable": false,
      "label": "Generic Resources",
      "variable_name": "GENERICRESOURCES",
      "visible": false,
      "properties": [
        {
          "name": "id",
          "value": "genericresources"
        }
      ]
    },
    {
      "default_value": "",
      "editable": false,
      "label": "Feature Tags",
      "variable_name": "FEATURETAGS",
      "visible": false,
      "properties": [
        {
          "name": "id",
          "value": "featuretags"
        }
      ]
    }
  ]
}

Related Topics 

  • 4.62 Application Template API
  • 4.59 Supported Methods

    • © 2016 Adaptive Computing