Jump to

• Request
• Response

Ingest file(s) into the system

put

/s1-intake-svc/rest/v1.0/inbox/upload

Oracle Safety One Intake REST API enables you to ingest documents automatically from third-party systems and applications. You can set various parameters in the call that specify how the documents are handled.

Request

Query Parameters

• multicase(required): integer(int32)
  For multiple documents where each one is intended to represent a separate potential case, set this to 1. Else, set it to 0 or undefined.
• primarydocname(required): string
  For multiple documents intended for a single potential case, provide the primary (main) AE document name in this parameter. This parameter is used for OCR extraction or AI Prediction on the document without manual intervention.
• siteabbr(required): string
  Provide the originating site (region) of the document that is to be associated with the intake record or case. The site must be available in Argus Safety > Argus Console > Code Lists > Flexible Data Re-categorization > Flexible Re-categorization > SITE_ABRV.
• sourcename(required): string
  Provide the source name of your API endpoint as configured in Argus Safety > Argus Console > Code Lists > Flexible Data Re-categorization > Flexible Re-categorization > INTAKE_SOURCE.
• triagerequired(required): integer(int32)
  For documents that require manual validation, set to 1.

Supported Media Types

• multipart/form-data

Request Body - multipart/form-data ()

Root Schema : schema

Type: object

Show Source

• bodyParts: array bodyParts
• contentDisposition: object ContentDisposition
• entity: object entity
• headers: object headers
  Additional Properties Allowed: additionalProperties
• mediaType: object MediaType
• messageBodyWorkers: object MessageBodyWorkers
• parameterizedHeaders: object parameterizedHeaders
  Additional Properties Allowed: additionalProperties
• parent: object schema
• providers: object Providers

{
    "type":"object",
    "properties":{
        "contentDisposition":{
            "$ref":"#/components/schemas/ContentDisposition"
        },
        "entity":{
            "type":"object"
        },
        "headers":{
            "type":"object",
            "properties":{
                "empty":{
                    "type":"boolean"
                }
            },
            "additionalProperties":{
                "type":"array",
                "items":{
                    "type":"string"
                }
            }
        },
        "mediaType":{
            "$ref":"#/components/schemas/MediaType"
        },
        "messageBodyWorkers":{
            "$ref":"#/components/schemas/MessageBodyWorkers"
        },
        "parent":{
            "$ref":"#/components/schemas/MultiPart"
        },
        "providers":{
            "$ref":"#/components/schemas/Providers"
        },
        "bodyParts":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/BodyPart"
            }
        },
        "parameterizedHeaders":{
            "type":"object",
            "properties":{
                "empty":{
                    "type":"boolean"
                }
            },
            "additionalProperties":{
                "type":"array",
                "items":{
                    "$ref":"#/components/schemas/ParameterizedHeader"
                }
            }
        }
    }
}

Nested Schema : bodyParts

Type: array

Show Source

• Array of: object BodyPart

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

Nested Schema : ContentDisposition

Type: object

Show Source

• creationDate: string (date-time)
• fileName: string
• modificationDate: string (date-time)
• parameters: object parameters
  Additional Properties Allowed: additionalProperties
• readDate: string (date-time)
• size: integer (int64)
• type: string

{
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "parameters":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        },
        "fileName":{
            "type":"string"
        },
        "creationDate":{
            "type":"string",
            "format":"date-time"
        },
        "modificationDate":{
            "type":"string",
            "format":"date-time"
        },
        "readDate":{
            "type":"string",
            "format":"date-time"
        },
        "size":{
            "type":"integer",
            "format":"int64"
        }
    }
}

Nested Schema : entity

Type: object

Nested Schema : headers

Type: object

Additional Properties Allowed

Show Source

• array additionalProperties

{
    "type":"object",
    "properties":{
        "empty":{
            "type":"boolean"
        }
    },
    "additionalProperties":{
        "type":"array",
        "items":{
            "type":"string"
        }
    }
}

Show Source

• empty: boolean

{
    "type":"object",
    "properties":{
        "empty":{
            "type":"boolean"
        }
    },
    "additionalProperties":{
        "type":"array",
        "items":{
            "type":"string"
        }
    }
}

Nested Schema : MediaType

Type: object

Show Source

• parameters: object parameters
  Additional Properties Allowed: additionalProperties
• subtype: string
• type: string
• wildcardSubtype: boolean
• wildcardType: boolean

{
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "subtype":{
            "type":"string"
        },
        "parameters":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        },
        "wildcardType":{
            "type":"boolean"
        },
        "wildcardSubtype":{
            "type":"boolean"
        }
    }
}

Nested Schema : MessageBodyWorkers

Type: object

Nested Schema : parameterizedHeaders

Type: object

Additional Properties Allowed

Show Source

• array additionalProperties

{
    "type":"object",
    "properties":{
        "empty":{
            "type":"boolean"
        }
    },
    "additionalProperties":{
        "type":"array",
        "items":{
            "$ref":"#/components/schemas/ParameterizedHeader"
        }
    }
}

Show Source

• empty: boolean

{
    "type":"object",
    "properties":{
        "empty":{
            "type":"boolean"
        }
    },
    "additionalProperties":{
        "type":"array",
        "items":{
            "$ref":"#/components/schemas/ParameterizedHeader"
        }
    }
}

Nested Schema : Providers

Type: object

Nested Schema : BodyPart

Type: object

Show Source

• contentDisposition: object ContentDisposition
• entity: object entity
• headers: object headers
  Additional Properties Allowed: additionalProperties
