Previous Next JavaScript must be enabled to correctly display this content

## Adds a new ECA system

post

/service/ecasystems

This endpoint is used to add the new eca system.

### Request

Supported Media Types

- application/json
- application/xml

Header Parameters

- sourceCode: string
  Source from which request is initiated

Body ()
Request Body that contains data required for creating a new eca systems
Root Schema : ECASystemServiceDTO
Type: `object`
Match All
Show Source

- allOf GenericDto
- object ECASystemServiceDTO-allOf[1]

    {
        "type":"object",
        "allOf":[
            {
                "$ref":"#/definitions/GenericDto"
            },
            {
                "type":"object",
                "properties":{
                    "ecaSystem":{
                        "type":"string",
                        "description":"Name of the ECA system",
                        "minLength":1,
                        "maxLength":15,
                        "pattern":"[a-zA-Z0-9\\s]+"
                    },
                    "ecaSystemDescription":{
                        "type":"string",
                        "description":"Description for ECA system",
                        "minLength":0,
                        "maxLength":105
                    }
                },
                "required":[
                    "ecaSystem"
                ]
            }
        ]
    }

Nested Schema : GenericDto
Match All
Show Source

- object GenericDto-allOf[0]
  Discriminator: `resource_type`

    {
        "allOf":[
            {
                "type":"object",
                "discriminator":"resource_type"
            }
        ]
    }

Nested Schema : GenericDto-allOf[0]
Type: `object`
Discriminator: `resource_type`
Nested Schema : ECASystemServiceDTO-allOf[1]
Type: `object`
Show Source

- ecaSystem: string
  Minimum Length: `1`
  Maximum Length: `15`
  Pattern: `[a-zA-Z0-9\s]+`
  Name of the ECA system
- ecaSystemDescription(optional): string
  Minimum Length: `0`
  Maximum Length: `105`
  Description for ECA system

    {
        "type":"object",
        "properties":{
            "ecaSystem":{
                "type":"string",
                "description":"Name of the ECA system",
                "minLength":1,
                "maxLength":15,
                "pattern":"[a-zA-Z0-9\\s]+"
            },
            "ecaSystemDescription":{
                "type":"string",
                "description":"Description for ECA system",
                "minLength":0,
                "maxLength":105
            }
        },
        "required":[
            "ecaSystem"
        ]
    }

Back to Top

### Response

Supported Media Types

- application/json
- application/xml

#### 201 Response

Returns message of success or failure
Headers

- Location: string
  URL of newly created ecasystems

Body ()
Root Schema : ECASystemServiceResponseDtoWrapper
Type: `object`
Show Source

- data(optional): object ECASystemServiceDTO
- messages(optional): object ResponseDto

    {
        "type":"object",
        "properties":{
            "messages":{
                "$ref":"#/definitions/ResponseDto"
            },
            "data":{
                "$ref":"#/definitions/ECASystemServiceDTO"
            }
        }
    }

Nested Schema : ECASystemServiceDTO
Type: `object`
Match All
Show Source

- allOf GenericDto
- object ECASystemServiceDTO-allOf[1]

    {
        "type":"object",
        "allOf":[
            {
                "$ref":"#/definitions/GenericDto"
            },
            {
                "type":"object",
                "properties":{
                    "ecaSystem":{
                        "type":"string",
                        "description":"Name of the ECA system",
                        "minLength":1,
                        "maxLength":15,
                        "pattern":"[a-zA-Z0-9\\s]+"
                    },
                    "ecaSystemDescription":{
                        "type":"string",
                        "description":"Description for ECA system",
                        "minLength":0,
                        "maxLength":105
                    }
                },
                "required":[
                    "ecaSystem"
                ]
            }
        ]
    }

Nested Schema : ResponseDto
Type: `object`
Show Source

- codes(optional): array codes
- id(optional): string
- requestId(optional): string
- status(optional): string

    {
        "type":"object",
        "properties":{
            "id":{
                "type":"string"
            },
            "status":{
                "type":"string"
            },
            "codes":{
                "type":"array",
                "items":{
                    "$ref":"#/definitions/ResponseCode"
                }
            },
            "requestId":{
                "type":"string"
            }
        }
    }

Nested Schema : GenericDto
Match All
Show Source

- object GenericDto-allOf[0]
  Discriminator: `resource_type`

    {
        "allOf":[
            {
                "type":"object",
                "discriminator":"resource_type"
            }
        ]
    }

Nested Schema : GenericDto-allOf[0]
Type: `object`
Discriminator: `resource_type`
Nested Schema : ECASystemServiceDTO-allOf[1]
Type: `object`
Show Source

- ecaSystem: string
  Minimum Length: `1`
  Maximum Length: `15`
  Pattern: `[a-zA-Z0-9\s]+`
  Name of the ECA system
- ecaSystemDescription(optional): string
  Minimum Length: `0`
  Maximum Length: `105`
  Description for ECA system

    {
        "type":"object",
        "properties":{
            "ecaSystem":{
                "type":"string",
                "description":"Name of the ECA system",
                "minLength":1,
                "maxLength":15,
                "pattern":"[a-zA-Z0-9\\s]+"
            },
            "ecaSystemDescription":{
                "type":"string",
                "description":"Description for ECA system",
                "minLength":0,
                "maxLength":105
            }
        },
        "required":[
            "ecaSystem"
        ]
    }

Nested Schema : codes
Type: `array`
Show Source

- Array of: object ResponseCode

    {
        "type":"array",
        "items":{
            "$ref":"#/definitions/ResponseCode"
        }
    }

Nested Schema : ResponseCode
Type: `object`
Show Source

- arg(optional): string
- args(optional): array args
- Code(optional): string
- Desc(optional): string
- Language(optional): string
- Type(optional): string

    {
        "type":"object",
        "properties":{
            "Code":{
                "type":"string"
            },
            "Desc":{
                "type":"string"
            },
            "Type":{
                "type":"string"
            },
            "Language":{
                "type":"string"
            },
            "args":{
                "type":"array",
                "items":{
                    "type":"object"
                }
            },
            "arg":{
                "type":"string"
            }
        }
    }

Nested Schema : args
Type: `array`
Show Source

- Array of: object items

    {
        "type":"array",
        "items":{
            "type":"object"
        }
    }

Nested Schema : items
Type: `object`

#### 400 Response

Malformed syntax.

#### 401 Response

Request does not have sufficient credentials.

#### 403 Response

Request is not authorized.

#### 405 Response

Invalid input

#### 500 Response

Internal error
Back to Top