Skip to Content

Data Schemas

Introduction

This page provides data schemas for these Jitterbit App Builder connector activities:

Update Activity

Update Activity Request Schema

Request Schema Node/Field Description
updateRecordsRequest The request to update records in App Builder.
request The node representing the request.
schemaRequest The node representing the schema request.
record A dynamic object containing the fields that can be updated for an existing record. The fields listed here are system fields present in every module that will not be updated in App Builder directly by this request.
id The ID of the record.
external_id The external ID of the record.
owner The ID of the owner of the item.
deleted A flag indicating whether or not the item is deleted.
created_at When the item was created.
created_by The ID of the creator of the item.
updated_at When the item was last updated.
updated_by The ID of the last user who updated the item.
ids An array of the IDs of the records to be updated. Bulk updates can be done in a single query if more than one ID is present.
external_ids An array of the external IDs of the records to be updated. Bulk updates can be done in a single query if more than one ID is present.
module The system name of the module for records to be updated in. For example: p_employees_d for the Employees module.
runWorkflows Whether or not microflows associated with the module should run after the records are updated.

Update Activity Response Schema

Response Schema Node/Field Description
updateRecordsResponse The response from updating records in App Builder.
response The node representing the response.
schemaResponse The node representing the schema response.
item The node containing response messages.
status_code A code associated with the response.
isUpdated A boolean indicating if the update request was successful.
message A message associated with the response.

Delete Activity

Delete Activity Request Schema

Request Schema Node/Field Description
deleteRecordsRequest The request to delete records from App Builder.
request The node representing the request.
ids The IDs of the records to be deleted.
module The system name of the module for records to be deleted from. For example: p_employees_d for the Employees module.

Delete Activity Response Schema

Response Schema Node/Field Description
deleteRecordsResponse The response from deleting records in App Builder.
response The node representing the response.
schemaResponse The node representing the schema response.
item The node containing response messages.
status_code A code associated with the response.
isDeleted A boolean indicating if the delete request was successful.
message A message associated with the response.

Create Activity

Create Activity Request Schema

Request Schema Node/Field Description
createRecordsRequest The request to create records in App Builder.
request The node representing the request.
schemaRequest The node representing the schema request.
item A dynamic object containing the fields that can entered for a new record. The fields listed here are system fields present in every module that will not be added in App Builder directly by this request.
id The ID of the item to be added as a record.
owner The ID of the owner of the item.
deleted Whether or not the item is deleted.
created_at When the item was created.
created_by The ID of the creator of the item.
updated_at When the item was last updated.
updated_by The ID of the last user who updated the item.
module The system name of the module for records to be created in. For example: p_employees_d for the Employees module.
runWorkflows Whether or not microflows associated with the module should run after the records are created.

Create Activity Response Schema

Response Schema Node/Field Description
createRecordsResponse The response from creating records in App Builder.
response The node representing the response.
schemaResponse The node representing the schema response.
item The node containing each created record.
... A dynamic list of fields associated with the module.
errors The node representing response errors.
item The node containing response error messages.
errorMessage A message associated with the error.
errorCode A code assosciated with the error.

Query Activity

Query Activity Request Schema

Request Schema Node/Field Description
queryRecordsRequest The request to query records from App Builder.
request The node representing the request.
deleted Allows deleted records to appear in the query response when set to True. The accepted values are True or False.
fields Limits the query response to the fields specified. All fields in the module are returned in the query response when nothing is set here. For example: [name, birthdate].
filters Allows the records in modules to be filtered by one or more conditions defined in this array. Each item in the array is treated as a filter object.
item The node representing an item in the filters array.

Caution

Some of this node's fields are required (as noted in each field description below) despite the cardinality keys indicating that the fields are optional. Not including all required fields will result in an Internal Server Error with a 500 code.
no Required in a filters item. The integer manually assigned to conditions added by the user. It is recommended to increase the number for each condition added in order, starting from 1. This number is used with the filter_logic field.
field Required in a filters item. The system name of the field where the condition will be added.
value Required in a filters item. The condition value of the field to be filtered. If dropdown fields are queried, the system name of the dropdown item should be used. Text field example: John. Dropdown example: p_approved.
operator Required in a filters item. The query operator to be used on values in the filtered field. Operator selections differ depending on the type of field being queried based on the Query Operators for the filter_logic and operator Fields table below. For example: equals, contains, start_with.
document_search Deprecated.
filter_logic Allows the criteria added to filters to be expressed as a condition with query operators. For example: ((1 or 2) and 3). If this field is left empty, the criteria in filters will be automatically connected based on logic_type. All available query operators are listed in the Query Operators for the filter_logic and operator Fields table below.
filter_lookup_type Allows lookups in the modules to be filtered against 1 (all records) or by 2 (Organization in the Employees module). 2 is set by default. This helps keeps lookup information relevant.
group_by The system name of the field to group query results by. All field types can be grouped except MultiselectLookup and MultiSelectDropdown. For example: approval_status.
group_field_date_type

