{"openapi":"3.0.3","info":{"title":"iFormBuilder API v8.1","version":"1.0.0","description":"The main advantage in this version (v81) is the ability to let users define the responses. By only requesting key information, you can more efficiently use resources instead of retrieving a full API feed, and parsing out unused fields.\n\nThis approach can be used with any resource that doesn't specify an ID, such as a list of elements or users.\n\nThe documentation is broken down into resource categories and you can see formatted code samples for various languages in the console on the right.\n\n\u003ca href = \"https://zerion.my.site.com/helpcenter/s/article/APIVersionHistoryChangelog66b5bb04bf3b5\" target=\"_blank\" rel=\"noopener\"\u003eCheckout our API Changelog and other documentation\u003c/a\u003e.\n\n## Base URL to Make Requests\n\nTo make a request, the base URL will look something like \u003ccode\u003ehttps://[region].iformbuilder.com/exzact/api/v81/[servername]\u003c/code\u003e\n\nThe \u003cb\u003eregion\u003c/b\u003e is where your server is located.  The table below shows what the subdomain would be for each region.\n\n\u003ctable\u003e\n\u003cthead\u003e\n  \u003ctr\u003e\n    \u003cth\u003eRegion\u003c/th\u003e\n    \u003cth\u003eSubdomain\u003c/th\u003e\n  \u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n  \u003ctr\u003e\n    \u003ctd\u003eUnited States\u003c/td\u003e\n    \u003ctd\u003eapi\u003c/td\u003e\n  \u003c/tr\u003e\n  \u003ctr\u003e\n    \u003ctd\u003eAustralia\u003c/td\u003e\n    \u003ctd\u003eau-api\u003c/td\u003e\n  \u003c/tr\u003e\n  \u003ctr\u003e\n    \u003ctd\u003eUnited Kingdom\u003c/td\u003e\n    \u003ctd\u003euk-api\u003c/td\u003e\n  \u003c/tr\u003e\n  \u003ctr\u003e\n    \u003ctd\u003eHipaa\u003c/td\u003e\n    \u003ctd\u003ehipaa-api\u003c/td\u003e\n  \u003c/tr\u003e  \n\u003c/tbody\u003e\n\u003c/table\u003e\n\nFor \u003cb\u003eservername\u003c/b\u003e, you would use the subdomain used to access iFormBuilder.  For example, if you want to use the API for app.iformbuilder.com, the URL would like \u003ccode\u003ehttps://api.iformbuilder.com/exzact/api/v81/app\u003c/code\u003e\n\n## General Notes\n\n\u003cli\u003e\u003cb\u003eMost 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.\u003c/b\u003e\u003c/li\u003e\n\u003cli\u003eDefault response will be returned when invalid grammar is passed into the request.\u003c/li\u003e\n\u003cli\u003eField grammar can include filters (single or multiple conditions) and sort order.\u003c/li\u003e\n\n\u003ch3\u003e\u003cb\u003eUsing Parameters\u003c/b\u003e\u003c/h3\u003e\n\n\u003cli\u003eParameters will allow you to refine the request and consist of the following:\u003c/li\u003e\n\u003cli\u003e\u003cb\u003efields:\u003c/b\u003e Allows you to specify which attributes are returned.  Filter and sort priority can be assigned to each field.  \u003c/li\u003e\n\u003cli\u003e\u003cb\u003elimit:\u003c/b\u003e Allows you to specify how many results are returned.\u003c/li\u003e\n\u003cli\u003e\u003cb\u003eoffset:\u003c/b\u003e Allows you to specify number of results to skip.\u003c/li\u003e\n\u003cli\u003e\u003cb\u003evalidate_grammar:\u003c/b\u003eReturns an error for incorrect field grammar when set to true.\u003c/li\u003e\n\u003cli\u003e\u003cb\u003eall_fields:\u003c/b\u003e When using list endpoints, setting this to 1 will return all fields for each object instead of just the defaul IDs.\u003c/li\u003e\n\u003cli\u003e\u003cb\u003eexclude:\u003c/b\u003e Allows you to specific fields you don't want to return.\u003c/li\u003e\n\n\u003cli\u003eFor example, this url would only provide the record ids.  \u003cbr\u003e\u003cblockquote\u003ehttps://api.iformbuilder.com/exzact/api/v81/[servername]/profiles/10978/pages/290749032/records\u003c/blockquote\u003e\u003c/li\u003e\n\u003cli\u003eThis example demonstrates returning first name, last name, age, and state.  This will also skip the first record only display 2 after that.  \u003cbr\u003e\u003cblockquote\u003ehttps://api.iformbuilder.com/exzact/api/v81/[servername]/profiles/10978/pages/290749032/records?\u003cb\u003efields=first_name,last_name,residing_state,age\u0026offset=1\u0026limit=2\u003c/b\u003e\u003c/blockquote\u003e\u003c/li\u003e\n\u003cli\u003eYou can also specify which subform fields you want.  In this example, we will have a subform called 'children_subform' with some fields in it.  \u003cbr\u003e\u003cblockquote\u003ehttps://api.iformbuilder.com/exzact/api/v81/[servername]/profiles/10978/pages/290749032/records?\u003cb\u003efields=first_name,last_name,residing_state,age,children_subform[child_name,child_age,child_height]\u0026offset=1\u0026limit=2\u003c/b\u003e\u003c/blockquote\u003e\u003c/li\u003e\n\n## Rate Limiting\n\n\u003cli\u003eTo help protect the integrity of our system, we implemented rate limiting.  When reaching our limit, the status code will be a 429 and the body will be \u003ccode\u003e{\"error_message\": \"API rate limit exceeded\"}\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eThe limit is set to 100 calls per minute per endpoint.  This means that you can send 100 requests a minute to both pages and user endpoints.  However, making multiple calls to different resources in the same endpoint will be added to same total.  Meaning, if you make 50 calls for \u003ccode\u003e/pages/12345/records\u003c/code\u003e and 50 calls to \u003ccode\u003e/pages/98765/records\u003c/code\u003e in a minute, you have reached the limit.\n\u003cli\u003eFeel free to contact us if the limits are affecting your workflow.\u003c/li\u003e\n\n## Sorting Fields\n\n\u003cli\u003eTo sort by column(s), there are three components:\u003c/li\u003e\n\u003cli\u003e\u003cb\u003eColumn:\u003c/b\u003e The field you want to sort by\u003c/li\u003e\n\u003cli\u003e\u003cb\u003eOperator:\u003c/b\u003e These consist of \u003c (ascending) and  \u003e (descending)\u003c/li\u003e\n\u003cli\u003e\u003cb\u003eSort Priority:\u003c/b\u003e  When sorting by multiple columns, you set priority by designating a number after the operator.\u003c/li\u003e\n\u003cli\u003eIn this example, age has first priority in ascending order followed by first name in descending order. \u003cbr\u003e\u003cblockquote\u003e https://api.iformbuilder.com/exzact/api/v81/[servername]/profiles/10978/pages/290749032/records?\u003cb\u003efields=first_name:\u003e2,age:\u0026lt;1 \u003c/b\u003e \u003c/blockquote\u003e\u003c/li\u003e\n\n## Filtering Fields\n\n\u003cp\u003eAdding filters will narrow down your request output or input.  This can be used with both GET and PUT requests.\u003cbr\u003e\n\u003cb\u003eGET:\u003c/b\u003e Will return any data that meets your filter’s rules.\u003cbr\u003e\n\u003cb\u003ePUT:\u003c/b\u003e 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.\u003c/p\u003e\n\n\u003cli\u003e\u003cb\u003eThree Components of Filtering\u003c/b\u003e\u003c/li\u003e\n\u003cli\u003e\u003cb\u003eColumn:\u003c/b\u003e The field you want to filter\u003c/li\u003e\n\u003cli\u003e\u003cb\u003eOperator:\u003c/b\u003e These consist of \u003c, \u003c=, \u003e, \u003e=, =, ~, and !=\u003c/li\u003e\n\u003cli\u003e\u003cb\u003eValue:\u003c/b\u003eThe value you are basing your filter on.  Boolean values can be passed in either as true and false, or 0 and 1.\u003c/li\u003e\n\n## Examples\n\n\u003cli\u003eGet everyone who is between 18 AND 65 (Note: the '\u0026' symbol may need to be url encoded which is '%26') \u003cbr\u003e\u003cblockquote\u003e\u003cb\u003eage((\u003e=\"18\")\u0026(\u003c=\"65\"))\u003c/b\u003e\u003c/blockquote\u003e\u003c/br\u003e or encoded\u003cblockquote\u003e\u003cb\u003eage((\u003e=\"18\")%26(\u003c=\"65\"))\u003c/b\u003e\u003c/blockquote\u003e\u003c/li\u003e\n\u003cli\u003eGet everyone that is younger than 18 OR older than 65 \u003cbr\u003e\u003cblockquote\u003e\u003cb\u003eage((\u003e=\"18\")|(\u003c=\"65\"))\u003c/blockquote\u003e\u003c/b\u003e\u003c/li\u003e\n\u003cli\u003eGet all first names that start with 'K' \u003cbr\u003e\u003cblockquote\u003e\u003cb\u003efirst_name(~\"K%\")\u003c/blockquote\u003e\u003c/b\u003e\u003c/li\u003e\n\u003cli\u003eGet all last names that end with 'son' \u003cbr\u003e\u003cblockquote\u003e \u003cb\u003elast_name(~\"%son\")\u003c/b\u003e\u003c/blockquote\u003e\u003c/li\u003e\n\u003cli\u003eGet all middle names that contain 'mit' \u003cbr\u003e\u003cblockquote\u003e \u003cb\u003emiddle_name(~\"%mit%\")\u003c/b\u003e\u003c/blockquote\u003e\u003c/li\u003e\n\u003cli\u003eGet everyone who is not the age of 23\u003cbr\u003e\u003cblockquote\u003e \u003cb\u003eage(!=\"23\")\u003c/b\u003e\u003c/blockquote\u003e\u003c/li\u003e\n\u003cli\u003eNow combining 4 examples above in a URL.\u003cbr\u003e\u003cblockquote\u003ehttps://api.iformbuilder.com/exzact/api/v81/[servername]/profiles/10978/pages/290749032/records?fields=\u003cb\u003eage((\u003e=\"18\")|(\u003c=\"65\")),first_name(~\"K%\"),last_name(~\"%son\"),middle_name(~\"%mit%\")\u003c/b\u003e\u003c/blockquote\u003e\u003c/li\u003e\n\u003cli\u003e\u003cb\u003eNote:\u003c/b\u003e If trying to filter a field that is \u003cb\u003elike\u003c/b\u003e 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:\u003cbr\u003e\u003cblockquote\u003ehttps://api.iformbuilder.com/exzact/api/v81/[servername]/profiles/10978/pages/290749032/records?fields=length(~\"\u003cb\u003e%25\u003c/b\u003e12\")\u003c/blockquote\u003e\u003c/li\u003e\n\n\u003cli\u003e\u003cb\u003eFilter Multiple Fields with\u003c/b\u003e\u003c/li\u003e\n\u003cli\u003eTo search a value inside multiple fields, you can use dashes to search multiple columns of the same value.  For example,\u003c/li\u003e\n\u003cli\u003eGet all first names OR last names that start with 'K' \u003cbr\u003e\u003cblockquote\u003e\u003cb\u003efirst_name-last_name(~\"K%\")\u003c/blockquote\u003e\u003c/b\u003e\u003c/li\u003e\n\n\u003cli\u003e\u003cb\u003eSearching Multiple Specific Values\u003c/b\u003e\u003c/li\u003e\n\u003cli\u003eThis will allow you to pass in multiple specifc values you want the query to return.  Form example,\u003c/li\u003e\n\u003cli\u003eGet both records for ids 12345 AND 98765 \u003cbr\u003e\u003cblockquote\u003e\u003cb\u003eid(=\"12345\"|=\"98765\")\u003c/blockquote\u003e\u003c/b\u003e\u003c/li\u003e\n\n## Request Access Token for Using API\n\n\u003cli\u003eEvery request, except the token request itself, needs an access token sent as \u003ccode\u003eAuthorization: Bearer {access_token}\u003c/code\u003e. A token grants access to any resource its user can access and expires after 3600 seconds.\u003c/li\u003e\n\u003cli\u003eGet a token from \u003ccode\u003ePOST /oauth/token\u003c/code\u003e (\u003ccode\u003ehttps://api.iformbuilder.com/exzact/api/v81/[servername]/oauth/token\u003c/code\u003e) using one of the supported OAuth 2.0 grant types: \u003cb\u003eJWT bearer\u003c/b\u003e (\u003ccode\u003eurn:ietf:params:oauth:grant-type:jwt-bearer\u003c/code\u003e, recommended for API apps), \u003cb\u003epassword\u003c/b\u003e, \u003cb\u003eauthorization_code\u003c/b\u003e or \u003cb\u003erefresh_token\u003c/b\u003e. See \u003cb\u003eToken Resource \u0026gt; Request Access Token\u003c/b\u003e for the parameters of each flow.\u003c/li\u003e\n\u003cli\u003eFor a walkthrough of creating an API app (client key and secret) and generating a token, see \u003ca href = \"https://zerion.my.site.com/helpcenter/s/article/APIWhataretheAPIAppsStartHere66b5e66b876e5\" target=\"_blank\" rel=\"noopener\"\u003eGenerating Access Token\u003c/a\u003e.\u003c/li\u003e"},"servers":[{"url":"https://api.iformbuilder.com/exzact/api/v81/[servername]"}],"security":[{"oauth2":[]}],"paths":{"/oauth/token":{"post":{"security":[],"responses":{"200":{"description":"OK - the access token was issued.","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OAuthTokenOutcome"},"examples":{"access_token":{"summary":"JWT bearer, password, refresh_token, or online authorization_code","value":{"access_token":"0123456789abcdef0123456789abcdef01234567","token_type":"Bearer","expires_in":3600}},"offline":{"summary":"authorization_code with access_type=offline","value":{"access_token":"0123456789abcdef0123456789abcdef01234567","refresh_token":"76543210fedcba9876543210fedcba9876543210","token_type":"Bearer","expires_in":3600}}}}}},"400":{"description":"Bad Request - missing or invalid parameters, an unsupported grant type, an API app not enabled for the grant, bad user credentials, or a rejected JWT assertion. See the error table in the description.","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OAuthTokenError"},"examples":{"invalid_request":{"summary":"missing grant_type or a required parameter","value":{"error":"invalid_request"}},"unsupported_grant_type":{"summary":"grant_type is not supported","value":{"error":"unsupported_grant_type"}},"unauthorized_client":{"summary":"API app is not enabled for this grant type","value":{"error":"unauthorized_client"}},"invalid_code":{"summary":"authorization code or refresh token is invalid, expired or mismatched","value":{"error_message":"invalid_grant"}},"invalid_grant":{"summary":"password grant with credentials that cannot sign in (error_description), or a JWT assertion that is malformed or whose header, claims, timing or signature was rejected (error only)","value":{"error":"invalid_grant","error_description":"Account not activated"}}}}}},"401":{"description":"Unauthorized - the `client_id` is unknown, the `client_secret` is empty or wrong, or the JWT `iss` is not a client key on this server (all `invalid_client`).","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OAuthTokenError"},"examples":{"invalid_client":{"summary":"wrong client_secret","value":{"error":"invalid_client"}},"unknown_client":{"summary":"unknown client_id, or JWT iss is not a client key on this server","value":{"error":"invalid_client"}}}}}}},"summary":"Request Access Token","operationId":"Request Access Token","description":"Issues an access token. Send the returned `access_token` as `Authorization: Bearer {access_token}` on every other request; it grants access to any resource the token's user can access. This endpoint itself does not take a bearer token.\n\nParameters can be sent as `application/x-www-form-urlencoded` or `application/json`. Unknown parameters are ignored.\n\n### Grant types\n\n| `grant_type` | Required parameters | Notes |\n|---|---|---|\n| `urn:ietf:params:oauth:grant-type:jwt-bearer` | `assertion` | Recommended for server-to-server API apps. No `client_id`/`client_secret`: the client key is the JWT `iss`, and the token is issued for the user the API app belongs to. |\n| `password` | `username`, `password`, `client_id`, `client_secret` | The token is issued for the iFormBuilder user in `username`. |\n| `authorization_code` | `code`, `redirect_uri`, `client_id`, `client_secret` | `redirect_uri` must match the one used on the authorize page. Optional `access_type=offline` also returns a `refresh_token`. |\n| `refresh_token` | `refresh_token`, `client_id`, `client_secret` | Returns a new access token for the user the refresh token was issued to. `code` is accepted in place of `refresh_token`. No new refresh token is returned. |\n\nThe API app must be enabled for the grant type it requests, otherwise the response is `unauthorized_client`.\n\n### Client authentication\n\nFor every grant except JWT bearer, send `client_id` and `client_secret` in the request body, or as HTTP Basic credentials (`Authorization: Basic base64({client_id}:{client_secret})`). Basic credentials take precedence over body values.\n\n### JWT bearer assertion\n\n`assertion` is a JWT signed with the API app's client secret.\n\n- **Header:** `{\"alg\": \"HS256\", \"typ\": \"JWT\"}`. `HS384` and `HS512` are also accepted.\n- **Claims:**\n  - `iss` - the API app's client key\n  - `aud` - the full URL of this endpoint, including the API version and server name: `https://api.iformbuilder.com/exzact/api/v81/[servername]/oauth/token`. Use the host you send the request to (for example `uk-api.iformbuilder.com` in the UK region). The version segment must match the version you call; a `v80` audience is rejected here.\n  - `iat` - issued-at time, in Unix seconds\n  - `exp` - expiry time, in Unix seconds. It must be in the future, not before `iat`, and no more than 600 seconds after `iat`.\n- **Signature:** the HMAC (SHA-256, SHA-384 or SHA-512, matching `alg`) of `base64url(header) + \".\" + base64url(claims)`, keyed with the client secret and base64url-encoded.\n\n### Authorization code flow\n\n1. Send the user's browser to the authorize page on your iFormBuilder server: `https://[servername].iformbuilder.com/exzact/api/oauth/auth?response_type=code\u0026client_id={client_id}\u0026redirect_uri={redirect_uri}\u0026state={state}` (`state` is optional but recommended: generate an unguessable value and check that it matches on return to protect against CSRF).\n2. After the user signs in, the browser is redirected to `redirect_uri` with `code` (and `state`). The code expires after 5 minutes.\n3. Exchange the code here with `grant_type=authorization_code`, the same `redirect_uri`, and the client credentials. Add `access_type=offline` to also receive a `refresh_token`.\n\n### Response\n\n`access_token`, `token_type` (always `Bearer`) and `expires_in` (seconds; currently 3600). `refresh_token` is included only for `authorization_code` with `access_type=offline`.\n\nCache the access token and reuse it until it expires; don't request a new token for every API call.\n\n### Errors\n\nMost errors return a JSON object with `error`. A failed `password` grant also includes `error_description` when the failure is a known sign-in outcome (invalid credentials, inactive account or company, locked account, SSO required, expired session); an unexpected server-side failure returns `invalid_grant` with no description.\n\n| HTTP | `error` | Cause |\n|---|---|---|\n| `400` | `invalid_request` | `grant_type` or another required parameter (including `client_secret`) is missing, a parameter is not a string, or `access_type`/`redirect_uri` is not valid |\n| `400` | `unsupported_grant_type` | `grant_type` is not one of the four values above |\n| `401` | `invalid_client` | `client_id` is not a known API app, `client_secret` is empty or wrong, or the JWT `iss` is not a client key on this server |\n| `400` | `unauthorized_client` | the API app is not enabled for this grant type (including the JWT bearer grant) |\n| `400` | `invalid_grant` | the `password` grant could not sign the user in (see `error_description`, omitted for unexpected server-side failures), or the `assertion` was rejected: not a three-part JWT, the header is missing `alg`/`typ` or `alg` is not `HS256`, `HS384` or `HS512`, `iss`, `iat` or `exp` is missing, `aud` does not match this endpoint's URL, `exp` is in the past, before `iat` or more than 600 seconds after `iat`, or the signature does not match the client secret |\n\nAn authorization `code` that is unknown, expired, issued to another API app or used with a different `redirect_uri`, or a `refresh_token` that is unknown or issued to another API app, returns `400` with `{\"error_message\": \"invalid_grant\"}` (an `error_message` key, not `error`).","tags":["Token Resource"],"parameters":[{"name":"Authorization","in":"header","description":"optional HTTP Basic client authentication, e.g. Basic base64({client_id}:{client_secret}); an alternative to client_id/client_secret in the body. Not used by the JWT bearer grant.","required":false,"schema":{"type":"string"},"example":"Basic base64({client_id}:{client_secret})"}],"requestBody":{"required":true,"content":{"application/x-www-form-urlencoded":{"schema":{"$ref":"#/components/schemas/OAuthTokenRequest"},"examples":{"jwt_bearer":{"summary":"JWT bearer (API apps)","value":{"grant_type":"urn:ietf:params:oauth:grant-type:jwt-bearer","assertion":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiIwMTIzNDU2Nzg5YWJjZGVmIiwiYXVkIjoiLi4uIiwiaWF0IjoxNzkxMjUwMDAwLCJleHAiOjE3OTEyNTA2MDB9.c2lnbmF0dXJl"}},"password":{"summary":"Password","value":{"grant_type":"password","username":"demo_user","password":"********","client_id":"0123456789abcdef0123456789abcdef01234567","client_secret":"fedcba9876543210fedcba9876543210fedcba98"}},"authorization_code":{"summary":"Authorization code (offline)","value":{"grant_type":"authorization_code","code":"1a2b3c4d5e6f7a8b9c0d1e2f3a4b5c6d7e8f9a0b","redirect_uri":"https://example.com/oauth/callback","access_type":"offline","client_id":"0123456789abcdef0123456789abcdef01234567","client_secret":"fedcba9876543210fedcba9876543210fedcba98"}},"refresh_token":{"summary":"Refresh token","value":{"grant_type":"refresh_token","refresh_token":"76543210fedcba9876543210fedcba9876543210","client_id":"0123456789abcdef0123456789abcdef01234567","client_secret":"fedcba9876543210fedcba9876543210fedcba98"}}}},"application/json":{"schema":{"$ref":"#/components/schemas/OAuthTokenRequest"},"examples":{"jwt_bearer":{"summary":"JWT bearer (API apps)","value":{"grant_type":"urn:ietf:params:oauth:grant-type:jwt-bearer","assertion":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiIwMTIzNDU2Nzg5YWJjZGVmIiwiYXVkIjoiLi4uIiwiaWF0IjoxNzkxMjUwMDAwLCJleHAiOjE3OTEyNTA2MDB9.c2lnbmF0dXJl"}},"password":{"summary":"Password","value":{"grant_type":"password","username":"demo_user","password":"********","client_id":"0123456789abcdef0123456789abcdef01234567","client_secret":"fedcba9876543210fedcba9876543210fedcba98"}}}}}}}},"/branding":{"get":{"security":[],"responses":{"200":{"description":"OK - the eight colors. The response carries `Cache-Control` `public, max-age=300`.","headers":{"Cache-Control":{"description":"`public, max-age=300`","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BrandingColorsOutcome"},"example":{"labelLoginColor":"#1A2B3C","textLoginColor":null,"headerBackgroundColor":"#696865","headerTextColor":"#FFF","menuLabelColor":null,"menuLabelHoverColor":"#89BD48","buttonBackgroundColor":null,"buttonBackgroundSemiColor":null}}}},"400":{"description":"Bad Request - the server in the URL is not valid. No colors are returned.","headers":{},"content":{}},"405":{"description":"Method Not Allowed - the resource is read-only.","headers":{},"content":{}},"503":{"description":"Service Unavailable - the server's database could not be reached.","headers":{},"content":{}}},"summary":"Retrieve Branding Colors","operationId":"Retrieve Branding Colors","description":"Returns the server's branding colors, for pages shown before sign-in. No token is needed.\n\n- Only these eight colors are returned, never any other server setting, whatever the query string.\n- Each value is `#` and 3 or 6 hex digits, as stored. A stored value that isn't one, or a color the server has not set, is `null`, so the client applies its own default.\n- Artwork is not included; it stays on the public CDN.\n- The colors are cached for 5 minutes, so a change can take that long to show here.\n\n### Authorization\n\nNone.","tags":["Branding Resource"]}},"/public_link_sessions":{"post":{"security":[],"responses":{"200":{"description":"OK - the session was issued.","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicLinkGrantSessionOutcome"},"example":{"access_token":"pls_0123456789abcdef0123456789abcdef.0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef","token_type":"Bearer","expires_in":3600,"profile_id":67890,"page_id":123456}}}},"400":{"description":"Bad Request - the body is not a JSON object, `share_token` is missing, or `password` / `page_id` has the wrong type.","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Unauthorized - the link has a password and it is missing (`Password required`) or wrong (`Incorrect password`).","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Forbidden - public links are switched off on the server (`publicLinkEnabled` is not 1) or not activated (no `PUBLICLINKAPI` API app).","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Not Found - the share token is malformed or unknown, the link is disabled, before its `activation_date` or at or after its `expiration_date`, `page_id` is not the link's page, or base64 share tokens are switched off. Every one of these answers the same way.","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Too Many Requests - too many wrong passwords for this link, or, when the per-IP limits are switched on, too many session requests, share tokens that opened no link, or wrong passwords from this client IP. Retry after the window.","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"summary":"Start Public Link Session","operationId":"Start Public Link Session","description":"Exchanges a public link's share token, and its password when the link has one, for a short-lived session token. No user, API app or access token is involved; this is the call an anonymous visitor's client (or a BFF acting for it) makes.\n\n### Session token\n\n- Expires after `expires_in` seconds (3600). Request a new one when it lapses.\n- Works **only** on `GET /public_link_sessions/current/feed` and `POST /public_link_sessions/current/pages/{page_id}/records`. Every other route answers `401`: it is not an access token, names no user and carries no role.\n- Bound to the link. Disabling, deleting or expiring the link, or switching public links off, ends every session for it at once.\n\n### Share token\n\n`share_token` is the `share_token` query value of the link's `public_url`, unchanged. The `publicLinkLegacyShareTokens` server setting can turn this format off.\n\n### Limits\n\nWrong passwords are counted per link: 20 in 15 minutes, then `429`. The `publicLinkSessionLimits` server setting overrides this.\n\nPer-client-IP limits on session requests (`sessions_per_ip_per_minute`), share tokens that open no link (`invalid_tokens_per_ip`, every `404`) and wrong passwords (`password_failures_per_ip`) are **off by default**. When the portal's backend makes the calls, every visitor shares its address, so it must rate-limit per visitor itself. Switch them on through `publicLinkSessionLimits` only where browsers call the API directly; the client IP is then the address the load balancer saw.","tags":["Public Link Session Resource"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["share_token"],"properties":{"share_token":{"type":"string","description":"the `share_token` value from the link's `public_url`"},"password":{"type":"string","description":"the link's password, in plain text; required when the link has one"},"page_id":{"type":"integer","description":"optional; when sent it must be the link's page, as in the `public_url` path"}}},"example":{"share_token":"MDEyMzQ1Njc4OWFiY2RlZi40Mg==","password":"********"}}}}}},"/public_link_sessions/current/feed":{"get":{"security":[{"publicLinkSession":[]}],"responses":{"200":{"description":"OK - the form definition of the session's link.","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicLinkGrantFeedOutcome"}}}},"401":{"description":"Unauthorized - no session token, an unknown or expired one, or the link is no longer collecting (disabled, deleted, outside its dates).","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Forbidden - public links are switched off on the server or not activated.","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Too Many Requests - this session has read the form too often (default 30 times per minute, overridable through the `publicLinkSessionLimits` server setting). Retry after the minute.","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"summary":"Get Public Link Session Form","operationId":"Get Public Link Session Form","description":"Returns everything a client needs to render the link's form: the link's page and every subform page under it (each with its elements, the subform edges that reach it, and page and element localizations, in the device feed format), plus every option list those elements use, with its enabled options.\n\nUsernames (`created_by`, `modified_by`) and server-only columns are removed. Pages and option lists outside the link's form tree, or outside the link's profile (option lists shared into it excepted), are never returned.","tags":["Public Link Session Resource"],"parameters":[{"name":"Authorization","in":"header","description":"e.g. Bearer {session access_token}","required":true,"schema":{"type":"string"},"example":"Bearer pls_0123456789abcdef0123456789abcdef.0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef"}]}},"/public_link_sessions/current/pages/{page_id}/records":{"post":{"security":[{"publicLinkSession":[]}],"responses":{"201":{"description":"Created - the record was written.","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicLinkGrantRecordOutcome"},"example":{"id":1001}}}},"400":{"description":"Bad Request - the body is not one record object, a field is invalid for its element, a field uses a shape a public link does not accept (see the description), or the parent fields are missing or present when they should not be.","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Unauthorized - no session token, an unknown or expired one, or the link is no longer collecting.","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Forbidden - `page_id` is not the link's page or one of its subform pages, the parent fields do not name a real subform of `page_id`, the parent record was not written by this session, or public links are switched off.","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Not Found - `page_id` is not a number.","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Too Many Requests - the profile has used its public link submissions for this month (nothing is written), or this session has written its maximum number of records.","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"summary":"Create Public Link Session Record","operationId":"Create Public Link Session Record","description":"Creates **one** record through a public link session. `page_id` is the link's page, or one of its subform pages for a subform record.\n\n### Monthly allowance\n\nA record on the link's page takes one submission from the profile's `public_link_monthly_limits` for the current month before anything is written, under a lock, so concurrent submissions can never exceed it. At the limit, or when the profile has no limit, the call answers `429` and writes nothing. If the write then fails, the submission is given back. Crossing 75 %, 90 % and 100 % sends the `public_link_email_alert` e-mail once per threshold per month. Subform records do not count.\n\n### Subform records\n\nSend `parent_record_id`, `parent_page_id` and `parent_element_id`. The parent must be a record this same session wrote, and `parent_element_id` must be the subform element on `parent_page_id` that points at `page_id`.\n\n### Fields\n\nAs `POST /profiles/{profile_id}/pages/{page_id}/records`, with these refused: `encoding` other than `base64` (the server does not fetch URLs for a public link), `is_media_internal`, an `extension` other than `jpg`, `jpeg` or `png`, values for assign-to, sound and third-party file-upload elements, and multi-photo values.\n\n### Stored metadata\n\n`created_by` and `modified_by` are `publiclink:{link id}`, `created_location` and `modified_location` are `PUBLIC_LINK`, and `created_device_id` identifies the session. None of them can be set by the caller.","tags":["Public Link Session Resource"],"parameters":[{"name":"page_id","in":"path","description":"the link's page, or one of its subform pages","required":true,"schema":{"type":"integer"}},{"name":"Authorization","in":"header","description":"e.g. Bearer {session access_token}","required":true,"schema":{"type":"string"},"example":"Bearer pls_0123456789abcdef0123456789abcdef.0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["fields"],"properties":{"fields":{"type":"array","items":{"type":"object","properties":{"element_id":{"type":"integer"},"element_name":{"type":"string"},"value":{"description":"the value; base64 for media elements"},"extension":{"type":"string","enum":["jpg","jpeg","png"],"description":"media file extension; omitted means png"},"encoding":{"type":"string","enum":["base64"]}}}},"parent_record_id":{"type":"integer","description":"subform records only"},"parent_page_id":{"type":"integer","description":"subform records only"},"parent_element_id":{"type":"integer","description":"subform records only"},"javascript_state":{"type":"string"}}},"example":{"fields":[{"element_name":"full_name","value":"Jane Doe"},{"element_name":"photo","value":"iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mP8z8BQDwAEhQGAhKmMIQAAAABJRU5ErkJggg==","extension":"png"}]}}}}}},"/token":{"get":{"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"client_id":{"type":"string","description":"client id of the access token"},"expires_in":{"type":"number","description":"remaining time on the access token in seconds"},"user":{"type":"object","properties":{},"description":"owner of the access token"},"user.username":{"type":"string","description":"username of the authenticated user"},"user.user_id":{"type":"number","description":"user id of the authenticated user"},"user.profile_id":{"type":"number","description":"profile id of the authenticated user"}},"required":["client_id","expires_in","user","user.username","user.user_id","user.profile_id"]},"example":{"client_id":"0123456789abcdef0123456789abcdef01234567","expires_in":1458,"user":{"username":"demo_user","user_id":12345,"profile_id":67890}}}}}},"summary":"Inspect Token Attributes","operationId":"Inspect Token Attributes","description":"","tags":["Token Resource"],"parameters":[{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}]}},"/profiles/{profile_id}":{"get":{"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"},"global_id":{"type":"string"},"version":{"type":"number"},"address1":{"type":"string"},"address2":{"type":"string"},"city":{"type":"string"},"zip":{"type":"string"},"state":{"type":"string"},"country":{"type":"string"},"phone":{"type":"string"},"fax":{"type":"string"},"email":{"type":"string"},"max_user":{"type":"number"},"max_page":{"type":"number"},"is_active":{"type":"boolean"},"created_date":{"type":"string"},"type":{"type":"number"},"support_hours":{"type":"number"},"time_zone":{"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"]},"example":{"id":161521,"name":"iFormBuilder","global_id":"0CP161521H14C19","version":1,"address1":"13665 Dulles Technology Dr., Suite 110","address2":"","city":"Herndon","zip":"20171","state":"VA","country":"USA","phone":"1-866-ZERION-1","fax":null,"email":"support@iformbuilder.com","max_user":10,"max_page":100,"is_active":true,"created_date":"2015-04-21T14:33:58+00:00","type":-1,"support_hours":0,"time_zone":null}}}}},"summary":"Retrieve a Profile","operationId":"Retrieve a Profile","description":"","tags":["Profile Resource"],"parameters":[{"name":"profile_id","in":"path","description":"id of the profile","required":true,"example":"self","schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}]},"put":{"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"number","description":"the updated profile id"}},"required":["id"]},"example":{"id":161521}}}},"403":{"description":"Forbidden - the caller is not a SERVER user and is not a COMPANY user of this profile on an internal client app, or the body sets `max_user`, `max_page`, `is_trial`, `is_active` or `support_hours` and the caller is not a SERVER user.","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"summary":"Update a Profile","operationId":"Update a Profile","description":"A SERVER user may update any profile. A COMPANY user on an internal client app may update their own profile's name, address, contact and `time_zone` fields. The license and account-state fields `max_user`, `max_page`, `is_trial`, `is_active` and `support_hours` are SERVER only.","tags":["Profile Resource"],"parameters":[{"name":"profile_id","in":"path","description":"id of the profile","required":true,"example":"self","schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}],"requestBody":{"content":{"application/json":{"example":{"address1":"13665 Dulles Technology Dr., Suite 110","address2":"","city":"Herndon","zip":"20171","state":"VA","country":"USA","phone":"1-866-ZERION-1"},"schema":{"type":"object","properties":{"name":{"type":"string","example":"iFormBuilder"},"address1":{"type":"string","example":"13665 Dulles Technology Dr., Suite 110"},"address2":{"type":"string"},"city":{"type":"string","example":"Herndon"},"zip":{"type":"string","example":"20171"},"state":{"type":"string","example":"VA"},"country":{"type":"string","example":"USA"},"phone":{"type":"string","example":"1-866-ZERION-1"},"fax":{"type":"string"},"email":{"type":"string","example":"support@iformbuilder.com"},"max_user":{"type":"number","example":10},"max_page":{"type":"number","example":100},"is_active":{"type":"boolean","example":true},"time_zone":{"type":"string"}}}}}}}},"/profiles/{profile_id}/company_info":{"get":{"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"profile_id":{"type":"number"},"name":{"type":"string"},"version":{"type":"number"},"title":{"type":"string"},"homemessage":{"type":"string"},"backgroundfilepath":{"type":"string"},"faqurl":{"type":"string"},"homemessageurl":{"type":"string"},"backgroundlink":{"type":"string"},"last_updated":{"type":"string"},"app_idle_timeout":{"type":"number"},"splash_link":{"type":"string"},"donebutton_link":{"type":"string"},"syncbutton_link":{"type":"string"},"base_color":{"type":"string"},"top_text_color":{"type":"string"},"text_color":{"type":"string"},"text_hl_color":{"type":"string"},"background2_link":{"type":"string"},"rsa_pub_key":{"type":"string"},"dropbox_user_id":{"type":"number"},"dropbox_media":{"type":"string"},"dropbox_struct":{"type":"number"},"media_location":{"type":"number"},"records_downloads_size":{"type":"number"},"addl_users_flg":{"type":"number"},"button_text_color":{"type":"string"},"show_submit_button":{"type":"number"},"enable_button_text_color":{"type":"number"},"signup_source":{"type":"string"},"signup_field":{"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_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"]}}}}},"summary":"Retrieve Company Info","operationId":"Retrieve Company Info","description":"The Dropbox credentials (`dropbox_access_token`, `dropbox_token_secret`) are write-only and are never returned, whoever the caller and whatever `fields` is sent. Use `GET /media_storage/connections` for connection state.","tags":["Profile Resource"],"parameters":[{"name":"profile_id","in":"path","description":"id of the profile","required":true,"example":"self","schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}]},"put":{"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"name":{"type":"string"},"title":{"type":"string"},"homemessage":{"type":"string"},"backgroundfilepath":{"type":"string"},"faqurl":{"type":"string"},"homemessageurl":{"type":"string"},"backgroundlink":{"type":"string"},"last_updated":{"type":"string"},"app_idle_timeout":{"type":"number"},"splash_link":{"type":"string"},"donebutton_link":{"type":"string"},"syncbutton_link":{"type":"string"},"base_color":{"type":"string"},"top_text_color":{"type":"string"},"text_color":{"type":"string"},"text_hl_color":{"type":"string"},"background2_link":{"type":"string"},"rsa_pub_key":{"type":"string"},"dropbox_access_token":{"type":"string","writeOnly":true,"description":"Write-only; never returned by GET company_info."},"dropbox_token_secret":{"type":"string","writeOnly":true,"description":"Dropbox refresh token. Write-only; never returned by GET company_info."},"dropbox_user_id":{"type":"number"},"dropbox_media":{"type":"string"},"dropbox_struct":{"type":"number"},"media_location":{"type":"number"},"records_downloads_size":{"type":"number"},"addl_users_flg":{"type":"number"},"button_text_color":{"type":"string"},"show_submit_button":{"type":"number"},"enable_button_text_color":{"type":"number"},"signup_source":{"type":"string"},"signup_field":{"type":"number"},"webform_flg":{"type":"number"}}},{"type":"object","properties":{"id":{"type":"number","description":"the updated profile id"}},"required":["id"]}]},"examples":{"example1":{"value":{"name":"iFormBuilder","title":"`iFormBuilder Title'","homemessage":"'\u003cstyle type=...\u003e'","backgroundfilepath":"path","faqurl":"https://zerion.my.site.com/helpcenter/s/article/FormPropertiesFrequentlyAskedQuestions66b5d2da37a3f","homemessageurl":"https://app.iformbuilder.com/exzact/adminHomeMessageTemplate1.php?PROFILE_ID=123456789","backgroundlink":"https://backgroundlink.iformbuilder.com","last_updated":"2018-08-17 10:41:12","app_idle_timeout":30,"splash_link":"https://splashlink.iformbuilder.com","donebutton_link":"https://donebutton.iformbuilder.com","syncbutton_link":"https://synclink.iformbuilder.com","base_color":"'#79AF64`","top_text_color":"'#79AF64`","text_color":"'#79AF64`","text_hl_color":"'#79AF64`","background2_link":"https://backgroundlink2.iformbuilder.com","rsa_pub_key":"-----BEGIN PUBLIC KEY-----\\r\\n","dropbox_access_token":"xxxxxxxxx","dropbox_token_secret":"xxxxxxxxx","dropbox_user_id":12332412,"dropbox_media":"0","dropbox_struct":0,"media_location":0,"records_downloads_size":55,"addl_users_flg":1,"button_text_color":"'#79AF64`","show_submit_button":0,"enable_button_text_color":2,"signup_source":"web","signup_field":4,"webform_flg":1}},"example2":{"value":{"profile_id":161521}}}}}}},"summary":"Update Company Info","operationId":"Update Company Info","description":"","tags":["Profile Resource"],"parameters":[{"name":"profile_id","in":"path","description":"id of the profile","required":true,"example":"self","schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}]}},"/profiles":{"get":{"responses":{"200":{"description":"OK","headers":{"Total-Count":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"},"global_id":{"type":"string"},"version":{"type":"number"},"address1":{"type":"string"},"address2":{"type":"string"},"city":{"type":"string"},"zip":{"type":"string"},"state":{"type":"string"},"country":{"type":"string"},"phone":{"type":"string"},"fax":{"type":"string"},"email":{"type":"string"},"max_user":{"type":"number"},"max_page":{"type":"number"},"is_active":{"type":"boolean"},"created_date":{"type":"string"},"type":{"type":"number"},"support_hours":{"type":"number"},"time_zone":{"type":"string"}},"required":["id","name"]}}}}},"summary":"Retrieve a List of Profiles","operationId":"Retrieve a List of Profiles","description":"","tags":["Profile Resource"],"parameters":[{"name":"fields","in":"query","description":"extra information of each profile on the list","schema":{"type":"string"}},{"name":"limit","in":"query","description":"maximum count of the profile list","example":"100","schema":{"type":"number"}},{"name":"offset","in":"query","description":"skip that many profiles before beginning to return","example":"0","schema":{"type":"number"}},{"name":"validate_grammar","in":"query","description":"returns an error for incorrect field grammar when set to true","example":"false","schema":{"type":"string"}},{"name":"all_fields","in":"query","description":"will show all fields for each the objects","example":"1","schema":{"type":"boolean"}},{"name":"exclude","in":"query","description":"will exclude specified fields","schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}]},"post":{"responses":{"201":{"description":"Created","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"number","description":"the created profile id"}},"required":["id"]},"example":{"id":161521}}}}},"summary":"Create a New Profile","operationId":"Create a New Profile","description":"","tags":["Profile Resource"],"parameters":[{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}],"requestBody":{"content":{"application/json":{"example":{"name":"iFormBuilder","max_user":10,"max_page":100,"is_active":true},"schema":{"type":"object","required":["name","max_user","max_page","is_active"],"properties":{"name":{"type":"string","example":"iFormBuilder"},"max_user":{"type":"number","example":10},"max_page":{"type":"number","example":100},"is_active":{"type":"boolean","example":true},"email":{"type":"string","example":"support@iformbuilder.com"},"address1":{"type":"string","example":"13665 Dulles Technology Dr., Suite 110"},"address2":{"type":"string"},"city":{"type":"string","example":"Herndon"},"zip":{"type":"string","example":"20171"},"state":{"type":"string","example":"VA"},"country":{"type":"string","example":"USA"},"phone":{"type":"string","example":"1-866-ZERION-1"},"fax":{"type":"string"},"time_zone":{"type":"string"}}}}}}}},"/profiles/{profile_id}/icons/{folder}":{"get":{"responses":{"200":{"description":"OK - a JSON array of icon urls in the folder. The `Total-Count` response header carries the number of urls returned.","headers":{"Total-Count":{"description":"number of icon urls in the response","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}},"example":["https://zerion-iform-icons-example.s3.amazonaws.com/app/67890/drawing_custom_icons/field_17306240006721a2f0b1c3d.png","https://zerion-iform-icons-example.s3.amazonaws.com/app/67890/drawing_custom_icons/field_17306240117721a2f0c4e5f.jpeg"]}}},"400":{"description":"Bad Request - `limit` or `offset` is not an integer.","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error_message":"'limit' must be an integer"}}}},"401":{"description":"Unauthorized - missing or invalid bearer token.","headers":{},"content":{}},"403":{"description":"Forbidden - the caller cannot access this profile's resources, or `profile_id` is not the caller's own profile.","headers":{},"content":{}},"404":{"description":"Not Found - `folder` is not an allowed icon folder, or `profile_id` does not exist.","headers":{},"content":{}}},"summary":"Retrieve Folder Icons","operationId":"Retrieve Folder Icons","description":"Lists the icons stored in one icon folder of the profile. Today the only folder is `drawing_custom_icons`, the custom icon set of the Drawing element. Icons in other folders (including the profile's default page icons served by `GET /profiles/{profile_id}/icons`) are not included.\n\n### Response\n\nA plain JSON array of icon urls (strings), not objects.\n\n### Folder\n\n`folder` must be exactly one of the allowed folder names; any other value, including dot segments, returns `404`.","tags":["Profile Resource"],"parameters":[{"name":"profile_id","in":"path","description":"id of the profile","required":true,"example":"self","schema":{"type":"string"}},{"name":"folder","in":"path","description":"name of the icon folder","required":true,"example":"drawing_custom_icons","schema":{"type":"string","enum":["drawing_custom_icons"]}},{"name":"limit","in":"query","description":"maximum number of urls to return (at most 1000, the default)","schema":{"type":"integer"}},{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}]},"post":{"responses":{"201":{"description":"Created - every icon was stored. A single object in the request returns a single `IconOutcome`; an array returns an array, in request order.","headers":{},"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/IconOutcome"},{"type":"array","items":{"$ref":"#/components/schemas/IconOutcome"}}]},"example":{"url":"https://zerion-iform-icons-example.s3.amazonaws.com/app/67890/drawing_custom_icons/field_17306240006721a2f0b1c3d.png"}}}},"207":{"description":"Multi-Status - some icons were stored and some failed. The body has the same shape as `201`; failed items carry `error_message` instead of `url`.","headers":{},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/IconOutcome"}},"example":[{"url":"https://zerion-iform-icons-example.s3.amazonaws.com/app/67890/drawing_custom_icons/field_17306240006721a2f0b1c3d.png"},{"error_message":"Profile has reached the limit of icons"}]}}},"400":{"description":"Bad Request - every icon failed. The body has the same shape as `201`, with an `error_message` on each item (for example a missing `file_data`, `Payload Too Large`, `Unsupported Media Type` or `Profile has reached the limit of icons`).","headers":{},"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/IconOutcome"},{"type":"array","items":{"$ref":"#/components/schemas/IconOutcome"}}]},"example":{"error_message":"Profile has reached the limit of icons"}}}},"401":{"description":"Unauthorized - missing or invalid bearer token.","headers":{},"content":{}},"403":{"description":"Forbidden - the token is not from an internal client app, or `profile_id` is not the caller's own profile.","headers":{},"content":{}},"404":{"description":"Not Found - `folder` is not an allowed icon folder, or `profile_id` does not exist.","headers":{},"content":{}}},"summary":"Create Folder Icons","operationId":"Create Folder Icons","description":"Uploads one or more icons into an icon folder of the profile. Today the only folder is `drawing_custom_icons`, the custom icon set of the Drawing element.\n\n### Request body\n\nA single `{ \"file_data\": ... }` object or a JSON array of them. `file_data` is the base64-encoded image. Each image must be PNG or JPEG and at most 256 KB; anything else fails that item with `Unsupported Media Type` or `Payload Too Large`.\n\n### Limit\n\nThe server's icon limit is counted per folder: icons in `drawing_custom_icons` do not count towards the default page-icon folder, and the other way round. Once the folder is full, each further item fails with `Profile has reached the limit of icons`.\n\n### HTTP status\n\n- `201` every item was stored\n- `207` some items failed and some did not\n- `400` every item failed\n- `401` no valid bearer token\n- `403` not an internal client app, or another profile's `profile_id`\n- `404` `folder` is not an allowed icon folder\n\n### Authorization\n\nRestricted to internal client apps, the same as `POST /profiles/{profile_id}/icons`.","tags":["Profile Resource"],"parameters":[{"name":"profile_id","in":"path","description":"id of the profile","required":true,"example":"self","schema":{"type":"string"}},{"name":"folder","in":"path","description":"name of the icon folder","required":true,"example":"drawing_custom_icons","schema":{"type":"string","enum":["drawing_custom_icons"]}},{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}],"requestBody":{"required":true,"content":{"application/json":{"examples":{"single":{"summary":"Single icon","value":{"file_data":"iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mP8z8BQDwAEhQGAhKmMIQAAAABJRU5ErkJggg=="}},"batch":{"summary":"Array of icons","value":[{"file_data":"iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mP8z8BQDwAEhQGAhKmMIQAAAABJRU5ErkJggg=="},{"file_data":"iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mP8z8BQDwAEhQGAhKmMIQAAAABJRU5ErkJggg=="}]}},"schema":{"oneOf":[{"type":"object","properties":{"file_data":{"type":"string","description":"base64-encoded PNG or JPEG image, at most 256 KB"}},"required":["file_data"]},{"type":"array","items":{"type":"object","properties":{"file_data":{"type":"string","description":"base64-encoded PNG or JPEG image, at most 256 KB"}},"required":["file_data"]}}]}}}}},"delete":{"responses":{"200":{"description":"OK - the icons were deleted. One url in the request returns a single `IconOutcome`; more than one returns an array, in request order.","headers":{},"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/IconOutcome"},{"type":"array","items":{"$ref":"#/components/schemas/IconOutcome"}}]},"example":{"url":"https://zerion-iform-icons-example.s3.amazonaws.com/app/67890/drawing_custom_icons/field_17306240006721a2f0b1c3d.png"}}}},"207":{"description":"Multi-Status - an array request where storage removed some icons and failed to remove others. The body has the same shape as `200`; failed items carry `error_message` instead of `url`, and their files are still in storage.","headers":{},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/IconOutcome"}},"example":[{"url":"https://zerion-iform-icons-example.s3.amazonaws.com/app/67890/drawing_custom_icons/field_17306240006721a2f0b1c3d.png"},{"error_message":"Cannot delete icon file [field_17306240117721a2f0c4e5f.jpeg]"}]}}},"400":{"description":"Bad Request - an item has no `url`, an empty `url`, or a `url` with no plain file name; nothing is deleted. Or an array request where storage failed to remove every icon; the body then has the same shape as `200`, with an `error_message` on each item.","headers":{},"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/IconOutcome"},{"type":"array","items":{"$ref":"#/components/schemas/IconOutcome"}}]},"example":[{"error_message":"Cannot delete icon file [field_17306240006721a2f0b1c3d.png]"},{"error_message":"Cannot delete icon file [field_17306240117721a2f0c4e5f.jpeg]"}]}}},"401":{"description":"Unauthorized - missing or invalid bearer token.","headers":{},"content":{}},"403":{"description":"Forbidden - the token is not from an internal client app, or `profile_id` is not the caller's own profile.","headers":{},"content":{}},"404":{"description":"Not Found - `folder` is not an allowed icon folder, or `profile_id` does not exist.","headers":{},"content":{}},"502":{"description":"Bad Gateway - a single-object request whose icon file storage failed to remove. The file is still in storage, and the body carries `error_message`.","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IconOutcome"},"example":{"error_message":"Cannot delete icon file [field_17306240006721a2f0b1c3d.png]"}}}}},"summary":"Delete Folder Icons","operationId":"Delete Folder Icons","description":"Deletes icons from an icon folder of the profile. Today the only folder is `drawing_custom_icons`, the custom icon set of the Drawing element.\n\n### Request body\n\nA single `{ \"url\": ... }` object or a JSON array of them, using the urls returned by `GET` or `POST` on this path.\n\n### Scope\n\nOnly the file name (the part after the last `/`) of each url is used. The object deleted is always `{servername}/{profile_id}/{folder}/{file name}`, so a url cannot reach another folder or another profile. A file name that does not exist in the folder is not reported as an error.\n\n### Storage failures\n\nEach icon whose file storage fails to remove is reported, and its file is still served at its url. A single `{ \"url\": ... }` object answers `502`. An array answers per item: `207` when some icons were removed, `400` when none were.\n\n### Authorization\n\nRestricted to internal client apps, the same as `DELETE /profiles/{profile_id}/icons`.","tags":["Profile Resource"],"parameters":[{"name":"profile_id","in":"path","description":"id of the profile","required":true,"example":"self","schema":{"type":"string"}},{"name":"folder","in":"path","description":"name of the icon folder","required":true,"example":"drawing_custom_icons","schema":{"type":"string","enum":["drawing_custom_icons"]}},{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}],"requestBody":{"required":true,"content":{"application/json":{"examples":{"single":{"summary":"Single url","value":{"url":"https://zerion-iform-icons-example.s3.amazonaws.com/app/67890/drawing_custom_icons/field_17306240006721a2f0b1c3d.png"}},"batch":{"summary":"Array of urls","value":[{"url":"https://zerion-iform-icons-example.s3.amazonaws.com/app/67890/drawing_custom_icons/field_17306240006721a2f0b1c3d.png"},{"url":"https://zerion-iform-icons-example.s3.amazonaws.com/app/67890/drawing_custom_icons/field_17306240117721a2f0c4e5f.jpeg"}]}},"schema":{"oneOf":[{"type":"object","properties":{"url":{"type":"string"}},"required":["url"]},{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"}},"required":["url"]}}]}}}}}},"/profiles/{profile_id}/users/{user_id}":{"get":{"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"number"},"username":{"type":"string"},"global_id":{"type":"string"},"first_name":{"type":"string"},"last_name":{"type":"string"},"email":{"type":"string"},"roles":{"type":"object","description":"A `server` user reads back every flag as `true`.","properties":{"role":{"type":"string","description":"One of `server`, `company` or `basic`."},"can_form_edit":{"type":"boolean"},"can_thunderplug_sync":{"type":"boolean"},"can_edit_records":{"type":"boolean"},"can_delete_records":{"type":"boolean"},"can_manage_templates":{"type":"boolean"},"can_generate_documents":{"type":"boolean"},"can_assign":{"type":"boolean"},"can_manage_users":{"type":"boolean","description":"Read-only. Comes with the `company` and `server` roles and can't be set through the API."},"can_edit_company_info":{"type":"boolean","description":"Read-only. Comes with the `company` and `server` roles and can't be set through the API."},"can_manage_billing":{"type":"boolean","description":"Read-only. Comes with the `company` and `server` roles and can't be set through the API."},"can_record_sync":{"type":"boolean","description":"Read-only. Comes with the `company` and `server` roles and can't be set through the API."}},"required":["role","can_form_edit","can_thunderplug_sync","can_edit_records","can_delete_records","can_manage_templates","can_generate_documents","can_assign","can_manage_users","can_edit_company_info","can_manage_billing","can_record_sync"]},"created_date":{"type":"string"},"is_locked":{"type":"boolean"}},"required":["id","username","global_id","first_name","last_name","email","roles","created_date","is_locked"]}}}}},"summary":"Retrieve a User","operationId":"Retrieve a User","description":"","tags":["User Resource"],"parameters":[{"name":"profile_id","in":"path","description":"id of the profile","required":true,"example":"self","schema":{"type":"string"}},{"name":"user_id","in":"path","description":"id of the user","required":true,"example":"self","schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}]},"put":{"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"number","description":"the updated user id"}},"required":["id"]},"example":{"id":161236}}}}},"summary":"Update a User","operationId":"Update a User","description":"","tags":["User Resource"],"parameters":[{"name":"profile_id","in":"path","description":"id of the profile","required":true,"example":"self","schema":{"type":"string"}},{"name":"user_id","in":"path","description":"id of the user","required":true,"example":"self","schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}],"requestBody":{"content":{"application/json":{"example":{"first_name":"Demo","last_name":"User","role":"server"},"schema":{"type":"object","properties":{"password":{"type":"string","example":"Testing123!","description":"At least 8 characters (the minimum is configurable per server).\nServers with password complexity enabled also require an uppercase letter,\na lowercase letter, a number, and one of `` !@#$%^\u0026*()-_=+~`,. ``. Servers that\nenforce password history reject a previously used password.\nZIM-integrated servers also enforce ZIM's policy: at least 8 characters\nwith an uppercase letter, a lowercase letter, and a number.\nA password that fails validation returns 400 with an error message naming\nthe rule it failed (ZIM's own error text on ZIM-integrated servers).\n"},"first_name":{"type":"string","example":"Demo"},"last_name":{"type":"string","example":"User"},"email":{"type":"string","example":"support@iformbuilder.com"},"role":{"type":"string","example":"server","description":"must match \"server\", \"company\" or \"basic\"\n\nOnly a Server Admin can set `server` or update a `server` user.\nOn a role change, omitted `can_assign`, `can_edit_records` and `can_delete_records`\nreset to the new role's defaults. `can_manage_templates` and `can_generate_documents`\nkeep their stored values.\n"},"can_form_edit":{"type":"boolean","example":true},"can_thunderplug_sync":{"type":"boolean","example":true},"can_assign":{"type":"boolean","example":true,"description":"Record Assignment. Company Admins, and Server Admins holding the company scope,\nalways have it. Omitted, it keeps the stored value unless `role` changes to\n`basic`, which clears it. For a server-only user (server scope without the\ncompany scope) `true` changes nothing, as GET already reports every permission\ntrue for them, and `false` clears it.\nOn a role change a `true` sent here is kept, so a client that demotes a user by\nediting their GET body (every flag `true` for an admin) MUST send `false`.\nOn ZIM-integrated servers a grant made here survives detaching the ZIM\nRecord Assignment policy, and `false` doesn't remove a grant that comes from\nthat policy.\nPermission bits this endpoint has no field for are kept unless `role` changes.\n"},"can_edit_records":{"type":"boolean","example":true,"description":"Edit Records. Lets the user edit records on forms they can view.\nOn ZIM-integrated servers the user's ZIM policies grant or revoke this permission,\nand replace a value sent here at the user's next sign-in.\n"},"can_delete_records":{"type":"boolean","example":true,"description":"Delete Records. Lets the user delete records on forms they can view.\nOn ZIM-integrated servers the user's ZIM policies grant or revoke this permission,\nand replace a value sent here at the user's next sign-in.\n"},"can_manage_templates":{"type":"boolean","example":true,"description":"Manage Document Templates. Lets the user create, edit and delete document templates.\nOn ZIM-integrated servers the user's ZIM policies grant or revoke this permission,\nand replace a value sent here at the user's next sign-in.\n"},"can_generate_documents":{"type":"boolean","example":true,"description":"Generate Documents. Lets the user generate documents from document templates.\nOn ZIM-integrated servers the user's ZIM policies grant or revoke this permission,\nand replace a value sent here at the user's next sign-in.\n"},"is_locked":{"type":"boolean","description":"Can only unlock user"}}}}}}},"delete":{"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"number","description":"the deleted user id"}},"required":["id"]},"example":{"id":161236}}}}},"summary":"Delete a User","operationId":"Delete a User","description":"","tags":["User Resource"],"parameters":[{"name":"profile_id","in":"path","description":"id of the profile","required":true,"example":"self","schema":{"type":"string"}},{"name":"user_id","in":"path","description":"id of the user","required":true,"example":"self","schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}]}},"/profiles/{profile_id}/api_clients":{"get":{"responses":{"200":{"description":"OK","headers":{"Total-Count":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ApiClient"}},"example":[{"id":12,"name":"Portal sign-in","client_key":"3f1c9b7e2a4d5c6f8e9a0b1c2d3e4f5a6b7c8d9e","username":"portal_service","type":["password"],"redirect_uris":[]},{"id":15,"name":"Field app","client_key":"9e8d7c6b5a4f3e2d1c0b9a8f7e6d5c4b3a2f1e0d","username":"inspector_1","type":["jwt-bearer","authorization_code"],"redirect_uris":["https://app.example.com/oauth/callback"]}]}}},"401":{"description":"Unauthorized - missing or invalid bearer token.","headers":{},"content":{}},"403":{"description":"Forbidden - the token belongs to a BASIC user, or `profile_id` is not the caller's own profile.","headers":{},"content":{}},"404":{"description":"Not Found - `profile_id` is not a valid profile id.","headers":{},"content":{}}},"summary":"Retrieve a List of API Clients","operationId":"Retrieve a List of API Clients","description":"The API clients (applications) of the profile. A client is `{id, name, client_key, username, type, redirect_uris}`. `type` lists the grants the client may use: `jwt-bearer`, `authorization_code` (which also allows `refresh_token`), `password`. `username` is the user the client acts as.\n\nThe client secret is never returned here: it is answered once, by `POST .../api_clients` and by `POST .../api_clients/{client_id}/reset_secret`. Internal (`i_`) clients are not part of this resource.\n\nA SERVER user sees every client of any profile. A COMPANY user sees the clients of their own profile whose acting user is not a server admin. BASIC users are forbidden.\n\nField grammar applies to `name`, `client_key` and `username`.","tags":["API Client Resource"],"parameters":[{"name":"profile_id","in":"path","description":"id of the profile","required":true,"example":"self","schema":{"type":"string"}},{"name":"fields","in":"query","description":"Field grammar. Fields are `id`, `name`, `client_key`, `username`, `type`, `redirect_uris`; filters apply to `name`, `client_key` and `username`.","required":false,"example":"name,client_key,username(=\"portal_service\")","schema":{"type":"string"}},{"name":"limit","in":"query","description":"Maximum number of clients returned (100 at most).","required":false,"schema":{"type":"integer"}},{"name":"offset","in":"query","description":"Number of clients to skip.","required":false,"schema":{"type":"integer"}}]},"post":{"responses":{"201":{"description":"Created - the secret is in this response only.","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiClientSecret"},"example":{"id":16,"client_key":"3f1c9b7e2a4d5c6f8e9a0b1c2d3e4f5a6b7c8d9e","client_secret":"7a6b5c4d3e2f1a0b9c8d7e6f5a4b3c2d1e0f9a8b"}}}},"400":{"description":"Bad Request - `name` is missing, over 100 characters or a reserved name (`TASKWORKER`, `PUBLICLINKAPI`, `FLATTENTASKAPI`), `type` is empty or names an unknown grant, `redirect_uris` holds a value that is not an absolute http(s) URL without fragment or whitespace or the list joined by commas exceeds 200 characters, `redirect_uris` is empty while `type` includes `authorization_code`, or `user_id` is not a user of the profile (for a COMPANY caller, also when that user is a server admin or a group).","headers":{},"content":{}},"401":{"description":"Unauthorized - missing or invalid bearer token.","headers":{},"content":{}},"403":{"description":"Forbidden - the token belongs to a BASIC user, or `profile_id` is not the caller's own profile.","headers":{},"content":{}},"404":{"description":"Not Found - `profile_id` is not a valid profile id.","headers":{},"content":{}}},"summary":"Create an API Client","operationId":"Create an API Client","description":"Creates a client acting as `user_id`, a user of the profile. `type` is a non-empty list of `jwt-bearer`, `authorization_code`, `password`. `redirect_uris` is required when `type` includes `authorization_code`; each entry must be an absolute http(s) URL without fragment or whitespace, and the list joined by commas must fit 200 characters.\n\nThe response carries `client_secret` once. Store it: no later request returns it, and `reset_secret` replaces it.","tags":["API Client Resource"],"parameters":[{"name":"profile_id","in":"path","description":"id of the profile","required":true,"example":"self","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["name","user_id","type"],"properties":{"name":{"type":"string","maxLength":100},"user_id":{"type":"integer","description":"id of the user the client acts as; must belong to `profile_id`"},"type":{"type":"array","minItems":1,"items":{"type":"string","enum":["jwt-bearer","authorization_code","password"]}},"redirect_uris":{"type":"array","items":{"type":"string","format":"uri"}}}},"example":{"name":"Field app","user_id":161236,"type":["jwt-bearer","authorization_code"],"redirect_uris":["https://app.example.com/oauth/callback"]}}},"required":true}}},"/profiles/{profile_id}/api_clients/{client_id}":{"get":{"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiClient"},"example":{"id":15,"name":"Field app","client_key":"9e8d7c6b5a4f3e2d1c0b9a8f7e6d5c4b3a2f1e0d","username":"inspector_1","type":["jwt-bearer","authorization_code"],"redirect_uris":["https://app.example.com/oauth/callback"]}}}},"401":{"description":"Unauthorized - missing or invalid bearer token.","headers":{},"content":{}},"403":{"description":"Forbidden - the token belongs to a BASIC user, or `profile_id` is not the caller's own profile.","headers":{},"content":{}},"404":{"description":"Not Found - no such client in the profile (including an internal client, or for a COMPANY caller one whose acting user is a server admin).","headers":{},"content":{}}},"summary":"Retrieve an API Client","operationId":"Retrieve an API Client","description":"One client of the profile, without its secret.","tags":["API Client Resource"],"parameters":[{"name":"profile_id","in":"path","description":"id of the profile","required":true,"example":"self","schema":{"type":"string"}},{"name":"client_id","in":"path","description":"id of the API client","required":true,"example":15,"schema":{"type":"integer"}}]},"put":{"responses":{"200":{"description":"OK - the updated client.","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiClient"}}}},"400":{"description":"Bad Request - the body names neither `name` nor `redirect_uris`, the body names `user_id` or changes `type` (both fixed at creation; an unchanged `type` may ride along), `name` is empty, over 100 characters or a reserved name (`TASKWORKER`, `PUBLICLINKAPI`, `FLATTENTASKAPI`), `redirect_uris` holds a value that is not an absolute http(s) URL, or `redirect_uris` is empty while the client's `type` includes `authorization_code`.","headers":{},"content":{}},"401":{"description":"Unauthorized - missing or invalid bearer token.","headers":{},"content":{}},"403":{"description":"Forbidden - the token belongs to a BASIC user, or `profile_id` is not the caller's own profile.","headers":{},"content":{}},"404":{"description":"Not Found - no such client in the profile.","headers":{},"content":{}}},"summary":"Update an API Client","operationId":"Update an API Client","description":"Changes `name` and/or `redirect_uris`. `type` and the acting user are fixed at creation. Values are stored as sent.","tags":["API Client Resource"],"parameters":[{"name":"profile_id","in":"path","description":"id of the profile","required":true,"example":"self","schema":{"type":"string"}},{"name":"client_id","in":"path","description":"id of the API client","required":true,"example":15,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","maxLength":100},"redirect_uris":{"type":"array","items":{"type":"string","format":"uri"}}}},"example":{"name":"Field app (staging)","redirect_uris":["https://staging.example.com/oauth/callback"]}}},"required":true}},"delete":{"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"integer"}}},"example":{"id":15}}}},"401":{"description":"Unauthorized - missing or invalid bearer token.","headers":{},"content":{}},"403":{"description":"Forbidden - the token belongs to a BASIC user, or `profile_id` is not the caller's own profile.","headers":{},"content":{}},"404":{"description":"Not Found - no such client in the profile.","headers":{},"content":{}}},"summary":"Delete an API Client","operationId":"Delete an API Client","description":"Deletes one client and revokes the access and refresh tokens issued to it. Any client of the profile can be deleted, including one whose acting user is now a server admin or no longer a user of the profile; revocation never widens privilege.","tags":["API Client Resource"],"parameters":[{"name":"profile_id","in":"path","description":"id of the profile","required":true,"example":"self","schema":{"type":"string"}},{"name":"client_id","in":"path","description":"id of the API client","required":true,"example":15,"schema":{"type":"integer"}}]}},"/profiles/{profile_id}/api_clients/{client_id}/reset_secret":{"post":{"responses":{"200":{"description":"OK - the new secret, in this response only.","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiClientSecret"},"example":{"id":15,"client_key":"9e8d7c6b5a4f3e2d1c0b9a8f7e6d5c4b3a2f1e0d","client_secret":"1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6e7f8a9b0c"}}}},"401":{"description":"Unauthorized - missing or invalid bearer token.","headers":{},"content":{}},"403":{"description":"Forbidden - the token belongs to a BASIC user, or `profile_id` is not the caller's own profile.","headers":{},"content":{}},"404":{"description":"Not Found - no such client in the profile.","headers":{},"content":{}}},"summary":"Reset an API Client Secret","operationId":"Reset an API Client Secret","description":"Replaces the client secret and revokes the access and refresh tokens issued to the client. The old secret stops minting tokens at once. The client key and the acting user do not change.","tags":["API Client Resource"],"parameters":[{"name":"profile_id","in":"path","description":"id of the profile","required":true,"example":"self","schema":{"type":"string"}},{"name":"client_id","in":"path","description":"id of the API client","required":true,"example":15,"schema":{"type":"integer"}}]}},"/profiles/{profile_id}/users":{"get":{"responses":{"200":{"description":"OK","headers":{"Total-Count":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"number"},"username":{"type":"string"},"global_id":{"type":"string"},"first_name":{"type":"string"},"last_name":{"type":"string"},"email":{"type":"string"},"roles":{"type":"object","description":"A `server` user reads back every flag as `true`.","properties":{"role":{"type":"string","description":"One of `server`, `company` or `basic`."},"can_form_edit":{"type":"boolean"},"can_thunderplug_sync":{"type":"boolean"},"can_edit_records":{"type":"boolean"},"can_delete_records":{"type":"boolean"},"can_manage_templates":{"type":"boolean"},"can_generate_documents":{"type":"boolean"},"can_assign":{"type":"boolean"},"can_manage_users":{"type":"boolean","description":"Read-only. Comes with the `company` and `server` roles and can't be set through the API."},"can_edit_company_info":{"type":"boolean","description":"Read-only. Comes with the `company` and `server` roles and can't be set through the API."},"can_manage_billing":{"type":"boolean","description":"Read-only. Comes with the `company` and `server` roles and can't be set through the API."},"can_record_sync":{"type":"boolean","description":"Read-only. Comes with the `company` and `server` roles and can't be set through the API."}}},"created_date":{"type":"string"},"is_locked":{"type":"boolean"}}},"example":[{"id":161236,"username":"demo_user"},{"id":161239,"username":"inspector_1"},{"id":161242,"username":"inspector_2"}]}}}},"summary":"Retrieve a List of Users","operationId":"Retrieve a List of Users","description":"","tags":["User Resource"],"parameters":[{"name":"profile_id","in":"path","description":"id of the profile","required":true,"example":"self","schema":{"type":"string"}},{"name":"fields","in":"query","description":"extra information of each user on the list","schema":{"type":"string"}},{"name":"limit","in":"query","description":"maximum count of the user list","example":"100","schema":{"type":"number"}},{"name":"offset","in":"query","description":"skip that many users before beginning to return","example":"0","schema":{"type":"number"}},{"name":"validate_grammar","in":"query","description":"returns an error for incorrect field grammar when set to true","example":"false","schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}]},"put":{"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"number","description":"the updated user id"}},"required":["id"]},"example":[{"id":161239},{"id":161242}]}}}},"summary":"Update a List of Users","operationId":"Update a List of Users","description":"","tags":["User Resource"],"parameters":[{"name":"profile_id","in":"path","description":"id of the profile","required":true,"example":"self","schema":{"type":"string"}},{"name":"fields","in":"query","description":"extra information of each user on the list","schema":{"type":"string"}},{"name":"limit","in":"query","description":"maximum count of the user list","example":"100","schema":{"type":"number"}},{"name":"offset","in":"query","description":"skip that many users before beginning to return","example":"0","schema":{"type":"number"}},{"name":"validate_grammar","in":"query","description":"returns an error for incorrect field grammar when set to true","example":"false","schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}],"requestBody":{"content":{"application/json":{"examples":{"example1":{"value":[{"id":161239,"password":"Password123!"},{"id":161242,"password":"Password456!"}]},"example2":{"value":{"role":"basic","can_form_edit":true}}},"schema":{"type":"object","properties":{"id":{"type":"number","example":161239},"password":{"type":"string","example":"Password123!","description":"At least 8 characters (the minimum is configurable per server).\nServers with password complexity enabled also require an uppercase letter,\na lowercase letter, a number, and one of `` !@#$%^\u0026*()-_=+~`,. ``. Servers that\nenforce password history reject a previously used password.\nZIM-integrated servers also enforce ZIM's policy: at least 8 characters\nwith an uppercase letter, a lowercase letter, and a number.\nA failing password is reported in that user's `error_message`, which names\nthe rule it failed (ZIM's own error text on ZIM-integrated servers). The\nresponse is 400 if every user in the request fails, otherwise 207.\n"},"first_name":{"type":"string","example":"Demo"},"last_name":{"type":"string","example":"User"},"email":{"type":"string","example":"support@iformbuilder.com"},"role":{"type":"string","example":"server","description":"must match \"server\", \"company\" or \"basic\"\n\nOnly a Server Admin can set `server` or update a `server` user.\nOn a role change, omitted `can_assign`, `can_edit_records` and `can_delete_records`\nreset to the new role's defaults. `can_manage_templates` and `can_generate_documents`\nkeep their stored values.\n"},"can_form_edit":{"type":"boolean","example":true},"can_thunderplug_sync":{"type":"boolean","example":true},"can_assign":{"type":"boolean","example":true,"description":"Record Assignment. Company Admins, and Server Admins holding the company scope,\nalways have it. Omitted, it keeps the stored value unless `role` changes to\n`basic`, which clears it. For a server-only user (server scope without the\ncompany scope) `true` changes nothing, as GET already reports every permission\ntrue for them, and `false` clears it.\nOn a role change a `true` sent here is kept, so a client that demotes a user by\nediting their GET body (every flag `true` for an admin) MUST send `false`.\nOn ZIM-integrated servers a grant made here survives detaching the ZIM\nRecord Assignment policy, and `false` doesn't remove a grant that comes from\nthat policy.\nPermission bits this endpoint has no field for are kept unless `role` changes.\n"},"can_edit_records":{"type":"boolean","example":true,"description":"Edit Records. Lets the user edit records on forms they can view.\nOn ZIM-integrated servers the user's ZIM policies grant or revoke this permission,\nand replace a value sent here at the user's next sign-in.\n"},"can_delete_records":{"type":"boolean","example":true,"description":"Delete Records. Lets the user delete records on forms they can view.\nOn ZIM-integrated servers the user's ZIM policies grant or revoke this permission,\nand replace a value sent here at the user's next sign-in.\n"},"can_manage_templates":{"type":"boolean","example":true,"description":"Manage Document Templates. Lets the user create, edit and delete document templates.\nOn ZIM-integrated servers the user's ZIM policies grant or revoke this permission,\nand replace a value sent here at the user's next sign-in.\n"},"can_generate_documents":{"type":"boolean","example":true,"description":"Generate Documents. Lets the user generate documents from document templates.\nOn ZIM-integrated servers the user's ZIM policies grant or revoke this permission,\nand replace a value sent here at the user's next sign-in.\n"},"is_locked":{"type":"boolean","description":"Can only unlock by using false"}}}}}}},"delete":{"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"number","description":"the deleted user id"}},"required":["id"]},"example":[{"id":161239},{"id":161242}]}}}},"summary":"Delete a List of Users","operationId":"Delete a List of Users","description":"","tags":["User Resource"],"parameters":[{"name":"profile_id","in":"path","description":"id of the profile","required":true,"example":"self","schema":{"type":"string"}},{"name":"fields","in":"query","description":"extra information of each user on the list","schema":{"type":"string"}},{"name":"limit","in":"query","description":"maximum count of the user list","example":"100","schema":{"type":"number"}},{"name":"offset","in":"query","description":"skip that many users before beginning to return","example":"0","schema":{"type":"number"}},{"name":"validate_grammar","in":"query","description":"returns an error for incorrect field grammar when set to true","example":"false","schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}],"requestBody":{"content":{"application/json":{"example":[{"id":161239},{"id":161242}],"schema":{"type":"object","properties":{"id":{"type":"number","example":161239}}}}}}},"post":{"responses":{"201":{"description":"Created","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"number","description":"the created user id"}},"required":["id"]},"examples":{"example1":{"value":{"id":161236}},"example2":{"value":[{"id":161239},{"id":161242}]}}}}},"400":{"description":"Bad Request","headers":{},"content":{}}},"summary":"Create New Users","operationId":"Create New Users","description":"","tags":["User Resource"],"parameters":[{"name":"profile_id","in":"path","description":"id of the profile","required":true,"example":"self","schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}],"requestBody":{"content":{"application/json":{"examples":{"example1":{"value":{"username":"demo_user","password":"Testing123!","email":"support@iformbuilder.com"}},"example2":{"value":[{"username":"inspector_1","password":"Testing123!","email":"inspector1@company.com","role":"basic"},{"username":"inspector_2","password":"Testing123!","email":"inspector2@company.com","role":"basic"}]}},"schema":{"type":"object","required":["username","password","email"],"properties":{"username":{"type":"string","example":"demo_user"},"password":{"type":"string","example":"Testing123!","description":"At least 8 characters (the minimum is configurable per server).\nServers with password complexity enabled also require an uppercase letter,\na lowercase letter, a number, and one of `` !@#$%^\u0026*()-_=+~`,. ``. Servers that\nenforce password history reject a previously used password.\nZIM-integrated servers also enforce ZIM's policy: at least 8 characters\nwith an uppercase letter, a lowercase letter, and a number.\nA user whose password fails validation is not created. Its `error_message`\nis `Parameter 'Password' is invalid` (ZIM's own error text on\nZIM-integrated servers). The response is 400 if every user in the request\nfails, otherwise 207.\n"},"first_name":{"type":"string","example":"Demo"},"last_name":{"type":"string","example":"User"},"email":{"type":"string","example":"support@iformbuilder.com"},"role":{"type":"string","example":"server","description":"must match \"server\", \"company\" or \"basic\"\n\nDefaults to `basic` when omitted. Only a Server Admin can create a `server` user.\nEvery `can_*` flag defaults to `false` when omitted. The `company` and `server` roles\nstill grant their preset permissions whatever the flags say.\n"},"can_form_edit":{"type":"boolean","example":true},"can_thunderplug_sync":{"type":"boolean","example":true},"can_assign":{"type":"boolean","example":true,"description":"Record Assignment. Company Admins and Server Admins always have it; set it to\ngive it to a basic user.\nOn ZIM-integrated servers a grant made here survives detaching the ZIM\nRecord Assignment policy.\n"},"can_edit_records":{"type":"boolean","example":true,"description":"Edit Records. Lets the user edit records on forms they can view.\nOn ZIM-integrated servers the user's ZIM policies grant or revoke this permission,\nand replace a value sent here at the user's next sign-in.\n"},"can_delete_records":{"type":"boolean","example":true,"description":"Delete Records. Lets the user delete records on forms they can view.\nOn ZIM-integrated servers the user's ZIM policies grant or revoke this permission,\nand replace a value sent here at the user's next sign-in.\n"},"can_manage_templates":{"type":"boolean","example":true,"description":"Manage Document Templates. Lets the user create, edit and delete document templates.\nOn ZIM-integrated servers the user's ZIM policies grant or revoke this permission,\nand replace a value sent here at the user's next sign-in.\n"},"can_generate_documents":{"type":"boolean","example":true,"description":"Generate Documents. Lets the user generate documents from document templates.\nOn ZIM-integrated servers the user's ZIM policies grant or revoke this permission,\nand replace a value sent here at the user's next sign-in.\n"}}}}}}}},"/profiles/{profile_id}/users/{user_id}/user_groups":{"get":{"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"user_group_id":{"type":"number"},"user_group_name":{"type":"string"}},"required":["user_group_id","user_group_name"]},"example":[{"user_group_id":290820226,"user_group_name":"User Group 1"},{"user_group_id":290820227,"user_group_name":"User Group 2"}]}}}},"summary":"Retrieve User Groups for a Specific User","operationId":"Retrieve User Groups for a Specific User","description":"","tags":["User Resource"],"parameters":[{"name":"profile_id","in":"path","description":"id of the profile","required":true,"example":"self","schema":{"type":"string"}},{"name":"user_id","in":"path","description":"id of the user","required":true,"schema":{"type":"number"}},{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}]}},"/profiles/{profile_id}/users/{user_id}/page_assignments/{page_id}":{"get":{"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"page_id":{"type":"number"},"can_collect":{"type":"boolean"},"can_view":{"type":"boolean"}},"required":["page_id","can_collect","can_view"]},"example":{"page_id":790777,"can_collect":true,"can_view":true}}}}},"summary":"Retrieve a Page Assignment with Page/User ID","operationId":"Retrieve a Page Assignment with Page/User ID","description":"","tags":["User Resource"],"parameters":[{"name":"profile_id","in":"path","description":"id of the profile","required":true,"example":"self","schema":{"type":"string"}},{"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"}},{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}]},"put":{"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"page_id":{"type":"number","description":"the updated page id"}},"required":["page_id"]},"example":{"page_id":790777}}}}},"summary":"Update a Page Assignment with Page/User ID","operationId":"Update a Page Assignment with Page/User ID","description":"","tags":["User Resource"],"parameters":[{"name":"profile_id","in":"path","description":"id of the profile","required":true,"example":"self","schema":{"type":"string"}},{"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"}},{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}],"requestBody":{"content":{"application/json":{"example":{"can_collect":true,"can_view":true},"schema":{"type":"object","properties":{"can_collect":{"type":"boolean","example":true},"can_view":{"type":"boolean","example":true}}}}}}},"delete":{"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"page_id":{"type":"number","description":"the deleted page id"}},"required":["page_id"]},"example":{"page_id":790777}}}}},"summary":"Delete a Page Assignment with Page/User ID","operationId":"Delete a Page Assignment with Page/User ID","description":"","tags":["User Resource"],"parameters":[{"name":"profile_id","in":"path","description":"id of the profile","required":true,"example":"self","schema":{"type":"string"}},{"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"}},{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}]}},"/profiles/{profile_id}/users/{user_id}/page_assignments":{"get":{"responses":{"200":{"description":"OK","headers":{"Total-Count":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"page_id":{"type":"number"},"can_collect":{"type":"boolean"},"can_view":{"type":"boolean"},"is_disabled":{"type":"boolean"}},"required":["page_id"]},"example":[{"page_id":790777},{"page_id":790771},{"page_id":790774}]}}}},"summary":"Retrieve a List of Page Assignments","operationId":"Retrieve a List of User Page Assignments","description":"","tags":["User Resource"],"parameters":[{"name":"profile_id","in":"path","description":"id of the profile","required":true,"example":"self","schema":{"type":"string"}},{"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","schema":{"type":"string"}},{"name":"limit","in":"query","description":"maximum count of the page assignment list","example":"100","schema":{"type":"number"}},{"name":"offset","in":"query","description":"skip that many page assignment before beginning to return","example":"0","schema":{"type":"number"}},{"name":"validate_grammar","in":"query","description":"returns an error for incorrect field grammar when set to true","example":"false","schema":{"type":"string"}},{"name":"exclude","in":"query","description":"will exclude specified fields","schema":{"type":"string"}},{"name":"all_fields","in":"query","description":"will show all fields for the objects","example":"1","schema":{"type":"boolean"}},{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}]},"put":{"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"page_id":{"type":"number","description":"the updated page id"}},"required":["page_id"]},"example":[{"page_id":790771},{"page_id":790774}]}}},"207":{"description":"Multi-Status - some items succeeded and some failed. The body is an array in request order (a list request body, even with one item, always answers a list); a failed item carries `error_message` instead of `page_id` and was not written.","headers":{},"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"page_id":{"type":"integer","description":"present when the item succeeded"},"error_message":{"type":"string","description":"present when the item failed"}}}},"example":[{"page_id":290857010},{"error_message":"Parameter 'page_id' is invalid"}]}}},"400":{"description":"Bad Request - every item of a list request body failed. The body has the same shape as `207`, with `error_message` on each item; nothing was written. A single-object request body that fails answers the standard error object instead.","headers":{},"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/ApiError"},{"type":"array","items":{"type":"object","properties":{"error_message":{"type":"string"}},"required":["error_message"]}}]},"examples":{"all_failed":{"summary":"Every item of a list body failed","value":[{"error_message":"Parameter 'page_id' is invalid"}]},"single_object":{"summary":"A single-object body failed","value":{"error_message":"Parameter 'page_id' is invalid"}}}}}}},"summary":"Update a List of Page Assignments","operationId":"Update a List of User Page Assignments","description":"","tags":["User Resource"],"parameters":[{"name":"profile_id","in":"path","description":"id of the profile","required":true,"example":"self","schema":{"type":"string"}},{"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","schema":{"type":"string"}},{"name":"limit","in":"query","description":"maximum count of the page assignment list","example":"100","schema":{"type":"number"}},{"name":"offset","in":"query","description":"skip that many page assignment before beginning to return","example":"0","schema":{"type":"number"}},{"name":"validate_grammar","in":"query","description":"returns an error for incorrect field grammar when set to true","example":"false","schema":{"type":"string"}},{"name":"exclude","in":"query","description":"will exclude specified fields","schema":{"type":"string"}},{"name":"all_fields","in":"query","description":"will show all fields for the objects","example":"1","schema":{"type":"boolean"}},{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}],"requestBody":{"content":{"application/json":{"examples":{"example1":{"value":[{"page_id":790771,"can_view":false},{"page_id":790774,"can_view":false}]},"example2":{"value":{"can_view":false}}},"schema":{"type":"object","properties":{"page_id":{"type":"number","example":790777},"can_collect":{"type":"boolean","example":true},"can_view":{"type":"boolean","example":true}}}}}}},"delete":{"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"page_id":{"type":"number","description":"the deleted page id"}},"required":["page_id"]},"example":[{"page_id":790771},{"page_id":790774}]}}},"207":{"description":"Multi-Status - some items succeeded and some failed. The body is an array in request order (a list request body, even with one item, always answers a list); a failed item carries `error_message` instead of `page_id` and was not written. An item whose row does not exist answers `The requested resource is not found`.","headers":{},"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"page_id":{"type":"integer","description":"present when the item succeeded"},"error_message":{"type":"string","description":"present when the item failed"}}}},"example":[{"page_id":290857010},{"error_message":"The requested resource is not found"}]}}},"400":{"description":"Bad Request - every item of a list request body failed. The body has the same shape as `207`, with `error_message` on each item; nothing was written. A single-object request body that fails answers the standard error object instead.","headers":{},"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/ApiError"},{"type":"array","items":{"type":"object","properties":{"error_message":{"type":"string"}},"required":["error_message"]}}]},"examples":{"all_failed":{"summary":"Every item of a list body failed","value":[{"error_message":"The requested resource is not found"}]},"single_object":{"summary":"A single-object body failed","value":{"error_message":"The requested resource is not found"}}}}}}},"summary":"Delete a List of Page Assignments","operationId":"Delete a List of User Page Assignments","description":"","tags":["User Resource"],"parameters":[{"name":"profile_id","in":"path","description":"id of the profile","required":true,"example":"self","schema":{"type":"string"}},{"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","schema":{"type":"string"}},{"name":"limit","in":"query","description":"maximum count of the page assignment list","example":"100","schema":{"type":"number"}},{"name":"offset","in":"query","description":"skip that many page assignment before beginning to return","example":"0","schema":{"type":"number"}},{"name":"validate_grammar","in":"query","description":"returns an error for incorrect field grammar when set to true","example":"false","schema":{"type":"string"}},{"name":"exclude","in":"query","description":"will exclude specified fields","schema":{"type":"string"}},{"name":"all_fields","in":"query","description":"will show all fields for the objects","example":"1","schema":{"type":"boolean"}},{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}],"requestBody":{"content":{"application/json":{"example":[{"page_id":790771},{"page_id":790774}],"schema":{"type":"object","properties":{"page_id":{"type":"number","example":790771}}}}}}},"post":{"responses":{"201":{"description":"Created","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"page_id":{"type":"number","description":"the created page id"}},"required":["page_id"]},"examples":{"example1":{"value":{"page_id":790777}},"example2":{"value":[{"page_id":790771},{"page_id":790774}]}}}}},"207":{"description":"Multi-Status - some items succeeded and some failed. The body is an array in request order (a list request body, even with one item, always answers a list); a failed item carries `error_message` instead of `page_id` and was not written.","headers":{},"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"page_id":{"type":"integer","description":"present when the item succeeded"},"error_message":{"type":"string","description":"present when the item failed"}}}},"example":[{"page_id":290857010},{"error_message":"Parameter 'page_id' is invalid"}]}}},"400":{"description":"Bad Request - every item of a list request body failed. The body has the same shape as `207`, with `error_message` on each item; nothing was written. A single-object request body that fails answers the standard error object instead.","headers":{},"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/ApiError"},{"type":"array","items":{"type":"object","properties":{"error_message":{"type":"string"}},"required":["error_message"]}}]},"examples":{"all_failed":{"summary":"Every item of a list body failed","value":[{"error_message":"Parameter 'page_id' is invalid"}]},"single_object":{"summary":"A single-object body failed","value":{"error_message":"Parameter 'page_id' is invalid"}}}}}}},"summary":"Create New Page Assignments","operationId":"Create New User Page Assignments","description":"","tags":["User Resource"],"parameters":[{"name":"profile_id","in":"path","description":"id of the profile","required":true,"example":"self","schema":{"type":"string"}},{"name":"user_id","in":"path","description":"id of the user","required":true,"schema":{"type":"number"}},{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}],"requestBody":{"content":{"application/json":{"examples":{"example1":{"value":{"page_id":790777,"can_collect":true}},"example2":{"value":[{"page_id":790771,"can_collect":true},{"page_id":790774,"can_collect":true}]}},"schema":{"type":"object","required":["page_id"],"properties":{"page_id":{"type":"number","example":790777},"can_collect":{"type":"boolean","example":true},"can_view":{"type":"boolean","example":true}}}}}}}},"/profiles/{profile_id}/users/self/page_access/{page_id}":{"get":{"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageAccessOutcome"},"example":{"page_id":790777,"can_view":true,"can_collect":false}}}},"401":{"description":"Unauthorized - missing or invalid bearer token.","headers":{},"content":{}},"403":{"description":"Forbidden - `profile_id` is not the caller's own profile (only SERVER users may name another profile).","headers":{},"content":{}},"404":{"description":"Not Found - the profile does not exist, `page_id` is not a positive integer, or the page neither belongs to nor is shared into `profile_id`.","headers":{},"content":{}},"429":{"description":"Too Many Requests - the per-server limit for this endpoint (`apiEndpointLimits`) was reached.","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"error_message":{"type":"string"}}},"example":{"error_message":"API rate limit exceeded"}}}}},"summary":"Retrieve the Signed-in User's Access to a Page","operationId":"Retrieve the Signed-in User's Access to a Page","description":"Returns the effective access of the user who owns the bearer token to one page, with subform inheritance applied. It answers the same question as the record endpoints' permission checks, so a client can decide whether to offer a form or subform without walking the subform tree itself.\n\nThe user is always the token's user. `self` is a literal path segment; there is no form of this endpoint that takes a user id.\n\n### Fields\n\n- `can_view` is `true` when the user holds view permission on the page through any assignment path (direct, user group, page group, or user group to page group), or inherits it from a form the page is a subform of. This is the page-level part of the check behind `GET .../records/{record_id}`; record assignments are not considered.\n- `can_collect` is the same with collect permission. It is the page-level part of the check behind `POST .../records`. It does not report edit or delete rights a BASIC user holds through view permission plus the `EDIT_RECORD` or `DEL_RECORD` role (the second path in the `PUT` and `DELETE .../records` checks), so `can_collect: false` does not mean the user cannot edit or delete records on the page.\n\n### Inheritance\n\nSubforms are never assigned directly, so a subform's access comes from its parent forms. The walk goes up through subform elements in the same profile, at most 10 levels. A form shared into the profile does not pass its access down to its subforms.\n\n`can_collect: true` through inheritance is a page-level answer. A record write is still checked against the parent form of each record it touches, so where one subform is used by two forms, a user assigned to only one of them may still get `403` writing records that belong to the other.\n\n### COMPANY and SERVER users\n\nUsers with company or server scope get `true` for both fields on any page they can reach in the profile, as the record endpoints treat them.\n\n### HTTP status\n\n- `200` the page exists in the profile; both fields may be `false`\n- `401` no valid bearer token\n- `403` another profile's `profile_id` and the caller is not a SERVER user\n- `404` unknown profile, invalid `page_id`, or the page is not in the profile\n- `429` the endpoint rate limit was reached\n\n### Rate limiting and freshness\n\nThe rate limit is per server per endpoint (`apiEndpointLimits`), shared by every caller on the server. A backend that calls this endpoint for many users, such as a portal BFF gating each form route, should use an internal client or ask for a raised limit rather than spend the shared budget.\n\nReads may come from a read replica, so a just-changed assignment can take a few seconds to show.","tags":["User Resource"],"parameters":[{"name":"profile_id","in":"path","description":"id of the profile","required":true,"example":"self","schema":{"type":"string"}},{"name":"page_id","in":"path","description":"id of the page","required":true,"schema":{"type":"number"}},{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}]}},"/profiles/{profile_id}/users/{user_id}/record_assignments/{assignment_id}":{"get":{"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"number"},"page_id":{"type":"number"},"record_id":{"type":"number"}},"required":["id","page_id","record_id"]},"example":{"id":526,"page_id":790777,"record_id":4}}}}},"summary":"Retrieve a Record Assignment","operationId":"Retrieve a User Record Assignment","description":"","tags":["User Resource"],"parameters":[{"name":"profile_id","in":"path","description":"id of the profile","required":true,"example":"self","schema":{"type":"string"}},{"name":"user_id","in":"path","description":"id of the user","required":true,"example":"self","schema":{"type":"string"}},{"name":"assignment_id","in":"path","description":"id of the record assignment","required":true,"schema":{"type":"number"}},{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}]},"delete":{"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"number","description":"the deleted assignment id"}},"required":["id"]},"example":{"id":526}}}}},"summary":"Delete a Record Assignment","operationId":"Delete a User Record Assignment","description":"","tags":["User Resource"],"parameters":[{"name":"profile_id","in":"path","description":"id of the profile","required":true,"example":"self","schema":{"type":"string"}},{"name":"user_id","in":"path","description":"id of the user","required":true,"example":"self","schema":{"type":"string"}},{"name":"assignment_id","in":"path","description":"id of the record assignment","required":true,"schema":{"type":"number"}},{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}]}},"/profiles/{profile_id}/users/{user_id}/record_assignments":{"get":{"responses":{"200":{"description":"OK","headers":{"Total-Count":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"number"},"page_id":{"type":"number"},"record_id":{"type":"number"}},"required":["id","page_id","record_id"]},"example":[{"id":526,"page_id":790777,"record_id":4},{"id":529,"page_id":790777,"record_id":1},{"id":532,"page_id":790777,"record_id":7}]}}}},"summary":"Retrieve a List of Record Assignments","operationId":"Retrieve a List of User Record Assignments","description":"","tags":["User Resource"],"parameters":[{"name":"profile_id","in":"path","description":"id of the profile","required":true,"example":"self","schema":{"type":"string"}},{"name":"user_id","in":"path","description":"id of the user","required":true,"example":"self","schema":{"type":"string"}},{"name":"fields","in":"query","description":"extra information of each page assignment on the list","schema":{"type":"string"}},{"name":"limit","in":"query","description":"maximum count of the page assignment list","example":"100","schema":{"type":"number"}},{"name":"offset","in":"query","description":"skip that many page assignment before beginning to return","example":"0","schema":{"type":"number"}},{"name":"validate_grammar","in":"query","description":"returns an error for incorrect field grammar when set to true","example":"false","schema":{"type":"string"}},{"name":"all_fields","in":"query","description":"will show all fields for each page assignment","example":"1","schema":{"type":"boolean"}},{"name":"exclude","in":"query","description":"will exclude specified fields","schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}]},"delete":{"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"number","description":"the deleted assignment id"}},"required":["id"]},"example":[{"id":529},{"id":532}]}}}},"summary":"Delete a List of Record Assignments","operationId":"Delete a List of User Record Assignments","description":"","tags":["User Resource"],"parameters":[{"name":"profile_id","in":"path","description":"id of the profile","required":true,"example":"self","schema":{"type":"string"}},{"name":"user_id","in":"path","description":"id of the user","required":true,"example":"self","schema":{"type":"string"}},{"name":"fields","in":"query","description":"extra information of each page assignment on the list","schema":{"type":"string"}},{"name":"limit","in":"query","description":"maximum count of the page assignment list","example":"100","schema":{"type":"number"}},{"name":"offset","in":"query","description":"skip that many page assignment before beginning to return","example":"0","schema":{"type":"number"}},{"name":"validate_grammar","in":"query","description":"returns an error for incorrect field grammar when set to true","example":"false","schema":{"type":"string"}},{"name":"all_fields","in":"query","description":"will show all fields for each page assignment","example":"1","schema":{"type":"boolean"}},{"name":"exclude","in":"query","description":"will exclude specified fields","schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}],"requestBody":{"content":{"application/json":{"example":[{"id":529},{"id":532}],"schema":{"type":"object","properties":{"id":{"type":"number","example":529}}}}}}},"post":{"responses":{"201":{"description":"Created","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"number","description":"the created assignment id"}},"required":["id"]},"examples":{"example1":{"value":{"id":526}},"example2":{"value":[{"id":529},{"id":532}]}}}}}},"summary":"Create New Record Assignments","operationId":"Create New User Record Assignments","description":"","tags":["User Resource"],"parameters":[{"name":"profile_id","in":"path","description":"id of the profile","required":true,"example":"self","schema":{"type":"string"}},{"name":"user_id","in":"path","description":"id of the user","required":true,"example":"self","schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}],"requestBody":{"content":{"application/json":{"examples":{"example1":{"value":{"page_id":790777,"record_id":4}},"example2":{"value":[{"page_id":790777,"record_id":1},{"page_id":790777,"record_id":7}]}},"schema":{"type":"object","required":["page_id","record_id"],"properties":{"page_id":{"type":"number","example":790777},"record_id":{"type":"number","example":4}}}}}}}},"/profiles/{profile_id}/users/{user_id}/browser_tokens":{"post":{"responses":{"200":{"description":"OK - `browser_token` named one of the user's live registrations; it was refreshed and the count is unchanged.","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BrowserTokenRegisterOutcome"},"example":{"id":5120,"browser_token":"3f1c9a7e0b5d4c2a8e6f1b3d5c7a9e0f2b4d6c8a","browser_count":2,"remaining":4,"resets_at":"2026-11-06T00:00:00+00:00"}}}},"201":{"description":"Created - a new registration was added for this browser.","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BrowserTokenRegisterOutcome"},"examples":{"limited":{"value":{"id":5121,"browser_token":"9d2e4f6a8c0b1d3e5f7a9c1b3d5e7f9a0c2e4b6d","browser_count":3,"remaining":3,"resets_at":"2026-11-06T00:00:00+00:00"}},"unlimited":{"value":{"id":5122,"browser_token":"1a3c5e7b9d0f2a4c6e8b0d1f3a5c7e9b2d4f6a8c","browser_count":1,"remaining":null,"resets_at":null}}}}}},"400":{"description":"Bad Request - the body is not a JSON object, or `browser_token` is not a string of at most 50 characters.","headers":{},"content":{}},"401":{"description":"Unauthorized - missing or invalid bearer token.","headers":{},"content":{}},"403":{"description":"Forbidden - `user_id` is not the caller (no role or client may register a browser for another user), `profile_id` is not the caller's own profile, or the server's `webformTokenLimit` is `0` (no access to WebForms).","headers":{},"content":{}},"404":{"description":"Not Found - `user_id` is not a user of `profile_id`.","headers":{},"content":{}},"409":{"description":"Conflict - the user already holds `webformTokenLimit` live registrations. Nothing was added; retry after `resets_at`.","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BrowserTokenLimitOutcome"},"example":{"error_message":"You have exceeded the number of browsers you can be logged in on. WebForms cannot be accessed on this browser until after 2026-11-06T00:00:00+00:00.","browser_count":6,"resets_at":"2026-11-06T00:00:00+00:00"}}}}},"summary":"Register a WebForms Browser","operationId":"Register a WebForms Browser","description":"Registers the caller's current browser for WebForms, or refreshes its existing registration, and enforces the server's per-user browser limit (`webformTokenLimit`) on the server.\n\n### Request body\n\nOptional. Send `{}` (or no body) for a browser with no registration yet, or `{ \"browser_token\": \"...\" }` with the value an earlier call returned to this browser.\n\n### Behaviour\n\n1. Registrations created before the last daily reset are removed. The reset happens every day at the UTC hour set by `webformTokenExpireAt` (0-23).\n2. If `browser_token` names one of the user's live registrations, it is refreshed and the same token is returned (`200`). A token that is unknown, expired or someone else's is treated as absent.\n3. Otherwise a new random token is issued (`201`), unless the user already holds `webformTokenLimit` live registrations (`409`).\n\nThe limit check and the insert run in one transaction that locks the user, so concurrent registrations cannot exceed the limit. A limit of `-1` is unlimited (`remaining` and `resets_at` are `null`); a limit of `0` refuses every registration with `403`.\n\n### Authorization\n\nStandard bearer token. `user_id` must be the caller (`self` or the caller's own id). Company and server admins, and internal clients, cannot register a browser for another user.\n\n`browser_token` is only ever returned to its owner, by this endpoint. Keep it in the browser and send it back on the next registration.","tags":["User Resource"],"parameters":[{"name":"profile_id","in":"path","description":"id of the profile","required":true,"example":"self","schema":{"type":"string"}},{"name":"user_id","in":"path","description":"id of the user; must be the caller","required":true,"example":"self","schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}],"requestBody":{"required":false,"content":{"application/json":{"example":{"browser_token":"3f1c9a7e0b5d4c2a8e6f1b3d5c7a9e0f2b4d6c8a"},"schema":{"type":"object","properties":{"browser_token":{"type":"string","maxLength":50,"description":"the token an earlier registration returned to this browser"}}}}}}},"get":{"responses":{"200":{"description":"OK - the user's live registrations (created since the last daily reset), oldest first, at most 1000. Token values are never listed.","headers":{"Total-Count":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer"},"created_date":{"type":"string","description":"when the browser registered or last refreshed (UTC)"}},"required":["id","created_date"]}},"example":[{"id":5120,"created_date":"2026-11-05T08:12:44+00:00"},{"id":5121,"created_date":"2026-11-05T09:30:02+00:00"}]}}},"401":{"description":"Unauthorized - missing or invalid bearer token.","headers":{},"content":{}},"403":{"description":"Forbidden - a BASIC user asked about another user, or `profile_id` is not the caller's own profile (company admins).","headers":{},"content":{}},"404":{"description":"Not Found - `user_id` is not a user of `profile_id`.","headers":{},"content":{}}},"summary":"Retrieve a List of WebForms Browsers","operationId":"Retrieve a List of WebForms Browsers","description":"Lists the browsers a user is registered on for WebForms.\n\n### Authorization\n\nStandard bearer token. A BASIC user may list only their own (`self`); a company admin may list any user of their own profile, and a server admin any user. There is no internal-client bypass.\n\nReads may come from a read replica, so a browser token registered or deleted moments ago can briefly be missing from the list or still listed.","tags":["User Resource"],"parameters":[{"name":"profile_id","in":"path","description":"id of the profile","required":true,"example":"self","schema":{"type":"string"}},{"name":"user_id","in":"path","description":"id of the user","required":true,"example":"self","schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}]},"delete":{"responses":{"200":{"description":"OK - every listed registration was released.","headers":{},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BrowserTokenDeleteOutcome"}},"example":[{"id":5120},{"id":5121}]}}},"207":{"description":"Multi-Status - some ids were released and some were not found for this user. Same body shape as `200`.","headers":{},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BrowserTokenDeleteOutcome"}},"example":[{"id":5120},{"id":9999,"error_message":"The requested resource is not found"}]}}},"400":{"description":"Bad Request - the body is empty or not a non-empty JSON list of `{ \"id\": ... }` objects (nothing is deleted), or no listed id was found for this user (same outcome array as `200`).","headers":{},"content":{}},"401":{"description":"Unauthorized - missing or invalid bearer token.","headers":{},"content":{}},"403":{"description":"Forbidden - a BASIC user asked about another user, or `profile_id` is not the caller's own profile (company admins).","headers":{},"content":{}},"404":{"description":"Not Found - `user_id` is not a user of `profile_id`.","headers":{},"content":{}},"413":{"description":"Payload Too Large - more than 100 ids were submitted. Split the batch and retry.","headers":{},"content":{}}},"summary":"Delete a List of WebForms Browsers","operationId":"Delete a List of WebForms Browsers","description":"Releases the listed browser registrations of a user, freeing their slots.\n\n### Request body\n\nRequired: a JSON list of `{ \"id\": ... }` objects, at most 100. There is no \"delete all\": an empty body, `[]` or `{}` is a `400` and nothing is deleted.\n\n### Authorization\n\nSame as listing: BASIC users only for themselves, company admins for users of their own profile, server admins for any user. There is no internal-client bypass.","tags":["User Resource"],"parameters":[{"name":"profile_id","in":"path","description":"id of the profile","required":true,"example":"self","schema":{"type":"string"}},{"name":"user_id","in":"path","description":"id of the user","required":true,"example":"self","schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}],"requestBody":{"required":true,"content":{"application/json":{"example":[{"id":5120},{"id":5121}],"schema":{"type":"array","minItems":1,"maxItems":100,"items":{"type":"object","required":["id"],"properties":{"id":{"type":"integer","example":5120}}}}}}}}},"/profiles/{profile_id}/users/{user_id}/browser_tokens/{browser_token_id}":{"delete":{"responses":{"200":{"description":"OK - the registration was released.","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BrowserTokenDeleteOutcome"},"example":{"id":5120}}}},"401":{"description":"Unauthorized - missing or invalid bearer token.","headers":{},"content":{}},"403":{"description":"Forbidden - a BASIC user asked about another user, or `profile_id` is not the caller's own profile (company admins).","headers":{},"content":{}},"404":{"description":"Not Found - `user_id` is not a user of `profile_id`, or `browser_token_id` is not one of that user's registrations.","headers":{},"content":{}}},"summary":"Delete a WebForms Browser","operationId":"Delete a WebForms Browser","description":"Releases one browser registration (sign-out on that browser), freeing its slot.\n\n### Authorization\n\nSame as listing: BASIC users only for themselves, company admins for users of their own profile, server admins for any user. There is no internal-client bypass.","tags":["User Resource"],"parameters":[{"name":"profile_id","in":"path","description":"id of the profile","required":true,"example":"self","schema":{"type":"string"}},{"name":"user_id","in":"path","description":"id of the user","required":true,"example":"self","schema":{"type":"string"}},{"name":"browser_token_id","in":"path","description":"the registration `id` (from registration or the list), not the token value","required":true,"schema":{"type":"integer"}},{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}]}},"/profiles/{profile_id}/user_groups/{user_group_id}":{"get":{"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"},"global_id":{"type":"string"},"version":{"type":"number"},"created_date":{"type":"string"},"users":{}},"required":["id","name","global_id","version","created_date","users"]}}}}},"summary":"Retrieve a User Group","operationId":"Retrieve a User Group","description":"","tags":["User Group Resource"],"parameters":[{"name":"profile_id","in":"path","description":"id of the profile","required":true,"example":"self","schema":{"type":"string"}},{"name":"user_group_id","in":"path","description":"id of the user group","required":true,"example":"self","schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}]},"put":{"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"number","description":"the updated user group id"}},"required":["id"]},"example":{"id":161236}}}}},"summary":"Update a User Group","operationId":"Update a User Group","description":"","tags":["User Group Resource"],"parameters":[{"name":"profile_id","in":"path","description":"id of the profile","required":true,"example":"self","schema":{"type":"string"}},{"name":"user_group_id","in":"path","description":"id of the user group","required":true,"example":"self","schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}],"requestBody":{"content":{"application/json":{"example":{"name":"user_group"},"schema":{"type":"object","properties":{"name":{"type":"string","description":"New group name. Leading and trailing whitespace is trimmed; otherwise the name is stored and returned exactly as sent (it is no longer lowercased or stripped to `[a-z0-9_]`). Must be unique across all users and groups on the server, ignoring case and accents; the group's own current name is allowed, so a change of case alone is accepted. At most 200 characters; control characters and characters outside the Basic Multilingual Plane (such as emoji) are rejected.","example":"testing123"}}}}}}},"delete":{"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"number","description":"the deleted user group id"}},"required":["id"]},"example":{"id":161236}}}}},"summary":"Delete a User Group","operationId":"Delete a User Group","description":"","tags":["User Group Resource"],"parameters":[{"name":"profile_id","in":"path","description":"id of the profile","required":true,"example":"self","schema":{"type":"string"}},{"name":"user_group_id","in":"path","description":"id of the user group","required":true,"example":"self","schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}]}},"/profiles/{profile_id}/user_groups":{"get":{"responses":{"200":{"description":"OK","headers":{"Total-Count":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"},"global_id":{"type":"string"},"version":{"type":"number"},"created_date":{"type":"string"},"users":{}},"required":["id","name"]},"example":[{"id":161236,"name":"demo_user_group"},{"id":161239,"name":"inspector__group"},{"id":161242,"name":"logistics_group"}]}}}},"summary":"Retrieve a List of User Groups","operationId":"Retrieve a List of User Groups","description":"","tags":["User Group Resource"],"parameters":[{"name":"profile_id","in":"path","description":"id of the profile","required":true,"example":"self","schema":{"type":"string"}},{"name":"fields","in":"query","description":"extra information of each user on the list","schema":{"type":"string"}},{"name":"limit","in":"query","description":"maximum count of the user list","example":"100","schema":{"type":"number"}},{"name":"offset","in":"query","description":"skip that many users before beginning to return","example":"0","schema":{"type":"number"}},{"name":"validate_grammar","in":"query","description":"returns an error for incorrect field grammar when set to true","example":"false","schema":{"type":"string"}},{"name":"all_fields","in":"query","description":"will show all fields for each users","example":"1","schema":{"type":"boolean"}},{"name":"exclude","in":"query","description":"will exclude specified fields","schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}]},"post":{"responses":{"201":{"description":"Created","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"number","description":"the created user group id"}},"required":["id"]},"example":{"id":161236}}}}},"summary":"Create New User Groups","operationId":"Create New User Groups","description":"","tags":["User Group Resource"],"parameters":[{"name":"profile_id","in":"path","description":"id of the profile","required":true,"example":"self","schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}],"requestBody":{"content":{"application/json":{"example":{"name":"demo_user_group"},"schema":{"type":"object","required":["name"],"properties":{"name":{"type":"string","description":"Group name. Leading and trailing whitespace is trimmed; otherwise the name is stored and returned exactly as sent (it is no longer lowercased or stripped to `[a-z0-9_]`). Must be unique across all users and groups on the server, ignoring case and accents. At most 200 characters; control characters and characters outside the Basic Multilingual Plane (such as emoji) are rejected.","example":"demo_user_group"}}}}}}}},"/profiles/{profile_id}/user_groups/{user_group_id}/users/{user_id}":{"get":{"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"user_id":{"type":"number"},"username":{"type":"string"}},"required":["user_id","username"]},"example":{"user_id":155455,"username":"inspector"}}}},"404":{"description":"Not Found - `user_id` is not a member of `user_group_id`.","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error_message":"The requested resource is not found"}}}}},"summary":"Retrieve a User Assignment","operationId":"Retrieve a User Assignment","description":"","tags":["User Group Resource"],"parameters":[{"name":"profile_id","in":"path","description":"id of the profile","required":true,"example":"self","schema":{"type":"string"}},{"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"}},{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}]},"delete":{"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"user_id":{"type":"number","description":"the deleted user id"}},"required":["user_id"]},"example":{"user_id":154477}}}}},"summary":"Delete a User Assignment","operationId":"Delete a User Assignment","description":"","tags":["User Group Resource"],"parameters":[{"name":"profile_id","in":"path","description":"id of the profile","required":true,"example":"self","schema":{"type":"string"}},{"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"}},{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}]}},"/profiles/{profile_id}/user_groups/{user_group_id}/users":{"get":{"responses":{"200":{"description":"OK","headers":{"Total-Count":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"user_id":{"type":"number"},"username":{"type":"string"}},"required":["user_id","username"]},"example":[{"user_id":159789,"username":"Michael"},{"user_id":169555,"username":"GeorgeMichael"},{"user_id":156487,"username":"GeorgeSr"}]}}}},"summary":"Retrieve a List of User Assignments","operationId":"Retrieve a List of User Assignments","description":"","tags":["User Group Resource"],"parameters":[{"name":"profile_id","in":"path","description":"id of the profile","required":true,"example":"self","schema":{"type":"string"}},{"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","schema":{"type":"string"}},{"name":"limit","in":"query","description":"maximum count of the page assignment list","example":"100","schema":{"type":"number"}},{"name":"offset","in":"query","description":"skip that many page assignment before beginning to return","example":"0","schema":{"type":"number"}},{"name":"validate_grammar","in":"query","description":"returns an error for incorrect field grammar when set to true","example":"false","schema":{"type":"string"}},{"name":"all_fields","in":"query","description":"will show all fields for each page assignment","example":"1","schema":{"type":"boolean"}},{"name":"exclude","in":"query","description":"will exclude specified fields","schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}]},"delete":{"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"user_id":{"type":"number","description":"the deleted user id"}},"required":["user_id"]},"example":[{"user_id":456124},{"user_id":875152}]}}}},"summary":"Delete a List of User Assignments","operationId":"Delete a List of User Assignments","description":"","tags":["User Group Resource"],"parameters":[{"name":"profile_id","in":"path","description":"id of the profile","required":true,"example":"self","schema":{"type":"string"}},{"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","schema":{"type":"string"}},{"name":"limit","in":"query","description":"maximum count of the page assignment list","example":"100","schema":{"type":"number"}},{"name":"offset","in":"query","description":"skip that many page assignment before beginning to return","example":"0","schema":{"type":"number"}},{"name":"validate_grammar","in":"query","description":"returns an error for incorrect field grammar when set to true","example":"false","schema":{"type":"string"}},{"name":"all_fields","in":"query","description":"will show all fields for each page assignment","example":"1","schema":{"type":"boolean"}},{"name":"exclude","in":"query","description":"will exclude specified fields","schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}],"requestBody":{"content":{"application/json":{"example":[{"user_id":456124},{"user_id":875152}],"schema":{"type":"object","properties":{"user_id":{"type":"number","example":2734}}}}}}},"post":{"responses":{"201":{"description":"Created","headers":{},"content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"user_id":{"type":"number","description":"the assigned user id"}},"required":["user_id"]},{"type":"object","properties":{"user_id":{"type":"number","description":"the assigned user id(s)"}},"required":["user_id"]}]},"examples":{"example1":{"value":{"user_id":415215}},"example2":{"value":[{"page_id":790771},{"page_id":790774}]}}}}},"207":{"description":"Multi-Status - some items succeeded and some failed. The body is an array in request order (a list request body, even with one item, always answers a list); a failed item carries `error_message` instead of `user_id` and was not written. A user who is already a member of the group answers `Parameter 'user_id' is invalid`.","headers":{},"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"user_id":{"type":"integer","description":"present when the item succeeded"},"error_message":{"type":"string","description":"present when the item failed"}}}},"example":[{"user_id":12345},{"error_message":"Parameter 'user_id' is invalid"}]}}},"400":{"description":"Bad Request - every item of a list request body failed. The body has the same shape as `207`, with `error_message` on each item; nothing was written. A single-object request body that fails answers the standard error object instead.","headers":{},"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/ApiError"},{"type":"array","items":{"type":"object","properties":{"error_message":{"type":"string"}},"required":["error_message"]}}]},"examples":{"all_failed":{"summary":"Every item of a list body failed","value":[{"error_message":"Parameter 'user_id' is invalid"}]},"single_object":{"summary":"A single-object body failed","value":{"error_message":"Parameter 'user_id' is invalid"}}}}}}},"summary":"Create New User Assignments","operationId":"Create New User Assignments","description":"","tags":["User Group Resource"],"parameters":[{"name":"profile_id","in":"path","description":"id of the profile","required":true,"example":"self","schema":{"type":"string"}},{"name":"user_group_id","in":"path","description":"id of the user group","required":true,"schema":{"type":"number"}},{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}],"requestBody":{"content":{"application/json":{"examples":{"example1":{"value":{"user_id":415215}},"example2":{"value":[{"user_id":790154},{"user_id":781045}]}},"schema":{"type":"object","required":["user_id"],"properties":{"user_id":{"type":"number","example":415215}}}}}}}},"/profiles/{profile_id}/user_groups/{user_group_id}/page_assignments/{page_id}":{"get":{"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"page_id":{"type":"number"},"is_group":{"type":"boolean"},"can_collect":{"type":"boolean"},"can_view":{"type":"boolean"}},"required":["page_id","is_group","can_collect","can_view"]},"example":{"page_id":790777,"is_group":false,"can_collect":true,"can_view":true}}}}},"summary":"Retrieve a Page Assignment","operationId":"Retrieve a User Group Page Assignment","description":"","tags":["User Group Resource"],"parameters":[{"name":"profile_id","in":"path","description":"id of the profile","required":true,"example":"self","schema":{"type":"string"}},{"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"}},{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}]},"put":{"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"page_id":{"type":"number","description":"the updated page id"}},"required":["page_id"]},"example":{"page_id":790777}}}}},"summary":"Update a Page Assignment","operationId":"Update a User Group Page Assignment","description":"","tags":["User Group Resource"],"parameters":[{"name":"profile_id","in":"path","description":"id of the profile","required":true,"example":"self","schema":{"type":"string"}},{"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"}},{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}],"requestBody":{"content":{"application/json":{"example":{"can_collect":true,"can_view":true},"schema":{"type":"object","properties":{"can_collect":{"type":"boolean","example":true},"can_view":{"type":"boolean","example":true}}}}}}},"delete":{"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"page_id":{"type":"number","description":"the deleted page id"}},"required":["page_id"]},"example":{"page_id":790777}}}}},"summary":"Delete a Page Assignment","operationId":"Delete a User Group Page Assignment","description":"","tags":["User Group Resource"],"parameters":[{"name":"profile_id","in":"path","description":"id of the profile","required":true,"example":"self","schema":{"type":"string"}},{"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"}},{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}]}},"/profiles/{profile_id}/user_groups/{user_group_id}/page_assignments":{"get":{"responses":{"200":{"description":"OK","headers":{"Total-Count":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"page_id":{"type":"number"},"is_group":{"type":"boolean"},"can_collect":{"type":"boolean"},"can_view":{"type":"boolean"}},"required":["page_id"]},"example":[{"page_id":790777},{"page_id":790771},{"page_id":790774}]}}}},"summary":"Retrieve a List of Page Assignments","operationId":"Retrieve a List of User Group Page Assignments","description":"","tags":["User Group Resource"],"parameters":[{"name":"profile_id","in":"path","description":"id of the profile","required":true,"example":"self","schema":{"type":"string"}},{"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","schema":{"type":"string"}},{"name":"limit","in":"query","description":"maximum count of the page assignment list","example":"100","schema":{"type":"number"}},{"name":"offset","in":"query","description":"skip that many page assignment before beginning to return","example":"0","schema":{"type":"number"}},{"name":"validate_grammar","in":"query","description":"returns an error for incorrect field grammar when set to true","example":"false","schema":{"type":"string"}},{"name":"all_fields","in":"query","description":"will show all fields for each page assignment","example":"1","schema":{"type":"boolean"}},{"name":"exclude","in":"query","description":"will exclude specified fields","schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}]},"put":{"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"page_id":{"type":"number","description":"the updated page id"}},"required":["page_id"]},"example":[{"page_id":790771},{"page_id":790774}]}}}},"summary":"Update a List of Page Assignments","operationId":"Update a List of User Group Page Assignments","description":"","tags":["User Group Resource"],"parameters":[{"name":"profile_id","in":"path","description":"id of the profile","required":true,"example":"self","schema":{"type":"string"}},{"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","schema":{"type":"string"}},{"name":"limit","in":"query","description":"maximum count of the page assignment list","example":"100","schema":{"type":"number"}},{"name":"offset","in":"query","description":"skip that many page assignment before beginning to return","example":"0","schema":{"type":"number"}},{"name":"validate_grammar","in":"query","description":"returns an error for incorrect field grammar when set to true","example":"false","schema":{"type":"string"}},{"name":"all_fields","in":"query","description":"will show all fields for each page assignment","example":"1","schema":{"type":"boolean"}},{"name":"exclude","in":"query","description":"will exclude specified fields","schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}],"requestBody":{"content":{"application/json":{"examples":{"example1":{"value":[{"page_id":790771,"can_view":false},{"page_id":790774,"can_view":false}]},"example2":{"value":{"can_view":false}}},"schema":{"type":"object","properties":{"page_id":{"type":"number","example":790777},"can_collect":{"type":"boolean","example":true},"can_view":{"type":"boolean","example":true}}}}}}},"delete":{"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"page_id":{"type":"number","description":"the deleted page id"}},"required":["page_id"]},"example":[{"page_id":790771},{"page_id":790774}]}}}},"summary":"Delete a List of Page Assignments","operationId":"Delete a List of User Group Page Assignments","description":"","tags":["User Group Resource"],"parameters":[{"name":"profile_id","in":"path","description":"id of the profile","required":true,"example":"self","schema":{"type":"string"}},{"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","schema":{"type":"string"}},{"name":"limit","in":"query","description":"maximum count of the page assignment list","example":"100","schema":{"type":"number"}},{"name":"offset","in":"query","description":"skip that many page assignment before beginning to return","example":"0","schema":{"type":"number"}},{"name":"validate_grammar","in":"query","description":"returns an error for incorrect field grammar when set to true","example":"false","schema":{"type":"string"}},{"name":"all_fields","in":"query","description":"will show all fields for each page assignment","example":"1","schema":{"type":"boolean"}},{"name":"exclude","in":"query","description":"will exclude specified fields","schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}],"requestBody":{"content":{"application/json":{"example":[{"page_id":790771},{"page_id":790774}],"schema":{"type":"object","properties":{"page_id":{"type":"number","example":790771}}}}}}},"post":{"responses":{"201":{"description":"Created","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"page_id":{"type":"number","description":"the created page id"}},"required":["page_id"]},"examples":{"example1":{"value":{"page_id":790777}},"example2":{"value":[{"page_id":790771},{"page_id":790774}]}}}}}},"summary":"Create New Page Assignments","operationId":"Create New User Group Page Assignments","description":"","tags":["User Group Resource"],"parameters":[{"name":"profile_id","in":"path","description":"id of the profile","required":true,"example":"self","schema":{"type":"string"}},{"name":"user_group_id","in":"path","description":"id of the user group","required":true,"schema":{"type":"number"}},{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}],"requestBody":{"content":{"application/json":{"examples":{"example1":{"value":{"page_id":790777,"can_collect":true}},"example2":{"value":[{"page_id":790771,"can_collect":true},{"page_id":790774,"can_collect":true}]}},"schema":{"type":"object","required":["page_id"],"properties":{"page_id":{"type":"number","example":790777},"can_collect":{"type":"boolean","example":true},"can_view":{"type":"boolean","example":true}}}}}}}},"/profiles/{profile_id}/pages/{page_id}":{"get":{"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"},"permissions":{"type":"object","properties":{}},"permissions.modify":{"type":"boolean"},"permissions.view":{"type":"boolean"},"permissions.collect":{"type":"boolean"},"permissions.shared":{"type":"boolean"},"permissions.shared-subform":{"type":"boolean"},"permissions.shared-lookup":{"type":"boolean"},"global_id":{"type":"string"},"label":{"type":"string"},"description":{"type":"string"},"version":{"type":"number"},"created_date":{"type":"string"},"created_by: `demo_user`":{"type":"string"},"modified_date":{"type":"string"},"modified_by: `demo_user`":{"type":"string"},"is_disabled":{"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"},"icon":{"type":"string"},"sort_order":{"type":"number"},"page_javascript":{"type":"string"},"label_icons":{"type":"string"},"localizations":{}},"required":["id","name","permissions","permissions.modify","permissions.view","permissions.collect","permissions.shared","permissions.shared-subform","permissions.shared-lookup","global_id","label","description","version","created_date","created_by: `demo_user`","modified_date","modified_by: `demo_user`","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"]},"example":{"id":790777,"name":"building_inspection","permissions":{"modify":true,"view":true,"collect":true,"shared":false,"shared-subform":false,"shared-lookup":false},"global_id":"0P790777H46FF3","label":"Building Inspection","description":"A form designed for building inspection","version":3,"created_date":"2015-05-12T11:27:14+00:00","created_by":"demo_user","modified_date":"2015-05-12T11:40:54+00:00","modified_by":"demo_user","is_disabled":false,"reference_id_1":"","reference_id_2":"","reference_id_3":"","reference_id_4":"","reference_id_5":"","icon":"https://example.com/media/icon_bldginsp.png","sort_order":0,"page_javascript":"","label_icons":"","localizations":[]}}}},"404":{"description":"Not Found - `page_id` does not exist or is not a page of `profile_id`.","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error_message":"The requested resource is not found"}}}}},"summary":"Retrieve a Page","operationId":"Retrieve a Page","description":"","tags":["Page Resource"],"parameters":[{"name":"profile_id","in":"path","description":"id of the profile","required":true,"example":"self","schema":{"type":"string"}},{"name":"page_id","in":"path","description":"id of the page","required":true,"schema":{"type":"number"}},{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}]},"put":{"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"number","description":"the updated page id"}},"required":["id"]},"example":{"id":790777}}}}},"summary":"Update a Page","operationId":"Update a Page","description":"","tags":["Page Resource"],"parameters":[{"name":"profile_id","in":"path","description":"id of the profile","required":true,"example":"self","schema":{"type":"string"}},{"name":"page_id","in":"path","description":"id of the page","required":true,"schema":{"type":"number"}},{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}],"requestBody":{"content":{"application/json":{"example":{"description":"A form designed for building inspection","icon":"https://example.com/media/icon_bldginsp.png"},"schema":{"type":"object","properties":{"name":{"type":"string","example":"building_inspection"},"label":{"type":"string","example":"Building Inspection"},"description":{"type":"string","example":"A form designed for building inspection"},"is_disabled":{"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"},"icon":{"type":"string","example":"https://example.com/media/icon_bldginsp.png"},"sort_order":{"type":"number"},"page_javascript":{"type":"string"},"label_icons":{"type":"string"}}}}}}},"delete":{"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"number","description":"the deleted page id"}},"required":["id"]},"example":{"id":790777}}}},"404":{"description":"Not Found - `page_id` does not exist or is not a page of `profile_id`.","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error_message":"The requested resource is not found"}}}}},"summary":"Delete a Page","operationId":"Delete a Page","description":"","tags":["Page Resource"],"parameters":[{"name":"profile_id","in":"path","description":"id of the profile","required":true,"example":"self","schema":{"type":"string"}},{"name":"page_id","in":"path","description":"id of the page","required":true,"schema":{"type":"number"}},{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}]},"post":{"responses":{"201":{"description":"Created","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"number","description":"the copied page id"}},"required":["id"]},"example":{"id":790780}}}}},"summary":"Copy a Page","operationId":"Copy a Page","description":"**Note:** This operation uses the non-standard HTTP `COPY` method. It is documented under `POST` because OpenAPI does not support custom HTTP methods — send the actual request with the `COPY` verb.\n\n","tags":["Page Resource"],"parameters":[{"name":"profile_id","in":"path","description":"id of the profile","required":true,"example":"self","schema":{"type":"string"}},{"name":"page_id","in":"path","description":"id of the page","required":true,"schema":{"type":"number"}},{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}],"x-original-http-method":"COPY"}},"/profiles/{profile_id}/pages":{"get":{"responses":{"200":{"description":"OK","headers":{"Total-Count":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"},"permissions":{"type":"object","properties":{}},"permissions.modify":{"type":"boolean"},"permissions.view":{"type":"boolean"},"permissions.collect":{"type":"boolean"},"permissions.shared":{"type":"boolean"},"permissions.shared-subform":{"type":"boolean"},"permissions.shared-lookup":{"type":"boolean"},"global_id":{"type":"string"},"label":{"type":"string"},"description":{"type":"string"},"version":{"type":"number"},"created_date":{"type":"string"},"created_by: `demo_user`":{"type":"string"},"modified_date":{"type":"string"},"modified_by: `demo_user`":{"type":"string"},"is_disabled":{"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"},"icon":{"type":"string"},"sort_order":{"type":"number"},"page_javascript":{"type":"string"},"label_icons":{"type":"string"},"localizations":{}},"required":["id","name","permissions","permissions.modify","permissions.view","permissions.collect","permissions.shared","permissions.shared-subform","permissions.shared-lookup"]},"example":[{"id":790765,"name":"de13_taking_a_lot_of_pictures","permissions":{"modify":true,"view":true,"collect":true,"shared":false,"shared-subform":false,"shared-lookup":false}},{"id":790768,"name":"de13_photo_subform","permissions":{"modify":true,"view":true,"collect":true,"shared":false,"shared-subform":false,"shared-lookup":false}},{"id":790777,"name":"building_inspection","permissions":{"modify":true,"view":true,"collect":true,"shared":false,"shared-subform":false,"shared-lookup":false}}]}}},"400":{"description":"Bad Request - `limit` or `offset` is not an integer.","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error_message":"'limit' must be an integer"}}}}},"summary":"Retrieve a List of Pages","operationId":"Retrieve a List of Pages","description":"","tags":["Page Resource"],"parameters":[{"name":"profile_id","in":"path","description":"id of the profile","required":true,"example":"self","schema":{"type":"string"}},{"name":"fields","in":"query","description":"extra information of each page on the list","schema":{"type":"string"}},{"name":"limit","in":"query","description":"maximum count of the profile list","example":"100","schema":{"type":"number"}},{"name":"offset","in":"query","description":"skip that many pages before beginning to return","example":"0","schema":{"type":"number"}},{"name":"validate_grammar","in":"query","description":"returns an error for incorrect field grammar when set to true","example":"false","schema":{"type":"string"}},{"name":"all_fields","in":"query","description":"will show all fields for each page","example":"1","schema":{"type":"boolean"}},{"name":"exclude","in":"query","description":"will exclude specified fields","schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}]},"post":{"responses":{"201":{"description":"Created","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"number","description":"the created page id"}},"required":["id"]},"example":{"id":790777}}}}},"summary":"Create a New Page","operationId":"Create a New Page","description":"","tags":["Page Resource"],"parameters":[{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}],"requestBody":{"content":{"application/json":{"example":{"name":"building_inspection","label":"Building Inspection","sort_order":0},"schema":{"type":"object","required":["name","label"],"properties":{"name":{"type":"string","example":"building_inspection"},"label":{"type":"string","example":"Building Inspection"},"description":{"type":"string","example":"A form designed for building inspection"},"is_disabled":{"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"},"icon":{"type":"string","example":"https://example.com/media/icon_bldginsp.png"},"sort_order":{"type":"number"},"page_javascript":{"type":"string"},"label_icons":{"type":"string"}}}}}}}},"/profiles/{profile_id}/page_status":{"get":{"responses":{"200":{"description":"OK","headers":{"Total-Count":{"description":"number of rows that match the filter, ignoring `limit` and `offset`","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PageStatusOutcome"}},"example":[{"page_id":790777,"profile_id":123456,"row_count":152,"last_modified_date":"2026-11-02T14:31:07+00:00","last_modified_location":"40.7128,-74.0060"},{"page_id":790765,"profile_id":123456,"row_count":0,"last_modified_date":"2026-10-15T09:12:44+00:00","last_modified_location":""}]}}},"400":{"description":"Bad Request - `limit` or `offset` is not an integer.","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error_message":"'limit' must be an integer"}}}},"401":{"description":"Unauthorized - missing or invalid bearer token.","headers":{},"content":{}},"403":{"description":"Forbidden - `profile_id` is not the caller's own profile (only SERVER users may name another profile), or the caller is a BASIC user with neither the form role nor the Record Assignment policy.","headers":{},"content":{}},"404":{"description":"Not Found - the profile does not exist.","headers":{},"content":{}},"429":{"description":"Too Many Requests - the per-server limit for this endpoint (`apiEndpointLimits`) was reached.","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error_message":"API rate limit exceeded"}}}}},"summary":"Retrieve a List of Page Statuses","operationId":"Retrieve a List of Page Statuses","description":"Returns the record count and the date and location of the last record change for every form in the profile that the caller may view, in one call. Each item is the row `GET .../pages/{page_id}/page_status` returns for that form.\n\n### Fields and filters\n\nStandard list grammar. Default fields are `page_id`, `profile_id`, `row_count`, `last_modified_date` and `last_modified_location`; `id` is also available. Filter on the form with `fields=page_id(=\"790777\")` or a range such as `fields=page_id(\u003e\"790000\")`. The default order is `id` descending.\n\n`limit` defaults to and is capped at 100. `Total-Count` is the number of matching rows before `limit` and `offset`.\n\n### Row count\n\n`row_count` is returned as stored. A negative value means the count is unknown; the stored value is not recomputed by this endpoint.\n\n### Which forms are listed\n\nOnly forms that belong to the profile or are shared into it, the same set `GET .../pages/{page_id}/page_status` answers for. A form with no status row is not listed.\n\n- Internal clients, COMPANY and SERVER users, and BASIC users with the form role see every such form.\n- BASIC users with the Record Assignment policy and no form role see the forms assigned to them for view or collect, directly, through a user group, through a page group, or through both.\n- Any other BASIC user gets `403`.\n\n### HTTP status\n\n- `200` the list, possibly empty\n- `401` no valid bearer token\n- `403` another profile's `profile_id` and the caller is not a SERVER user, or a BASIC user with neither role\n- `404` unknown profile\n- `429` the endpoint rate limit was reached; this route shares the per-endpoint budget with the other page status routes\n\nReads may come from a read replica, so a just-written status can take a few seconds to show.","tags":["Page Resource"],"parameters":[{"name":"profile_id","in":"path","description":"id of the profile","required":true,"example":"self","schema":{"type":"string"}},{"name":"fields","in":"query","description":"fields to return and filters, e.g. `page_id(=\"790777\")`","schema":{"type":"string"}},{"name":"limit","in":"query","description":"maximum count of the page status list","example":"100","schema":{"type":"number"}},{"name":"offset","in":"query","description":"skip that many page statuses before beginning to return","example":"0","schema":{"type":"number"}},{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}]}},"/profiles/{profile_id}/pages/{page_id}/feed":{"get":{"responses":{"200":{"description":"OK","headers":{"Total-Count":{"description":"number of records matching the request filters, ignoring `limit` and `offset`","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"number"},"parent_record_id":{"type":"number"},"parent_page_id":{"type":"number"},"parent_element_id":{"type":"number"},"created_date":{"type":"string"},"created_by: `demo_user`":{"type":"string"},"created_location":{"type":"string"},"created_device_id":{"type":"string"},"modified_date":{"type":"string"},"modified_by: `demo_user`":{"type":"string"},"modified_location":{"type":"string"},"modified_device_id":{"type":"string"},"server_modified_date":{"type":"string"},"javascript_state":{"type":"string"}},"required":["id"]},"example":[{"id":3,"parent_record_id":0,"parent_page_id":0,"parent_element_id":0,"created_date":"2018-04-18T17:23:57+00:00","created_by":"tony","created_location":"Server","created_device_id":"Server","modified_date":"2018-04-18T17:23:57+00:00","modified_by":"tony","modified_location":"Server","modified_device_id":"Server","server_modified_date":"2018-04-18T17:23:57+00:00","javascript_state":"{}","my_element_2":null,"my_element_1":[{"id":3,"parent_record_id":3,"parent_page_id":290804421,"parent_element_id":121091346,"created_date":"2018-04-18T17:30:08+00:00","created_by":"tonyplug","created_location":"API","created_device_id":"API","modified_date":"2018-04-18T17:33:31+00:00","modified_by":"onlychild","modified_location":"39.744230:-76.609999:246.626373:65.000000:10.000000:-1.000000:-1.000000:1524072811.204094","modified_device_id":"7054e0d8d6901e8ef10611ea2e25a31319cc4174","server_modified_date":"2018-04-18T17:33:33+00:00","javascript_state":"{}","my_element_1":"2015-05-12T14:38:19+00:00","my_element_2":"Tony Ruth","my_element_3":"Green","my_element_4":"Turtle"}]}]}}},"404":{"description":"Not Found - `page_id` does not exist or is not a page of `profile_id`.","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error_message":"The requested resource is not found"}}}},"500":{"description":"Internal Server Error - the record count for `Total-Count` could not be read. The request fails rather than report a count of 0.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"summary":"Retrieve the page feed","operationId":"Retrieve the page feed","description":"","tags":["Page Resource"],"parameters":[{"name":"profile_id","in":"path","description":"id of the profile","required":true,"example":"self","schema":{"type":"string"}},{"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","example":"0","schema":{"type":"boolean"}},{"name":"javascript_state","in":"query","description":"will exclude javascript state if set to 0","example":"0","schema":{"type":"boolean"}},{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}]}},"/profiles/{profile_id}/pages/{page_id}/localizations/{language_code}":{"get":{"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"language_code":{"type":"string"},"label":{"type":"string"}},"required":["language_code","label"]},"example":{"language_code":"es","label":"inspección de la construcción"}}}}},"summary":"Retrieve a Page Localization","operationId":"Retrieve a Page Localization","description":"","tags":["Page Resource"],"parameters":[{"name":"profile_id","in":"path","description":"id of the profile","required":true,"example":"self","schema":{"type":"string"}},{"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"}},{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}]},"put":{"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"language_code":{"type":"string","description":"the updated language code"}},"required":["language_code"]},"example":{"language_code":"es"}}}}},"summary":"Update a Page Localization","operationId":"Update a Page Localization","description":"","tags":["Page Resource"],"parameters":[{"name":"profile_id","in":"path","description":"id of the profile","required":true,"example":"self","schema":{"type":"string"}},{"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"}},{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}],"requestBody":{"content":{"application/json":{"example":{"label":"inspección de la construcción"},"schema":{"type":"object","properties":{"label":{"type":"string","example":"inspección de la construcción"}}}}}}},"delete":{"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"language_code":{"type":"string","description":"the deleted language code"}},"required":["language_code"]},"example":{"language_code":"es"}}}}},"summary":"Delete a Page Localization","operationId":"Delete a Page Localization","description":"","tags":["Page Resource"],"parameters":[{"name":"profile_id","in":"path","description":"id of the profile","required":true,"example":"self","schema":{"type":"string"}},{"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"}},{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}]}},"/profiles/{profile_id}/pages/{page_id}/localizations":{"get":{"responses":{"200":{"description":"OK","headers":{"Total-Count":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"language_code":{"type":"string"},"label":{"type":"string"}},"required":["language_code","label"]},"example":[{"language_code":"es","label":"inspección de la construcción"},{"language_code":"zh-hans","label":"楼宇检查"},{"language_code":"zh-hant","label":"樓宇檢查"}]}}},"404":{"description":"Not Found - `page_id` does not exist or is not a page of `profile_id`.","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error_message":"The requested resource is not found"}}}}},"summary":"Retrieve a List of Page Localizations","operationId":"Retrieve a List of Page Localizations","description":"","tags":["Page Resource"],"parameters":[{"name":"profile_id","in":"path","description":"id of the profile","required":true,"example":"self","schema":{"type":"string"}},{"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","schema":{"type":"string"}},{"name":"limit","in":"query","description":"maximum count of the page localization list","example":"100","schema":{"type":"number"}},{"name":"offset","in":"query","description":"skip that many page localization before beginning to return","example":"0","schema":{"type":"number"}},{"name":"validate_grammar","in":"query","description":"returns an error for incorrect field grammar when set to true","example":"false","schema":{"type":"string"}},{"name":"all_fields","in":"query","description":"will show all fields for each page localization","example":"1","schema":{"type":"boolean"}},{"name":"exclude","in":"query","description":"will exclude specified fields","schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}]},"put":{"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"language_code":{"type":"string","description":"the updated language code"}},"required":["language_code"]},"example":[{"language_code":"zh-hans"},{"language_code":"zh-hant"}]}}},"207":{"description":"Multi-Status - some items succeeded and some failed. The body is an array in request order (a list request body, even with one item, always answers a list); a failed item carries `error_message` instead of `language_code` and was not written.","headers":{},"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"language_code":{"type":"string","description":"present when the item succeeded"},"error_message":{"type":"string","description":"present when the item failed"}}}},"example":[{"language_code":"es"},{"error_message":"Parameter 'language_code' is invalid"}]}}},"400":{"description":"Bad Request - every item of a list request body failed. The body has the same shape as `207`, with `error_message` on each item; nothing was written. A single-object request body that fails answers the standard error object instead.","headers":{},"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/ApiError"},{"type":"array","items":{"type":"object","properties":{"error_message":{"type":"string"}},"required":["error_message"]}}]},"examples":{"all_failed":{"summary":"Every item of a list body failed","value":[{"error_message":"Parameter 'language_code' is invalid"}]},"single_object":{"summary":"A single-object body failed","value":{"error_message":"Parameter 'language_code' is invalid"}}}}}},"404":{"description":"Not Found - `page_id` does not exist or is not a page of `profile_id`.","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error_message":"The requested resource is not found"}}}}},"summary":"Update a List of Page Localizations","operationId":"Update a List of Page Localizations","description":"","tags":["Page Resource"],"parameters":[{"name":"profile_id","in":"path","description":"id of the profile","required":true,"example":"self","schema":{"type":"string"}},{"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","schema":{"type":"string"}},{"name":"limit","in":"query","description":"maximum count of the page localization list","example":"100","schema":{"type":"number"}},{"name":"offset","in":"query","description":"skip that many page localization before beginning to return","example":"0","schema":{"type":"number"}},{"name":"validate_grammar","in":"query","description":"returns an error for incorrect field grammar when set to true","example":"false","schema":{"type":"string"}},{"name":"all_fields","in":"query","description":"will show all fields for each page localization","example":"1","schema":{"type":"boolean"}},{"name":"exclude","in":"query","description":"will exclude specified fields","schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}],"requestBody":{"content":{"application/json":{"example":[{"language_code":"zh-hans","label":"楼宇检查"},{"language_code":"zh-hant","label":"樓宇檢查"}],"schema":{"type":"object","properties":{"language_code":{"type":"string","example":"es"},"label":{"type":"string","example":"inspección de la construcción"}}}}}}},"delete":{"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"language_code":{"type":"string","description":"the deleted language code"}},"required":["language_code"]},"example":[{"language_code":"zh-hans"},{"language_code":"zh-hant"}]}}},"207":{"description":"Multi-Status - some items succeeded and some failed. The body is an array in request order (a list request body, even with one item, always answers a list); a failed item carries `error_message` instead of `language_code` and was not written. An item whose row does not exist answers `The requested resource is not found`.","headers":{},"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"language_code":{"type":"string","description":"present when the item succeeded"},"error_message":{"type":"string","description":"present when the item failed"}}}},"example":[{"language_code":"es"},{"error_message":"Parameter 'language_code' is invalid"}]}}},"400":{"description":"Bad Request - every item of a list request body failed. The body has the same shape as `207`, with `error_message` on each item; nothing was written. A single-object request body that fails answers the standard error object instead.","headers":{},"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/ApiError"},{"type":"array","items":{"type":"object","properties":{"error_message":{"type":"string"}},"required":["error_message"]}}]},"examples":{"all_failed":{"summary":"Every item of a list body failed","value":[{"error_message":"Parameter 'language_code' is invalid"}]},"single_object":{"summary":"A single-object body failed","value":{"error_message":"Parameter 'language_code' is invalid"}}}}}},"404":{"description":"Not Found - `page_id` does not exist or is not a page of `profile_id`.","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error_message":"The requested resource is not found"}}}}},"summary":"Delete a List of Page Localizations","operationId":"Delete a List of Page Localizations","description":"","tags":["Page Resource"],"parameters":[{"name":"profile_id","in":"path","description":"id of the profile","required":true,"example":"self","schema":{"type":"string"}},{"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","schema":{"type":"string"}},{"name":"limit","in":"query","description":"maximum count of the page localization list","example":"100","schema":{"type":"number"}},{"name":"offset","in":"query","description":"skip that many page localization before beginning to return","example":"0","schema":{"type":"number"}},{"name":"validate_grammar","in":"query","description":"returns an error for incorrect field grammar when set to true","example":"false","schema":{"type":"string"}},{"name":"all_fields","in":"query","description":"will show all fields for each page localization","example":"1","schema":{"type":"boolean"}},{"name":"exclude","in":"query","description":"will exclude specified fields","schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}],"requestBody":{"content":{"application/json":{"example":[{"language_code":"zh-hans"},{"language_code":"zh-hant"}],"schema":{"type":"object","properties":{"language_code":{"type":"string","example":"zh-hans"}}}}}}},"post":{"responses":{"201":{"description":"Created","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"language_code":{"type":"string","description":"the created language code"}},"required":["language_code"]},"examples":{"example1":{"value":{"language_code":"es"}},"example2":{"value":[{"language_code":"zh-hans"},{"language_code":"zh-hant"}]}}}}},"207":{"description":"Multi-Status - some items succeeded and some failed. The body is an array in request order (a list request body, even with one item, always answers a list); a failed item carries `error_message` instead of `language_code` and was not written.","headers":{},"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"language_code":{"type":"string","description":"present when the item succeeded"},"error_message":{"type":"string","description":"present when the item failed"}}}},"example":[{"language_code":"es"},{"error_message":"Parameter 'language_code' is invalid"}]}}},"400":{"description":"Bad Request - every item of a list request body failed. The body has the same shape as `207`, with `error_message` on each item; nothing was written. A single-object request body that fails answers the standard error object instead.","headers":{},"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/ApiError"},{"type":"array","items":{"type":"object","properties":{"error_message":{"type":"string"}},"required":["error_message"]}}]},"examples":{"all_failed":{"summary":"Every item of a list body failed","value":[{"error_message":"Parameter 'language_code' is invalid"}]},"single_object":{"summary":"A single-object body failed","value":{"error_message":"Parameter 'language_code' is invalid"}}}}}},"404":{"description":"Not Found - `page_id` does not exist or is not a page of `profile_id`.","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error_message":"The requested resource is not found"}}}}},"summary":"Create New Page Localizations","operationId":"Create New Page Localizations","description":"","tags":["Page Resource"],"parameters":[{"name":"profile_id","in":"path","description":"id of the profile","required":true,"example":"self","schema":{"type":"string"}},{"name":"page_id","in":"path","description":"id of the page","required":true,"schema":{"type":"number"}},{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}],"requestBody":{"content":{"application/json":{"examples":{"example1":{"value":{"language_code":"es","label":"inspección de la construcción"}},"example2":{"value":[{"language_code":"zh-hans","label":"楼宇检查"},{"language_code":"zh-hant","label":"樓宇檢查"}]}},"schema":{"type":"object","required":["language_code","label"],"properties":{"language_code":{"type":"string","example":"es"},"label":{"type":"string","example":"inspección de la construcción"}}}}}}}},"/profiles/{profile_id}/pages/{page_id}/assignments/{user_id}":{"get":{"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"user_id":{"type":"number"},"can_collect":{"type":"boolean"},"can_view":{"type":"boolean"}},"required":["user_id","can_collect","can_view"]},"example":{"user_id":161236,"can_collect":true,"can_view":true}}}}},"summary":"Retrieve a Page Assignment","operationId":"Retrieve a Page Assignment","description":"","tags":["Page Resource"],"parameters":[{"name":"profile_id","in":"path","description":"id of the profile","required":true,"example":"self","schema":{"type":"string"}},{"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"}},{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}]},"put":{"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"user_id":{"type":"number","description":"the updated user id"}},"required":["user_id"]},"example":{"user_id":161236}}}}},"summary":"Update a Page Assignment","operationId":"Update a Page Assignment","description":"","tags":["Page Resource"],"parameters":[{"name":"profile_id","in":"path","description":"id of the profile","required":true,"example":"self","schema":{"type":"string"}},{"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"}},{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}],"requestBody":{"content":{"application/json":{"example":{"can_collect":true,"can_view":true},"schema":{"type":"object","properties":{"can_collect":{"type":"boolean","example":true},"can_view":{"type":"boolean","example":true}}}}}}},"delete":{"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"user_id":{"type":"number","description":"the deleted user id"}},"required":["user_id"]},"example":{"user_id":161236}}}}},"summary":"Delete a Page Assignment","operationId":"Delete a Page Assignment","description":"","tags":["Page Resource"],"parameters":[{"name":"profile_id","in":"path","description":"id of the profile","required":true,"example":"self","schema":{"type":"string"}},{"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"}},{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}]}},"/profiles/{profile_id}/pages/{page_id}/assignments":{"get":{"responses":{"200":{"description":"OK","headers":{"Total-Count":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"user_id":{"type":"number"},"can_collect":{"type":"boolean"},"can_view":{"type":"boolean"}},"required":["user_id"]},"example":[{"user_id":161236},{"user_id":161239},{"user_id":161242}]}}},"404":{"description":"Not Found - `page_id` does not exist or is not a page of `profile_id`.","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error_message":"The requested resource is not found"}}}}},"summary":"Retrieve a List of Page Assignments","operationId":"Retrieve a List of Page Assignments","description":"","tags":["Page Resource"],"parameters":[{"name":"profile_id","in":"path","description":"id of the profile","required":true,"example":"self","schema":{"type":"string"}},{"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","schema":{"type":"string"}},{"name":"limit","in":"query","description":"maximum count of the page assignment list","example":"100","schema":{"type":"number"}},{"name":"offset","in":"query","description":"skip that many page assignment before beginning to return","example":"0","schema":{"type":"number"}},{"name":"validate_grammar","in":"query","description":"returns an error for incorrect field grammar when set to true","example":"false","schema":{"type":"string"}},{"name":"all_fields","in":"query","description":"will show all fields for each page assignment","example":"1","schema":{"type":"boolean"}},{"name":"exclude","in":"query","description":"will exclude specified fields","schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}]},"put":{"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"user_id":{"type":"number","description":"the updated user id"}},"required":["user_id"]},"example":[{"user_id":161239},{"user_id":161242}]}}},"404":{"description":"Not Found - `page_id` does not exist or is not a page of `profile_id`.","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error_message":"The requested resource is not found"}}}}},"summary":"Update a List of Page Assignments","operationId":"Update a List of Page Assignments","description":"","tags":["Page Resource"],"parameters":[{"name":"profile_id","in":"path","description":"id of the profile","required":true,"example":"self","schema":{"type":"string"}},{"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","schema":{"type":"string"}},{"name":"limit","in":"query","description":"maximum count of the page assignment list","example":"100","schema":{"type":"number"}},{"name":"offset","in":"query","description":"skip that many page assignment before beginning to return","example":"0","schema":{"type":"number"}},{"name":"validate_grammar","in":"query","description":"returns an error for incorrect field grammar when set to true","example":"false","schema":{"type":"string"}},{"name":"all_fields","in":"query","description":"will show all fields for each page assignment","example":"1","schema":{"type":"boolean"}},{"name":"exclude","in":"query","description":"will exclude specified fields","schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}],"requestBody":{"content":{"application/json":{"examples":{"example1":{"value":[{"user_id":161239,"can_view":false},{"user_id":161242,"can_view":false}]},"example2":{"value":{"can_view":false}}},"schema":{"type":"object","properties":{"user_id":{"type":"number","example":161236},"can_collect":{"type":"boolean","example":true},"can_view":{"type":"boolean","example":true}}}}}}},"delete":{"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"user_id":{"type":"number","description":"the deleted user id"}},"required":["user_id"]},"example":[{"user_id":161239},{"user_id":161242}]}}},"404":{"description":"Not Found - `page_id` does not exist or is not a page of `profile_id`.","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error_message":"The requested resource is not found"}}}}},"summary":"Delete a List of Page Assignments","operationId":"Delete a List of Page Assignments","description":"","tags":["Page Resource"],"parameters":[{"name":"profile_id","in":"path","description":"id of the profile","required":true,"example":"self","schema":{"type":"string"}},{"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","schema":{"type":"string"}},{"name":"limit","in":"query","description":"maximum count of the page assignment list","example":"100","schema":{"type":"number"}},{"name":"offset","in":"query","description":"skip that many page assignment before beginning to return","example":"0","schema":{"type":"number"}},{"name":"validate_grammar","in":"query","description":"returns an error for incorrect field grammar when set to true","example":"false","schema":{"type":"string"}},{"name":"all_fields","in":"query","description":"will show all fields for each page assignment","example":"1","schema":{"type":"boolean"}},{"name":"exclude","in":"query","description":"will exclude specified fields","schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}],"requestBody":{"content":{"application/json":{"example":[{"user_id":161239},{"user_id":161242}],"schema":{"type":"object","properties":{"user_id":{"type":"number","example":161239}}}}}}},"post":{"responses":{"201":{"description":"Created","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"user_id":{"type":"number","description":"the created user id"}},"required":["user_id"]},"examples":{"example1":{"value":{"user_id":161236}},"example2":{"value":[{"user_id":161239},{"user_id":161242}]}}}}},"404":{"description":"Not Found - `page_id` does not exist or is not a page of `profile_id`.","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error_message":"The requested resource is not found"}}}}},"summary":"Create New Page Assignments","operationId":"Create New Page Assignments","description":"","tags":["Page Resource"],"parameters":[{"name":"profile_id","in":"path","description":"id of the profile","required":true,"example":"self","schema":{"type":"string"}},{"name":"page_id","in":"path","description":"id of the page","required":true,"schema":{"type":"number"}},{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}],"requestBody":{"content":{"application/json":{"examples":{"example1":{"value":{"user_id":161236,"can_collect":true}},"example2":{"value":[{"user_id":161239,"can_collect":true},{"user_id":161242,"can_collect":true}]}},"schema":{"type":"object","required":["user_id"],"properties":{"user_id":{"type":"number","example":161236},"can_collect":{"type":"boolean","example":true},"can_view":{"type":"boolean","example":true}}}}}}}},"/profiles/{profile_id}/pages/{page_id}/record_assignments":{"get":{"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"number"},"user_id":{"type":"number"},"record_id":{"type":"number"},"Body":{"type":"string","description":"[\n{\n    \"id\": 270987,\n    \"user_id\": 38265920,\n    \"record_id\": 3662\n},\n{\n    \"id\": 270990,\n    \"user_id\": 38265867,\n    \"record_id\": 3656\n},\n]"}},"required":["id","user_id","record_id"]},"example":{"id":790777,"user_id":456,"record_id":123,"Body":""}}}},"404":{"description":"Not Found - `page_id` does not exist or is not a page of `profile_id`.","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error_message":"The requested resource is not found"}}}}},"summary":"Retrieve Page Record Assignments","operationId":"Retrieve Page Record Assignments","description":"","tags":["Page Resource"],"parameters":[{"name":"profile_id","in":"path","description":"id of the profile","required":true,"example":"self","schema":{"type":"string"}},{"name":"page_id","in":"path","description":"id of the page","required":true,"schema":{"type":"number"}},{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}]},"delete":{"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"number"},"Body":{"type":"string","description":"[\n{\n    \"id\": 270987\n}\n{\n    \"id\": 270990\n]"}},"required":["id"]},"example":{"id":790777,"Body":""}}}},"404":{"description":"Not Found - `page_id` does not exist or is not a page of `profile_id`.","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error_message":"The requested resource is not found"}}}}},"summary":"Delete Page Record Assignments","operationId":"Delete Page Record Assignments","description":"","tags":["Page Resource"],"parameters":[{"name":"profile_id","in":"path","description":"id of the profile","required":true,"example":"self","schema":{"type":"string"}},{"name":"page_id","in":"path","description":"id of the page","required":true,"schema":{"type":"number"}},{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}],"requestBody":{"content":{"application/json":{"example":[{"id":270987},{"id":270990}],"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"number"}},"required":["id"]}}}}}}},"/profiles/{profile_id}/pages/{page_id}/http_callbacks/{http_callback_id}":{"get":{"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"},"url":{"type":"string"},"feed_format":{"type":"string","description":"must match \"json\" or \"xml\""},"feed_format_version":{"type":"string","description":"Must specifiy in URL parameter to retrieve"},"trigger_post_email":{"type":"string","description":"Must specifiy in URL parameter to retrieve"},"content_type: `header` (string, required) - must match \"header\" or \"key_value_pair\"":{"type":"string"},"key_value_pair_key (string, required) - required if content_type is \"key_value_pair\"":{"type":"string"},"error_email":{"type":"string"},"notification_email":{"type":"string"},"is_guaranteed_delivery":{"type":"boolean"},"mode":{"type":"number"},"secure_type":{"type":"string"},"secure_key":{"type":"string"},"is_disabled":{"type":"boolean"}},"required":["id","name","url","feed_format","error_email","notification_email","is_guaranteed_delivery","mode","secure_type","secure_key","is_disabled"]},"example":{"id":283,"name":"New Record Endpoint","url":"https://www.iformbuilder.com/post_http_endpoint.php","feed_format":"json","content_type":"header","key_value_pair_key":"","error_email":"support@iformbuilder.com","notification_email":"support@iformbuilder.com","is_guaranteed_delivery":true,"mode":0,"secure_type":"RS512","secure_key":"-----BEGIN RSA PRIVATE KEY-----\n\u003cbase64 key material\u003e\n-----END RSA PRIVATE KEY-----"}}}}},"summary":"Retrieve a Page HTTP Callback","operationId":"Retrieve a Page HTTP Callback","description":"","tags":["Page Resource"],"parameters":[{"name":"profile_id","in":"path","description":"id of the profile","required":true,"example":"self","schema":{"type":"string"}},{"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"}},{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}]},"put":{"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"number","description":"the updated page http callback id"}},"required":["id"]},"example":{"id":283}}}}},"summary":"Update a Page HTTP Callback","operationId":"Update a Page HTTP Callback","description":"","tags":["Page Resource"],"parameters":[{"name":"profile_id","in":"path","description":"id of the profile","required":true,"example":"self","schema":{"type":"string"}},{"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"}},{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}],"requestBody":{"content":{"application/json":{"example":{"error_email":"support@iformbuilder.com","notification_email":"support@iformbuilder.com"},"schema":{"type":"object","required":["mode","secure_key"],"properties":{"name":{"type":"string","example":"New Record Endpoint"},"url":{"type":"string","example":"https://www.iformbuilder.com/post_http_endpoint.php"},"feed_format":{"type":"string","example":"json","description":"must match \"json\" or \"xml\""},"feed_format_version":{"type":"number","example":10,"description":"must be 9 or 10."},"trigger_post_email":{"type":"string","example":"support@iformbuilder.com"},"content_type: `header` (string, optional) - must match \"header\" or \"key_value_pair\"":{"type":"string"},"key_value_pair_key (string, optional) - reuqired if content_type is \"key_value_pair\"":{"type":"string"},"error_email":{"type":"string","example":"support@iformbuilder.com","description":"must be valid email"},"notification_email":{"type":"string","example":"support@iformbuilder.com","description":"must be valid email"},"is_guaranteed_delivery":{"type":"boolean","example":true},"mode":{"type":"string","example":"'delete'"},"secure_type":{"type":"string","example":"RS512"},"is_disabled":{"type":"boolean"},"secure_key":{"type":"string","example":"-----BEGIN RSA PRIVATE KEY-----\\n\u003cbase64 key material\u003e\\n-----END RSA PRIVATE KEY-----"}}}}}}},"delete":{"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"number","description":"the deleted page http callback id"}},"required":["id"]},"example":{"id":283}}}}},"summary":"Delete a Page HTTP Callback","operationId":"Delete a Page HTTP Callback","description":"","tags":["Page Resource"],"parameters":[{"name":"profile_id","in":"path","description":"id of the profile","required":true,"example":"self","schema":{"type":"string"}},{"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"}},{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}]}},"/profiles/{profile_id}/pages/{page_id}/http_callbacks":{"get":{"responses":{"200":{"description":"OK","headers":{"Total-Count":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"},"url":{"type":"string"},"feed_format":{"type":"string","description":"must match \"json\" or \"xml\""},"feed_format_version":{"type":"string","description":"Must specifiy in URL parameter to retrieve"},"content_type: `header` (string, optional) - must match \"header\" or \"key_value_pair\"":{"type":"string"},"key_value_pair_key (string, optional) - reuqired if content_type is \"key_value_pair\"":{"type":"string"},"error_email":{"type":"string"},"notification_email":{"type":"string"},"is_guaranteed_delivery":{"type":"boolean"},"mode":{"type":"string"},"secure_type":{"type":"string"},"is_disabled":{"type":"boolean"},"trigger_post_email":{"type":"string","description":"Must specifiy in URL parameter to retrieve"},"secure_key":{"type":"string"}},"required":["id","name","secure_key"]},"example":[{"id":283,"name":"New Record Endpoint"},{"id":286,"name":"Zapier Endpoint"}]}}},"404":{"description":"Not Found - `page_id` does not exist or is not a page of `profile_id`.","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error_message":"The requested resource is not found"}}}}},"summary":"Retrieve a List of Page HTTP Callbacks","operationId":"Retrieve a List of Page HTTP Callbacks","description":"","tags":["Page Resource"],"parameters":[{"name":"profile_id","in":"path","description":"id of the profile","required":true,"example":"self","schema":{"type":"string"}},{"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","schema":{"type":"string"}},{"name":"limit","in":"query","description":"maximum count of the option localization list","example":"100","schema":{"type":"number"}},{"name":"offset","in":"query","description":"skip that many option localization before beginning to return","example":"0","schema":{"type":"number"}},{"name":"validate_grammar","in":"query","description":"returns an error for incorrect field grammar when set to true","example":"false","schema":{"type":"string"}},{"name":"all_fields","in":"query","description":"will show all fields for each option localization","example":"1","schema":{"type":"boolean"}},{"name":"exclude","in":"query","description":"will exclude specified fields","schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}]},"delete":{"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"number","description":"the deleted page http callback id"}},"required":["id"]},"example":[{"id":283},{"id":286}]}}},"207":{"description":"Multi-Status - some items succeeded and some failed. The body is an array in request order (a list request body, even with one item, always answers a list); a failed item carries `error_message` instead of `id` and was not written. An item whose row does not exist answers `The requested resource is not found`.","headers":{},"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","description":"present when the item succeeded"},"error_message":{"type":"string","description":"present when the item failed"}}}},"example":[{"id":1},{"error_message":"The requested resource is not found"}]}}},"400":{"description":"Bad Request - every item of a list request body failed. The body has the same shape as `207`, with `error_message` on each item; nothing was written. A single-object request body that fails answers the standard error object instead.","headers":{},"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/ApiError"},{"type":"array","items":{"type":"object","properties":{"error_message":{"type":"string"}},"required":["error_message"]}}]},"examples":{"all_failed":{"summary":"Every item of a list body failed","value":[{"error_message":"The requested resource is not found"}]},"single_object":{"summary":"A single-object body failed","value":{"error_message":"The requested resource is not found"}}}}}},"404":{"description":"Not Found - `page_id` does not exist or is not a page of `profile_id`.","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error_message":"The requested resource is not found"}}}}},"summary":"Delete a List of Page HTTP Callbacks","operationId":"Delete a List of Page HTTP Callbacks","description":"","tags":["Page Resource"],"parameters":[{"name":"profile_id","in":"path","description":"id of the profile","required":true,"example":"self","schema":{"type":"string"}},{"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","schema":{"type":"string"}},{"name":"limit","in":"query","description":"maximum count of the option localization list","example":"100","schema":{"type":"number"}},{"name":"offset","in":"query","description":"skip that many option localization before beginning to return","example":"0","schema":{"type":"number"}},{"name":"validate_grammar","in":"query","description":"returns an error for incorrect field grammar when set to true","example":"false","schema":{"type":"string"}},{"name":"all_fields","in":"query","description":"will show all fields for each option localization","example":"1","schema":{"type":"boolean"}},{"name":"exclude","in":"query","description":"will exclude specified fields","schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}],"requestBody":{"content":{"application/json":{"example":[{"id":283},{"id":286}],"schema":{"type":"object","properties":{"id":{"type":"number","example":283}}}}}}},"post":{"responses":{"201":{"description":"Created","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"number","description":"the created page http callback id"}},"required":["id"]},"example":{"id":283}}}},"404":{"description":"Not Found - `page_id` does not exist or is not a page of `profile_id`.","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error_message":"The requested resource is not found"}}}}},"summary":"Create New Page HTTP Callbacks","operationId":"Create New Page HTTP Callbacks","description":"","tags":["Page Resource"],"parameters":[{"name":"profile_id","in":"path","description":"id of the profile","required":true,"example":"self","schema":{"type":"string"}},{"name":"page_id","in":"path","description":"id of the page","required":true,"schema":{"type":"number"}},{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}],"requestBody":{"content":{"application/json":{"example":{"name":"New Record Endpoint","url":"https://www.iformbuilder.com/post_http_endpoint.php","feed_format":"json","content_type":"header","is_guaranteed_delivery":true},"schema":{"type":"object","required":["name","url","feed_format"],"properties":{"name":{"type":"string","example":"New Record Endpoint"},"url":{"type":"string","example":"https://www.iformbuilder.com/post_http_endpoint.php"},"feed_format":{"type":"string","example":"json","description":"must match \"json\" or \"xml\""},"feed_format_version":{"type":"number","example":10,"description":"must be 9 or 10."},"content_type: `header` (string, required) - must match \"header\" or \"key_value_pair\"":{"type":"string"},"key_value_pair_key (string, optional) - reuqired if content_type is \"key_value_pair\"":{"type":"string"},"error_email":{"type":"string","example":"support@iformbuilder.com","description":"must be valid email"},"notification_email":{"type":"string","example":"support@iformbuilder.com","description":"must be valid email"},"is_guaranteed_delivery":{"type":"boolean","example":true},"mode":{"type":"string","example":"'delete'"},"secure_type":{"type":"string","example":"RS512"},"is_disabled":{"type":"boolean"},"trigger_post_email `support@iformbuilder.com`":{"type":"string"},"secure_key":{"type":"string","example":"-----BEGIN RSA PRIVATE KEY-----\\n\u003cbase64 key material\u003e\\n-----END RSA PRIVATE KEY-----"}}}}}}}},"/profiles/{profile_id}/pages/{page_id}/email_alerts":{"get":{"responses":{"200":{"description":"OK","headers":{"Total-Count":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"email":{"type":"string"}},"required":["email"]},"example":[{"email":"inspector_1@iformbuilder.com"},{"email":"inspector_2@iformbuilder.com"},{"email":"support@iformbuilder.com"}]}}},"400":{"description":"Bad Request - `limit` or `offset` is not an integer.","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error_message":"'limit' must be an integer"}}}},"404":{"description":"Not Found - `page_id` does not exist or is not a page of `profile_id`.","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error_message":"The requested resource is not found"}}}}},"summary":"Retrieve a List of Page Email Alerts","operationId":"Retrieve a List of Page Email Alerts","description":"","tags":["Page Resource"],"parameters":[{"name":"profile_id","in":"path","description":"id of the profile","required":true,"example":"self","schema":{"type":"string"}},{"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","schema":{"type":"string"}},{"name":"limit","in":"query","description":"maximum count of the page assignment list","example":"100","schema":{"type":"number"}},{"name":"offset","in":"query","description":"skip that many page assignment before beginning to return","example":"0","schema":{"type":"number"}},{"name":"validate_grammar","in":"query","description":"returns an error for incorrect field grammar when set to true","example":"false","schema":{"type":"string"}},{"name":"all_fields","in":"query","description":"will show all fields for each page assignment","example":"1","schema":{"type":"boolean"}},{"name":"exclude","in":"query","description":"will exclude specified fields","schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}]},"delete":{"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"email":{"type":"string","description":"the deleted email alert"}},"required":["email"]},"example":[{"email":"inspector_1@iformbuilder.com"},{"email":"inspector_2@iformbuilder.com"}]}}},"207":{"description":"Multi-Status - some items succeeded and some failed. The body is an array in request order (a list request body, even with one item, always answers a list); a failed item carries `error_message` instead of `email` and was not written. An item whose row does not exist answers `The requested resource is not found`.","headers":{},"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"email":{"type":"string","description":"present when the item succeeded"},"error_message":{"type":"string","description":"present when the item failed"}}}},"example":[{"email":"support@iformbuilder.com"},{"error_message":"The requested resource is not found"}]}}},"400":{"description":"Bad Request - every item of a list request body failed. The body has the same shape as `207`, with `error_message` on each item; nothing was written. A single-object request body that fails answers the standard error object instead.","headers":{},"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/ApiError"},{"type":"array","items":{"type":"object","properties":{"error_message":{"type":"string"}},"required":["error_message"]}}]},"examples":{"all_failed":{"summary":"Every item of a list body failed","value":[{"error_message":"The requested resource is not found"}]},"single_object":{"summary":"A single-object body failed","value":{"error_message":"The requested resource is not found"}}}}}},"404":{"description":"Not Found - `page_id` does not exist or is not a page of `profile_id`.","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error_message":"The requested resource is not found"}}}}},"summary":"Delete a List of Page Email Alerts","operationId":"Delete a List of Page Email Alerts","description":"","tags":["Page Resource"],"parameters":[{"name":"profile_id","in":"path","description":"id of the profile","required":true,"example":"self","schema":{"type":"string"}},{"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","schema":{"type":"string"}},{"name":"limit","in":"query","description":"maximum count of the page assignment list","example":"100","schema":{"type":"number"}},{"name":"offset","in":"query","description":"skip that many page assignment before beginning to return","example":"0","schema":{"type":"number"}},{"name":"validate_grammar","in":"query","description":"returns an error for incorrect field grammar when set to true","example":"false","schema":{"type":"string"}},{"name":"all_fields","in":"query","description":"will show all fields for each page assignment","example":"1","schema":{"type":"boolean"}},{"name":"exclude","in":"query","description":"will exclude specified fields","schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}],"requestBody":{"content":{"application/json":{"example":[{"email":"inspector_1@iformbuilder.com"},{"email":"inspector_2@iformbuilder.com"}],"schema":{"type":"object","required":["email"],"properties":{"email":{"type":"string","example":"support@iformbuilder.com"}}}}}}},"post":{"responses":{"201":{"description":"Created","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"email":{"type":"string","description":"the created email alert"}},"required":["email"]},"examples":{"example1":{"value":{"email":"support@iformbuilder.com"}},"example2":{"value":[{"email":"inspector_1@iformbuilder.com"},{"email":"inspector_2@iformbuilder.com"}]}}}}},"404":{"description":"Not Found - `page_id` does not exist or is not a page of `profile_id`.","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error_message":"The requested resource is not found"}}}}},"summary":"Create New Page Email Alerts","operationId":"Create New Page Email Alerts","description":"","tags":["Page Resource"],"parameters":[{"name":"profile_id","in":"path","description":"id of the profile","required":true,"example":"self","schema":{"type":"string"}},{"name":"page_id","in":"path","description":"id of the page","required":true,"schema":{"type":"number"}},{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}],"requestBody":{"content":{"application/json":{"examples":{"example1":{"value":{"email":"support@iformbuilder.com"}},"example2":{"value":[{"email":"inspector_1@iformbuilder.com"},{"email":"inspector_2@iformbuilder.com"}]}},"schema":{"type":"object","required":["email"],"properties":{"email":{"type":"string","example":"support@iformbuilder.com"}}}}}}}},"/profiles/{profile_id}/pages/{page_id}/email_alerts/settings":{"get":{"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageEmailAlertSettings"},"example":{"cc":["supervisor@iformbuilder.com"],"bcc":[],"subject_element":"site_name"}}}},"401":{"description":"Unauthorized - missing or invalid bearer token.","headers":{},"content":{}},"403":{"description":"Forbidden - the user cannot assign the page.","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Not Found - `page_id` does not exist, is not a page of `profile_id`, or is a form shared from another profile.","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error_message":"The requested resource is not found"}}}}},"summary":"Retrieve Page Email Alert Settings","operationId":"Retrieve Page Email Alert Settings","description":"Returns the CC list, the BCC list and the subject element of the page's email alert. The To list is `GET /profiles/{profile_id}/pages/{page_id}/email_alerts`.\n\n`subject_element` is the name of the element whose value becomes the subject of each alert. It is `null` when none is set. The subject is then the server's configured alert subject followed by the form label, or `New Record - \u003cform label\u003e` when the server has none.\n\n### Authorization\n\nThe same as the To list: the user must be able to assign the page.","tags":["Page Resource"],"parameters":[{"name":"profile_id","in":"path","description":"id of the profile","required":true,"example":"self","schema":{"type":"string"}},{"name":"page_id","in":"path","description":"id of the page","required":true,"schema":{"type":"number"}},{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}]},"put":{"responses":{"200":{"description":"OK - the settings were saved. The body is the updated settings, in the same shape as `GET`.","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageEmailAlertSettings"},"example":{"cc":["supervisor@iformbuilder.com"],"bcc":["audit@iformbuilder.com"],"subject_element":null}}}},"400":{"description":"Bad Request - the body is not a JSON object, `cc` or `bcc` is not a list of valid email addresses or is longer than 1000 characters once joined with `, `, or `subject_element` does not name an element of the page that can be a subject. Nothing was written.","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error_message":"cc must be a list of email addresses"}}}},"401":{"description":"Unauthorized - missing or invalid bearer token.","headers":{},"content":{}},"403":{"description":"Forbidden - the user cannot assign the page.","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Not Found - `page_id` does not exist, is not a page of `profile_id`, or is a form shared from another profile.","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error_message":"The requested resource is not found"}}}}},"summary":"Update Page Email Alert Settings","operationId":"Update Page Email Alert Settings","description":"Replaces the CC list, the BCC list or the subject element of the page's email alert. Only the fields in the body are written, and each one replaces its stored value as a whole. An empty list clears `cc` or `bcc`. `null` or an empty string clears `subject_element`.\n\nDuplicate addresses are stored once. `subject_element` must name an element of the page with a data type of 1 (Text), 7 (Select), 8 (Pick List), 9 (Multi Select), 19 (Text Area) or 25 (Unique ID). It is stored as the element's own name, whatever the letter case sent.\n\n### Authorization\n\nSame as `GET /profiles/{profile_id}/pages/{page_id}/email_alerts/settings`.","tags":["Page Resource"],"parameters":[{"name":"profile_id","in":"path","description":"id of the profile","required":true,"example":"self","schema":{"type":"string"}},{"name":"page_id","in":"path","description":"id of the page","required":true,"schema":{"type":"number"}},{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}],"requestBody":{"content":{"application/json":{"example":{"cc":["supervisor@iformbuilder.com"],"bcc":["audit@iformbuilder.com"],"subject_element":null},"schema":{"type":"object","properties":{"cc":{"type":"array","items":{"type":"string"},"description":"the full CC list"},"bcc":{"type":"array","items":{"type":"string"},"description":"the full BCC list"},"subject_element":{"type":"string","nullable":true,"description":"name of the element whose value is the subject"}}}}}}}},"/profiles/{profile_id}/pages/{page_id}/trigger_posts":{"post":{"responses":{"202":{"description":"Accepted","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"number","description":"causes post trigger"}},"required":["id"]},"example":[{"id":78},{"id":81}]}}},"207":{"description":"Multi-Status","headers":{},"content":{}}},"summary":"Triggers POST Action","operationId":"Triggers POST Action","description":"","tags":["Page Resource"],"parameters":[{"name":"profile_id","in":"path","description":"id of the profile","required":true,"example":"self","schema":{"type":"string"}},{"name":"page_id","in":"path","description":"id of the page","required":true,"schema":{"type":"number"}},{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}],"requestBody":{"content":{"application/json":{"example":[{"id":78},{"id":81}],"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"number","example":91}}}}}}}},"/profiles/{profile_id}/pages/{page_id}/shared_page":{"get":{"responses":{"200":{"description":"OK","headers":{"Total-Count":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"number"},"profile_id":{"type":"string"},"allow_copy":{"type":"boolean"}},"required":["id","profile_id","allow_copy"]},"example":[{"id":86,"profile_id":161675,"allow_copy":false},{"id":89,"profile_id":161666,"allow_copy":true}]}}},"404":{"description":"Not Found - `page_id` does not exist or is not a page of `profile_id`.","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error_message":"The requested resource is not found"}}}}},"summary":"Retrieve a List of a Shared Page Entries","operationId":"Retrieve a List of a Shared Page Entries","description":"","tags":["Page Resource"],"parameters":[{"name":"profile_id","in":"path","description":"id of the profile","required":true,"example":"self","schema":{"type":"string"}},{"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","schema":{"type":"string"}},{"name":"limit","in":"query","description":"maximum count of the page assignment list","example":"100","schema":{"type":"number"}},{"name":"offset","in":"query","description":"skip that many page assignment before beginning to return","example":"0","schema":{"type":"number"}},{"name":"validate_grammar","in":"query","description":"returns an error for incorrect field grammar when set to true","example":"false","schema":{"type":"string"}},{"name":"all_fields","in":"query","description":"will show all fields for each page assignment","example":"1","schema":{"type":"boolean"}},{"name":"exclude","in":"query","description":"will exclude specified fields","schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}]},"put":{"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"number","description":"id of deleted shared page entry"}},"required":["id"]},"example":[{"id":86},{"id":89}]}}},"404":{"description":"Not Found - `page_id` does not exist or is not a page of `profile_id`.","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error_message":"The requested resource is not found"}}}}},"summary":"Update a Shared Page Entry","operationId":"Update a Shared Page Entry","description":"","tags":["Page Resource"],"parameters":[{"name":"profile_id","in":"path","description":"id of the profile","required":true,"example":"self","schema":{"type":"string"}},{"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","schema":{"type":"string"}},{"name":"limit","in":"query","description":"maximum count of the page assignment list","example":"100","schema":{"type":"number"}},{"name":"offset","in":"query","description":"skip that many page assignment before beginning to return","example":"0","schema":{"type":"number"}},{"name":"validate_grammar","in":"query","description":"returns an error for incorrect field grammar when set to true","example":"false","schema":{"type":"string"}},{"name":"all_fields","in":"query","description":"will show all fields for each page assignment","example":"1","schema":{"type":"boolean"}},{"name":"exclude","in":"query","description":"will exclude specified fields","schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}],"requestBody":{"content":{"application/json":{"example":[{"id":86,"allow_copy":true},{"id":89,"allow_copy":false}],"schema":{"type":"object","properties":{}}}}}},"delete":{"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"number","description":"id of deleted shared page entry"}},"required":["id"]},"example":[{"id":86},{"id":89}]}}},"404":{"description":"Not Found - `page_id` does not exist or is not a page of `profile_id`.","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error_message":"The requested resource is not found"}}}}},"summary":"Delete a Shared Page Entry","operationId":"Delete a Shared Page Entry","description":"","tags":["Page Resource"],"parameters":[{"name":"profile_id","in":"path","description":"id of the profile","required":true,"example":"self","schema":{"type":"string"}},{"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","schema":{"type":"string"}},{"name":"limit","in":"query","description":"maximum count of the page assignment list","example":"100","schema":{"type":"number"}},{"name":"offset","in":"query","description":"skip that many page assignment before beginning to return","example":"0","schema":{"type":"number"}},{"name":"validate_grammar","in":"query","description":"returns an error for incorrect field grammar when set to true","example":"false","schema":{"type":"string"}},{"name":"all_fields","in":"query","description":"will show all fields for each page assignment","example":"1","schema":{"type":"boolean"}},{"name":"exclude","in":"query","description":"will exclude specified fields","schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}],"requestBody":{"content":{"application/json":{"example":[{"id":86},{"id":89}],"schema":{"type":"object","properties":{}}}}}},"post":{"responses":{"201":{"description":"Created","headers":{},"content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"id":{"type":"number","description":"the id of shared page entry"}},"required":["id"]},{"type":"object","properties":{"id":{"type":"number","description":"ids of shared page entries"}},"required":["id"]}]},"examples":{"example1":{"value":{"id":86}},"example2":{"value":[{"id":"86"},{"id":"89"}]}}}}},"404":{"description":"Not Found - `page_id` does not exist or is not a page of `profile_id`.","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error_message":"The requested resource is not found"}}}}},"summary":"Create New Share Page","operationId":"Create New Share Page","description":"","tags":["Page Resource"],"parameters":[{"name":"profile_id","in":"path","description":"id of the profile","required":true,"example":"self","schema":{"type":"string"}},{"name":"page_id","in":"path","description":"id of the page","required":true,"schema":{"type":"number"}},{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}],"requestBody":{"content":{"application/json":{"examples":{"example1":{"value":[{"profile_id":161675,"allow_copy":true}]},"example2":{"value":[{"profile_id":161675,"allow_copy":true},{"profile_id":161675,"allow_copy":true}]}},"schema":{"type":"object","required":["profile_id","allow_copy"],"properties":{"profile_id":{"type":"number","example":161675},"allow_copy":{"type":"boolean","example":true}}}}}}}},"/profiles/{profile_id}/pages/{page_id}/dynamic_attributes/{dynamic_attribute}":{"get":{"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"dynamic_attribute: `map_priority`":{"type":"string"},"value":{"type":"string","description":"this value type can change based on dynamic attribute"},"type":{"type":"string","description":"will display what type the value has to be, for example string or number"},"last_modified_date":{"type":"string","description":"04-02T02:07:29+00:00\" - Last time this attribute was modified"}},"required":["dynamic_attribute: `map_priority`","value","type"]}}}}},"summary":"Retrieve a Page Dynamic Attribute","operationId":"Retrieve a Page Dynamic Attribute","description":"","tags":["Page Resource"],"parameters":[{"name":"profile_id","in":"path","description":"id of the profile","required":true,"example":"self","schema":{"type":"string"}},{"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"}},{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}]},"put":{"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"attribute_name: `map_priority`":{"type":"string","description":"the updated dynamic attribute"}},"required":["attribute_name: `map_priority`"]},"example":{"dynamic_attribute":"map_priority"}}}}},"summary":"Update an Page Dynamic Attribute","operationId":"Update an Page Dynamic Attribute","description":"","tags":["Page Resource"],"parameters":[{"name":"profile_id","in":"path","description":"id of the profile","required":true,"example":"self","schema":{"type":"string"}},{"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"}},{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}],"requestBody":{"content":{"application/json":{"example":{"value":"my_element2"},"schema":{"type":"object","properties":{"value":{"type":"string","example":"my_element2"}}}}}}},"delete":{"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"attribute_name: `map_priority`":{"type":"string","description":"the deleted dynamic_attribute"}},"required":["attribute_name: `map_priority`"]},"example":{"attribute_name":"map_priority"}}}}},"summary":"Delete an Page Attribute","operationId":"Delete an Page Attribute","description":"","tags":["Page Resource"],"parameters":[{"name":"profile_id","in":"path","description":"id of the profile","required":true,"example":"self","schema":{"type":"string"}},{"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"}},{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}]}},"/profiles/{profile_id}/pages/{page_id}/dynamic_attributes":{"get":{"responses":{"200":{"description":"OK","headers":{"Total-Count":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"attribute_name: `12_24_hour_time`":{"type":"string"},"value":{"type":"string","description":"returned value type can differ based on dynamic attribute"}},"required":["attribute_name: `12_24_hour_time`","value"]},"example":[{"attribute_name":"map_priority","value":"my_element"},{"attribute_name":"map_disable_top_location","value":true}]}}},"404":{"description":"Not Found - `page_id` does not exist or is not a page of `profile_id`.","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error_message":"The requested resource is not found"}}}}},"summary":"Retrieve a List of Page Dynamic Attributes","operationId":"Retrieve a List of Page Dynamic Attributes","description":"","tags":["Page Resource"],"parameters":[{"name":"profile_id","in":"path","description":"id of the profile","required":true,"example":"self","schema":{"type":"string"}},{"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","schema":{"type":"string"}},{"name":"limit","in":"query","description":"maximum count of the page dynamic attribute list","example":"100","schema":{"type":"number"}},{"name":"offset","in":"query","description":"skip that many page dynamic attribute before beginning to return","example":"0","schema":{"type":"number"}},{"name":"validate_grammar","in":"query","description":"returns an error for incorrect field grammar when set to true","example":"false","schema":{"type":"string"}},{"name":"all_fields","in":"query","description":"will show all fields for each page dynamic attribute","example":"1","schema":{"type":"boolean"}},{"name":"exclude","in":"query","description":"will exclude specified fields","schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}]},"put":{"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"language_code":{"type":"string","description":"the updated language code"}},"required":["language_code"]},"example":[{"attribute_name":"map_priority"},{"attribute_name":"map_disable_top_location"}]}}},"404":{"description":"Not Found - `page_id` does not exist or is not a page of `profile_id`.","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error_message":"The requested resource is not found"}}}}},"summary":"Update a List of Page Dynamic Attributes","operationId":"Update a List of Page Dynamic Attributes","description":"","tags":["Page Resource"],"parameters":[{"name":"profile_id","in":"path","description":"id of the profile","required":true,"example":"self","schema":{"type":"string"}},{"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","schema":{"type":"string"}},{"name":"limit","in":"query","description":"maximum count of the page dynamic attribute list","example":"100","schema":{"type":"number"}},{"name":"offset","in":"query","description":"skip that many page dynamic attribute before beginning to return","example":"0","schema":{"type":"number"}},{"name":"validate_grammar","in":"query","description":"returns an error for incorrect field grammar when set to true","example":"false","schema":{"type":"string"}},{"name":"all_fields","in":"query","description":"will show all fields for each page dynamic attribute","example":"1","schema":{"type":"boolean"}},{"name":"exclude","in":"query","description":"will exclude specified fields","schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}],"requestBody":{"content":{"application/json":{"example":[{"attribute_name":"map_priority","value":"my_element2"},{"attribute_name":"map_disable_top_location","value":false}],"schema":{"type":"object","required":["attribute_name: `map_priority`","value"],"properties":{"attribute_name: `map_priority`":{"type":"string"},"value":{"type":"string","example":"my_element2","description":"- value validation (ie. string or boolean) could change based on specific page dynamic attribute."}}}}}}},"delete":{"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"language_code":{"type":"string","description":"the deleted language code"}},"required":["language_code"]},"example":[{"attribute_name":"time_settting"},{"attribute_name":"map_disable_top_location"}]}}},"207":{"description":"Multi-Status - some items succeeded and some failed. The body is an array in request order (a list request body, even with one item, always answers a list); a failed item carries `error_message` instead of `attribute_name` and was not written. An item whose row does not exist answers `The requested resource is not found`.","headers":{},"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"attribute_name":{"type":"string","description":"present when the item succeeded"},"error_message":{"type":"string","description":"present when the item failed"}}}},"example":[{"attribute_name":"map_priority"},{"error_message":"The requested resource is not found"}]}}},"400":{"description":"Bad Request - every item of a list request body failed. The body has the same shape as `207`, with `error_message` on each item; nothing was written. A single-object request body that fails answers the standard error object instead.","headers":{},"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/ApiError"},{"type":"array","items":{"type":"object","properties":{"error_message":{"type":"string"}},"required":["error_message"]}}]},"examples":{"all_failed":{"summary":"Every item of a list body failed","value":[{"error_message":"The requested resource is not found"}]},"single_object":{"summary":"A single-object body failed","value":{"error_message":"The requested resource is not found"}}}}}},"404":{"description":"Not Found - `page_id` does not exist or is not a page of `profile_id`.","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error_message":"The requested resource is not found"}}}}},"summary":"Delete a List of Page Dynamic Attributes","operationId":"Delete a List of Page Dynamic Attributes","description":"","tags":["Page Resource"],"parameters":[{"name":"profile_id","in":"path","description":"id of the profile","required":true,"example":"self","schema":{"type":"string"}},{"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","schema":{"type":"string"}},{"name":"limit","in":"query","description":"maximum count of the page dynamic attribute list","example":"100","schema":{"type":"number"}},{"name":"offset","in":"query","description":"skip that many page dynamic attribute before beginning to return","example":"0","schema":{"type":"number"}},{"name":"validate_grammar","in":"query","description":"returns an error for incorrect field grammar when set to true","example":"false","schema":{"type":"string"}},{"name":"all_fields","in":"query","description":"will show all fields for each page dynamic attribute","example":"1","schema":{"type":"boolean"}},{"name":"exclude","in":"query","description":"will exclude specified fields","schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}],"requestBody":{"content":{"application/json":{"example":[{"attribute_name":"time_settting"},{"attribute_name":"map_disable_top_location"}],"schema":{"type":"object","required":["attribute_name"],"properties":{"attribute_name":{"type":"string","example":"``"}}}}}}},"post":{"responses":{"201":{"description":"Created","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"attribute_name: `map_priority`":{"type":"string","description":"created page dynamic attribute"}},"required":["attribute_name: `map_priority`"]},"examples":{"example1":{"value":{"attribute_name":"map_priority"}},"example2":{"value":[{"attribute_name":"map_priority"},{"attribute_name":"map_disable_top_location"}]}}}}},"404":{"description":"Not Found - `page_id` does not exist or is not a page of `profile_id`.","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error_message":"The requested resource is not found"}}}}},"summary":"Create New Page Attribute","operationId":"Create New Page Attribute","description":"\u003ch2\u003eList of Valid Page Dynamic Attributes\u003c/h2\u003e\n\n\u003cli\u003eTo find out what elements have dynamic attributes and what values are accepted, take a look \u003ca href=\"https://zerion.my.site.com/helpcenter/s/article/WhatareDynamicAttributes66b5c2e6410ec#page\" target=\"_blank\" rel=\"noopener\"\u003ehere\u003c/a\u003e.\u003c/li\u003e","tags":["Page Resource"],"parameters":[{"name":"profile_id","in":"path","description":"id of the profile","required":true,"example":"self","schema":{"type":"string"}},{"name":"page_id","in":"path","description":"id of the page","required":true,"schema":{"type":"number"}},{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}],"requestBody":{"content":{"application/json":{"examples":{"example1":{"value":{"attribute_name":"map_priority","value":"my_element"}},"example2":{"value":[{"attribute_name":"map_priority","value":"my_element"},{"attribute_name":"map_disable_top_location","value":true}]}},"schema":{"type":"object","required":["attribute_name: `map_priority`","value"],"properties":{"attribute_name: `map_priority`":{"type":"string"},"value":{"type":"string","example":"my_element","description":"value validation (ie. string or boolean) could change based on specific page dynamic attribute."}}}}}}}},"/profiles/{profile_id}/pages/{page_id}/update_charset":{"put":{"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"page_id":{"type":"number","description":"the updated page id"}},"required":["page_id"]},"example":{"page_id":12345}}}}},"summary":"Update Charset","operationId":"Update Charset","description":"","tags":["Page Resource"],"parameters":[{"name":"profile_id","in":"path","description":"id of the profile","required":true,"example":"self","schema":{"type":"string"}},{"name":"page_id","in":"path","description":"id of the page","required":true,"schema":{"type":"number"}},{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}],"requestBody":{"content":{"application/json":{"example":{},"schema":{"type":"object","properties":{}}}}}}},"/profiles/{profile_id}/pages/{page_id}/index":{"post":{"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"element_name: `field_123`":{"type":"string"}},"required":["element_name: `field_123`"]},"example":[{"element_name":"field_123"},{"element_name":"field_456"}]}}}},"summary":"Create a New Field Index","operationId":"Create a New Field Index","description":"","tags":["Page Resource"],"parameters":[{"name":"profile_id","in":"path","description":"id of the profile","required":true,"example":"self","schema":{"type":"string"}},{"name":"page_id","in":"path","description":"id of the page","required":true,"schema":{"type":"number"}},{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}],"requestBody":{"content":{"application/json":{"example":[{"element_name":"field_123","type":"fulltext"},{"element_name":"field_456","type":"key"}],"schema":{"type":"object","required":["element_name: `field_123`","type"],"properties":{"element_name: `field_123`":{"type":"string"},"type":{"type":"string","example":"key or fulltext"}}}}}}},"get":{"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"element_name: `field_123`":{"type":"string"}},"required":["element_name: `field_123`"]},"example":[{"element_name":"field_123","type":"FULLTEXT"},{"element_name":"field_456","type":"KEY"}]}}}},"summary":"Retrieve a Field Index","operationId":"Retrieve a Field Index","description":"","tags":["Page Resource"],"parameters":[{"name":"profile_id","in":"path","description":"id of the profile","required":true,"example":"self","schema":{"type":"string"}},{"name":"page_id","in":"path","description":"id of the page","required":true,"schema":{"type":"number"}},{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}],"requestBody":{"content":{"application/json":{"example":{"element_name: `field_123`":"","type":"key or fulltext"},"schema":{"type":"object","required":["element_name: `field_123`","type"],"properties":{"element_name: `field_123`":{"type":"string"},"type":{"type":"string","example":"key or fulltext"}}}}}}},"delete":{"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"element_name: `field_123`":{"type":"string"}},"required":["element_name: `field_123`"]},"example":[{"element_name":"field_123"},{"element_name":"field_456"}]}}}},"summary":"Delete a Field Index","operationId":"Delete a Field Index","description":"","tags":["Page Resource"],"parameters":[{"name":"profile_id","in":"path","description":"id of the profile","required":true,"example":"self","schema":{"type":"string"}},{"name":"page_id","in":"path","description":"id of the page","required":true,"schema":{"type":"number"}},{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}],"requestBody":{"content":{"application/json":{"example":[{"element_name":"field_123"},{"element_name":"field_456"}],"schema":{"type":"object","required":["element_name: `field_123`"],"properties":{"element_name: `field_123`":{"type":"string"}}}}}}}},"/media_storage/connections/initiate":{"post":{"responses":{"200":{"description":"OK - open `consent_url` in the browser. The provider sends the user back to `redirect_uri` with `code` and `state`.","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"consent_url":{"type":"string","description":"the provider's consent page, built with this server's client id"},"state":{"type":"string","description":"signed, stateless OAuth state; valid for 15 minutes"}},"required":["consent_url","state"]},"example":{"consent_url":"https://www.dropbox.com/oauth2/authorize?response_type=code\u0026client_id=abc123\u0026redirect_uri=https%3A%2F%2Fapp.example.com%2Fintegrations%2Fcallback\u0026force_reapprove=true\u0026token_access_type=offline\u0026state=eyJsb2NhdGlvbiI6Mn0.5d41402abc4b2a76b9719d911017c592","state":"eyJsb2NhdGlvbiI6Mn0.5d41402abc4b2a76b9719d911017c592"}}}},"400":{"description":"Bad Request - `location` is not one of 2, 3, 6, 7, 8; `share` is not a boolean or is true for a location other than 3; or `redirect_uri` is missing or not on this server's `mediaStorageRedirectUris` allowlist.","headers":{},"content":{}},"401":{"description":"Unauthorized - missing or invalid bearer token.","headers":{},"content":{}},"403":{"description":"Forbidden - the client is not an internal client, the token belongs to a BASIC user, or `share` is true and the user is not a SERVER user.","headers":{},"content":{}},"503":{"description":"Service Unavailable - the provider has no OAuth client credentials on this server.","headers":{},"content":{}}},"summary":"Initiate Media Storage Connection","operationId":"Initiate Media Storage Connection","description":"Starts an OAuth connection between the caller's profile and a cloud storage provider. The API builds the consent URL with its own client id; the caller hosts only the redirect page and never sees a client secret or a provider token.\n\n| `location` | Provider |\n|---|---|\n| `2` | Dropbox (consent requests offline access, so a refresh token is issued) |\n| `3` | Box |\n| `6` | OneDrive |\n| `7` | SharePoint |\n| `8` | Google Drive |\n\n`redirect_uri` must exactly match an entry of the server's `mediaStorageRedirectUris` configuration.\n\n`share: true` (Box only) asks for the connection to be shared across the server's profiles. It is decided here and signed into `state`, so the exchange cannot change it; a caller who may not share gets `403` now, before the consent redirect.\n\n### Authorization\n\nInternal clients only, and a SERVER or COMPANY user. `share: true` needs a SERVER user.","tags":["Media Storage Resource"],"parameters":[{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}],"requestBody":{"required":true,"content":{"application/json":{"example":{"location":3,"redirect_uri":"https://app.example.com/integrations/callback","share":true},"schema":{"type":"object","required":["location","redirect_uri"],"properties":{"location":{"type":"integer","enum":[2,3,6,7,8]},"redirect_uri":{"type":"string"},"share":{"type":"boolean","description":"Box only, SERVER users only; store the connection as shared across profiles once the code is exchanged","default":false}}}}}}}},"/media_storage/connections":{"post":{"responses":{"201":{"description":"Created - the connection as `GET` lists it.","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MediaStorageConnection"},"example":{"provider":"box","location":3,"active":false,"account":"Jane Example"}}}},"400":{"description":"Bad Request - unsupported `location`; missing `code`; `state` invalid, expired, or minted for another location, profile or server; `share` sent and different from the value `state` was minted with; `shared_connection_id` sent with `code`, `state` or `share`, sent for a location other than 3, or not a linkable id (`Parameter 'shared_connection_id' is invalid`, the same message for an unknown id, a token that is not shared, and a token of another type); or the provider rejected the code.","headers":{},"content":{}},"401":{"description":"Unauthorized - missing or invalid bearer token.","headers":{},"content":{}},"403":{"description":"Forbidden - the client is not an internal client, the token belongs to a BASIC user, or `state` was minted with `share` true and the user is not a SERVER user.","headers":{},"content":{}},"502":{"description":"Bad Gateway - the provider failed or rejected this server's client credentials.","headers":{},"content":{}},"503":{"description":"Service Unavailable - the provider has no OAuth client credentials on this server.","headers":{},"content":{}}},"summary":"Create Media Storage Connection","operationId":"Create Media Storage Connection","description":"Stores a connection for the caller's profile, in one of two ways.\n\n- **Exchange** `{location, code, state}`: exchanges the `code` from the redirect for tokens, which are stored server-side and never returned. The connection is shared across profiles (Box only) exactly when `share: true` was sent to `initiate`: the choice is read from the signed `state`. A `share` sent here is optional and must repeat that choice, or the request answers `400`.\n- **Link** `{location: 3, shared_connection_id}`: links the profile to a shared Box connection listed by `GET /media_storage/connections/shared`. The id must be a shared token of the same provider.\n\nEither way the profile's previous connection to that provider is replaced. Creating a connection does not change the profile's active media storage location.\n\nFor Dropbox the legacy `ZCCompanyInfo` Dropbox columns are kept in step with the stored connection.\n\n### Authorization\n\nInternal clients only, and a SERVER or COMPANY user. A `state` minted with `share: true` needs a SERVER user here too.","tags":["Media Storage Resource"],"parameters":[{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}],"requestBody":{"required":true,"content":{"application/json":{"example":{"location":3,"code":"4c5f1b0a9e","state":"eyJsb2NhdGlvbiI6M30.5d41402abc4b2a76b9719d911017c592"},"schema":{"type":"object","required":["location"],"properties":{"location":{"type":"integer","enum":[2,3,6,7,8]},"code":{"type":"string","description":"the authorization code from the redirect; required unless `shared_connection_id` is sent"},"state":{"type":"string","description":"the `state` returned by `initiate`; required with `code`"},"share":{"type":"boolean","deprecated":true,"description":"ignored as a choice - sharing is decided by `share` at `initiate` and read from `state`; when sent it must equal that value, or the request answers 400"},"shared_connection_id":{"type":"integer","description":"Box only; link this shared connection instead of exchanging a code"}}}}}}},"get":{"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MediaStorageConnection"}},"example":[{"provider":"dropbox","location":2,"active":true,"destination_root":"/iForm Media","account":"Jane Example"},{"provider":"box","location":3,"active":false,"account":"Ops Team"}]}}},"401":{"description":"Unauthorized - missing or invalid bearer token.","headers":{},"content":{}},"403":{"description":"Forbidden - the client is not an internal client.","headers":{},"content":{}}},"summary":"List Media Storage Connections","operationId":"List Media Storage Connections","description":"Lists the caller's profile's cloud storage connections. No credential and no timestamp is returned. `destination_root` is reported only on the active location.\n\n### Authorization\n\nInternal clients only. Any user type may list.","tags":["Media Storage Resource"],"parameters":[{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}]}},"/media_storage/connections/shared":{"get":{"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MediaStorageSharedConnection"}},"example":[{"connection_id":41,"account":"Ops Team","profiles":[100,200]}]}}},"400":{"description":"Bad Request - `location` is missing or not 3.","headers":{},"content":{}},"401":{"description":"Unauthorized - missing or invalid bearer token.","headers":{},"content":{}},"403":{"description":"Forbidden - the client is not an internal client, or the token belongs to a BASIC user.","headers":{},"content":{}}},"summary":"List Shared Media Storage Connections","operationId":"List Shared Media Storage Connections","description":"Lists the connections a SERVER user shared across profiles, one entry per connection. Pass a `connection_id` as `shared_connection_id` to `POST /media_storage/connections` to link it. `profiles`, the profiles using each connection, is returned only to a SERVER user.\n\n### Authorization\n\nInternal clients only, and a SERVER or COMPANY user.","tags":["Media Storage Resource"],"parameters":[{"name":"location","in":"query","description":"provider location; only 3 (Box) supports sharing","required":true,"schema":{"type":"integer","enum":[3]}},{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}]}},"/media_storage/connections/{location}":{"delete":{"responses":{"200":{"description":"OK - the profile's remaining connections. Also returned when nothing was connected for `location`.","headers":{},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MediaStorageConnection"}},"example":[{"provider":"google_drive","location":8,"active":false,"account":"Jane Example"}]}}},"401":{"description":"Unauthorized - missing or invalid bearer token.","headers":{},"content":{}},"403":{"description":"Forbidden - the client is not an internal client, or the token belongs to a BASIC user.","headers":{},"content":{}},"404":{"description":"Not Found - `location` is not one of 2, 3, 6, 7, 8.","headers":{},"content":{}}},"summary":"Delete Media Storage Connection","operationId":"Delete Media Storage Connection","description":"Removes the profile's connection to the provider. The stored token is deleted, and the provider grant revoked where supported (Dropbox, Google Drive), only when no other profile uses it. Unlinking a shared connection leaves it in place for the other profiles.\n\nIf `location` is the profile's active media storage location, the profile is reset to S3 (`MEDIA_LOCATION` 5) in the same transaction, so it never points at a removed connection. Deleting an inactive location leaves the active one unchanged.\n\nFor Dropbox the legacy `ZCCompanyInfo` Dropbox columns are cleared as well.\n\n### Authorization\n\nInternal clients only, and a SERVER or COMPANY user.","tags":["Media Storage Resource"],"parameters":[{"name":"location","in":"path","description":"provider location","required":true,"schema":{"type":"integer","enum":[2,3,6,7,8]}},{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}]}},"/media_storage/active":{"put":{"responses":{"200":{"description":"OK - the location is now the profile's active media storage location.","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MediaStorageActiveLocation"},"examples":{"box":{"value":{"provider":"box","location":3,"active":true,"destination_root":"163842097521","account":"Ops Team"}},"s3":{"value":{"provider":"s3_private","location":9,"active":true}}}}}},"400":{"description":"Bad Request - `location` is not one of 2, 3, 5, 6, 7, 8, 9; `structure` is not 0 or 1; `destination_root` is not a string, is longer than 255 characters, holds a control character or a `.`/`..` segment, holds whitespace or any of `\" * : \u003c \u003e ? \\ |` for location 6, 7 or 8, is sent for location 5 or 9, or is missing or more than one library name for location 7; `site_id` is missing or not a site id for location 7, or sent for another location; or location 5 or 9 has no S3 bucket configured on this server.","headers":{},"content":{}},"401":{"description":"Unauthorized - missing or invalid bearer token.","headers":{},"content":{}},"403":{"description":"Forbidden - the client is not an internal client, or the token belongs to a BASIC user.","headers":{},"content":{}},"409":{"description":"Conflict - the profile has no connection for `location` (2, 3, 6, 7, 8); connect it first with `POST /media_storage/connections`. Also returned when the provider grant must be reconnected.","headers":{},"content":{}},"422":{"description":"Unprocessable Entity - Box only; the Box account is not on a paid plan (its upload limit is under 1 GB).","headers":{},"content":{}},"502":{"description":"Bad Gateway - the provider failed while the folder or library was being found or created. Nothing was changed.","headers":{},"content":{}}},"summary":"Set Active Media Storage Location","operationId":"Set Active Media Storage Location","description":"Makes `location` the caller's profile's active media storage location, where new record media is written, together with its folder and structure.\n\n| `location` | Needs | `destination_root` | Stored as |\n|---|---|---|---|\n| `2` Dropbox | a Dropbox connection | optional folder path | the path as sent |\n| `3` Box | a Box connection on a paid Box plan | optional folder path | the id of the last folder; missing folders are created |\n| `5` S3 | the server's media bucket | not sent | - |\n| `6` OneDrive | a OneDrive connection | optional folder path | the path as sent |\n| `7` SharePoint | a SharePoint connection and `site_id` | required document library name | the library name; the library is created on the site if missing, and `site_id` is stored on the connection |\n| `8` Google Drive | a Google Drive connection | optional folder path | the id of the last folder; missing folders are created |\n| `9` S3 (private) | the server's private media bucket | not sent | - |\n\n`structure` is `0` (the default: root / profile id / form name / file) or `1` (root / file).\n\nEvery provider call is made before anything is stored, and the location, folder and structure are then written together, so a provider failure leaves the profile's media storage exactly as it was. Any location may be chosen by any account; there is no plan or account-type restriction beyond Box's own paid-plan requirement.\n\n### Authorization\n\nInternal clients only, and a SERVER or COMPANY user.","tags":["Media Storage Resource"],"parameters":[{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}],"requestBody":{"required":true,"content":{"application/json":{"example":{"location":7,"destination_root":"iFormMedia","structure":0,"site_id":"contoso.sharepoint.com,2C712604-1370-44E7-A1F5-426573FDA80A,2D2244C3-251A-49EA-93A8-39E1C3A060FE"},"schema":{"type":"object","required":["location"],"properties":{"location":{"type":"integer","enum":[2,3,5,6,7,8,9]},"destination_root":{"type":"string","maxLength":255,"description":"the folder path (a document library name for SharePoint); not used for 5 and 9"},"structure":{"type":"integer","enum":[0,1],"default":0,"description":"0 = root / profile id / form name / file, 1 = root / file"},"site_id":{"type":"string","description":"SharePoint (7) only, required there; `root` or an `id` from `GET /media_storage/connections/7/sites`"}}}}}}}},"/media_storage/connections/7/sites":{"get":{"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MediaStorageSite"}},"example":[{"id":"root","label":"Contoso (root)"},{"id":"contoso.sharepoint.com,2C712604-1370-44E7-A1F5-426573FDA80A,2D2244C3-251A-49EA-93A8-39E1C3A060FE","label":"Operations"}]}}},"401":{"description":"Unauthorized - missing or invalid bearer token.","headers":{},"content":{}},"403":{"description":"Forbidden - the client is not an internal client, or the token belongs to a BASIC user.","headers":{},"content":{}},"409":{"description":"Conflict - the profile has no SharePoint connection, or it must be reconnected.","headers":{},"content":{}},"422":{"description":"Unprocessable Entity - the SharePoint connection is a personal Microsoft account; SharePoint needs a work or school account.","headers":{},"content":{}},"502":{"description":"Bad Gateway - Microsoft Graph failed.","headers":{},"content":{}}},"summary":"List SharePoint Sites","operationId":"List SharePoint Sites","description":"Lists the SharePoint sites the profile's SharePoint connection can use, for `site_id` in `PUT /media_storage/active`. The tenant's root site is listed with the id `root`.\n\n### Authorization\n\nInternal clients only, and a SERVER or COMPANY user.","tags":["Media Storage Resource"],"parameters":[{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}]}},"/profiles/{profile_id}/pages/{page_id}/media_restore":{"post":{"responses":{"200":{"description":"OK - no item in the batch failed (every `status` is `RESTORED`, `ALREADY_ACTIVE` or `PERMANENTLY_DELETED`).","headers":{},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MediaRestoreOutcome"}},"example":[{"url":"https://zerion-iform-media-example.s3.amazonaws.com/app/67890/_data67890_inspection_form/field_1234.png","status":"ALREADY_ACTIVE"},{"url":"privates3://zerion-iform-private-media-example/app/67890/_data67890_inspection_form/field_5678.jpeg","status":"RESTORED","version_id":"tn1cpMCxjyrb_0ksm3HBGnz6ORIAMZ9O"}]}}},"207":{"description":"Multi-Status - some items succeeded and some failed. The body has the same shape as `200`; inspect each item's `status`.","headers":{},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/MediaRestoreOutcome"}},"example":[{"url":"https://zerion-iform-media-example.s3.amazonaws.com/app/67890/_data67890_inspection_form/field_1234.png","status":"RESTORED","version_id":"tn1cpMCxjyrb_0ksm3HBGnz6ORIAMZ9O"},{"url":"https://zerion-iform-media-example.s3.amazonaws.com/app/99999/_data99999_other_form/field_1.png","status":"RESTORE_FAILED","reason":"URL_OUT_OF_SCOPE"}]}}},"400":{"description":"Bad Request - either the body was empty or not valid JSON (standard error object body), or every item in the batch failed (same outcome array as `200`, one entry per item).","headers":{},"content":{}},"401":{"description":"Unauthorized - missing or invalid bearer token.","headers":{},"content":{}},"403":{"description":"Forbidden - the token belongs to a BASIC user, the user cannot modify records on this page, or `profile_id` is not the caller's own profile.","headers":{},"content":{}},"404":{"description":"Not Found - `page_id` is not a valid page id, or the page does not belong to `profile_id`.","headers":{},"content":{}},"413":{"description":"Payload Too Large - more than 200 items were submitted. Split the batch and retry.","headers":{},"content":{}}},"summary":"Restore Deleted Media","operationId":"Restore Deleted Media","description":"Restores media files that were deleted from a versioned S3 bucket (for example via `DELETE .../media_upload`) by removing the S3 delete marker, making the object readable again.\n\n### Request body\n\nSend either a JSON array of `{ \"url\": ... }` objects or a single `{ \"url\": ... }` object. Both public `https://...amazonaws.com/...` URLs and `privates3://{bucket}/{key}` URLs (as returned for private media) are accepted. A request may contain **at most 200 items**; 201 or more returns `413` and nothing is restored.\n\n### Response\n\nA plain JSON array with one entry per submitted item, in request order. Each entry has `url` and `status`; `reason` is added on `PERMANENTLY_DELETED` and `RESTORE_FAILED`, and `version_id` is added only on `RESTORED`.\n\n| `status` | `reason` | Meaning |\n|---|---|---|\n| `RESTORED` | - | Delete marker removed; the object is readable again. `version_id` is the id of the removed delete marker. |\n| `ALREADY_ACTIVE` | - | The latest version has no delete marker. A no-op success, so replaying a request is idempotent. |\n| `PERMANENTLY_DELETED` | `LIFECYCLE_EXPIRED`, `OBJECT_NEVER_EXISTED` | Nothing to restore: the versions have been expired by the bucket lifecycle, or no object with that key ever existed. |\n| `RESTORE_FAILED` | `URL_REQUIRED`, `URL_OUT_OF_SCOPE`, `S3_CLIENT_UNAVAILABLE`, `AWS_SDK_ERROR`, or the raw AWS error code returned by S3 (for example `AccessDenied` or `NoSuchBucket`) | The item failed. Failures are per item and do not abort the rest of the batch (barring a server-side media configuration error, which fails the whole request). Malformed URLs and URLs on non-S3 hosts are reported as `URL_OUT_OF_SCOPE`. |\n\n### HTTP status\n\n- `200` no item failed (`RESTORED`, `ALREADY_ACTIVE` and `PERMANENTLY_DELETED` all count as non-failures)\n- `207` some items failed and some did not\n- `400` every item failed, or the body was empty or malformed\n- `413` more than 200 items in one request\n- `401` no valid bearer token\n- `403` BASIC user, no record-modify permission on the page, or another profile's `profile_id`\n- `404` invalid `page_id`, or the page does not belong to the profile\n\n### Authorization\n\nStandard bearer token. **BASIC users are denied with `403` before any S3 call**; COMPANY and SERVER users are allowed. The caller must also be able to modify records on the page.\n\n### Scope\n\nEvery URL must belong to the page in the path: its key must contain `{profile_id}/{data_table_name}`, where the data table name is resolved server-side from `(profile_id, page_id)`. URLs outside that scope come back as `RESTORE_FAILED` / `URL_OUT_OF_SCOPE` rather than being looked up in S3.","tags":["Page Resource"],"parameters":[{"name":"profile_id","in":"path","description":"id of the profile","required":true,"example":"self","schema":{"type":"string"}},{"name":"page_id","in":"path","description":"id of the page","required":true,"schema":{"type":"number"}},{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}],"requestBody":{"required":true,"content":{"application/json":{"examples":{"batch":{"summary":"Array of urls (public and private)","value":[{"url":"https://zerion-iform-media-example.s3.amazonaws.com/app/67890/_data67890_inspection_form/field_1234.png"},{"url":"privates3://zerion-iform-private-media-example/app/67890/_data67890_inspection_form/field_5678.png"}]},"single":{"summary":"Single object","value":{"url":"https://zerion-iform-media-example.s3.amazonaws.com/app/67890/_data67890_inspection_form/field_1234.png"}}},"schema":{"oneOf":[{"type":"array","maxItems":200,"items":{"type":"object","required":["url"],"properties":{"url":{"type":"string","description":"public `https://...amazonaws.com/...` or `privates3://{bucket}/{key}` url of the media file"}}}},{"type":"object","required":["url"],"properties":{"url":{"type":"string","description":"public `https://...amazonaws.com/...` or `privates3://{bucket}/{key}` url of the media file"}}}]}}}}}},"/profiles/{profile_id}/public_links":{"get":{"responses":{"200":{"description":"OK","headers":{"Total-Count":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PublicLink"}},"example":[{"id":41,"name":"Site Inspection","public_url":"https://app.iformbuilder.com/exzact/WebForm/pl/pages/290749032?share_token=ZXhhbXBsZS40MQ==","is_disabled":false,"page_id":290749032}]}}},"401":{"description":"Unauthorized - missing or invalid bearer token.","headers":{},"content":{}},"403":{"description":"Forbidden - the caller is neither an internal API client nor a SERVER user, or `profile_id` is not the caller's own profile.","headers":{},"content":{}}},"summary":"Retrieve a List of Public Links","operationId":"Retrieve a List of Public Links","description":"Lists the profile's public links, one per form at most. Default fields are `id`, `name`, `public_url`, `is_disabled` and `page_id`; ask for the others with `fields`.\n\n### Authorization\n\nInternal API clients and SERVER users. `password` is returned, RSA-encrypted, to SERVER and COMPANY users only.","tags":["Page Resource"],"parameters":[{"name":"profile_id","in":"path","description":"id of the profile","required":true,"example":"self","schema":{"type":"string"}},{"name":"fields","in":"query","description":"fields to return, with optional filters and sort order","example":"id,name,page_id,activation_date,expiration_date","schema":{"type":"string"}},{"name":"limit","in":"query","description":"maximum number of links to return","example":"100","schema":{"type":"number"}},{"name":"offset","in":"query","description":"number of links to skip","example":"0","schema":{"type":"number"}},{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}]},"post":{"responses":{"201":{"description":"Created - every item succeeded. A single object in the body answers a single `{id}`; an array answers an array in request order.","headers":{},"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/PublicLinkWriteOutcome"},{"type":"array","items":{"$ref":"#/components/schemas/PublicLinkWriteOutcome"}}]},"example":{"id":41}}}},"207":{"description":"Multi-Status - some items were created and some failed. Each failed item carries `error_message`.","headers":{},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PublicLinkWriteOutcome"}},"example":[{"id":41},{"error_message":"Public Link for page_id 290749033 already exists"}]}}},"400":{"description":"Bad Request - every item failed (for example a missing or invalid `page_id`, the form already has a public link, or public links are not enabled on this server). The body has the same shape as `201`, with `error_message` on each item.","headers":{},"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/PublicLinkWriteOutcome"},{"type":"array","items":{"$ref":"#/components/schemas/PublicLinkWriteOutcome"}}]}}}},"401":{"description":"Unauthorized - missing or invalid bearer token.","headers":{},"content":{}},"403":{"description":"Forbidden - the caller cannot modify one of the forms in the body (see Authorization), or `profile_id` is not the caller's own profile. Nothing is created.","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Not Found - a `page_id` in the body is a page of the profile but not a form (for example a page group).","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"summary":"Create Public Links","operationId":"Create Public Links","description":"Creates a public link for each form in the body. A form has at most one public link. Send one object or an array of objects.\n\n### Authorization\n\n- SERVER users: any form in the profile.\n- COMPANY users: any form of their own profile that is not shared into it from another profile.\n- BASIC users: only forms they created, and only with the Form Builder role.\n\nAn internal API client gets no exemption: it passes only when its user does. Permission is checked for every form in the body before anything is written, so one form the caller cannot modify fails the whole request with `403`.","tags":["Page Resource"],"parameters":[{"name":"profile_id","in":"path","description":"id of the profile","required":true,"example":"self","schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/PublicLinkCreateRequest"},{"type":"array","items":{"$ref":"#/components/schemas/PublicLinkCreateRequest"}}]},"example":{"page_id":290749032,"name":"Site Inspection","activation_date":"2026-12-01T00:00:00Z","expiration_date":"2027-01-01T00:00:00Z","password":"s3cret-pass"}}}}},"put":{"responses":{"200":{"description":"OK - every item was updated. The body is always an array, in request order.","headers":{},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PublicLinkWriteOutcome"}},"example":[{"id":41}]}}},"207":{"description":"Multi-Status - some items were updated and some failed. Each failed item carries `error_message`.","headers":{},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PublicLinkWriteOutcome"}}}}},"400":{"description":"Bad Request - every item failed (for example neither `id` nor `page_id`, no link matches them, or public links are not enabled on this server). The body is the same array, with `error_message` on each item.","headers":{},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PublicLinkWriteOutcome"}}}}},"401":{"description":"Unauthorized - missing or invalid bearer token.","headers":{},"content":{}},"403":{"description":"Forbidden - the caller cannot modify the form of one of the links in the body (see Authorization), or `profile_id` is not the caller's own profile. Nothing is updated.","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"summary":"Update Public Links","operationId":"Update Public Links","description":"Updates public links, each found by `id`, by `page_id`, or by both. Fields left out keep their value.\n\n`password`: a non-empty string sets a new password (stored RSA-encrypted). `\"\"` removes the password, so the link no longer asks for one. `null` or leaving `password` out keeps the current password.\n\n### Authorization\n\nThe same rule as **Create Public Links**, applied to the form each link belongs to: SERVER users any form; COMPANY users their own profile's non-shared forms; BASIC users with the Form Builder role only forms they created. An internal API client gets no exemption. Every link is checked before anything is written, so one link the caller cannot modify fails the whole request with `403`.","tags":["Page Resource"],"parameters":[{"name":"profile_id","in":"path","description":"id of the profile","required":true,"example":"self","schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/PublicLinkUpdateRequest"},{"type":"array","items":{"$ref":"#/components/schemas/PublicLinkUpdateRequest"}}]},"examples":{"change_password":{"summary":"Set a new password","value":{"id":41,"password":"n3w-pass"}},"clear_password":{"summary":"Remove the password","value":{"id":41,"password":""}},"disable":{"summary":"Disable the link of a form","value":{"page_id":290749032,"is_disabled":true}}}}}}},"delete":{"responses":{"200":{"description":"OK - every link was deleted. A single object in the body answers a single `{id}`; an array answers an array in request order.","headers":{},"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/PublicLinkWriteOutcome"},{"type":"array","items":{"$ref":"#/components/schemas/PublicLinkWriteOutcome"}}]},"example":{"id":41}}}},"207":{"description":"Multi-Status - some links were deleted and some failed. Each failed item carries `error_message`.","headers":{},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PublicLinkWriteOutcome"}}}}},"400":{"description":"Bad Request - every item failed (for example no link matches its `id` or `page_id`, or public links are not enabled on this server).","headers":{},"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/PublicLinkWriteOutcome"},{"type":"array","items":{"$ref":"#/components/schemas/PublicLinkWriteOutcome"}}]}}}},"401":{"description":"Unauthorized - missing or invalid bearer token.","headers":{},"content":{}},"403":{"description":"Forbidden - the caller cannot modify the form of one of the links (see Authorization), or `profile_id` is not the caller's own profile. Nothing is deleted.","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"summary":"Delete Public Links","operationId":"Delete Public Links","description":"Deletes public links, each found by `id`, by `page_id`, or by both. Send one object or an array of objects.\n\n### Authorization\n\nThe same rule as **Update Public Links**: SERVER users any form; COMPANY users their own profile's non-shared forms; BASIC users with the Form Builder role only forms they created. An internal API client gets no exemption. Every link is checked before anything is deleted, so one link the caller cannot modify fails the whole request with `403`.","tags":["Page Resource"],"parameters":[{"name":"profile_id","in":"path","description":"id of the profile","required":true,"example":"self","schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/PublicLinkKey"},{"type":"array","items":{"$ref":"#/components/schemas/PublicLinkKey"}}]},"example":{"id":41}}}}}},"/profiles/{profile_id}/page_groups/{page_group_id}":{"get":{"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"},"global_id":{"type":"string"},"version":{"type":"number"},"created_date":{"type":"string"},"pages":{}},"required":["id","name","global_id","version","created_date","pages"]}}}}},"summary":"Retrieve a Page Group","operationId":"Retrieve a Page Group","description":"","tags":["Page Group Resource"],"parameters":[{"name":"profile_id","in":"path","description":"id of the profile","required":true,"example":"self","schema":{"type":"string"}},{"name":"page_group_id","in":"path","description":"id of the page group","required":true,"schema":{"type":"number"}},{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}]},"put":{"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"number","description":"the updated page group id"}},"required":["id"]},"example":{"id":790777}}}}},"summary":"Update a Page Group","operationId":"Update a Page Group","description":"","tags":["Page Group Resource"],"parameters":[{"name":"profile_id","in":"path","description":"id of the profile","required":true,"example":"self","schema":{"type":"string"}},{"name":"page_group_id","in":"path","description":"id of the page group","required":true,"schema":{"type":"number"}},{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}],"requestBody":{"content":{"application/json":{"example":{"name":"my_form_group"},"schema":{"type":"object","properties":{"name":{"type":"string","example":"building_inspection"}}}}}}},"delete":{"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"number","description":"the deleted page group id"}},"required":["id"]},"example":{"id":790777}}}}},"summary":"Delete a Page Group","operationId":"Delete a Page Group","description":"","tags":["Page Group Resource"],"parameters":[{"name":"profile_id","in":"path","description":"id of the profile","required":true,"example":"self","schema":{"type":"string"}},{"name":"page_group_id","in":"path","description":"id of the page group","required":true,"schema":{"type":"number"}},{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}]}},"/profiles/{profile_id}/page_groups":{"get":{"responses":{"200":{"description":"OK","headers":{"Total-Count":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"},"global_id":{"type":"string"},"version":{"type":"number"},"created_date":{"type":"string"},"pages":{}},"required":["id","name"]},"examples":{"example1":{"value":[{"id":359784,"name":"inspections"},{"id":359894,"name":"logistics"}]},"example2":{"value":[{"id":359784,"name":"inspections"},{"id":359894,"name":"logistics"}]}}}}}},"summary":"Retrieve a List of Page Groups","operationId":"Retrieve a List of Page Groups","description":"","tags":["Page Group Resource"],"parameters":[{"name":"profile_id","in":"path","description":"id of the profile","required":true,"example":"self","schema":{"type":"string"}},{"name":"fields","in":"query","description":"extra information of each user on the list","schema":{"type":"string"}},{"name":"limit","in":"query","description":"maximum count of the user list","example":"100","schema":{"type":"number"}},{"name":"offset","in":"query","description":"skip that many users before beginning to return","example":"0","schema":{"type":"number"}},{"name":"validate_grammar","in":"query","description":"returns an error for incorrect field grammar when set to true","example":"false","schema":{"type":"string"}},{"name":"all_fields","in":"query","description":"will show all fields for each users","example":"1","schema":{"type":"boolean"}},{"name":"exclude","in":"query","description":"will exclude specified fields","schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}]},"post":{"responses":{"201":{"description":"Created","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"number","description":"the created page group id"}},"required":["id"]},"example":{"id":161236}}}}},"summary":"Create New Page Group","operationId":"Create New Page Group","description":"","tags":["Page Group Resource"],"parameters":[{"name":"profile_id","in":"path","description":"id of the profile","required":true,"example":"self","schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}],"requestBody":{"content":{"application/json":{"example":{"name":"demo_page_group"},"schema":{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"demo_page_group"}}}}}}}},"/profiles/{profile_id}/page_groups/{page_group_id}/pages":{"get":{"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"page_id":{"type":"number"},"Body":{"type":"string","description":"[\n    {\n        \"page_id\": 11261236,\n    }\n]       "}},"required":["page_id"]},"example":{"page_id":11261236,"Body":""}}}}},"summary":"Retrieve a Page Group Page Assignment","operationId":"Retrieve a Page Group Page Assignment","description":"","tags":["Page Group Resource"],"parameters":[{"name":"profile_id","in":"path","description":"id of the profile","required":true,"example":"self","schema":{"type":"string"}},{"name":"page_group_id","in":"path","description":"id of the page","required":true,"schema":{"type":"number"}},{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}]},"post":{"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"page_id":{"type":"number"},"Body":{"type":"string","description":"[\n    {\n        \"page_id\": 11261236            \n    },\n    {\n        \"page_id\": 11261239            \n    }\n]       "}},"required":["page_id"]},"example":{"page_id":11261236,"Body":""}}}}},"summary":"Assign Page to Page Group","operationId":"Assign Page to Page Group","description":"","tags":["Page Group Resource"],"parameters":[{"name":"profile_id","in":"path","description":"id of the profile","required":true,"example":"self","schema":{"type":"string"}},{"name":"page_group_id","in":"path","description":"id of the page","required":true,"schema":{"type":"number"}},{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}],"requestBody":{"content":{"application/json":{"example":[{"page_id":11261236},{"page_id":11261239}],"schema":{"type":"array","items":{"type":"object","properties":{"page_id":{"type":"number"}},"required":["page_id"]}}}}}},"delete":{"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"page_id":{"type":"number"}},"required":["page_id"]},"example":[{"page_id":11261236},{"page_id":11261239}]}}},"207":{"description":"Multi-Status - some items succeeded and some failed. The body is an array in request order (a list request body, even with one item, always answers a list); a failed item carries `error_message` instead of `page_id` and was not written. An item whose row does not exist answers `The requested resource is not found`.","headers":{},"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"page_id":{"type":"integer","description":"present when the item succeeded"},"error_message":{"type":"string","description":"present when the item failed"}}}},"example":[{"page_id":290857010},{"error_message":"The requested resource is not found"}]}}},"400":{"description":"Bad Request - every item of a list request body failed. The body has the same shape as `207`, with `error_message` on each item; nothing was written. A single-object request body that fails answers the standard error object instead.","headers":{},"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/ApiError"},{"type":"array","items":{"type":"object","properties":{"error_message":{"type":"string"}},"required":["error_message"]}}]},"examples":{"all_failed":{"summary":"Every item of a list body failed","value":[{"error_message":"The requested resource is not found"}]},"single_object":{"summary":"A single-object body failed","value":{"error_message":"The requested resource is not found"}}}}}}},"summary":"Delete Page from Page Group","operationId":"Delete Page from Page Group","description":"","tags":["Page Group Resource"],"parameters":[{"name":"profile_id","in":"path","description":"id of the profile","required":true,"example":"self","schema":{"type":"string"}},{"name":"page_group_id","in":"path","description":"id of the page","required":true,"schema":{"type":"number"}},{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}],"requestBody":{"content":{"application/json":{"example":[{"page_id":11261236},{"page_id":11261239}],"schema":{"type":"array","items":{"type":"object","properties":{"page_id":{"type":"number"}},"required":["page_id"]}}}}}}},"/profiles/{profile_id}/page_groups/{page_group_id}/assignments/{user_id}":{"get":{"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"user_id":{"type":"number"},"is_group":{"type":"boolean"},"can_collect":{"type":"boolean"},"can_view":{"type":"boolean"}},"required":["user_id","is_group","can_collect","can_view"]},"example":{"user_id":161236,"is_group":false,"can_collect":true,"can_view":true}}}}},"summary":"Retrieve a Page Group User Assignment","operationId":"Retrieve a Page Group User Assignment","description":"","tags":["Page Group Resource"],"parameters":[{"name":"profile_id","in":"path","description":"id of the profile","required":true,"example":"self","schema":{"type":"string"}},{"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"}},{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}]},"put":{"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"user_id":{"type":"number","description":"the updated user id"}},"required":["user_id"]},"example":{"user_id":161236}}}}},"summary":"Update a Page Group User Assignment","operationId":"Update a Page Group User Assignment","description":"","tags":["Page Group Resource"],"parameters":[{"name":"profile_id","in":"path","description":"id of the profile","required":true,"example":"self","schema":{"type":"string"}},{"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"}},{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}],"requestBody":{"content":{"application/json":{"example":{"can_collect":true,"can_view":true},"schema":{"type":"object","properties":{"can_collect":{"type":"boolean","example":true},"can_view":{"type":"boolean","example":true}}}}}}},"delete":{"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"user_id":{"type":"number","description":"the deleted user id"}},"required":["user_id"]},"example":{"user_id":161236}}}}},"summary":"Delete a Page Group User Assignment","operationId":"Delete a Page Group User Assignment","description":"","tags":["Page Group Resource"],"parameters":[{"name":"profile_id","in":"path","description":"id of the profile","required":true,"example":"self","schema":{"type":"string"}},{"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"}},{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}]}},"/profiles/{profile_id}/page_groups/{page_group_id}/assignments":{"get":{"responses":{"200":{"description":"OK","headers":{"Total-Count":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"user_id":{"type":"number"},"is_group":{"type":"boolean"},"can_collect":{"type":"boolean"},"can_view":{"type":"boolean"}},"required":["user_id"]},"example":[{"user_id":161236},{"user_id":161239},{"user_id":161242}]}}}},"summary":"Retrieve a List of Page Group User Assignments","operationId":"Retrieve a List of Page Group User Assignments","description":"","tags":["Page Group Resource"],"parameters":[{"name":"profile_id","in":"path","description":"id of the profile","required":true,"example":"self","schema":{"type":"string"}},{"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","schema":{"type":"string"}},{"name":"limit","in":"query","description":"maximum count of the page assignment list","example":"100","schema":{"type":"number"}},{"name":"offset","in":"query","description":"skip that many page assignment before beginning to return","example":"0","schema":{"type":"number"}},{"name":"validate_grammar","in":"query","description":"returns an error for incorrect field grammar when set to true","example":"false","schema":{"type":"string"}},{"name":"all_fields","in":"query","description":"will show all fields for each page assignment","example":"1","schema":{"type":"boolean"}},{"name":"exclude","in":"query","description":"will exclude specified fields","schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}]},"put":{"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"user_id":{"type":"number","description":"the updated user id"}},"required":["user_id"]},"example":[{"user_id":161239},{"user_id":161242}]}}},"207":{"description":"Multi-Status - some items succeeded and some failed. The body is an array in request order (a list request body, even with one item, always answers a list); a failed item carries `error_message` instead of `user_id` and was not written.","headers":{},"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"user_id":{"type":"integer","description":"present when the item succeeded"},"error_message":{"type":"string","description":"present when the item failed"}}}},"example":[{"user_id":12345},{"error_message":"Parameter 'user_id' is invalid"}]}}},"400":{"description":"Bad Request - every item of a list request body failed. The body has the same shape as `207`, with `error_message` on each item; nothing was written. A single-object request body that fails answers the standard error object instead.","headers":{},"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/ApiError"},{"type":"array","items":{"type":"object","properties":{"error_message":{"type":"string"}},"required":["error_message"]}}]},"examples":{"all_failed":{"summary":"Every item of a list body failed","value":[{"error_message":"Parameter 'user_id' is invalid"}]},"single_object":{"summary":"A single-object body failed","value":{"error_message":"Parameter 'user_id' is invalid"}}}}}}},"summary":"Update a List of Page Group User Assignments","operationId":"Update a List of Page Group User Assignments","description":"","tags":["Page Group Resource"],"parameters":[{"name":"profile_id","in":"path","description":"id of the profile","required":true,"example":"self","schema":{"type":"string"}},{"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","schema":{"type":"string"}},{"name":"limit","in":"query","description":"maximum count of the page assignment list","example":"100","schema":{"type":"number"}},{"name":"offset","in":"query","description":"skip that many page assignment before beginning to return","example":"0","schema":{"type":"number"}},{"name":"validate_grammar","in":"query","description":"returns an error for incorrect field grammar when set to true","example":"false","schema":{"type":"string"}},{"name":"all_fields","in":"query","description":"will show all fields for each page assignment","example":"1","schema":{"type":"boolean"}},{"name":"exclude","in":"query","description":"will exclude specified fields","schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}],"requestBody":{"content":{"application/json":{"examples":{"example1":{"value":[{"user_id":161239,"can_view":false},{"user_id":161242,"can_view":false}]},"example2":{"value":{"can_view":false}}},"schema":{"type":"object","properties":{"user_id":{"type":"number","example":161236},"can_collect":{"type":"boolean","example":true},"can_view":{"type":"boolean","example":true}}}}}}},"delete":{"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"user_id":{"type":"number","description":"the deleted user id"}},"required":["user_id"]},"example":[{"user_id":161239},{"user_id":161242}]}}},"207":{"description":"Multi-Status - some items succeeded and some failed. The body is an array in request order (a list request body, even with one item, always answers a list); a failed item carries `error_message` instead of `user_id` and was not written. An item whose row does not exist answers `The requested resource is not found`.","headers":{},"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"user_id":{"type":"integer","description":"present when the item succeeded"},"error_message":{"type":"string","description":"present when the item failed"}}}},"example":[{"user_id":12345},{"error_message":"The requested resource is not found"}]}}},"400":{"description":"Bad Request - every item of a list request body failed. The body has the same shape as `207`, with `error_message` on each item; nothing was written. A single-object request body that fails answers the standard error object instead.","headers":{},"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/ApiError"},{"type":"array","items":{"type":"object","properties":{"error_message":{"type":"string"}},"required":["error_message"]}}]},"examples":{"all_failed":{"summary":"Every item of a list body failed","value":[{"error_message":"The requested resource is not found"}]},"single_object":{"summary":"A single-object body failed","value":{"error_message":"The requested resource is not found"}}}}}}},"summary":"Delete a List of Page Group's User Assignments","operationId":"Delete a List of Page Group's User Assignments","description":"","tags":["Page Group Resource"],"parameters":[{"name":"profile_id","in":"path","description":"id of the profile","required":true,"example":"self","schema":{"type":"string"}},{"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","schema":{"type":"string"}},{"name":"limit","in":"query","description":"maximum count of the page assignment list","example":"100","schema":{"type":"number"}},{"name":"offset","in":"query","description":"skip that many page assignment before beginning to return","example":"0","schema":{"type":"number"}},{"name":"validate_grammar","in":"query","description":"returns an error for incorrect field grammar when set to true","example":"false","schema":{"type":"string"}},{"name":"all_fields","in":"query","description":"will show all fields for each page assignment","example":"1","schema":{"type":"boolean"}},{"name":"exclude","in":"query","description":"will exclude specified fields","schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}],"requestBody":{"content":{"application/json":{"example":[{"user_id":161239},{"user_id":161242}],"schema":{"type":"object","properties":{"user_id":{"type":"number","example":161239}}}}}}}},"/profiles/{profile_id}/pages/{page_group_id}/assignments":{"post":{"responses":{"201":{"description":"Created","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"user_id":{"type":"number","description":"the created user id"}},"required":["user_id"]},"examples":{"example1":{"value":{"user_id":161236}},"example2":{"value":[{"user_id":161239},{"user_id":161242}]}}}}}},"summary":"Create New Page Group Assignments","operationId":"Create New Page Group Assignments","description":"","tags":["Page Group Resource"],"parameters":[{"name":"profile_id","in":"path","description":"id of the profile","required":true,"example":"self","schema":{"type":"string"}},{"name":"page_group_id","in":"path","description":"id of the page","required":true,"schema":{"type":"number"}},{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}],"requestBody":{"content":{"application/json":{"examples":{"example1":{"value":{"user_id":161236,"can_collect":true}},"example2":{"value":[{"user_id":161239,"can_collect":true},{"user_id":161242,"can_collect":true}]}},"schema":{"type":"object","required":["user_id"],"properties":{"user_id":{"type":"number","example":161236},"can_collect":{"type":"boolean","example":true},"can_view":{"type":"boolean","example":true}}}}}}}},"/profiles/{profile_id}/pages/{page_id}/elements/{element_id}":{"get":{"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"},"global_id":{"type":"string"},"version":{"type":"number"},"label":{"type":"string"},"description":{"type":"string"},"data_type":{"type":"number"},"data_size":{"type":"number"},"created_date":{"type":"string"},"created_by: `demo_user`":{"type":"string"},"modified_date":{"type":"string"},"modified_by: `demo_user`":{"type":"string"},"widget_type":{"type":"string"},"sort_order":{"type":"number"},"optionlist_id":{"type":"number"},"default_value":{"type":"string"},"low_value":{"type":"number"},"high_value":{"type":"number"},"dynamic_value":{"type":"string"},"is_required":{"type":"boolean"},"condition_value":{"type":"string"},"client_validation":{"type":"string"},"is_disabled":{"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"},"attachment_link":{"type":"string"},"is_readonly":{"type":"boolean"},"validation_message":{"type":"string"},"is_action":{"type":"boolean"},"smart_tbl_search":{"type":"string"},"smart_tbl_search_col":{"type":"string"},"is_encrypt":{"type":"boolean"},"is_hide_typing":{"type":"boolean"},"on_change":{"type":"string"},"keyboard_type":{"type":"number"},"dynamic_label":{"type":"string"},"weighted_score":{"type":"number"},"localizations":{}},"required":["id","name","global_id","version","label","description","data_type","data_size","created_date","created_by: `demo_user`","modified_date","modified_by: `demo_user`","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"]},"example":{"id":20483236,"name":"inspector_name","global_id":"0E20483236H5971E","version":3,"label":"Inspector Name","description":"","data_type":1,"data_size":50,"created_date":"2015-05-12T14:38:35+00:00","created_by":"demo_user","modified_date":"2015-05-12T14:49:41+00:00","modified_by":"demo_user","widget_type":"","sort_order":1,"optionlist_id":0,"default_value":"","low_value":0,"high_value":0,"dynamic_value":"iformbuilder.username","is_required":false,"condition_value":"","client_validation":"","is_disabled":false,"reference_id_1":"","reference_id_2":"","reference_id_3":"","reference_id_4":"","reference_id_5":"","attachment_link":"","is_readonly":false,"validation_message":"","is_action":false,"smart_tbl_search":"","smart_tbl_search_col":"","is_encrypt":false,"is_hide_typing":false,"on_change":"","keyboard_type":1,"dynamic_label":"","weighted_score":0,"localizations":[]}}}}},"summary":"Retrieve an Element","operationId":"Retrieve an Element","description":"","tags":["Element Resource"],"parameters":[{"name":"profile_id","in":"path","description":"id of the profile","required":true,"example":"self","schema":{"type":"string"}},{"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":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}]},"put":{"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"number","description":"the updated element id"}},"required":["id"]},"example":{"id":20483245}}}}},"summary":"Update an Element","operationId":"Update an Element","description":"","tags":["Element Resource"],"parameters":[{"name":"profile_id","in":"path","description":"id of the profile","required":true,"example":"self","schema":{"type":"string"}},{"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":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}],"requestBody":{"content":{"application/json":{"example":{"is_required":true},"schema":{"type":"object","properties":{"name":{"type":"string","example":"inspector_name"},"label":{"type":"string","example":"Inspector Name"},"description":{"type":"string"},"data_type":{"type":"number","example":1},"data_size":{"type":"number","example":50},"widget_type":{"type":"string"},"sort_order":{"type":"number","example":1},"optionlist_id":{"type":"number"},"default_value":{"type":"string"},"low_value":{"type":"number"},"high_value":{"type":"number"},"dynamic_value":{"type":"string","example":"iformbuilder.username"},"is_required":{"type":"boolean"},"condition_value":{"type":"string"},"client_validation":{"type":"string"},"is_disabled":{"type":"boolean"},"reference_id_1":{"type":"string"},"attachment_link":{"type":"string"},"is_action":{"type":"boolean","example":true},"is_readonly":{"type":"boolean"},"validation_message":{"type":"string"},"smart_tbl_search":{"type":"string"},"smart_tbl_search_col":{"type":"string"},"is_encrypt":{"type":"boolean"},"is_hide_typing":{"type":"boolean"},"keyboard_type":{"type":"number","example":1},"dynamic_label":{"type":"string"},"weighted_score":{"type":"number"}}}}}}},"delete":{"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"number","description":"the deleted element id"}},"required":["id"]},"example":{"id":20483245}}}}},"summary":"Delete an Element","operationId":"Delete an Element","description":"","tags":["Element Resource"],"parameters":[{"name":"profile_id","in":"path","description":"id of the profile","required":true,"example":"self","schema":{"type":"string"}},{"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":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}]},"post":{"responses":{"201":{"description":"Created","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"number","description":"the copied element id"}},"required":["id"]},"example":{"id":20483248}}}}},"summary":"Copy an Element","operationId":"Copy an Element","description":"**Note:** This operation uses the non-standard HTTP `COPY` method. It is documented under `POST` because OpenAPI does not support custom HTTP methods — send the actual request with the `COPY` verb.\n\n","tags":["Element Resource"],"parameters":[{"name":"profile_id","in":"path","description":"id of the profile","required":true,"example":"self","schema":{"type":"string"}},{"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":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}],"x-original-http-method":"COPY"}},"/profiles/{profile_id}/pages/{page_id}/elements":{"get":{"responses":{"200":{"description":"OK","headers":{"Total-Count":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"},"global_id":{"type":"string"},"version":{"type":"number"},"label":{"type":"string"},"description":{"type":"string"},"data_type":{"type":"number"},"data_size":{"type":"number"},"created_date":{"type":"string"},"created_by: `demo_user`":{"type":"string"},"modified_date":{"type":"string"},"modified_by: `demo_user`":{"type":"string"},"widget_type":{"type":"string"},"sort_order":{"type":"number"},"optionlist_id":{"type":"number"},"default_value":{"type":"string"},"low_value":{"type":"number"},"high_value":{"type":"number"},"dynamic_value":{"type":"string"},"is_required":{"type":"boolean"},"condition_value":{"type":"string"},"client_validation":{"type":"string"},"is_disabled":{"type":"boolean"},"reference_id_1":{"type":"string"},"attachment_link":{"type":"string"},"is_readonly":{"type":"boolean"},"is_action":{"type":"boolean"},"validation_message":{"type":"string"},"smart_tbl_search":{"type":"string"},"smart_tbl_search_col":{"type":"string"},"is_encrypt":{"type":"boolean"},"is_hide_typing":{"type":"boolean"},"keyboard_type":{"type":"number"},"dynamic_label":{"type":"string"},"weighted_score":{"type":"number"},"localizations":{}},"required":["id","name"]},"example":[{"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}]}}},"404":{"description":"Not Found - `page_id` does not exist or is not a page of `profile_id`.","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error_message":"The requested resource is not found"}}}}},"summary":"Retrieve a List of Elements","operationId":"Retrieve a List of Elements","description":"","tags":["Element Resource"],"parameters":[{"name":"profile_id","in":"path","description":"id of the profile","required":true,"example":"self","schema":{"type":"string"}},{"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","example":"sort_order:\u003e","schema":{"type":"string"}},{"name":"limit","in":"query","description":"maximum count of the element list","example":"100","schema":{"type":"number"}},{"name":"offset","in":"query","description":"skip that many elements before beginning to return","example":"0","schema":{"type":"number"}},{"name":"validate_grammar","in":"query","description":"returns an error for incorrect field grammar when set to true","example":"false","schema":{"type":"string"}},{"name":"all_fields","in":"query","description":"will show all fields for each elements","example":"1","schema":{"type":"boolean"}},{"name":"exclude","in":"query","description":"will exclude specified fields","schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}]},"put":{"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"number","description":"the updated element id"}},"required":["id"]},"example":[{"id":20483233},{"id":20483236}]}}},"207":{"description":"Multi-Status - some items succeeded and some failed. The body is an array in request order (a list request body, even with one item, always answers a list); a failed item carries `error_message` instead of `id` and was not written.","headers":{},"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","description":"present when the item succeeded"},"error_message":{"type":"string","description":"present when the item failed"}}}},"example":[{"id":20483233},{"error_message":"Parameter 'id' is invalid"}]}}},"400":{"description":"Bad Request - every item of a list request body failed. The body has the same shape as `207`, with `error_message` on each item; nothing was written. A single-object request body that fails answers the standard error object instead.","headers":{},"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/ApiError"},{"type":"array","items":{"type":"object","properties":{"error_message":{"type":"string"}},"required":["error_message"]}}]},"examples":{"all_failed":{"summary":"Every item of a list body failed","value":[{"error_message":"Parameter 'id' is invalid"}]},"single_object":{"summary":"A single-object body failed","value":{"error_message":"Parameter 'id' is invalid"}}}}}},"404":{"description":"Not Found - `page_id` does not exist or is not a page of `profile_id`.","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error_message":"The requested resource is not found"}}}}},"summary":"Update a List of Elements","operationId":"Update a List of Elements","description":"","tags":["Element Resource"],"parameters":[{"name":"profile_id","in":"path","description":"id of the profile","required":true,"example":"self","schema":{"type":"string"}},{"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","example":"sort_order:\u003e","schema":{"type":"string"}},{"name":"limit","in":"query","description":"maximum count of the element list","example":"100","schema":{"type":"number"}},{"name":"offset","in":"query","description":"skip that many elements before beginning to return","example":"0","schema":{"type":"number"}},{"name":"validate_grammar","in":"query","description":"returns an error for incorrect field grammar when set to true","example":"false","schema":{"type":"string"}},{"name":"all_fields","in":"query","description":"will show all fields for each elements","example":"1","schema":{"type":"boolean"}},{"name":"exclude","in":"query","description":"will exclude specified fields","schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}],"requestBody":{"content":{"application/json":{"examples":{"example1":{"value":[{"id":20483233,"dynamic_value":"new Date()"},{"id":20483236,"dynamic_value":"iformbuilder.username"}]},"example2":{"value":{"keyboard_type":1}}},"schema":{"type":"object","properties":{"id":{"type":"number","example":20483236},"name":{"type":"string","example":"inspector_name"},"label":{"type":"string","example":"Inspector Name"},"description":{"type":"string"},"data_type":{"type":"number","example":1},"data_size":{"type":"number","example":50},"widget_type":{"type":"string"},"sort_order":{"type":"number","example":1},"optionlist_id":{"type":"number"},"default_value":{"type":"string"},"low_value":{"type":"number"},"high_value":{"type":"number"},"dynamic_value":{"type":"string","example":"iformbuilder.username"},"is_required":{"type":"boolean"},"condition_value":{"type":"string"},"client_validation":{"type":"string"},"is_disabled":{"type":"boolean"},"reference_id_1":{"type":"string"},"attachment_link":{"type":"string"},"is_readonly":{"type":"boolean"},"is_action":{"type":"boolean","example":true},"validation_message":{"type":"string"},"smart_tbl_search":{"type":"string"},"smart_tbl_search_col":{"type":"string"},"is_encrypt":{"type":"boolean"},"is_hide_typing":{"type":"boolean"},"keyboard_type":{"type":"number","example":1},"dynamic_label":{"type":"string"},"weighted_score":{"type":"number"}}}}}}},"delete":{"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"number","description":"the deleted element id"}},"required":["id"]},"example":[{"id":20483233},{"id":20483236}]}}},"207":{"description":"Multi-Status - some items succeeded and some failed. The body is an array in request order (a list request body, even with one item, always answers a list); a failed item carries `error_message` instead of `id` and was not written. An item whose row does not exist answers `The requested resource is not found`.","headers":{},"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","description":"present when the item succeeded"},"error_message":{"type":"string","description":"present when the item failed"}}}},"example":[{"id":20483233},{"error_message":"Parameter 'id' is invalid"}]}}},"400":{"description":"Bad Request - every item of a list request body failed. The body has the same shape as `207`, with `error_message` on each item; nothing was written. A single-object request body that fails answers the standard error object instead.","headers":{},"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/ApiError"},{"type":"array","items":{"type":"object","properties":{"error_message":{"type":"string"}},"required":["error_message"]}}]},"examples":{"all_failed":{"summary":"Every item of a list body failed","value":[{"error_message":"Parameter 'id' is invalid"}]},"single_object":{"summary":"A single-object body failed","value":{"error_message":"Parameter 'id' is invalid"}}}}}},"404":{"description":"Not Found - `page_id` does not exist or is not a page of `profile_id`.","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error_message":"The requested resource is not found"}}}}},"summary":"Delete a List of Elements","operationId":"Delete a List of Elements","description":"","tags":["Element Resource"],"parameters":[{"name":"profile_id","in":"path","description":"id of the profile","required":true,"example":"self","schema":{"type":"string"}},{"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","example":"sort_order:\u003e","schema":{"type":"string"}},{"name":"limit","in":"query","description":"maximum count of the element list","example":"100","schema":{"type":"number"}},{"name":"offset","in":"query","description":"skip that many elements before beginning to return","example":"0","schema":{"type":"number"}},{"name":"validate_grammar","in":"query","description":"returns an error for incorrect field grammar when set to true","example":"false","schema":{"type":"string"}},{"name":"all_fields","in":"query","description":"will show all fields for each elements","example":"1","schema":{"type":"boolean"}},{"name":"exclude","in":"query","description":"will exclude specified fields","schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}],"requestBody":{"content":{"application/json":{"example":[{"id":20483233},{"id":20483236}],"schema":{"type":"object","properties":{"id":{"type":"number","example":20483236}}}}}}},"post":{"responses":{"201":{"description":"Created","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"number","description":"the created element id"}},"required":["id"]},"examples":{"example1":{"value":{"id":20483233}},"example2":{"value":[{"id":20483236},{"id":20483245}]}}}}},"207":{"description":"Multi-Status - some items succeeded and some failed. The body is an array in request order (a list request body, even with one item, always answers a list); a failed item carries `error_message` instead of `id` and was not written.","headers":{},"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","description":"present when the item succeeded"},"error_message":{"type":"string","description":"present when the item failed"}}}},"example":[{"id":20483233},{"error_message":"Parameter 'sort_order' is invalid"}]}}},"400":{"description":"Bad Request - every item of a list request body failed. The body has the same shape as `207`, with `error_message` on each item; nothing was written. A single-object request body that fails answers the standard error object instead.","headers":{},"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/ApiError"},{"type":"array","items":{"type":"object","properties":{"error_message":{"type":"string"}},"required":["error_message"]}}]},"examples":{"all_failed":{"summary":"Every item of a list body failed","value":[{"error_message":"Parameter 'sort_order' is invalid"}]},"single_object":{"summary":"A single-object body failed","value":{"error_message":"Parameter 'sort_order' is invalid"}}}}}},"404":{"description":"Not Found - `page_id` does not exist or is not a page of `profile_id`.","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error_message":"The requested resource is not found"}}}}},"summary":"Create New Elements","operationId":"Create New Elements","description":"","tags":["Element Resource"],"parameters":[{"name":"profile_id","in":"path","description":"id of the profile","required":true,"example":"self","schema":{"type":"string"}},{"name":"page_id","in":"path","description":"id of the page","required":true,"schema":{"type":"number"}},{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}],"requestBody":{"content":{"application/json":{"examples":{"example1":{"value":{"name":"inspection_date","label":"Inspection Date and Time","data_type":5}},"example2":{"value":[{"name":"inspector_name","label":"Inspector Name","data_type":1,"sort_order":1},{"name":"photo_of_front_of_building","label":"Photo of Building","data_type":11,"sort_order":2}]}},"schema":{"type":"object","required":["name","label","data_type"],"properties":{"name":{"type":"string","example":"inspector_name"},"label":{"type":"string","example":"Inspector Name"},"description":{"type":"string"},"data_type":{"type":"number","example":1},"data_size":{"type":"number","example":50},"widget_type":{"type":"string"},"sort_order":{"type":"number","example":1},"optionlist_id":{"type":"number"},"default_value":{"type":"string"},"low_value":{"type":"number"},"high_value":{"type":"number"},"dynamic_value":{"type":"string","example":"iformbuilder.username"},"is_required":{"type":"boolean"},"condition_value":{"type":"string"},"client_validation":{"type":"string"},"is_disabled":{"type":"boolean"},"reference_id_1":{"type":"string"},"attachment_link":{"type":"string"},"is_readonly":{"type":"boolean"},"is_action":{"type":"boolean","example":true},"validation_message":{"type":"string"},"smart_tbl_search":{"type":"string"},"smart_tbl_search_col":{"type":"string"},"is_encrypt":{"type":"boolean"},"is_hide_typing":{"type":"boolean"},"keyboard_type":{"type":"number","example":1},"dynamic_label":{"type":"string"},"weighted_score":{"type":"number"}}}}}}}},"/profiles/{profile_id}/pages/{page_id}/elements/{element_id}/localizations/{language_code}":{"get":{"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"language_code":{"type":"string"},"label":{"type":"string"}},"required":["language_code","label"]},"example":{"language_code":"es","label":"nombre del Inspector"}}}}},"summary":"Retrieve an Element Localization","operationId":"Retrieve an Element Localization","description":"","tags":["Element Resource"],"parameters":[{"name":"profile_id","in":"path","description":"id of the profile","required":true,"example":"self","schema":{"type":"string"}},{"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"}},{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}]},"put":{"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"language_code":{"type":"string","description":"the updated language code"}},"required":["language_code"]},"example":{"language_code":"es"}}}}},"summary":"Update an Element Localization","operationId":"Update an Element Localization","description":"","tags":["Element Resource"],"parameters":[{"name":"profile_id","in":"path","description":"id of the profile","required":true,"example":"self","schema":{"type":"string"}},{"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"}},{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}],"requestBody":{"content":{"application/json":{"example":{"label":"nombre del Inspector"},"schema":{"type":"object","properties":{"label":{"type":"string","example":"nombre del Inspector"}}}}}}},"delete":{"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"language_code":{"type":"string","description":"the deleted language code"}},"required":["language_code"]},"example":{"language_code":"es"}}}}},"summary":"Delete a Element Localization","operationId":"Delete a Element Localization","description":"","tags":["Element Resource"],"parameters":[{"name":"profile_id","in":"path","description":"id of the profile","required":true,"example":"self","schema":{"type":"string"}},{"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"}},{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}]}},"/profiles/{profile_id}/pages/{page_id}/elements/{element_id}/localizations":{"get":{"responses":{"200":{"description":"OK","headers":{"Total-Count":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"language_code":{"type":"string"},"label":{"type":"string"}},"required":["language_code","label"]},"example":[{"language_code":"es","label":"nombre del Inspector"},{"language_code":"zh-hans","label":"检查人员"},{"language_code":"zh-hant","label":"檢查人員"}]}}}},"summary":"Retrieve a List of Element Localizations","operationId":"Retrieve a List of Element Localizations","description":"","tags":["Element Resource"],"parameters":[{"name":"profile_id","in":"path","description":"id of the profile","required":true,"example":"self","schema":{"type":"string"}},{"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","schema":{"type":"string"}},{"name":"limit","in":"query","description":"maximum count of the element localization list","example":"100","schema":{"type":"number"}},{"name":"offset","in":"query","description":"skip that many element localization before beginning to return","example":"0","schema":{"type":"number"}},{"name":"validate_grammar","in":"query","description":"returns an error for incorrect field grammar when set to true","example":"false","schema":{"type":"string"}},{"name":"all_fields","in":"query","description":"will show all fields for each element localization","example":"1","schema":{"type":"boolean"}},{"name":"exclude","in":"query","description":"will exclude specified fields","schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}]},"put":{"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"language_code":{"type":"string","description":"the updated language code"}},"required":["language_code"]},"example":[{"language_code":"zh-hans"},{"language_code":"zh-hant"}]}}},"207":{"description":"Multi-Status - some items succeeded and some failed. The body is an array in request order (a list request body, even with one item, always answers a list); a failed item carries `error_message` instead of `language_code` and was not written.","headers":{},"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"language_code":{"type":"string","description":"present when the item succeeded"},"error_message":{"type":"string","description":"present when the item failed"}}}},"example":[{"language_code":"es"},{"error_message":"Parameter 'language_code' is invalid"}]}}},"400":{"description":"Bad Request - every item of a list request body failed. The body has the same shape as `207`, with `error_message` on each item; nothing was written. A single-object request body that fails answers the standard error object instead.","headers":{},"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/ApiError"},{"type":"array","items":{"type":"object","properties":{"error_message":{"type":"string"}},"required":["error_message"]}}]},"examples":{"all_failed":{"summary":"Every item of a list body failed","value":[{"error_message":"Parameter 'language_code' is invalid"}]},"single_object":{"summary":"A single-object body failed","value":{"error_message":"Parameter 'language_code' is invalid"}}}}}}},"summary":"Update a List of Element Localizations","operationId":"Update a List of Element Localizations","description":"","tags":["Element Resource"],"parameters":[{"name":"profile_id","in":"path","description":"id of the profile","required":true,"example":"self","schema":{"type":"string"}},{"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","schema":{"type":"string"}},{"name":"limit","in":"query","description":"maximum count of the element localization list","example":"100","schema":{"type":"number"}},{"name":"offset","in":"query","description":"skip that many element localization before beginning to return","example":"0","schema":{"type":"number"}},{"name":"validate_grammar","in":"query","description":"returns an error for incorrect field grammar when set to true","example":"false","schema":{"type":"string"}},{"name":"all_fields","in":"query","description":"will show all fields for each element localization","example":"1","schema":{"type":"boolean"}},{"name":"exclude","in":"query","description":"will exclude specified fields","schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}],"requestBody":{"content":{"application/json":{"example":[{"language_code":"zh-hans","label":"检查人员"},{"language_code":"zh-hant","label":"檢查人員"}],"schema":{"type":"object","properties":{"language_code":{"type":"string","example":"es"},"label":{"type":"string","example":"nombre del Inspector"}}}}}}},"delete":{"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"language_code":{"type":"string","description":"the deleted language code"}},"required":["language_code"]},"example":[{"language_code":"zh-hans"},{"language_code":"zh-hant"}]}}},"207":{"description":"Multi-Status - some items succeeded and some failed. The body is an array in request order (a list request body, even with one item, always answers a list); a failed item carries `error_message` instead of `language_code` and was not written. An item whose row does not exist answers `The requested resource is not found`.","headers":{},"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"language_code":{"type":"string","description":"present when the item succeeded"},"error_message":{"type":"string","description":"present when the item failed"}}}},"example":[{"language_code":"es"},{"error_message":"Parameter 'language_code' is invalid"}]}}},"400":{"description":"Bad Request - every item of a list request body failed. The body has the same shape as `207`, with `error_message` on each item; nothing was written. A single-object request body that fails answers the standard error object instead.","headers":{},"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/ApiError"},{"type":"array","items":{"type":"object","properties":{"error_message":{"type":"string"}},"required":["error_message"]}}]},"examples":{"all_failed":{"summary":"Every item of a list body failed","value":[{"error_message":"Parameter 'language_code' is invalid"}]},"single_object":{"summary":"A single-object body failed","value":{"error_message":"Parameter 'language_code' is invalid"}}}}}}},"summary":"Delete a List of Element Localizations","operationId":"Delete a List of Element Localizations","description":"","tags":["Element Resource"],"parameters":[{"name":"profile_id","in":"path","description":"id of the profile","required":true,"example":"self","schema":{"type":"string"}},{"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","schema":{"type":"string"}},{"name":"limit","in":"query","description":"maximum count of the element localization list","example":"100","schema":{"type":"number"}},{"name":"offset","in":"query","description":"skip that many element localization before beginning to return","example":"0","schema":{"type":"number"}},{"name":"validate_grammar","in":"query","description":"returns an error for incorrect field grammar when set to true","example":"false","schema":{"type":"string"}},{"name":"all_fields","in":"query","description":"will show all fields for each element localization","example":"1","schema":{"type":"boolean"}},{"name":"exclude","in":"query","description":"will exclude specified fields","schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}],"requestBody":{"content":{"application/json":{"example":[{"language_code":"zh-hans"},{"language_code":"zh-hant"}],"schema":{"type":"object","properties":{"language_code":{"type":"string","example":"zh-hans"}}}}}}},"post":{"responses":{"201":{"description":"Created","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"language_code":{"type":"string","description":"the created language code"}},"required":["language_code"]},"examples":{"example1":{"value":{"language_code":"es"}},"example2":{"value":[{"language_code":"zh-hans"},{"language_code":"zh-hant"}]}}}}},"207":{"description":"Multi-Status - some items succeeded and some failed. The body is an array in request order (a list request body, even with one item, always answers a list); a failed item carries `error_message` instead of `language_code` and was not written.","headers":{},"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"language_code":{"type":"string","description":"present when the item succeeded"},"error_message":{"type":"string","description":"present when the item failed"}}}},"example":[{"language_code":"es"},{"error_message":"Parameter 'language_code' is invalid"}]}}},"400":{"description":"Bad Request - every item of a list request body failed. The body has the same shape as `207`, with `error_message` on each item; nothing was written. A single-object request body that fails answers the standard error object instead.","headers":{},"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/ApiError"},{"type":"array","items":{"type":"object","properties":{"error_message":{"type":"string"}},"required":["error_message"]}}]},"examples":{"all_failed":{"summary":"Every item of a list body failed","value":[{"error_message":"Parameter 'language_code' is invalid"}]},"single_object":{"summary":"A single-object body failed","value":{"error_message":"Parameter 'language_code' is invalid"}}}}}}},"summary":"Create New Element Localizations","operationId":"Create New Element Localizations","description":"","tags":["Element Resource"],"parameters":[{"name":"profile_id","in":"path","description":"id of the profile","required":true,"example":"self","schema":{"type":"string"}},{"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":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}],"requestBody":{"content":{"application/json":{"examples":{"example1":{"value":{"language_code":"es","label":"nombre del Inspector"}},"example2":{"value":[{"language_code":"zh-hans","label":"检查人员"},{"language_code":"zh-hant","label":"檢查人員"}]}},"schema":{"type":"object","required":["language_code","label"],"properties":{"language_code":{"type":"string","example":"es"},"label":{"type":"string","example":"nombre del Inspector"}}}}}}}},"/profiles/{profile_id}/pages/{page_id}/elements/{element_id}/dynamic_attributes/{dynamic_attribute}":{"get":{"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"dynamic_attribute: `12_24_hour_time`":{"type":"string"},"value":{"type":"string","description":"this value type can change based on dynamic attribute"},"type":{"type":"string","description":"will display what type the value has to be, for example string or number"},"last_modified_date":{"type":"string","description":"04-02T02:07:29+00:00\" - Last time this attribute was modified"}},"required":["dynamic_attribute: `12_24_hour_time`","value","type"]}}}}},"summary":"Retrieve an Element Dynamic Attribute","operationId":"Retrieve an Element Dynamic Attribute","description":"","tags":["Element Resource"],"parameters":[{"name":"profile_id","in":"path","description":"id of the profile","required":true,"example":"self","schema":{"type":"string"}},{"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"}},{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}]},"put":{"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"attribute_name: `12_24_hour_time`":{"type":"string","description":"the updated dynamic attribute"}},"required":["attribute_name: `12_24_hour_time`"]},"example":{"dynamic_attribute":"12_24_hour_time"}}}}},"summary":"Update an Element Dynamic Attribute","operationId":"Update an Element Dynamic Attribute","description":"","tags":["Element Resource"],"parameters":[{"name":"profile_id","in":"path","description":"id of the profile","required":true,"example":"self","schema":{"type":"string"}},{"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"}},{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}],"requestBody":{"content":{"application/json":{"example":{"value":"24hr"},"schema":{"type":"object","properties":{"value":{"type":"string","example":"24hr"}}}}}}},"delete":{"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"attribute_name: `12_24_hour_time`":{"type":"string","description":"the deleted dynamic_attribute"}},"required":["attribute_name: `12_24_hour_time`"]},"example":{"attribute_name":"12_24_hour_time"}}}}},"summary":"Delete an Element Attribute","operationId":"Delete an Element Attribute","description":"","tags":["Element Resource"],"parameters":[{"name":"profile_id","in":"path","description":"id of the profile","required":true,"example":"self","schema":{"type":"string"}},{"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"}},{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}]}},"/profiles/{profile_id}/pages/{page_id}/elements/{element_id}/dynamic_attributes":{"get":{"responses":{"200":{"description":"OK","headers":{"Total-Count":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"attribute_name: `12_24_hour_time`":{"type":"string"},"value":{"type":"string","description":"returned value type can differ based on dynamic attribute"}},"required":["attribute_name: `12_24_hour_time`","value"]},"example":[{"attribute_name":"12_24_hour_time","value":"12hr","type":"string","last_modified_date":"2019-04-11T15:42:58+00:00"},{"attribute_name":"gdpr","value":true,"type":"boolean","last_modified_date":"2019-04-11T15:42:58+00:00"}]}}}},"summary":"Retrieve a List of Element Dynamic Attributes","operationId":"Retrieve a List of Element Dynamic Attributes","description":"","tags":["Element Resource"],"parameters":[{"name":"profile_id","in":"path","description":"id of the profile","required":true,"example":"self","schema":{"type":"string"}},{"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","schema":{"type":"string"}},{"name":"limit","in":"query","description":"maximum count of the element dynamic attribute list","example":"100","schema":{"type":"number"}},{"name":"offset","in":"query","description":"skip that many element dynamic attribute before beginning to return","example":"0","schema":{"type":"number"}},{"name":"validate_grammar","in":"query","description":"returns an error for incorrect field grammar when set to true","example":"false","schema":{"type":"string"}},{"name":"all_fields","in":"query","description":"will show all fields for each element dynamic attribute","example":"1","schema":{"type":"boolean"}},{"name":"exclude","in":"query","description":"will exclude specified fields","schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}]},"put":{"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"attribute_name: `12_24_hour_time`":{"type":"string","description":"the updated attribute name"}},"required":["attribute_name: `12_24_hour_time`"]},"example":[{"attribute_name":"12_24_hour_time"},{"attribute_name":"gdpr"}]}}}},"summary":"Update a List of Element Dynamic Attributes","operationId":"Update a List of Element Dynamic Attributes","description":"","tags":["Element Resource"],"parameters":[{"name":"profile_id","in":"path","description":"id of the profile","required":true,"example":"self","schema":{"type":"string"}},{"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","schema":{"type":"string"}},{"name":"limit","in":"query","description":"maximum count of the element dynamic attribute list","example":"100","schema":{"type":"number"}},{"name":"offset","in":"query","description":"skip that many element dynamic attribute before beginning to return","example":"0","schema":{"type":"number"}},{"name":"validate_grammar","in":"query","description":"returns an error for incorrect field grammar when set to true","example":"false","schema":{"type":"string"}},{"name":"all_fields","in":"query","description":"will show all fields for each element dynamic attribute","example":"1","schema":{"type":"boolean"}},{"name":"exclude","in":"query","description":"will exclude specified fields","schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}],"requestBody":{"content":{"application/json":{"example":[{"attribute_name":"12_24_hour_time","value":"24hr"},{"attribute_name":"gdpr","value":false}],"schema":{"type":"object","required":["attribute_name: `12_24_hour_time`","value"],"properties":{"attribute_name: `12_24_hour_time`":{"type":"string"},"value":{"type":"string","example":"24hr","description":"- value validation (ie. string or boolean) could change based on specific element dynamic attribute."}}}}}}},"delete":{"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"language_code":{"type":"string","description":"the deleted language code"}},"required":["language_code"]},"example":[{"attribute_name":"time_settting"},{"attribute_name":"gdpr"}]}}},"207":{"description":"Multi-Status - some items succeeded and some failed. The body is an array in request order (a list request body, even with one item, always answers a list); a failed item carries `error_message` instead of `attribute_name` and was not written. An item whose row does not exist answers `The requested resource is not found`.","headers":{},"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"attribute_name":{"type":"string","description":"present when the item succeeded"},"error_message":{"type":"string","description":"present when the item failed"}}}},"example":[{"attribute_name":"map_priority"},{"error_message":"The requested resource is not found"}]}}},"400":{"description":"Bad Request - every item of a list request body failed. The body has the same shape as `207`, with `error_message` on each item; nothing was written. A single-object request body that fails answers the standard error object instead.","headers":{},"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/ApiError"},{"type":"array","items":{"type":"object","properties":{"error_message":{"type":"string"}},"required":["error_message"]}}]},"examples":{"all_failed":{"summary":"Every item of a list body failed","value":[{"error_message":"The requested resource is not found"}]},"single_object":{"summary":"A single-object body failed","value":{"error_message":"The requested resource is not found"}}}}}}},"summary":"Delete a List of Element Dynamic Attributes","operationId":"Delete a List of Element Dynamic Attributes","description":"","tags":["Element Resource"],"parameters":[{"name":"profile_id","in":"path","description":"id of the profile","required":true,"example":"self","schema":{"type":"string"}},{"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","schema":{"type":"string"}},{"name":"limit","in":"query","description":"maximum count of the element dynamic attribute list","example":"100","schema":{"type":"number"}},{"name":"offset","in":"query","description":"skip that many element dynamic attribute before beginning to return","example":"0","schema":{"type":"number"}},{"name":"validate_grammar","in":"query","description":"returns an error for incorrect field grammar when set to true","example":"false","schema":{"type":"string"}},{"name":"all_fields","in":"query","description":"will show all fields for each element dynamic attribute","example":"1","schema":{"type":"boolean"}},{"name":"exclude","in":"query","description":"will exclude specified fields","schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}],"requestBody":{"content":{"application/json":{"example":[{"attribute_name":"time_settting"},{"attribute_name":"gdpr"}],"schema":{"type":"object","required":["attribute_name"],"properties":{"attribute_name":{"type":"string","example":"``"}}}}}}},"post":{"responses":{"201":{"description":"Created","headers":{},"content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"attribute_name":{"type":"string","description":"created element dynamic attribute"}},"required":["attribute_name"]},{"type":"object","properties":{"attribute_name: `12_24_hour_time`":{"type":"string","description":"created element dynamic attribute"}},"required":["attribute_name: `12_24_hour_time`"]}]},"examples":{"example1":{"value":{"attribute_name":"12_24_hour_time"}},"example2":{"value":[{"attribute_name":"12_24_hour_time"},{"attribute_name":"gdpr"}]}}}}}},"summary":"Create New Element Attribute","operationId":"Create New Element Attribute","description":"\u003ch2\u003eList of Valid Element Dynamic Attributes\u003c/h2\u003e\n\n\u003cli\u003eTo find out what elements have dynamic attributes and what values are accepted, take a look \u003ca href=\"https://zerion.my.site.com/helpcenter/s/article/WhatareDynamicAttributes66b5c2e6410ec#dynamic\" target=\"_blank\" rel=\"noopener\"\u003ehere\u003c/a\u003e.\u003c/li\u003e","tags":["Element Resource"],"parameters":[{"name":"profile_id","in":"path","description":"id of the profile","required":true,"example":"self","schema":{"type":"string"}},{"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":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}],"requestBody":{"content":{"application/json":{"examples":{"example1":{"value":{"attribute_name":"12_24_hour_time","value":"12hr"}},"example2":{"value":[{"attribute_name":"12_24_hour_time","value":"12hr"},{"attribute_name":"gdpr","value":true}]}},"schema":{"type":"object","required":["attribute_name: `12_24_hour_time`","value"],"properties":{"attribute_name: `12_24_hour_time`":{"type":"string"},"value":{"type":"string","example":"12hr","description":"value validation (ie. string or boolean) could change based on specific element dynamic attribute."}}}}}}}},"/profiles/{profile_id}/optionlists/{optionlist_id}":{"get":{"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"},"global_id":{"type":"string"},"version":{"type":"number"},"created_date":{"type":"string"},"created_by: `demo_user`":{"type":"string"},"modified_date":{"type":"string"},"modified_by: `demo_user`":{"type":"string"},"reference_id":{"type":"string"},"option_icons":{"type":"string"}},"required":["id","name","global_id","version","created_date","created_by: `demo_user`","modified_date","modified_by: `demo_user`","reference_id","option_icons"]},"example":{"id":393655,"name":"System Grade","global_id":"0OL393655H6488B","version":3,"created_date":"2015-05-12T22:04:03+00:00","created_by":"demo_user","modified_date":"2015-05-12T22:08:45+00:00","modified_by":"demo_user","reference_id":"","option_icons":"dropbox://iForm"}}}}},"summary":"Retrieve an Optionlist","operationId":"Retrieve an Optionlist","description":"","tags":["Optionlist Resource"],"parameters":[{"name":"profile_id","in":"path","description":"id of the profile","required":true,"example":"self","schema":{"type":"string"}},{"name":"optionlist_id","in":"path","description":"id of the optionlist","required":true,"schema":{"type":"number"}},{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}]},"put":{"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"number","description":"the updated optionlist id"}},"required":["id"]},"example":{"id":393655}}}}},"summary":"Update an Optionlist","operationId":"Update an Optionlist","description":"","tags":["Optionlist Resource"],"parameters":[{"name":"profile_id","in":"path","description":"id of the profile","required":true,"example":"self","schema":{"type":"string"}},{"name":"optionlist_id","in":"path","description":"id of the optionlist","required":true,"schema":{"type":"number"}},{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}],"requestBody":{"content":{"application/json":{"example":{"option_icons":"dropbox://iForm"},"schema":{"type":"object","properties":{"name":{"type":"string","example":"System Grade"},"reference_id":{"type":"string"},"option_icons":{"type":"string","example":"dropbox://iForm"}}}}}}},"delete":{"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"number","description":"the deleted optionlist id"}},"required":["id"]},"example":{"id":393655}}}}},"summary":"Delete an Optionlist","operationId":"Delete an Optionlist","description":"","tags":["Optionlist Resource"],"parameters":[{"name":"profile_id","in":"path","description":"id of the profile","required":true,"example":"self","schema":{"type":"string"}},{"name":"optionlist_id","in":"path","description":"id of the optionlist","required":true,"schema":{"type":"number"}},{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}]},"post":{"responses":{"201":{"description":"Created","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"number","description":"the copied optionlist id"}},"required":["id"]},"example":{"id":393658}}}}},"summary":"Copy an Optionlist","operationId":"Copy an Optionlist","description":"**Note:** This operation uses the non-standard HTTP `COPY` method. It is documented under `POST` because OpenAPI does not support custom HTTP methods — send the actual request with the `COPY` verb.\n\n","tags":["Optionlist Resource"],"parameters":[{"name":"profile_id","in":"path","description":"id of the profile","required":true,"example":"self","schema":{"type":"string"}},{"name":"optionlist_id","in":"path","description":"id of the optionlist","required":true,"schema":{"type":"number"}},{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}],"x-original-http-method":"COPY"}},"/profiles/{profile_id}/optionlists":{"get":{"responses":{"200":{"description":"OK","headers":{"Total-Count":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"},"global_id":{"type":"string"},"version":{"type":"number"},"created_date":{"type":"string"},"created_by: `demo_user`":{"type":"string"},"modified_date":{"type":"string"},"modified_by: `demo_user`":{"type":"string"},"reference_id":{"type":"string"},"option_icons":{"type":"string"}},"required":["id","name"]},"example":[{"id":393652,"name":"Colors"},{"id":393655,"name":"System Grade"}]}}},"400":{"description":"Bad Request - `limit` or `offset` is not an integer.","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error_message":"'limit' must be an integer"}}}}},"summary":"Retrieve a List of Optionlists","operationId":"Retrieve a List of Optionlists","description":"","tags":["Optionlist Resource"],"parameters":[{"name":"profile_id","in":"path","description":"id of the profile","required":true,"example":"self","schema":{"type":"string"}},{"name":"fields","in":"query","description":"extra information of each optionlist on the list","schema":{"type":"string"}},{"name":"limit","in":"query","description":"maximum count of the optionlist list","example":"100","schema":{"type":"number"}},{"name":"offset","in":"query","description":"skip that many optionlists before beginning to return","example":"0","schema":{"type":"number"}},{"name":"validate_grammar","in":"query","description":"returns an error for incorrect field grammar when set to true","example":"false","schema":{"type":"string"}},{"name":"all_fields","in":"query","description":"will show all fields for each optionlists","example":"1","schema":{"type":"boolean"}},{"name":"exclude","in":"query","description":"will exclude specified fields","schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}]},"post":{"responses":{"201":{"description":"Created","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"number","description":"the created option list id"}},"required":["id"]},"example":{"id":393655}}}}},"summary":"Create New a New Optionlist","operationId":"Create New a New Optionlist","description":"","tags":["Optionlist Resource"],"parameters":[{"name":"profile_id","in":"path","description":"id of the profile","required":true,"example":"self","schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}],"requestBody":{"content":{"application/json":{"example":{"name":"System Grade"},"schema":{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"System Grade"},"reference_id":{"type":"string"},"option_icons":{"type":"string","example":"dropbox://iForm"}}}}}}}},"/profiles/{profile_id}/optionlists/{optionlist_id}/options/{option_id}":{"get":{"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"number"},"key_value":{"type":"string"},"global_id":{"type":"string"},"label":{"type":"string"},"sort_order":{"type":"number"},"condition_value":{"type":"string"},"score":{"type":"number"},"is_disabled":{"type":"boolean","description":"true once a record has used the option on a dwindling option list (ZCOptions.IS_DISABLED). Read-only. Request it with fields=is_disabled, or filter with fields=is_disabled(=\"0\") to hide used options."},"localizations":{}},"required":["id","key_value","global_id","label","sort_order","condition_value","score","is_disabled","localizations"]},"example":{"id":268623880,"key_value":"na","global_id":"0O268623880HD6ED5","label":"N/A","sort_order":0,"condition_value":"false","score":0,"is_disabled":false,"localizations":[]}}}}},"summary":"Retrieve an Option","operationId":"Retrieve an Option","description":"","tags":["Optionlist Resource"],"parameters":[{"name":"profile_id","in":"path","description":"id of the profile","required":true,"example":"self","schema":{"type":"string"}},{"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"}},{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}]},"put":{"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"number","description":"the updated option id"}},"required":["id"]},"example":{"id":268623880}}}}},"summary":"Update an Option","operationId":"Update an Option","description":"","tags":["Optionlist Resource"],"parameters":[{"name":"profile_id","in":"path","description":"id of the profile","required":true,"example":"self","schema":{"type":"string"}},{"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"}},{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}],"requestBody":{"content":{"application/json":{"example":{"condition_value":"false","score":0},"schema":{"type":"object","properties":{"key_value":{"type":"string","example":"na"},"label":{"type":"string","example":"N/A"},"sort_order":{"type":"number"},"condition_value":{"type":"string","example":"false"},"score":{"type":"number"}}}}}}},"delete":{"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"number","description":"the deleted option id"}},"required":["id"]},"example":{"id":268623880}}}}},"summary":"Delete an Option","operationId":"Delete an Option","description":"","tags":["Optionlist Resource"],"parameters":[{"name":"profile_id","in":"path","description":"id of the profile","required":true,"example":"self","schema":{"type":"string"}},{"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"}},{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}]}},"/profiles/{profile_id}/optionlists/{optionlist_id}/options":{"get":{"responses":{"200":{"description":"OK","headers":{"Total-Count":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"number"},"key_value":{"type":"string"},"global_id":{"type":"string"},"label":{"type":"string"},"sort_order":{"type":"number"},"condition_value":{"type":"string"},"score":{"type":"number"},"is_disabled":{"type":"boolean","description":"true once a record has used the option on a dwindling option list (ZCOptions.IS_DISABLED). Read-only. Request it with fields=is_disabled, or filter with fields=is_disabled(=\"0\") to hide used options."},"localizations":{}},"required":["id","key_value"]},"example":[{"id":268623883,"key_value":"pass"},{"id":268623886,"key_value":"fail"},{"id":268623880,"key_value":"na"}]}}}},"summary":"Retrieve a List of Options","operationId":"Retrieve a List of Options","description":"","tags":["Optionlist Resource"],"parameters":[{"name":"profile_id","in":"path","description":"id of the profile","required":true,"example":"self","schema":{"type":"string"}},{"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","schema":{"type":"string"}},{"name":"limit","in":"query","description":"maximum count of the profile list","example":"100","schema":{"type":"number"}},{"name":"offset","in":"query","description":"skip that many profiles before beginning to return","example":"0","schema":{"type":"number"}},{"name":"validate_grammar","in":"query","description":"returns an error for incorrect field grammar when set to true","example":"false","schema":{"type":"string"}},{"name":"all_fields","in":"query","description":"will show all fields for each profiles","example":"1","schema":{"type":"boolean"}},{"name":"exclude","in":"query","description":"will exclude specified fields","schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}]},"put":{"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"number","description":"the updated option id"}},"required":["id"]},"example":[{"id":268623883},{"id":268623886},{"id":268623880}]}}},"207":{"description":"Multi-Status - some items succeeded and some failed. The body is an array in request order (a list request body, even with one item, always answers a list); a failed item carries `error_message` instead of `id` and was not written.","headers":{},"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","description":"present when the item succeeded"},"error_message":{"type":"string","description":"present when the item failed"}}}},"example":[{"id":1},{"error_message":"Parameter 'id' is invalid"}]}}},"400":{"description":"Bad Request - every item of a list request body failed. The body has the same shape as `207`, with `error_message` on each item; nothing was written. A single-object request body that fails answers the standard error object instead.","headers":{},"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/ApiError"},{"type":"array","items":{"type":"object","properties":{"error_message":{"type":"string"}},"required":["error_message"]}}]},"examples":{"all_failed":{"summary":"Every item of a list body failed","value":[{"error_message":"Parameter 'id' is invalid"}]},"single_object":{"summary":"A single-object body failed","value":{"error_message":"Parameter 'id' is invalid"}}}}}}},"summary":"Update a List of Options","operationId":"Update a List of Options","description":"","tags":["Optionlist Resource"],"parameters":[{"name":"profile_id","in":"path","description":"id of the profile","required":true,"example":"self","schema":{"type":"string"}},{"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","schema":{"type":"string"}},{"name":"limit","in":"query","description":"maximum count of the profile list","example":"100","schema":{"type":"number"}},{"name":"offset","in":"query","description":"skip that many profiles before beginning to return","example":"0","schema":{"type":"number"}},{"name":"validate_grammar","in":"query","description":"returns an error for incorrect field grammar when set to true","example":"false","schema":{"type":"string"}},{"name":"all_fields","in":"query","description":"will show all fields for each profiles","example":"1","schema":{"type":"boolean"}},{"name":"exclude","in":"query","description":"will exclude specified fields","schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}],"requestBody":{"content":{"application/json":{"examples":{"example1":{"value":[{"id":268623883,"sort_order":0},{"id":268623886,"sort_order":1},{"id":268623880,"sort_order":2}]},"example2":{"value":{"condition_value":""}}},"schema":{"type":"object","properties":{"id":{"type":"number","example":268623880},"key_value":{"type":"string","example":"na"},"label":{"type":"string","example":"N/A"},"sort_order":{"type":"number"},"condition_value":{"type":"string","example":"false"},"score":{"type":"number"}}}}}}},"delete":{"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"number","description":"the deleted option id"}},"required":["id"]},"example":[{"id":268623886},{"id":268623880}]}}},"207":{"description":"Multi-Status - some items succeeded and some failed. The body is an array in request order (a list request body, even with one item, always answers a list); a failed item carries `error_message` instead of `id` and was not written. An item whose row does not exist answers `The requested resource is not found`.","headers":{},"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","description":"present when the item succeeded"},"error_message":{"type":"string","description":"present when the item failed"}}}},"example":[{"id":1},{"error_message":"Parameter 'id' is invalid"}]}}},"400":{"description":"Bad Request - every item of a list request body failed. The body has the same shape as `207`, with `error_message` on each item; nothing was written. A single-object request body that fails answers the standard error object instead.","headers":{},"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/ApiError"},{"type":"array","items":{"type":"object","properties":{"error_message":{"type":"string"}},"required":["error_message"]}}]},"examples":{"all_failed":{"summary":"Every item of a list body failed","value":[{"error_message":"Parameter 'id' is invalid"}]},"single_object":{"summary":"A single-object body failed","value":{"error_message":"Parameter 'id' is invalid"}}}}}}},"summary":"Delete a List of Options","operationId":"Delete a List of Options","description":"","tags":["Optionlist Resource"],"parameters":[{"name":"profile_id","in":"path","description":"id of the profile","required":true,"example":"self","schema":{"type":"string"}},{"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","schema":{"type":"string"}},{"name":"limit","in":"query","description":"maximum count of the profile list","example":"100","schema":{"type":"number"}},{"name":"offset","in":"query","description":"skip that many profiles before beginning to return","example":"0","schema":{"type":"number"}},{"name":"validate_grammar","in":"query","description":"returns an error for incorrect field grammar when set to true","example":"false","schema":{"type":"string"}},{"name":"all_fields","in":"query","description":"will show all fields for each profiles","example":"1","schema":{"type":"boolean"}},{"name":"exclude","in":"query","description":"will exclude specified fields","schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}],"requestBody":{"content":{"application/json":{"example":[{"id":268623886},{"id":268623880}],"schema":{"type":"object","properties":{"id":{"type":"number","example":268623880}}}}}}},"post":{"responses":{"201":{"description":"Created","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"number","description":"the created option id"}},"required":["id"]},"examples":{"example1":{"value":{"id":268623880}},"example2":{"value":[{"id":268623883},{"id":268623886}]}}}}},"207":{"description":"Multi-Status - some items succeeded and some failed. The body is an array in request order (a list request body, even with one item, always answers a list); a failed item carries `error_message` instead of `id` and was not written.","headers":{},"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","description":"present when the item succeeded"},"error_message":{"type":"string","description":"present when the item failed"}}}},"example":[{"id":1},{"error_message":"Parameter 'sort_order' is invalid"}]}}},"400":{"description":"Bad Request - every item of a list request body failed. The body has the same shape as `207`, with `error_message` on each item; nothing was written. A single-object request body that fails answers the standard error object instead.","headers":{},"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/ApiError"},{"type":"array","items":{"type":"object","properties":{"error_message":{"type":"string"}},"required":["error_message"]}}]},"examples":{"all_failed":{"summary":"Every item of a list body failed","value":[{"error_message":"Parameter 'sort_order' is invalid"}]},"single_object":{"summary":"A single-object body failed","value":{"error_message":"Parameter 'sort_order' is invalid"}}}}}}},"summary":"Create New Options","operationId":"Create New Options","description":"","tags":["Optionlist Resource"],"parameters":[{"name":"profile_id","in":"path","description":"id of the profile","required":true,"example":"self","schema":{"type":"string"}},{"name":"optionlist_id","in":"path","description":"id of the option list","required":true,"schema":{"type":"number"}},{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}],"requestBody":{"content":{"application/json":{"examples":{"example1":{"value":{"key_value":"na","label":"N/A","sort_order":0}},"example2":{"value":[{"key_value":"pass","label":"Pass","sort_order":1},{"key_value":"fail","label":"Fail","sort_order":2}]}},"schema":{"type":"object","required":["key_value","label"],"properties":{"key_value":{"type":"string","example":"na"},"label":{"type":"string","example":"N/A"},"sort_order":{"type":"number"},"condition_value":{"type":"string","example":"false"},"score":{"type":"number"}}}}}}}},"/profiles/{profile_id}/optionlists/{optionlist_id}/options/{option_id}/localizations/{language_code}":{"get":{"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"language_code":{"type":"string"},"label":{"type":"string"}},"required":["language_code","label"]},"example":{"language_code":"es","label":"fallar"}}}}},"summary":"Retrieve a Option Localization","operationId":"Retrieve a Option Localization","description":"","tags":["Optionlist Resource"],"parameters":[{"name":"profile_id","in":"path","description":"id of the profile","required":true,"example":"self","schema":{"type":"string"}},{"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"}},{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}]},"put":{"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"language_code":{"type":"string","description":"the updated language code"}},"required":["language_code"]},"example":{"language_code":"es"}}}}},"summary":"Update a Option Localization","operationId":"Update a Option Localization","description":"","tags":["Optionlist Resource"],"parameters":[{"name":"profile_id","in":"path","description":"id of the profile","required":true,"example":"self","schema":{"type":"string"}},{"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"}},{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}],"requestBody":{"content":{"application/json":{"example":{"label":"fallar"},"schema":{"type":"object","properties":{"label":{"type":"string","example":"fallar"}}}}}}},"delete":{"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"language_code":{"type":"string","description":"the deleted language code"}},"required":["language_code"]},"example":{"language_code":"es"}}}}},"summary":"Delete a Option Localization","operationId":"Delete a Option Localization","description":"","tags":["Optionlist Resource"],"parameters":[{"name":"profile_id","in":"path","description":"id of the profile","required":true,"example":"self","schema":{"type":"string"}},{"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"}},{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}]}},"/profiles/{profile_id}/optionlists/{optionlist_id}/options/{option_id}/localizations":{"get":{"responses":{"200":{"description":"OK","headers":{"Total-Count":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"language_code":{"type":"string"},"label":{"type":"string"}},"required":["language_code","label"]},"example":[{"language_code":"es","label":"fallar"},{"language_code":"zh-hans","label":"失败"},{"language_code":"zh-hant","label":"失敗"}]}}}},"summary":"Retrieve a List of Option Localizations","operationId":"Retrieve a List of Option Localizations","description":"","tags":["Optionlist Resource"],"parameters":[{"name":"profile_id","in":"path","description":"id of the profile","required":true,"example":"self","schema":{"type":"string"}},{"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","schema":{"type":"string"}},{"name":"limit","in":"query","description":"maximum count of the option localization list","example":"100","schema":{"type":"number"}},{"name":"offset","in":"query","description":"skip that many option localization before beginning to return","example":"0","schema":{"type":"number"}},{"name":"validate_grammar","in":"query","description":"returns an error for incorrect field grammar when set to true","example":"false","schema":{"type":"string"}},{"name":"all_fields","in":"query","description":"will show all fields for each option localization","example":"1","schema":{"type":"boolean"}},{"name":"exclude","in":"query","description":"will exclude specified fields","schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}]},"put":{"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"language_code":{"type":"string","description":"the updated language code"}},"required":["language_code"]},"example":[{"language_code":"zh-hans"},{"language_code":"zh-hant"}]}}},"207":{"description":"Multi-Status - some items succeeded and some failed. The body is an array in request order (a list request body, even with one item, always answers a list); a failed item carries `error_message` instead of `language_code` and was not written.","headers":{},"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"language_code":{"type":"string","description":"present when the item succeeded"},"error_message":{"type":"string","description":"present when the item failed"}}}},"example":[{"language_code":"es"},{"error_message":"Parameter 'language_code' is invalid"}]}}},"400":{"description":"Bad Request - every item of a list request body failed. The body has the same shape as `207`, with `error_message` on each item; nothing was written. A single-object request body that fails answers the standard error object instead.","headers":{},"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/ApiError"},{"type":"array","items":{"type":"object","properties":{"error_message":{"type":"string"}},"required":["error_message"]}}]},"examples":{"all_failed":{"summary":"Every item of a list body failed","value":[{"error_message":"Parameter 'language_code' is invalid"}]},"single_object":{"summary":"A single-object body failed","value":{"error_message":"Parameter 'language_code' is invalid"}}}}}}},"summary":"Update a List of Option Localizations","operationId":"Update a List of Option Localizations","description":"","tags":["Optionlist Resource"],"parameters":[{"name":"profile_id","in":"path","description":"id of the profile","required":true,"example":"self","schema":{"type":"string"}},{"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","schema":{"type":"string"}},{"name":"limit","in":"query","description":"maximum count of the option localization list","example":"100","schema":{"type":"number"}},{"name":"offset","in":"query","description":"skip that many option localization before beginning to return","example":"0","schema":{"type":"number"}},{"name":"validate_grammar","in":"query","description":"returns an error for incorrect field grammar when set to true","example":"false","schema":{"type":"string"}},{"name":"all_fields","in":"query","description":"will show all fields for each option localization","example":"1","schema":{"type":"boolean"}},{"name":"exclude","in":"query","description":"will exclude specified fields","schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}],"requestBody":{"content":{"application/json":{"example":[{"language_code":"zh-hans","label":"失败"},{"language_code":"zh-hant","label":"失敗"}],"schema":{"type":"object","properties":{"language_code":{"type":"string","example":"es"},"label":{"type":"string","example":"fallar"}}}}}}},"delete":{"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"language_code":{"type":"string","description":"the deleted language code"}},"required":["language_code"]},"example":[{"language_code":"zh-hans"},{"language_code":"zh-hant"}]}}},"207":{"description":"Multi-Status - some items succeeded and some failed. The body is an array in request order (a list request body, even with one item, always answers a list); a failed item carries `error_message` instead of `language_code` and was not written. An item whose row does not exist answers `The requested resource is not found`.","headers":{},"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"language_code":{"type":"string","description":"present when the item succeeded"},"error_message":{"type":"string","description":"present when the item failed"}}}},"example":[{"language_code":"es"},{"error_message":"Parameter 'language_code' is invalid"}]}}},"400":{"description":"Bad Request - every item of a list request body failed. The body has the same shape as `207`, with `error_message` on each item; nothing was written. A single-object request body that fails answers the standard error object instead.","headers":{},"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/ApiError"},{"type":"array","items":{"type":"object","properties":{"error_message":{"type":"string"}},"required":["error_message"]}}]},"examples":{"all_failed":{"summary":"Every item of a list body failed","value":[{"error_message":"Parameter 'language_code' is invalid"}]},"single_object":{"summary":"A single-object body failed","value":{"error_message":"Parameter 'language_code' is invalid"}}}}}}},"summary":"Delete a List of Option Localizations","operationId":"Delete a List of Option Localizations","description":"","tags":["Optionlist Resource"],"parameters":[{"name":"profile_id","in":"path","description":"id of the profile","required":true,"example":"self","schema":{"type":"string"}},{"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","schema":{"type":"string"}},{"name":"limit","in":"query","description":"maximum count of the option localization list","example":"100","schema":{"type":"number"}},{"name":"offset","in":"query","description":"skip that many option localization before beginning to return","example":"0","schema":{"type":"number"}},{"name":"validate_grammar","in":"query","description":"returns an error for incorrect field grammar when set to true","example":"false","schema":{"type":"string"}},{"name":"all_fields","in":"query","description":"will show all fields for each option localization","example":"1","schema":{"type":"boolean"}},{"name":"exclude","in":"query","description":"will exclude specified fields","schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}],"requestBody":{"content":{"application/json":{"example":[{"language_code":"zh-hans"},{"language_code":"zh-hant"}],"schema":{"type":"object","properties":{"language_code":{"type":"string","example":"zh-hans"}}}}}}},"post":{"responses":{"201":{"description":"Created","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"language_code":{"type":"string","description":"the created language code"}},"required":["language_code"]},"examples":{"example1":{"value":{"language_code":"es"}},"example2":{"value":[{"language_code":"zh-hans"},{"language_code":"zh-hant"}]}}}}},"207":{"description":"Multi-Status - some items succeeded and some failed. The body is an array in request order (a list request body, even with one item, always answers a list); a failed item carries `error_message` instead of `language_code` and was not written.","headers":{},"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"language_code":{"type":"string","description":"present when the item succeeded"},"error_message":{"type":"string","description":"present when the item failed"}}}},"example":[{"language_code":"es"},{"error_message":"Parameter 'language_code' is invalid"}]}}},"400":{"description":"Bad Request - every item of a list request body failed. The body has the same shape as `207`, with `error_message` on each item; nothing was written. A single-object request body that fails answers the standard error object instead.","headers":{},"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/ApiError"},{"type":"array","items":{"type":"object","properties":{"error_message":{"type":"string"}},"required":["error_message"]}}]},"examples":{"all_failed":{"summary":"Every item of a list body failed","value":[{"error_message":"Parameter 'language_code' is invalid"}]},"single_object":{"summary":"A single-object body failed","value":{"error_message":"Parameter 'language_code' is invalid"}}}}}}},"summary":"Create New Option Localizations","operationId":"Create New Option Localizations","description":"","tags":["Optionlist Resource"],"parameters":[{"name":"profile_id","in":"path","description":"id of the profile","required":true,"example":"self","schema":{"type":"string"}},{"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":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}],"requestBody":{"content":{"application/json":{"examples":{"example1":{"value":{"language_code":"es","label":"fallar"}},"example2":{"value":[{"language_code":"zh-hans","label":"失败"},{"language_code":"zh-hant","label":"失敗"}]}},"schema":{"type":"object","required":["language_code","label"],"properties":{"language_code":{"type":"string","example":"es"},"label":{"type":"string","example":"fallar"}}}}}}}},"/profiles/{profile_id}/pages/{page_id}/records/{record_id}":{"get":{"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"number"},"parent_record_id":{"type":"number"},"parent_page_id":{"type":"number"},"parent_element_id":{"type":"number"},"created_date":{"type":"string"},"created_by: `demo_user`":{"type":"string"},"created_location":{"type":"string"},"created_device_id":{"type":"string"},"modified_date":{"type":"string"},"modified_by: `demo_user`":{"type":"string"},"modified_location":{"type":"string"},"modified_device_id":{"type":"string"},"server_modified_date":{"type":"string"},"javascript_state":{"type":"string"}},"required":["id","parent_record_id","parent_page_id","parent_element_id","created_date","created_by: `demo_user`","created_location","created_device_id","modified_date","modified_by: `demo_user`","modified_location","modified_device_id","server_modified_date","javascript_state"]},"example":{"id":1,"parent_record_id":0,"parent_page_id":0,"parent_element_id":0,"created_date":"2015-05-14T15:59:42+00:00","created_by":"demo_user","created_location":"API","created_device_id":"API","modified_date":"2015-05-14T16:08:21+00:00","modified_by":"demo_user","modified_location":"API","modified_device_id":"API","server_modified_date":"2015-05-14T16:08:21+00:00","javascript_state":"{}","inspection_date":"2015-05-12T14:38:19+00:00","inspector_name":"Demo User","photo_of_front_of_building":"https://example.com/media/building_inspection/field_photo.jpg","comments":"building exterior"}}}}},"summary":"Retrieve a Record","operationId":"Retrieve a Record","description":"","tags":["Record Resource"],"parameters":[{"name":"profile_id","in":"path","description":"id of the profile","required":true,"example":"self","schema":{"type":"string"}},{"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'.","example":"desc","schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}]},"put":{"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"number","description":"the updated record id"}},"required":["id"]},"example":{"id":1}}}}},"summary":"Update a Record","operationId":"Update a Record","description":"","tags":["Record Resource"],"parameters":[{"name":"profile_id","in":"path","description":"id of the profile","required":true,"example":"self","schema":{"type":"string"}},{"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":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}],"requestBody":{"content":{"application/json":{"example":{"fields":[{"element_name":"photo_of_front_of_building","extension":"jpg","encoding":"url","value":"http://upload.wikimedia.org/wikipedia/commons/0/04/Garfield_Building_Detroit.jpg"},{"element_name":"comments","value":"building exterior"}]},"schema":{"type":"object","required":["fields.value"],"properties":{"fields":{"type":"array","items":{},"description":"an array that contains record fields"},"fields.element_name: `inspector_name`":{"type":"string","description":"must have either element_name or element_id set"},"fields.element_id":{"type":"number","example":2048326},"fields.value":{"type":"string","example":"Demo User"},"fields.extension":{"type":"string","example":"jpg","description":"file extension, if applicable"},"fields.encoding":{"type":"string","example":"url","description":"must match \"base64\", \"url\""},"device_id":{"type":"string","example":"API"},"javascript_state":{"type":"string","example":"{}"}}}}}}},"delete":{"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"number","description":"the deleted record id"}},"required":["id"]},"example":{"id":1}}}}},"summary":"Delete a Record","operationId":"Delete a Record","description":"","tags":["Record Resource"],"parameters":[{"name":"profile_id","in":"path","description":"id of the profile","required":true,"example":"self","schema":{"type":"string"}},{"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":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}]},"post":{"responses":{"201":{"description":"Created","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"number","description":"the deleted record id"}},"required":["id"]},"example":{"id":1}}}}},"summary":"Copy a Record","operationId":"Copy a Record","description":"**Note:** This operation uses the non-standard HTTP `COPY` method. It is documented under `POST` because OpenAPI does not support custom HTTP methods — send the actual request with the `COPY` verb.\n\n","tags":["Record Resource"],"parameters":[{"name":"profile_id","in":"path","description":"id of the profile","required":true,"example":"self","schema":{"type":"string"}},{"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":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}],"x-original-http-method":"COPY"}},"/profiles/{profile_id}/pages/{page_id}/records":{"get":{"responses":{"200":{"description":"OK","headers":{"Total-Count":{"description":"number of records matching the request filters, ignoring `limit` and `offset`","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"number"},"parent_record_id":{"type":"number"},"parent_page_id":{"type":"number"},"parent_element_id":{"type":"number"},"created_date":{"type":"string"},"created_by: `demo_user`":{"type":"string"},"created_location":{"type":"string"},"created_device_id":{"type":"string"},"modified_date":{"type":"string"},"modified_by: `demo_user`":{"type":"string"},"modified_location":{"type":"string"},"modified_device_id":{"type":"string"},"server_modified_date":{"type":"string"},"javascript_state":{"type":"string"}},"required":["id"]},"example":[{"id":7},{"id":4},{"id":1}]}}},"400":{"description":"Bad Request - `limit` or `offset` is not an integer.","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error_message":"'limit' must be an integer"}}}},"404":{"description":"Not Found - `page_id` does not exist or is not a page of `profile_id`.","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error_message":"The requested resource is not found"}}}},"500":{"description":"Internal Server Error - the record count for `Total-Count` could not be read. The request fails rather than report a count of 0.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"summary":"Retrieve a List of Records","operationId":"Retrieve a List of Records","description":"","tags":["Record Resource"],"parameters":[{"name":"profile_id","in":"path","description":"id of the profile","required":true,"example":"self","schema":{"type":"string"}},{"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","schema":{"type":"string"}},{"name":"limit","in":"query","description":"maximum count of the record list","example":"100","schema":{"type":"number"}},{"name":"offset","in":"query","description":"skip that many record before beginning to return","example":"0","schema":{"type":"number"}},{"name":"validate_grammar","in":"query","description":"returns an error for incorrect field grammar when set to true","example":"false","schema":{"type":"string"}},{"name":"all_fields","in":"query","description":"will show all fields for each record","example":"1","schema":{"type":"boolean"}},{"name":"exclude","in":"query","description":"will exclude specified fields","schema":{"type":"string"}},{"name":"subform_order","in":"query","description":"order of subform records.  Use 'asc' or 'desc'.","example":"desc","schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}]},"put":{"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"number","description":"the updated record id"}},"required":["id"]},"example":[{"id":4},{"id":7}]}}},"207":{"description":"Multi-Status - some records were updated and some failed. The body is an array in request order; a failed item carries `error_message` instead of `id` and was not written. A record that does not exist answers `The requested resource is not found`; a record whose values fail validation answers the same list of errors the single-record PUT returns, and its values are not stored.","headers":{},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/RecordWriteOutcome"}},"example":[{"id":4},{"error_message":[{"field_value":"quantity","error_message":"Parameter 'value' is invalid"}]}]}}},"400":{"description":"Bad Request - every record failed (each was missing or failed validation). The body has the same shape as `207`, with `error_message` on each item; nothing was written.","headers":{},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/RecordWriteOutcome"}}}}},"404":{"description":"Not Found - `page_id` does not exist or is not a page of `profile_id`.","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error_message":"The requested resource is not found"}}}}},"summary":"Update a List of Records","operationId":"Update a List of Records","description":"","tags":["Record Resource"],"parameters":[{"name":"profile_id","in":"path","description":"id of the profile","required":true,"example":"self","schema":{"type":"string"}},{"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","schema":{"type":"string"}},{"name":"limit","in":"query","description":"maximum count of the record list","example":"100","schema":{"type":"number"}},{"name":"offset","in":"query","description":"skip that many record before beginning to return","example":"0","schema":{"type":"number"}},{"name":"validate_grammar","in":"query","description":"returns an error for incorrect field grammar when set to true","example":"false","schema":{"type":"string"}},{"name":"all_fields","in":"query","description":"will show all fields for each record","example":"1","schema":{"type":"boolean"}},{"name":"exclude","in":"query","description":"will exclude specified fields","schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}],"requestBody":{"content":{"application/json":{"examples":{"example1":{"value":[{"id":4,"fields":[{"element_name":"comments","value":"no picture was taken"}]},{"id":7,"fields":[{"element_name":"photo_of_front_of_building","extension":"jpg","encoding":"url","value":"http://cupegraf.com/data_images/wallpapers/6/310051-building.jpg"},{"element_name":"comments","value":"under sunlight"}]}]},"example2":{"value":{"fields":[{"element_name":"comments","value":"no picture was taken"},{"element_name":"notes","value":"no notes were taken"}]}}},"schema":{"type":"object","required":["fields.value"],"properties":{"id":{"type":"number","example":4},"fields":{"type":"array","items":{},"description":"an array that contains record fields"},"fields.element_name: `inspector_name`":{"type":"string","description":"must have either element_name or element_id set"},"fields.element_id":{"type":"string","example":"20483236"},"fields.value":{"type":"string","example":"Demo User"},"fields.extension":{"type":"string","example":"jpg","description":"file extension, if applicable"},"fields.encoding":{"type":"string","example":"url","description":"must match \"base64\", \"url\""},"device_id":{"type":"string","example":"API"},"javascript_state":{"type":"string","example":"{}"}}}}}}},"delete":{"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"number","description":"the deleted record id"}},"required":["id"]},"example":[{"id":4},{"id":7}]}}},"404":{"description":"Not Found - `page_id` does not exist or is not a page of `profile_id`.","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error_message":"The requested resource is not found"}}}}},"summary":"Delete a List of Records","operationId":"Delete a List of Records","description":"","tags":["Record Resource"],"parameters":[{"name":"profile_id","in":"path","description":"id of the profile","required":true,"example":"self","schema":{"type":"string"}},{"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","schema":{"type":"string"}},{"name":"limit","in":"query","description":"maximum count of the record list","example":"100","schema":{"type":"number"}},{"name":"offset","in":"query","description":"skip that many record before beginning to return","example":"0","schema":{"type":"number"}},{"name":"validate_grammar","in":"query","description":"returns an error for incorrect field grammar when set to true","example":"false","schema":{"type":"string"}},{"name":"all_fields","in":"query","description":"will show all fields for each record","example":"1","schema":{"type":"boolean"}},{"name":"exclude","in":"query","description":"will exclude specified fields","schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}],"requestBody":{"content":{"application/json":{"example":[{"id":4},{"id":7}],"schema":{"type":"object","properties":{"id":{"type":"number","example":4}}}}}}},"post":{"responses":{"201":{"description":"Created","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"number","description":"the created record id"}},"required":["id"]},"examples":{"example1":{"value":{"id":1}},"example2":{"value":[{"id":4},{"id":7}]}}}}},"404":{"description":"Not Found - `page_id` does not exist or is not a page of `profile_id`.","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error_message":"The requested resource is not found"}}}}},"summary":"Create New Records","operationId":"Create New Records","description":"","tags":["Record Resource"],"parameters":[{"name":"profile_id","in":"path","description":"id of the profile","required":true,"example":"self","schema":{"type":"string"}},{"name":"page_id","in":"path","description":"id of the page","required":true,"schema":{"type":"number"}},{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}],"requestBody":{"content":{"application/json":{"examples":{"example1":{"value":{"fields":[{"element_name":"inspection_date","value":"2015-05-12T14:38:19+00:00"},{"element_name":"photo_of_front_of_building","extension":"jpg","encoding":"url","value":"http://upload.wikimedia.org/wikipedia/commons/0/04/Garfield_Building_Detroit.jpg"}]}},"example2":{"value":[{"fields":[{"element_name":"inspection_date","value":"2015-05-14T16:13:46+00:00"},{"element_name":"photo_of_front_of_building","extension":"jpg","encoding":"url","value":"http://upload.wikimedia.org/wikipedia/commons/0/04/Garfield_Building_Detroit.jpg"}]},{"fields":[{"element_name":"inspection_date","value":"2015-06-02T14:22:12+00:00"},{"element_name":"photo_of_front_of_building","extension":"jpg","encoding":"url","value":"http://upload.wikimedia.org/wikipedia/commons/0/04/Garfield_Building_Detroit.jpg"}]}]}},"schema":{"type":"object","required":["fields.value"],"properties":{"parent_record_id":{"type":"number"},"parent_page_id":{"type":"number"},"parent_element_id":{"type":"number"},"fields":{"type":"array","items":{},"description":"an array that contains record fields"},"fields.element_name: `inspector_name`":{"type":"string","description":"must have either element_name or element_id set"},"fields.element_id":{"type":"string","example":"20483236"},"fields.value":{"type":"string","example":"Demo User"},"fields.extension":{"type":"string","example":"jpg","description":"file extension, if applicable"},"fields.encoding":{"type":"string","example":"url","description":"must match \"base64\", \"url\""},"device_id":{"type":"string","example":"API"},"javascript_state":{"type":"string","example":"{}"}}}}}}}},"/profiles/{profile_id}/pages/{page_id}/records/{record_id}/assignments/{user_id}":{"get":{"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"user_id":{"type":"number"}},"required":["user_id"]}}}}},"summary":"Retrieve a Record Assignment","operationId":"Retrieve a Record Assignment","description":"","tags":["Record Resource"],"parameters":[{"name":"profile_id","in":"path","description":"id of the profile","required":true,"example":"self","schema":{"type":"string"}},{"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"}},{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}]},"delete":{"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"user_id":{"type":"number","description":"the deleted user id"}},"required":["user_id"]},"example":{"user_id":161236}}}}},"summary":"Delete a Record Assignment","operationId":"Delete a Record Assignment","description":"","tags":["Record Resource"],"parameters":[{"name":"profile_id","in":"path","description":"id of the profile","required":true,"example":"self","schema":{"type":"string"}},{"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"}},{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}]}},"/profiles/{profile_id}/pages/{page_id}/records/{record_id}/media":{"delete":{"responses":{"202":{"description":"Accepted - every named element was handled and at least one blob deletion was queued (`DELETE_QUEUED`). The stored values are already cleared; the S3 objects are removed asynchronously.","headers":{},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/RecordMediaOutcome"}},"example":[{"element_name":"photo_1","status":"DELETE_QUEUED","urls":["https://zerion-iform-media-example.s3.amazonaws.com/app/67890/_data67890_inspection_form/field_1234.png"]},{"element_name":"signature_1","status":"NO_MEDIA"}]}}},"200":{"description":"OK - every named element was handled and nothing was queued, either because every element was already empty (`NO_MEDIA`) or because the media deletion queue is disabled on this server (`VALUE_CLEARED`, the value is gone but the blob is not).","headers":{},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/RecordMediaOutcome"}},"example":[{"element_name":"photo_1","status":"NO_MEDIA"}]}}},"207":{"description":"Multi-Status - some elements failed and some did not, or the values were cleared but the deletion queue refused the request (`VALUE_CLEARED` with `reason` `QUEUE_FAILED`). Same body shape as `202`; inspect each item's `status`.","headers":{},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/RecordMediaOutcome"}},"example":[{"element_name":"photo_1","status":"DELETE_QUEUED","urls":["https://zerion-iform-media-example.s3.amazonaws.com/app/67890/_data67890_inspection_form/field_1234.png"]},{"element_name":"drawing_1","status":"DELETE_FAILED","reason":"MEDIA_NOT_HOSTED_ON_S3","url":"https://www.dropbox.com/s/abc123/drawing.png"}]}}},"400":{"description":"Bad Request - the body was empty or not a list of element names, an element name is not on the page, an element is not one of the five supported media types (standard error object body naming the element; nothing is changed), or every named element failed (same outcome array as `202`).","headers":{},"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/ApiError"},{"type":"array","items":{"$ref":"#/components/schemas/RecordMediaOutcome"}}]},"examples":{"invalid_element":{"summary":"An element is not on the page or is not a supported media element (nothing changed)","value":{"error_message":"Element 'attachment_1' does not hold media this endpoint can delete."}},"empty_body":{"summary":"The body is empty or not a list of element names (nothing changed)","value":{"error_message":"Request body must contain a list of element names whose media should be deleted."}},"all_failed":{"summary":"Every named element was refused (same outcome array as 202)","value":[{"element_name":"drawing_1","status":"DELETE_FAILED","reason":"MEDIA_NOT_HOSTED_ON_S3","url":"https://www.dropbox.com/s/abc123/drawing.png"}]}}}}},"401":{"description":"Unauthorized - missing or invalid bearer token.","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error_message":"Invalid access token"}}}},"403":{"description":"Forbidden - the user cannot delete records on this page, or `profile_id` is not the caller's own profile.","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error_message":"User does not have the required permission"}}}},"404":{"description":"Not Found - `page_id` is not a valid page id, the page does not belong to `profile_id`, or `record_id` does not exist on the page.","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error_message":"The requested resource is not found"}}}},"413":{"description":"Payload Too Large - more than 200 element names were submitted. Split the batch and retry.","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error_message":"Batch ceiling exceeded (max 200). Send fewer element names per request."}}}}},"summary":"Delete Record Media","operationId":"Delete Record Media","description":"Deletes the media held by named elements of a single record: clears each element's stored value on the record and queues the underlying Amazon S3 object for deletion. Use this when one photo, signature, drawing, sound clip or multi-photo set must be removed without deleting the record. The generic record `PUT` cannot do this: it never touches the blob and cannot clear a `multi_photo` field at all.\n\n### Request body\n\nSend a JSON array of element names, `[\"photo_1\", \"signature_1\"]`. Also accepted: an array of `{ \"element_name\": ... }` objects, a single `{ \"element_name\": ... }` object, and either of those wrapped as `{ \"fields\": [...] }`. Names are trimmed and de-duplicated. A request may name **at most 200 elements**; 201 or more returns `413` and nothing is changed.\n\nEvery named element must exist on the page and be an **image**, **signature**, **sound**, **drawing** or **multi_photo** element. Any other element (attachment, third-party file upload, a non-media field, a name not on the page) fails the whole request with `400` naming the element, and no data changes.\n\n### What is deleted\n\nThe URLs are never supplied by the caller; they are read from what the record holds. Only objects in Amazon S3 are deleted (public `https://...amazonaws.com/...` URLs and `privates3://` URLs) and only when the object key sits under this page's media prefix (`{profile_id}/{data_table_name}`). Media held in the customer's own storage (Box, Dropbox, Google Drive, OneDrive, SharePoint), on Rackspace Cloud Files, or under another page's prefix is refused per element and the stored value is left exactly as it was. A `multi_photo` element is all-or-nothing: if any one of its URLs is refused, the whole element is refused.\n\nThe stored values are written first, in one statement for the whole record, and only then is the blob deletion queued, so a failed write never leaves a queued deletion behind. The record's `modified_by`, `modified_date` and `server_modified_date` are updated and the page's record version moves so devices pick up the change.\n\n### Response\n\nA plain JSON array with one entry per distinct element, in request order. Each entry has `element_name` and `status`; `urls` is added on `DELETE_QUEUED` and `VALUE_CLEARED`, and `reason` plus the single offending `url` on `DELETE_FAILED`.\n\n| `status` | `reason` | Meaning |\n|---|---|---|\n| `DELETE_QUEUED` | - | Value cleared; every URL in `urls` was handed to the deletion queue. |\n| `VALUE_CLEARED` | -, `QUEUE_FAILED` | Value cleared but the blob was **not** deleted: the deletion queue is disabled on this server (no `reason`), or it refused the request (`QUEUE_FAILED`). Keep `urls` if you need to clean up or restore. |\n| `NO_MEDIA` | - | The element already held no media. A no-op success, so replaying a request is idempotent. |\n| `DELETE_FAILED` | `MEDIA_NOT_HOSTED_ON_S3`, `URL_OUT_OF_SCOPE` | Refused; nothing changed for this element. `url` names the first URL that was not an S3 object, or that is not keyed under this page. |\n\n### HTTP status\n\n- `202` no element failed and at least one deletion was queued\n- `200` no element failed and nothing was queued (`NO_MEDIA` only, or the queue is disabled)\n- `207` some elements failed and some did not, or the values were cleared but the queue refused the request\n- `400` every element failed, or the body/element names were invalid (nothing changed)\n- `413` more than 200 element names in one request\n- `401` no valid bearer token\n- `403` no record-delete permission on the page, or another profile's `profile_id`\n- `404` invalid `page_id`, the page does not belong to the profile, or the record does not exist\n\n### Authorization\n\nStandard bearer token. The caller must be allowed to **delete records** on the page: the same rule as `DELETE .../records/{record_id}`, including access inherited through a parent form and the standalone Delete Records role. Unlike `POST .../media_restore`, BASIC users are not denied outright; a BASIC user who may delete records on the page may delete their media.\n\n### Recovering deleted media\n\nDeletion of the S3 object is reversible for as long as the bucket's version retention keeps it: pass the `urls` from this response to `POST .../pages/{page_id}/media_restore`. Restoring the object does **not** re-attach it to the record; the element's stored value stays empty. Keep the `urls` from this response if you may need to restore.","tags":["Record Resource"],"parameters":[{"name":"profile_id","in":"path","description":"id of the profile","required":true,"example":"self","schema":{"type":"string"}},{"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":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}],"requestBody":{"required":true,"content":{"application/json":{"examples":{"names":{"summary":"Array of element names","value":["photo_1","signature_1"]},"objects":{"summary":"Array of element_name objects","value":[{"element_name":"photo_1"},{"element_name":"signature_1"}]},"single":{"summary":"Single object","value":{"element_name":"photo_1"}}},"schema":{"oneOf":[{"type":"array","maxItems":200,"items":{"type":"string","description":"name of an image, signature, sound, drawing or multi_photo element on the page"}},{"type":"array","maxItems":200,"items":{"type":"object","required":["element_name"],"properties":{"element_name":{"type":"string"}}}},{"type":"object","required":["element_name"],"properties":{"element_name":{"type":"string"}}}]}}}}}},"/profiles/{profile_id}/pages/{page_id}/records/{record_id}/assignments":{"get":{"responses":{"200":{"description":"OK","headers":{"Total-Count":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"user_id":{"type":"number"}},"required":["user_id"]},"example":[{"user_id":161236},{"user_id":161239},{"user_id":161242}]}}}},"summary":"Retrieve a List of Record Assignments","operationId":"Retrieve a List of Record Assignments","description":"","tags":["Record Resource"],"parameters":[{"name":"profile_id","in":"path","description":"id of the profile","required":true,"example":"self","schema":{"type":"string"}},{"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","schema":{"type":"string"}},{"name":"limit","in":"query","description":"maximum count of the page assignment list","example":"100","schema":{"type":"number"}},{"name":"offset","in":"query","description":"skip that many page assignment before beginning to return","example":"0","schema":{"type":"number"}},{"name":"validate_grammar","in":"query","description":"returns an error for incorrect field grammar when set to true","example":"false","schema":{"type":"string"}},{"name":"all_fields","in":"query","description":"will show all fields for each page assignment","example":"1","schema":{"type":"boolean"}},{"name":"exclude","in":"query","description":"will exclude specified fields","schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}]},"delete":{"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"user_id":{"type":"number","description":"the deleted user id"}},"required":["user_id"]},"example":[{"user_id":161239},{"user_id":161242}]}}}},"summary":"Delete a List of Record Assignments","operationId":"Delete a List of Record Assignments","description":"","tags":["Record Resource"],"parameters":[{"name":"profile_id","in":"path","description":"id of the profile","required":true,"example":"self","schema":{"type":"string"}},{"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","schema":{"type":"string"}},{"name":"limit","in":"query","description":"maximum count of the page assignment list","example":"100","schema":{"type":"number"}},{"name":"offset","in":"query","description":"skip that many page assignment before beginning to return","example":"0","schema":{"type":"number"}},{"name":"validate_grammar","in":"query","description":"returns an error for incorrect field grammar when set to true","example":"false","schema":{"type":"string"}},{"name":"all_fields","in":"query","description":"will show all fields for each page assignment","example":"1","schema":{"type":"boolean"}},{"name":"exclude","in":"query","description":"will exclude specified fields","schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}],"requestBody":{"content":{"application/json":{"example":[{"user_id":161239},{"user_id":161242}],"schema":{"type":"object","properties":{"user_id":{"type":"number","example":161239}}}}}}},"post":{"responses":{"201":{"description":"Created","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"user_id":{"type":"number","description":"the created user id"}},"required":["user_id"]},"examples":{"example1":{"value":{"user_id":161236}},"example2":{"value":[{"user_id":161239},{"user_id":161242}]}}}}}},"summary":"Create New Record Assignments","operationId":"Create New Record Assignments","description":"","tags":["Record Resource"],"parameters":[{"name":"profile_id","in":"path","description":"id of the profile","required":true,"example":"self","schema":{"type":"string"}},{"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":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}],"requestBody":{"content":{"application/json":{"examples":{"example1":{"value":{"user_id":161236}},"example2":{"value":[{"username":"iformuser"},{"user_id":161242}]}},"schema":{"type":"object","properties":{"user_id":{"type":"number","example":161236,"description":"Must provide user id or username"},"username":{"type":"string","example":"user","description":"Must provide user id or username"}}}}}}}},"/profiles/{profile_id}/notifications":{"post":{"responses":{"201":{"description":"Created","headers":{},"content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"id":{"type":"array","description":"The user id the message is sent to.","items":{}}},"required":["id"]},{"type":"object","properties":{"id":{"type":"number","description":"the created user id"}},"required":["id"]}]},"example":{"id":[2435467,7564532]}}}}},"summary":"Send Notifications","operationId":"Send Notifications","description":"","tags":["Notification Resource"],"parameters":[{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}],"requestBody":{"content":{"application/json":{"examples":{"example1":{"value":{"message":"Sync Device","users":[2435467,7564532]}},"example2":{"value":[{"message":"Please sync your device","users":[161227]},{"message":"Please upload any records.","users":[243567,756432]}]}},"schema":{"type":"object","required":["message","users"],"properties":{"message":{"type":"string","example":"Please sync to update form"},"users":{"type":"array","items":{}}}}}}}}},"/profiles/{profile_id}/media":{"get":{"responses":{"200":{"description":"OK - the file's raw bytes with the stored `Content-Type`.","headers":{},"content":{"*/*":{"schema":{"type":"string","format":"binary"}}}},"400":{"description":"Bad Request - the `url` names a storage path with a dot segment (`.`/`..`), a `privatecloudfiles://` path with an empty target or a dot segment, `?`, `#` or control character, or a connector id (`OneDriveApi:`, `SharePointApi:`, `GoogleDriveApi:`, `DropboxApi:`) containing a dot segment, `?`, `#` or a control character.","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Unauthorized - missing or invalid bearer token.","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Forbidden - the caller cannot access `profile_id`, or a `privates3://` url names a bucket outside the server's private media buckets (`mediaAWSS3Info.privateMediaBucket` plus `oldPrivateMediaBucketList`), or a `privatecloudfiles://` url names a country, region and container outside the server's private Cloud Files locations (`mediaPrivateMainServerLocationInfo`, `mediaPrivateBackupServerLocationInfo` plus `oldPrivateCloudFilesLocationList`), or either names a server other than this one or one in `oldServerIdList`, or (for a caller without server scope) another profile.","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Not Found - the object does not exist or is empty, or the `url` is not a recognised private media reference.","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"Conflict - the profile's cloud-drive connection must be reconnected (reconnect required).","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"502":{"description":"Bad Gateway - storage failed for a reason other than a missing object (any other S3 or Cloud Files error), or a Box/Dropbox host failed, timed out, redirected outside the provider, or was still answering 202 after 3 attempts.","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"summary":"Get Media","operationId":"Get Media","description":"Streams a private media file referenced by a record's image/file field. The `url` is the stored value: `privates3://`, `privatecloudfiles://`, `OneDriveApi:`, `SharePointApi:`, `GoogleDriveApi:`, `DropboxApi:`, or a Box (`https://*.box.com/shared/static/...`) or Dropbox (`https://*.dropbox.com/...?raw=1`) link. Box and Dropbox links are fetched only from their own hosts, over HTTPS, with bounded retries and timeouts.","tags":["Private Media Resource"],"parameters":[{"name":"profile_id","in":"path","description":"id of the profile","required":true,"example":"self","schema":{"type":"string"}},{"name":"url","in":"query","description":"URL of the private media file, as returned in a record's image/file field","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}]}},"/profiles/{profile_id}/licenses/{license_id}":{"get":{"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"number"},"username":{"type":"string"},"device_id":{"type":"string"},"device_last_login_user: `demo_user`":{"type":"string"},"device_last_login_date":{"type":"string"},"device_notification_token":{"type":"string"},"device_model":{"type":"string"},"device_system_version":{"type":"string"},"application_name":{"type":"string"},"application_version":{"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"]},"example":{"id":196111,"username":"demo_user","device_id":"d174b4c64f6f358a3b19bfca4558eb1d9d3e265f","device_last_login_user":"demo_user","device_last_login_date":"2019-05-23T15:52:15+00:00","device_notification_token":"78f48ac3 6765c07c 0d53bbd7 97d6b61b 0e9d50ee e5d7522e 06bb8787 870e26fb","device_model":"iPad Pro","device_system_version":"12.1.1","application_name":"iForm","application_version":"8.32.0"}}}}},"summary":"Retrieve a Device License","operationId":"Retrieve a Device License","description":"","tags":["Device License Resource"],"parameters":[{"name":"profile_id","in":"path","description":"id of the profile","required":true,"example":"self","schema":{"type":"string"}},{"name":"license_id","in":"path","description":"id of the device license","required":true,"example":"198392","schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}]}},"/profiles/{profile_id}/licenses":{"get":{"responses":{"200":{"description":"OK","headers":{"Total-Count":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"number"},"username":{"type":"string"},"device_id":{"type":"string"},"device_last_login_user: `demo_user`":{"type":"string"},"device_last_login_date":{"type":"string"},"device_notification_token":{"type":"string"},"device_model":{"type":"string"},"device_system_version":{"type":"string"},"application_name":{"type":"string"},"application_version":{"type":"string"}},"required":["id","username","device_id"]},"example":[{"id":161236,"username":"demo_user","device_id":"d174b4c64f6f358a3b19bfca4558eb1d9d3e265f"},{"id":161236,"username":"demo_user","device_id":"d174b4c64f6f358a3b19bfca4558eb1d9d3e265f"},{"id":161242,"username":"inspector_2","device_id":"d174b4c64f6f358a3b19bfca4558eb1d9d3e265f"}]}}}},"summary":"Retrieve a List of Device Licenses","operationId":"Retrieve a List of Device Licenses","description":"","tags":["Device License Resource"],"parameters":[{"name":"profile_id","in":"path","description":"id of the profile","required":true,"example":"self","schema":{"type":"string"}},{"name":"fields","in":"query","description":"extra information of each user on the list","schema":{"type":"string"}},{"name":"limit","in":"query","description":"maximum count of the user list","example":"100","schema":{"type":"number"}},{"name":"offset","in":"query","description":"skip that many users before beginning to return","example":"0","schema":{"type":"number"}},{"name":"validate_grammar","in":"query","description":"returns an error for incorrect field grammar when set to true","example":"false","schema":{"type":"string"}},{"name":"all_fields","in":"query","description":"will show all fields for each users","example":"1","schema":{"type":"boolean"}},{"name":"exclude","in":"query","description":"will exclude specified fields","schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}]}},"/transaction_log":{"get":{"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"username":{"type":"string"},"date":{"type":"string"},"description":{"type":"string"},"last_updated":{"type":"string"}},"required":["username","date","description","last_updated"]}}}},"400":{"description":"Bad Request - `limit` or `offset` is not an integer.","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error_message":"'limit' must be an integer"}}}}},"summary":"Retrieve a Device Transaction Log","operationId":"Retrieve a Device Transaction Log","description":"","tags":["Device Transaction Log Resource"],"parameters":[{"name":"fields","in":"query","description":"filter and/or select response fields. Use `fields=\u003cfieldname\u003e(=\"\u003cvalue\u003e\")` to filter by any available field. Multiple filters can be combined with a comma. Example: `fields=username(=\"demo_user\"),profile_id(=\"12345\")`. Filterable fields: `username`, `date`, `action`, `description`, `last_updated`, `server_id`, `profile_id`","schema":{"type":"string"}},{"name":"limit","in":"query","description":"maximum number of results to return","example":"1000","schema":{"type":"number"}},{"name":"offset","in":"query","description":"skip that many records before beginning to return","example":"0","schema":{"type":"number"}},{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}]}},"/async_transaction_log":{"get":{"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"number"},"server_id":{"type":"string"},"profile_id":{"type":"number"},"username":{"type":"string"},"request_time":{"type":"string"},"request_version":{"type":"string"},"remote_address":{"type":"string"},"request_uri: `/exzact/api/v81/profiles/self/pages/1234/trigger_posts`":{"type":"string"},"request_function: `SERVER_POST_XML`":{"type":"string"},"request_method":{"type":"string"}},"required":["id","server_id","profile_id","username","request_time","request_version","remote_address","request_uri: `/exzact/api/v81/profiles/self/pages/1234/trigger_posts`","request_function: `SERVER_POST_XML`","request_method"]},"example":{"id":1,"server_id":"app","profile_id":12345,"username":"testuser","request_time":"2024-05-13T20:28:34+00:00","request_version":"1","remote_address":"203.0.113.5","request_uri":"/exzact/api/v81/profiles/self/pages/1234/trigger_posts","request_function":"SERVER_POST_XML","request_method":"POST"}}}},"400":{"description":"Bad Request - `limit` or `offset` is not an integer.","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error_message":"'limit' must be an integer"}}}}},"summary":"Retrieve an Async Transaction Log","operationId":"Retrieve an Async Transaction Log","description":"","tags":["Async Transaction Log Resource"],"parameters":[{"name":"fields","in":"query","description":"filter and/or select response fields. Use `fields=\u003cfieldname\u003e(=\"\u003cvalue\u003e\")` to filter by any available field. Multiple filters can be combined with a comma. Example: `fields=username(=\"testuser\"),profile_id(=\"12345\")`. Filterable fields: `id`, `server_id`, `profile_id`, `username`, `request_time`, `request_version`, `remote_address`, `request_uri`, `request_function`, `request_method`","schema":{"type":"string"}},{"name":"limit","in":"query","description":"maximum number of results to return","example":"1000","schema":{"type":"number"}},{"name":"offset","in":"query","description":"skip that many records before beginning to return","example":"0","schema":{"type":"number"}},{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}]}},"/async_transaction_log/daily_summary":{"get":{"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"array","items":{}},"example":[{"request_count":69,"request_uri":"/exzact/_triggerFormPostAction.php?t=abc123\u0026PAGE_ID=290829043"},{"request_count":7,"request_uri":"/exzact/api/v81/loadapp/profiles/363674/pages/290856497/elements/283233000"}]}}},"400":{"description":"Bad Request - `limit` or `offset` is not an integer.","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"},"example":{"error_message":"'limit' must be an integer"}}}}},"summary":"Retrieve an Async Transaction Log Daily Summary","operationId":"Retrieve an Async Transaction Log Daily Summary","description":"Returns API usage grouped by endpoint for a given day, ordered by request count descending. Each result shows how many times a particular `request_uri` was called. Useful for self-serve API usage reporting without requiring support.","tags":["Async Transaction Log Resource"],"parameters":[{"name":"fields","in":"query","description":"filter and/or select response fields. Use `fields=\u003cfieldname\u003e(=\"\u003cvalue\u003e\")` to filter by any available field. Use `~` instead of `=` for LIKE/partial matching: `fields=request_uri(~\"%pattern%\")`. Multiple filters can be combined with a comma. Example: `fields=request_time(=\"2026-04-22\"),request_uri(~\"%/pages/%\")`. Filterable fields: `request_time` (date or datetime — time portion is ignored), `request_uri`, `request_function`, `username`. If `request_time` is omitted, defaults to today (UTC).","schema":{"type":"string"}},{"name":"limit","in":"query","description":"maximum number of results to return","example":"50","schema":{"type":"number"}},{"name":"offset","in":"query","description":"skip that many records before beginning to return","example":"0","schema":{"type":"number"}},{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}]}},"/mapbox/settings":{"get":{"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MapboxSettings"},"example":{"enabled":true,"user":"zerion","api_key_last4":"9XyZ","map_type":"streets-v11","map_types":["streets-v11","satellite-v9"],"profile_default_threshold":500,"server_mapview_limit":2000}}}},"401":{"description":"Unauthorized - missing or invalid bearer token.","headers":{},"content":{}},"403":{"description":"Forbidden - the client is not internal, or the user's role is not allowed (see Authorization).","headers":{},"content":{}},"409":{"description":"Conflict - Mapbox is not enabled on this server.","headers":{},"content":{}}},"summary":"Retrieve Mapbox Settings","operationId":"Retrieve Mapbox Settings","description":"Returns the server's Mapbox integration settings. The Mapbox secret key is never returned: `api_key_last4` carries its last four characters only (`null` when no key is stored, `\"\"` when the stored key is four characters or shorter).\n\n`map_types` lists the map types `map_type` may take. `server_mapview_limit` is the server-wide map-view cap; a negative value means no cap.\n\n### Authorization\n\nInternal API clients only. On a ZWS-integrated server, COMPANY and SERVER users are allowed; on any other server, SERVER users only. The role check runs before the enabled check, so a disallowed user gets `403` even when Mapbox is disabled.","tags":["Mapbox Resource"],"parameters":[{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}]},"put":{"responses":{"200":{"description":"OK - the settings were saved. The body is the updated settings, in the same shape as `GET`.","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MapboxSettings"},"example":{"enabled":true,"user":"zerion","api_key_last4":"Ab12","map_type":"satellite-v9","map_types":["streets-v11","satellite-v9"],"profile_default_threshold":250,"server_mapview_limit":2000}}}},"400":{"description":"Bad Request - the body is not a JSON object, a field is empty or of the wrong type, `map_type` is not one of `map_types`, or `profile_default_threshold` is below 0 while `server_mapview_limit` is 0 or more.","headers":{},"content":{}},"401":{"description":"Unauthorized - missing or invalid bearer token.","headers":{},"content":{}},"403":{"description":"Forbidden - the client is not internal, or the user's role is not allowed (see Authorization).","headers":{},"content":{}},"409":{"description":"Conflict - Mapbox is not enabled on this server.","headers":{},"content":{}}},"summary":"Update Mapbox Settings","operationId":"Update Mapbox Settings","description":"Updates the server's Mapbox integration settings. Every field is optional; an omitted field keeps its stored value. In particular, omit `api_key` to keep the stored key.\n\nAfter the merge, `api_key`, `user` and `map_type` must all be non-empty, and `map_type` must be one of the server's `map_types`. `profile_default_threshold` must be an integer of 0 or more, unless `server_mapview_limit` is negative.\n\n### Authorization\n\nSame as `GET /mapbox/settings`: internal API clients only; COMPANY or SERVER users on a ZWS-integrated server, SERVER users only otherwise.","tags":["Mapbox Resource"],"parameters":[{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}],"requestBody":{"required":true,"content":{"application/json":{"example":{"api_key":"sk.eyJ1IjoiemVyaW9uIiwiYSI6ImV4YW1wbGUifQ.Ab12","user":"zerion","map_type":"satellite-v9","profile_default_threshold":250},"schema":{"type":"object","properties":{"api_key":{"type":"string","description":"the Mapbox secret key; omit to keep the stored key"},"user":{"type":"string","description":"the Mapbox account user name"},"map_type":{"type":"string","description":"the default map type; one of `map_types`"},"profile_default_threshold":{"type":"integer","description":"the default map-view threshold for a new profile"}}}}}}}},"/mapbox/mapviews":{"get":{"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MapboxMapviews"},"example":{"profile_id":123456,"dates":["2026-10-01T00:00:00.000Z","2026-10-02T00:00:00.000Z","2026-10-03T00:00:00.000Z"],"mapviews":[3,0,12],"total":15}}}},"400":{"description":"Bad Request - `profile_id` is missing or not a positive integer, `start` or `end` is missing or not an ISO-8601 date or date-time, or `start` is after `end`.","headers":{},"content":{}},"401":{"description":"Unauthorized - missing or invalid bearer token.","headers":{},"content":{}},"403":{"description":"Forbidden - the client is not internal, or the user is not a SERVER user.","headers":{},"content":{}},"404":{"description":"Not Found - the profile has no Mapbox token on this server.","headers":{},"content":{}},"409":{"description":"Conflict - Mapbox is not enabled on this server.","headers":{},"content":{}},"502":{"description":"Bad Gateway - Mapbox could not be reached, answered with an error (its HTTP status is in `error_message`), or returned an unexpected response.","headers":{},"content":{}},"503":{"description":"Service Unavailable - the Mapbox user or key is not configured on this server.","headers":{},"content":{}}},"summary":"Retrieve Profile Map Views","operationId":"Retrieve Mapbox Profile Map Views","description":"Returns a profile's daily Mapbox map views over a period, with their sum. The profile's Mapbox token is looked up server-side; token ids are never returned.\n\n`start` and `end` are each a date (`YYYY-MM-DD`, read as midnight UTC) or a date-time with a zone (`2026-10-01T00:00:00Z`, `2026-10-01T00:00:00.000+02:00`). Both are passed to Mapbox in UTC.\n\n### Authorization\n\nInternal API clients only, and SERVER users only, whatever the server's ZWS mode.","tags":["Mapbox Resource"],"parameters":[{"name":"profile_id","in":"query","description":"id of the profile","required":true,"example":"123456","schema":{"type":"integer"}},{"name":"start","in":"query","description":"start of the period, ISO-8601 date or date-time","required":true,"example":"2026-10-01","schema":{"type":"string"}},{"name":"end","in":"query","description":"end of the period, ISO-8601 date or date-time; not before `start`","required":true,"example":"2026-10-31","schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}]}},"/mapbox/mapviews/profiles":{"get":{"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"profile_id":{"type":"integer"}},"required":["profile_id"]}},"example":[{"profile_id":123456},{"profile_id":234567}]}}},"401":{"description":"Unauthorized - missing or invalid bearer token.","headers":{},"content":{}},"403":{"description":"Forbidden - the client is not internal, or the user is not a SERVER user.","headers":{},"content":{}},"409":{"description":"Conflict - Mapbox is not enabled on this server.","headers":{},"content":{}},"502":{"description":"Bad Gateway - Mapbox could not be reached, answered with an error (its HTTP status is in `error_message`), or returned an unexpected response.","headers":{},"content":{}},"503":{"description":"Service Unavailable - the Mapbox user or key is not configured on this server.","headers":{},"content":{}}},"summary":"List Profiles with Map Views","operationId":"List Mapbox Map View Profiles","description":"Lists the profiles on this server that have a Mapbox token, in ascending `profile_id` order. Use it to pick a profile for `GET /mapbox/mapviews`. Tokens belonging to other servers on the same Mapbox account are left out, and token ids are never returned.\n\n### Authorization\n\nInternal API clients only, and SERVER users only, whatever the server's ZWS mode.","tags":["Mapbox Resource"],"parameters":[{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}]}},"/mapbox/profiles/{profile_id}":{"get":{"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MapboxProfileMapview"},"example":{"profile_id":123456,"enabled":true,"threshold":500,"has_token":true,"server_mapview_limit":2000,"allocated":1500,"unallocated":500}}}},"401":{"description":"Unauthorized - missing or invalid bearer token.","headers":{},"content":{}},"403":{"description":"Forbidden - the client is not internal, or the user is not a SERVER user.","headers":{},"content":{}},"404":{"description":"Not Found - the profile does not exist or has no company info.","headers":{},"content":{}},"409":{"description":"Conflict - Mapbox is not enabled on this server.","headers":{},"content":{}}},"summary":"Retrieve Profile Map View Settings","operationId":"Retrieve Mapbox Profile Map View Settings","description":"Returns a profile's map-view settings: whether map views are enabled, its monthly map-view threshold, and whether it has a Mapbox token. The token itself is never returned.\n\n`allocated` is the sum of every profile's threshold on the server, enabled or not; `unallocated` is `server_mapview_limit` minus `allocated`, or `null` when the server has no cap (a negative `server_mapview_limit`).\n\n### Authorization\n\nInternal API clients only, and SERVER users only, whatever the server's ZWS mode.","tags":["Mapbox Resource"],"parameters":[{"name":"profile_id","in":"path","description":"id of the profile","required":true,"example":"123456","schema":{"type":"integer"}},{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}]},"put":{"responses":{"200":{"description":"OK - the settings were saved. The body is the updated settings, in the same shape as `GET`.","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MapboxProfileMapview"},"example":{"profile_id":123456,"enabled":true,"threshold":300,"has_token":true,"server_mapview_limit":2000,"allocated":1300,"unallocated":700}}}},"400":{"description":"Bad Request - the body is not a JSON object, `enabled` is not a boolean, `threshold` is not an integer, or, while `server_mapview_limit` is 0 or more, `threshold` is below 0 or map views would be enabled with a threshold of 0.","headers":{},"content":{}},"401":{"description":"Unauthorized - missing or invalid bearer token.","headers":{},"content":{}},"403":{"description":"Forbidden - the client is not internal, or the user is not a SERVER user.","headers":{},"content":{}},"404":{"description":"Not Found - the profile does not exist or has no company info.","headers":{},"content":{}},"409":{"description":"Conflict - Mapbox is not enabled on this server, or the threshold does not fit in the server's unallocated map views.","headers":{},"content":{}},"502":{"description":"Bad Gateway - map views were being enabled and Mapbox did not create a token for the profile. Nothing was saved.","headers":{},"content":{}},"503":{"description":"Service Unavailable - map views were being enabled, the profile has no token yet, and the Mapbox user or key is not configured on this server. Nothing was saved.","headers":{},"content":{}}},"summary":"Update Profile Map View Settings","operationId":"Update Mapbox Profile Map View Settings","description":"Enables or disables map views for a profile and sets its monthly map-view threshold. Both fields are optional; an omitted field keeps its stored value.\n\nWhile the server has a cap (`server_mapview_limit` 0 or more), `threshold` cannot be below 0, and map views can be enabled only with a threshold above 0. A request that raises the threshold or turns map views on must fit the cap: every other profile's threshold plus this one cannot exceed `server_mapview_limit`. Lowering the threshold or disabling map views is never refused by the cap.\n\nThe first time map views are enabled for a profile without a token, a Mapbox token is created for it. If that fails, nothing is saved, map views stay off, and the response is `502`.\n\n### Authorization\n\nInternal API clients only, and SERVER users only, whatever the server's ZWS mode.","tags":["Mapbox Resource"],"parameters":[{"name":"profile_id","in":"path","description":"id of the profile","required":true,"example":"123456","schema":{"type":"integer"}},{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}],"requestBody":{"required":true,"content":{"application/json":{"example":{"enabled":true,"threshold":300},"schema":{"type":"object","properties":{"enabled":{"type":"boolean","description":"whether map views are enabled for the profile"},"threshold":{"type":"integer","description":"the profile's monthly map-view threshold"}}}}}}}},"/email_settings":{"get":{"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmailSettings"},"example":{"custom":true,"host":"smtp.example.com","from_address":"alerts@example.com","username":"mailer","password_set":true,"subject":"New Record","footer":"","footer2":""}}}},"401":{"description":"Unauthorized - missing or invalid bearer token.","headers":{},"content":{}},"403":{"description":"Forbidden - the client is not internal, or the user's role is not allowed (see Authorization).","headers":{},"content":{}}},"summary":"Retrieve Email Settings","operationId":"Retrieve Email Settings","description":"Returns the SMTP server and the subject and footers that this server's email alerts use. The SMTP password is never returned: `password_set` only says whether a non-empty one is stored.\n\n`custom` is `true` when the server has its own SMTP settings. When it is `false`, `host`, `from_address` and `username` are `null` and alerts go out through the server default. A subject or footer that was never set reads as the default in effect.\n\n### Authorization\n\nInternal API clients only. On a ZWS-integrated server, COMPANY and SERVER users are allowed; on any other server, SERVER users only.","tags":["Email Settings Resource"],"parameters":[{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}]},"put":{"responses":{"200":{"description":"OK - the settings were saved. The body is the updated settings, in the same shape as `GET`.","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmailSettings"},"example":{"custom":true,"host":"smtp.example.com","from_address":"alerts@example.com","username":"mailer","password_set":true,"subject":"Record received","footer":"","footer2":""}}}},"400":{"description":"Bad Request - the body is not a JSON object, a field has the wrong type, `subject`, `host`, `from_address` or `username` is empty or spans more than one line, `host` is not a host name or IP address, `from_address` is not a valid email address, or the SMTP credentials would be left incomplete.","headers":{},"content":{}},"401":{"description":"Unauthorized - missing or invalid bearer token.","headers":{},"content":{}},"403":{"description":"Forbidden - the client is not internal, or the user's role is not allowed (see Authorization).","headers":{},"content":{}}},"summary":"Update Email Settings","operationId":"Update Email Settings","description":"Updates the server's email alert settings. Every field is optional; an omitted field is not changed. A setting that has no stored value yet is created.\n\nOmit `password` to keep the stored password. An empty `password`, or one made only of `*` characters, also keeps it. Changing `host` or `username` from the stored value needs a new `password` in the same request, so a stored password is never sent to a different server or account.\n\nSending any of `host`, `from_address`, `username` or `password` sets a custom SMTP server. After the merge with the stored values, all four must be non-empty, so the first custom SMTP save needs all four.\n\n### Authorization\n\nSame as `GET /email_settings`: internal API clients only; COMPANY or SERVER users on a ZWS-integrated server, SERVER users only otherwise.","tags":["Email Settings Resource"],"parameters":[{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}],"requestBody":{"required":true,"content":{"application/json":{"example":{"host":"smtp.example.com","from_address":"alerts@example.com","username":"mailer","password":"{smtp_password}","subject":"Record received"},"schema":{"type":"object","properties":{"host":{"type":"string","description":"the SMTP host name or IP address, optionally prefixed with `ssl://` or `tls://`; no port"},"from_address":{"type":"string","format":"email","description":"the sender address of alert email"},"username":{"type":"string","description":"the SMTP user name"},"password":{"type":"string","format":"password","description":"the SMTP password; omit, or send only `*` characters, to keep the stored one"},"subject":{"type":"string","description":"the subject of an alert whose form sets none; non-empty"},"footer":{"type":"string","description":"the first footer of alert email; may be empty"},"footer2":{"type":"string","description":"the second footer of alert email; may be empty"}}}}}}}},"/email_settings/smtp":{"delete":{"responses":{"200":{"description":"OK - the custom SMTP settings were removed. The body is the updated settings, in the same shape as `GET`.","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmailSettings"},"example":{"custom":false,"host":null,"from_address":null,"username":null,"password_set":false,"subject":"Record received","footer":"","footer2":""}}}},"401":{"description":"Unauthorized - missing or invalid bearer token.","headers":{},"content":{}},"403":{"description":"Forbidden - the client is not internal, or the user's role is not allowed (see Authorization).","headers":{},"content":{}}},"summary":"Restore Default SMTP","operationId":"Restore Default Email SMTP","description":"Removes the server's custom SMTP host, from address, user name and password, so email alerts go out through the server default again. The subject and footers are not changed. Calling it on a server without custom SMTP settings succeeds and changes nothing.\n\n### Authorization\n\nSame as `GET /email_settings`: internal API clients only; COMPANY or SERVER users on a ZWS-integrated server, SERVER users only otherwise.","tags":["Email Settings Resource"],"parameters":[{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}]}},"/usage":{"get":{"responses":{"200":{"description":"OK - the analytics service's report, relayed as it answered. A JSON report is returned as is. A CSV report (a header row, then one row per day) is returned as `text/csv`; the rows of the `overall` report are put on separate lines.","headers":{},"content":{"application/json":{"schema":{}},"text/csv":{"schema":{"type":"string"},"example":"Date,Count\n2026-10-01,5\n2026-10-02,7"}}},"400":{"description":"Bad Request - `report` or `transaction_type` is missing or not one of its values, `profile_id` is not a positive integer, `start` or `end` is missing or not a date, `end` was sent with the `overall` report, `start` is after `end` (or after today for `overall`), or the period is longer than 366 days.","headers":{},"content":{}},"401":{"description":"Unauthorized - missing or invalid bearer token.","headers":{},"content":{}},"403":{"description":"Forbidden - the user is a BASIC user, or a COMPANY user asked for another profile's `profile_id`.","headers":{},"content":{}},"502":{"description":"Bad Gateway - the analytics service could not be reached, or answered with an error (its HTTP status is in `error_message`). The service's address and response body are never returned.","headers":{},"content":{}},"503":{"description":"Service Unavailable - the analytics service is not configured on this server.","headers":{},"content":{}}},"summary":"Retrieve Usage","operationId":"Retrieve Usage Report","description":"Returns a daily device or API transaction report from the analytics service, for one profile or for the whole server.\n\n- `overall` runs from `start` to the latest day and takes no `end`.\n- `detail` and `profile-detail` run from `start` to `end`.\n- The period is at most 366 days.\n\n### Authorization\n\nSERVER and COMPANY users. A COMPANY user sees only their own profile: `profile_id` defaults to it, and any other `profile_id` answers 403. A SERVER user may pass any `profile_id`, or none for the server-wide report. BASIC users get 403.","tags":["Usage Resource"],"parameters":[{"name":"report","in":"query","description":"the report to run","required":true,"example":"overall","schema":{"type":"string","enum":["overall","detail","profile-detail"]}},{"name":"transaction_type","in":"query","description":"device transactions or API calls","required":true,"example":"device","schema":{"type":"string","enum":["device","api"]}},{"name":"profile_id","in":"query","description":"id of the profile; a COMPANY user's own profile when omitted, the whole server for a SERVER user when omitted","required":false,"example":"123456","schema":{"type":"integer"}},{"name":"start","in":"query","description":"first day of the period, `YYYY-MM-DD`","required":true,"example":"2026-10-01","schema":{"type":"string","format":"date"}},{"name":"end","in":"query","description":"last day of the period, `YYYY-MM-DD`; required for `detail` and `profile-detail`, not accepted for `overall`","required":false,"example":"2026-10-31","schema":{"type":"string","format":"date"}},{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}]}},"/branding/images/{name}":{"post":{"summary":"Upload Branding Image","operationId":"Upload Branding Image","description":"Replaces one of the server's branding images. The upload is resized to the image's fixed size, ignoring its aspect ratio, and stored at `[servername]/[name].png` in the server's branding bucket, public-read. The console pages and devices read that object directly, so it is the image they show from then on.\n\n| name | size (px) |\n|---|---|\n| `sign_in` | 70 x 28 |\n| `content` | 800 x 600 |\n| `header_bg` | 65 x 85 |\n| `login_bg` | 439 x 325 |\n| `dataview_login` | 350 x 33 |\n| `login` | 109 x 38 |\n| `logo` | 248 x 58 |\n| `pw_reset_header` | 350 x 33 |\n| `reset_password` | 168 x 38 |\n| `formbuilder_logo` | 355 x 70 |\n| `formbuilder_sidebar` | 70 x 560 |\n| `logout` | 70 x 28 |\n| `activate` | 168 x 38 |\n| `web_page_icon` | 32 x 32 |\n| `sso_login_bg` | 878 x 325 |\n| `sso_dataview_login` | 350 x 33 |\n| `sso_login` | 109 x 38 |\n\nThe three `sso_*` names exist only while SSO is enabled on the server.\n\n### Authorization\n\nInternal API clients only, and SERVER users only, whatever the server's ZWS mode.","tags":["Branding Resource"],"parameters":[{"name":"name","in":"path","description":"the image name; see the table above","required":true,"schema":{"type":"string"},"example":"logo"},{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"type":"object","required":["file"],"properties":{"file":{"type":"string","format":"binary","description":"one PNG image; its bytes are checked, not its file name or declared type"}}}}}},"responses":{"201":{"description":"Created - the image was stored.","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BrandingImageOutcome"},"example":{"name":"logo","url":"https://iform-artwork.s3.amazonaws.com/app/logo.png"}}}},"400":{"description":"Bad Request - no file was uploaded, or the file is not a PNG image GD can read.","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Unauthorized - missing or invalid bearer token.","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Forbidden - the client is not internal, or the user is not a SERVER user.","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Not Found - `name` is not an image name, or is an `sso_*` name while SSO is off.","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"502":{"description":"Bad Gateway - the image could not be written to the branding bucket.","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/server_features":{"get":{"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerFeaturesOutcome"},"example":{"webform_enabled":true,"mapbox_enabled":false,"public_link_enabled":true,"public_link_default_threshold":100,"user_based_licensing":false,"cloud_server":false,"server_admin_assign_formbuilding":true,"user_delete_suspension_period_days":30,"save_prompt_enabled":true,"save_prompt_timer":900,"multi_photo_limit":10,"http_request_data_limit":2000,"post_xml_maximum_endpoint":5,"formbuilder_hidden_elements":[36],"localization_language_codes":{"en":"English","fr":"French/Français"},"icon_upload_limit":100}}}},"401":{"description":"Unauthorized - missing or invalid bearer token.","headers":{},"content":{}},"405":{"description":"Method Not Allowed - the resource is read-only.","headers":{},"content":{}}},"summary":"Retrieve Server Features","operationId":"Retrieve Server Features","description":"Returns the server's feature switches and limits, so a client can decide which features to offer. Read-only: each value is changed where it is today.\n\n- Booleans are JSON booleans and limits are integers.\n- A setting the server has no row for reads as the value the server applies.\n- `cloud_server` only says whether a cloud server address is set; the address is never returned.\n- `icon_upload_limit` is the only part of the icon storage settings that is returned.\n- Values are read from the server configuration cache, so a change can take up to 24 hours to show here.\n\n### Authorization\n\nAny signed-in user, through any API client.","tags":["Server Features Resource"],"parameters":[{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}]}},"/integrations/arcgis/connection/initiate":{"post":{"summary":"Start ArcGIS Connection","operationId":"Start ArcGIS Connection","description":"Starts the API-brokered OAuth connection of the caller's profile to an ArcGIS account. Send the user to `consent_url`; ArcGIS redirects back to `redirect_uri` with `code` and `state`, which the consumer posts to `POST /integrations/arcgis/connection`.\n\n- `redirect_uri` must exactly match an entry of the `arcGisRedirectUris` server config (a JSON array or comma-separated list).\n- `portal_url` defaults to `https://www.arcgis.com/sharing`. Any `https://*.arcgis.com/sharing` portal is accepted. An ArcGIS Enterprise portal must be `https`, end in `/sharing`, and exactly match an entry of the `arcGisPortalAllowlist` server config.\n- `consent_url` carries the app's client id only, never a secret, and asks for a non-expiring refresh token.\n- `state` is signed and valid for 15 minutes.\n\n### Authorization\n\nInternal API clients only, and the user must be a SERVER or COMPANY user.","tags":["ArcGIS Integration Resource"],"parameters":[{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["redirect_uri"],"properties":{"redirect_uri":{"type":"string","example":"https://app.example.com/integrations/arcgis/callback"},"portal_url":{"type":"string","example":"https://www.arcgis.com/sharing"}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"consent_url":{"type":"string","example":"https://www.arcgis.com/sharing/oauth2/authorize?client_id=abc\u0026response_type=code\u0026redirect_uri=https%3A%2F%2Fapp.example.com%2Fintegrations%2Farcgis%2Fcallback\u0026state=eyJ...\u0026expiration=-1"},"state":{"type":"string"}}}}}},"400":{"description":"Bad Request - `redirect_uri` missing or not allowlisted, or `portal_url` not https, not ArcGIS Online and not allowlisted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Forbidden - not an internal client, or a BASIC user.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"Service Unavailable - ArcGIS has no client id on this server.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/integrations/arcgis/connection":{"post":{"summary":"Create ArcGIS Connection","operationId":"Create ArcGIS Connection","description":"Exchanges the authorization `code` for a refresh token and stores the connection for the caller's profile. The `state` must be the one `initiate` returned to this user on this server, and the redirect URI and portal are re-checked against the current allowlists. Connecting again replaces the profile's previous connection, and its old grant is revoked at the portal unless another profile still uses it. No token is returned.\n\n### Authorization\n\nInternal API clients only, and the user must be a SERVER or COMPANY user.","tags":["ArcGIS Integration Resource"],"parameters":[{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["code","state"],"properties":{"code":{"type":"string"},"state":{"type":"string"}}}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ArcGisConnection"}}}},"400":{"description":"Bad Request - `code` missing, `state` invalid or expired, an allowlist entry was removed, or ArcGIS rejected the code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Forbidden - not an internal client, or a BASIC user.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"502":{"description":"Bad Gateway - ArcGIS could not be reached or answered with an error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"503":{"description":"Service Unavailable - ArcGIS has no client id on this server.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}},"get":{"summary":"Get ArcGIS Connection","operationId":"Get ArcGIS Connection","description":"The caller's profile's ArcGIS connection. `healthy` is a live check that the stored grant still reads the account's content. No token is returned.\n\n### Authorization\n\nInternal API clients only, and the user must be a SERVER or COMPANY user.","tags":["ArcGIS Integration Resource"],"parameters":[{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ArcGisConnection"}}}},"403":{"description":"Forbidden - not an internal client, or a BASIC user.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}},"delete":{"summary":"Delete ArcGIS Connection","operationId":"Delete ArcGIS Connection","description":"Unlinks the ArcGIS account from the caller's profile. When no other profile shares the stored grant, it is deleted and revoked at the portal where the portal supports revocation. Idempotent: answers the disconnected shape whether or not a connection existed. Forms stay linked to their layers, but records stop reaching them until an account is connected again.\n\n### Authorization\n\nInternal API clients only, and the user must be a SERVER or COMPANY user.","tags":["ArcGIS Integration Resource"],"parameters":[{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ArcGisConnection"}}}},"403":{"description":"Forbidden - not an internal client, or a BASIC user.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/integrations/arcgis/forms":{"get":{"summary":"List ArcGIS Forms","operationId":"List ArcGIS Forms","description":"Forms of the caller's profile that contain an Esri widget element, with the feature layer each is linked to. Sorted by name, ascending unless `sort` is `desc`. The `Total-Count` header carries the number of matching forms before `limit` and `offset`.\n\n### Authorization\n\nInternal API clients only, and the user must be a SERVER or COMPANY user.","tags":["ArcGIS Integration Resource"],"parameters":[{"name":"name","in":"query","description":"case-insensitive substring of the form name or label","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"1 to 1000, default 100","required":false,"schema":{"type":"integer"}},{"name":"offset","in":"query","description":"default 0","required":false,"schema":{"type":"integer"}},{"name":"sort","in":"query","description":"name order, `asc` or `desc` (case-insensitive), default `asc`","required":false,"schema":{"type":"string","enum":["asc","desc"],"default":"asc"}},{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}],"responses":{"200":{"description":"OK","headers":{"Total-Count":{"schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"label":{"type":"string"},"feature_layer_url":{"type":"string","nullable":true}}}},"example":[{"id":290749032,"name":"street_trees","label":"Street Trees","feature_layer_url":"https://services7.arcgis.com/AbC123/arcgis/rest/services/street_trees/FeatureServer/0"}]}}},"400":{"description":"Bad Request - `limit`, `offset`, `name` or `sort` is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Forbidden - not an internal client, or a BASIC user.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/integrations/arcgis/feature_layers":{"get":{"summary":"List ArcGIS Feature Layers","operationId":"List ArcGIS Feature Layers","description":"Every layer of every Feature Service in the connected account's content, root folder and sub-folders. `folder` is null for the root folder. Services on a host the connection may not send its token to are left out. When the request runs short of time, the remaining services are left out and the response carries `Partial-Result: true`.\n\n### Authorization\n\nInternal API clients only, and the user must be a SERVER or COMPANY user.","tags":["ArcGIS Integration Resource"],"parameters":[{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}],"responses":{"200":{"description":"OK","headers":{"Total-Count":{"schema":{"type":"integer"}},"Partial-Result":{"description":"present and `true` when some services were not described in time","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"folder":{"type":"string","nullable":true},"service":{"type":"string"},"layer_id":{"type":"integer"},"layer_name":{"type":"string"},"url":{"type":"string"}}}},"example":[{"folder":"Inspections","service":"Street Trees","layer_id":0,"layer_name":"Trees","url":"https://services7.arcgis.com/AbC123/arcgis/rest/services/street_trees/FeatureServer/0"}]}}},"403":{"description":"Forbidden - not an internal client, or a BASIC user.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"Conflict - the profile has no ArcGIS connection.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"502":{"description":"Bad Gateway - ArcGIS could not be reached, refused the stored grant, or answered with an error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/integrations/arcgis/imports":{"post":{"summary":"Import ArcGIS Feature Layer","operationId":"Import ArcGIS Feature Layer","description":"Creates a form in the caller's profile from a feature layer and links the form to that layer. The form gets an Esri widget, then one element per layer field:\n\n| Layer field | Element |\n|---|---|\n| coded-value domain | pick list, with a new option list |\n| range domain | range |\n| `esriFieldTypeDate` | date-time |\n| `esriFieldTypeDateOnly` | date |\n| double, single, integer, small and big integer | number |\n| anything else | text, sized to the field's length |\n\nThe object id field is not imported. Global id, geometry, blob and raster fields become optional text elements; records never send them to the layer. Required (`nullable: false`) and read-only (`editable: false`) carry over. A field whose name has characters an element name cannot hold, is reserved, starts with a digit or collides with another is renamed and listed in `renamed_fields`; the form keeps the layer field name, and records send a renamed element to that field. If any step fails, the half-created form and its option lists are removed.\n\n### Authorization\n\nInternal API clients only, and the user must be a SERVER or COMPANY user.","tags":["ArcGIS Integration Resource"],"parameters":[{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ArcGisFeatureLayerRequest"}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"label":{"type":"string"},"feature_layer_url":{"type":"string"},"element_count":{"type":"integer","description":"elements created from layer fields, the Esri widget not counted"},"renamed_fields":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"element":{"type":"string"}}}}}}}}},"400":{"description":"Bad Request - `feature_layer_url` is not an https FeatureServer layer URL, is on a host the connection may not reach, cannot be read with the account, or is not a feature layer; or the form could not be created (for example the profile's form limit).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Forbidden - not an internal client, or a BASIC user.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"Conflict - the profile has no ArcGIS connection.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"502":{"description":"Bad Gateway - ArcGIS could not be reached or answered with an error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/profiles/{profile_id}/pages/{page_id}/arcgis/link":{"put":{"summary":"Link Form to ArcGIS Feature Layer","operationId":"Link Form to ArcGIS Feature Layer","description":"Links the form to a feature layer, so new and updated records are pushed to it. The URL must end in `/FeatureServer/{layer_id}`, be on a host the profile's connection may send its token to, and describe a layer with `objectIdField` and `fields` when read with the connected account. Replaces an existing link.\n\n### Authorization\n\nInternal API clients only, the user must be a SERVER or COMPANY user, and the user must be able to modify the page.","tags":["ArcGIS Integration Resource"],"parameters":[{"name":"profile_id","in":"path","description":"id of the profile","required":true,"example":"self","schema":{"type":"string"}},{"name":"page_id","in":"path","description":"id of the page","required":true,"schema":{"type":"number"}},{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ArcGisFeatureLayerRequest"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ArcGisLink"}}}},"400":{"description":"Bad Request - not a FeatureServer layer URL, on a host the connection may not reach, or not readable as a feature layer with the account.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Forbidden - not an internal client, a BASIC user, or no modify permission on the page.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Not Found - the page is not in the profile.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"Conflict - the profile has no ArcGIS connection.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"502":{"description":"Bad Gateway - ArcGIS could not be reached or answered with an error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}},"delete":{"summary":"Unlink Form from ArcGIS Feature Layer","operationId":"Unlink Form from ArcGIS Feature Layer","description":"Removes the form's link to its feature layer. Idempotent.\n\n### Authorization\n\nInternal API clients only, the user must be a SERVER or COMPANY user, and the user must be able to modify the page.","tags":["ArcGIS Integration Resource"],"parameters":[{"name":"profile_id","in":"path","description":"id of the profile","required":true,"example":"self","schema":{"type":"string"}},{"name":"page_id","in":"path","description":"id of the page","required":true,"schema":{"type":"number"}},{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ArcGisLink"}}}},"403":{"description":"Forbidden - not an internal client, a BASIC user, or no modify permission on the page.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Not Found - the page is not in the profile.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/profiles/{profile_id}/pages/{page_id}/arcgis/publish":{"post":{"summary":"Publish Form as ArcGIS Feature Layer","operationId":"Publish Form as ArcGIS Feature Layer","description":"Publishes the form as a new hosted feature service in the connected account and links the form to its layer `0`. The service has `feature_id`, `latitude` and `longitude`, then one field per element; labels, dividers, subforms, image labels and the Esri widget are left out. Text becomes a string of the element's size, number a double, toggle an integer, range a double with a range domain, and select types a string with a coded-value domain from the option list.\n\nWith `with_existing_data: true` every record with a location in `MODIFIED_LOCATION` becomes a feature; records without one are skipped. The temporary CSV item is deleted once ArcGIS finishes publishing.\n\nThe form is linked only once ArcGIS reports the publish job finished. A job still running after the server's two-minute wait stays `processing` while the server keeps checking it in the background, whether or not anyone polls: it links the form and turns `complete` when the job completes, or turns `failed` and leaves the form unlinked when the job fails. A job still running 30 minutes after the wait turns `failed`. Whatever the outcome, the temporary CSV item is deleted. When the server does not queue background work, each `GET` checks the job instead.\n\nA new publish that replaces a stale `processing` one first finishes that one, so its CSV item is deleted too.\n\nThe request answers `202` with a `request_id` before the publish runs, because a publish can take minutes: poll `GET` on this path for `complete` (with `feature_layer_url`) or `failed` (with the ArcGIS error). When the server queues background work the answer is `pending` and the task service starts the job; otherwise it is `processing` and the job runs on the API server after the response is sent. One publish per form runs at a time.\n\n### Authorization\n\nInternal API clients only, the user must be a SERVER or COMPANY user, and the user must be able to modify the page.","tags":["ArcGIS Integration Resource"],"parameters":[{"name":"profile_id","in":"path","description":"id of the profile","required":true,"example":"self","schema":{"type":"string"}},{"name":"page_id","in":"path","description":"id of the page","required":true,"schema":{"type":"number"}},{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"with_existing_data":{"type":"boolean","default":false}}}}}},"responses":{"202":{"description":"Accepted - `pending` when queued, `processing` when the API server runs it after this response; poll the status.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ArcGisPublishStatus"},"example":{"status":"pending","request_id":"9f2c4e1a7b3d5f60"}}}},"400":{"description":"Bad Request - `with_existing_data` is not a boolean.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Forbidden - not an internal client, a BASIC user, or no modify permission on the page.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Not Found - the page is not in the profile.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"Conflict - the profile has no ArcGIS connection, or a publish is already running for the form.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}},"get":{"summary":"Get ArcGIS Publish Status","operationId":"Get ArcGIS Publish Status","description":"Status of the form's latest publish: `none`, `pending`, `processing`, `complete` (with `feature_layer_url`) or `failed` (with `error`).\n\nWhile a publish is `processing` after its ArcGIS job outlasted the server's wait, the server checks the job in the background, and this request also asks ArcGIS for its outcome: on completion it links the form and answers `complete`, on failure it answers `failed` and the form stays unlinked, and otherwise it answers `processing`. A `processing` publish 30 minutes old answers `failed` unless its job completed, and its temporary CSV item is deleted. Keep polling until the status is `complete` or `failed`.\n\n### Authorization\n\nInternal API clients only, the user must be a SERVER or COMPANY user, and the user must be able to view the page.","tags":["ArcGIS Integration Resource"],"parameters":[{"name":"profile_id","in":"path","description":"id of the profile","required":true,"example":"self","schema":{"type":"string"}},{"name":"page_id","in":"path","description":"id of the page","required":true,"schema":{"type":"number"}},{"name":"Authorization","in":"header","description":"e.g. Bearer {access_token}","required":false,"schema":{"type":"string"},"example":"Bearer {access_token}"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ArcGisPublishStatus"},"example":{"status":"complete","request_id":"9f2c4e1a7b3d5f60","updated_at":"2026-10-29T14:03:11Z","stale":false,"feature_layer_url":"https://services7.arcgis.com/AbC123/arcgis/rest/services/street_trees/FeatureServer/0"}}}},"403":{"description":"Forbidden - not an internal client, a BASIC user, or no view permission on the page.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Not Found - the page is not in the profile.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}}},"components":{"schemas":{"ApiClient":{"type":"object","description":"an API client of a profile, without its secret","properties":{"id":{"type":"integer"},"name":{"type":"string"},"client_key":{"type":"string"},"username":{"type":"string","description":"the user the client acts as"},"type":{"type":"array","description":"grants the client may use; `authorization_code` also allows `refresh_token`","items":{"type":"string","enum":["jwt-bearer","authorization_code","password"]}},"redirect_uris":{"type":"array","items":{"type":"string","format":"uri"}}}},"ApiClientSecret":{"type":"object","description":"the one response that carries a client secret","properties":{"id":{"type":"integer"},"client_key":{"type":"string"},"client_secret":{"type":"string"}}},"OAuthTokenRequest":{"description":"body of a token request; the required parameters depend on `grant_type`","oneOf":[{"title":"JWT bearer","type":"object","required":["grant_type","assertion"],"properties":{"grant_type":{"type":"string","enum":["urn:ietf:params:oauth:grant-type:jwt-bearer"]},"assertion":{"type":"string","description":"JWT signed with the API app's client secret (HS256, HS384 or HS512) carrying `iss`, `aud`, `iat` and `exp` claims"}}},{"title":"Password","type":"object","required":["grant_type","username","password","client_id","client_secret"],"properties":{"grant_type":{"type":"string","enum":["password"]},"username":{"type":"string","description":"iFormBuilder username the token is issued for"},"password":{"type":"string","format":"password"},"client_id":{"type":"string","description":"API app client key (or send HTTP Basic credentials)"},"client_secret":{"type":"string","description":"API app client secret (or send HTTP Basic credentials)"}}},{"title":"Authorization code","type":"object","required":["grant_type","code","redirect_uri","client_id","client_secret"],"properties":{"grant_type":{"type":"string","enum":["authorization_code"]},"code":{"type":"string","description":"the `code` returned to `redirect_uri` by the authorize page"},"redirect_uri":{"type":"string","format":"uri","description":"must match the `redirect_uri` used on the authorize page"},"access_type":{"type":"string","enum":["online","offline"],"default":"online","description":"`offline` also returns a `refresh_token`"},"client_id":{"type":"string","description":"API app client key (or send HTTP Basic credentials)"},"client_secret":{"type":"string","description":"API app client secret (or send HTTP Basic credentials)"}}},{"title":"Refresh token","type":"object","required":["grant_type","refresh_token","client_id","client_secret"],"properties":{"grant_type":{"type":"string","enum":["refresh_token"]},"refresh_token":{"type":"string","description":"refresh token from an offline `authorization_code` grant (`code` is accepted in its place)"},"client_id":{"type":"string","description":"API app client key (or send HTTP Basic credentials)"},"client_secret":{"type":"string","description":"API app client secret (or send HTTP Basic credentials)"}}}]},"OAuthTokenOutcome":{"type":"object","description":"access token issued by `POST /oauth/token`","properties":{"access_token":{"type":"string","description":"send as `Authorization: Bearer {access_token}`"},"token_type":{"type":"string","enum":["Bearer"]},"expires_in":{"type":"integer","description":"lifetime of the access token in seconds"},"refresh_token":{"type":"string","description":"present only for `authorization_code` with `access_type=offline`"}},"required":["access_token","token_type","expires_in"]},"OAuthTokenError":{"type":"object","description":"error from `POST /oauth/token`; has `error` (optionally with `error_description`), or `error_message` for a rejected `code`/`refresh_token`","properties":{"error":{"type":"string","description":"OAuth error code, or a `jwt ...` string for a rejected JWT assertion","enum":["invalid_request","unsupported_grant_type","invalid_client","unauthorized_client","invalid_grant","jwt header params","jwt claim set","jwt time","jwt client key","jwt signature","jwt not supported"]},"error_description":{"type":"string","description":"human-readable reason; present only when a `password` grant fails with a known sign-in outcome (invalid credentials, inactive account or company, locked account, SSO required, expired session); omitted for unexpected server-side failures"},"error_message":{"type":"string","description":"returned instead of `error` (value `invalid_grant`) when an authorization `code` or `refresh_token` is rejected"}},"minProperties":1},"MediaStorageConnection":{"type":"object","description":"a profile's cloud storage connection; never carries a credential","properties":{"provider":{"type":"string","enum":["dropbox","box","onedrive","sharepoint","google_drive"]},"location":{"type":"integer","description":"the ZCApiConnector location code (2 Dropbox, 3 Box, 6 OneDrive, 7 SharePoint, 8 Google Drive)"},"active":{"type":"boolean","description":"whether this is the profile's active media storage location"},"destination_root":{"type":"string","description":"present only on the active location; a folder path for OneDrive and Dropbox, a library name for SharePoint, a folder id for Box and Google Drive"},"account":{"type":"string","description":"the provider account's display name, when known"}},"required":["provider","location","active"]},"MediaStorageActiveLocation":{"type":"object","description":"the profile's active media storage location; never carries a credential","properties":{"provider":{"type":"string","enum":["dropbox","box","s3","onedrive","sharepoint","google_drive","s3_private"]},"location":{"type":"integer","description":"the MEDIA_LOCATION code (2 Dropbox, 3 Box, 5 S3, 6 OneDrive, 7 SharePoint, 8 Google Drive, 9 private S3)"},"active":{"type":"boolean","description":"always true"},"destination_root":{"type":"string","description":"the stored root, when there is one; a folder path for OneDrive and Dropbox, a library name for SharePoint, a folder id for Box and Google Drive"},"account":{"type":"string","description":"the provider account's display name, when known"}},"required":["provider","location","active"]},"MediaStorageSite":{"type":"object","description":"a SharePoint site the connection can store media in","properties":{"id":{"type":"string","description":"`root`, or a Graph site id (host,siteCollectionId,webId); pass as `site_id`"},"label":{"type":"string","description":"the site's display name"}},"required":["id","label"]},"MediaStorageSharedConnection":{"type":"object","description":"a connection a SERVER user shared across profiles; never carries a credential","properties":{"connection_id":{"type":"integer","description":"pass as `shared_connection_id` to link it"},"account":{"type":"string","description":"the provider account's display name"},"profiles":{"type":"array","description":"present only for a SERVER user; the profiles using the connection","items":{"type":"integer"}}},"required":["connection_id","account"]},"BrandingImageOutcome":{"type":"object","description":"the branding image that was written","properties":{"name":{"type":"string","description":"the image name from the path","example":"logo"},"url":{"type":"string","description":"the public URL of the stored image","example":"https://iform-artwork.s3.amazonaws.com/app/logo.png"}},"required":["name","url"]},"MapboxSettings":{"type":"object","description":"the server's Mapbox integration settings; the secret key is never included","properties":{"enabled":{"type":"boolean","description":"always `true`; a disabled server answers `409`"},"user":{"type":"string","description":"the Mapbox account user name"},"api_key_last4":{"type":"string","nullable":true,"description":"the last four characters of the stored key; `null` when none is stored, `\"\"` when the key is four characters or shorter"},"map_type":{"type":"string","description":"the default map type"},"map_types":{"type":"array","items":{"type":"string"},"description":"the map types `map_type` may take"},"profile_default_threshold":{"type":"integer","description":"the default map-view threshold for a new profile"},"server_mapview_limit":{"type":"integer","description":"the server-wide map-view cap; negative means no cap"}},"required":["enabled","user","api_key_last4","map_type","map_types","profile_default_threshold","server_mapview_limit"]},"MapboxProfileMapview":{"type":"object","description":"a profile's map-view settings; the profile's Mapbox token is never included","properties":{"profile_id":{"type":"integer"},"enabled":{"type":"boolean","description":"whether map views are enabled for the profile"},"threshold":{"type":"integer","description":"the profile's monthly map-view threshold"},"has_token":{"type":"boolean","description":"`true` when the profile has a Mapbox token"},"server_mapview_limit":{"type":"integer","description":"the server-wide map-view cap; negative means no cap"},"allocated":{"type":"integer","description":"the sum of every profile's threshold on the server"},"unallocated":{"type":"integer","nullable":true,"description":"`server_mapview_limit` minus `allocated`; `null` when the server has no cap"}},"required":["profile_id","enabled","threshold","has_token","server_mapview_limit","allocated","unallocated"]},"EmailSettings":{"type":"object","description":"the server's email alert settings; the SMTP password is never included","properties":{"custom":{"type":"boolean","description":"`true` when the server has its own SMTP settings; `false` when alerts use the server default"},"host":{"type":"string","nullable":true,"description":"the SMTP host; `null` when not set"},"from_address":{"type":"string","nullable":true,"description":"the sender address of alert email; `null` when not set"},"username":{"type":"string","nullable":true,"description":"the SMTP user name; `null` when not set"},"password_set":{"type":"boolean","description":"`true` when a non-empty SMTP password is stored"},"subject":{"type":"string","description":"the subject of an alert whose form sets none"},"footer":{"type":"string","description":"the first footer of alert email"},"footer2":{"type":"string","description":"the second footer of alert email"}},"required":["custom","host","from_address","username","password_set","subject","footer","footer2"]},"MapboxMapviews":{"type":"object","description":"a profile's daily Mapbox map views over a period","properties":{"profile_id":{"type":"integer"},"dates":{"type":"array","items":{"type":"string"},"description":"the start of each day, as Mapbox reports it"},"mapviews":{"type":"array","items":{"type":"integer"},"description":"map views per day, aligned with `dates`"},"total":{"type":"integer","description":"the sum of `mapviews`"}},"required":["profile_id","dates","mapviews","total"]},"PublicLinkGrantSessionOutcome":{"type":"object","description":"a public link session, from `POST /public_link_sessions`","properties":{"access_token":{"type":"string","description":"the session token, sent as `Authorization: Bearer {access_token}` on the `/public_link_sessions/current/...` routes only"},"token_type":{"type":"string","enum":["Bearer"]},"expires_in":{"type":"integer","description":"seconds until the session expires"},"profile_id":{"type":"integer","description":"the link's profile"},"page_id":{"type":"integer","description":"the link's page"}},"required":["access_token","token_type","expires_in","profile_id","page_id"]},"PublicLinkGrantFeedOutcome":{"type":"object","description":"the form definition of a public link session's link","properties":{"profile_id":{"type":"integer"},"page_id":{"type":"integer","description":"the link's page; the first entry of `pages`"},"expires_in":{"type":"integer","description":"seconds left on the session"},"pages":{"type":"array","items":{"type":"object","properties":{"page":{"type":"object","description":"the page, device feed format (`created_by`, `modified_by` and server-only columns removed)"},"parents":{"type":"array","description":"the subform edges into this page; empty for the link's page","items":{"type":"object","properties":{"parent_page_id":{"type":"integer"},"parent_element_id":{"type":"integer"}}}},"elements":{"type":"array","items":{"type":"object","description":"an element, device feed format (`created_by`, `modified_by` and server-only columns removed)"}},"page_localizations":{"type":"array","items":{"type":"object"}},"element_localizations":{"type":"array","items":{"type":"object"}}}}},"option_lists":{"type":"array","items":{"type":"object","properties":{"option_list":{"type":"object"},"options":{"type":"array","items":{"type":"object"}}}}}},"required":["profile_id","page_id","expires_in","pages","option_lists"]},"PublicLinkGrantRecordOutcome":{"type":"object","description":"the record created through a public link session","properties":{"id":{"type":"integer","description":"id of the new record"}},"required":["id"]},"MediaRestoreOutcome":{"type":"object","description":"per-asset outcome of a media_restore request","properties":{"url":{"type":"string","nullable":true,"description":"the url exactly as submitted (null when the item had no url)"},"status":{"type":"string","description":"per-asset outcome","enum":["RESTORED","ALREADY_ACTIVE","PERMANENTLY_DELETED","RESTORE_FAILED"]},"reason":{"type":"string","description":"present only on `PERMANENTLY_DELETED` and `RESTORE_FAILED`"},"version_id":{"type":"string","description":"present only on `RESTORED`; the S3 version id of the delete marker that was removed"}},"required":["url","status"]},"IconOutcome":{"type":"object","description":"per-icon outcome of an icons POST or DELETE request","properties":{"url":{"type":"string","description":"the icon's url; on POST, the url of the stored icon, on DELETE, the url exactly as submitted. Absent when the item failed."},"error_message":{"type":"string","description":"present only when the item failed"}}},"PageStatusOutcome":{"type":"object","description":"record count and last record change of one form in one profile","properties":{"id":{"type":"number","description":"id of the status row; returned only when asked for in `fields`"},"page_id":{"type":"number","description":"id of the form"},"profile_id":{"type":"number","description":"id of the profile the status is kept for"},"row_count":{"type":"number","description":"number of records on the form; negative when the count is unknown"},"last_modified_date":{"type":"string","nullable":true,"description":"date of the last record change, RFC 3339 in UTC"},"last_modified_location":{"type":"string","nullable":true,"description":"location of the last record change"}},"required":["page_id","profile_id","row_count","last_modified_date","last_modified_location"]},"PageAccessOutcome":{"type":"object","description":"the signed-in user's effective access to one page, subform inheritance included","properties":{"page_id":{"type":"number","description":"the page id from the path"},"can_view":{"type":"boolean","description":"the user may view records on the page, directly or through a parent form"},"can_collect":{"type":"boolean","description":"the user may collect (create, edit, delete) records on the page, directly or through a parent form"}},"required":["page_id","can_view","can_collect"]},"BrowserTokenRegisterOutcome":{"type":"object","description":"outcome of a WebForms browser registration","properties":{"id":{"type":"integer","description":"the registration id, for `DELETE .../browser_tokens/{browser_token_id}`"},"browser_token":{"type":"string","description":"this browser's token; send it back on the next registration"},"browser_count":{"type":"integer","description":"the user's live registrations, this one included"},"remaining":{"type":"integer","nullable":true,"description":"registrations left before the limit; null when the limit is -1 (unlimited)"},"resets_at":{"type":"string","nullable":true,"description":"the next daily reset (UTC), when registrations from before it stop counting; null when the limit is -1"}},"required":["id","browser_token","browser_count","remaining","resets_at"]},"BrowserTokenLimitOutcome":{"type":"object","description":"a WebForms browser registration refused because the user holds the limit","properties":{"error_message":{"type":"string"},"browser_count":{"type":"integer","description":"the user's live registrations"},"resets_at":{"type":"string","description":"the next daily reset (UTC), after which registration can succeed"}},"required":["error_message","browser_count","resets_at"]},"BrowserTokenDeleteOutcome":{"type":"object","description":"per-id outcome of a WebForms browser release","properties":{"id":{"type":"integer","description":"the registration id as submitted (0 when the item had no usable id)"},"error_message":{"type":"string","description":"present only when the id was not one of the user's registrations"}},"required":["id"]},"RecordMediaOutcome":{"type":"object","description":"per-element outcome of a record media DELETE request","properties":{"element_name":{"type":"string","description":"the element's name as stored on the page"},"status":{"type":"string","description":"per-element outcome","enum":["DELETE_QUEUED","VALUE_CLEARED","NO_MEDIA","DELETE_FAILED"]},"reason":{"type":"string","description":"present on `DELETE_FAILED` (`MEDIA_NOT_HOSTED_ON_S3`, `URL_OUT_OF_SCOPE`) and on `VALUE_CLEARED` when the deletion queue refused the request (`QUEUE_FAILED`)"},"urls":{"type":"array","description":"present on `DELETE_QUEUED` and `VALUE_CLEARED`; every media url the element held before it was cleared (one for a single-value element, one per file for `multi_photo`)","items":{"type":"string"}},"url":{"type":"string","description":"present only on `DELETE_FAILED`; the first url that caused the refusal"}},"required":["element_name","status"]},"PublicLink":{"type":"object","description":"a form's public link. Only the default fields (`id`, `name`, `public_url`, `is_disabled`, `page_id`) are returned unless `fields` asks for more.","properties":{"id":{"type":"integer"},"name":{"type":"string"},"label":{"type":"string"},"public_url":{"type":"string"},"expiration_date":{"type":"string","nullable":true},"activation_date":{"type":"string","nullable":true},"created_by":{"type":"string"},"created_date":{"type":"string"},"last_modified_by":{"type":"string"},"last_modified_date":{"type":"string"},"is_disabled":{"type":"boolean"},"page_id":{"type":"integer"},"password":{"type":"string","description":"RSA-encrypted; returned to SERVER and COMPANY users only. Empty when the link has no password."}}},"PublicLinkKey":{"type":"object","description":"identifies a public link by `id`, by `page_id`, or by both; at least one is required","properties":{"id":{"type":"integer","description":"id of the public link"},"page_id":{"type":"integer","description":"id of the form the link belongs to"}}},"PublicLinkCreateRequest":{"type":"object","required":["page_id"],"properties":{"page_id":{"type":"integer","description":"id of a form in the profile; it must not already have a public link"},"name":{"type":"string"},"label":{"type":"string"},"activation_date":{"type":"string","description":"date and time the link starts accepting submissions, for example `2026-12-01T00:00:00Z`"},"expiration_date":{"type":"string","description":"date and time the link stops accepting submissions"},"is_disabled":{"type":"boolean"},"password":{"type":"string","description":"when non-empty, submitters must enter it; stored RSA-encrypted"}}},"PublicLinkUpdateRequest":{"allOf":[{"$ref":"#/components/schemas/PublicLinkKey"},{"type":"object","properties":{"name":{"type":"string"},"label":{"type":"string"},"activation_date":{"type":"string"},"expiration_date":{"type":"string"},"is_disabled":{"type":"boolean"},"password":{"type":"string","nullable":true,"description":"a non-empty string sets a new password; `\"\"` removes it; `null` or leaving the key out keeps the current one"}}}]},"RecordWriteOutcome":{"type":"object","description":"per-record outcome of a list `PUT .../records`; `id` on success, `error_message` on failure","properties":{"id":{"type":"integer","description":"id of the updated record"},"error_message":{"description":"why this record was not written - a message, or the list of validation errors for its fields","oneOf":[{"type":"string"},{"type":"array","items":{"oneOf":[{"type":"object","properties":{"field_value":{"description":"the element_name or element_id the error is about"},"error_message":{"type":"string"},"error_code":{"type":"integer"}}},{"type":"string"}]}}]}}},"PublicLinkWriteOutcome":{"type":"object","description":"per-item outcome of a public_links POST, PUT or DELETE; `id` on success, `error_message` on failure","properties":{"id":{"type":"integer","description":"id of the public link"},"error_message":{"type":"string","description":"why this item failed"}}},"ArcGisConnection":{"type":"object","description":"a profile's ArcGIS connection; never carries a token","properties":{"connected":{"type":"boolean"},"username":{"type":"string","nullable":true},"portal_url":{"type":"string","nullable":true},"healthy":{"type":"boolean","description":"the stored grant still reads the account's content"}},"required":["connected","username","portal_url","healthy"],"example":{"connected":true,"username":"jdoe_example","portal_url":"https://www.arcgis.com/sharing","healthy":true}},"ArcGisFeatureLayerRequest":{"type":"object","required":["feature_layer_url"],"properties":{"feature_layer_url":{"type":"string","description":"https URL ending in `/FeatureServer/{layer_id}`; a query string is dropped","example":"https://services7.arcgis.com/AbC123/arcgis/rest/services/street_trees/FeatureServer/0"}}},"ArcGisLink":{"type":"object","properties":{"page_id":{"type":"integer"},"feature_layer_url":{"type":"string","nullable":true}},"required":["page_id","feature_layer_url"]},"ArcGisPublishStatus":{"type":"object","properties":{"status":{"type":"string","enum":["none","pending","processing","complete","failed"]},"request_id":{"type":"string"},"updated_at":{"type":"string","format":"date-time"},"stale":{"type":"boolean","description":"always present in the `GET` status body (not in the `POST` 202). True when `pending` or `processing` and `updated_at` is 30 minutes old or more - the publish was never picked up, or died mid-run and could not be settled as `failed` yet, and no longer blocks a new publish. False otherwise, including `none`."},"feature_layer_url":{"type":"string","description":"present when `complete`"},"error":{"type":"string","description":"present when `failed`"}},"required":["status"]},"ApiError":{"type":"object","description":"standard error body; every non-2xx response that is not a per-item outcome array carries this shape","properties":{"error_message":{"type":"string","description":"human-readable reason for the failure"}},"required":["error_message"]},"PageEmailAlertSettings":{"type":"object","description":"the CC list, BCC list and subject element of a page's email alert","properties":{"cc":{"type":"array","items":{"type":"string"},"description":"addresses copied on each alert"},"bcc":{"type":"array","items":{"type":"string"},"description":"addresses blind-copied on each alert"},"subject_element":{"type":"string","nullable":true,"description":"name of the element whose value is the subject; `null` when none is set"}},"required":["cc","bcc","subject_element"]},"ServerFeaturesOutcome":{"type":"object","description":"the server's feature switches and limits","properties":{"webform_enabled":{"type":"boolean","description":"WebForm features are on (`webformEnabled`; false when unset)"},"mapbox_enabled":{"type":"boolean","description":"Mapbox map view features are on (`mapboxEnabled`; false when unset)"},"public_link_enabled":{"type":"boolean","description":"public link features are on; true only when `publicLinkEnabled` reads 1"},"public_link_default_threshold":{"type":"integer","description":"default per-profile public link threshold (`publicLinkDefaultThreshold`; 100 when unset)"},"user_based_licensing":{"type":"boolean","description":"the server uses user-based licensing (`isUserBasedLicensingModel`)"},"cloud_server":{"type":"boolean","description":"a cloud server address is set (`cloudServerAddress`); the address itself is never returned"},"server_admin_assign_formbuilding":{"type":"boolean","description":"company admins may assign user rights on the create and edit user pages (`serverAdminAssignFormbuilding`; true when unset)"},"user_delete_suspension_period_days":{"type":"integer","description":"days a deleted user's license stays suspended under user-based licensing (`userBasedLicensingDeleteSuspensionPeriodInDays`; 30 when unset)"},"save_prompt_enabled":{"type":"boolean","description":"the form designer shows the unsaved changes prompt (`savePromptFlag`; true when unset)"},"save_prompt_timer":{"type":"integer","description":"seconds before the unsaved changes prompt (`savePromptTimer`; 900 when unset)"},"multi_photo_limit":{"type":"integer","description":"maximum for the multi-photo element limit attribute (`multiPhotoLimit`; 0 when unset)"},"http_request_data_limit":{"type":"integer","description":"data size of the HTTP Request element, type 53 (`httpRequestDataLimit`; 2000 when unset)"},"post_xml_maximum_endpoint":{"type":"integer","description":"Post Data endpoints allowed per form (`postXMLMaximumEndpoint`; 0 when unset)"},"formbuilder_hidden_elements":{"type":"array","description":"element type ids hidden from the form designer palette (`formbuilderHiddenElements`; empty when unset)","items":{"type":"integer"}},"localization_language_codes":{"type":"object","description":"language code =\u003e label, the languages accepted for localization (`localizationLanguageCodeList`)","additionalProperties":{"type":"string"}},"icon_upload_limit":{"type":"integer","description":"icons allowed per profile (element 5 of `iconServerLocationInfo`; 0 when unset, which refuses every upload)"}},"required":["webform_enabled","mapbox_enabled","public_link_enabled","public_link_default_threshold","user_based_licensing","cloud_server","server_admin_assign_formbuilding","user_delete_suspension_period_days","save_prompt_enabled","save_prompt_timer","multi_photo_limit","http_request_data_limit","post_xml_maximum_endpoint","formbuilder_hidden_elements","localization_language_codes","icon_upload_limit"]},"BrandingColorsOutcome":{"type":"object","description":"the server's branding colors, and nothing else","properties":{"labelLoginColor":{"type":"string","nullable":true,"pattern":"^#([0-9A-Fa-f]{3}|[0-9A-Fa-f]{6})$","description":"labels on the login page (username and password); null when unset or not a hex color"},"textLoginColor":{"type":"string","nullable":true,"pattern":"^#([0-9A-Fa-f]{3}|[0-9A-Fa-f]{6})$","description":"text typed into the login page fields; null when unset or not a hex color"},"headerBackgroundColor":{"type":"string","nullable":true,"pattern":"^#([0-9A-Fa-f]{3}|[0-9A-Fa-f]{6})$","description":"header background; null when unset or not a hex color"},"headerTextColor":{"type":"string","nullable":true,"pattern":"^#([0-9A-Fa-f]{3}|[0-9A-Fa-f]{6})$","description":"header text; null when unset or not a hex color"},"menuLabelColor":{"type":"string","nullable":true,"pattern":"^#([0-9A-Fa-f]{3}|[0-9A-Fa-f]{6})$","description":"menu labels; null when unset or not a hex color"},"menuLabelHoverColor":{"type":"string","nullable":true,"pattern":"^#([0-9A-Fa-f]{3}|[0-9A-Fa-f]{6})$","description":"menu labels on hover; null when unset or not a hex color"},"buttonBackgroundColor":{"type":"string","nullable":true,"pattern":"^#([0-9A-Fa-f]{3}|[0-9A-Fa-f]{6})$","description":"button background; null when unset or not a hex color"},"buttonBackgroundSemiColor":{"type":"string","nullable":true,"pattern":"^#([0-9A-Fa-f]{3}|[0-9A-Fa-f]{6})$","description":"secondary button background; null when unset or not a hex color"}},"required":["labelLoginColor","textLoginColor","headerBackgroundColor","headerTextColor","menuLabelColor","menuLabelHoverColor","buttonBackgroundColor","buttonBackgroundSemiColor"]}},"securitySchemes":{"oauth2":{"type":"oauth2","description":"Every request needs an access token, sent as `Authorization: Bearer {access_token}`. A token grants access to any resource its user can access and expires after `expires_in` seconds (currently 3600); cache and reuse it until then.\n\nGet a token from `POST /oauth/token` using any supported grant type:\n\n- **JWT bearer** (`urn:ietf:params:oauth:grant-type:jwt-bearer`) - recommended for API apps. Sign a short-lived JWT with the API app's client key and secret and exchange it for a token; no user interaction. OpenAPI cannot describe this grant as a flow, so it is documented on the **Request Access Token** operation.\n- **Password** - exchange an iFormBuilder username and password, plus the API app's client key and secret.\n- **Authorization code** - send the user to the authorize page on their iFormBuilder server, then exchange the returned code. `access_type=offline` also returns a refresh token.\n- **Refresh token** - exchange a refresh token from an offline authorization code grant for a new access token.","flows":{"password":{"tokenUrl":"https://api.iformbuilder.com/exzact/api/v81/[servername]/oauth/token","scopes":{}},"authorizationCode":{"authorizationUrl":"https://[servername].iformbuilder.com/exzact/api/oauth/auth","tokenUrl":"https://api.iformbuilder.com/exzact/api/v81/[servername]/oauth/token","refreshUrl":"https://api.iformbuilder.com/exzact/api/v81/[servername]/oauth/token","scopes":{}}}},"publicLinkSession":{"type":"http","scheme":"bearer","description":"A public link session token from `POST /public_link_sessions`, sent as `Authorization: Bearer {access_token}`. Accepted only by the `/public_link_sessions/current/...` routes; no other route accepts it, and no access token is accepted by those routes."}}},"tags":[{"name":"Token Resource"},{"name":"Public Link Session Resource","description":"### Notes:\n\n- Anonymous collection through a public link. `POST /public_link_sessions` exchanges a link's share token (and password) for a session token that can read that link's form and create records on it, and nothing else."},{"name":"Profile Resource"},{"name":"API Client Resource"},{"name":"User Resource"},{"name":"User Group Resource"},{"name":"Page Resource","description":"\u003ch3\u003e\u003cb\u003eGeneral Notes:\u003c/b\u003e\u003c/h3\u003e\n\n\u003cli\u003eWhen using DELETE on a page, all records must be deleted first.\u003c/li\u003e"},{"name":"Page Group Resource"},{"name":"Element Resource","description":"\u003ch3\u003e\u003cb\u003eGeneral Notes:\u003c/b\u003e\u003c/h3\u003e\n\n\u003cli\u003eWhen 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)\u003c/li\u003e"},{"name":"Optionlist Resource"},{"name":"Record Resource","description":"\u003ch3\u003e\u003cb\u003eGeneral Notes:\u003c/b\u003e\u003c/h3\u003e\n\n\u003cli\u003eTo search for null values in the API, you can put an empty string in search criteria. \u003cb\u003efields=first_name(=\"\")\u003c/b\u003e  \u003c/li\u003e"},{"name":"Notification Resource"},{"name":"Private Media Resource"},{"name":"Media Storage Resource","description":"### Notes:\n\n- Internal clients only. Connects a profile to a cloud storage provider without the caller ever holding a client secret or a provider token.\n- `PUT /media_storage/active` makes a connected provider (or S3) the profile's active media storage location."},{"name":"Device License Resource"},{"name":"Device Transaction Log Resource","description":"\u003ch3\u003e\u003cb\u003eNotes:\u003c/b\u003e\u003c/h3\u003e\n\n\u003cli\u003ePlease use the base domain \u003cb\u003ebeta\u003c/b\u003e in order to use this resource.\u003c/li\u003e Example: https://beta-api.iformbuilder.com (US), beta-uk-api (UK), beta-au-api (AU)."},{"name":"Async Transaction Log Resource","description":"\u003ch3\u003e\u003cb\u003eNotes:\u003c/b\u003e\u003c/h3\u003e\n\n\u003cli\u003ePlease use the base domain \u003cb\u003ebeta\u003c/b\u003e in order to use this resource.\u003c/li\u003e Example: https://beta-api.iformbuilder.com (US), beta-uk-api (UK), beta-au-api (AU)."},{"name":"Mapbox Resource","description":"\u003ch3\u003e\u003cb\u003eNotes:\u003c/b\u003e\u003c/h3\u003e\n\n\u003cli\u003eServer-level Mapbox settings and map-view usage. Internal API clients only.\u003c/li\u003e"},{"name":"Email Settings Resource","description":"\u003ch3\u003e\u003cb\u003eNotes:\u003c/b\u003e\u003c/h3\u003e\n\n\u003cli\u003eServer-level SMTP server, subject and footers of email alerts. Internal API clients only.\u003c/li\u003e"},{"name":"Usage Resource","description":"\u003ch3\u003e\u003cb\u003eNotes:\u003c/b\u003e\u003c/h3\u003e\n\n\u003cli\u003eDaily device and API transaction reports from the analytics service, scoped to the caller's profile.\u003c/li\u003e"},{"name":"Branding Resource","description":"\u003ch3\u003e\u003cb\u003eNotes:\u003c/b\u003e\u003c/h3\u003e\n\n\u003cli\u003eServer branding artwork. Internal API clients and SERVER users only.\u003c/li\u003e\n\u003cli\u003e\u003ccode\u003eGET /branding\u003c/code\u003e is public and returns only the branding colors.\u003c/li\u003e"},{"name":"Server Features Resource","description":"### Notes:\n\n- Read-only server feature switches and limits, for any signed-in user."},{"name":"ArcGIS Integration Resource","description":"Connect an ArcGIS account, import feature layers as forms, link forms to layers and publish forms as hosted feature layers. Internal API clients only."}]}