GET api/ResourceTypes/ImportCustomFieldsPreviewData/{dataFetchKey}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
dataFetchKey

string

Required

Body Parameters

None.

Response Information

Resource Description

ImportPreview
NameDescriptionTypeAdditional information
ImportKey

string

None.

ImportValid

boolean

None.

NoAction

boolean

None.

InformationMessages

Collection of GroupedTranslationMessages

None.

ErrorMessages

Collection of GroupedTranslationMessages

None.

WarningMessages

Collection of GroupedTranslationMessages

None.

TotalObjectsAffectedByImport

integer

None.

TotalObjectsUpdated

integer

None.

TotalObjectsCreated

integer

None.

TotalObjectsNoActionTaken

integer

None.

TotalObjectsToBeIgnored

integer

None.

TotalObjectsWithErrors

integer

None.

Response Formats

application/json, text/json

Sample:
{
  "ImportKey": "sample string 1",
  "ImportValid": false,
  "NoAction": true,
  "InformationMessages": [
    {
      "IsTopGroup": true,
      "GroupKey": "sample string 2",
      "Messages": [
        {
          "MessageKey": "sample string 1",
          "Message": "sample string 2",
          "MessageParams": {
            "sample string 1": {},
            "sample string 3": {}
          }
        },
        {
          "MessageKey": "sample string 1",
          "Message": "sample string 2",
          "MessageParams": {
            "sample string 1": {},
            "sample string 3": {}
          }
        }
      ]
    },
    {
      "IsTopGroup": true,
      "GroupKey": "sample string 2",
      "Messages": [
        {
          "MessageKey": "sample string 1",
          "Message": "sample string 2",
          "MessageParams": {
            "sample string 1": {},
            "sample string 3": {}
          }
        },
        {
          "MessageKey": "sample string 1",
          "Message": "sample string 2",
          "MessageParams": {
            "sample string 1": {},
            "sample string 3": {}
          }
        }
      ]
    }
  ],
  "ErrorMessages": [
    {
      "IsTopGroup": true,
      "GroupKey": "sample string 2",
      "Messages": [
        {
          "MessageKey": "sample string 1",
          "Message": "sample string 2",
          "MessageParams": {
            "sample string 1": {},
            "sample string 3": {}
          }
        },
        {
          "MessageKey": "sample string 1",
          "Message": "sample string 2",
          "MessageParams": {
            "sample string 1": {},
            "sample string 3": {}
          }
        }
      ]
    },
    {
      "IsTopGroup": true,
      "GroupKey": "sample string 2",
      "Messages": [
        {
          "MessageKey": "sample string 1",
          "Message": "sample string 2",
          "MessageParams": {
            "sample string 1": {},
            "sample string 3": {}
          }
        },
        {
          "MessageKey": "sample string 1",
          "Message": "sample string 2",
          "MessageParams": {
            "sample string 1": {},
            "sample string 3": {}
          }
        }
      ]
    }
  ],
  "WarningMessages": [
    {
      "IsTopGroup": true,
      "GroupKey": "sample string 2",
      "Messages": [
        {
          "MessageKey": "sample string 1",
          "Message": "sample string 2",
          "MessageParams": {
            "sample string 1": {},
            "sample string 3": {}
          }
        },
        {
          "MessageKey": "sample string 1",
          "Message": "sample string 2",
          "MessageParams": {
            "sample string 1": {},
            "sample string 3": {}
          }
        }
      ]
    },
    {
      "IsTopGroup": true,
      "GroupKey": "sample string 2",
      "Messages": [
        {
          "MessageKey": "sample string 1",
          "Message": "sample string 2",
          "MessageParams": {
            "sample string 1": {},
            "sample string 3": {}
          }
        },
        {
          "MessageKey": "sample string 1",
          "Message": "sample string 2",
          "MessageParams": {
            "sample string 1": {},
            "sample string 3": {}
          }
        }
      ]
    }
  ],
  "TotalObjectsAffectedByImport": 3,
  "TotalObjectsUpdated": 4,
  "TotalObjectsCreated": 5,
  "TotalObjectsNoActionTaken": 6,
  "TotalObjectsToBeIgnored": 7,
  "TotalObjectsWithErrors": 8
}

application/xml

Sample:

Sample not available.

text/xml

Sample:

Sample not available.