Required if group_by is defined. If a group_by definition is made for a Date type field in the request, this field must be used. One of five different grouping options must be chosen:

  • 0 (Not Set): Allows the field with a type other than Date, Datetime, and Time to be grouped.
  • 1 (All): Allows the date field to be grouped by the entire date up to the time.
  • 2 (Year): Allows the date field to be grouped by year.
  • 3 (Year and Month): Allows the date field to be grouped by year and month.
  • 4 (Year, Month, and Day): Allows the date field to be grouped by year, month and day.
group_field_date_type2

Required if group_by is defined. If a group_by definition is made for a Date type field in the request, this field must be used. One of five different grouping options must be chosen:

  • 0 (Not Set): Allows the field with a type other than Date, Datetime, and Time to be grouped.
  • 1 (All): Allows the date field to be grouped by the entire date up to the time.
  • 2 (Year): Allows the date field to be grouped by year.
  • 3 (Year and Month): Allows the date field to be grouped by year and month.
  • 4 (Year, Month, and Day): Allows the date field to be grouped by year, month and day.
is_lookup_find_id Deprecated.
limit Limits the query response to a specific number of records. For example: When 100 is set here, only the first 100 records found in the query result are transmitted.
locale Specifies which format and language Date, Datetime and Dropdown items will appear as. Dropdown item translations are configured in the Globalization page in App Builder. Date and Datetime formats by language are shown in the Language Codes and Datetime Formats for the locale Field table below.
logic_type If the filter_logic field is left empty, the criteria in filters will be automatically connected based on this field. The accepted values are 1 (and) or 2 (or). 1 is set by default.
many_to_many The system name of a module connected to the one defined in module using an App Builder Relation. For example: p_equipment_d. If defined, the query will pull additional information from this module based on its connection to module, similar to a JOIN in SQL.
many_to_many_table_name The name of the intermediate table created between the module and many_to_many modules (if defined) through an App Builder Relation. This table is not a module and is not visible in the App Builder interface. The name of this table is the combination of the lowercase names of the two related modules with an underscore in between them. For example: module1name_module2name.
module Required. The system name of the module to query. For example: p_employees_d for the Employees module.
offset Deprecated.
sort_direction Allows the sort_field field to be sorted in ascending or descending order. The accepted values are asc or desc respectively.
sort_direction_alt_type Allows the sort_field2 field to be sorted in ascending or descending order. The accepted values are asc or desc respectively.
sort_field The system name of the field to sort the queried records by. For example: created_at.
sort_field2 The system name of the field to sort the queried records by after they have been sorted with sort_field. For example: created_at.
sort_field_type The system name of the field to sort the queried records based on the grouping settings defined in group_by and group_field_date_type. For example: approval_status.
sort_field_type2 The system name of the field to sort the queried records based on the grouping settings defined in group_by and group_field_date_type2. For example: approval_status.
timezoneOffset Offsets times in the query response from Coordinated Universal Time (UTC) by the number of minutes defined here. For example: 180 or -240.
two_way Required if many_to_many is defined. Used as part of validating an App Builder Relation. Its value should always be false.

Query Activity Response Schema

Response Schema Node/Field Description
queryRecordsResponse The response from querying records in App Builder.
response The node representing the response.
schemaResponse The node representing the schema response.
item The node containing each record returned from the query.
... A dynamic list of fields associated with the module.
errors The node representing response errors.
item The node containing response error messages.
errorMessage A message associated with the error.
errorCode A code associated with the error.

Query Operators for the filter_logic and operator Fields

Operator Description
is Finds records with a field value that matches a specified value. For example: Approval Status is Approved returns records marked as Approved in their Approval Status field.
is_not Finds records with a field value that does not match a specified value. For example: Approval Status is_not Approved returns records that are not marked as Approved in their Approval Status field.
contains Finds records with a field value that contains a specified value. For example: Full Name contains John returns records with John in their Full Name field.
not_contain Finds records with a field value that does not contain a specified value. For example: Full Name not_contain John returns records without John in their Full Name field.
starts_with Finds records with a field value that starts with a specified value. For example: Email starts_with test returns records with email addresses in their Email field that start with test.
ends_with Finds records with a field value that ends with a specified value. For example: Email ends_with @gmail.com returns records with email addresses in their Email field that end with @gmail.com.
empty Find records with an empty field value. For example: Email empty returns records with an empty Email field.
not_empty Find records without an empty field value. For example: Email not_empty returns records with values in their Email field.
equals Finds records with numeric or boolean field values that equal a specified value. For example: Price equals 100 returns records with a Price field value of 100.
not_equal Finds records with numeric or boolean field values that do not equal a specified value. For example: Price not_equal 100 returns records without a Price field value of 100.
greater Finds records with numeric field values that are greater than a specified value. For example: Age greater 20 returns records with an Age field value above, but not including 20.
greater_equal Finds records with numeric field values that are greater than or equal a specified value. For example: Age greater_equal 20 returns records with an Age field value 20 and above.
less Finds records with numeric field values that are greater than a specified value. For example: Age less 20 returns records with an Age field value below, but not including 20.
less_equal Finds records with numeric field values that are greater than or equal a specified value. For example: Age less_equal 20 returns records with an Age field value 20 and below.

