Freigegeben: JSON-Repräsentation

In diesem Kapitel erfahren Sie, in welchem Format Detailinformationen zu erfolgreichen Anforderungen (Requests) ausgegeben werden. Abhängig vom Verarbeitungsergebnis wird die HTTP-Anforderung mit beschreibenden Detailinformationen zurückgeliefert.

Beschreibung der Parameter zur Antwort auf die erfolgreiche Anforderung mit Detailinformationen:

Beschreibung der Parameter eines responseDetails-Objekts:

Beschreibung der Parameter eines ResponseDetailData-Objekts:

Beispiele für eine Antwort für eine erfolgreiche Anforderung (Request) mit Detailinformationen zu den jeweiligen ResponseDetail-Codes:

Beispiel 1: DmsApp-Mapping-IgnoredNotModifiableDestinationProperty

HTTP/1.1 200 OK
 
{
    "responseDetails": [
        {
            "code": "DmsApp-Mapping-IgnoredNotModifiableDestinationProperty",
            "title": "Ignored source property",
            "detail": "The source property with the ID 'myprop1_ID' was ignored because the mapped destination property with the ID '5' ('Name') is not modifiable. The current value for the property is 'Value of Name' and is not overwritten by the given value 'Value for myprop1'.",
            "hint": "Please adjust the d.3 configuration if you still want to write the values or contact your administrator.",
            "data": {
                "sourceItemId": "myprop1_ID",
                "sourceItemValue": "Value for myprop1",
                "destinationItemId": "5",
                "destinationItemValue": "Value of Name"
            }
        }
    ]
}

Beispiel 2: DmsApp-Mapping-NoMappingFoundForSourceCategory

HTTP/1.1 200 OK
 
{
    "responseDetails": [
        {
            "code": "DmsApp-Mapping-NoMappingFoundForSourceCategory",
            "title": "Ignored source category",
            "detail": "The source category with the ID 'CAT1' was ignored because no mapping to a destination category was found.",
            "hint": "Please configure a mapping for the given source category or contact your administrator.",
            "data": {
                "sourceItemId": "CAT1"
            }
        }
    ]
}

Beispiel 3: DmsApp-Mapping-IgnoredDestinationSystemPropertyDueToUpdateMode

HTTP/1.1 200 OK
 
{
    "responseDetails": [     
        {
            "code": "DmsApp-Mapping-IgnoredDestinationSystemPropertyDueToUpdateMode",
            "title": "Ignored source property",
            "detail": "The source property with the ID 'PROP2' was ignored because the mapped destination property with the ID 'property_document_number', which is a system property, cannot be changed in update mode.",
            "data": {
                "sourceItemId": "PROP2",
                "destinationItemId": "property_document_number"
            }
        }
    ]
}

Beispiel 4: DmsApp-Mapping-MappingForSourceNotFound

HTTP/1.1 200 OK
 
{
    "responseDetails": [
        {
            "code": "DmsApp-Mapping-MappingForSourceNotFound",
            "title": "Mapping configuration not found",
            "detail": "No mapping configuration was found for the source with the ID '/myapp/sources/mysourcex'. For this reason, no mapping is applied and any given values for properties or categories are ignored.",
            "hint": "Please configure a mapping for the given source or contact your administrator.",
            "data": {
                "sourceItemId": "/myapp/sources/mysourcex"
            }
        }
    ]
}

Beispiel 5: DmsApp-Mapping-NoDestinationCategoryFoundWithDestinationProperty

HTTP/1.1 200 OK
 
{
    "responseDetails": [
        {
            "code": "DmsApp-Mapping-NoDestinationCategoryFoundWithDestinationProperty",
            "title": "Ignored source property",
            "detail": "The source property with the ID 'myprop1_ID' was ignored because the mapped destination property with the ID '5' was not found in any destination category.",
            "data": {
                "sourceItemId": "myprop1_ID",
                "destinationItemId": "5"
            }
        }
    ]
}

Beispiel 6: DmsApp-Mapping-NoMappingFoundForSourceProperty

HTTP/1.1 200 OK
 
{
    "responseDetails": [
        {
            "code": "DmsApp-Mapping-NoMappingFoundForSourceProperty",
            "title": "Ignored source property",
            "detail": "The source property with the ID 'PROP3' was ignored because no mapping to a destination property was found.",
            "hint": "Please configure a mapping for the given source property or contact your administrator.",
            "data": {
                "sourceItemId": "PROP3"
            }
        }
    ]
}

Beispiel 7: DmsApp-Mapping-NoSourceProperties

HTTP/1.1 200 OK
 
{
    "responseDetails": [
        {
            "code": "DmsApp-Mapping-NoSourceProperties",
            "title": "No source properties given",
            "detail": "No source properties were given that could be mapped."
        }
    ]
}

Beispiel 8: DmsApp-Mapping-NoValuesGivenForSourceProperty

HTTP/1.1 200 OK
 
{
    "responseDetails": [
        {
            "code": "DmsApp-Mapping-NoValuesGivenForSourceProperty",
            "title": "Ignored source property",
            "detail": "The source property with the ID 'myprop1_ID' was ignored because no values were given.",
            "data": {
                "sourceItemId": "myprop1_ID"
            }
        }
    ]
}

Beispiel 9: DmsApp-Mapping-PropertyStatusIgnored

HTTP/1.1 200 OK
 
{
    "responseDetails": [
        {
            "code": "DmsApp-Mapping-PropertyStatusIgnored",
            "title": "Ignored source property",
            "detail": "The source property with the ID 'myprop1_ID' was ignored because it is mapped to the destination property 'status' (ID: 'property_state') and other source properties were given. A status transfer is only possible if no other properties are changed.",
            "hint": "For a status transfer please send only the property ‘status’. Change the other properties in another request.",
            "data": {
                "sourceItemId": "myprop1_ID",
                "destinationItemId": "property_state"
            }
        }
    ]
}

Beispiel 10: DmsApp-Mapping-UnknownDestinationCategory

HTTP/1.1 200 OK
 
{
    "responseDetails": [
        {
            "code": "DmsApp-Mapping-UnknownDestinationCategory",
            "title": "Ignored source category",
            "detail": "The source category with the ID 'mycat1_ID' was ignored because the mapped destination category with the id 'destcat1_ID' is unknown or the user does not have permission for the category.",          
            "data": {
                "sourceItemId": "mycat1_ID",
                "destinationItemId": "destcat1_ID"
            }
        }
    ]
}