Jump to

• Request
• Response

Submit document with default document type variant (Deprecated)

post

/bca/api/documentReceiver/v1/networks/{networkId}/flows/{flowId}/steps/{stepId}

Deprecated. This request is internally redirected to

POST /bca/api/documentReceiver/v1/networks/{networkId}/flows/{flowId}/steps/{stepId}/variants/default

Request

Path Parameters

• flowId(required): string
  The business flow id
• networkId(required): string
  Identifier of the founder's network
• stepId(required): string
  The business flow step id

There's no request body for this operation.

Back to Top

Response

202 Response

Document related to specified document type variant was accepted for processing. The json response is available for CSV documents only.

Body ()

Root Schema : CSV Document Post Response

Type: object

Title: CSV Document Post Response

Additional Properties Allowed

Show Source

• object CSV Record
  Title: CSV Record

  CSV record information identified by record identifier.

{
    "type":"object",
    "title":"CSV Document Post Response",
    "additionalProperties":{
        "$ref":"#/components/schemas/CsvRecord"
    }
}

Nested Schema : CSV Record

Type: object

Title: CSV Record

CSV record information identified by record identifier.

Show Source

• problems: array problems
• status(required): string
  Allowed Values: [ "ACCEPTED", "REJECTED" ]

  Record status (ACCEPTED - record was accepted for processing, REJECTED - record was rejected/excluded from processing). Note that the behavior isn't transactional. If one of the records is REJECTED the ramaining records won't be affected.

{
    "type":"object",
    "title":"CSV Record",
    "description":"CSV record information identified by record identifier.",
    "required":[
        "status"
    ],
    "properties":{
        "status":{
            "type":"string",
            "description":"Record status (ACCEPTED - record was accepted for processing, REJECTED - record was rejected/excluded from processing). Note that the behavior isn't transactional. If one of the records is REJECTED the ramaining records won't be affected.",
            "enum":[
                "ACCEPTED",
                "REJECTED"
            ]
        },
        "problems":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/CsvRecordProblem"
            }
        }
    }
}

Nested Schema : problems

Type: array

Show Source

• Array of: object CSV Record Problem
  Title: CSV Record Problem

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/CsvRecordProblem"
    }
}

Nested Schema : CSV Record Problem

Type: object

Title: CSV Record Problem

Show Source

• description(required): string
  Problem description
• type(required): string
  Allowed Values: [ "PARSING", "VALIDATION" ]

  Problem type (PARSING - problem occured when the CSV document was parsed, VALIDATION - problem occured when the translated JSON document was validated against JSON schema).

{
    "type":"object",
    "title":"CSV Record Problem",
    "required":[
        "type",
        "description"
    ],
    "properties":{
        "type":{
            "type":"string",
            "description":"Problem type (PARSING - problem occured when the CSV document was parsed, VALIDATION - problem occured when the translated JSON document was validated against JSON schema).",
            "enum":[
                "PARSING",
                "VALIDATION"
            ]
        },
        "description":{
            "type":"string",
            "description":"Problem description"
        }
    }
}

400 Response

Input document is invalid. The json response is available for CSV documents only. Also, if the CSV file cannot be reliably split into multiple records during the parsing phase, the error code 400 will be returned with only simple string error description.

Body ()

Root Schema : CSV Document Post Response

Type: object

Title: CSV Document Post Response

Additional Properties Allowed

Show Source

• object CSV Record
  Title: CSV Record

  CSV record information identified by record identifier.

{
    "type":"object",
    "title":"CSV Document Post Response",
    "additionalProperties":{
        "$ref":"#/components/schemas/CsvRecord"
    }
}

Nested Schema : CSV Record

Type: object

Title: CSV Record

CSV record information identified by record identifier.

Show Source

• problems: array problems
• status(required): string
  Allowed Values: [ "ACCEPTED", "REJECTED" ]

  Record status (ACCEPTED - record was accepted for processing, REJECTED - record was rejected/excluded from processing). Note that the behavior isn't transactional. If one of the records is REJECTED the ramaining records won't be affected.

{
    "type":"object",
    "title":"CSV Record",
    "description":"CSV record information identified by record identifier.",
    "required":[
        "status"
    ],
    "properties":{
        "status":{
            "type":"string",
            "description":"Record status (ACCEPTED - record was accepted for processing, REJECTED - record was rejected/excluded from processing). Note that the behavior isn't transactional. If one of the records is REJECTED the ramaining records won't be affected.",
            "enum":[
                "ACCEPTED",
                "REJECTED"
            ]
        },
        "problems":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/CsvRecordProblem"
            }
        }
    }
}

Nested Schema : problems

Type: array

Show Source

• Array of: object CSV Record Problem
  Title: CSV Record Problem

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/CsvRecordProblem"
    }
}

Nested Schema : CSV Record Problem

Type: object

Title: CSV Record Problem

Show Source

• description(required): string
  Problem description
• type(required): string
  Allowed Values: [ "PARSING", "VALIDATION" ]

  Problem type (PARSING - problem occured when the CSV document was parsed, VALIDATION - problem occured when the translated JSON document was validated against JSON schema).

{
    "type":"object",
    "title":"CSV Record Problem",
    "required":[
        "type",
        "description"
    ],
    "properties":{
        "type":{
            "type":"string",
            "description":"Problem type (PARSING - problem occured when the CSV document was parsed, VALIDATION - problem occured when the translated JSON document was validated against JSON schema).",
            "enum":[
                "PARSING",
                "VALIDATION"
            ]
        },
        "description":{
            "type":"string",
            "description":"Problem description"
        }
    }
}

403 Response

User is not authorized to send the document or a virus/malware has been found in the attachments.

404 Response

Business network, flow or step is not available to the current tenant, or the variant with variantId is not available for the document type accepted by this business flow step.

409 Response

Business flow is not active.

413 Response

Submitted request exceeds the maximum allowed size or attachment limits.

415 Response

CSV upload is not supported for this document type variant. Applicable only if Content-Type is text/csv.

Back to Top