Jump to

• Request
• Response
• Examples

Update an import definition for an event

put

/api/bulk/2.0/events/{parentId}/imports/{id}

Updates the specified import definition for the specified event.

Request

Supported Media Types

• application/json
• text/csv

Path Parameters

• id: integer
• parentId: integer

Body ()

Root Schema : EventImportIndividual

Type: object

Title: EventImportIndividual

Show Source

• autoDeleteDuration(optional): string
  Title: autoDeleteDuration
• createdAt(optional): string(date-time)
  Title: createdAt
• createdBy(optional): string
  Title: createdBy
• dataRetentionDuration(optional): string
  Title: dataRetentionDuration
• fields(optional): array fields
  Title: fields
• id(optional): integer
  Title: id
• identifierFieldName(optional): string
  Title: identifierFieldName
• importPriorityUri(optional): string
  Title: importPriorityUri
• isSyncTriggeredOnImport(optional): boolean
  Title: isSyncTriggeredOnImport
• isUpdatingMultipleMatchedRecords(optional): boolean
  Title: isUpdatingMultipleMatchedRecords
• kbUsed(optional): integer(int64)
  Title: kbUsed
• mapDataCards(optional): boolean
  Title: mapDataCards
• mapDataCardsCaseSensitiveMatch(optional): boolean
  Title: mapDataCardsCaseSensitiveMatch
• mapDataCardsEntityField(optional): string
  Title: mapDataCardsEntityField
• mapDataCardsEntityType(optional): string
  Title: mapDataCardsEntityType
• mapDataCardsSourceField(optional): string
  Title: mapDataCardsSourceField
• name(optional): string
  Title: name
• nullIdentifierFieldName(optional): boolean
  Title: nullIdentifierFieldName
• parentId(optional): integer
  Title: parentId
• syncActions(optional): array syncActions
  Title: syncActions
• updatedAt(optional): string(date-time)
  Title: updatedAt
• updatedBy(optional): string
  Title: updatedBy
• updateRule(optional): string
  Title: RuleType

  Default Value: always

  Allowed Values: [ "always", "ifNewIsNotNull", "ifExistingIsNull", "useFieldRule" ]
• updateRuleByField(optional): array updateRuleByField
  Title: updateRuleByField
• uri(optional): string
  Title: uri

