{
"sections": [
"title",
"description",
"fields",
"associated_objects",
"wsdl_segment",
"field_reference"
],
"title": "DynamicDataCapture - Data API",
"description": "DynamicDataCapture is a junction object that adds a Form tab to Work Order Overview, and to the related list of a work order, work order line item, or service appointment in the Field Service mobile app. This object is available in API version 62.0 and later.",
"fields_columns": [
"type",
"properties",
"description",
"relationship_name",
"refers_to",
"relationship_type"
],
"fields": {
"ActionDefinition": {
"type": "string",
"properties": "Create, Filter, Group, Sort, Update",
"description": "The associated Data Capture Flow to execute."
},
"ActionType": {
"type": "picklist",
"properties": "Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update",
"description": "The type of platform action that the form is associated with. Possible values are: Possible values are: Flow The default value is Flow."
},
"Description": {
"type": "textarea",
"properties": "Create, Filter, Group, Nillable, Sort, Update",
"description": "The description of the form."
},
"ExecutionOrder": {
"type": "int",
"properties": "Create, Filter, Group, Nillable, Sort, Update",
"description": "The order in which the Data Capture flow is executed. Positive integer values or null are supported."
},
"IsRequired": {
"type": "boolean",
"properties": "Create, Defaulted on create, Filter, Group, Sort, Update",
"description": "Boolean value that specifies if this form needs to be completed before moving on to the next form."
},
"LastReferencedDate": {
"type": "dateTime",
"properties": "Filter, Nillable, Sort",
"description": "The order in which the Data Capture flow is executed. Positive integer values or null are supported."
},
"Name": {
"type": "string",
"properties": "Create, Filter, Group, idLookup, Sort, Update",
"description": "The name of the form."
},
"OwnerId": {
"type": "reference",
"properties": "Create, Defaulted on create, Filter, Group, Sort, Update",
"description": "The ID that refers to user who owns the Dynamic Data Capture object. This field is a polymorphic relationship field.",
"relationship_name": "Owner",
"refers_to": "ServiceAppointment, WorkOrder, WorkOrderLineItem (the parent object), Timesheet"
},
"ParentRecordId": {
"type": "reference",
"properties": "Create, Filter, Group, Sort",
"description": "The ID that refers to a work order, work order line item, or service appointment that serves as the parent record for junction object. This field is a polymorphic relationship field.",
"relationship_name": "ParentRecord",
"relationship_type": "Parent-child",
"refers_to": "ServiceAppointment, WorkOrder, WorkOrderLineItem (the parent object)"
},
"ParentRecordType": {
"type": "string",
"properties": "Filter, Group, Nillable, Sort",
"description": "The type of parent object associated with the junction object. Possible values are: Work Order Work Order Line Item Service Appointment"
},
"PausedFlowInterviewId": {
"type": "reference",
"properties": "Create, Filter, Group, Nillable, Sort, Update",
"description": "The ID of the flow interview that has been paused by a user. This field is a relationship field.",
"relationship_name": "PausedFlowInterview",
"refers_to": "FlowInterview"
},
"ProcessType": {
"type": "picklist",
"properties": "Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update",
"description": "The flow process type for the form. Possible values are: DataCaptureFlow—Data Capture Flow The default value is DataCaptureFlow."
},
"ServiceDocumentTemplate": {
"type": "string",
"properties": "Create, Filter, Group, Nillable, Sort, Update"
},
"ServiceReportLanguage": {
"type": "picklist",
"properties": "Create, Filter, Group, Nillable, Restricted picklist, Sort, Update"
},
"StatusCategory": {
"type": "picklist",
"properties": "Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update",
"description": "The category that each status value belongs to. Possible values are: Completed InProgress—In Progress New NotApplicable—Not Applicable Paused The default value is New."
}
},
"associated_objects": "This object has the following associated objects. If the API version isn’t specified, they’re available in the same API versions as this object. Otherwise, they’re available in the specified API version and later.\n\n- **DynamicDataCaptureChangeEvent(API Version 64.0)**: Change events are available for the object.\n- **DynamicDataCaptureOwnerSharingRule (API Version 64.0)**: Sharing rules are available for the object.\n- **DynamicDataCaptureShare (API Version 64.0)**: Sharing is available for the object.",
"wsdl_segment": "```xml\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n\n\n \n \n \n \n\n\n \n\n\n \n \n \n \n \n \n\n```",
"field_reference": {
"ActionDefinition": {
"field_label": "Action Definition",
"type": "string",
"length": "255"
},
"ActionType": {
"field_label": "Action Type",
"type": "picklist",
"length": "255"
},
"CreatedById": {
"field_label": "Created By ID",
"type": "reference",
"length": "18"
},
"CreatedDate": {
"field_label": "Created Date",
"type": "datetime"
},
"CurrencyIsoCode": {
"field_label": "Currency ISO Code",
"type": "picklist",
"length": "3"
},
"Description": {
"field_label": "Description",
"type": "textarea",
"length": "255"
},
"ExecutionOrder": {
"field_label": "Execution Order",
"type": "int",
"digits": "9"
},
"Id": {
"field_label": "Form ID",
"type": "id",
"length": "18"
},
"IsDeleted": {
"field_label": "Deleted",
"type": "boolean"
},
"IsRequired": {
"field_label": "Required",
"type": "boolean"
},
"LastModifiedById": {
"field_label": "Last Modified By ID",
"type": "reference",
"length": "18"
},
"LastModifiedDate": {
"field_label": "Last Modified Date",
"type": "datetime"
},
"LastReferencedDate": {
"field_label": "Last Referenced Date",
"type": "datetime"
},
"LastViewedDate": {
"field_label": "Last Viewed Date",
"type": "datetime"
},
"Name": {
"field_label": "Name",
"type": "string",
"length": "255"
},
"OwnerId": {
"field_label": "Owner ID",
"type": "reference",
"length": "18"
},
"ParentRecordId": {
"field_label": "Parent Record ID",
"type": "reference",
"length": "18"
},
"ParentRecordType": {
"field_label": "Parent Record Type",
"type": "string",
"length": "50"
},
"PausedFlowInterviewId": {
"field_label": "Paused Flow Interview ID",
"type": "reference",
"length": "18"
},
"ProcessType": {
"field_label": "Process Type",
"type": "picklist",
"length": "255"
},
"StatusCategory": {
"field_label": "Status",
"type": "picklist",
"length": "255"
},
"SystemModstamp": {
"field_label": "System Modstamp",
"type": "datetime"
}
},
"field_reference_columns": [
"field_label",
"type",
"length",
"digits"
]
}