Jump to

• Request
• Response

Adds a new upload source preferences

post

/cmc-upload-source-preferences-services/service/uploadsourcepreferences

This endpoint is used to create the upload source preferences.

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 uploadsourcepreferences

Root Schema : CmcTmUploadSourcePrefServiceDto

Type: object

Match All

Show Source

• allOf GenericDto
• object CmcTmUploadSourcePrefServiceDto-allOf[1]

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/GenericDto"
        },
        {
            "type":"object",
            "properties":{
                "sourceCode":{
                    "type":"string",
                    "minLength":0,
                    "maxLength":15
                },
                "uploadedStatus":{
                    "type":"string",
                    "minLength":0,
                    "maxLength":1,
                    "pattern":"^(?:H|U|A)$"
                },
                "onError":{
                    "type":"string",
                    "minLength":0,
                    "maxLength":1,
                    "pattern":"^(E)$"
                },
                "onOverride":{
                    "type":"string",
                    "minLength":0,
                    "maxLength":1,
                    "pattern":"^(?:E|I|O)$"
                },
                "proceedWithEod":{
                    "type":"string",
                    "minLength":0,
                    "maxLength":1
                },
                "deleteAllowed":{
                    "type":"string",
                    "minLength":0,
                    "maxLength":1
                },
                "reverseAllowed":{
                    "type":"string",
                    "minLength":0,
                    "maxLength":1
                },
                "amendAllowed":{
                    "type":"string",
                    "minLength":0,
                    "maxLength":1
                },
                "purgeDays":{
                    "type":"number",
                    "minLength":0,
                    "maxLength":4
                },
                "allowDeferredProcessing":{
                    "type":"string",
                    "minLength":0,
                    "maxLength":1
                },
                "allowEodWithDeferred":{
                    "type":"string",
                    "minLength":0,
                    "maxLength":1
                },
                "allowDelete":{
                    "type":"string",
                    "minLength":0,
                    "maxLength":1
                },
                "onQueueException":{
                    "type":"string",
                    "minLength":0,
                    "maxLength":1,
                    "pattern":"^(?:E|I)$"
                },
                "onRepairableException":{
                    "type":"string",
                    "minLength":0,
                    "maxLength":1,
                    "pattern":"^(?:E|I)$"
                }
            },
            "required":[
                "sourceCode",
                "uploadedStatus",
                "onError",
                "onOverride"
            ]
        }
    ]
}

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

Type: object

Show Source

• allowDeferredProcessing(optional): string
  Minimum Length: 0

  Maximum Length: 1
• allowDelete(optional): string
  Minimum Length: 0

  Maximum Length: 1
• allowEodWithDeferred(optional): string
  Minimum Length: 0

  Maximum Length: 1
• amendAllowed(optional): string
  Minimum Length: 0

  Maximum Length: 1
• deleteAllowed(optional): string
  Minimum Length: 0

  Maximum Length: 1
• onError: string
  Minimum Length: 0

  Maximum Length: 1

  Pattern: ^(E)$
• onOverride: string
  Minimum Length: 0

  Maximum Length: 1

  Pattern: ^(?:E|I|O)$
• onQueueException(optional): string
  Minimum Length: 0

  Maximum Length: 1

  Pattern: ^(?:E|I)$
• onRepairableException(optional): string
  Minimum Length: 0

  Maximum Length: 1

  Pattern: ^(?:E|I)$
• proceedWithEod(optional): string
  Minimum Length: 0

  Maximum Length: 1
• purgeDays(optional): number
  Minimum Length: 0

  Maximum Length: 4
• reverseAllowed(optional): string
  Minimum Length: 0

  Maximum Length: 1
• sourceCode: string
  Minimum Length: 0

  Maximum Length: 15
• uploadedStatus: string
  Minimum Length: 0

  Maximum Length: 1

  Pattern: ^(?:H|U|A)$

{
    "type":"object",
    "properties":{
        "sourceCode":{
            "type":"string",
            "minLength":0,
            "maxLength":15
        },
        "uploadedStatus":{
            "type":"string",
            "minLength":0,
            "maxLength":1,
            "pattern":"^(?:H|U|A)$"
        },
        "onError":{
            "type":"string",
            "minLength":0,
            "maxLength":1,
            "pattern":"^(E)$"
        },
        "onOverride":{
            "type":"string",
            "minLength":0,
            "maxLength":1,
            "pattern":"^(?:E|I|O)$"
        },
        "proceedWithEod":{
            "type":"string",
            "minLength":0,
            "maxLength":1
        },
        "deleteAllowed":{
            "type":"string",
            "minLength":0,
            "maxLength":1
        },
        "reverseAllowed":{
            "type":"string",
            "minLength":0,
            "maxLength":1
        },
        "amendAllowed":{
            "type":"string",
            "minLength":0,
            "maxLength":1
        },
        "purgeDays":{
            "type":"number",
            "minLength":0,
            "maxLength":4
        },
        "allowDeferredProcessing":{
            "type":"string",
            "minLength":0,
            "maxLength":1
        },
        "allowEodWithDeferred":{
            "type":"string",
            "minLength":0,
            "maxLength":1
        },
        "allowDelete":{
            "type":"string",
            "minLength":0,
            "maxLength":1
        },
        "onQueueException":{
            "type":"string",
            "minLength":0,
            "maxLength":1,
            "pattern":"^(?:E|I)$"
        },
        "onRepairableException":{
            "type":"string",
            "minLength":0,
            "maxLength":1,
            "pattern":"^(?:E|I)$"
        }
    },
    "required":[
        "sourceCode",
        "uploadedStatus",
        "onError",
        "onOverride"
    ]
}

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 uploadsourcepreferences

