#%RAML 0.8
title: Data hub orchestration APIs
baseUri: https://api.covisintlabs.com/orchestrationconfig/v1
protocols: [HTTPS]

schemas: !include gav://nexus-cov-raml/LATEST/common-schema
  - orchestrationConfigs: |
      {
        "id": "http://api.covisint.com/schema/orchestrations",
        "$schema": "http://json-schema.org/draft-04/schema",
        "description": "Collection of exception definitions.",
        "type": "array",
        "items": {
          "$ref": "http://api.covisint.com/schema/orchestrationConfig#"
        }
      }
  - orchestrationConfig: |
      {
        "$schema": "http://json-schema.org/draft-04/schema#",
        "id": "http://api.covisint.com/schema/orchestrationConfig",
        "type": "object",
        "description": "Schema representing orchestrations",
        "extends":{
         "$ref":"http://api.covisint.com/schema/realmScopedResource#"
        },
        "properties": {
            "name": {
                "description": "name for a  configuration",
                "$ref": "http://api.covisint.com/idm/schema/internationalString#"
            },
            "description" : {
              "description": "The application description (internationalized).",
              "$ref" : "http://api.covisint.com/idm/schema/internationalString#"
            },
            "orchestrationType": {
                "description": "define orchestration type",
                "enum": ["senderWire","receiverWire","common","compound"]
            },
            "tagIds": {
                "description": "list of tag Id( or documentInfo Id) associated with orchestration.",
                "type":"array",
                "minItems": 1,
                "items" : [
                  {
                   "type": "string"
                  }
                ]
            },
            "serviceRunTime": {
                "type": "number",
                "minValue": 1,
                "maxValue":600000,
                "description": "define run time of service in milliseconds."
            },
            "active": {
                "type": "boolean",
                "description": "show status of orchestration configuration",
                "default": true
            },
            "tasks": {
                "type": "array",
                "minItems": 1,
                "uniqueItems": false,
                "description": "list of tasks for transformation",
                "items": [
                   {
                      "type": "object",
                      "properties": {
                         "taskType": {
                             "enum": ["PREPROCESSOR","PARSER","MAPPER","PACKAGER","POSTPROCESSOR"],
                             "description": "type of task represents the phase of orchestration process",
                             "default": "preprocessor"
                         },
                         "name": {
                             "description": "name of the task to be performed for transformation of data",
                             "$ref": "http://api.covisint.com/idm/schema/internationalString#"
                         },
                         "type": {
                             "enum": ["JAVA","JAVASCRIPT","XSD","XSLT"],
                             "description": "supported language type"
                         },
                         "className": {
                             "type": "string",
                             "description": "name of the java class or javascript function performing the orchestration task"
                         },
                         "order": {
                             "type": "number",
                             "description": "order in which task to be executed",
                             "default": 0
                         },
                         "serviceParms": {
                             "type": "string",
                             "description": "list of params required for the task execution"
                         },
                         "continueOnFailure": {
                             "type": "boolean",
                             "description": "if this flag is true, orchestration continues even in case of any error, else orchestration stops",
                             "default": true
                         }
                      }
                      , "required": ["taskType","name", "type","className", "order", "serviceParms" ]
                   }
                ]
            },
            "tagTpRelationship": {
                "description": "list of tag TP Relationship Id associated with orchestration.",
                "type":"array",
                 "minItems": 0,
                 "items" : [
                  {
                   "type": "string"
                  }
                ]
            },
            "tagTpCodeRelationship": {
                "description": "list of tag TP Code Relationship Id associated with orchestration.",
                "type":"array",
                 "minItems": 0,
                 "items" : [
                  {
                   "type": "string"
                  }
                ]
            },
            "targetDocumentInfo": {
                "type": "string",
                "description": "Valid document info id."
            },
            "tags": {
                "description": "The tags associated with this orchestration config.",
                "$ref": "http://api.covisint.com/idm/schema/tag#",
                "readOnly": true
            }
        }
        , "required": [ "name", "orchestrationType", "tasks", "tagIds", "targetDocumentInfo", "serviceRunTime"  ]
      }

