Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 4 Next »


/api/0.1/executions

HTTP Verbs:

  • GET - Returns JSON formatted list of executions.
    • Returned structure:
         [
            {
               "execution_id": <execution_id>,
               "workflow_name": <name>,
               "service_template_name": <template name>,

                              "service_name": <service name>,

                              "status": <execution state>

                       }

                       {

                            ......

                        }

                  ]

/api/0.1/executions/<execution_id>

  • GET - Returns JSON formatted details of specific execution ID ( positive integer)
    • Returned structure:
         {
            "execution_id": <execution_id>,
            "workflow_name": <name>,
            "service_template_name": <template name>,

                         "service_name": <service name>,

                          "status": <execution state>

                  }

  • POST - Resumes a stopped execution.
  • DELETE - Cancels the specified execution.

/api/0.1/nodes/<node_id>

  • GET - Returns JSON encoded details of specified node template.

/api/0.1/services

  • GET - Returns JSON list of all services.
    • Returned structure:
         [
            {
               "id": <service_id>,
               "description": <description>,
               "name": <service name>,

                              "service_template": <service template id>,

                              "created": <created date>,

                              "updated": <updated date>

                       }

                       {

                            ......

                        }

                  ]

/api/0.1/services/<service_id>

  • DELETE - Deletes the specified service id (positive integer)

/api/0.1/services/<service_id>/executions

  • GET - Returns JSON list of all executions for the specified service id (positive integer)
    • Returned structure:  see  /api/0.1/executions

/api/0.1/services/<service_id>/executions/<workflow_name>

  • POST - Starts the execution of the specified workflow name for the specified service id (positive integer)


/api/0.1/services/<service_id>/inputs

  • GET - Gets the JSON formatted inputs for the specified service id (positive integer)
    • Returned structure:
            [
                  {
                     "name": <input name>,
                     "description": <input description>,
                     "value": <input value>

                             }

                             {

                                  ......

                              }

                        ]

/api/0.1/services/<service_id>/outputs

  • GET - Gets the JSON formatted outputs for the specified service id (positive integer)
  • Returned structure:
          [
                {
                   "name": <output name>,
                   "description": <output description>,
                   "value": <output value>

                           }

                           {

                                ......

                            }

                      ]

/api/0.1/services/<service_id>/workflows

  • GET - Lists all defined user workflows for the specified service id (positive integer)

/api/0.1/templates

  • POST - Validates a TOSCA template based on the JSON formatted POST body (content type = application/json)
    • POST body keys and usage:
      • service_template_path,  string, required, URL to template or CSAR
      • service_template_filename, string, optional, default to service-template.yaml
    • Example body:
       {
            "service_template_path":  "http://myhost/templates/mytemplate.csar" ,
            "service_template_filename": "mytemplate.yaml"
      }


/api/0.1/templates

  • GET - Returns JSON list of stored templates.

/api/0.1/templates/<template_id> 

  • DELETE - Delete a template from ARIA storage (positive integer)

/api/0.1/templates/<template_id>/json

  • GET - Gets a JSON representation of a template by id (positive integer)

/api/0.1/templates/<template_id>/nodes

  • GET - Returns JSON formatted list of node template in specified template id (positive integer)

/api/0.1/templates/<template_id>/services/<service_name>

  • POST  - Creates a service from the specified service template id (positive integer)

/api/0.1/templates/<template_name>

  • PUT - Installed a service template in ARIA storage based on PUT body and encoding.
    •  
  • No labels