Supported App Builder Fields Per Operator

Operator Text
(Single-Line)		 Text
(Multi-Line)		 Email URL Number Number
(Auto)		 Number
(Decimal)		 Currency Rating Dropdown Multiselect
dropdown		 Lookup Multiselect
lookup		 Checkbox Tag Date Date/Time Time File Upload Location Image
contains
not_contain
is
is_not
starts_with
ends_with
empty
not_empty
equals
not_equal
greater
greater_equal
less
less_equal
is_in
is_not_in

Language Codes and Datetime Formats for the locale Field

Language Language Code Datetime Format
Afrikaans AF yyyy-MM-dd HH:mm
Albanian SQ d.M.yyyy h:mm tt
Arabic AR dd/MM/yyyy hh:mm tt
Azerbaijani AZ dd.MM.yyyy H:mm
Basque EU yyyy/M/d HH:mm
Belarusian BE dd.MM.yy HH:mm
Bengali BN d/M/yyyy h:mm tt
Bulgarian BG d.M.yyyy H:mm
Catalan CA d/M/yyyy H:mm
Chinese ZH yyyy/M/d H:mm
Croatian HR d.M.yyyy. H:mm
Czech CS dd.MM.yyyy H:mm
Danish DA dd-MM-yyyy HH:mm
Dutch NL dd-MM-yyyy HH:mm
English EN M/d/yyyy h:mm tt
Esperanto EO yyyy-MM-dd HH:mm
Estonian ET dd.MM.yyyy HH:mm
Filipino TI dd/MM/yyyy h:mm tt
Finnish FI d.M.yyyy H.mm
French FR dd-MM-yy HH:mm
Galician GL dd/MM/yyyy HH:mm
Georgian KA dd.MM.yyyy HH:mm
German DE dd.MM.yyyy HH:mm
Gujarati GU dd-MM-yy HH:mm
Greek EL d/M/yyyy h:mm tt
Hindi HI dd-MM-yyyy HH:mm
Hungarian HU yyyy.MM.dd. H:mm
Icelandic IS d.M.yyyy HH:mm
Indonesian ID dd/MM/yyyy HH.mm
Irish GA dd/MM/yyyy HH:mm
Italian IT dd.MM.yyyy HH:mm
Japanese JA yyyy/MM/dd H:mm
Kannada KN dd-MM-yy HH:mm
Khmer KM dd/MM/yy H:mm
Korean KO yyyy.M.d. tt h:mm
Lao LO d/M/yyyy H:mm
Latvian LV dd.MM.yyyy HH:mm
Lithuanian LT yyyy-MM-dd HH:mm
Macedonian MK dd.M.yyyy HH:mm
Malay MS d/MM/yyyy h:mm tt
Maltese MT dd/MM/yyyy HH:mm
Marathi MR dd-MM-yyyy HH:mm
Norwegian NO dd.MM.yyyy HH:mm
Persian FA dd/MM/yyyy hh:mm tt
Polish PL dd.MM.yyyy HH:mm
Portuguese PT dd/MM/yyyy HH:mm
Romanian RO dd.MM.yyyy HH:mm
Russian RU dd.MM.yyyy HH:mm
Slovak SK d.M.yyyy H:mm
Slovenian SL d.MM.yyyy HH:mm
Spanish ES d/M/yyyy HH:mm
Swahili SW dd/MM/yyyy HH:mm
Swedish SV yyyy-MM-dd HH:mm
Tamil TA dd-MM-yyyy HH:mm
Telugu TE dd-MM-yy HH:mm
Thai TH d/M/yyyy H:mm
Turkish TR dd.MM.yyyy HH:mm
Urdu UR d/M/yy h:mm tt
Vietnamese VI dd/MM/yyyy h:mm tt
Welsh CY dd/MM/yyyy HH:mm
Yiddish YI dd/MM/yyyy HH:mm