Jump to

• Request
• Response

Close the upload sources by given ID

patch

/cmc-upload-source-preferences-services/service/uploadsources/{uploadSourceCode}/close

This endpoint is used to close the upload sources identified by given ID.

Request

Supported Media Types

• application/json
• application/xml

Path Parameters

• uploadSourceCode: string
  Key of the uploadsources maintenance

Header Parameters

• sourceCode: string
  Source from which request is initiated

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

Successful operation.

Body ()

Root Schema : CmcTmUploadSourceServiceResponseDtoWrapper

Type: object

Show Source

• data(optional): object CmcTmUploadSourceServiceDto
• messages(optional): object ResponseDto

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

Nested Schema : CmcTmUploadSourceServiceDto

Type: object

Match All

Show Source

• allOf GenericDto
• object CmcTmUploadSourceServiceDto-allOf[1]

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/GenericDto"
        },
        {
            "type":"object",
            "properties":{
                "sourceCode":{
                    "type":"string",
                    "minLength":0,
                    "maxLength":15,
                    "pattern":"^[A-Z0-9*_]*$"
                },
                "sourceDesc":{
                    "type":"string",
                    "minLength":0,
                    "maxLength":105
                },
                "baseDataFromFc":{
                    "type":"string",
                    "minLength":0,
                    "maxLength":1,
                    "pattern":"^(?:Y|N)$"
                },
                "sysAuthReq":{
                    "type":"string",
                    "minLength":0,
                    "maxLength":1,
                    "pattern":"^(?:Y|N)$"
                }
            },
            "required":[
                "sourceCode"
            ]
        }
    ]
}

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 : CmcTmUploadSourceServiceDto-allOf[1]

Type: object

Show Source

• baseDataFromFc(optional): string
  Minimum Length: 0

  Maximum Length: 1

  Pattern: ^(?:Y|N)$
• sourceCode: string
  Minimum Length: 0

  Maximum Length: 15

  Pattern: ^[A-Z0-9*_]*$
• sourceDesc(optional): string
  Minimum Length: 0

  Maximum Length: 105
• sysAuthReq(optional): string
  Minimum Length: 0

  Maximum Length: 1

  Pattern: ^(?:Y|N)$

{
    "type":"object",
    "properties":{
        "sourceCode":{
            "type":"string",
            "minLength":0,
            "maxLength":15,
            "pattern":"^[A-Z0-9*_]*$"
        },
        "sourceDesc":{
            "type":"string",
            "minLength":0,
            "maxLength":105
        },
        "baseDataFromFc":{
            "type":"string",
            "minLength":0,
            "maxLength":1,
            "pattern":"^(?:Y|N)$"
        },
        "sysAuthReq":{
            "type":"string",
            "minLength":0,
            "maxLength":1,
            "pattern":"^(?:Y|N)$"
        }
    },
    "required":[
        "sourceCode"
    ]
}

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.

500 Response

Internal error

Back to Top