Jump to

• Request
• Response

Get all valid upload source preferences

get

/service/uploadsourcepreferences

This endpoint is used to Get all valid upload source preferences maintanence records.

Request

Supported Media Types

• application/json
• application/xml

Query Parameters

• authStatus: string
• includecloseandunauth: boolean
  includecloseandunauth need to be set to fetch summary record, defult value is false
• limit: integer
  limit is maximum no of records to be fetched
• moduleCode: string
• offset: integer
  offset is starting no of records to be fetched
• recordStatus: string
• sourceCode: string

Back to Top

Response

Supported Media Types

• application/json
• application/xml

201 Response

Returns message of success or failure

Headers

• Location: string

Body ()

Root Schema : CmcTmUploadSourcePrefServiceCollection

Type: object

Collection of uploadsourcepref.

Show Source

• data: array data
• paging: object PagingDto

{
    "description":"Collection of uploadsourcepref.",
    "type":"object",
    "properties":{
        "data":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/CmcTmUploadSourcePrefServiceDto"
            }
        },
        "paging":{
            "$ref":"#/definitions/PagingDto"
        }
    }
}

Nested Schema : data

Type: array

Show Source

• Array of: object CmcTmUploadSourcePrefServiceDto

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

Nested Schema : PagingDto

Type: object

Show Source

• totalResults: integer

{
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer"
        }
    }
}

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 : 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: string
  Minimum Length: 0

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

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

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

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

  Maximum Length: 1
• onError(required): string
  Minimum Length: 0

  Maximum Length: 1

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

  Maximum Length: 1

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

  Maximum Length: 1

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

  Maximum Length: 1

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

  Maximum Length: 1
• purgeDays: number
  Minimum Length: 0

  Maximum Length: 4
• reverseAllowed: string
  Minimum Length: 0

  Maximum Length: 1
• sourceCode(required): string
  Minimum Length: 0

  Maximum Length: 15
• uploadedStatus(required): 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"
    ]
}

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