• mediaType: object MediaType
• messageBodyWorkers: object MessageBodyWorkers
• parameterizedHeaders: object parameterizedHeaders
  Additional Properties Allowed: additionalProperties
• parent: object schema
• providers: object Providers

{
    "type":"object",
    "properties":{
        "contentDisposition":{
            "$ref":"#/components/schemas/ContentDisposition"
        },
        "entity":{
            "type":"object"
        },
        "headers":{
            "type":"object",
            "properties":{
                "empty":{
                    "type":"boolean"
                }
            },
            "additionalProperties":{
                "type":"array",
                "items":{
                    "type":"string"
                }
            }
        },
        "mediaType":{
            "$ref":"#/components/schemas/MediaType"
        },
        "messageBodyWorkers":{
            "$ref":"#/components/schemas/MessageBodyWorkers"
        },
        "parent":{
            "$ref":"#/components/schemas/MultiPart"
        },
        "providers":{
            "$ref":"#/components/schemas/Providers"
        },
        "parameterizedHeaders":{
            "type":"object",
            "properties":{
                "empty":{
                    "type":"boolean"
                }
            },
            "additionalProperties":{
                "type":"array",
                "items":{
                    "$ref":"#/components/schemas/ParameterizedHeader"
                }
            }
        }
    }
}

Nested Schema : entity

Type: object

Nested Schema : headers

Type: object

Additional Properties Allowed

Show Source

• array additionalProperties

{
    "type":"object",
    "properties":{
        "empty":{
            "type":"boolean"
        }
    },
    "additionalProperties":{
        "type":"array",
        "items":{
            "type":"string"
        }
    }
}

Show Source

• empty: boolean

{
    "type":"object",
    "properties":{
        "empty":{
            "type":"boolean"
        }
    },
    "additionalProperties":{
        "type":"array",
        "items":{
            "type":"string"
        }
    }
}

Nested Schema : parameterizedHeaders

Type: object

Additional Properties Allowed

Show Source

• array additionalProperties

{
    "type":"object",
    "properties":{
        "empty":{
            "type":"boolean"
        }
    },
    "additionalProperties":{
        "type":"array",
        "items":{
            "$ref":"#/components/schemas/ParameterizedHeader"
        }
    }
}

Show Source

• empty: boolean

{
    "type":"object",
    "properties":{
        "empty":{
            "type":"boolean"
        }
    },
    "additionalProperties":{
        "type":"array",
        "items":{
            "$ref":"#/components/schemas/ParameterizedHeader"
        }
    }
}

Nested Schema : additionalProperties

Type: array

Show Source

• Array of: string

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

Nested Schema : additionalProperties

Type: array

Show Source

• Array of: object ParameterizedHeader

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

Nested Schema : ParameterizedHeader

Type: object

Show Source

• parameters: object parameters
  Additional Properties Allowed: additionalProperties
• value: string

{
    "type":"object",
    "properties":{
        "value":{
            "type":"string"
        },
        "parameters":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        }
    }
}

Nested Schema : parameters

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

Nested Schema : parameters

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

Nested Schema : additionalProperties

Type: array

Show Source

• Array of: string

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

Nested Schema : parameters

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

Nested Schema : additionalProperties

Type: array

Show Source

• Array of: object ParameterizedHeader

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

Back to Top

Response

Supported Media Types

• application/json

200 Response

Success

Body ()

Root Schema : IngestionResponse

Type: object

Show Source

• fileName: string
• intakeNum: string

{
    "type":"object",
    "properties":{
        "fileName":{
            "type":"string"
        },
        "intakeNum":{
            "type":"string"
        }
    }
}

400 Response

Bad request

Body ()

Root Schema : ErrorResponseData

Type: object

Response object for error

Show Source

• details: object details
  Error Details
• errorCode: string
  Error Code

  Example: Exception
• errorMessage: string
  Error Message

  Example: Please see the server log for details

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Error Code",
            "example":"Exception"
        },
        "errorMessage":{
            "type":"string",
            "description":"Error Message",
            "example":"Please see the server log for details"
        },
        "details":{
            "type":"object",
            "description":"Error Details"
        }
    },
    "description":"Response object for error"
}

Nested Schema : details

Type: object

Error Details

401 Response

Unauthorized user

404 Response

Not found

Body ()

Root Schema : ErrorResponseData

Type: object

Response object for error

Show Source

• details: object details
  Error Details
• errorCode: string
  Error Code

  Example: Exception
• errorMessage: string
  Error Message

  Example: Please see the server log for details

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Error Code",
            "example":"Exception"
        },
        "errorMessage":{
            "type":"string",
            "description":"Error Message",
            "example":"Please see the server log for details"
        },
        "details":{
            "type":"object",
            "description":"Error Details"
        }
    },
    "description":"Response object for error"
}

Nested Schema : details

Type: object

Error Details

500 Response

Internal Server Error

Body ()

Root Schema : ErrorResponseData

Type: object

Response object for error

Show Source

• details: object details
  Error Details
• errorCode: string
  Error Code

  Example: Exception
• errorMessage: string
  Error Message

  Example: Please see the server log for details

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Error Code",
            "example":"Exception"
        },
        "errorMessage":{
            "type":"string",
            "description":"Error Message",
            "example":"Please see the server log for details"
        },
        "details":{
            "type":"object",
            "description":"Error Details"
        }
    },
    "description":"Response object for error"
}

Nested Schema : details

Type: object

Error Details

Back to Top