{
    "title":"EventImportIndividual",
    "description":"",
    "properties":{
        "autoDeleteDuration":{
            "title":"autoDeleteDuration",
            "description":"",
            "type":"string"
        },
        "createdAt":{
            "format":"date-time",
            "title":"createdAt",
            "description":"",
            "type":"string"
        },
        "createdBy":{
            "title":"createdBy",
            "description":"",
            "type":"string"
        },
        "dataRetentionDuration":{
            "title":"dataRetentionDuration",
            "description":"",
            "type":"string"
        },
        "fields":{
            "title":"fields",
            "description":"",
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "id":{
            "title":"id",
            "description":"",
            "type":"integer"
        },
        "identifierFieldName":{
            "title":"identifierFieldName",
            "description":"",
            "type":"string"
        },
        "importPriorityUri":{
            "title":"importPriorityUri",
            "description":"",
            "type":"string"
        },
        "isSyncTriggeredOnImport":{
            "title":"isSyncTriggeredOnImport",
            "description":"",
            "type":"boolean"
        },
        "isUpdatingMultipleMatchedRecords":{
            "title":"isUpdatingMultipleMatchedRecords",
            "description":"",
            "type":"boolean"
        },
        "kbUsed":{
            "format":"int64",
            "title":"kbUsed",
            "description":"",
            "type":"integer"
        },
        "mapDataCards":{
            "title":"mapDataCards",
            "description":"",
            "type":"boolean"
        },
        "mapDataCardsCaseSensitiveMatch":{
            "title":"mapDataCardsCaseSensitiveMatch",
            "description":"",
            "type":"boolean"
        },
        "mapDataCardsEntityField":{
            "title":"mapDataCardsEntityField",
            "description":"",
            "type":"string"
        },
        "mapDataCardsEntityType":{
            "title":"mapDataCardsEntityType",
            "description":"",
            "type":"string"
        },
        "mapDataCardsSourceField":{
            "title":"mapDataCardsSourceField",
            "description":"",
            "type":"string"
        },
        "name":{
            "title":"name",
            "description":"",
            "type":"string"
        },
        "nullIdentifierFieldName":{
            "title":"nullIdentifierFieldName",
            "description":"",
            "type":"boolean"
        },
        "parentId":{
            "title":"parentId",
            "description":"",
            "type":"integer"
        },
        "syncActions":{
            "title":"syncActions",
            "description":"",
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "updatedAt":{
            "format":"date-time",
            "title":"updatedAt",
            "description":"",
            "type":"string"
        },
        "updatedBy":{
            "title":"updatedBy",
            "description":"",
            "type":"string"
        },
        "updateRule":{
            "$ref":"#/definitions/RuleType"
        },
        "updateRuleByField":{
            "title":"updateRuleByField",
            "description":"",
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "uri":{
            "title":"uri",
            "description":"",
            "type":"string"
        }
    }
}

Nested Schema : fields

Type: array

Title: fields

Show Source

• Array of: string

{
    "title":"fields",
    "description":"",
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : syncActions

Type: array

Title: syncActions

Show Source

• Array of: string

{
    "title":"syncActions",
    "description":"",
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : updateRuleByField

Type: array

Title: updateRuleByField

Show Source

• Array of: string

{
    "title":"updateRuleByField",
    "description":"",
    "type":"array",
    "items":{
        "type":"string"
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK.

Body ()

Root Schema : EventImportIndividualResponse

Type: object

Title: EventImportIndividualResponse

Show Source

• autoDeleteDuration(optional): string
  Title: autoDeleteDuration
• createdAt(optional): string(date-time)
  Title: createdAt
• createdBy(optional): string
  Title: createdBy
• dataRetentionDuration(optional): string
  Title: dataRetentionDuration
• fields(optional): array fields
  Title: fields
• identifierFieldName(optional): string
  Title: identifierFieldName
• importPriorityUri(optional): string
  Title: importPriorityUri
• isSyncTriggeredOnImport(optional): boolean
  Title: isSyncTriggeredOnImport
• isUpdatingMultipleMatchedRecords(optional): boolean
  Title: isUpdatingMultipleMatchedRecords
• kbUsed(optional): integer(int64)
  Title: kbUsed
• mapDataCards(optional): boolean
  Title: mapDataCards
• mapDataCardsCaseSensitiveMatch(optional): boolean
  Title: mapDataCardsCaseSensitiveMatch
• mapDataCardsEntityField(optional): string
  Title: mapDataCardsEntityField
• mapDataCardsEntityType(optional): string
  Title: mapDataCardsEntityType
• mapDataCardsSourceField(optional): string
  Title: mapDataCardsSourceField
• name(optional): string
  Title: name
• nullIdentifierFieldName(optional): boolean
  Title: nullIdentifierFieldName
• syncActions(optional): array syncActions
  Title: syncActions
• updatedAt(optional): string(date-time)
  Title: updatedAt
• updatedBy(optional): string
  Title: updatedBy
• updateRule(optional): string
  Title: RuleType

  Default Value: always

  Allowed Values: [ "always", "ifNewIsNotNull", "ifExistingIsNull", "useFieldRule" ]
• updateRuleByField(optional): array updateRuleByField
  Title: updateRuleByField
• uri(optional): string
  Title: uri

{
    "title":"EventImportIndividualResponse",
    "description":"",
    "properties":{
        "autoDeleteDuration":{
            "title":"autoDeleteDuration",
            "description":"",
            "type":"string"
        },
        "createdAt":{
            "format":"date-time",
            "title":"createdAt",
            "description":"",
            "type":"string"
        },
        "createdBy":{
            "title":"createdBy",
            "description":"",
            "type":"string"
        },
        "dataRetentionDuration":{
            "title":"dataRetentionDuration",
            "description":"",
            "type":"string"
        },
        "fields":{
            "title":"fields",
            "description":"",
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "identifierFieldName":{
            "title":"identifierFieldName",
            "description":"",
            "type":"string"
        },
        "importPriorityUri":{
            "title":"importPriorityUri",
            "description":"",
            "type":"string"
        },
        "isSyncTriggeredOnImport":{
            "title":"isSyncTriggeredOnImport",
            "description":"",
            "type":"boolean"
        },
        "isUpdatingMultipleMatchedRecords":{
            "title":"isUpdatingMultipleMatchedRecords",
            "description":"",
            "type":"boolean"
        },
        "kbUsed":{
            "format":"int64",
            "title":"kbUsed",
            "description":"",
            "type":"integer"
        },
        "mapDataCards":{
            "title":"mapDataCards",
            "description":"",
            "type":"boolean"
        },
        "mapDataCardsCaseSensitiveMatch":{
            "title":"mapDataCardsCaseSensitiveMatch",
            "description":"",
            "type":"boolean"
        },
        "mapDataCardsEntityField":{
            "title":"mapDataCardsEntityField",
            "description":"",
            "type":"string"
        },
        "mapDataCardsEntityType":{
            "title":"mapDataCardsEntityType",
            "description":"",
            "type":"string"
        },
        "mapDataCardsSourceField":{
            "title":"mapDataCardsSourceField",
            "description":"",
            "type":"string"
        },
        "name":{
            "title":"name",
            "description":"",
            "type":"string"
        },
        "nullIdentifierFieldName":{
            "title":"nullIdentifierFieldName",
            "description":"",
            "type":"boolean"
        },
        "syncActions":{
            "title":"syncActions",
            "description":"",
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "updatedAt":{
            "format":"date-time",
            "title":"updatedAt",
            "description":"",
            "type":"string"
        },
        "updatedBy":{
            "title":"updatedBy",
            "description":"",
            "type":"string"
        },
        "updateRule":{
            "$ref":"#/definitions/RuleType"
        },
        "updateRuleByField":{
            "title":"updateRuleByField",
            "description":"",
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "uri":{
            "title":"uri",
            "description":"",
            "type":"string"
        }
    }
}

Nested Schema : fields

Type: array

Title: fields

Show Source

• Array of: string

{
    "title":"fields",
    "description":"",
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : syncActions

Type: array

Title: syncActions

Show Source

• Array of: string

{
    "title":"syncActions",
    "description":"",
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : updateRuleByField

Type: array

Title: updateRuleByField

Show Source

• Array of: string

{
    "title":"updateRuleByField",
    "description":"",
    "type":"array",
    "items":{
        "type":"string"
    }
}

400 Response

Bad request. See Status Codes for information about other possible HTTP status codes.

401 Response

Unauthorized. See Status Codes for information about other possible HTTP status codes.

403 Response

Forbidden. See Status Codes for information about other possible HTTP status codes.

404 Response

The requested resource was not found. See Status Codes for information about other possible HTTP status codes.

409 Response

There was a conflict. See Status Codes for information about other possible HTTP status codes.

410 Response

The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes.

412 Response

The resource you are attempting to delete has dependencies, and cannot be deleted. See Status Codes for information about other possible HTTP status codes.

413 Response

Storage space exceeded. See Status Codes for information about other possible HTTP status codes.

500 Response

The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes.

503 Response

There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes.

Back to Top

Examples

Update the export definition with the id #14 for the event with id #12:

PUT /events/12/imports/14
Content-Type: application/json 
			

Request body:

{
  "name": "Winter 2016 Fall Fashion Show Event Import",
  "fields": {
    "job_role": "{{Event[12].Field[58]}}"
  },
  "identifierFieldName": "job_role",
  "isSyncTriggeredOnImport": "false"
}
			

Response:

{
  "id": 14,
  "parentId": 12,
  "mapDataCardsCaseSensitiveMatch": false,
  "name": "Winter 2016 Fall Fashion Show Event Import",
  "fields": {
    "job_role": "{{Event[12].Field[58]}}"
  },
  "identifierFieldName": "job_role",
  "syncActions": [],
  "isSyncTriggeredOnImport": false,
  "dataRetentionDuration": "P7D",
  "kbUsed": 1,
  "isUpdatingMultipleMatchedRecords": false,
  "uri": "/events/12/imports/14",
  "createdBy": "API.User",
  "createdAt": "2016-11-24T15:54:26.6700000Z",
  "updatedBy": "API.User",
  "updatedAt": "2016-11-24T16:35:14.7754951Z"
}
			

Back to Top