Operations
Last updated
Last updated
New operations are added to the project or container by pressing the 'ADD' button.
There are a couple or properties that can or must be defined for each operation.
Identifier A unique (in the context of the container this operation belongs to) identifier for the operation. Must start with a character and can only contain characters and numbers.
Path Required. The path to call for this operation. Sometimes referred to as resource or simply url. You can add 'path parameters' like this: '/resource/{id}' where 'id' is a path parameter. You also have to option to check 'Absolute path'. If you do, the 'Path' will not depend on any containers (just on the 'Base address' set in connector configuration).
Display name Friendly name of operation. If specified, this is what will be displayed when selecting operation in machine step. If not specified, 'Identifier' will be used.
Description Mainly for documentation purposes. It will also appear as a tool tip when selection operation in machine step.
Http method Required. Specify which http method to use for this operation, such as GET, POST or DELETE.
Can be repeated Here you can specify if this operation is to be repeatable in a workflow. Typically a 'GET'-operation can be repeated while a 'DELETE' or 'POST' should not be repeated. But it is up to you to set this. Nothing is assumed.
You specify operation authorization if you have created any in Authorization schemes. This can always be added later, so there is no requirement to set this upfront.
Press OK to create the operation. Once the operation has been created you can specify input and output of the operation.