Recent Searches

No recent searches

    Popular Articles

      Articles
      View all
        Topics
        View all
          Tickets
          View all
            no results

            Sorry! nothing found for

            Documentation

            Posted 28 days ago by Harrison Gowers

            API documentation for Smartbox.ai Endpoints


            Methods

            [ Jump to Models ]

            Table of Contents


            Up
            post /box-content
            Get content (boxContentPost)

            Consumes

            This API call consumes the following media types via the Content-Typerequest header:
            • application/json

            Request body

            body BoxContentRequest (required)
            Body Parameter —

            Return type

            Example data

            Content-Type: application/json
            {
              "documents" : [ {
                "path" : "path",
                "size" : 0,
                "docId" : "docId",
                "name" : "name"
              }, {
                "path" : "path",
                "size" : 0,
                "docId" : "docId",
                "name" : "name"
              } ],
              "totalDocuments" : 6,
              "apiCallMessage" : "apiCallMessage",
              "apiCallStatus" : "apiCallStatus"
            }

            Produces

            This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Typeresponse header.
            • application/json

            Responses

            200

            Document management response BoxContentResponse


            Up
            get /box-status-by-upload-id
            Query box status by upload ID (boxStatusByUploadIdGet)

            Query parameters

            uploadId (required)
            Query Parameter —

            Return type

            Example data

            Content-Type: application/json
            {
              "boxRedacted" : true,
              "numberOfFilesProcessed" : 6,
              "apiCallMessage" : "apiCallMessage",
              "totalFiles" : 0,
              "apiCallStatus" : "apiCallStatus",
              "extractionInProgress" : true,
              "boxAnalysed" : true
            }

            Produces

            This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Typeresponse header.
            • application/json

            Responses

            200

            File processing status response BoxStatusResponse


            Up
            get /box-status
            Query box status (boxStatusGet)

            Query parameters

            boxId (required)
            Query Parameter —

            Return type

            Example data

            Content-Type: application/json
            {
              "boxRedacted" : true,
              "numberOfFilesProcessed" : 6,
              "apiCallMessage" : "apiCallMessage",
              "totalFiles" : 0,
              "apiCallStatus" : "apiCallStatus",
              "extractionInProgress" : true,
              "boxAnalysed" : true
            }

            Produces

            This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Typeresponse header.
            • application/json

            Responses

            200

            File processing status response BoxStatusResponse


            Up
            get /boxes
            List boxes (boxesGet)

            Query parameters

            pageNumber (required)
            Query Parameter —
            pageRows (required)
            Query Parameter —
            sort (optional)
            Query Parameter —

            Return type

            Example data

            Content-Type: application/json
            {
              "boxList" : [ {
                "visibleToDownload" : true,
                "boxName" : "boxName",
                "sharingAvailability" : true,
                "usersBoxVisible" : [ "usersBoxVisible", "usersBoxVisible" ],
                "visibleAllUsers" : true,
                "boxId" : "boxId",
                "usersAccessDownload" : [ "usersAccessDownload", "usersAccessDownload" ]
              }, {
                "visibleToDownload" : true,
                "boxName" : "boxName",
                "sharingAvailability" : true,
                "usersBoxVisible" : [ "usersBoxVisible", "usersBoxVisible" ],
                "visibleAllUsers" : true,
                "boxId" : "boxId",
                "usersAccessDownload" : [ "usersAccessDownload", "usersAccessDownload" ]
              } ]
            }

            Produces

            This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Typeresponse header.
            • application/json

            Responses

            200

            A list of boxes BoxListResponse


            Up
            post /create-box
            Create box (createBoxPost)

            Consumes

            This API call consumes the following media types via the Content-Typerequest header:
            • application/json

            Request body

            body CreateBoxRequest (required)
            Body Parameter —

            Return type

            Example data

            Content-Type: application/json
            {
              "boxName" : "boxName",
              "message" : "message",
              "boxId" : "boxId",
              "status" : "status"
            }

            Produces

            This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Typeresponse header.
            • application/json

            Responses

            200

            Box creation response CreateBoxResponse


            Up
            post /create-dictionary
            Create Dictionary (createDictionaryPost)

            Consumes

            This API call consumes the following media types via the Content-Typerequest header:
            • application/json

            Request body

            body CreateDictionaryRequest (required)
            Body Parameter —

            Return type

            Example data

            Content-Type: application/json
            {
              "dictionaryId" : "dictionaryId",
              "message" : "message",
              "status" : "status"
            }

            Produces

            This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Typeresponse header.
            • application/json

            Responses

            200

            Dictionary creation response CreateDictionaryResponse


            Up
            post /delete-box
            Delete box (deleteBoxPost)

            Consumes

            This API call consumes the following media types via the Content-Typerequest header:
            • application/json

            Request body

            body DeleteBoxRequest (required)
            Body Parameter —

            Return type

            Example data

            Content-Type: application/json
            {
              "message" : "message",
              "status" : "status"
            }

            Produces

            This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Typeresponse header.
            • application/json

            Responses

            200

            Box deletion response DeleteBoxResponse


            Up
            delete /delete-dictionary
            Delete Dictionary (deleteDictionaryDelete)

            Query parameters

            dictionaryName (required)
            Query Parameter —

            Return type

            Example data

            Content-Type: application/json
            {
              "message" : "message",
              "status" : "status"
            }

            Produces

            This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Typeresponse header.
            • application/json

            Responses

            200

            Dictionary deletion response DeleteDictionaryResponse


            Up
            post /delete-file
            Delete File (deleteFilePost)

            Consumes

            This API call consumes the following media types via the Content-Typerequest header:
            • application/json

            Request body

            body DeleteFileRequest (required)
            Body Parameter —

            Return type

            Example data

            Content-Type: application/json
            {
              "message" : "message",
              "status" : "status"
            }

            Produces

            This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Typeresponse header.
            • application/json

            Responses

            200

            File deletion response DeleteFileResponse


            Up
            get /dictionaries
            List Dictionaries (dictionariesGet)

            Return type

            Example data

            Content-Type: application/json
            {
              "totalDictionaries" : 6,
              "dictionaries" : [ {
                "dictionaryName" : "dictionaryName",
                "dictionaryId" : "dictionaryId",
                "termsCount" : 0
              }, {
                "dictionaryName" : "dictionaryName",
                "dictionaryId" : "dictionaryId",
                "termsCount" : 0
              } ]
            }

            Produces

            This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Typeresponse header.
            • application/json

            Responses

            200

            Dictionary list response DictionaryListResponse


            Up
            get /dictionary-terms
            List Dictionary Terms (dictionaryTermsGet)

            Query parameters

            dictionaryName (required)
            Query Parameter —

            Return type

            Example data

            Content-Type: application/json
            {
              "totalTerms" : 0,
              "dictionaryName" : "dictionaryName",
              "terms" : [ {
                "termId" : "termId",
                "description" : "description",
                "term" : "term"
              }, {
                "termId" : "termId",
                "description" : "description",
                "term" : "term"
              } ]
            }

            Produces

            This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Typeresponse header.
            • application/json

            Responses

            200

            Terms list response DictionaryTermsResponse


            Up
            get /document-status
            Query document status (documentStatusGet)

            Query parameters

            docId (required)
            Query Parameter —

            Return type

            Example data

            Content-Type: application/json
            {
              "metadata" : {
                "path" : "path",
                "size" : 0,
                "name" : "name",
                "id" : "id"
              },
              "apiCallMessage" : "apiCallMessage",
              "redactionStatus" : true,
              "analysisStatus" : true,
              "apiCallStatus" : "apiCallStatus"
            }

            Produces

            This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Typeresponse header.
            • application/json

            Responses

            200

            Document retrieval response DocumentStatusResponse


            Up
            get /download-audit-copy
            Download audit document (downloadAuditCopyGet)

            Query parameters

            docId (required)
            Query Parameter —

            Return type

            byte[]

            Example data

            Content-Type: application/json
            ""

            Produces

            This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Typeresponse header.
            • application/octet-stream

            Responses

            200

            File download response byte[]


            Up
            get /download-original
            Download original document (downloadOriginalGet)

            Query parameters

            docId (required)
            Query Parameter —

            Return type

            byte[]

            Example data

            Content-Type: application/json
            ""

            Produces

            This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Typeresponse header.
            • application/octet-stream

            Responses

            200

            File download response byte[]


            Up
            get /download-redacted-copy
            Download redacted document (downloadRedactedCopyGet)

            Query parameters

            docId (required)
            Query Parameter —

            Return type

            byte[]

            Example data

            Content-Type: application/json
            ""

            Produces

            This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Typeresponse header.
            • application/octet-stream

            Responses

            200

            File download response byte[]


            Up
            post /edit-dictionary
            Edit Dictionary (editDictionaryPost)

            Consumes

            This API call consumes the following media types via the Content-Typerequest header:
            • multipart/form-data

            Form parameters

            dictionaryId (required)
            Form Parameter —
            file (required)
            Form Parameter — format: binary

            Return type

            Example data

            Content-Type: application/json
            {
              "message" : "message",
              "status" : "status"
            }

            Produces

            This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Typeresponse header.
            • application/json

            Responses

            200

            Dictionary edit response EditDictionaryResponse


            Up
            post /overwrite-dictionary
            Overwrite Dictionary (overwriteDictionaryPost)

            Consumes

            This API call consumes the following media types via the Content-Typerequest header:
            • multipart/form-data

            Form parameters

            dictionaryId (required)
            Form Parameter —
            file (required)
            Form Parameter — format: binary

            Return type

            Example data

            Content-Type: application/json
            {
              "message" : "message",
              "status" : "status"
            }

            Produces

            This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Typeresponse header.
            • application/json

            Responses

            200

            Dictionary overwrite response OverwriteDictionaryResponse


            Up
            get /regular-expressions
            List Regular Expressions (regularExpressionsGet)

            Return type

            Example data

            Content-Type: application/json
            [ {
              "regex" : "regex",
              "description" : "description",
              "id" : "id",
              "title" : "title"
            }, {
              "regex" : "regex",
              "description" : "description",
              "id" : "id",
              "title" : "title"
            } ]

            Produces

            This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Typeresponse header.
            • application/json

            Responses

            200

            Successful response RegularExpressionsResponse


            Up
            post /remove-dictionary-terms
            Remove Dictionary Terms (removeDictionaryTermsPost)

            Consumes

            This API call consumes the following media types via the Content-Typerequest header:
            • multipart/form-data

            Form parameters

            dictionaryId (required)
            Form Parameter —
            file (required)
            Form Parameter — format: binary

            Return type

            Example data

            Content-Type: application/json
            {
              "message" : "message",
              "status" : "status"
            }

            Produces

            This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Typeresponse header.
            • application/json

            Responses

            200

            Dictionary term removal response RemoveDictionaryTermsResponse


            Up
            post /request-hash-list-deduplication
            Request Hash List for Deduplication (requestHashListDeduplicationPost)

            Consumes

            This API call consumes the following media types via the Content-Typerequest header:
            • application/json

            Request body

            Body Parameter —

            Return type

            Example data

            Content-Type: application/json
            {
              "totalRows" : 6,
              "hashList" : [ {
                "fileName" : "fileName",
                "numberOfDuplicates" : 0,
                "hash" : "hash"
              }, {
                "fileName" : "fileName",
                "numberOfDuplicates" : 0,
                "hash" : "hash"
              } ]
            }

            Produces

            This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Typeresponse header.
            • application/json

            Responses

            200

            Deduplication hash list response RequestHashListDeduplicationResponse


            Up
            post /request-hash-list-near-deduplication
            Request Hash List for Near Deduplication (requestHashListNearDeduplicationPost)

            Consumes

            This API call consumes the following media types via the Content-Typerequest header:
            • application/json

            Request body

            Body Parameter —

            Return type

            Example data

            Content-Type: application/json
            {
              "totalRows" : 0,
              "hashList" : [ {
                "fileName" : "fileName",
                "numberOfDuplicates" : 0,
                "hash" : "hash"
              }, {
                "fileName" : "fileName",
                "numberOfDuplicates" : 0,
                "hash" : "hash"
              } ]
            }

            Produces

            This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Typeresponse header.
            • application/json

            Responses

            200

            Hash list for near deduplication requested RequestHashListNearDeduplicationResponse


            Up
            post /trigger-bulk-redaction
            Trigger Bulk Redaction (triggerBulkRedactionPost)

            Consumes

            This API call consumes the following media types via the Content-Typerequest header:
            • application/json

            Request body

            Body Parameter —

            Return type

            Example data

            Content-Type: application/json
            {
              "message" : "Bulk redaction process was triggered successfully!",
              "status" : "Success"
            }

            Produces

            This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Typeresponse header.
            • application/json

            Responses

            200

            Bulk redaction process response TriggerBulkRedactionResponse


            Up
            post /trigger-de-threading
            Trigger De-threading (triggerDeThreadingPost)

            Consumes

            This API call consumes the following media types via the Content-Typerequest header:
            • application/json

            Request body

            Body Parameter —

            Return type

            Example data

            Content-Type: application/json
            {
              "message" : "Dethreading process was triggered successfully!",
              "status" : "Success"
            }

            Produces

            This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Typeresponse header.
            • application/json

            Responses

            200

            Dethreading process response TriggerDeThreadingResponse


            Up
            post /trigger-deduplication
            Trigger Deduplication (triggerDeduplicationPost)

            Consumes

            This API call consumes the following media types via the Content-Typerequest header:
            • application/json

            Request body

            Body Parameter —

            Return type

            Example data

            Content-Type: application/json
            {
              "message" : "Deduplication process was triggered successfully!",
              "status" : "Success"
            }

            Produces

            This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Typeresponse header.
            • application/json

            Responses

            200

            Deduplication process response TriggerDeduplicationResponse


            Up
            post /trigger-near-deduplication
            Trigger Near Deduplication (triggerNearDeduplicationPost)

            Consumes

            This API call consumes the following media types via the Content-Typerequest header:
            • application/json

            Request body

            Body Parameter —

            Return type

            Example data

            Content-Type: application/json
            {
              "message" : "Near deduplication process was triggered successfully!",
              "status" : "Success"
            }

            Produces

            This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Typeresponse header.
            • application/json

            Responses

            200

            Near deduplication process response TriggerNearDeduplicationResponse


            Up
            post /upload
            Upload file (uploadPost)
            Upload files to a box

            Consumes

            This API call consumes the following media types via the Content-Typerequest header:
            • multipart/form-data

            Form parameters

            files (required)
            Form Parameter — format: binary
            boxId (required)
            Form Parameter —

            Return type

            Example data

            Content-Type: application/json
            {
              "uploadId" : "uploadId",
              "message" : "message",
              "status" : "status"
            }

            Produces

            This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Typeresponse header.
            • application/json

            Responses

            200

            Upload status response UploadFileResponse


            Models

            [ Jump to Methods ]

            Table of Contents

            1. Box
            2. BoxContentRequest
            3. BoxContentResponse
            4. BoxContentResponse_documents
            5. BoxListResponse
            6. BoxStatusResponse
            7. CreateBoxRequest
            8. CreateBoxResponse
            9. CreateDictionaryRequest
            10. CreateDictionaryResponse
            11. DeleteBoxRequest
            12. DeleteBoxResponse
            13. DeleteDictionaryResponse
            14. DeleteFileRequest
            15. DeleteFileResponse
            16. DictionaryListResponse
            17. DictionaryListResponse_dictionaries
            18. DictionaryTermsResponse
            19. DictionaryTermsResponse_terms
            20. DocumentStatusResponse
            21. DocumentStatusResponse_metadata
            22. EditDictionaryRequest
            23. EditDictionaryResponse
            24. OverwriteDictionaryRequest
            25. OverwriteDictionaryResponse
            26. RegularExpressionsResponse
            27. RegularExpressionsResponse_inner
            28. RemoveDictionaryTermsRequest
            29. RemoveDictionaryTermsResponse
            30. RequestHashListDeduplicationRequest
            31. RequestHashListDeduplicationResponse
            32. RequestHashListDeduplicationResponse_hashList
            33. RequestHashListNearDeduplicationRequest
            34. RequestHashListNearDeduplicationResponse
            35. TriggerBulkRedactionRequest
            36. TriggerBulkRedactionRequest_redactionOptions
            37. TriggerBulkRedactionResponse
            38. TriggerDeThreadingRequest
            39. TriggerDeThreadingResponse
            40. TriggerDeduplicationRequest
            41. TriggerDeduplicationResponse
            42. TriggerNearDeduplicationRequest
            43. TriggerNearDeduplicationResponse
            44. UploadFileRequest
            45. UploadFileResponse

            Box Up

            boxId (optional)
            String A unique identifier for the box
            boxName (optional)
            String The name of the box
            sharingAvailability (optional)
            Boolean Indicates if the box is available for sharing
            visibleToDownload (optional)
            Boolean Indicates if the box is visible for download
            visibleAllUsers (optional)
            Boolean Indicates if the box is visible to all users
            usersAccessDownload (optional)
            array[String] A list of users who have access to download the box or null if no specific users are assigned
            usersBoxVisible (optional)
            array[String] A list of users who can see the box or null if no specific users are assigned

            BoxContentRequest Up

            boxId (optional)
            pageNumber (optional)
            example: 1
            resultsPerPage (optional)
            Enum:
            20
            50
            100
            example: 20

            BoxContentResponse Up

            documents (optional)
            totalDocuments (optional)
            Integer Total number of documents
            apiCallMessage (optional)
            String Message indicating the result of the API call
            apiCallStatus (optional)
            String Status of the API call

            BoxContentResponse_documents Up

            docId (optional)
            String Unique identifier for the document
            path (optional)
            String Path where the document is stored
            name (optional)
            String Name of the document
            size (optional)
            Integer Size of the document in bytes

            BoxListResponse Up

            boxList (optional)

            BoxStatusResponse Up

            totalFiles (optional)
            Integer Total number of files to be processed
            numberOfFilesProcessed (optional)
            Integer Number of files that have been processed so far
            boxRedacted (optional)
            Boolean Indicates if the box has been redacted
            extractionInProgress (optional)
            Boolean Indicates if the extraction process is currently in progress
            boxAnalysed (optional)
            Boolean Indicates if the box has been analysed
            apiCallMessage (optional)
            String Message indicating the result of the API call
            apiCallStatus (optional)
            String Status of the API call

            CreateBoxRequest Up

            boxName
            boxConfiguration (optional)
            String Default or Advanced
            example: Advanced
            analysisConfiguration (optional)
            String Selected PII, Dictionaries and Regex for analysis
            example: ["doc_anotate_address_email","doc_anotate_address_url",{"selectedRegexList":"EE"},{"selectedBusinessTerms":4}]
            securityConfiguration (optional)
            Object Sharing and download access options
            example: [{"shareFolder":true},{"visibleAllUsers":true},{"visibleToDownload":true},{"usersBoxVisible":[]},{"usersAccessDownload":[]}]

            CreateBoxResponse Up

            boxId (optional)
            String Unique identifier for the box
            boxName (optional)
            String Name assigned to the box
            status (optional)
            String Status of the box creation process
            message (optional)
            String Message indicating the result of the box creation

            CreateDictionaryRequest Up

            dictionaryName
            String Name of the dictionary to be created
            terms
            array[String] List of terms to be included in the dictionary

            CreateDictionaryResponse Up

            status (optional)
            String Status of the dictionary creation process
            message (optional)
            String Message indicating the result of the dictionary creation
            dictionaryId (optional)
            String Unique identifier for the created dictionary

            DeleteBoxRequest Up

            boxId (optional)

            DeleteBoxResponse Up

            status (optional)
            String Status of the box deletion process
            message (optional)
            String Message indicating the result of the box deletion

            DeleteDictionaryResponse Up

            status (optional)
            String Status of the dictionary deletion process
            message (optional)
            String Message indicating the result of the dictionary deletion

            DeleteFileRequest Up

            fileId (optional)

            DeleteFileResponse Up

            status (optional)
            String Status of the file deletion process
            message (optional)
            String Message indicating the result of the file deletion

            DictionaryListResponse Up

            dictionaries (optional)
            totalDictionaries (optional)
            Integer Total number of dictionaries

            DictionaryListResponse_dictionaries Up

            dictionaryId (optional)
            String Unique identifier for the dictionary
            dictionaryName (optional)
            String Name of the dictionary
            termsCount (optional)
            Integer Number of terms in the dictionary

            DictionaryTermsResponse Up

            dictionaryName (optional)
            String Name of the dictionary
            terms (optional)
            array[DictionaryTermsResponse_terms] List of terms in the dictionary
            totalTerms (optional)
            Integer Total number of terms in the dictionary

            DictionaryTermsResponse_terms Up

            termId (optional)
            String Unique identifier for the term
            term (optional)
            String The term itself
            description (optional)
            String Description of the term

            DocumentStatusResponse Up

            redactionStatus (optional)
            Boolean Indicates if the document has been redacted
            analysisStatus (optional)
            Boolean Indicates if the document has been analysed
            metadata (optional)
            apiCallMessage (optional)
            String Message indicating the result of the API call
            apiCallStatus (optional)
            String Status of the API call

            DocumentStatusResponse_metadata Up

            Metadata of the document
            size (optional)
            Integer Size of the document in bytes
            path (optional)
            String Path where the document is stored
            name (optional)
            String Name of the document
            id (optional)
            String Unique identifier for the document

            EditDictionaryRequest Up

            dictionaryId (optional)
            file (optional)
            byte[] format: binary

            EditDictionaryResponse Up

            status (optional)
            String Status of the dictionary edit process
            message (optional)
            String Message indicating the result of the dictionary edit

            OverwriteDictionaryRequest Up

            dictionaryId (optional)
            file (optional)
            byte[] format: binary

            OverwriteDictionaryResponse Up

            status (optional)
            String Status of the term removal process
            message (optional)
            String Message indicating the result of the term removal

            RegularExpressionsResponse_inner Up

            id (optional)
            String The unique identifier for the regular expression
            title (optional)
            String The title of the regular expression
            description (optional)
            String A brief description of the regular expression
            regex (optional)
            String The regular expression pattern

            RemoveDictionaryTermsRequest Up

            dictionaryId (optional)
            file (optional)
            byte[] format: binary

            RemoveDictionaryTermsResponse Up

            status (optional)
            String Status of the term removal process
            message (optional)
            String Message indicating the result of the term removal

            RequestHashListDeduplicationRequest Up

            boxId
            pageNumber
            resultsPerPage
            searchWord (optional)
            String returns only hashes of file names containing searchWord

            RequestHashListDeduplicationResponse Up

            hashList (optional)
            array[RequestHashListDeduplicationResponse_hashList] List of file hashes and their details
            totalRows (optional)
            Integer Total number of rows in the hash list

            RequestHashListDeduplicationResponse_hashList Up

            fileName (optional)
            String Name of the file
            hash (optional)
            String Hash value of the file
            numberOfDuplicates (optional)
            Integer Number of duplicate files

            RequestHashListNearDeduplicationRequest Up

            boxId
            pageNumber
            resultsPerPage
            searchWord (optional)
            String Returns only hashes of file names containing searchWord

            RequestHashListNearDeduplicationResponse Up

            hashList (optional)
            array[RequestHashListDeduplicationResponse_hashList] List of file hashes and their details
            totalRows (optional)
            Integer Total number of rows in the hash list

            TriggerBulkRedactionRequest_redactionOptions Up

            redactionType (optional)
            String Type of redaction to be applied
            example: Full
            includeMetadata (optional)
            Boolean Whether to include metadata in the redaction process
            example: true

            TriggerBulkRedactionResponse Up

            status (optional)
            String Status of the bulk redaction process
            example: Success
            message (optional)
            String Message indicating the result of the bulk redaction process
            example: Bulk redaction process was triggered successfully!

            TriggerDeThreadingRequest Up

            boxId (optional)
            triggerEmailThreading (optional)
            removeEmptyFolders (optional)

            TriggerDeThreadingResponse Up

            status (optional)
            String Status of the dethreading process
            example: Success
            message (optional)
            String Message indicating the result of the dethreading process
            example: Dethreading process was triggered successfully!

            TriggerDeduplicationRequest Up

            boxId
            triggerDeduplicationUponAllFiles
            excludedHashes (optional)

            TriggerDeduplicationResponse Up

            status (optional)
            String Status of the deduplication process
            example: Success
            message (optional)
            String Message indicating the result of the deduplication process
            example: Deduplication process was triggered successfully!

            TriggerNearDeduplicationRequest Up

            boxId
            fileToKeepOption (optional)
            triggerNearDeduplicationUponAllFiles
            selectedHashes (optional)
            excludedHashes (optional)

            TriggerNearDeduplicationResponse Up

            status (optional)
            String Status of the Near deduplication process
            example: Success
            message (optional)
            String Message indicating the result of the Near deduplication process
            example: Near deduplication process was triggered successfully!

            UploadFileRequest Up

            files (optional)
            byte[] format: binary
            boxId (optional)

            UploadFileResponse Up

            status (optional)
            String Status of the upload process
            message (optional)
            String Message indicating the result of the upload
            uploadId (optional)
            String Unique identifier for the upload

            Was this article helpful?

            That’s Great!

            Thank you for your feedback

            Sorry! We couldn't be helpful

            Thank you for your feedback

            Let us know how can we improve this article!

            Select at least one of the reasons
            CAPTCHA verification is required.

            Feedback sent

            We appreciate your effort and will try to fix the article

            Preview
            0 of 0