Creating an operation - Cloud

Talend Cloud API Designer User Guide

Version
Cloud
Language
English (United States)
Product
Talend Cloud
Module
Talend API Designer
Content
Design and Development > Designing APIs
An operation is the action that can be performed on your resources.

Procedure

  1. Click the + button in the top right corner of the left panel.
    Tip: If you want to create your operation directly in a previously created section, you can do so by clicking the + button to the right of the section name. If you have already created a resource, you can click the + button to the right of the resource path to create an operation for this resource.
  2. Click Operation, or click the type of operation, for example GET if you are creating it in an existing resource.
    If you create an operation in an existing resource, the method and the path of the operation are filled automatically.
  3. Enter a Name for your operation, Get list of contacts for example.
  4. Select the Method and enter a Path and Description if needed.
    If you enter a path that does not match an existing resource, a new resource will be created.
  5. Enter Tags and an Id if needed.
  6. If you want to add a different security scheme than the whole API, click the pencil icon to the right of SECURITY, and select Customize security for this resource.
  7. Select your security scheme(s).
    Note: Security schemes are defined in the SECURITY section of your API.
  8. Add REQUEST and RESPONSES parameters if needed.
    Reusable request bodies are not supported.
    Note: Header names containing dashes, such as Content-Type or Access-Key can cause errors in Talend Studio. You should avoid using them if you want to import your API definition and use it in a Job or Route.
  9. Click Save.