Search Results for

    Show / Hide Table of Contents

    Method CreateDocumentComplex

    CreateDocumentComplex(String, DocumentContract, DocumentFileParameterContract, CreateDocumentOptionsContract)

    Create a new document

    Declaration
    DocumentContract CreateDocumentComplex(string connectionId, DocumentContract document, DocumentFileParameterContract documentFileParameter, CreateDocumentOptionsContract options)
    Parameters
    Type Name Description
    System.String connectionId

    The connection id to identify your connection. See also ConnectionId

    DocumentContract document

    Document to create

    DocumentFileParameterContract documentFileParameter

    Files to import

    CreateDocumentOptionsContract options

    Optional: Additional options

    Returns
    Type Description
    DocumentContract

    The created document

    Examples

    POST http://YourServerName/InfoShare/Json/Document/CreateDocumentComplex

    Example for create a document complex.

    {
        "connectionId": "e80fbb94-b6bd-4d8b-b786-faa2ff8f833a",
        "document": {
            "Name": "Lohnzettel Corynne",
            "InfoStoreId": "d239283f-2957-eb11-a0fd-00155d109000",
            "ProtectionDomainId": "0100a000-38a7-11d8-a902-0050bf427e8f"
        },
        "documentFileParameter": {
            "DocumentData": [
                {
                    "Name": "DocumentData Lohnzettel Corynne",
                    "Files": [
                        {
                            "FileId": "eaf7d52f-9ddb-4153-bac6-039ed3dbdf59",
                            "Name": "Lohnzettel_Corynne.pdf"
                        }
                    ]
                }
            ]
        },
        "options": {
        "VerifyOptions": 
            {
            "FileLength": 7,
                "HashValue": "zB+FTMzmqWP1LZrdCUSJm01CTnZrCWTKVY/9xsex9BEBg32rm4+H/vEeT8/oh5YJ2I7mZ4ELi1v5aytOLrVQWg=="
            }
        }
    }

    Response:

    {
        "CreateDocumentComplexResult": {
            "Abonnements": [],
            "AccessRightsEnumList": [
                "CheckOut",
                "EditContent",
                "Delete",
                ...
            ],
           "AnnotationManager": {
               "PostItAnnotations": [],
               "RectangleAnnotations": [],
               "StampAnnotations": [],
               "TextAnnotations": []
            },
            "Blogs": [],
            "CheckOutStateEnum": "NotCheckedOut",
            "CheckOutUserId": "00000000-0000-0000-0000-000000000000",
            "DocumentData": [
                {
                    "Id": "803e3403-2a57-eb11-a0fd-00155d109000",
                    "Name": "Lohnzettel Corynne",
                    "Renditions": [
                        {
                            "ContentProtections": [],
                            "Extension": "",
                            "Files": [
                                {
                                    "BlobPath": "2021\\01\\15\\000\\000\\000DocumentData Lohnzettel Corynne.",
                                    "BlobStoreId": "573a283f-2957-eb11-a0fd-00155d109000"
                                }
                            ],
                           "HashValue": [
                               204,
                               31,
                               ...
                            ],
                            "Id": "873e3403-2a57-eb11-a0fd-00155d109000",
                            "PageCount": 0,
                            "Size": 7
                        }
                    ]
                }
            ],
            "HasOverlay": false,
            "Id": "0aba0ab3-1366-4dc7-b4a5-9508d2d4d9ab",
            "ImportTemplateId": null,
            "InfoStoreId": "d239283f-2957-eb11-a0fd-00155d109000",
            "LifeCycleManager": {
                "CheckOutLifeCycleStateId": null,
                "LifeCycleEndDate": null,
                "LifeCycleId": null,
                "LifeCycleProtections": null,
                "LifeCycleStartDate": null,
                "LifeCycleStateId": null,
                "NextAutomaticLifeCycleStateId": null,
                "NextLifeCycleStates": []
            },
            "MainFileLength": 7,
            "Name": "Lohnzettel Corynne",
            "PageCount": 0,
            "Properties": [
                {
                    "GlobalValues": [],
                    "PropertyTypeId": "010000a0-38a7-11d8-a902-0050bf427e8f",
                    "Values": [
                        "2021-01-15T12:07:32"
                    ]
                },
                {
                    "GlobalValues": [],
                     "PropertyTypeId": "01000006-38a7-11d8-a902-0050bf427e8f",
                    "Values": [
                        "Lohnzettel Corynne"
                    ]
                },
                {
                    "GlobalValues": [],
                    "PropertyTypeId": "0100000c-38a7-11d8-a902-0050bf427e8f",
                    "Values": []
                },
                {
                    "GlobalValues": [],
                    "PropertyTypeId": "01000a00-38a7-11d8-a902-0050bf427e8f",
                    "Values": [
                        "Lohnzettel Corynne"
                    ]
                },
                {
                    "GlobalValues": [],
                    "PropertyTypeId": "0100000d-38a7-11d8-a902-0050bf427e8f",
                    "Values": [
                        "zB+FTMzmqWP1LZrdCUSJm01CTnZrCWTKVY/9xsex9BEBg32rm4+H/vEeT8/oh5YJ2I7mZ4ELi1v5aytOLrVQWg=="
                    ]
                },
                {
                    "GlobalValues": [],
                    "PropertyTypeId": "01000001-d596-485b-ace6-d64647a94277",
                    "Values": [
                        "2021-01-15T12:05:00"
                    ]
                },
                {
                    "GlobalValues": [
                        {
                            "Values": [
                                {
                                    "Culture": "de-DE",
                                    "Text": "DCI administrator"
                                },
                                {
                                    "Culture": "de",
                                    "Text": "DCI administrator"
                                }
                            ]
                        }
                    ],
                    "PropertyTypeId": "01000002-d596-485b-ace6-d64647a94277",
                    "Values": [
                        "0100a003-38a7-11d8-a902-0050bf427e8f"
                    ]
                },
                ...
            ],
            "ProtectionDomainId": "0100a000-38a7-11d8-a902-0050bf427e8f",
            "Reminders": [],
            "SessionCount": 0,
            "SigningProfileId": null,
            "VersionId": "0aba0ab3-1366-4dc7-b4a5-9508d2d4d9ab"
        }
    }
    Exceptions
    Type Condition
    ServiceException

    The connection id {connectionId} isn't valid or has expired (10008)

    ServiceException

    InfoStore not found {infoStoreId} (10018)

    ServiceException

    Unknown data type for property type (10035)

    ServiceException

    Protection domain not found {protectionDomainId} (10036)

    ServiceException

    String was not recognized as a valid DateTime: {dateTimeValue}. Expected format {expectedFormat} (10059)

    ServiceException

    InfoStore {infoStoreId} has no blob storage (10070)

    ServiceException

    Property type not found {propertyTypeId} (10034)

    ServiceException

    Timeout occured in method {methodName} (10116)

    ServiceException

    Failure while inserting values into document (10117)

    ServiceException

    Document is already a SAP document (10121)

    ServiceException

    SAP property for repository not configured (10122)

    ServiceException

    SAP property for sap document id not configured (10123)

    ServiceException

    No SAP repository found (10124)

    ServiceException

    Verification code is needed: Verification code not yet verified (10152)

    ServiceException

    Too much renditions or document datas for a SAP Document (10164)

    ServiceException

    Not enough rights ({accessOperationName}, {accessOperationId}) (10071)

    ServiceException

    Failure while inserting value: '{propertyTypeValue}' into propertyType: {propertyTypeId} (10190)

    ServiceException

    Could not parse hexadecimal color code string {hexColorCodeString} to a valid ARGB value (10207)

    ServiceException

    Property type {propertyTypeId} value is too long: {value} (10179)

    ServiceException

    Document with Id {documentId} already exists (10234)

    ServiceException

    No file matched the given criteria (10250)

    Back to top Copyright © Kendox