openapi: 3.1.0 info: description: |- The main advantage in this version (v60) is the ability to let users define the response. By only requesting key information, you can more efficiently use resources instead of retrieving a full API feed, and parsing out unused fields. This approach can be used with any resource that doesn't specify an ID, such as a list of elements or users. The documentation is broken down into resource categories and you can see formatted code samples for various languages in the console on the right.

General Notes:

  • Most list based requests will return a maximum of 100 objects per request (Users, Assignments, Pages, Localizations, etc...) where as records and options will return up to 1000.
  • Default response will be returned when invalid grammar is passed into the request.
  • Field grammar can include filters (single or multiple conditions) and sort order.

    • Using Parameters

  • Parameters will allow you to refined the request and consist of the following:
  • fields: Allow you to specify which attributes are returned. Filter and sort priority can be assigned to each field.
  • limit: Allow you to specify how many results are returned.
  • offset: Allow you to specify number of results to skip.
  • For example, this url would only provide the record ids.
    https://www.iformbuilder.com/exzact/api/v60/profiles/10978/pages/290749032/records
  • This example demonstrates returning first name, last name, age, and state. This will also skip the first record only display 2 after that.
    https://www.iformbuilder.com/exzact/api/v60/profiles/10978/pages/290749032/records?fields=first_name,last_name,residing_state,age&offset=1&limit=2
  • You can also specify which subform fields you want. In this example, we will have a subform called 'children_subform' with some fields in it.
    https://www.iformbuilder.com/exzact/api/v60/profiles/10978/pages/290749032/records?fields=first_name,last_name,residing_state,age,children_subform[child_name,child_age,child_height]&offset=1&limit=2

    • Sorting Fields:

  • To sort by column(s), there are three components:
  • Column: The field you want to sort by
  • Operator: These consist of < (ascending) and > (descending)
  • Sort Priority: When sorting by multiple columns, you set priority by designating a number after the operator.
  • In this example, age has first priority in ascending order followed by first name in descending order.
    https://www.iformbuilder.com/exzact/api/v60/profiles/10978/pages/290749032/records?fields=first_name:>2,age:<1

    • Filtering Fields:

    Adding filters will narrow down your request output or input. This can be used with both GET and PUT requests.
    GET: Will return any data that meets your filter’s rules.
    PUT: Instead of updating a specific record, update many records that match the filter. For example, changing everyone who is now over 18 from child to an adult.

  • Three Components of Filtering
  • Column: The field you want to filter
  • Operator: These consist of <, <=, >, >=, = and ~
  • Value:The value you are basing your filter on. Boolean values can be passed in either as true and false, or 0 and 1.
  • Examples
  • Get everyone who is between 18 AND 65 (Note: the '&' symbol may need to be url encoded which is '%26')
    age((>="18")&(<="65"))

    or encoded
    age((>="18")%26(<="65"))
  • Get everyone that is younger than 18 OR older than 65
    age((>="18")|(<="65"))
  • Get all first names that start with 'K'
    first_name(~"K%")
  • Get all last names that end with 'son'
    last_name(~"%son")
  • Get all middle names that contain 'mit'
    middle_name(~"%mit%")
  • Now combining 4 examples above in a URL.
    https://www.iformbuilder.com/exzact/api/v60/profiles/10978/pages/290749032/records?fields=age((>="18")|(<="65")),first_name(~"K%"),last_name(~"%son"),middle_name(~"%mit%")
  • Note: If trying to filter a field that is like a certain value that starts with a number, you have url encode the '%' symbol, otherwise the api will fail. If you wanted to search for a value that starts with 12 for exmaple:
    https://www.iformbuilder.com/exzact/api/v60/profiles/10978/pages/290749032/records?fields=length(~"%2512")
  • Filter Multiple Fields with
  • To search a value inside multiple fields, you can use dashes to search multiple columns of the same value.
  • Note: When filtering with multiple fields, this needs to be at the beginning of the search criteria. Also, exact value searches will not work. For example,
  • Get all first names OR last names that start with 'K'
    first_name-last_name(~"K%")
  • Searching Multiple Specific Values
  • This will allow you to pass in multiple specifc values you want the query to return. Form example,
  • Get both records for ids 12345 AND 98765
    id(="12345"|="98765")

    • Making API Requests

  • To make requests to the API, you must obtain an access token. To obtain an a valid access token, click on the link below to get started.
  • Generating Access Token
    • title: iFormBuilder API v6.0 version: '' servers: - url: https://servername.iformbuilder.com/exzact/api/v60/ paths: /profiles: get: operationId: get-profiles summary: Retrieve a List of Profiles description: '' parameters: - name: fields in: query description: extra information of each profile on the list required: false schema: type: string - name: limit in: query description: maximum count of the profile list required: false schema: type: number example: '100' - name: offset in: query description: skip that many profiles before beginning to return required: false schema: type: number example: '0' responses: '200': description: OK headers: Total-Count: schema: type: string content: '*/*': schema: type: object properties: address_1: type: string address_2: type: string city: type: string country: type: string created_date: type: string email: type: string fax: type: string global_id: type: string id: type: number is_active: type: boolean max_page: type: number max_user: type: number name: type: string phone: type: string state: type: string support_hours: type: number time_zone: type: string type: type: number version: type: number zip: type: string required: - id - name security: - oauth2: [] tags: - Profile Resource post: operationId: post-profiles summary: Create a New Profile description: '' requestBody: content: application/json: schema: type: object properties: address_1: type: string examples: - 13665 Dulles Technology Dr., Suite 110 address_2: type: string city: type: string examples: - Herndon country: type: string examples: - USA email: type: string examples: - support@iformbuilder.com fax: type: string is_active: type: boolean examples: - true max_page: type: number examples: - 100 max_user: type: number examples: - 10 name: type: string examples: - iFormBuilder phone: type: string examples: - 1-866-ZERION-1 state: type: string examples: - VA time_zone: type: string zip: type: string examples: - '20171' required: - name - email - max_user - max_page - is_active responses: '201': description: Created headers: {} content: application/json: examples: response: value: id: 161521 schema: type: object properties: id: description: the created profile id type: number required: - id security: - oauth2: [] tags: - Profile Resource /profiles/{profile_id}: get: operationId: get-profiles-profile-id summary: Retrieve a Profile description: '' parameters: - name: profile_id in: path description: id of the profile required: true schema: type: string example: self responses: '200': description: OK headers: {} content: application/json: examples: response: value: address1: 13665 Dulles Technology Dr., Suite 110 address2: '' city: Herndon country: USA created_date: 2015-04-21T14:33:58+00:00 email: support@iformbuilder.com fax: null global_id: 0CP161521H14C19 id: 161521 is_active: true max_page: 100 max_user: 10 name: iFormBuilder phone: 1-866-ZERION-1 state: VA support_hours: 0 time_zone: null type: -1 version: 1 zip: '20171' schema: type: object properties: address_1: type: string address_2: type: string city: type: string country: type: string created_date: type: string email: type: string fax: type: string global_id: type: string id: type: number is_active: type: boolean max_page: type: number max_user: type: number name: type: string phone: type: string state: type: string support_hours: type: number time_zone: type: string type: type: number version: type: number zip: type: string required: - id - name - global_id - version - address1 - address2 - city - zip - state - country - phone - fax - email - max_user - max_page - is_active - created_date - type - support_hours - time_zone security: - oauth2: [] tags: - Profile Resource put: operationId: put-profiles-profile-id summary: Update a Profile description: '' parameters: - name: profile_id in: path description: id of the profile required: true schema: type: string example: self requestBody: content: application/json: schema: type: object properties: address_1: type: string examples: - 13665 Dulles Technology Dr., Suite 110 address_2: type: string city: type: string examples: - Herndon country: type: string examples: - USA email: type: string examples: - support@iformbuilder.com fax: type: string is_active: type: boolean examples: - true max_page: type: number examples: - 100 max_user: type: number examples: - 10 name: type: string examples: - iFormBuilder phone: type: string examples: - 1-866-ZERION-1 state: type: string examples: - VA time_zone: type: string zip: type: string examples: - '20171' responses: '200': description: OK headers: {} content: application/json: examples: response: value: id: 161521 schema: type: object properties: id: description: the updated profile id type: number required: - id security: - oauth2: [] tags: - Profile Resource /profiles/{profile_id}/company_info: get: operationId: get-profiles-profile-id-company-info summary: Retrieve Company Info description: '' parameters: - name: profile_id in: path description: id of the profile required: true schema: type: string example: self responses: '200': description: OK headers: {} content: '*/*': schema: type: object properties: addl_users_flg: type: number app_idle_timeout: type: number background_2_link: type: string backgroundfilepath: type: string backgroundlink: type: string base_color: type: string button_text_color: type: string donebutton_link: type: string dropbox_access_token: type: string dropbox_media: type: string dropbox_struct: type: number dropbox_token_secret: type: string dropbox_user_id: type: number enable_button_text_color: type: number faqurl: type: string homemessage: type: string homemessageurl: type: string last_updated: type: string media_location: type: number name: type: string profile_id: type: number records_downloads_size: type: number rsa_pub_key: type: string show_submit_button: type: number signup_field: type: number signup_source: type: string splash_link: type: string syncbutton_link: type: string text_color: type: string text_hl_color: type: string title: type: string top_text_color: type: string version: type: number webform_flg: type: number required: - profile_id - name - version - title - homemessage - backgroundfilepath - faqurl - homemessageurl - backgroundlink - last_updated - app_idle_timeout - splash_link - donebutton_link - syncbutton_link - base_color - top_text_color - text_color - text_hl_color - background2_link - rsa_pub_key - dropbox_access_token - dropbox_token_secret - dropbox_user_id - dropbox_media - dropbox_struct - media_location - records_downloads_size - addl_users_flg - button_text_color - show_submit_button - enable_button_text_color - signup_source - signup_field - webform_flg security: - oauth2: [] tags: - Profile Resource put: operationId: put-profiles-profile-id-company-info summary: Update Company Info description: '' parameters: - name: profile_id in: path description: id of the profile required: true schema: type: string example: self responses: '200': description: OK headers: {} content: application/json: examples: response: value: profile_id: 161521 schema: type: object properties: id: description: the updated profile id type: number required: - id security: - oauth2: [] tags: - Profile Resource /profiles/{profile_id}/licenses: get: operationId: get-profiles-profile-id-licenses summary: Retrieve a List of Device Licenses description: '' parameters: - name: profile_id in: path description: id of the profile required: true schema: type: string example: self - name: fields in: query description: extra information of each user on the list required: false schema: type: string - name: limit in: query description: maximum count of the user list required: false schema: type: number example: '100' - name: offset in: query description: skip that many users before beginning to return required: false schema: type: number example: '0' responses: '200': description: OK headers: Total-Count: schema: type: string content: application/json: examples: response: value: - device_id: d174b4c64f6f358a3b19bfca4558eb1d9d3e265f id: 161236 username: demo_user - device_id: d174b4c64f6f358a3b19bfca4558eb1d9d3e265f id: 161236 username: demo_user - device_id: d174b4c64f6f358a3b19bfca4558eb1d9d3e265f id: 161242 username: inspector_2 schema: type: object properties: application_name: type: string application_version: type: string device_id: type: string device_last_login_date: type: string devicelastloginuser_demouser: type: string device_model: type: string device_notification_token: type: string device_system_version: type: string id: type: number username: type: string required: - id - username - device_id security: - oauth2: [] tags: - Device License Resource /profiles/{profile_id}/licenses/{license_id}: get: operationId: get-profiles-profile-id-licenses-license-id summary: Retrieve a Device License description: '' parameters: - name: profile_id in: path description: id of the profile required: true schema: type: string example: self - name: license_id in: path description: id of the device license required: true schema: type: string example: '198392' responses: '200': description: OK headers: {} content: application/json: examples: response: value: application_name: iForm application_version: 8.32.0 device_id: d174b4c64f6f358a3b19bfca4558eb1d9d3e265f device_last_login_date: 2019-05-23T15:52:15+00:00 device_last_login_user: demo_user device_model: iPad Pro device_notification_token: 78f48ac3 6765c07c 0d53bbd7 97d6b61b 0e9d50ee e5d7522e 06bb8787 870e26fb device_system_version: 12.1.1 id: 196111 username: demo_user schema: type: object properties: application_name: type: string application_version: type: string device_id: type: string device_last_login_date: type: string devicelastloginuser_demouser: type: string device_model: type: string device_notification_token: type: string device_system_version: type: string id: type: number username: type: string required: - id - username - device_id - 'device_last_login_user: `demo_user`' - device_last_login_date - device_notification_token - device_model - device_system_version - application_name - application_version security: - oauth2: [] tags: - Device License Resource /profiles/{profile_id}/media?URL={media_url}: get: operationId: get-profiles-profile-id-media-url-media-url summary: Get Media description: '' responses: '200': description: OK headers: {} security: - oauth2: [] tags: - Private Media Resource /profiles/{profile_id}/notifications: post: operationId: post-profiles-profile-id-notifications summary: Send Notifications description: '' requestBody: content: application/json: schema: type: object properties: message: type: string examples: - Please sync to update form users: type: array items: {} required: - message - users responses: '201': description: Created headers: {} content: '*/*': schema: type: object properties: id: description: the created user id type: number required: - id security: - oauth2: [] tags: - Notification Resource /profiles/{profile_id}/optionlists: get: operationId: get-profiles-profile-id-optionlists summary: Retrieve a List of Optionlists description: '' parameters: - name: profile_id in: path description: id of the profile required: true schema: type: string example: self - name: fields in: query description: extra information of each profile on the list required: false schema: type: string - name: limit in: query description: maximum count of the profile list required: false schema: type: number example: '100' - name: offset in: query description: skip that many profiles before beginning to return required: false schema: type: number example: '0' responses: '200': description: OK headers: Total-Count: schema: type: string content: application/json: examples: response: value: - id: 393652 name: Colors - id: 393655 name: System Grade schema: type: object properties: created_by: type: string created_date: type: string global_id: type: string id: type: number modified_by: type: string modified_date: type: string name: type: string option_icons: type: string reference_id: type: string version: type: number required: - id - name security: - oauth2: [] tags: - Optionlist Resource post: operationId: post-profiles-profile-id-optionlists summary: Create New a New Optionlist description: '' parameters: - name: profile_id in: path description: id of the profile required: true schema: type: string example: self requestBody: content: application/json: schema: type: object properties: name: type: string examples: - System Grade option_icons: type: string examples: - dropbox://iForm reference_id: type: string required: - name responses: '201': description: Created headers: {} content: application/json: examples: response: value: id: 393655 schema: type: object properties: id: description: the created option list id type: number required: - id security: - oauth2: [] tags: - Optionlist Resource /profiles/{profile_id}/optionlists/{optionlist_id}: copy: consumes: [] produces: - application/json parameters: - name: profile_id in: path description: id of the profile required: true type: string x-example: self - name: optionlist_id in: path description: id of the optionlist required: true type: number responses: '201': description: Created headers: {} examples: application/json: id: 393658 schema: type: object properties: id: description: the copied optionlist id type: number required: - id security: - oauth2: [] tags: - Optionlist Resource description: '' operationId: copy-profiles-profile-id-optionlists-optionlist-id summary: Copy an Optionlist delete: operationId: delete-profiles-profile-id-optionlists-optionlist-id summary: Delete an Optionlist description: '' parameters: - name: profile_id in: path description: id of the profile required: true schema: type: string example: self - name: optionlist_id in: path description: id of the optionlist required: true schema: type: number responses: '200': description: OK headers: {} content: application/json: examples: response: value: id: 393655 schema: type: object properties: id: description: the deleted optionlist id type: number required: - id security: - oauth2: [] tags: - Optionlist Resource get: operationId: get-profiles-profile-id-optionlists-optionlist-id summary: Retrieve an Optionlist description: '' parameters: - name: profile_id in: path description: id of the profile required: true schema: type: string example: self - name: optionlist_id in: path description: id of the optionlist required: true schema: type: number responses: '200': description: OK headers: {} content: application/json: examples: response: value: created_by: cng created_date: 2015-05-12T22:04:03+00:00 global_id: 0OL393655H6488B id: 393655 modified_by: cng modified_date: 2015-05-12T22:08:45+00:00 name: System Grade option_icons: dropbox://iForm reference_id: '' version: 3 schema: type: object properties: created_by: type: string created_date: type: string global_id: type: string id: type: number modified_by: type: string modified_date: type: string name: type: string option_icons: type: string reference_id: type: string version: type: number required: - id - name - global_id - version - created_date - created_by - modified_date - modified_by - reference_id - option_icons security: - oauth2: [] tags: - Optionlist Resource put: operationId: put-profiles-profile-id-optionlists-optionlist-id summary: Update an Optionlist description: '' parameters: - name: profile_id in: path description: id of the profile required: true schema: type: string example: self - name: optionlist_id in: path description: id of the optionlist required: true schema: type: number requestBody: content: application/json: schema: type: object properties: name: type: string examples: - System Grade option_icons: type: string examples: - dropbox://iForm reference_id: type: string responses: '200': description: OK headers: {} content: application/json: examples: response: value: id: 393655 schema: type: object properties: id: description: the updated optionlist id type: number required: - id security: - oauth2: [] tags: - Optionlist Resource /profiles/{profile_id}/optionlists/{optionlist_id}/options: delete: operationId: delete-profiles-profile-id-optionlists-optionlist-id-options summary: Delete a List of Options description: '' parameters: - name: profile_id in: path description: id of the profile required: true schema: type: string example: self - name: optionlist_id in: path description: id of the option list required: true schema: type: number - name: fields in: query description: extra information of each profile on the list required: false schema: type: string - name: limit in: query description: maximum count of the profile list required: false schema: type: number example: '100' - name: offset in: query description: skip that many profiles before beginning to return required: false schema: type: number example: '0' requestBody: content: application/json: schema: type: object properties: id: type: number examples: - 268623880 responses: '200': description: OK headers: {} content: application/json: examples: response: value: - id: 268623886 - id: 268623880 schema: type: object properties: id: description: the deleted option id type: number required: - id security: - oauth2: [] tags: - Optionlist Resource get: operationId: get-profiles-profile-id-optionlists-optionlist-id-options summary: Retrieve a List of Options description: '' parameters: - name: profile_id in: path description: id of the profile required: true schema: type: string example: self - name: optionlist_id in: path description: id of the option list required: true schema: type: number - name: fields in: query description: extra information of each profile on the list required: false schema: type: string - name: limit in: query description: maximum count of the profile list required: false schema: type: number example: '100' - name: offset in: query description: skip that many profiles before beginning to return required: false schema: type: number example: '0' responses: '200': description: OK headers: Total-Count: schema: type: string content: application/json: examples: response: value: - id: 268623883 key_value: pass - id: 268623886 key_value: fail - id: 268623880 key_value: na schema: type: object properties: condition_value: type: string global_id: type: string id: type: number key_value: type: string label: type: string localizations: {} score: type: number sort_order: type: number required: - id - key_value security: - oauth2: [] tags: - Optionlist Resource post: operationId: post-profiles-profile-id-optionlists-optionlist-id-options summary: Create New Options description: '' parameters: - name: profile_id in: path description: id of the profile required: true schema: type: string example: self - name: optionlist_id in: path description: id of the option list required: true schema: type: number requestBody: content: application/json: schema: type: object properties: condition_value: type: string examples: - 'false' key_value: type: string examples: - na label: type: string examples: - N/A score: type: number sort_order: type: number required: - key_value - label responses: '201': description: Created headers: {} content: application/json: examples: response: value: - id: 268623883 - id: 268623886 schema: type: object properties: id: description: the created option id type: number required: - id security: - oauth2: [] tags: - Optionlist Resource put: operationId: put-profiles-profile-id-optionlists-optionlist-id-options summary: Update a List of Options description: '' parameters: - name: profile_id in: path description: id of the profile required: true schema: type: string example: self - name: optionlist_id in: path description: id of the option list required: true schema: type: number - name: fields in: query description: extra information of each profile on the list required: false schema: type: string - name: limit in: query description: maximum count of the profile list required: false schema: type: number example: '100' - name: offset in: query description: skip that many profiles before beginning to return required: false schema: type: number example: '0' requestBody: content: application/json: schema: type: object properties: condition_value: type: string examples: - 'false' id: type: number examples: - 268623880 key_value: type: string examples: - na label: type: string examples: - N/A score: type: number sort_order: type: number responses: '200': description: OK headers: {} content: application/json: examples: response: value: - id: 268623883 - id: 268623886 - id: 268623880 schema: type: object properties: id: description: the updated option id type: number required: - id security: - oauth2: [] tags: - Optionlist Resource /profiles/{profile_id}/optionlists/{optionlist_id}/options/{option_id}: delete: operationId: delete-profiles-profile-id-optionlists-optionlist-id-options-option-id summary: Delete an Option description: '' parameters: - name: profile_id in: path description: id of the profile required: true schema: type: string example: self - name: optionlist_id in: path description: id of the option list required: true schema: type: number - name: option_id in: path description: id of the option required: true schema: type: number responses: '200': description: OK headers: {} content: application/json: examples: response: value: id: 268623880 schema: type: object properties: id: description: the deleted option id type: number required: - id security: - oauth2: [] tags: - Optionlist Resource get: operationId: get-profiles-profile-id-optionlists-optionlist-id-options-option-id summary: Retrieve an Option description: '' parameters: - name: profile_id in: path description: id of the profile required: true schema: type: string example: self - name: optionlist_id in: path description: id of the option list required: true schema: type: number - name: option_id in: path description: id of the option required: true schema: type: number responses: '200': description: OK headers: {} content: application/json: examples: response: value: condition_value: 'false' global_id: 0O268623880HD6ED5 id: 268623880 key_value: na label: N/A localizations: [] score: 0 sort_order: 0 schema: type: object properties: condition_value: type: string global_id: type: string id: type: number key_value: type: string label: type: string localizations: {} score: type: number sort_order: type: number required: - id - key_value - global_id - label - sort_order - condition_value - score - localizations security: - oauth2: [] tags: - Optionlist Resource put: operationId: put-profiles-profile-id-optionlists-optionlist-id-options-option-id summary: Update an Option description: '' parameters: - name: profile_id in: path description: id of the profile required: true schema: type: string example: self - name: optionlist_id in: path description: id of the option list required: true schema: type: number - name: option_id in: path description: id of the option required: true schema: type: number requestBody: content: application/json: schema: type: object properties: condition_value: type: string examples: - 'false' key_value: type: string examples: - na label: type: string examples: - N/A score: type: number sort_order: type: number responses: '200': description: OK headers: {} content: application/json: examples: response: value: id: 268623880 schema: type: object properties: id: description: the updated option id type: number required: - id security: - oauth2: [] tags: - Optionlist Resource /profiles/{profile_id}/optionlists/{optionlist_id}/options/{option_id}/localizations: delete: operationId: delete-profiles-profile-id-optionlists-optionlist-id-options-option-id-localizations summary: Delete a List of Option Localizations description: '' parameters: - name: profile_id in: path description: id of the profile required: true schema: type: string example: self - name: optionlist_id in: path description: id of the optionlist required: true schema: type: number - name: option_id in: path description: id of the option required: true schema: type: number - name: fields in: query description: extra information of each option localization on the list required: false schema: type: string - name: limit in: query description: maximum count of the option localization list required: false schema: type: number example: '100' - name: offset in: query description: skip that many option localization before beginning to return required: false schema: type: number example: '0' requestBody: content: application/json: schema: type: object properties: language_code: type: string examples: - zh-hans responses: '200': description: OK headers: {} content: application/json: examples: response: value: - language_code: zh-hans - language_code: zh-hant schema: type: object properties: language_code: description: the deleted language code type: string required: - language_code security: - oauth2: [] tags: - Optionlist Resource get: operationId: get-profiles-profile-id-optionlists-optionlist-id-options-option-id-localizations summary: Retrieve a List of Option Localizations description: '' parameters: - name: profile_id in: path description: id of the profile required: true schema: type: string example: self - name: optionlist_id in: path description: id of the optionlist required: true schema: type: number - name: option_id in: path description: id of the option required: true schema: type: number - name: fields in: query description: extra information of each option localization on the list required: false schema: type: string - name: limit in: query description: maximum count of the option localization list required: false schema: type: number example: '100' - name: offset in: query description: skip that many option localization before beginning to return required: false schema: type: number example: '0' responses: '200': description: OK headers: Total-Count: schema: type: string content: application/json: examples: response: value: - label: fallar language_code: es - label: 失败 language_code: zh-hans - label: 失敗 language_code: zh-hant schema: type: object properties: label: type: string language_code: type: string required: - language_code - label security: - oauth2: [] tags: - Optionlist Resource post: operationId: post-profiles-profile-id-optionlists-optionlist-id-options-option-id-localizations summary: Create New Option Localizations description: '' parameters: - name: profile_id in: path description: id of the profile required: true schema: type: string example: self - name: optionlist_id in: path description: id of the optionlist required: true schema: type: number - name: option_id in: path description: id of the option required: true schema: type: number requestBody: content: application/json: schema: type: object properties: label: type: string examples: - fallar language_code: type: string examples: - es required: - language_code - label responses: '201': description: Created headers: {} content: application/json: examples: response: value: - language_code: zh-hans - language_code: zh-hant schema: type: object properties: language_code: description: the created language code type: string required: - language_code security: - oauth2: [] tags: - Optionlist Resource put: operationId: put-profiles-profile-id-optionlists-optionlist-id-options-option-id-localizations summary: Update a List of Option Localizations description: '' parameters: - name: profile_id in: path description: id of the profile required: true schema: type: string example: self - name: optionlist_id in: path description: id of the optionlist required: true schema: type: number - name: option_id in: path description: id of the option required: true schema: type: number - name: fields in: query description: extra information of each option localization on the list required: false schema: type: string - name: limit in: query description: maximum count of the option localization list required: false schema: type: number example: '100' - name: offset in: query description: skip that many option localization before beginning to return required: false schema: type: number example: '0' requestBody: content: application/json: schema: type: object properties: label: type: string examples: - fallar language_code: type: string examples: - es responses: '200': description: OK headers: {} content: application/json: examples: response: value: - language_code: zh-hans - language_code: zh-hant schema: type: object properties: language_code: description: the updated language code type: string required: - language_code security: - oauth2: [] tags: - Optionlist Resource /profiles/{profile_id}/optionlists/{optionlist_id}/options/{option_id}/localizations/{language_code}: delete: operationId: delete-profiles-profile-id-optionlists-optionlist-id-options-option-id-localizations-language-code summary: Delete a Option Localization description: '' parameters: - name: profile_id in: path description: id of the profile required: true schema: type: string example: self - name: optionlist_id in: path description: id of the optionlist required: true schema: type: number - name: option_id in: path description: id of the option required: true schema: type: number - name: language_code in: path description: language code of the localization required: true schema: type: string responses: '200': description: OK headers: {} content: application/json: examples: response: value: language_code: es schema: type: object properties: language_code: description: the deleted language code type: string required: - language_code security: - oauth2: [] tags: - Optionlist Resource get: operationId: get-profiles-profile-id-optionlists-optionlist-id-options-option-id-localizations-language-code summary: Retrieve a Option Localization description: '' parameters: - name: profile_id in: path description: id of the profile required: true schema: type: string example: self - name: optionlist_id in: path description: id of the optionlist required: true schema: type: number - name: option_id in: path description: id of the option required: true schema: type: number - name: language_code in: path description: language code of the localization required: true schema: type: string responses: '200': description: OK headers: {} content: application/json: examples: response: value: label: fallar language_code: es schema: type: object properties: label: type: string language_code: type: string required: - language_code - label security: - oauth2: [] tags: - Optionlist Resource put: operationId: put-profiles-profile-id-optionlists-optionlist-id-options-option-id-localizations-language-code summary: Update a Option Localization description: '' parameters: - name: profile_id in: path description: id of the profile required: true schema: type: string example: self - name: optionlist_id in: path description: id of the optionlist required: true schema: type: number - name: option_id in: path description: id of the option required: true schema: type: number - name: language_code in: path description: language code of the localization required: true schema: type: string requestBody: content: application/json: schema: type: object properties: label: type: string examples: - fallar responses: '200': description: OK headers: {} content: application/json: examples: response: value: language_code: es schema: type: object properties: language_code: description: the updated language code type: string required: - language_code security: - oauth2: [] tags: - Optionlist Resource /profiles/{profile_id}/page_groups: get: operationId: get-profiles-profile-id-page-groups summary: Retrieve a List of Page Groups description: '' parameters: - name: profile_id in: path description: id of the profile required: true schema: type: string example: self - name: fields in: query description: extra information of each user on the list required: false schema: type: string - name: limit in: query description: maximum count of the user list required: false schema: type: number example: '100' - name: offset in: query description: skip that many users before beginning to return required: false schema: type: number example: '0' responses: '200': description: OK headers: Total-Count: schema: type: string content: application/json: examples: response: value: - id: 359784 name: inspections - id: 359894 name: logistics schema: type: object properties: created_date: type: string global_id: type: string id: type: number name: type: string pages: {} version: type: number required: - id - name security: - oauth2: [] tags: - Page Group Resource post: operationId: post-profiles-profile-id-page-groups summary: Create New Page Group description: '' parameters: - name: profile_id in: path description: id of the profile required: true schema: type: string example: self requestBody: content: application/json: schema: type: object properties: name: type: string examples: - demo_page_group required: - name responses: '201': description: Created headers: {} content: application/json: examples: response: value: id: 161236 schema: type: object properties: id: description: the created page group id type: number required: - id security: - oauth2: [] tags: - Page Group Resource /profiles/{profile_id}/page_groups/{page_group_id}: delete: operationId: delete-profiles-profile-id-page-groups-page-group-id summary: Delete a Page Group description: '' parameters: - name: profile_id in: path description: id of the profile required: true schema: type: string example: self - name: page_group_id in: path description: id of the page group required: true schema: type: number responses: '200': description: OK headers: {} content: application/json: examples: response: value: id: 790777 schema: type: object properties: id: description: the deleted page group id type: number required: - id security: - oauth2: [] tags: - Page Group Resource get: operationId: get-profiles-profile-id-page-groups-page-group-id summary: Retrieve a Page Group description: '' parameters: - name: profile_id in: path description: id of the profile required: true schema: type: string example: self - name: page_group_id in: path description: id of the page group required: true schema: type: number responses: '200': description: OK headers: {} content: '*/*': schema: type: object properties: created_date: type: string global_id: type: string id: type: number name: type: string pages: {} version: type: number required: - id - name - global_id - version - created_date - pages security: - oauth2: [] tags: - Page Group Resource put: operationId: put-profiles-profile-id-page-groups-page-group-id summary: Update a Page Group description: '' parameters: - name: profile_id in: path description: id of the profile required: true schema: type: string example: self - name: page_group_id in: path description: id of the page group required: true schema: type: number requestBody: content: application/json: schema: type: object properties: name: type: string examples: - building_inspection responses: '200': description: OK headers: {} content: application/json: examples: response: value: id: 790777 schema: type: object properties: id: description: the updated page group id type: number required: - id security: - oauth2: [] tags: - Page Group Resource /profiles/{profile_id}/page_groups/{page_group_id}/assignments: delete: operationId: delete-profiles-profile-id-page-groups-page-group-id-assignments summary: Delete a List of Page Group's User Assignments description: '' parameters: - name: profile_id in: path description: id of the profile required: true schema: type: string example: self - name: page_group_id in: path description: id of the page group required: true schema: type: number - name: fields in: query description: extra information of each page assignment on the list required: false schema: type: string - name: limit in: query description: maximum count of the page assignment list required: false schema: type: number example: '100' - name: offset in: query description: skip that many page assignment before beginning to return required: false schema: type: number example: '0' requestBody: content: application/json: schema: type: object properties: user_id: type: number examples: - 161239 responses: '200': description: OK headers: {} content: application/json: examples: response: value: - user_id: 161239 - user_id: 161242 schema: type: object properties: user_id: description: the deleted user id type: number required: - user_id security: - oauth2: [] tags: - Page Group Resource get: operationId: get-profiles-profile-id-page-groups-page-group-id-assignments summary: Retrieve a List of Page Group User Assignments description: '' parameters: - name: profile_id in: path description: id of the profile required: true schema: type: string example: self - name: page_group_id in: path description: id of the page group required: true schema: type: number - name: fields in: query description: extra information of each page assignment on the list required: false schema: type: string - name: limit in: query description: maximum count of the page assignment list required: false schema: type: number example: '100' - name: offset in: query description: skip that many page assignment before beginning to return required: false schema: type: number example: '0' responses: '200': description: OK headers: Total-Count: schema: type: string content: application/json: examples: response: value: - user_id: 161236 - user_id: 161239 - user_id: 161242 schema: type: object properties: can_collect: type: boolean can_view: type: boolean is_group: type: boolean user_id: type: number required: - user_id security: - oauth2: [] tags: - Page Group Resource put: operationId: put-profiles-profile-id-page-groups-page-group-id-assignments summary: Update a List of Page Group User Assignments description: '' parameters: - name: profile_id in: path description: id of the profile required: true schema: type: string example: self - name: page_group_id in: path description: id of the page group required: true schema: type: number - name: fields in: query description: extra information of each page assignment on the list required: false schema: type: string - name: limit in: query description: maximum count of the page assignment list required: false schema: type: number example: '100' - name: offset in: query description: skip that many page assignment before beginning to return required: false schema: type: number example: '0' requestBody: content: application/json: schema: type: object properties: can_collect: type: boolean examples: - true can_view: type: boolean examples: - true user_id: type: number examples: - 161236 responses: '200': description: OK headers: {} content: application/json: examples: response: value: - user_id: 161239 - user_id: 161242 schema: type: object properties: user_id: description: the updated user id type: number required: - user_id security: - oauth2: [] tags: - Page Group Resource /profiles/{profile_id}/page_groups/{page_group_id}/assignments/{user_id}: delete: operationId: delete-profiles-profile-id-page-groups-page-group-id-assignments-user-id summary: Delete a Page Group User Assignment description: '' parameters: - name: profile_id in: path description: id of the profile required: true schema: type: string example: self - name: page_group_id in: path description: id of the page required: true schema: type: number - name: user_id in: path description: id of the user required: true schema: type: number responses: '200': description: OK headers: {} content: application/json: examples: response: value: user_id: 161236 schema: type: object properties: user_id: description: the deleted user id type: number required: - user_id security: - oauth2: [] tags: - Page Group Resource get: operationId: get-profiles-profile-id-page-groups-page-group-id-assignments-user-id summary: Retrieve a Page Group User Assignment description: '' parameters: - name: profile_id in: path description: id of the profile required: true schema: type: string example: self - name: page_group_id in: path description: id of the page required: true schema: type: number - name: user_id in: path description: id of the user required: true schema: type: number responses: '200': description: OK headers: {} content: application/json: examples: response: value: can_collect: true can_view: true is_group: false user_id: 161236 schema: type: object properties: can_collect: type: boolean can_view: type: boolean is_group: type: boolean user_id: type: number required: - user_id - is_group - can_collect - can_view security: - oauth2: [] tags: - Page Group Resource put: operationId: put-profiles-profile-id-page-groups-page-group-id-assignments-user-id summary: Update a Page Group User Assignment description: '' parameters: - name: profile_id in: path description: id of the profile required: true schema: type: string example: self - name: page_group_id in: path description: id of the page required: true schema: type: number - name: user_id in: path description: id of the user required: true schema: type: number requestBody: content: application/json: schema: type: object properties: can_collect: type: boolean examples: - true can_view: type: boolean examples: - true responses: '200': description: OK headers: {} content: application/json: examples: response: value: user_id: 161236 schema: type: object properties: user_id: description: the updated user id type: number required: - user_id security: - oauth2: [] tags: - Page Group Resource /profiles/{profile_id}/page_groups/{page_group_id}/pages: delete: operationId: delete-profiles-profile-id-page-groups-page-group-id-pages summary: Delete Page from Page Group description: '' parameters: - name: profile_id in: path description: id of the profile required: true schema: type: string example: self - name: page_group_id in: path description: id of the page required: true schema: type: number requestBody: content: application/json: schema: type: array items: properties: page_id: type: number required: - page_id type: object examples: - - page_id: 11261236 - page_id: 11261239 responses: '200': description: OK headers: {} content: application/json: examples: response: value: - page_id: 11261236 - page_id: 11261239 schema: type: object properties: page_id: type: number required: - page_id security: - oauth2: [] tags: - Page Group Resource get: operationId: get-profiles-profile-id-page-groups-page-group-id-pages summary: Retrieve a Page Group Page Assignment description: '' parameters: - name: profile_id in: path description: id of the profile required: true schema: type: string example: self - name: page_group_id in: path description: id of the page required: true schema: type: number responses: '200': description: OK headers: {} content: application/json: examples: response: value: Body: '' page_id: 11261236 schema: type: object properties: body: description: |- [ { "page_id": 11261236, } ] type: string page_id: type: number required: - page_id security: - oauth2: [] tags: - Page Group Resource post: operationId: post-profiles-profile-id-page-groups-page-group-id-pages summary: Assign Page to Page Group description: '' parameters: - name: profile_id in: path description: id of the profile required: true schema: type: string example: self - name: page_group_id in: path description: id of the page required: true schema: type: number requestBody: content: application/json: schema: type: array items: properties: page_id: type: number required: - page_id type: object examples: - - page_id: 11261236 - page_id: 11261239 responses: '200': description: OK headers: {} content: application/json: examples: response: value: Body: '' page_id: 11261236 schema: type: object properties: body: description: |- [ { "page_id": 11261236 }, { "page_id": 11261239 } ] type: string page_id: type: number required: - page_id security: - oauth2: [] tags: - Page Group Resource /profiles/{profile_id}/pages: get: operationId: get-profiles-profile-id-pages summary: Retrieve a List of Pages description: '' parameters: - name: profile_id in: path description: id of the profile required: true schema: type: string example: self - name: fields in: query description: extra information of each profile on the list required: false schema: type: string - name: limit in: query description: maximum count of the profile list required: false schema: type: number example: '100' - name: offset in: query description: skip that many profiles before beginning to return required: false schema: type: number example: '0' responses: '200': description: OK headers: Total-Count: schema: type: string content: application/json: examples: response: value: - id: 790765 name: de13_taking_a_lot_of_pictures permissions: collect: true modify: true view: true - id: 790768 name: de13_photo_subform permissions: collect: true modify: true view: true - id: 790777 name: building_inspection permissions: collect: true modify: true view: true schema: type: object properties: created_by: type: string created_date: type: string description: type: string global_id: type: string icon: type: string id: type: number is_disabled: type: boolean label: type: string label_icons: type: string localizations: {} modified_by: type: string modified_date: type: string name: type: string page_javascript: type: string permissions: type: object properties: {} permissions_collect: type: boolean permissions_modify: type: boolean permissions_view: type: boolean reference_id_1: type: string reference_id_2: type: string reference_id_3: type: string reference_id_4: type: string reference_id_5: type: string sort_order: type: number version: type: number required: - id - name - permissions - permissions.modify - permissions.view - permissions.collect security: - oauth2: [] tags: - Page Resource post: operationId: post-profiles-profile-id-pages summary: Create a New Page description: '' requestBody: content: application/json: schema: type: object properties: description: type: string examples: - A form designed for building inspection icon: type: string examples: - https://dl.dropboxusercontent.com/u/53478059/Demo_Forms/icon_bldginsp.png is_disabled: type: boolean label: type: string examples: - Building Inspection label_icons: type: string name: type: string examples: - building_inspection page_javascript: type: string reference_id_1: type: string reference_id_2: type: string reference_id_3: type: string reference_id_4: type: string reference_id_5: type: string sort_order: type: number required: - name - label responses: '201': description: Created headers: {} content: application/json: examples: response: value: id: 790777 schema: type: object properties: id: description: the created page id type: number required: - id security: - oauth2: [] tags: - Page Resource /profiles/{profile_id}/pages/{page_group_id}/assignments: post: operationId: post-profiles-profile-id-pages-page-group-id-assignments summary: Create New Page Group Assignments description: '' parameters: - name: profile_id in: path description: id of the profile required: true schema: type: string example: self - name: page_group_id in: path description: id of the page required: true schema: type: number requestBody: content: application/json: schema: type: object properties: can_collect: type: boolean examples: - true can_view: type: boolean examples: - true user_id: type: number examples: - 161236 required: - user_id responses: '201': description: Created headers: {} content: application/json: examples: response: value: - user_id: 161239 - user_id: 161242 schema: type: object properties: user_id: description: the created user id type: number required: - user_id security: - oauth2: [] tags: - Page Group Resource /profiles/{profile_id}/pages/{page_id}: copy: consumes: [] produces: - application/json parameters: - name: profile_id in: path description: id of the profile required: true type: string x-example: self - name: page_id in: path description: id of the page required: true type: number responses: '201': description: Created headers: {} examples: application/json: id: 790780 schema: type: object properties: id: description: the copied page id type: number required: - id security: - oauth2: [] tags: - Page Resource description: '' operationId: copy-profiles-profile-id-pages-page-id summary: Copy a Page delete: operationId: delete-profiles-profile-id-pages-page-id summary: Delete a Page description: '' parameters: - name: profile_id in: path description: id of the profile required: true schema: type: string example: self - name: page_id in: path description: id of the page required: true schema: type: number responses: '200': description: OK headers: {} content: application/json: examples: response: value: id: 790777 schema: type: object properties: id: description: the deleted page id type: number required: - id security: - oauth2: [] tags: - Page Resource get: operationId: get-profiles-profile-id-pages-page-id summary: Retrieve a Page description: '' parameters: - name: profile_id in: path description: id of the profile required: true schema: type: string example: self - name: page_id in: path description: id of the page required: true schema: type: number responses: '200': description: OK headers: {} content: application/json: examples: response: value: created_by: cng created_date: 2015-05-12T11:27:14+00:00 description: A form designed for building inspection global_id: 0P790777H46FF3 icon: https://dl.dropboxusercontent.com/u/53478059/Demo_Forms/icon_bldginsp.png id: 790777 is_disabled: false label: Building Inspection label_icons: '' localizations: [] modified_by: cng modified_date: 2015-05-12T11:40:54+00:00 name: building_inspection page_javascript: '' permissions: collect: true modify: true view: true reference_id_1: '' reference_id_2: '' reference_id_3: '' reference_id_4: '' reference_id_5: '' sort_order: 0 version: 3 schema: type: object properties: created_by: type: string created_date: type: string description: type: string global_id: type: string icon: type: string id: type: number is_disabled: type: boolean label: type: string label_icons: type: string localizations: {} modified_by: type: string modified_date: type: string name: type: string page_javascript: type: string permissions: type: object properties: {} permissions_collect: type: boolean permissions_modify: type: boolean permissions_view: type: boolean reference_id_1: type: string reference_id_2: type: string reference_id_3: type: string reference_id_4: type: string reference_id_5: type: string sort_order: type: number version: type: number required: - id - name - permissions - permissions.modify - permissions.view - permissions.collect - global_id - label - description - version - created_date - created_by - modified_date - modified_by - is_disabled - reference_id_1 - reference_id_2 - reference_id_3 - reference_id_4 - reference_id_5 - icon - sort_order - page_javascript - label_icons - localizations security: - oauth2: [] tags: - Page Resource put: operationId: put-profiles-profile-id-pages-page-id summary: Update a Page description: '' parameters: - name: profile_id in: path description: id of the profile required: true schema: type: string example: self - name: page_id in: path description: id of the page required: true schema: type: number requestBody: content: application/json: schema: type: object properties: description: type: string examples: - A form designed for building inspection icon: type: string examples: - https://dl.dropboxusercontent.com/u/53478059/Demo_Forms/icon_bldginsp.png is_disabled: type: boolean label: type: string examples: - Building Inspection label_icons: type: string name: type: string examples: - building_inspection page_javascript: type: string reference_id_1: type: string reference_id_2: type: string reference_id_3: type: string reference_id_4: type: string reference_id_5: type: string sort_order: type: number responses: '200': description: OK headers: {} content: application/json: examples: response: value: id: 790777 schema: type: object properties: id: description: the updated page id type: number required: - id security: - oauth2: [] tags: - Page Resource /profiles/{profile_id}/pages/{page_id}/assignments: delete: operationId: delete-profiles-profile-id-pages-page-id-assignments summary: Delete a List of Page Assignments description: '' parameters: - name: profile_id in: path description: id of the profile required: true schema: type: string example: self - name: page_id in: path description: id of the page required: true schema: type: number - name: fields in: query description: extra information of each page assignment on the list required: false schema: type: string - name: limit in: query description: maximum count of the page assignment list required: false schema: type: number example: '100' - name: offset in: query description: skip that many page assignment before beginning to return required: false schema: type: number example: '0' requestBody: content: application/json: schema: type: object properties: user_id: type: number examples: - 161239 responses: '200': description: OK headers: {} content: application/json: examples: response: value: - user_id: 161239 - user_id: 161242 schema: type: object properties: user_id: description: the deleted user id type: number required: - user_id security: - oauth2: [] tags: - Page Resource get: operationId: get-profiles-profile-id-pages-page-id-assignments summary: Retrieve a List of Page Assignments description: '' parameters: - name: profile_id in: path description: id of the profile required: true schema: type: string example: self - name: page_id in: path description: id of the page required: true schema: type: number - name: fields in: query description: extra information of each page assignment on the list required: false schema: type: string - name: limit in: query description: maximum count of the page assignment list required: false schema: type: number example: '100' - name: offset in: query description: skip that many page assignment before beginning to return required: false schema: type: number example: '0' responses: '200': description: OK headers: Total-Count: schema: type: string content: application/json: examples: response: value: - user_id: 161236 - user_id: 161239 - user_id: 161242 schema: type: object properties: can_collect: type: boolean can_view: type: boolean user_id: type: number required: - user_id security: - oauth2: [] tags: - Page Resource post: operationId: post-profiles-profile-id-pages-page-id-assignments summary: Create New Page Assignments description: '' parameters: - name: profile_id in: path description: id of the profile required: true schema: type: string example: self - name: page_id in: path description: id of the page required: true schema: type: number requestBody: content: application/json: schema: type: object properties: can_collect: type: boolean examples: - true can_view: type: boolean examples: - true user_id: type: number examples: - 161236 required: - user_id responses: '201': description: Created headers: {} content: application/json: examples: response: value: - user_id: 161239 - user_id: 161242 schema: type: object properties: user_id: description: the created user id type: number required: - user_id security: - oauth2: [] tags: - Page Resource put: operationId: put-profiles-profile-id-pages-page-id-assignments summary: Update a List of Page Assignments description: '' parameters: - name: profile_id in: path description: id of the profile required: true schema: type: string example: self - name: page_id in: path description: id of the page required: true schema: type: number - name: fields in: query description: extra information of each page assignment on the list required: false schema: type: string - name: limit in: query description: maximum count of the page assignment list required: false schema: type: number example: '100' - name: offset in: query description: skip that many page assignment before beginning to return required: false schema: type: number example: '0' requestBody: content: application/json: schema: type: object properties: can_collect: type: boolean examples: - true can_view: type: boolean examples: - true user_id: type: number examples: - 161236 responses: '200': description: OK headers: {} content: application/json: examples: response: value: - user_id: 161239 - user_id: 161242 schema: type: object properties: user_id: description: the updated user id type: number required: - user_id security: - oauth2: [] tags: - Page Resource /profiles/{profile_id}/pages/{page_id}/assignments/{user_id}: delete: operationId: delete-profiles-profile-id-pages-page-id-assignments-user-id summary: Delete a Page Assignment description: '' parameters: - name: profile_id in: path description: id of the profile required: true schema: type: string example: self - name: page_id in: path description: id of the page required: true schema: type: number - name: user_id in: path description: id of the user required: true schema: type: number responses: '200': description: OK headers: {} content: application/json: examples: response: value: user_id: 161236 schema: type: object properties: user_id: description: the deleted user id type: number required: - user_id security: - oauth2: [] tags: - Page Resource get: operationId: get-profiles-profile-id-pages-page-id-assignments-user-id summary: Retrieve a Page Assignment description: '' parameters: - name: profile_id in: path description: id of the profile required: true schema: type: string example: self - name: page_id in: path description: id of the page required: true schema: type: number - name: user_id in: path description: id of the user required: true schema: type: number responses: '200': description: OK headers: {} content: application/json: examples: response: value: can_collect: true can_view: true user_id: 161236 schema: type: object properties: can_collect: type: boolean can_view: type: boolean user_id: type: number required: - user_id - can_collect - can_view security: - oauth2: [] tags: - Page Resource put: operationId: put-profiles-profile-id-pages-page-id-assignments-user-id summary: Update a Page Assignment description: '' parameters: - name: profile_id in: path description: id of the profile required: true schema: type: string example: self - name: page_id in: path description: id of the page required: true schema: type: number - name: user_id in: path description: id of the user required: true schema: type: number requestBody: content: application/json: schema: type: object properties: can_collect: type: boolean examples: - true can_view: type: boolean examples: - true responses: '200': description: OK headers: {} content: application/json: examples: response: value: user_id: 161236 schema: type: object properties: user_id: description: the updated user id type: number required: - user_id security: - oauth2: [] tags: - Page Resource /profiles/{profile_id}/pages/{page_id}/dynamic_attributes: delete: operationId: delete-profiles-profile-id-pages-page-id-dynamic-attributes summary: Delete a List of Page Dynamic Attributes description: '' parameters: - name: profile_id in: path description: id of the profile required: true schema: type: string example: self - name: page_id in: path description: id of the page required: true schema: type: number - name: fields in: query description: extra information of each page dynamic attribute on the list required: false schema: type: string - name: limit in: query description: maximum count of the page dynamic attribute list required: false schema: type: number example: '100' - name: offset in: query description: skip that many page dynamic attribute before beginning to return required: false schema: type: number example: '0' requestBody: content: application/json: schema: type: object properties: attribute_name: type: string examples: - '``' required: - attribute_name responses: '200': description: OK headers: {} content: application/json: examples: response: value: - attribute_name: time_settting - attribute_name: map_top_location_disable schema: type: object properties: language_code: description: the deleted language code type: string required: - language_code security: - oauth2: [] tags: - Page Resource get: operationId: get-profiles-profile-id-pages-page-id-dynamic-attributes summary: Retrieve a List of Page Dynamic Attributes description: '' parameters: - name: profile_id in: path description: id of the profile required: true schema: type: string example: self - name: page_id in: path description: id of the page required: true schema: type: number - name: fields in: query description: extra information of each page dynamic attribute on the list required: false schema: type: string - name: limit in: query description: maximum count of the page dynamic attribute list required: false schema: type: number example: '100' - name: offset in: query description: skip that many page dynamic attribute before beginning to return required: false schema: type: number example: '0' responses: '200': description: OK headers: Total-Count: schema: type: string content: application/json: examples: response: value: - attribute_name: map_priority value: my_element - attribute_name: map_top_location_disable value: true schema: type: object properties: attributename_1224hourtime: type: string value: description: returned value type can differ based on dynamic attribute type: string required: - 'attribute_name: `12_24_hour_time`' - value security: - oauth2: [] tags: - Page Resource post: operationId: post-profiles-profile-id-pages-page-id-dynamic-attributes summary: Create New Page Attribute description: |-

    List of Valid Page Dynamic Attributes

  • To find out what elements have dynamic attributes and what values are accepted, take a look here.
    • parameters: - name: profile_id in: path description: id of the profile required: true schema: type: string example: self - name: page_id in: path description: id of the page required: true schema: type: number requestBody: content: application/json: schema: type: object properties: attributename_mappriority: type: string value: description: value validation (ie. string or boolean) could change based on specific page dynamic attribute. type: string examples: - my_element required: - 'attribute_name: `map_priority`' - value responses: '201': description: Created headers: {} content: application/json: examples: response: value: - attribute_name: map_priority - attribute_name: map_top_location_disable schema: type: object properties: attributename_mappriority: description: created page dynamic attribute type: string required: - 'attribute_name: `map_priority`' security: - oauth2: [] tags: - Page Resource put: operationId: put-profiles-profile-id-pages-page-id-dynamic-attributes summary: Update a List of Page Dynamic Attributes description: '' parameters: - name: profile_id in: path description: id of the profile required: true schema: type: string example: self - name: page_id in: path description: id of the page required: true schema: type: number - name: fields in: query description: extra information of each page dynamic attribute on the list required: false schema: type: string - name: limit in: query description: maximum count of the page dynamic attribute list required: false schema: type: number example: '100' - name: offset in: query description: skip that many page dynamic attribute before beginning to return required: false schema: type: number example: '0' requestBody: content: application/json: schema: type: object properties: attributename_mappriority: type: string value: description: '- value validation (ie. string or boolean) could change based on specific page dynamic attribute.' type: string examples: - my_element2 required: - 'attribute_name: `map_priority`' - value responses: '200': description: OK headers: {} content: application/json: examples: response: value: - attribute_name: map_priority - attribute_name: map_top_location_disable schema: type: object properties: language_code: description: the updated language code type: string required: - language_code security: - oauth2: [] tags: - Page Resource /profiles/{profile_id}/pages/{page_id}/dynamic_attributes/{dynamic_attribute}: delete: operationId: delete-profiles-profile-id-pages-page-id-dynamic-attributes-dynamic-attribute summary: Delete an Page Attribute description: '' parameters: - name: profile_id in: path description: id of the profile required: true schema: type: string example: self - name: page_id in: path description: id of the page required: true schema: type: number - name: dynamic_attribute in: path description: name of dynamic attribute required: true schema: type: string responses: '200': description: OK headers: {} content: application/json: examples: response: value: attribute_name: map_priority schema: type: object properties: attributename_mappriority: description: the deleted dynamic_attribute type: string required: - 'attribute_name: `map_priority`' security: - oauth2: [] tags: - Page Resource get: operationId: get-profiles-profile-id-pages-page-id-dynamic-attributes-dynamic-attribute summary: Retrieve a Page Dynamic Attribute description: '' parameters: - name: profile_id in: path description: id of the profile required: true schema: type: string example: self - name: page_id in: path description: id of the page required: true schema: type: number - name: dynamic_attribute in: path description: name of dynamic attribute required: true schema: type: string responses: '200': description: OK headers: {} content: '*/*': schema: type: object properties: dynamicattribute_mappriority: type: string last_modified_date: description: 04-02T02:07:29+00:00" - Last time this attribute was modified type: string type: description: will display what type the value has to be, for example string or number type: string value: description: this value type can change based on dynamic attribute type: string required: - 'dynamic_attribute: `map_priority`' - value - type security: - oauth2: [] tags: - Page Resource put: operationId: put-profiles-profile-id-pages-page-id-dynamic-attributes-dynamic-attribute summary: Update an Page Dynamic Attribute description: '' parameters: - name: profile_id in: path description: id of the profile required: true schema: type: string example: self - name: page_id in: path description: id of the page required: true schema: type: number - name: dynamic_attribute in: path description: name of dynamic attribute required: true schema: type: string requestBody: content: application/json: schema: type: object properties: value: type: string examples: - my_element2 responses: '200': description: OK headers: {} content: application/json: examples: response: value: dynamic_attribute: map_priority schema: type: object properties: attributename_mappriority: description: the updated dynamic attribute type: string required: - 'attribute_name: `map_priority`' security: - oauth2: [] tags: - Page Resource /profiles/{profile_id}/pages/{page_id}/elements: delete: operationId: delete-profiles-profile-id-pages-page-id-elements summary: Delete a List of Elements description: '' parameters: - name: profile_id in: path description: id of the profile required: true schema: type: string example: self - name: page_id in: path description: id of the page required: true schema: type: number - name: fields in: query description: extra information of each element on the list required: false schema: type: string example: sort_order:> - name: limit in: query description: maximum count of the element list required: false schema: type: number example: '100' - name: offset in: query description: skip that many elements before beginning to return required: false schema: type: number example: '0' requestBody: content: application/json: schema: type: object properties: id: type: number examples: - 20483236 responses: '200': description: OK headers: {} content: application/json: examples: response: value: - id: 20483233 - id: 20483236 schema: type: object properties: id: description: the deleted element id type: number required: - id security: - oauth2: [] tags: - Element Resource get: operationId: get-profiles-profile-id-pages-page-id-elements summary: Retrieve a List of Elements description: '' parameters: - name: profile_id in: path description: id of the profile required: true schema: type: string example: self - name: page_id in: path description: id of the page required: true schema: type: number - name: fields in: query description: extra information of each element on the list required: false schema: type: string example: sort_order:> - name: limit in: query description: maximum count of the element list required: false schema: type: number example: '100' - name: offset in: query description: skip that many elements before beginning to return required: false schema: type: number example: '0' responses: '200': description: OK headers: Total-Count: schema: type: string content: application/json: examples: response: value: - id: 20483233 name: inspection_date sort_order: 0 - id: 20483236 name: inspector_name sort_order: 1 - id: 20483245 name: photo_of_front_of_building sort_order: 2 - id: 20483248 name: comments sort_order: 3 schema: type: object properties: attachment_link: type: string client_validation: type: string condition_value: type: string created_by: type: string created_date: type: string data_size: type: number data_type: type: number default_value: type: string description: type: string dynamic_label: type: string dynamic_value: type: string global_id: type: string high_value: type: number id: type: number is_action: type: boolean is_disabled: type: boolean is_encrypt: type: boolean is_hide_typing: type: boolean is_readonly: type: boolean is_required: type: boolean keyboard_type: type: number label: type: string localizations: {} low_value: type: number modified_by: type: string modified_date: type: string name: type: string optionlist_id: type: number reference_id_1: type: string smart_tbl_search: type: string smart_tbl_search_col: type: string sort_order: type: number validation_message: type: string version: type: number weighted_score: type: number widget_type: type: string required: - id - name security: - oauth2: [] tags: - Element Resource post: operationId: post-profiles-profile-id-pages-page-id-elements summary: Create New Elements description: '' parameters: - name: profile_id in: path description: id of the profile required: true schema: type: string example: self - name: page_id in: path description: id of the page required: true schema: type: number requestBody: content: application/json: schema: type: object properties: attachment_link: type: string client_validation: type: string condition_value: type: string data_size: type: number examples: - 50 data_type: type: number examples: - 1 default_value: type: string description: type: string dynamic_label: type: string dynamic_value: type: string examples: - iformbuilder.username high_value: type: number is_action: type: boolean examples: - true is_disabled: type: boolean is_encrypt: type: boolean is_hide_typing: type: boolean is_readonly: type: boolean is_required: type: boolean keyboard_type: type: number examples: - 1 label: type: string examples: - Inspector Name low_value: type: number name: type: string examples: - inspector_name optionlist_id: type: number reference_id_1: type: string smart_tbl_search: type: string smart_tbl_search_col: type: string sort_order: type: number examples: - 1 validation_message: type: string weighted_score: type: number widget_type: type: string required: - name - label - data_type responses: '201': description: Created headers: {} content: application/json: examples: response: value: - id: 20483236 - id: 20483245 schema: type: object properties: id: description: the created element id type: number required: - id security: - oauth2: [] tags: - Element Resource put: operationId: put-profiles-profile-id-pages-page-id-elements summary: Update a List of Elements description: '' parameters: - name: profile_id in: path description: id of the profile required: true schema: type: string example: self - name: page_id in: path description: id of the page required: true schema: type: number - name: fields in: query description: extra information of each element on the list required: false schema: type: string example: sort_order:> - name: limit in: query description: maximum count of the element list required: false schema: type: number example: '100' - name: offset in: query description: skip that many elements before beginning to return required: false schema: type: number example: '0' requestBody: content: application/json: schema: type: object properties: attachment_link: type: string client_validation: type: string condition_value: type: string data_size: type: number examples: - 50 data_type: type: number examples: - 1 default_value: type: string description: type: string dynamic_label: type: string dynamic_value: type: string examples: - iformbuilder.username high_value: type: number id: type: number examples: - 20483236 is_action: type: boolean examples: - true is_disabled: type: boolean is_encrypt: type: boolean is_hide_typing: type: boolean is_readonly: type: boolean is_required: type: boolean keyboard_type: type: number examples: - 1 label: type: string examples: - Inspector Name low_value: type: number name: type: string examples: - inspector_name optionlist_id: type: number reference_id_1: type: string smart_tbl_search: type: string smart_tbl_search_col: type: string sort_order: type: number examples: - 1 validation_message: type: string weighted_score: type: number widget_type: type: string responses: '200': description: OK headers: {} content: application/json: examples: response: value: - id: 20483233 - id: 20483236 schema: type: object properties: id: description: the updated element id type: number required: - id security: - oauth2: [] tags: - Element Resource /profiles/{profile_id}/pages/{page_id}/elements/{element_id}: copy: consumes: [] produces: - application/json parameters: - name: profile_id in: path description: id of the profile required: true type: string x-example: self - name: page_id in: path description: id of the page required: true type: number - name: element_id in: path description: id of the element required: true type: number responses: '201': description: Created headers: {} examples: application/json: id: 20483248 schema: type: object properties: id: description: the copied element id type: number required: - id security: - oauth2: [] tags: - Element Resource description: '' operationId: copy-profiles-profile-id-pages-page-id-elements-element-id summary: Copy an Element delete: operationId: delete-profiles-profile-id-pages-page-id-elements-element-id summary: Delete an Element description: '' parameters: - name: profile_id in: path description: id of the profile required: true schema: type: string example: self - name: page_id in: path description: id of the page required: true schema: type: number - name: element_id in: path description: id of the element required: true schema: type: number responses: '200': description: OK headers: {} content: application/json: examples: response: value: id: 20483245 schema: type: object properties: id: description: the deleted element id type: number required: - id security: - oauth2: [] tags: - Element Resource get: operationId: get-profiles-profile-id-pages-page-id-elements-element-id summary: Retrieve an Element description: '' parameters: - name: profile_id in: path description: id of the profile required: true schema: type: string example: self - name: page_id in: path description: id of the page required: true schema: type: number - name: element_id in: path description: id of the element required: true schema: type: number responses: '200': description: OK headers: {} content: application/json: examples: response: value: attachment_link: '' client_validation: '' condition_value: '' created_by: cng created_date: 2015-05-12T14:38:35+00:00 data_size: 50 data_type: 1 default_value: '' description: '' dynamic_label: '' dynamic_value: iformbuilder.username global_id: 0E20483236H5971E high_value: 0 id: 20483236 is_action: false is_disabled: false is_encrypt: false is_hide_typing: false is_readonly: false is_required: false keyboard_type: 1 label: Inspector Name localizations: [] low_value: 0 modified_by: cng modified_date: 2015-05-12T14:49:41+00:00 name: inspector_name on_change: '' optionlist_id: 0 reference_id_1: '' reference_id_2: '' reference_id_3: '' reference_id_4: '' reference_id_5: '' smart_tbl_search: '' smart_tbl_search_col: '' sort_order: 1 validation_message: '' version: 3 weighted_score: 0 widget_type: '' schema: type: object properties: attachment_link: type: string client_validation: type: string condition_value: type: string created_by: type: string created_date: type: string data_size: type: number data_type: type: number default_value: type: string description: type: string dynamic_label: type: string dynamic_value: type: string global_id: type: string high_value: type: number id: type: number is_action: type: boolean is_disabled: type: boolean is_encrypt: type: boolean is_hide_typing: type: boolean is_readonly: type: boolean is_required: type: boolean keyboard_type: type: number label: type: string localizations: {} low_value: type: number modified_by: type: string modified_date: type: string name: type: string on_change: type: string optionlist_id: type: number reference_id_1: type: string reference_id_2: type: string reference_id_3: type: string reference_id_4: type: string reference_id_5: type: string smart_tbl_search: type: string smart_tbl_search_col: type: string sort_order: type: number validation_message: type: string version: type: number weighted_score: type: number widget_type: type: string required: - id - name - global_id - version - label - description - data_type - data_size - created_date - created_by - modified_date - modified_by - widget_type - sort_order - optionlist_id - default_value - low_value - high_value - dynamic_value - is_required - condition_value - client_validation - is_disabled - reference_id_1 - reference_id_2 - reference_id_3 - reference_id_4 - reference_id_5 - attachment_link - is_readonly - validation_message - is_action - smart_tbl_search - smart_tbl_search_col - is_encrypt - is_hide_typing - on_change - keyboard_type - dynamic_label - weighted_score - localizations security: - oauth2: [] tags: - Element Resource put: operationId: put-profiles-profile-id-pages-page-id-elements-element-id summary: Update an Element description: '' parameters: - name: profile_id in: path description: id of the profile required: true schema: type: string example: self - name: page_id in: path description: id of the page required: true schema: type: number - name: element_id in: path description: id of the element required: true schema: type: number requestBody: content: application/json: schema: type: object properties: attachment_link: type: string client_validation: type: string condition_value: type: string data_size: type: number examples: - 50 data_type: type: number examples: - 1 default_value: type: string description: type: string dynamic_label: type: string dynamic_value: type: string examples: - iformbuilder.username high_value: type: number is_action: type: boolean examples: - true is_disabled: type: boolean is_encrypt: type: boolean is_hide_typing: type: boolean is_readonly: type: boolean is_required: type: boolean keyboard_type: type: number examples: - 1 label: type: string examples: - Inspector Name low_value: type: number name: type: string examples: - inspector_name optionlist_id: type: number reference_id_1: type: string smart_tbl_search: type: string smart_tbl_search_col: type: string sort_order: type: number examples: - 1 validation_message: type: string weighted_score: type: number widget_type: type: string responses: '200': description: OK headers: {} content: application/json: examples: response: value: id: 20483245 schema: type: object properties: id: description: the updated element id type: number required: - id security: - oauth2: [] tags: - Element Resource /profiles/{profile_id}/pages/{page_id}/elements/{element_id}/dynamic_attributes: delete: operationId: delete-profiles-profile-id-pages-page-id-elements-element-id-dynamic-attributes summary: Delete a List of Element Dynamic Attributes description: '' parameters: - name: profile_id in: path description: id of the profile required: true schema: type: string example: self - name: page_id in: path description: id of the page required: true schema: type: number - name: element_id in: path description: id of the element required: true schema: type: number - name: fields in: query description: extra information of each element dynamic attribute on the list required: false schema: type: string - name: limit in: query description: maximum count of the element dynamic attribute list required: false schema: type: number example: '100' - name: offset in: query description: skip that many element dynamic attribute before beginning to return required: false schema: type: number example: '0' requestBody: content: application/json: schema: type: object properties: attribute_name: type: string examples: - '``' required: - attribute_name responses: '200': description: OK headers: {} content: application/json: examples: response: value: - attribute_name: time_settting - attribute_name: gdpr schema: type: object properties: language_code: description: the deleted language code type: string required: - language_code security: - oauth2: [] tags: - Element Resource get: operationId: get-profiles-profile-id-pages-page-id-elements-element-id-dynamic-attributes summary: Retrieve a List of Element Dynamic Attributes description: '' parameters: - name: profile_id in: path description: id of the profile required: true schema: type: string example: self - name: page_id in: path description: id of the page required: true schema: type: number - name: element_id in: path description: id of the element required: true schema: type: number - name: fields in: query description: extra information of each element dynamic attribute on the list required: false schema: type: string - name: limit in: query description: maximum count of the element dynamic attribute list required: false schema: type: number example: '100' - name: offset in: query description: skip that many element dynamic attribute before beginning to return required: false schema: type: number example: '0' responses: '200': description: OK headers: Total-Count: schema: type: string content: application/json: examples: response: value: - attribute_name: 12_24_hour_time last_modified_date: 2019-04-11T15:42:58+00:00 type: string value: 12hr - attribute_name: gdpr last_modified_date: 2019-04-11T15:42:58+00:00 type: boolean value: true schema: type: object properties: attributename_1224hourtime: type: string value: description: returned value type can differ based on dynamic attribute type: string required: - 'attribute_name: `12_24_hour_time`' - value security: - oauth2: [] tags: - Element Resource post: operationId: post-profiles-profile-id-pages-page-id-elements-element-id-dynamic-attributes summary: Create New Element Attribute description: |-

    List of Valid Element Dynamic Attributes

  • To find out what elements have dynamic attributes and what values are accepted, take a look here.
    • parameters: - name: profile_id in: path description: id of the profile required: true schema: type: string example: self - name: page_id in: path description: id of the page required: true schema: type: number - name: element_id in: path description: id of the element required: true schema: type: number requestBody: content: application/json: schema: type: object properties: attributename_1224hourtime: type: string value: description: value validation (ie. string or boolean) could change based on specific element dynamic attribute. type: string examples: - 12hr required: - 'attribute_name: `12_24_hour_time`' - value responses: '201': description: Created headers: {} content: application/json: examples: response: value: - attribute_name: 12_24_hour_time - attribute_name: gdpr schema: type: object properties: attributename_1224hourtime: description: created element dynamic attribute type: string required: - 'attribute_name: `12_24_hour_time`' security: - oauth2: [] tags: - Element Resource put: operationId: put-profiles-profile-id-pages-page-id-elements-element-id-dynamic-attributes summary: Update a List of Element Dynamic Attributes description: '' parameters: - name: profile_id in: path description: id of the profile required: true schema: type: string example: self - name: page_id in: path description: id of the page required: true schema: type: number - name: element_id in: path description: id of the element required: true schema: type: number - name: fields in: query description: extra information of each element dynamic attribute on the list required: false schema: type: string - name: limit in: query description: maximum count of the element dynamic attribute list required: false schema: type: number example: '100' - name: offset in: query description: skip that many element dynamic attribute before beginning to return required: false schema: type: number example: '0' requestBody: content: application/json: schema: type: object properties: attributename_1224hourtime: type: string value: description: '- value validation (ie. string or boolean) could change based on specific element dynamic attribute.' type: string examples: - 24hr required: - 'attribute_name: `12_24_hour_time`' - value responses: '200': description: OK headers: {} content: application/json: examples: response: value: - attribute_name: 12_24_hour_time - attribute_name: gdpr schema: type: object properties: attributename_1224hourtime: description: the updated attribute name type: string required: - 'attribute_name: `12_24_hour_time`' security: - oauth2: [] tags: - Element Resource /profiles/{profile_id}/pages/{page_id}/elements/{element_id}/dynamic_attributes/{dynamic_attribute}: delete: operationId: delete-profiles-profile-id-pages-page-id-elements-element-id-dynamic-attributes-dynamic-attribute summary: Delete an Element Attribute description: '' parameters: - name: profile_id in: path description: id of the profile required: true schema: type: string example: self - name: page_id in: path description: id of the page required: true schema: type: number - name: element_id in: path description: id of the element required: true schema: type: number - name: dynamic_attribute in: path description: name of dynamic attribute required: true schema: type: string responses: '200': description: OK headers: {} content: application/json: examples: response: value: attribute_name: 12_24_hour_time schema: type: object properties: attributename_1224hourtime: description: the deleted dynamic_attribute type: string required: - 'attribute_name: `12_24_hour_time`' security: - oauth2: [] tags: - Element Resource get: operationId: get-profiles-profile-id-pages-page-id-elements-element-id-dynamic-attributes-dynamic-attribute summary: Retrieve an Element Dynamic Attribute description: '' parameters: - name: profile_id in: path description: id of the profile required: true schema: type: string example: self - name: page_id in: path description: id of the page required: true schema: type: number - name: element_id in: path description: id of the element required: true schema: type: number - name: dynamic_attribute in: path description: name of dynamic attribute required: true schema: type: string responses: '200': description: OK headers: {} content: '*/*': schema: type: object properties: dynamicattribute_1224hourtime: type: string last_modified_date: description: 04-02T02:07:29+00:00" - Last time this attribute was modified type: string type: description: will display what type the value has to be, for example string or number type: string value: description: this value type can change based on dynamic attribute type: string required: - 'dynamic_attribute: `12_24_hour_time`' - value - type security: - oauth2: [] tags: - Element Resource put: operationId: put-profiles-profile-id-pages-page-id-elements-element-id-dynamic-attributes-dynamic-attribute summary: Update an Element Dynamic Attribute description: '' parameters: - name: profile_id in: path description: id of the profile required: true schema: type: string example: self - name: page_id in: path description: id of the page required: true schema: type: number - name: element_id in: path description: id of the element required: true schema: type: number - name: dynamic_attribute in: path description: name of dynamic attribute required: true schema: type: string requestBody: content: application/json: schema: type: object properties: value: type: string examples: - 24hr responses: '200': description: OK headers: {} content: application/json: examples: response: value: dynamic_attribute: 12_24_hour_time schema: type: object properties: attributename_1224hourtime: description: the updated dynamic attribute type: string required: - 'attribute_name: `12_24_hour_time`' security: - oauth2: [] tags: - Element Resource /profiles/{profile_id}/pages/{page_id}/elements/{element_id}/localizations: delete: operationId: delete-profiles-profile-id-pages-page-id-elements-element-id-localizations summary: Delete a List of Element Localizations description: '' parameters: - name: profile_id in: path description: id of the profile required: true schema: type: string example: self - name: page_id in: path description: id of the page required: true schema: type: number - name: element_id in: path description: id of the element required: true schema: type: number - name: fields in: query description: extra information of each element localization on the list required: false schema: type: string - name: limit in: query description: maximum count of the element localization list required: false schema: type: number example: '100' - name: offset in: query description: skip that many element localization before beginning to return required: false schema: type: number example: '0' requestBody: content: application/json: schema: type: object properties: language_code: type: string examples: - zh-hans responses: '200': description: OK headers: {} content: application/json: examples: response: value: - language_code: zh-hans - language_code: zh-hant schema: type: object properties: language_code: description: the deleted language code type: string required: - language_code security: - oauth2: [] tags: - Element Resource get: operationId: get-profiles-profile-id-pages-page-id-elements-element-id-localizations summary: Retrieve a List of Element Localizations description: '' parameters: - name: profile_id in: path description: id of the profile required: true schema: type: string example: self - name: page_id in: path description: id of the page required: true schema: type: number - name: element_id in: path description: id of the element required: true schema: type: number - name: fields in: query description: extra information of each element localization on the list required: false schema: type: string - name: limit in: query description: maximum count of the element localization list required: false schema: type: number example: '100' - name: offset in: query description: skip that many element localization before beginning to return required: false schema: type: number example: '0' responses: '200': description: OK headers: Total-Count: schema: type: string content: application/json: examples: response: value: - label: nombre del Inspector language_code: es - label: 检查人员 language_code: zh-hans - label: 檢查人員 language_code: zh-hant schema: type: object properties: label: type: string language_code: type: string required: - language_code - label security: - oauth2: [] tags: - Element Resource post: operationId: post-profiles-profile-id-pages-page-id-elements-element-id-localizations summary: Create New Element Localizations description: '' parameters: - name: profile_id in: path description: id of the profile required: true schema: type: string example: self - name: page_id in: path description: id of the page required: true schema: type: number - name: element_id in: path description: id of the element required: true schema: type: number requestBody: content: application/json: schema: type: object properties: label: type: string examples: - nombre del Inspector language_code: type: string examples: - es required: - language_code - label responses: '201': description: Created headers: {} content: application/json: examples: response: value: - language_code: zh-hans - language_code: zh-hant schema: type: object properties: language_code: description: the created language code type: string required: - language_code security: - oauth2: [] tags: - Element Resource put: operationId: put-profiles-profile-id-pages-page-id-elements-element-id-localizations summary: Update a List of Element Localizations description: '' parameters: - name: profile_id in: path description: id of the profile required: true schema: type: string example: self - name: page_id in: path description: id of the page required: true schema: type: number - name: element_id in: path description: id of the element required: true schema: type: number - name: fields in: query description: extra information of each element localization on the list required: false schema: type: string - name: limit in: query description: maximum count of the element localization list required: false schema: type: number example: '100' - name: offset in: query description: skip that many element localization before beginning to return required: false schema: type: number example: '0' requestBody: content: application/json: schema: type: object properties: label: type: string examples: - nombre del Inspector language_code: type: string examples: - es responses: '200': description: OK headers: {} content: application/json: examples: response: value: - language_code: zh-hans - language_code: zh-hant schema: type: object properties: language_code: description: the updated language code type: string required: - language_code security: - oauth2: [] tags: - Element Resource /profiles/{profile_id}/pages/{page_id}/elements/{element_id}/localizations/{language_code}: delete: operationId: delete-profiles-profile-id-pages-page-id-elements-element-id-localizations-language-code summary: Delete a Element Localization description: '' parameters: - name: profile_id in: path description: id of the profile required: true schema: type: string example: self - name: page_id in: path description: id of the page required: true schema: type: number - name: element_id in: path description: id of the element required: true schema: type: number - name: language_code in: path description: language code of the localization required: true schema: type: string responses: '200': description: OK headers: {} content: application/json: examples: response: value: language_code: es schema: type: object properties: language_code: description: the deleted language code type: string required: - language_code security: - oauth2: [] tags: - Element Resource get: operationId: get-profiles-profile-id-pages-page-id-elements-element-id-localizations-language-code summary: Retrieve an Element Localization description: '' parameters: - name: profile_id in: path description: id of the profile required: true schema: type: string example: self - name: page_id in: path description: id of the page required: true schema: type: number - name: element_id in: path description: id of the element required: true schema: type: number - name: language_code in: path description: language code of the localization required: true schema: type: string responses: '200': description: OK headers: {} content: application/json: examples: response: value: label: nombre del Inspector language_code: es schema: type: object properties: label: type: string language_code: type: string required: - language_code - label security: - oauth2: [] tags: - Element Resource put: operationId: put-profiles-profile-id-pages-page-id-elements-element-id-localizations-language-code summary: Update an Element Localization description: '' parameters: - name: profile_id in: path description: id of the profile required: true schema: type: string example: self - name: page_id in: path description: id of the page required: true schema: type: number - name: element_id in: path description: id of the element required: true schema: type: number - name: language_code in: path description: language code of the localization required: true schema: type: string requestBody: content: application/json: schema: type: object properties: label: type: string examples: - nombre del Inspector responses: '200': description: OK headers: {} content: application/json: examples: response: value: language_code: es schema: type: object properties: language_code: description: the updated language code type: string required: - language_code security: - oauth2: [] tags: - Element Resource /profiles/{profile_id}/pages/{page_id}/email_alerts: delete: operationId: delete-profiles-profile-id-pages-page-id-email-alerts summary: Delete a List of Page Email Alerts description: '' parameters: - name: profile_id in: path description: id of the profile required: true schema: type: string example: self - name: page_id in: path description: id of the page required: true schema: type: number - name: fields in: query description: extra information of each page assignment on the list required: false schema: type: string - name: limit in: query description: maximum count of the page assignment list required: false schema: type: number example: '100' - name: offset in: query description: skip that many page assignment before beginning to return required: false schema: type: number example: '0' requestBody: content: application/json: schema: type: object properties: email: type: string examples: - support@iformbuilder.com required: - email responses: '200': description: OK headers: {} content: application/json: examples: response: value: - email: inspector_1@iformbuilder.com - email: inspector_2@iformbuilder.com schema: type: object properties: email: description: the deleted email alert type: string required: - email security: - oauth2: [] tags: - Page Resource get: operationId: get-profiles-profile-id-pages-page-id-email-alerts summary: Retrieve a List of Page Email Alerts description: '' parameters: - name: profile_id in: path description: id of the profile required: true schema: type: string example: self - name: page_id in: path description: id of the page required: true schema: type: number - name: fields in: query description: extra information of each page assignment on the list required: false schema: type: string - name: limit in: query description: maximum count of the page assignment list required: false schema: type: number example: '100' - name: offset in: query description: skip that many page assignment before beginning to return required: false schema: type: number example: '0' responses: '200': description: OK headers: Total-Count: schema: type: string content: application/json: examples: response: value: - email: inspector_1@iformbuilder.com - email: inspector_2@iformbuilder.com - email: support@iformbuilder.com schema: type: object properties: email: type: string required: - email security: - oauth2: [] tags: - Page Resource post: operationId: post-profiles-profile-id-pages-page-id-email-alerts summary: Create New Page Email Alerts description: '' parameters: - name: profile_id in: path description: id of the profile required: true schema: type: string example: self - name: page_id in: path description: id of the page required: true schema: type: number requestBody: content: application/json: schema: type: object properties: email: type: string examples: - support@iformbuilder.com required: - email responses: '201': description: Created headers: {} content: application/json: examples: response: value: - email: inspector_1@iformbuilder.com - email: inspector_2@iformbuilder.com schema: type: object properties: email: description: the created email alert type: string required: - email security: - oauth2: [] tags: - Page Resource /profiles/{profile_id}/pages/{page_id}/feed: get: operationId: get-profiles-profile-id-pages-page-id-feed summary: Retrieve the page feed description: '' parameters: - name: profile_id in: path description: id of the profile required: true schema: type: string example: self - name: page_id in: path description: id of the page required: true schema: type: number - name: deep in: query description: return all of the subform records as well required: false schema: type: boolean example: '0' - name: javascript_state in: query description: will exclude javascript state if set to 0 required: false schema: type: boolean example: '0' responses: '200': description: OK headers: Total-Count: schema: type: string content: application/json: examples: response: value: - created_by: tony created_date: 2018-04-18T17:23:57+00:00 created_device_id: Server created_location: Server id: 3 javascript_state: '{}' modified_by: tony modified_date: 2018-04-18T17:23:57+00:00 modified_device_id: Server modified_location: Server my_element_1: - created_by: tonyplug created_date: 2018-04-18T17:30:08+00:00 created_device_id: API created_location: API id: 3 javascript_state: '{}' modified_by: onlychild modified_date: 2018-04-18T17:33:31+00:00 modified_device_id: 7054e0d8d6901e8ef10611ea2e25a31319cc4174 modified_location: 39.744230:-76.609999:246.626373:65.000000:10.000000:-1.000000:-1.000000:1524072811.204094 my_element_1: 2015-05-12T14:38:19+00:00 my_element_2: Tony Ruth my_element_3: Green my_element_4: Turtle parent_element_id: 121091346 parent_page_id: 290804421 parent_record_id: 3 server_modified_date: 2018-04-18T17:33:33+00:00 my_element_2: null parent_element_id: 0 parent_page_id: 0 parent_record_id: 0 server_modified_date: 2018-04-18T17:23:57+00:00 schema: type: object properties: created_by: type: string created_date: type: string created_device_id: type: string created_location: type: string id: type: number javascript_state: type: string modified_by: type: string modified_date: type: string modified_device_id: type: string modified_location: type: string parent_element_id: type: number parent_page_id: type: number parent_record_id: type: number server_modified_date: type: string required: - id security: - oauth2: [] tags: - Page Resource /profiles/{profile_id}/pages/{page_id}/http_callbacks: delete: operationId: delete-profiles-profile-id-pages-page-id-http-callbacks summary: Delete a List of Page HTTP Callbacks description: '' parameters: - name: profile_id in: path description: id of the profile required: true schema: type: string example: self - name: page_id in: path description: id of the page required: true schema: type: number - name: fields in: query description: extra information of each option localization on the list required: false schema: type: string - name: limit in: query description: maximum count of the option localization list required: false schema: type: number example: '100' - name: offset in: query description: skip that many option localization before beginning to return required: false schema: type: number example: '0' requestBody: content: application/json: schema: type: object properties: id: type: number examples: - 283 responses: '200': description: OK headers: {} content: application/json: examples: response: value: - id: 283 - id: 286 schema: type: object properties: id: description: the deleted page http callback id type: number required: - id security: - oauth2: [] tags: - Page Resource get: operationId: get-profiles-profile-id-pages-page-id-http-callbacks summary: Retrieve a List of Page HTTP Callbacks description: '' parameters: - name: profile_id in: path description: id of the profile required: true schema: type: string example: self - name: page_id in: path description: id of the page required: true schema: type: number - name: fields in: query description: extra information of each option localization on the list required: false schema: type: string - name: limit in: query description: maximum count of the option localization list required: false schema: type: number example: '100' - name: offset in: query description: skip that many option localization before beginning to return required: false schema: type: number example: '0' responses: '200': description: OK headers: Total-Count: schema: type: string content: application/json: examples: response: value: - id: 283 name: New Record Endpoint - id: 286 name: Zapier Endpoint schema: type: object properties: contenttype_header_string_optional_must_match_header_or_keyvaluepair: type: string error_email: type: string feed_format: description: must match "json" or "xml" type: string feed_format_version: description: Must specifiy in URL parameter to retrieve type: string id: type: number is_disabled: type: boolean is_gauranteed_delivery: type: boolean keyvaluepairkey_string_optional_reuqired_if_contenttype_is_keyvaluepair: type: string mode: type: string name: type: string notification_email: type: string secure_key: type: string secure_type: type: string trigger_post_email: description: Must specifiy in URL parameter to retrieve type: string url: type: string required: - id - name - mode - secure_type - secure_key security: - oauth2: [] tags: - Page Resource post: operationId: post-profiles-profile-id-pages-page-id-http-callbacks summary: Create New Page HTTP Callbacks description: '' parameters: - name: profile_id in: path description: id of the profile required: true schema: type: string example: self - name: page_id in: path description: id of the page required: true schema: type: number requestBody: content: application/json: schema: type: object properties: contenttype_header_string_required_must_match_header_or_keyvaluepair: type: string error_email: type: string examples: - support@iformbuilder.com feed_format: description: must match "json" or "xml" type: string examples: - json feed_format_version: description: must be 9 or 10. type: number examples: - 10 is_disabled: type: boolean is_gauranteed_delivery: type: boolean examples: - true keyvaluepairkey_string_optional_reuqired_if_contenttype_is_keyvaluepair: type: string mode: type: string examples: - "'delete'" name: type: string examples: - New Record Endpoint notification_email: type: string examples: - support@iformbuilder.com secure_key: type: string examples: - -----BEGIN RSA PRIVATE KEY-----\nMIIEpAIBAAKCAQEAhDZuORmHJDScMC66KwyU+3SBsgLLwTy/yjRgP-----END RSA PRIVATE KEY----- secure_type: type: string examples: - RS512 triggerpostemail_support@iformbuildercom: type: string url: type: string examples: - https://www.iformbuilder.com/post_http_endpoint.php required: - name - url - feed_format responses: '201': description: Created headers: {} content: application/json: examples: response: value: id: 283 schema: type: object properties: id: description: the created page http callback id type: number required: - id security: - oauth2: [] tags: - Page Resource /profiles/{profile_id}/pages/{page_id}/http_callbacks/{http_callback_id}: delete: operationId: delete-profiles-profile-id-pages-page-id-http-callbacks-http-callback-id summary: Delete a Page HTTP Callback description: '' parameters: - name: profile_id in: path description: id of the profile required: true schema: type: string example: self - name: page_id in: path description: id of the page required: true schema: type: number - name: http_callback_id in: path description: id of the http callback required: true schema: type: number responses: '200': description: OK headers: {} content: application/json: examples: response: value: id: 283 schema: type: object properties: id: description: the deleted page http callback id type: number required: - id security: - oauth2: [] tags: - Page Resource get: operationId: get-profiles-profile-id-pages-page-id-http-callbacks-http-callback-id summary: Retrieve a Page HTTP Callback description: '' parameters: - name: profile_id in: path description: id of the profile required: true schema: type: string example: self - name: page_id in: path description: id of the page required: true schema: type: number - name: http_callback_id in: path description: id of the http callback required: true schema: type: number responses: '200': description: OK headers: {} content: application/json: examples: response: value: content_type: header error_email: support@iformbuilder.com feed_format: json id: 283 is_gauranteed_delivery: true key_value_pair_key: '' mode: 0 name: New Record Endpoint notification_email: support@iformbuilder.com secure_key: |- -----BEGIN RSA PRIVATE KEY----- MIIEpAIBAAKCAQEAhDZuORmHJDScMC66Kw -----END RSA PRIVATE KEY----- secure_type: RS512 url: https://www.iformbuilder.com/post_http_endpoint.php schema: type: object properties: contenttype_header_string_required_must_match_header_or_keyvaluepair: type: string error_email: type: string feed_format: description: must match "json" or "xml" type: string feed_format_version: description: Must specifiy in URL parameter to retrieve type: string id: type: number is_gauranteed_delivery: type: boolean keyvaluepairkey_string_required_required_if_contenttype_is_keyvaluepair: type: string mode: type: number name: type: string notification_email: type: string secure_key: type: string secure_type: type: string trigger_post_email: description: Must specifiy in URL parameter to retrieve type: string url: type: string required: - id - name - url - feed_format - error_email - notification_email - is_gauranteed_delivery - mode - secure_type - secure_key security: - oauth2: [] tags: - Page Resource put: operationId: put-profiles-profile-id-pages-page-id-http-callbacks-http-callback-id summary: Update a Page HTTP Callback description: '' parameters: - name: profile_id in: path description: id of the profile required: true schema: type: string example: self - name: page_id in: path description: id of the page required: true schema: type: number - name: http_callback_id in: path description: id of the http callback required: true schema: type: number requestBody: content: application/json: schema: type: object properties: contenttype_header_string_optional_must_match_header_or_keyvaluepair: type: string error_email: type: string examples: - support@iformbuilder.com feed_format: description: must match "json" or "xml" type: string examples: - json feed_format_version: description: must be 9 or 10. type: number examples: - 10 is_disabled: type: boolean is_gauranteed_delivery: type: boolean examples: - true keyvaluepairkey_string_optional_reuqired_if_contenttype_is_keyvaluepair: type: string mode: type: string examples: - "'delete'" name: type: string examples: - New Record Endpoint notification_email: type: string examples: - support@iformbuilder.com secure_key: type: string examples: - -----BEGIN RSA PRIVATE KEY-----\nMIIEpAIBAAKCAQEAhDZuORmHJDScMC66KwyU+3SBsgLLwTy/yjRgP-----END RSA PRIVATE KEY----- secure_type: type: string examples: - RS512 trigger_post_email: type: string examples: - support@iformbuilder.com url: type: string examples: - https://www.iformbuilder.com/post_http_endpoint.php required: - mode - secure_key responses: '200': description: OK headers: {} content: application/json: examples: response: value: id: 283 schema: type: object properties: id: description: the updated page http callback id type: number required: - id security: - oauth2: [] tags: - Page Resource /profiles/{profile_id}/pages/{page_id}/localizations: delete: operationId: delete-profiles-profile-id-pages-page-id-localizations summary: Delete a List of Page Localizations description: '' parameters: - name: profile_id in: path description: id of the profile required: true schema: type: string example: self - name: page_id in: path description: id of the page required: true schema: type: number - name: fields in: query description: extra information of each page localization on the list required: false schema: type: string - name: limit in: query description: maximum count of the page localization list required: false schema: type: number example: '100' - name: offset in: query description: skip that many page localization before beginning to return required: false schema: type: number example: '0' requestBody: content: application/json: schema: type: object properties: language_code: type: string examples: - zh-hans responses: '200': description: OK headers: {} content: application/json: examples: response: value: - language_code: zh-hans - language_code: zh-hant schema: type: object properties: language_code: description: the deleted language code type: string required: - language_code security: - oauth2: [] tags: - Page Resource get: operationId: get-profiles-profile-id-pages-page-id-localizations summary: Retrieve a List of Page Localizations description: '' parameters: - name: profile_id in: path description: id of the profile required: true schema: type: string example: self - name: page_id in: path description: id of the page required: true schema: type: number - name: fields in: query description: extra information of each page localization on the list required: false schema: type: string - name: limit in: query description: maximum count of the page localization list required: false schema: type: number example: '100' - name: offset in: query description: skip that many page localization before beginning to return required: false schema: type: number example: '0' responses: '200': description: OK headers: Total-Count: schema: type: string content: application/json: examples: response: value: - label: inspección de la construcción language_code: es - label: 楼宇检查 language_code: zh-hans - label: 樓宇檢查 language_code: zh-hant schema: type: object properties: label: type: string language_code: type: string required: - language_code - label security: - oauth2: [] tags: - Page Resource post: operationId: post-profiles-profile-id-pages-page-id-localizations summary: Create New Page Localizations description: '' parameters: - name: profile_id in: path description: id of the profile required: true schema: type: string example: self - name: page_id in: path description: id of the page required: true schema: type: number requestBody: content: application/json: schema: type: object properties: label: type: string examples: - inspección de la construcción language_code: type: string examples: - es required: - language_code - label responses: '201': description: Created headers: {} content: application/json: examples: response: value: - language_code: zh-hans - language_code: zh-hant schema: type: object properties: language_code: description: the created language code type: string required: - language_code security: - oauth2: [] tags: - Page Resource put: operationId: put-profiles-profile-id-pages-page-id-localizations summary: Update a List of Page Localizations description: '' parameters: - name: profile_id in: path description: id of the profile required: true schema: type: string example: self - name: page_id in: path description: id of the page required: true schema: type: number - name: fields in: query description: extra information of each page localization on the list required: false schema: type: string - name: limit in: query description: maximum count of the page localization list required: false schema: type: number example: '100' - name: offset in: query description: skip that many page localization before beginning to return required: false schema: type: number example: '0' requestBody: content: application/json: schema: type: object properties: label: type: string examples: - inspección de la construcción language_code: type: string examples: - es responses: '200': description: OK headers: {} content: application/json: examples: response: value: - language_code: zh-hans - language_code: zh-hant schema: type: object properties: language_code: description: the updated language code type: string required: - language_code security: - oauth2: [] tags: - Page Resource /profiles/{profile_id}/pages/{page_id}/localizations/{language_code}: delete: operationId: delete-profiles-profile-id-pages-page-id-localizations-language-code summary: Delete a Page Localization description: '' parameters: - name: profile_id in: path description: id of the profile required: true schema: type: string example: self - name: page_id in: path description: id of the page required: true schema: type: number - name: language_code in: path description: language code of the localization required: true schema: type: string responses: '200': description: OK headers: {} content: application/json: examples: response: value: language_code: es schema: type: object properties: language_code: description: the deleted language code type: string required: - language_code security: - oauth2: [] tags: - Page Resource get: operationId: get-profiles-profile-id-pages-page-id-localizations-language-code summary: Retrieve a Page Localization description: '' parameters: - name: profile_id in: path description: id of the profile required: true schema: type: string example: self - name: page_id in: path description: id of the page required: true schema: type: number - name: language_code in: path description: language code of the localization required: true schema: type: string responses: '200': description: OK headers: {} content: application/json: examples: response: value: label: inspección de la construcción language_code: es schema: type: object properties: label: type: string language_code: type: string required: - language_code - label security: - oauth2: [] tags: - Page Resource put: operationId: put-profiles-profile-id-pages-page-id-localizations-language-code summary: Update a Page Localization description: '' parameters: - name: profile_id in: path description: id of the profile required: true schema: type: string example: self - name: page_id in: path description: id of the page required: true schema: type: number - name: language_code in: path description: language code of the localization required: true schema: type: string requestBody: content: application/json: schema: type: object properties: label: type: string examples: - inspección de la construcción responses: '200': description: OK headers: {} content: application/json: examples: response: value: language_code: es schema: type: object properties: language_code: description: the updated language code type: string required: - language_code security: - oauth2: [] tags: - Page Resource /profiles/{profile_id}/pages/{page_id}/record_assignments: delete: operationId: delete-profiles-profile-id-pages-page-id-record-assignments summary: Delete Page Record Assignments description: '' parameters: - name: profile_id in: path description: id of the profile required: true schema: type: string example: self - name: page_id in: path description: id of the page required: true schema: type: number requestBody: content: application/json: schema: type: array items: properties: id: type: number required: - id type: object examples: - - id: 270987 - id: 270990 responses: '200': description: OK headers: {} content: application/json: examples: response: value: Body: '' id: 790777 schema: type: object properties: body: description: |- [ { "id": 270987 } { "id": 270990 ] type: string id: type: number required: - id security: - oauth2: [] tags: - Page Resource get: operationId: get-profiles-profile-id-pages-page-id-record-assignments summary: Retrieve Page Record Assignments description: '' parameters: - name: profile_id in: path description: id of the profile required: true schema: type: string example: self - name: page_id in: path description: id of the page required: true schema: type: number responses: '200': description: OK headers: {} content: application/json: examples: response: value: Body: '' id: 790777 record_id: 123 user_id: 456 schema: type: object properties: body: description: |- [ { "id": 270987, "user_id": 38265920, "record_id": 3662 }, { "id": 270990, "user_id": 38265867, "record_id": 3656 }, ] type: string id: type: number record_id: type: number user_id: type: number required: - id - user_id - record_id security: - oauth2: [] tags: - Page Resource /profiles/{profile_id}/pages/{page_id}/records: delete: operationId: delete-profiles-profile-id-pages-page-id-records summary: Delete a List of Records description: '' parameters: - name: profile_id in: path description: id of the profile required: true schema: type: string example: self - name: page_id in: path description: id of the page required: true schema: type: number - name: fields in: query description: extra information of each record on the list required: false schema: type: string - name: limit in: query description: maximum count of the record list required: false schema: type: number example: '100' - name: offset in: query description: skip that many record before beginning to return required: false schema: type: number example: '0' requestBody: content: application/json: schema: type: object properties: id: type: number examples: - 4 responses: '200': description: OK headers: {} content: application/json: examples: response: value: - id: 4 - id: 7 schema: type: object properties: id: description: the deleted record id type: number required: - id security: - oauth2: [] tags: - Record Resource get: operationId: get-profiles-profile-id-pages-page-id-records summary: Retrieve a List of Records description: '' parameters: - name: profile_id in: path description: id of the profile required: true schema: type: string example: self - name: page_id in: path description: id of the page required: true schema: type: number - name: fields in: query description: extra information of each record on the list required: false schema: type: string - name: limit in: query description: maximum count of the record list required: false schema: type: number example: '100' - name: offset in: query description: skip that many record before beginning to return required: false schema: type: number example: '0' - name: subform_order in: query description: order of subform records. Use 'asc' or 'desc'. required: false schema: type: string example: desc responses: '200': description: OK headers: Total-Count: schema: type: string content: application/json: examples: response: value: - id: 7 - id: 4 - id: 1 schema: type: object properties: created_by: type: string created_date: type: string created_device_id: type: string created_location: type: string id: type: number javascript_state: type: string modified_by: type: string modified_date: type: string modified_device_id: type: string modified_location: type: string parent_element_id: type: number parent_page_id: type: number parent_record_id: type: number server_modified_date: type: string required: - id security: - oauth2: [] tags: - Record Resource post: operationId: post-profiles-profile-id-pages-page-id-records summary: Create New Records description: '' parameters: - name: profile_id in: path description: id of the profile required: true schema: type: string example: self - name: page_id in: path description: id of the page required: true schema: type: number requestBody: content: application/json: schema: type: object properties: device_id: type: string examples: - API fields: description: an array that contains record fields type: array items: {} fields_element_id: type: string examples: - '20483236' fieldselementname_inspectorname: description: must have either element_name or element_id set type: string fields_encoding: description: must match "base64", "url" type: string examples: - url fields_extension: description: file extension, if applicable type: string examples: - jpg fields_value: type: string examples: - Calvin Ng javascript_state: type: string examples: - '{}' parent_element_id: type: number parent_page_id: type: number parent_record_id: type: number required: - fields.value responses: '201': description: Created headers: {} content: application/json: examples: response: value: - id: 4 - id: 7 schema: type: object properties: id: description: the created record id type: number required: - id security: - oauth2: [] tags: - Record Resource put: operationId: put-profiles-profile-id-pages-page-id-records summary: Update a List of Records description: '' parameters: - name: profile_id in: path description: id of the profile required: true schema: type: string example: self - name: page_id in: path description: id of the page required: true schema: type: number - name: fields in: query description: extra information of each record on the list required: false schema: type: string - name: limit in: query description: maximum count of the record list required: false schema: type: number example: '100' - name: offset in: query description: skip that many record before beginning to return required: false schema: type: number example: '0' requestBody: content: application/json: schema: type: object properties: device_id: type: string examples: - API fields: description: an array that contains record fields type: array items: {} fields_element_id: type: string examples: - '20483236' fieldselementname_inspectorname: description: must have either element_name or element_id set type: string fields_encoding: description: must match "base64", "url" type: string examples: - url fields_extension: description: file extension, if applicable type: string examples: - jpg fields_value: type: string examples: - Calvin Ng id: type: number examples: - 4 javascript_state: type: string examples: - '{}' required: - fields.value responses: '200': description: OK headers: {} content: application/json: examples: response: value: - id: 4 - id: 7 schema: type: object properties: id: description: the updated record id type: number required: - id security: - oauth2: [] tags: - Record Resource /profiles/{profile_id}/pages/{page_id}/records/{record_id}: copy: consumes: [] produces: - application/json parameters: - name: profile_id in: path description: id of the profile required: true type: string x-example: self - name: page_id in: path description: id of the page required: true type: number - name: record_id in: path description: id of the record required: true type: number responses: '201': description: Created headers: {} examples: application/json: id: 1 schema: type: object properties: id: description: the deleted record id type: number required: - id security: - oauth2: [] tags: - Record Resource description: '' operationId: copy-profiles-profile-id-pages-page-id-records-record-id summary: Copy a Record delete: operationId: delete-profiles-profile-id-pages-page-id-records-record-id summary: Delete a Record description: '' parameters: - name: profile_id in: path description: id of the profile required: true schema: type: string example: self - name: page_id in: path description: id of the page required: true schema: type: number - name: record_id in: path description: id of the record required: true schema: type: number responses: '200': description: OK headers: {} content: application/json: examples: response: value: id: 1 schema: type: object properties: id: description: the deleted record id type: number required: - id security: - oauth2: [] tags: - Record Resource get: operationId: get-profiles-profile-id-pages-page-id-records-record-id summary: Retrieve a Record description: '' parameters: - name: profile_id in: path description: id of the profile required: true schema: type: string example: self - name: page_id in: path description: id of the page required: true schema: type: number - name: record_id in: path description: id of the record required: true schema: type: number - name: subform_order in: query description: order of subform records. Use 'asc' or 'desc'. required: false schema: type: string example: desc responses: '200': description: OK headers: {} content: application/json: examples: response: value: comments: building exterior created_by: cng created_date: 2015-05-14T15:59:42+00:00 created_device_id: API created_location: API id: 1 inspection_date: 2015-05-12T14:38:19+00:00 inspector_name: Calvin Ng javascript_state: '{}' modified_by: cng modified_date: 2015-05-14T16:08:21+00:00 modified_device_id: API modified_location: API parent_element_id: 0 parent_page_id: 0 parent_record_id: 0 photo_of_front_of_building: https://c560319.ssl.cf2.rackcdn.com/cngdemo/161521/_data161521_building_inspection/field_8712891695554c875dd647.jpg server_modified_date: 2015-05-14T16:08:21+00:00 schema: type: object properties: created_by: type: string created_date: type: string created_device_id: type: string created_location: type: string id: type: number javascript_state: type: string modified_by: type: string modified_date: type: string modified_device_id: type: string modified_location: type: string parent_element_id: type: number parent_page_id: type: number parent_record_id: type: number server_modified_date: type: string required: - id - parent_record_id - parent_page_id - parent_element_id - created_date - created_by - created_location - created_device_id - modified_date - modified_by - modified_location - modified_device_id - server_modified_date - javascript_state security: - oauth2: [] tags: - Record Resource put: operationId: put-profiles-profile-id-pages-page-id-records-record-id summary: Update a Record description: '' parameters: - name: profile_id in: path description: id of the profile required: true schema: type: string example: self - name: page_id in: path description: id of the page required: true schema: type: number - name: record_id in: path description: id of the record required: true schema: type: number requestBody: content: application/json: schema: type: object properties: device_id: type: string examples: - API fields: description: an array that contains record fields type: array items: {} fields_element_id: type: number examples: - 2048326 fieldselementname_inspectorname: description: must have either element_name or element_id set type: string fields_encoding: description: must match "base64", "url" type: string examples: - url fields_extension: description: file extension, if applicable type: string examples: - jpg fields_value: type: string examples: - Calvin Ng javascript_state: type: string examples: - '{}' required: - fields.value responses: '200': description: OK headers: {} content: application/json: examples: response: value: id: 1 schema: type: object properties: id: description: the updated record id type: number required: - id security: - oauth2: [] tags: - Record Resource /profiles/{profile_id}/pages/{page_id}/records/{record_id}/assignments: delete: operationId: delete-profiles-profile-id-pages-page-id-records-record-id-assignments summary: Delete a List of Record Assignments description: '' parameters: - name: profile_id in: path description: id of the profile required: true schema: type: string example: self - name: page_id in: path description: id of the page required: true schema: type: number - name: record_id in: path description: id of the record required: true schema: type: number - name: fields in: query description: extra information of each page assignment on the list required: false schema: type: string - name: limit in: query description: maximum count of the page assignment list required: false schema: type: number example: '100' - name: offset in: query description: skip that many page assignment before beginning to return required: false schema: type: number example: '0' requestBody: content: application/json: schema: type: object properties: user_id: type: number examples: - 161239 responses: '200': description: OK headers: {} content: application/json: examples: response: value: - user_id: 161239 - user_id: 161242 schema: type: object properties: user_id: description: the deleted user id type: number required: - user_id security: - oauth2: [] tags: - Record Resource get: operationId: get-profiles-profile-id-pages-page-id-records-record-id-assignments summary: Retrieve a List of Record Assignments description: '' parameters: - name: profile_id in: path description: id of the profile required: true schema: type: string example: self - name: page_id in: path description: id of the page required: true schema: type: number - name: record_id in: path description: id of the record required: true schema: type: number - name: fields in: query description: extra information of each page assignment on the list required: false schema: type: string - name: limit in: query description: maximum count of the page assignment list required: false schema: type: number example: '100' - name: offset in: query description: skip that many page assignment before beginning to return required: false schema: type: number example: '0' responses: '200': description: OK headers: Total-Count: schema: type: string content: application/json: examples: response: value: - user_id: 161236 - user_id: 161239 - user_id: 161242 schema: type: object properties: user_id: type: number required: - user_id security: - oauth2: [] tags: - Record Resource post: operationId: post-profiles-profile-id-pages-page-id-records-record-id-assignments summary: Create New Record Assignments description: '' parameters: - name: profile_id in: path description: id of the profile required: true schema: type: string example: self - name: page_id in: path description: id of the page required: true schema: type: number - name: record_id in: path description: id of the record required: true schema: type: number requestBody: content: application/json: schema: type: object properties: user_id: description: Must provide user id or username type: number examples: - 161236 username: description: Must provide user id or username type: string examples: - user responses: '201': description: Created headers: {} content: application/json: examples: response: value: - user_id: 161239 - user_id: 161242 schema: type: object properties: user_id: description: the created user id type: number required: - user_id security: - oauth2: [] tags: - Record Resource /profiles/{profile_id}/pages/{page_id}/records/{record_id}/assignments/{user_id}: delete: operationId: delete-profiles-profile-id-pages-page-id-records-record-id-assignments-user-id summary: Delete a Record Assignment description: '' parameters: - name: profile_id in: path description: id of the profile required: true schema: type: string example: self - name: page_id in: path description: id of the page required: true schema: type: number - name: record_id in: path description: id of the record required: true schema: type: number - name: user_id in: path description: id of the user required: true schema: type: number responses: '200': description: OK headers: {} content: application/json: examples: response: value: user_id: 161236 schema: type: object properties: user_id: description: the deleted user id type: number required: - user_id security: - oauth2: [] tags: - Record Resource get: operationId: get-profiles-profile-id-pages-page-id-records-record-id-assignments-user-id summary: Retrieve a Record Assignment description: '' parameters: - name: profile_id in: path description: id of the profile required: true schema: type: string example: self - name: page_id in: path description: id of the page required: true schema: type: number - name: record_id in: path description: id of the record required: true schema: type: number - name: user_id in: path description: id of the user required: true schema: type: number responses: '200': description: OK headers: {} content: '*/*': schema: type: object properties: user_id: type: number required: - user_id security: - oauth2: [] tags: - Record Resource /profiles/{profile_id}/pages/{page_id}/shared_page: delete: operationId: delete-profiles-profile-id-pages-page-id-shared-page summary: Delete a Shared Page Entry description: '' parameters: - name: profile_id in: path description: id of the profile required: true schema: type: string example: self - name: page_id in: path description: id of the page required: true schema: type: number - name: fields in: query description: extra information of each page assignment on the list required: false schema: type: string - name: limit in: query description: maximum count of the page assignment list required: false schema: type: number example: '100' - name: offset in: query description: skip that many page assignment before beginning to return required: false schema: type: number example: '0' requestBody: content: application/json: schema: type: object properties: {} responses: '200': description: OK headers: {} content: application/json: examples: response: value: - id: 86 - id: 89 schema: type: object properties: id: description: id of deleted shared page entry type: number required: - id security: - oauth2: [] tags: - Page Resource get: operationId: get-profiles-profile-id-pages-page-id-shared-page summary: Retrieve a List of a Shared Page Entries description: '' parameters: - name: profile_id in: path description: id of the profile required: true schema: type: string example: self - name: page_id in: path description: id of the page required: true schema: type: number - name: fields in: query description: extra information of each page assignment on the list required: false schema: type: string - name: limit in: query description: maximum count of the page assignment list required: false schema: type: number example: '100' - name: offset in: query description: skip that many page assignment before beginning to return required: false schema: type: number example: '0' responses: '200': description: OK headers: Total-Count: schema: type: string content: application/json: examples: response: value: - allow_copy: false id: 86 profile_id: 161675 - allow_copy: true id: 89 profile_id: 161666 schema: type: object properties: allow_copy: type: boolean id: type: number profile_id: type: string required: - id - profile_id - allow_copy security: - oauth2: [] tags: - Page Resource post: operationId: post-profiles-profile-id-pages-page-id-shared-page summary: Create New Share Page description: '' parameters: - name: profile_id in: path description: id of the profile required: true schema: type: string example: self - name: page_id in: path description: id of the page required: true schema: type: number requestBody: content: application/json: schema: type: object properties: allow_copy: type: boolean examples: - true profile_id: type: number examples: - 161675 required: - profile_id - allow_copy responses: '201': description: Created headers: {} content: application/json: examples: response: value: - id: '86' - id: '89' schema: type: object properties: id: description: ids of shared page entries type: number required: - id security: - oauth2: [] tags: - Page Resource put: operationId: put-profiles-profile-id-pages-page-id-shared-page summary: Update a Shared Page Entry description: '' parameters: - name: profile_id in: path description: id of the profile required: true schema: type: string example: self - name: page_id in: path description: id of the page required: true schema: type: number - name: fields in: query description: extra information of each page assignment on the list required: false schema: type: string - name: limit in: query description: maximum count of the page assignment list required: false schema: type: number example: '100' - name: offset in: query description: skip that many page assignment before beginning to return required: false schema: type: number example: '0' requestBody: content: application/json: schema: type: object properties: {} responses: '200': description: OK headers: {} content: application/json: examples: response: value: - id: 86 - id: 89 schema: type: object properties: id: description: id of deleted shared page entry type: number required: - id security: - oauth2: [] tags: - Page Resource /profiles/{profile_id}/pages/{page_id}/trigger_posts: post: operationId: post-profiles-profile-id-pages-page-id-trigger-posts summary: Triggers POST Action description: '' parameters: - name: profile_id in: path description: id of the profile required: true schema: type: string example: self - name: page_id in: path description: id of the page required: true schema: type: number requestBody: content: application/json: schema: type: object properties: id: type: number examples: - 91 required: - id responses: '201': description: Created headers: {} content: application/json: examples: response: value: - id: 78 - id: 81 schema: type: object properties: id: description: causes post trigger type: number required: - id security: - oauth2: [] tags: - Page Resource /profiles/{profile_id}/user_groups: get: operationId: get-profiles-profile-id-user-groups summary: Retrieve a List of User Groups description: '' parameters: - name: profile_id in: path description: id of the profile required: true schema: type: string example: self - name: fields in: query description: extra information of each user on the list required: false schema: type: string - name: limit in: query description: maximum count of the user list required: false schema: type: number example: '100' - name: offset in: query description: skip that many users before beginning to return required: false schema: type: number example: '0' responses: '200': description: OK headers: Total-Count: schema: type: string content: application/json: examples: response: value: - id: 161236 name: demo_user_group - id: 161239 name: inspector__group - id: 161242 name: logistics_group schema: type: object properties: created_date: type: string global_id: type: string id: type: number name: type: string users: {} version: type: number required: - id - name security: - oauth2: [] tags: - User Group Resource post: operationId: post-profiles-profile-id-user-groups summary: Create New User Groups description: '' parameters: - name: profile_id in: path description: id of the profile required: true schema: type: string example: self requestBody: content: application/json: schema: type: object properties: name: type: string examples: - demo_user_group required: - name responses: '201': description: Created headers: {} content: application/json: examples: response: value: id: 161236 schema: type: object properties: id: description: the created user group id type: number required: - id security: - oauth2: [] tags: - User Group Resource /profiles/{profile_id}/user_groups/{user_group_id}: delete: operationId: delete-profiles-profile-id-user-groups-user-group-id summary: Delete a User Group description: '' parameters: - name: profile_id in: path description: id of the profile required: true schema: type: string example: self - name: user_group_id in: path description: id of the user group required: true schema: type: string example: self responses: '200': description: OK headers: {} content: application/json: examples: response: value: id: 161236 schema: type: object properties: id: description: the deleted user group id type: number required: - id security: - oauth2: [] tags: - User Group Resource get: operationId: get-profiles-profile-id-user-groups-user-group-id summary: Retrieve a User Group description: '' parameters: - name: profile_id in: path description: id of the profile required: true schema: type: string example: self - name: user_group_id in: path description: id of the user group required: true schema: type: string example: self responses: '200': description: OK headers: {} content: '*/*': schema: type: object properties: created_date: type: string global_id: type: string id: type: number name: type: string users: {} version: type: number required: - id - name - global_id - version - created_date - users security: - oauth2: [] tags: - User Group Resource put: operationId: put-profiles-profile-id-user-groups-user-group-id summary: Update a User Group description: '' parameters: - name: profile_id in: path description: id of the profile required: true schema: type: string example: self - name: user_group_id in: path description: id of the user group required: true schema: type: string example: self requestBody: content: application/json: schema: type: object properties: name: type: string examples: - testing123 responses: '200': description: OK headers: {} content: application/json: examples: response: value: id: 161236 schema: type: object properties: id: description: the updated user group id type: number required: - id security: - oauth2: [] tags: - User Group Resource /profiles/{profile_id}/user_groups/{user_group_id}/page_assignments: delete: operationId: delete-profiles-profile-id-user-groups-user-group-id-page-assignments summary: Delete a List of Page Assignments description: '' parameters: - name: profile_id in: path description: id of the profile required: true schema: type: string example: self - name: user_group_id in: path description: id of the user group required: true schema: type: number - name: fields in: query description: extra information of each page assignment on the list required: false schema: type: string - name: limit in: query description: maximum count of the page assignment list required: false schema: type: number example: '100' - name: offset in: query description: skip that many page assignment before beginning to return required: false schema: type: number example: '0' requestBody: content: application/json: schema: type: object properties: page_id: type: number examples: - 790771 responses: '200': description: OK headers: {} content: application/json: examples: response: value: - page_id: 790771 - page_id: 790774 schema: type: object properties: page_id: description: the deleted page id type: number required: - page_id security: - oauth2: [] tags: - User Group Resource get: operationId: get-profiles-profile-id-user-groups-user-group-id-page-assignments summary: Retrieve a List of Page Assignments description: '' parameters: - name: profile_id in: path description: id of the profile required: true schema: type: string example: self - name: user_group_id in: path description: id of the user group required: true schema: type: number - name: fields in: query description: extra information of each page assignment on the list required: false schema: type: string - name: limit in: query description: maximum count of the page assignment list required: false schema: type: number example: '100' - name: offset in: query description: skip that many page assignment before beginning to return required: false schema: type: number example: '0' responses: '200': description: OK headers: Total-Count: schema: type: string content: application/json: examples: response: value: - page_id: 790777 - page_id: 790771 - page_id: 790774 schema: type: object properties: can_collect: type: boolean can_view: type: boolean is_group: type: boolean page_id: type: number required: - page_id security: - oauth2: [] tags: - User Group Resource post: operationId: post-profiles-profile-id-user-groups-user-group-id-page-assignments summary: Create New Page Assignments description: '' parameters: - name: profile_id in: path description: id of the profile required: true schema: type: string example: self - name: user_group_id in: path description: id of the user group required: true schema: type: number requestBody: content: application/json: schema: type: object properties: can_collect: type: boolean examples: - true can_view: type: boolean examples: - true page_id: type: number examples: - 790777 required: - page_id responses: '201': description: Created headers: {} content: application/json: examples: response: value: - page_id: 790771 - page_id: 790774 schema: type: object properties: page_id: description: the created page id type: number required: - page_id security: - oauth2: [] tags: - User Group Resource put: operationId: put-profiles-profile-id-user-groups-user-group-id-page-assignments summary: Update a List of Page Assignments description: '' parameters: - name: profile_id in: path description: id of the profile required: true schema: type: string example: self - name: user_group_id in: path description: id of the user group required: true schema: type: number - name: fields in: query description: extra information of each page assignment on the list required: false schema: type: string - name: limit in: query description: maximum count of the page assignment list required: false schema: type: number example: '100' - name: offset in: query description: skip that many page assignment before beginning to return required: false schema: type: number example: '0' requestBody: content: application/json: schema: type: object properties: can_collect: type: boolean examples: - true can_view: type: boolean examples: - true page_id: type: number examples: - 790777 responses: '200': description: OK headers: {} content: application/json: examples: response: value: - page_id: 790771 - page_id: 790774 schema: type: object properties: page_id: description: the updated page id type: number required: - page_id security: - oauth2: [] tags: - User Group Resource /profiles/{profile_id}/user_groups/{user_group_id}/page_assignments/{page_id}: delete: operationId: delete-profiles-profile-id-user-groups-user-group-id-page-assignments-page-id summary: Delete a Page Assignment description: '' parameters: - name: profile_id in: path description: id of the profile required: true schema: type: string example: self - name: user_group_id in: path description: id of the user group required: true schema: type: number - name: page_id in: path description: id of the page required: true schema: type: number responses: '200': description: OK headers: {} content: application/json: examples: response: value: page_id: 790777 schema: type: object properties: page_id: description: the deleted page id type: number required: - page_id security: - oauth2: [] tags: - User Group Resource get: operationId: get-profiles-profile-id-user-groups-user-group-id-page-assignments-page-id summary: Retrieve a Page Assignment description: '' parameters: - name: profile_id in: path description: id of the profile required: true schema: type: string example: self - name: user_group_id in: path description: id of the user group required: true schema: type: number - name: page_id in: path description: id of the page required: true schema: type: number responses: '200': description: OK headers: {} content: application/json: examples: response: value: can_collect: true can_view: true is_group: false page_id: 790777 schema: type: object properties: can_collect: type: boolean can_view: type: boolean is_group: type: boolean page_id: type: number required: - page_id - is_group - can_collect - can_view security: - oauth2: [] tags: - User Group Resource put: operationId: put-profiles-profile-id-user-groups-user-group-id-page-assignments-page-id summary: Update a Page Assignment description: '' parameters: - name: profile_id in: path description: id of the profile required: true schema: type: string example: self - name: user_group_id in: path description: id of the user group required: true schema: type: number - name: page_id in: path description: id of the page required: true schema: type: number requestBody: content: application/json: schema: type: object properties: can_collect: type: boolean examples: - true can_view: type: boolean examples: - true responses: '200': description: OK headers: {} content: application/json: examples: response: value: page_id: 790777 schema: type: object properties: page_id: description: the updated page id type: number required: - page_id security: - oauth2: [] tags: - User Group Resource /profiles/{profile_id}/user_groups/{user_group_id}/users: delete: operationId: delete-profiles-profile-id-user-groups-user-group-id-users summary: Delete a List of Page Assignments description: '' parameters: - name: profile_id in: path description: id of the profile required: true schema: type: string example: self - name: user_group_id in: path description: id of the user group required: true schema: type: number - name: fields in: query description: extra information of each page assignment on the list required: false schema: type: string - name: limit in: query description: maximum count of the page assignment list required: false schema: type: number example: '100' - name: offset in: query description: skip that many page assignment before beginning to return required: false schema: type: number example: '0' requestBody: content: application/json: schema: type: object properties: user_id: type: number examples: - 2734 responses: '200': description: OK headers: {} content: application/json: examples: response: value: - user_id: 456124 - user_id: 875152 schema: type: object properties: user_id: description: the deleted user id type: number required: - user_id security: - oauth2: [] tags: - User Group Resource get: operationId: get-profiles-profile-id-user-groups-user-group-id-users summary: Retrieve a List of User Assignments description: '' parameters: - name: profile_id in: path description: id of the profile required: true schema: type: string example: self - name: user_group_id in: path description: id of the user group required: true schema: type: number - name: fields in: query description: extra information of each page assignment on the list required: false schema: type: string - name: limit in: query description: maximum count of the page assignment list required: false schema: type: number example: '100' - name: offset in: query description: skip that many page assignment before beginning to return required: false schema: type: number example: '0' responses: '200': description: OK headers: Total-Count: schema: type: string content: application/json: examples: response: value: - user_id: 159789 username: Michael - user_id: 169555 username: GeorgeMichael - user_id: 156487 username: GeorgeSr schema: type: object properties: user_id: type: number username: type: string required: - user_id - username security: - oauth2: [] tags: - User Group Resource post: operationId: post-profiles-profile-id-user-groups-user-group-id-users summary: Create New User Assignments description: '' parameters: - name: profile_id in: path description: id of the profile required: true schema: type: string example: self - name: user_group_id in: path description: id of the user group required: true schema: type: number requestBody: content: application/json: schema: type: object properties: user_id: type: number examples: - 415215 required: - user_id responses: '201': description: Created headers: {} content: application/json: examples: response: value: - page_id: 790771 - page_id: 790774 schema: type: object properties: user_id: description: the assigned user id(s) type: number required: - user_id security: - oauth2: [] tags: - User Group Resource /profiles/{profile_id}/user_groups/{user_group_id}/users/{user_id}: delete: operationId: delete-profiles-profile-id-user-groups-user-group-id-users-user-id summary: Delete a User Assignment description: '' parameters: - name: profile_id in: path description: id of the profile required: true schema: type: string example: self - name: user_group_id in: path description: id of the user group required: true schema: type: number - name: user_id in: path description: id of the user required: true schema: type: number responses: '200': description: OK headers: {} content: application/json: examples: response: value: user_id: 154477 schema: type: object properties: user_id: description: the deleted user id type: number required: - user_id security: - oauth2: [] tags: - User Group Resource get: operationId: get-profiles-profile-id-user-groups-user-group-id-users-user-id summary: Retrieve a User Assignment description: '' parameters: - name: profile_id in: path description: id of the profile required: true schema: type: string example: self - name: user_group_id in: path description: id of the user group required: true schema: type: number - name: user_id in: path description: id of the user required: true schema: type: number responses: '200': description: OK headers: {} content: application/json: examples: response: value: user_id: 155455 username: inspector schema: type: object properties: user_id: type: number username: type: string required: - user_id - username security: - oauth2: [] tags: - User Group Resource /profiles/{profile_id}/users: delete: operationId: delete-profiles-profile-id-users summary: Delete a List of Users description: '' parameters: - name: profile_id in: path description: id of the profile required: true schema: type: string example: self - name: fields in: query description: extra information of each user on the list required: false schema: type: string - name: limit in: query description: maximum count of the user list required: false schema: type: number example: '100' - name: offset in: query description: skip that many users before beginning to return required: false schema: type: number example: '0' requestBody: content: application/json: schema: type: object properties: id: type: number examples: - 161239 responses: '200': description: OK headers: {} content: application/json: examples: response: value: - id: 161239 - id: 161242 schema: type: object properties: id: description: the deleted user id type: number required: - id security: - oauth2: [] tags: - User Resource get: operationId: get-profiles-profile-id-users summary: Retrieve a List of Users description: '' parameters: - name: profile_id in: path description: id of the profile required: true schema: type: string example: self - name: fields in: query description: extra information of each user on the list required: false schema: type: string - name: limit in: query description: maximum count of the user list required: false schema: type: number example: '100' - name: offset in: query description: skip that many users before beginning to return required: false schema: type: number example: '0' responses: '200': description: OK headers: Total-Count: schema: type: string content: application/json: examples: response: value: - id: 161236 username: demo_user - id: 161239 username: inspector_1 - id: 161242 username: inspector_2 schema: type: object properties: created_date: type: string email: type: string first_name: type: string global_id: type: string id: type: number is_locked: type: boolean last_name: type: string roles: type: object properties: can_form_edit: type: boolean can_thunderplug_sync: type: boolean role: type: string username: type: string security: - oauth2: [] tags: - User Resource post: operationId: post-profiles-profile-id-users summary: Create New Users description: '' parameters: - name: profile_id in: path description: id of the profile required: true schema: type: string example: self requestBody: content: application/json: schema: type: object properties: can_form_edit: type: boolean examples: - true can_thunderplug_sync: type: boolean examples: - true email: type: string examples: - support@iformbuilder.com first_name: type: string examples: - Calvin last_name: type: string examples: - Ng password: type: string examples: - testing123 role: description: must match "server", "company" or "basic" type: string examples: - server username: type: string examples: - demo_user required: - username - password - email responses: '201': description: Created headers: {} content: application/json: examples: response: value: - id: 161239 - id: 161242 schema: type: object properties: id: description: the created user id type: number required: - id security: - oauth2: [] tags: - User Resource put: operationId: put-profiles-profile-id-users summary: Update a List of Users description: '' parameters: - name: profile_id in: path description: id of the profile required: true schema: type: string example: self - name: fields in: query description: extra information of each user on the list required: false schema: type: string - name: limit in: query description: maximum count of the user list required: false schema: type: number example: '100' - name: offset in: query description: skip that many users before beginning to return required: false schema: type: number example: '0' requestBody: content: application/json: schema: type: object properties: can_form_edit: type: boolean examples: - true can_thunderplug_sync: type: boolean examples: - true email: type: string examples: - support@iformbuilder.com first_name: type: string examples: - Calvin id: type: number examples: - 161239 is_locked: description: Can only unlock by using false type: boolean last_name: type: string examples: - Ng password: type: string examples: - testing123 role: description: must match "server", "company" or "basic" type: string examples: - server responses: '200': description: OK headers: {} content: application/json: examples: response: value: - id: 161239 - id: 161242 schema: type: object properties: id: description: the updated user id type: number required: - id security: - oauth2: [] tags: - User Resource /profiles/{profile_id}/users/{user_id}: delete: operationId: delete-profiles-profile-id-users-user-id summary: Delete a User description: '' parameters: - name: profile_id in: path description: id of the profile required: true schema: type: string example: self - name: user_id in: path description: id of the user required: true schema: type: string example: self responses: '200': description: OK headers: {} content: application/json: examples: response: value: id: 161236 schema: type: object properties: id: description: the deleted user id type: number required: - id security: - oauth2: [] tags: - User Resource get: operationId: get-profiles-profile-id-users-user-id summary: Retrieve a User description: '' parameters: - name: profile_id in: path description: id of the profile required: true schema: type: string example: self - name: user_id in: path description: id of the user required: true schema: type: string example: self responses: '200': description: OK headers: {} content: '*/*': schema: type: object properties: created_date: type: string email: type: string first_name: type: string global_id: type: string id: type: number is_locked: type: boolean last_name: type: string roles: type: object properties: can_form_edit: type: boolean can_thunderplug_sync: type: boolean role: type: string required: - role - can_form_edit - can_thunderplug_sync username: type: string required: - id - username - global_id - first_name - last_name - email - roles - created_date - is_locked security: - oauth2: [] tags: - User Resource put: operationId: put-profiles-profile-id-users-user-id summary: Update a User description: '' parameters: - name: profile_id in: path description: id of the profile required: true schema: type: string example: self - name: user_id in: path description: id of the user required: true schema: type: string example: self requestBody: content: application/json: schema: type: object properties: can_form_edit: type: boolean examples: - true can_thunderplug_sync: type: boolean examples: - true email: type: string examples: - support@iformbuilder.com first_name: type: string examples: - Calvin is_locked: description: Can only unlock user type: boolean last_name: type: string examples: - Ng password: type: string examples: - testing123 roles: description: must match "server", "company" or "basic" type: string examples: - server responses: '200': description: OK headers: {} content: application/json: examples: response: value: id: 161236 schema: type: object properties: id: description: the updated user id type: number required: - id security: - oauth2: [] tags: - User Resource /profiles/{profile_id}/users/{user_id}/page_assignments: delete: operationId: delete-profiles-profile-id-users-user-id-page-assignments summary: Delete a List of Page Assignments description: '' parameters: - name: profile_id in: path description: id of the profile required: true schema: type: string example: self - name: user_id in: path description: id of the user required: true schema: type: number - name: fields in: query description: extra information of each page assignment on the list required: false schema: type: string - name: limit in: query description: maximum count of the page assignment list required: false schema: type: number example: '100' - name: offset in: query description: skip that many page assignment before beginning to return required: false schema: type: number example: '0' requestBody: content: application/json: schema: type: object properties: page_id: type: number examples: - 790771 responses: '200': description: OK headers: {} content: application/json: examples: response: value: - page_id: 790771 - page_id: 790774 schema: type: object properties: page_id: description: the deleted page id type: number required: - page_id security: - oauth2: [] tags: - User Resource get: operationId: get-profiles-profile-id-users-user-id-page-assignments summary: Retrieve a List of Page Assignments description: '' parameters: - name: profile_id in: path description: id of the profile required: true schema: type: string example: self - name: user_id in: path description: id of the user required: true schema: type: number - name: fields in: query description: extra information of each page assignment on the list required: false schema: type: string - name: limit in: query description: maximum count of the page assignment list required: false schema: type: number example: '100' - name: offset in: query description: skip that many page assignment before beginning to return required: false schema: type: number example: '0' responses: '200': description: OK headers: Total-Count: schema: type: string content: application/json: examples: response: value: - page_id: 790777 - page_id: 790771 - page_id: 790774 schema: type: object properties: can_collect: type: boolean can_view: type: boolean is_disabled: type: boolean page_id: type: number required: - page_id security: - oauth2: [] tags: - User Resource post: operationId: post-profiles-profile-id-users-user-id-page-assignments summary: Create New Page Assignments description: '' parameters: - name: profile_id in: path description: id of the profile required: true schema: type: string example: self - name: user_id in: path description: id of the user required: true schema: type: number requestBody: content: application/json: schema: type: object properties: can_collect: type: boolean examples: - true can_view: type: boolean examples: - true page_id: type: number examples: - 790777 required: - page_id responses: '201': description: Created headers: {} content: application/json: examples: response: value: - page_id: 790771 - page_id: 790774 schema: type: object properties: page_id: description: the created page id type: number required: - page_id security: - oauth2: [] tags: - User Resource put: operationId: put-profiles-profile-id-users-user-id-page-assignments summary: Update a List of Page Assignments description: '' parameters: - name: profile_id in: path description: id of the profile required: true schema: type: string example: self - name: user_id in: path description: id of the user required: true schema: type: number - name: fields in: query description: extra information of each page assignment on the list required: false schema: type: string - name: limit in: query description: maximum count of the page assignment list required: false schema: type: number example: '100' - name: offset in: query description: skip that many page assignment before beginning to return required: false schema: type: number example: '0' requestBody: content: application/json: schema: type: object properties: can_collect: type: boolean examples: - true can_view: type: boolean examples: - true page_id: type: number examples: - 790777 responses: '200': description: OK headers: {} content: application/json: examples: response: value: - page_id: 790771 - page_id: 790774 schema: type: object properties: page_id: description: the updated page id type: number required: - page_id security: - oauth2: [] tags: - User Resource /profiles/{profile_id}/users/{user_id}/page_assignments/{page_id}: delete: operationId: delete-profiles-profile-id-users-user-id-page-assignments-page-id summary: Delete a Page Assignment with Page/User ID description: '' parameters: - name: profile_id in: path description: id of the profile required: true schema: type: string example: self - name: user_id in: path description: id of the user required: true schema: type: number - name: page_id in: path description: id of the page required: true schema: type: number responses: '200': description: OK headers: {} content: application/json: examples: response: value: page_id: 790777 schema: type: object properties: page_id: description: the deleted page id type: number required: - page_id security: - oauth2: [] tags: - User Resource get: operationId: get-profiles-profile-id-users-user-id-page-assignments-page-id summary: Retrieve a Page Assignment with Page/User ID description: '' parameters: - name: profile_id in: path description: id of the profile required: true schema: type: string example: self - name: user_id in: path description: id of the user required: true schema: type: number - name: page_id in: path description: id of the page required: true schema: type: number responses: '200': description: OK headers: {} content: application/json: examples: response: value: can_collect: true can_view: true page_id: 790777 schema: type: object properties: can_collect: type: boolean can_view: type: boolean page_id: type: number required: - page_id - can_collect - can_view security: - oauth2: [] tags: - User Resource put: operationId: put-profiles-profile-id-users-user-id-page-assignments-page-id summary: Update a Page Assignment with Page/User ID description: '' parameters: - name: profile_id in: path description: id of the profile required: true schema: type: string example: self - name: user_id in: path description: id of the user required: true schema: type: number - name: page_id in: path description: id of the page required: true schema: type: number requestBody: content: application/json: schema: type: object properties: can_collect: type: boolean examples: - true can_view: type: boolean examples: - true responses: '200': description: OK headers: {} content: application/json: examples: response: value: page_id: 790777 schema: type: object properties: page_id: description: the updated page id type: number required: - page_id security: - oauth2: [] tags: - User Resource /profiles/{profile_id}/users/{user_id}/record_assignments: delete: operationId: delete-profiles-profile-id-users-user-id-record-assignments summary: Delete a List of Record Assignments description: '' parameters: - name: profile_id in: path description: id of the profile required: true schema: type: string example: self - name: user_id in: path description: id of the user required: true schema: type: string example: self - name: fields in: query description: extra information of each page assignment on the list required: false schema: type: string - name: limit in: query description: maximum count of the page assignment list required: false schema: type: number example: '100' - name: offset in: query description: skip that many page assignment before beginning to return required: false schema: type: number example: '0' requestBody: content: application/json: schema: type: object properties: id: type: number examples: - 529 responses: '200': description: OK headers: {} content: application/json: examples: response: value: - id: 529 - id: 532 schema: type: object properties: id: description: the deleted assignment id type: number required: - id security: - oauth2: [] tags: - User Resource get: operationId: get-profiles-profile-id-users-user-id-record-assignments summary: Retrieve a List of Record Assignments description: '' parameters: - name: profile_id in: path description: id of the profile required: true schema: type: string example: self - name: user_id in: path description: id of the user required: true schema: type: string example: self - name: fields in: query description: extra information of each page assignment on the list required: false schema: type: string - name: limit in: query description: maximum count of the page assignment list required: false schema: type: number example: '100' - name: offset in: query description: skip that many page assignment before beginning to return required: false schema: type: number example: '0' responses: '200': description: OK headers: Total-Count: schema: type: string content: application/json: examples: response: value: - id: 526 page_id: 790777 record_id: 4 - id: 529 page_id: 790777 record_id: 1 - id: 532 page_id: 790777 record_id: 7 schema: type: object properties: id: type: number page_id: type: number record_id: type: number required: - id - page_id - record_id security: - oauth2: [] tags: - User Resource post: operationId: post-profiles-profile-id-users-user-id-record-assignments summary: Create New Record Assignments description: '' parameters: - name: profile_id in: path description: id of the profile required: true schema: type: string example: self - name: user_id in: path description: id of the user required: true schema: type: string example: self requestBody: content: application/json: schema: type: object properties: page_id: type: number examples: - 790777 record_id: type: number examples: - 4 required: - page_id - record_id responses: '201': description: Created headers: {} content: application/json: examples: response: value: - id: 529 - id: 532 schema: type: object properties: id: description: the created assignment id type: number required: - id security: - oauth2: [] tags: - User Resource /profiles/{profile_id}/users/{user_id}/record_assignments/{assignment_id}: delete: operationId: delete-profiles-profile-id-users-user-id-record-assignments-assignment-id summary: Delete a Record Assignment description: '' parameters: - name: profile_id in: path description: id of the profile required: true schema: type: string example: self - name: user_id in: path description: id of the user required: true schema: type: string example: self - name: assignment_id in: path description: id of the record assignment required: true schema: type: number responses: '200': description: OK headers: {} content: application/json: examples: response: value: id: 526 schema: type: object properties: id: description: the deleted assignment id type: number required: - id security: - oauth2: [] tags: - User Resource get: operationId: get-profiles-profile-id-users-user-id-record-assignments-assignment-id summary: Retrieve a Record Assignment description: '' parameters: - name: profile_id in: path description: id of the profile required: true schema: type: string example: self - name: user_id in: path description: id of the user required: true schema: type: string example: self - name: assignment_id in: path description: id of the record assignment required: true schema: type: number responses: '200': description: OK headers: {} content: application/json: examples: response: value: id: 526 page_id: 790777 record_id: 4 schema: type: object properties: id: type: number page_id: type: number record_id: type: number required: - id - page_id - record_id security: - oauth2: [] tags: - User Resource /token: get: operationId: get-token summary: Inspect Token Attributes description: '' responses: '200': description: OK headers: {} content: application/json: examples: response: value: client_id: 2a05f7663e0fe740f7ed01c02097cbf564e26c0b expires_in: 1458 user: profile_id: 161435 user_id: 161015 username: calvinng schema: type: object properties: client_id: description: client id of the access token type: string expires_in: description: remaining time on the access token in seconds type: number user: description: owner of the access token type: object properties: {} user_profile_id: description: profile id of the authenticated user type: number user_user_id: description: user id of the authenticated user type: number user_username: description: username of the authenticated user type: string required: - client_id - expires_in - user - user.username - user.user_id - user.profile_id security: - oauth2: [] tags: - Token Resource components: schemas: Company_Info: {} Create_New_Element_Dynamic_Attribute: {} Create_New_Page_Dynamic_Attribute: {} Device_License: {} Device_License_Collection: {} Element: {} Element_Attribute_Collection: {} Element_Collection: {} Element_Dynamic_Attribute_Collection: {} Element_Dynamic_Attributes: {} Element_Localization: {} Element_Localization_Collection: {} Media: {} New_Element_Creation: {} New_Element_Localization_Creation: {} New_Option_Creation: {} New_Option_Localization_Creation: {} New_Optionlist_Creation: {} New_Page_Assignment_Creation: {} New_Page_Creation: {} New_Page_Email_Alert_Creation: {} New_Page_Group_Creation: {} New_Page_Group_User_Assignment_Creation: {} New_Page_HTTP_Callback_Creation: {} New_Page_Localization_Creation: {} New_Profile_Creation: {} New_Record_Assignment_Creation: {} New_Record_Creation: {} New_Shared_Page_Creation: {} New_User_Creation: {} New_User_Group_Creation: {} Notification: {} Option: {} Option_Collection: {} Option_Localization: {} Option_Localization_Collection: {} Optionlist: {} Optionlist_Collection: {} Page: {} Page_Assignment: {} Page_Assignment_Collection: {} Page_Attribute_Collection: {} Page_Collection: {} Page_Dynamic_Attribute_Collection: {} Page_Dynamic_Attributes: {} Page_Email_Alert_Collection: {} Page_Feed: {} Page_Group: {} Page_Group_Collection: {} Page_Group_Page_Assignment: {} Page_Group_User_Assignment: {} Page_Group_User_Assignment_Collection: {} Page_HTTP_Callback: {} Page_HTTP_Callback_Collection: {} Page_Localization: {} Page_Localization_Collection: {} Page_Record_Assignment: {} Profile: {} Profile_Collection: {} Record: {} Record_Assignment: {} Record_Assignment_Collection: {} Record_Collection: {} Shared_Page_Collection: {} Token: {} Trigger_Record_Post: {} User: {} User_Assignment: {} User_Assignment_Collection: {} User_Collection: {} User_Group: {} User_Group_Collection: {} requestBodies: Assign_Page_to_Page_GroupBody: content: application/json: schema: type: array items: properties: page_id: type: number required: - page_id type: object examples: - - page_id: 11261236 - page_id: 11261239 Create_New_Page_AssignmentsBody: content: application/json: schema: type: object properties: can_collect: type: boolean examples: - true can_view: type: boolean examples: - true page_id: type: number examples: - 790777 required: - page_id Create_New_Page_AssignmentsBody2: content: application/json: schema: type: object properties: can_collect: type: boolean examples: - true can_view: type: boolean examples: - true user_id: type: number examples: - 161236 required: - user_id Delete_a_List_of_Page_AssignmentsBody: content: application/json: schema: type: object properties: page_id: type: number examples: - 790771 Delete_a_List_of_Page_AssignmentsBody2: content: application/json: schema: type: object properties: user_id: type: number examples: - 161239 Delete_a_List_of_Page_Dynamic_AttributesBody: content: application/json: schema: type: object properties: attribute_name: type: string examples: - '``' required: - attribute_name Delete_a_List_of_Page_Email_AlertsBody: content: application/json: schema: type: object properties: email: type: string examples: - support@iformbuilder.com required: - email Delete_a_List_of_Page_LocalizationsBody: content: application/json: schema: type: object properties: language_code: type: string examples: - zh-hans Update_a_List_of_Page_AssignmentsBody: content: application/json: schema: type: object properties: can_collect: type: boolean examples: - true can_view: type: boolean examples: - true page_id: type: number examples: - 790777 Update_a_List_of_Page_AssignmentsBody2: content: application/json: schema: type: object properties: can_collect: type: boolean examples: - true can_view: type: boolean examples: - true user_id: type: number examples: - 161236 Update_a_Page_Assignment_with_Page_User_IDBody: content: application/json: schema: type: object properties: can_collect: type: boolean examples: - true can_view: type: boolean examples: - true Update_a_Shared_Page_EntryBody: content: application/json: schema: type: object properties: {} securitySchemes: oauth2: flows: authorizationCode: authorizationUrl: / scopes: {} tokenUrl: / type: oauth2 tags: - name: Token Resource - name: Profile Resource - name: User Resource - name: User Group Resource - description: |-

    General Notes:

  • When using DELETE on a page, all records must be deleted first.
    • name: Page Resource - name: Page Group Resource - description: |-

    General Notes:

  • When adding Smart Table Search to an element, smart_tbl_search and smart_tbl_search_col both have to be defined together and and must point to valid resources (form name, element name)
    • name: Element Resource - name: Optionlist Resource - description: |-

    General Notes:

  • To search for null values in the API, you can put an empty string in search criteria. fields=first_name(="")
    • name: Record Resource - name: Notification Resource - name: Private Media Resource - name: Device License Resource