traits: !include gav://nexus-cov-raml/LATEST/common-traits
/orchestrationConfigs:
  description: Collection endpoint to create new configuration for orchestration service.[Since:1.0]
  is: [secured]
  post:
        description: Creates orchestration configuration for document to be transformed. [Flow-name:orchestrationConfig-create-orchestrationConfig][Since:1.0][visibility:public]
        headers:
          Accept:
            description: Media type.
            example: application/vnd.com.covisint.platform.orchestrationConfig.v1+json
            type: string
            required: true
          Content-Type:
            description: Media type of the response body.
            example: application/vnd.com.covisint.platform.orchestrationConfig.v1+json
            type: string
            required: true
        is: [postResponse,secured]
        body:
          application/vnd.com.covisint.platform.orchestrationConfig.v1+json:
            schema: orchestrationConfig
        responses:
          201:
            description: orchestration configuration created successfully.
            body:
              application/vnd.com.covisint.platform.orchestrationConfig.v1+json:
                schema: orchestrationConfig
          400:
            description: |
              There was a problem with the client's request.
                ___
                Substatus codes and error messages are mentioned below:
                + framework:request
                + framework:request:io
                + framework:request:io:read - Invalid input. There was an error while parsing.
                + framework:request:io:read:parsing
                + framework:request:io:write
                + framework:request:header:missing - Missing request header: {headerName}
                + framework:request:data:missing - The following information was missing from the resource: {resourceFieldName(s)}
                + framework:request:invalid:header:value - Invalid x-requester header value. Valid values are [person, application]
            body:
              application/vnd.com.covisint.error.v1+json:
                schema: errorResponseSchema
  get:
    is: [pagableRequest,getSearchResponse,secured]
    description: Search orchestrations configurations based on the given filter criteria parameters. [Flow-name:orchestrationConfig-search-orchestrationConfig][Since:1.0][visibility:public]
    headers:
     Accept:
       description: Media type
       example: application/vnd.com.covisint.platform.orchestrationConfig.v1+json
       type: string
       required: true
    queryParameters:
      orchestrationType:
        description: Retrieve configuration with the specified  Type .
        type: string
        required: false
      id:
        description: Retrieve configuration with the specified  config id.
        type: string
        required: false
      name:
        description: Retrieve configuration with the specified name.
        type: string
        required: false
      targetDocumentInfo:
        description: Retrieve configuration with the specified targetDocumentInfo.
        type: string
        required: false
      tagTpRelationship:
        description: Retrieve configuration with the specified tagTpRelationship.
        type: string
        required: false
      tagTpCodeRelationship:
        description: Retrieve configuration with the specified tagTpCodeRelationship.
        type: string
        required: false
      tagIds:
        description: Retrieve configuration with the specified tagId.
        type: string
        required: false
      tag:
        description: Retrieve configuration with the specified tag.
        type: string
        required: false
      active:
        description: Retrieve configuration with the specified status.
        type: string
        required: false
      sortBy:
        description: Sort the search results.
        type: string
        required: false
        enum: ["+creation","+name","+orchestrationType"]
    responses:
      200:
        description: All Exception Trace messages that satisfy the query parameters were successfully retrieved (response collection may be empty).
        body:
          application/vnd.com.covisint.platform.orchestrationConfig.v1+json:
           schema: orchestrationConfig
      400:
        description: |
            There was a problem with the client's request
            ___
            Substatus codes and error messages are mentioned below:
            + framework:request
            + framework:request:io
            + framework:request:io:read - Invalid input. There was an error while parsing.
            + framework:request:io:read:parsing
            + framework:request:io:write
            + framework:request:header:missing - Missing request header: {headerName}
            + framework:request:data:missing - The following information was missing from the resource: {resourceFieldName(s)}
            + framework:request:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application]
        body:
          application/vnd.com.covisint.error.v1+json:
            schema: errorResponseSchema
  /{Id}:
    description: Endpoint for an individual configuration.
    uriParameters:
      Id:
        description: Unique id of the orchestration configuration.
        type: string
    get:
      description: Retrieve the configuration by its unique id. [Flow-name:orchestrationConfig-get-orchestrationConfig][Since:1.0][visibility:public]
      headers:
        Accept:
          description: Media type.
          example: application/vnd.com.covisint.platform.orchestrationConfig.v1+json
          type: string
          required: true
      is: [getResponse,secured]
      responses:
        200:
          description: Configuration was successfully retrieved by its id.
          body:
            application/vnd.com.covisint.platform.orchestrationConfig.v1+json:
              schema: orchestrationConfig
        400:
            description: |
                There was a problem with the client's request.
                ___
                Substatus codes and error messages are mentioned below:
                + framework:request
                + framework:request:io
                + framework:request:io:read - Invalid input. There was an error while parsing.
                + framework:request:io:read:parsing
                + framework:request:io:write
                + framework:request:header:missing - Missing request header: {headerName}
                + framework:request:param:missing - Missing request parameter.
                + framework:request:data:missing - The following information was missing from the resource: {resourceFieldName(s)}
                + framework:request:invalid:header:value - Invalid x-requester header value. Valid values are [person, application]
            body:
              application/vnd.com.covisint.error.v1+json:
                schema: errorResponseSchema
    put:
      description: Updates an existing orchestration configuration. Throws an error if {configId} does not already exist.[Flow-name:orchestrationConfig-update-orchestrationConfig][Since:1.0][visibility:public]
      headers:
        Accept:
          description: Media type.
          example: application/vnd.com.covisint.platform.orchestrationConfig.v1+json
          type: string
          required: true
        Content-Type:
          description: The Content type
          example: application/vnd.com.covisint.platform.orchestrationConfig.v1+json
          type: string
          required: true
      is: [putResponseV2,secured]
      responses:
        200:
          description: Successfully updated the requested orchestration.
          body:
            application/vnd.com.covisint.platform.orchestrationConfig.v1+json:
              schema: orchestrationConfig
        400:
            description: |
                There was a problem with the client's request.
                ___
                Substatus codes and error messages are mentioned below:
                + framework:request
                + framework:request:io
                + framework:request:io:read - Invalid input. There was an error while parsing.
                + framework:request:io:read:parsing
                + framework:request:io:write
                + framework:request:header:missing - Missing request header: {headerName}
                + framework:request:param:missing - Missing request parameter.
                + framework:request:data:missing - The following information was missing from the resource: {resourceFieldName(s)}
                + framework:request:invalid:header:value - Invalid x-requester header value. Valid values are [person, application]
            body:
              application/vnd.com.covisint.error.v1+json:
                schema: errorResponseSchema
    delete:
        description: Delete an existing orchestration configuration.  Throws an error if {configId} does not already exist. [Flow-name:orchestrationConfig-delete-orchestrationConfig][Since:1.0][visibility:public]
        headers:
        is: [secured]
        responses:
          204:
            description: Successfully deleted the orchestration configuration.
          400:
              description: |
                  There was a problem with the client's request.
                  ___
                  Substatus codes and error messages are mentioned below:
                  + framework:request
                  + framework:request:io
                  + framework:request:io:read - Invalid input. There was an error while parsing.
                  + framework:request:io:read:parsing
                  + framework:request:io:write
                  + framework:request:header:missing - Missing request header: {headerName}
                  + framework:request:param:missing - Missing request parameter.
                  + framework:request:data:missing - The following information was missing from the resource: {resourceFieldName(s)}
                  + framework:request:invalid:header:value - Invalid x-requester header value. Valid values are [person, application]
              body:
               application/vnd.com.covisint.error.v1+json:
                schema: errorResponseSchema
          404:
              description: |
                  The requested stream was not found.
              body:
               application/vnd.com.covisint.error.v1+json:
                schema: errorResponseSchema
          500:
              description: |
                  There was an unhandled server-side error.
              body:
               application/vnd.com.covisint.error.v1+json:
                schema: errorResponseSchema
    /tasks/activate:
          post:
               description: Activates the configuration for orchestration.[Flow-name:orchestrationConfig-activate-orchestrationConfig][Since:1.0][visibility:public]
               headers:
               is: [secured]
               responses:
                  204:
                    description: Orchestration sucessfully activated.
                  400:
                    description: |
                      There was a problem with the client's request
                       ___
                        Substatus codes and error messages are mentioned below:
                      + framework:request:io:read - There was an error while reading the request body.
                      + framework:request:io:read:parsing - Invalid input.  There was a error while parsing the request body.
                      + framework:request:header:missing - Missing request header: {headerName}
                      + framework:request:data:missing - The following information was missing from the resource: {resourceFieldName(s)}
                      + framework:request:invalid:header:value - Invalid x-requester header value. Valid values are [person, application]
                    body:
                      application/vnd.com.covisint.error.v1+json:
                        schema: errorResponseSchema
                  500:
                    description: |
                        An unhandled server-side error occurred.
                    body:
                      application/vnd.com.covisint.error.v1+json:
                        schema: errorResponseSchema
    /tasks/deactivate:
          post:
            description: Deactivates the orchestraion.[Flow-name:orchestrationConfig-deactivate-orchestrationConfig][Since:1.0][visibility:public]
            headers:
            is: [secured]
            responses:
              204:
               description: Orchestration sucessfully deactivated.
              400:
                  description: |
                    There was a problem with the client's request.
                     ___
                      Substatus codes and error messages are mentioned below:
                    + framework:request:io:read - There was an error while reading the request body.
                    + framework:request:io:read:parsing - Invalid input.  There was a error while parsing the request body.
                    + framework:request:header:missing - Missing request header: {headerName}
                    + framework:request:data:missing - The following information was missing from the resource: {resourceFieldName(s)}
                    + framework:request:invalid:header:value - Invalid x-requester header value. Valid values are [person, application]
                  body:
                    application/vnd.com.covisint.error.v1+json:
                      schema: errorResponseSchema
              500:
                description: |
                    An unhandled server-side error occurred.
                body:
                  application/vnd.com.covisint.error.v1+json:
                    schema: errorResponseSchema
    /tasks/{taskId}:
          uriParameters:
            taskId:
              description: The Id of the task.
              type: string
              required: true
          delete:
            description: Delete task from the orchestraion-config.[Flow-name:orchestrationConfig-deleteTask-orchestrationConfig][Since:1.0][visibility:public]
            headers:
            is: [secured]
            responses:
              204:
               description: Orchestration task sucessfully deleted.
              400:
                  description: |
                    There was a problem with the client's request.
                     ___
                      Substatus codes and error messages are mentioned below:
                    + framework:request:io:read - There was an error while reading the request body.
                    + framework:request:io:read:parsing - Invalid input.  There was a error while parsing the request body.
                    + framework:request:header:missing - Missing request header: {headerName}
                    + framework:request:data:missing - The following information was missing from the resource: {resourceFieldName(s)}
                    + framework:request:invalid:header:value - Invalid x-requester header value. Valid values are [person, application]
                  body:
                    application/vnd.com.covisint.error.v1+json:
                      schema: errorResponseSchema
              500:
                description: |
                    An unhandled server-side error occurred.
                body:
                  application/vnd.com.covisint.error.v1+json:
                    schema: errorResponseSchema
    /tags/{tag}:
          is: [secured]
          uriParameters:
            tag:
              description: The tag value.
              type: string
              required: true
          put:
            description: Tags the specified orchestraion-config.[Flow-name:orchestrationConfig-addTag-orchestrationConfig][Since:1.0][visibility:public]
            is: [putResponse]
            responses:
              204:
               description: The tag was successfully added.
              400:
                  description: |
                    There was a problem with the client's request.
                     ___
                      Substatus codes and error messages are mentioned below:
                    + framework:request:io:read - There was an error while reading the request body.
                    + framework:request:io:read:parsing - Invalid input.  There was a error while parsing the request body.
                    + framework:request:header:missing - Missing request header: {headerName}
                    + framework:request:data:missing - The following information was missing from the resource: {resourceFieldName(s)}
                    + framework:request:invalid:header:value - Invalid x-requester header value. Valid values are [person, application]
                  body:
                    application/vnd.com.covisint.error.v1+json:
                      schema: errorResponseSchema
              500:
                description: |
                    An unhandled server-side error occurred.
                body:
                  application/vnd.com.covisint.error.v1+json:
                    schema: errorResponseSchema
          delete:
            description: Removes a tag from orchestraion-config.[Flow-name:orchestrationConfig-deleteTag-orchestrationConfig][Since:1.0][visibility:public]
            is: [deleteResponse]
            responses:
              204:
               description: The tag was successfully removed.
              400:
                  description: |
                    There was a problem with the client's request.
                     ___
                      Substatus codes and error messages are mentioned below:
                    + framework:request:io:read - There was an error while reading the request body.
                    + framework:request:io:read:parsing - Invalid input.  There was a error while parsing the request body.
                    + framework:request:header:missing - Missing request header: {headerName}
                    + framework:request:data:missing - The following information was missing from the resource: {resourceFieldName(s)}
                    + framework:request:invalid:header:value - Invalid x-requester header value. Valid values are [person, application]
                  body:
                    application/vnd.com.covisint.error.v1+json:
                      schema: errorResponseSchema
              500:
                description: |
                    An unhandled server-side error occurred.
                body:
                  application/vnd.com.covisint.error.v1+json:
                    schema: errorResponseSchema
  /count:
   description: Endpoint to return the count of orchestration config  that match the given query criteria.[Since:1.0]
   get:
    is: [taggable,getSearchResponse,secured]
    description: Retrieve count of orchestration configs based on the specified query parameters.[Flow-name:orchestrationConfig-count-orchestrationConfig][Since:1.0][visibility:public]
    headers:
      Accept:
        description: Media type.
        example: text/plain
        type: string
        required: true
    queryParameters:
      orchestrationType:
        description: Retrieve configuration with the specified  Type .
        type: string
        required: false
      id:
        description: Retrieve configuration with the specified  config id. 
        type: string
        required: false
      active:
        description: Retrieve configuration with the specified  config id. 
        type: string
        required: false
    responses:
      200:
        description: The number of matching orchestration configurations were returned.
        body:
          plan/text:
      400:
          description: |
           There was a problem with the client's request.
            ___
           Substatus codes and error messages are mentioned below:
           + framework:request
           + framework:request:header:missing - Missing request header: {headerName}
           + framework:request:data:missing - The following information was missing from the resource: {resourceFieldName(s)}
           + framework:request:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application]
          body:
            application/vnd.com.covisint.error.v1+json:
              schema: errorResponseSchema