Body ()

Root Schema : CmcTmUploadSourcePrefServiceResponseDtoWrapper

Type: object

Show Source

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

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

Nested Schema : CmcTmUploadSourcePrefServiceDto

Type: object

Match All

Show Source

• allOf GenericDto
• object CmcTmUploadSourcePrefServiceDto-allOf[1]

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/GenericDto"
        },
        {
            "type":"object",
            "properties":{
                "sourceCode":{
                    "type":"string",
                    "minLength":0,
                    "maxLength":15
                },
                "uploadedStatus":{
                    "type":"string",
                    "minLength":0,
                    "maxLength":1,
                    "pattern":"^(?:H|U|A)$"
                },
                "onError":{
                    "type":"string",
                    "minLength":0,
                    "maxLength":1,
                    "pattern":"^(E)$"
                },
                "onOverride":{
                    "type":"string",
                    "minLength":0,
                    "maxLength":1,
                    "pattern":"^(?:E|I|O)$"
                },
                "proceedWithEod":{
                    "type":"string",
                    "minLength":0,
                    "maxLength":1
                },
                "deleteAllowed":{
                    "type":"string",
                    "minLength":0,
                    "maxLength":1
                },
                "reverseAllowed":{
                    "type":"string",
                    "minLength":0,
                    "maxLength":1
                },
                "amendAllowed":{
                    "type":"string",
                    "minLength":0,
                    "maxLength":1
                },
                "purgeDays":{
                    "type":"number",
                    "minLength":0,
                    "maxLength":4
                },
                "allowDeferredProcessing":{
                    "type":"string",
                    "minLength":0,
                    "maxLength":1
                },
                "allowEodWithDeferred":{
                    "type":"string",
                    "minLength":0,
                    "maxLength":1
                },
                "allowDelete":{
                    "type":"string",
                    "minLength":0,
                    "maxLength":1
                },
                "onQueueException":{
                    "type":"string",
                    "minLength":0,
                    "maxLength":1,
                    "pattern":"^(?:E|I)$"
                },
                "onRepairableException":{
                    "type":"string",
                    "minLength":0,
                    "maxLength":1,
                    "pattern":"^(?:E|I)$"
                }
            },
            "required":[
                "sourceCode",
                "uploadedStatus",
                "onError",
                "onOverride"
            ]
        }
    ]
}

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

Type: object

Show Source

• allowDeferredProcessing(optional): string
  Minimum Length: 0

  Maximum Length: 1
• allowDelete(optional): string
  Minimum Length: 0

  Maximum Length: 1
• allowEodWithDeferred(optional): string
  Minimum Length: 0

  Maximum Length: 1
• amendAllowed(optional): string
  Minimum Length: 0

  Maximum Length: 1
• deleteAllowed(optional): string
  Minimum Length: 0

  Maximum Length: 1
• onError: string
  Minimum Length: 0

  Maximum Length: 1

  Pattern: ^(E)$
• onOverride: string
  Minimum Length: 0

  Maximum Length: 1

  Pattern: ^(?:E|I|O)$
• onQueueException(optional): string
  Minimum Length: 0

  Maximum Length: 1

  Pattern: ^(?:E|I)$
• onRepairableException(optional): string
  Minimum Length: 0

  Maximum Length: 1

  Pattern: ^(?:E|I)$
• proceedWithEod(optional): string
  Minimum Length: 0

  Maximum Length: 1
• purgeDays(optional): number
  Minimum Length: 0

  Maximum Length: 4
• reverseAllowed(optional): string
  Minimum Length: 0

  Maximum Length: 1
• sourceCode: string
  Minimum Length: 0

  Maximum Length: 15
• uploadedStatus: string
  Minimum Length: 0

  Maximum Length: 1

  Pattern: ^(?:H|U|A)$

{
    "type":"object",
    "properties":{
        "sourceCode":{
            "type":"string",
            "minLength":0,
            "maxLength":15
        },
        "uploadedStatus":{
            "type":"string",
            "minLength":0,
            "maxLength":1,
            "pattern":"^(?:H|U|A)$"
        },
        "onError":{
            "type":"string",
            "minLength":0,
            "maxLength":1,
            "pattern":"^(E)$"
        },
        "onOverride":{
            "type":"string",
            "minLength":0,
            "maxLength":1,
            "pattern":"^(?:E|I|O)$"
        },
        "proceedWithEod":{
            "type":"string",
            "minLength":0,
            "maxLength":1
        },
        "deleteAllowed":{
            "type":"string",
            "minLength":0,
            "maxLength":1
        },
        "reverseAllowed":{
            "type":"string",
            "minLength":0,
            "maxLength":1
        },
        "amendAllowed":{
            "type":"string",
            "minLength":0,
            "maxLength":1
        },
        "purgeDays":{
            "type":"number",
            "minLength":0,
            "maxLength":4
        },
        "allowDeferredProcessing":{
            "type":"string",
            "minLength":0,
            "maxLength":1
        },
        "allowEodWithDeferred":{
            "type":"string",
            "minLength":0,
            "maxLength":1
        },
        "allowDelete":{
            "type":"string",
            "minLength":0,
            "maxLength":1
        },
        "onQueueException":{
            "type":"string",
            "minLength":0,
            "maxLength":1,
            "pattern":"^(?:E|I)$"
        },
        "onRepairableException":{
            "type":"string",
            "minLength":0,
            "maxLength":1,
            "pattern":"^(?:E|I)$"
        }
    },
    "required":[
        "sourceCode",
        "uploadedStatus",
        "onError",
        "onOverride"
    ]
}

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