diff --git a/.circleci/config.yml b/.circleci/config.yml index a8b428ba..a64e8adf 100644 --- a/.circleci/config.yml +++ b/.circleci/config.yml @@ -94,7 +94,8 @@ workflows: pip install --progress-bar off -r docs/requirements.txt && \ pip install --progress-bar off -e ".[dev-core,dev-civisml]" && \ pip-audit --version && \ - pip-audit --skip-editable + pip-audit --skip-editable \ + --ignore-vuln GHSA-4xh5-x5gv-qwph # https://github.com/pypa/pip/issues/13607 - pre-build: name: twine command-run: | diff --git a/CHANGELOG.md b/CHANGELOG.md index c4592338..43b0a71f 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -9,13 +9,17 @@ and this project adheres to [Semantic Versioning](http://semver.org/). ### Added ### Changed +- Updated retries for Civis API calls under `civis.APIClient` + to wait at least the `Retry-After` duration from the response header, + instead of potentially less than that. (#525) ### Deprecated ### Removed ### Fixed - +- Fixed retries for Civis API calls under `civis.APIClient` + that would lead to a recursion error. (#525) - Updated documentation for the `preview_rows` argument of `civis.io.query_civis` to have the correct maximum of 1000. (#523) diff --git a/src/civis/_get_api_key.py b/src/civis/_get_api_key.py new file mode 100644 index 00000000..027f49f2 --- /dev/null +++ b/src/civis/_get_api_key.py @@ -0,0 +1,16 @@ +import os + + +def get_api_key(api_key): + """Pass-through if `api_key` is not None otherwise tries the CIVIS_API_KEY + environment variable. + """ + if api_key is not None: # always prefer user given one + return api_key + api_key = os.environ.get("CIVIS_API_KEY", None) + if api_key is None: + raise EnvironmentError( + "No Civis API key found. Please store in " + "CIVIS_API_KEY environment variable" + ) + return api_key diff --git a/src/civis/_utils.py b/src/civis/_retries.py similarity index 54% rename from src/civis/_utils.py rename to src/civis/_retries.py index aab8c4f0..98d58718 100644 --- a/src/civis/_utils.py +++ b/src/civis/_retries.py @@ -1,5 +1,4 @@ import logging -import os import tenacity from tenacity.wait import wait_base @@ -19,36 +18,32 @@ wait=tenacity.wait_random_exponential(multiplier=2, max=60), stop=(tenacity.stop_after_delay(600) | tenacity.stop_after_attempt(10)), retry_error_callback=lambda retry_state: retry_state.outcome.result(), + reraise=True, ) """ -# Explicitly set the available globals and locals -# to mitigate risk of unwanted code execution -DEFAULT_RETRYING = eval( # nosec - DEFAULT_RETRYING_STR, - {"tenacity": tenacity, "__builtins__": {}}, # globals - {}, # locals -) - -def get_api_key(api_key): - """Pass-through if `api_key` is not None otherwise tries the CIVIS_API_KEY - environment variable. - """ - if api_key is not None: # always prefer user given one - return api_key - api_key = os.environ.get("CIVIS_API_KEY", None) - if api_key is None: - raise EnvironmentError( - "No Civis API key found. Please store in " - "CIVIS_API_KEY environment variable" - ) - return api_key +def get_default_retrying(): + """Return a new instance of the default tenacity.Retrying.""" + # Explicitly set the available globals and locals + # to mitigate risk of unwanted code execution + return eval( # nosec + DEFAULT_RETRYING_STR, + {"tenacity": tenacity, "__builtins__": {}}, # globals + {}, # locals + ) def retry_request(method, prepared_req, session, retrying=None): retry_conditions = None - retrying = retrying if retrying else DEFAULT_RETRYING + + # New tenacity.Retrying instance needed, whether it's a copy of the user-provided + # one or it's one based on civis-python's default settings. + retrying = retrying.copy() if retrying else get_default_retrying() + + # If retries are exhausted, + # raise the last exception encountered, not tenacity's RetryError. + retrying.reraise = True def _make_request(req, sess): """send the prepared session request""" @@ -66,7 +61,7 @@ def _make_request(req, sess): if retry_conditions: retrying.retry = retry_conditions - retrying.wait = wait_for_retry_after_header(fallback=retrying.wait) + retrying.wait = wait_at_least_retry_after_header(base=retrying.wait) response = retrying(_make_request, prepared_req, session) return response @@ -74,25 +69,23 @@ def _make_request(req, sess): return response -class wait_for_retry_after_header(wait_base): - """Wait strategy that first looks for Retry-After header. If not - present it uses the fallback strategy as the wait param""" +class wait_at_least_retry_after_header(wait_base): + """Wait strategy for at least `Retry-After` seconds (if present from header)""" - def __init__(self, fallback): - self.fallback = fallback + def __init__(self, base): + self.base = base def __call__(self, retry_state): # retry_state is an instance of tenacity.RetryCallState. # The .outcome property contains the result/exception # that came from the underlying function. - result_headers = retry_state.outcome._result.headers - retry_after = result_headers.get("Retry-After") or result_headers.get( - "retry-after" - ) + headers = retry_state.outcome._result.headers try: - log.info("Retrying after {} seconds".format(retry_after)) - return int(retry_after) + retry_after = float( + headers.get("Retry-After") or headers.get("retry-after") or "0.0" + ) except (TypeError, ValueError): - pass - return self.fallback(retry_state) + retry_after = 0.0 + # Wait at least retry_after seconds (compared to the user-specified wait). + return max(retry_after, self.base(retry_state)) diff --git a/src/civis/base.py b/src/civis/base.py index 5521d06a..15b58ee8 100644 --- a/src/civis/base.py +++ b/src/civis/base.py @@ -10,7 +10,7 @@ import civis from civis.response import PaginatedResponse, convert_response_data_type -from civis._utils import retry_request, DEFAULT_RETRYING +from civis._retries import retry_request FINISHED = ["success", "succeeded"] FAILED = ["failed"] @@ -159,16 +159,13 @@ def _make_request(self, method, path=None, params=None, data=None, **kwargs): params = self._handle_array_params(params) with self._lock: - if self._client._retrying is None: - retrying = self._session_kwargs.pop("retrying", None) - self._client._retrying = retrying if retrying else DEFAULT_RETRYING with open_session(self._session_kwargs["api_key"], self._headers) as sess: request = requests.Request( method, url, json=data, params=params, **kwargs ) pre_request = sess.prepare_request(request) response = retry_request( - method, pre_request, sess, self._client._retrying + method, pre_request, sess, self._session_kwargs["retrying"] ) if response.status_code == 401: diff --git a/src/civis/cli/__main__.py b/src/civis/cli/__main__.py index bce26848..93a1f9eb 100755 --- a/src/civis/cli/__main__.py +++ b/src/civis/cli/__main__.py @@ -41,7 +41,7 @@ from civis.base import get_headers, open_session from civis.resources import get_api_spec, CACHED_SPEC_PATH from civis.resources._resources import parse_method_name -from civis._utils import retry_request +from civis._retries import retry_request _REPLACEABLE_COMMAND_CHARS = re.compile(r"[^A-Za-z0-9]+") diff --git a/src/civis/cli/_cli_commands.py b/src/civis/cli/_cli_commands.py index 1263d57d..9fbc5168 100644 --- a/src/civis/cli/_cli_commands.py +++ b/src/civis/cli/_cli_commands.py @@ -14,6 +14,7 @@ import civis from civis.io import file_to_civis, civis_to_file from civis.utils import job_logs +from civis._retries import get_default_retrying # From http://patorjk.com/software/taag/#p=display&f=3D%20Diagonal&t=CIVIS @@ -243,8 +244,10 @@ def notebooks_download_cmd(notebook_id, path): """Download a notebook to a specified local path.""" client = civis.APIClient() info = client.notebooks.get(notebook_id) - response = requests.get(info["notebook_url"], stream=True, timeout=60) - response.raise_for_status() + for attempt in get_default_retrying(): + with attempt: + response = requests.get(info["notebook_url"], stream=True, timeout=60) + response.raise_for_status() chunk_size = 32 * 1024 chunked = response.iter_content(chunk_size) with open(path, "wb") as f: diff --git a/src/civis/client.py b/src/civis/client.py index d35b9c3f..9714427f 100644 --- a/src/civis/client.py +++ b/src/civis/client.py @@ -1,20 +1,19 @@ from __future__ import annotations +import collections from functools import lru_cache import logging import textwrap import warnings -from typing import TYPE_CHECKING + +import tenacity import civis from civis.resources import generate_classes_maybe_cached -from civis._utils import get_api_key, DEFAULT_RETRYING_STR +from civis._get_api_key import get_api_key +from civis._retries import DEFAULT_RETRYING_STR from civis.response import _RETURN_TYPES, find, find_one -if TYPE_CHECKING: - import collections - import tenacity - _log = logging.getLogger(__name__) @@ -59,6 +58,9 @@ class APIClient: please note that you should leave the ``retry`` attribute unspecified, because the conditions under which retries apply are pre-determined -- see :ref:`retries` for details. + In addition, the ``reraise`` attribute will be overridden to ``True`` + to raise the last exception (rather than tenacity's `RetryError`) + if all retry attempts are exhausted. user_agent : str, optional A custom user agent string to use for requests made by this client. The user agent string will be appended with the Python version, @@ -81,6 +83,11 @@ def __init__( ) self._feature_flags = () session_auth_key = get_api_key(api_key) + if retries is not None and not isinstance(retries, tenacity.Retrying): + raise TypeError( + "If provided, the `retries` parameter must be " + "a tenacity.Retrying instance." + ) self._session_kwargs = { "api_key": session_auth_key, "retrying": retries, @@ -102,11 +109,6 @@ def __init__( cls(self._session_kwargs, client=self, return_type=return_type), ) - # Don't create the `tenacity.Retrying` instance until we make the first - # API call with this `APIClient` instance. - # Once that happens, we keep re-using this `tenacity.Retrying` instance. - self._retrying = None - @property def feature_flags(self): """The feature flags for the current user. diff --git a/src/civis/client.pyi b/src/civis/client.pyi index bcb12106..3f534f52 100644 --- a/src/civis/client.pyi +++ b/src/civis/client.pyi @@ -5,6 +5,8 @@ from collections import OrderedDict from collections.abc import Iterator from typing import Any, List +import tenacity + from civis.response import Response class _Admin: @@ -998,6 +1000,8 @@ class _Clusters: *, base_type: str | None = ..., state: str | None = ..., + start_date: str | None = ..., + end_date: str | None = ..., limit: int | None = ..., page_num: int | None = ..., order: str | None = ..., @@ -1018,6 +1022,14 @@ class _Clusters: state : str, optional If specified, return deployments in these states. It accepts a comma- separated list, possible values are pending, running, terminated, sleeping + start_date : str, optional + If specified, return deployments created after this date. Must be 31 days + or less before end date. Defaults to 7 days prior to end date. The date + must be provided in the format YYYY-MM-DD. + end_date : str, optional + If specified, return deployments created before this date. Defaults to 7 + days after start date, or today if start date is not specified. The date + must be provided in the format YYYY-MM-DD. limit : int, optional Number of results to return. Defaults to its maximum of 50. page_num : int, optional @@ -58118,6 +58130,8 @@ class _Users: The number of times the user has signed in. - assuming_role : bool Whether the user is assuming this role or not. + - role_assumer : :class:`civis.Response` + Details about the role assumer. - assuming_admin : bool Whether the user is assuming admin. - assuming_admin_expiration : str (date-time) @@ -58360,6 +58374,8 @@ class _Users: The number of times the user has signed in. - assuming_role : bool Whether the user is assuming this role or not. + - role_assumer : :class:`civis.Response` + Details about the role assumer. - assuming_admin : bool Whether the user is assuming admin. - assuming_admin_expiration : str (date-time) @@ -58452,59 +58468,6 @@ class _Users: """ ... - def list_me_themes( - self, - ) -> List[_ResponseUsersListMeThemes]: - """List themes - - API URL: ``GET /users/me/themes`` - - Returns - ------- - :class:`civis.ListResponse` - - id : int - The ID of this theme. - - name : str - The name of this theme. - - created_at : str (date-time) - - updated_at : str (date-time) - """ - ... - - def get_me_themes( - self, - id: int, - ) -> _ResponseUsersGetMeThemes: - """Show a theme - - API URL: ``GET /users/me/themes/{id}`` - - Parameters - ---------- - id : int - The ID of this theme. - - Returns - ------- - :class:`civis.Response` - - id : int - The ID of this theme. - - name : str - The name of this theme. - - organization_ids : List[int] - List of organization ID's allowed to use this theme. - - settings : str - The theme configuration object. - - logo_file : :class:`civis.Response` - - id : int - The ID of the logo image file. - - download_url : str - The URL of the logo image file. - - created_at : str (date-time) - - updated_at : str (date-time) - """ - ... - def get( self, id: int, @@ -83190,6 +83153,7 @@ class _ResponseUsersListMe(Response): created_at: str sign_in_count: int assuming_role: bool + role_assumer: dict assuming_admin: bool assuming_admin_expiration: str superadmin_mode_expiration: str @@ -83224,6 +83188,7 @@ class _ResponseUsersPatchMe(Response): created_at: str sign_in_count: int assuming_role: bool + role_assumer: dict assuming_admin: bool assuming_admin_expiration: str superadmin_mode_expiration: str @@ -83259,25 +83224,6 @@ class _ResponseUsersListMeOrganizationAdmins(Response): online: bool email: str -class _ResponseUsersListMeThemes(Response): - id: int - name: str - created_at: str - updated_at: str - -class _ResponseUsersGetMeThemes(Response): - id: int - name: str - organization_ids: List[int] - settings: str - logo_file: _ResponseUsersGetMeThemesLogoFile - created_at: str - updated_at: str - -class _ResponseUsersGetMeThemesLogoFile(Response): - id: int - download_url: str - class _ResponseUsersGet(Response): id: int user: str @@ -84391,6 +84337,7 @@ class APIClient: api_version: str = ..., local_api_spec: OrderedDict | str | None = ..., force_refresh_api_spec: bool = ..., + retries: tenacity.Retrying | None = ..., user_agent: str | None = ..., ): ... def get_aws_credential_id( diff --git a/src/civis/io/_files.py b/src/civis/io/_files.py index a747af10..46463fb0 100644 --- a/src/civis/io/_files.py +++ b/src/civis/io/_files.py @@ -6,17 +6,16 @@ import logging import math import os -from random import random import re import shutil from tempfile import TemporaryDirectory -import time import requests from requests import HTTPError from civis import APIClient, find_one from civis.base import CivisAPIError, EmptyResultError +from civis._retries import get_default_retrying try: import pandas as pd @@ -40,11 +39,6 @@ MAX_FILE_SIZE = 5 * 2**40 # 5TB MAX_THREADS = 4 -RETRY_EXCEPTIONS = ( - requests.HTTPError, - requests.ConnectionError, - requests.ConnectTimeout, -) log = logging.getLogger(__name__) # standard chunk size; provides good performance across various buffer sizes @@ -114,7 +108,6 @@ def _single_upload(buf, name, client, **kwargs): # Store the current buffer position in case we need to retry below. buf_orig_position = buf.tell() - @_retry(RETRY_EXCEPTIONS) def _post(): # Reset the buffer in case we had to retry. buf.seek(buf_orig_position) @@ -129,7 +122,9 @@ def _post(): msg = _get_aws_error_message(response) raise HTTPError(msg, response=response) - _post() + for attempt in get_default_retrying(): + with attempt: + _post() log.debug("Uploaded File %d", file_response.id) return file_response.id @@ -156,8 +151,6 @@ def _multipart_upload(buf, name, file_size, client, **kwargs): if num_parts != len(urls): raise ValueError(f"There are {num_parts} file parts but only {len(urls)} urls") - # upload function wrapped with a retry decorator - @_retry(RETRY_EXCEPTIONS) def _upload_part_base(item, file_path, part_size, file_size): part_num, part_url = item[0], item[1] offset = part_size * part_num @@ -175,6 +168,8 @@ def _upload_part_base(item, file_path, part_size, file_size): log.debug("Completed upload of file part %s", part_num) + _upload_part_base = get_default_retrying().wraps(_upload_part_base) + _upload_part = partial( _upload_part_base, file_path=buf.name, @@ -393,7 +388,6 @@ def _civis_to_file(file_id, buf, client=None): # Store the current buffer position in case we need to retry below. buf_orig_position = buf.tell() - @_retry(RETRY_EXCEPTIONS) def _download_url_to_buf(): # Reset the buffer in case we had to retry. buf.seek(buf_orig_position) @@ -404,7 +398,9 @@ def _download_url_to_buf(): for lines in chunked: buf.write(lines) - _download_url_to_buf() + for attempt in get_default_retrying(): + with attempt: + _download_url_to_buf() def file_id_from_run_output(name, job_id, run_id, regex=False, client=None): @@ -728,53 +724,3 @@ def read(self, size=-1): data = self.buf.read(bytes_to_read) self.bytes_read += len(data) return data - - -def _retry(exceptions, retries=5, delay=0.5, backoff=2): - """ - Retry decorator - - Parameters - ---------- - exceptions: Exception - exceptions to trigger retry - retries: int, optional - number of retries to perform - delay: float, optional - delay before next retry - backoff: int, optional - factor used to calculate the exponential increase - delay after each retry - - Returns - ------- - retry decorator - - Raises - ------ - exception raised by decorator function - """ - - def deco_retry(f): - def f_retry(*args, **kwargs): - n_failed = 0 - new_delay = delay - while True: - try: - return f(*args, **kwargs) - except exceptions as exc: - if n_failed < retries: - n_failed += 1 - msg = "%s, Retrying in %d seconds..." % (str(exc), new_delay) - log.debug(msg) - time.sleep(new_delay) - new_delay = min( - (pow(2, n_failed) / 4) * (random() + backoff), # nosec - 50 + 10 * random(), # nosec - ) - else: - raise exc - - return f_retry - - return deco_retry diff --git a/src/civis/io/_tables.py b/src/civis/io/_tables.py index 5bae88ea..273dfef6 100644 --- a/src/civis/io/_tables.py +++ b/src/civis/io/_tables.py @@ -23,6 +23,7 @@ from civis.io import civis_to_file, file_to_civis from civis.utils import run_job from civis._deprecation import DeprecatedKwargDefault +from civis._retries import get_default_retrying import requests @@ -474,8 +475,10 @@ def read_civis_sql( kwargs["encoding"] = encoding data = pl.read_csv(url, **kwargs) else: - response = requests.get(url, stream=True, timeout=60) - response.raise_for_status() + for attempt in get_default_retrying(): + with attempt: + response = requests.get(url, stream=True, timeout=60) + response.raise_for_status() with io.StringIO() as buf: _decompress_stream( @@ -1430,8 +1433,10 @@ def _decompress_stream(response, buf, write_bytes=True, encoding="utf-8"): def _download_file(url, local_path, headers, compression): - response = requests.get(url, stream=True, timeout=60) - response.raise_for_status() + for attempt in get_default_retrying(): + with attempt: + response = requests.get(url, stream=True, timeout=60) + response.raise_for_status() # gzipped buffers can be concatenated so write headers as gzip if compression == "gzip": diff --git a/src/civis/resources/_client_pyi.py b/src/civis/resources/_client_pyi.py index e4c1a85a..f93b5f1f 100644 --- a/src/civis/resources/_client_pyi.py +++ b/src/civis/resources/_client_pyi.py @@ -52,6 +52,8 @@ def generate_client_pyi(client_pyi_path, api_spec_path): from collections.abc import Iterator from typing import Any, List +import tenacity + from civis.response import Response """ @@ -150,6 +152,7 @@ def __init__( api_version: str = ..., local_api_spec: OrderedDict | str | None = ..., force_refresh_api_spec: bool = ..., + retries: tenacity.Retrying | None = ..., user_agent: str | None = ..., ): ... def get_aws_credential_id( diff --git a/src/civis/resources/_resources.py b/src/civis/resources/_resources.py index 0ddc6289..1e62c138 100644 --- a/src/civis/resources/_resources.py +++ b/src/civis/resources/_resources.py @@ -22,7 +22,8 @@ open_session, ) from civis._camel_to_snake import camel_to_snake -from civis._utils import get_api_key, retry_request +from civis._get_api_key import get_api_key +from civis._retries import retry_request from civis.response import Response diff --git a/src/civis/resources/civis_api_spec.json b/src/civis/resources/civis_api_spec.json index 97794620..47a072a6 100644 --- a/src/civis/resources/civis_api_spec.json +++ b/src/civis/resources/civis_api_spec.json @@ -1 +1 @@ -{"swagger":"2.0","info":{"title":"Civis Analytics API","version":"1"},"host":"api.civisanalytics.com","schemes":["https"],"produces":["application/json"],"paths":{"/admin/organizations":{"get":{"summary":"List organizations","description":null,"deprecated":false,"parameters":[{"name":"status","in":"query","required":false,"description":"The status of the organization (active/trial/inactive).","type":"array","items":{"type":"string"}},{"name":"org_type","in":"query","required":false,"description":"The organization type (platform/ads/survey_vendor/other).","type":"array","items":{"type":"string"}}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object7"}}}},"x-examples":[{"resource":"Admin","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/admin/organizations","description":"List all orgs","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/admin/organizations","request_body":null,"request_headers":{"Content-Type":"application/json","Authorization":"Bearer 1yDslJPlzrkcnKN_o9cuxaIYEHMW3tR-oyIurJKJ1K4","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 1,\n \"name\": \"Civis Analytics\",\n \"slug\": \"civis\",\n \"accountManagerId\": null,\n \"csSpecialistId\": null,\n \"status\": \"active\",\n \"orgType\": null,\n \"customBranding\": null,\n \"contractSize\": null,\n \"maxAnalystUsers\": null,\n \"maxReportUsers\": null,\n \"vertical\": null,\n \"csMetadata\": null,\n \"removeFooterInEmails\": false,\n \"salesforceAccountId\": null,\n \"tableauSiteId\": null,\n \"fedrampEnabled\": true,\n \"createdById\": null,\n \"lastUpdatedById\": null,\n \"advancedSettings\": {\n \"dedicatedDjPoolEnabled\": false\n },\n \"tableauRefreshHistory\": [\n {\n \"time_period\": \"2023-07\",\n \"usage\": 0\n },\n {\n \"time_period\": \"2023-06\",\n \"usage\": 0\n }\n ]\n },\n {\n \"id\": 2,\n \"name\": \"Demo\",\n \"slug\": \"demo\",\n \"accountManagerId\": null,\n \"csSpecialistId\": null,\n \"status\": \"active\",\n \"orgType\": null,\n \"customBranding\": null,\n \"contractSize\": null,\n \"maxAnalystUsers\": null,\n \"maxReportUsers\": null,\n \"vertical\": null,\n \"csMetadata\": null,\n \"removeFooterInEmails\": false,\n \"salesforceAccountId\": null,\n \"tableauSiteId\": null,\n \"fedrampEnabled\": false,\n \"createdById\": null,\n \"lastUpdatedById\": null,\n \"advancedSettings\": {\n \"dedicatedDjPoolEnabled\": false\n },\n \"tableauRefreshHistory\": [\n {\n \"time_period\": \"2023-07\",\n \"usage\": 0\n },\n {\n \"time_period\": \"2023-06\",\n \"usage\": 0\n }\n ]\n },\n {\n \"id\": 3,\n \"name\": \"Default\",\n \"slug\": \"default\",\n \"accountManagerId\": null,\n \"csSpecialistId\": null,\n \"status\": \"active\",\n \"orgType\": null,\n \"customBranding\": null,\n \"contractSize\": null,\n \"maxAnalystUsers\": null,\n \"maxReportUsers\": null,\n \"vertical\": null,\n \"csMetadata\": null,\n \"removeFooterInEmails\": false,\n \"salesforceAccountId\": null,\n \"tableauSiteId\": null,\n \"fedrampEnabled\": false,\n \"createdById\": null,\n \"lastUpdatedById\": null,\n \"advancedSettings\": {\n \"dedicatedDjPoolEnabled\": false\n },\n \"tableauRefreshHistory\": [\n {\n \"time_period\": \"2023-07\",\n \"usage\": 0\n },\n {\n \"time_period\": \"2023-06\",\n \"usage\": 0\n }\n ]\n },\n {\n \"id\": 4,\n \"name\": \"Managers\",\n \"slug\": \"managers\",\n \"accountManagerId\": null,\n \"csSpecialistId\": null,\n \"status\": \"active\",\n \"orgType\": null,\n \"customBranding\": null,\n \"contractSize\": null,\n \"maxAnalystUsers\": null,\n \"maxReportUsers\": null,\n \"vertical\": null,\n \"csMetadata\": null,\n \"removeFooterInEmails\": false,\n \"salesforceAccountId\": null,\n \"tableauSiteId\": null,\n \"fedrampEnabled\": false,\n \"createdById\": null,\n \"lastUpdatedById\": null,\n \"advancedSettings\": {\n \"dedicatedDjPoolEnabled\": false\n },\n \"tableauRefreshHistory\": [\n {\n \"time_period\": \"2023-07\",\n \"usage\": 0\n },\n {\n \"time_period\": \"2023-06\",\n \"usage\": 0\n }\n ]\n },\n {\n \"id\": 5,\n \"name\": \"Organization 1\",\n \"slug\": \"organization_b\",\n \"accountManagerId\": 1,\n \"csSpecialistId\": 2,\n \"status\": \"active\",\n \"orgType\": \"platform\",\n \"customBranding\": null,\n \"contractSize\": 25555,\n \"maxAnalystUsers\": 3,\n \"maxReportUsers\": 20,\n \"vertical\": \"Snake Handling\",\n \"csMetadata\": \"{\\\"second_vertical\\\":\\\"snake disposal\\\"}\",\n \"removeFooterInEmails\": false,\n \"salesforceAccountId\": null,\n \"tableauSiteId\": \"tableau-site-id\",\n \"fedrampEnabled\": false,\n \"createdById\": null,\n \"lastUpdatedById\": null,\n \"advancedSettings\": {\n \"dedicatedDjPoolEnabled\": false\n },\n \"tableauRefreshHistory\": [\n {\n \"time_period\": \"2023-07\",\n \"usage\": 0\n },\n {\n \"time_period\": \"2023-06\",\n \"usage\": 0\n }\n ]\n },\n {\n \"id\": 6,\n \"name\": \"Organization 2\",\n \"slug\": \"organization_c\",\n \"accountManagerId\": null,\n \"csSpecialistId\": null,\n \"status\": \"active\",\n \"orgType\": \"ads\",\n \"customBranding\": null,\n \"contractSize\": null,\n \"maxAnalystUsers\": null,\n \"maxReportUsers\": null,\n \"vertical\": null,\n \"csMetadata\": null,\n \"removeFooterInEmails\": false,\n \"salesforceAccountId\": null,\n \"tableauSiteId\": \"tableau-site-id\",\n \"fedrampEnabled\": false,\n \"createdById\": null,\n \"lastUpdatedById\": null,\n \"advancedSettings\": {\n \"dedicatedDjPoolEnabled\": false\n },\n \"tableauRefreshHistory\": [\n {\n \"time_period\": \"2023-07\",\n \"usage\": 0\n },\n {\n \"time_period\": \"2023-06\",\n \"usage\": 0\n }\n ]\n },\n {\n \"id\": 7,\n \"name\": \"Organization 3\",\n \"slug\": \"organization_d\",\n \"accountManagerId\": null,\n \"csSpecialistId\": null,\n \"status\": \"trial\",\n \"orgType\": \"platform\",\n \"customBranding\": null,\n \"contractSize\": null,\n \"maxAnalystUsers\": null,\n \"maxReportUsers\": null,\n \"vertical\": null,\n \"csMetadata\": null,\n \"removeFooterInEmails\": false,\n \"salesforceAccountId\": null,\n \"tableauSiteId\": \"tableau-site-id\",\n \"fedrampEnabled\": false,\n \"createdById\": null,\n \"lastUpdatedById\": null,\n \"advancedSettings\": {\n \"dedicatedDjPoolEnabled\": false\n },\n \"tableauRefreshHistory\": [\n {\n \"time_period\": \"2023-07\",\n \"usage\": 0\n },\n {\n \"time_period\": \"2023-06\",\n \"usage\": 0\n }\n ]\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"74e73e7bf7620c87b7e673af70baa1fb\"","X-Request-Id":"42077289-bebd-41f1-828b-811aed4c544d","X-Runtime":"0.121092","Content-Length":"3880"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/admin/organizations\" -X GET \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer 1yDslJPlzrkcnKN_o9cuxaIYEHMW3tR-oyIurJKJ1K4\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Admin","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/admin/organizations","description":"Filter orgs","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/admin/organizations?status[]=active&status[]=trial&org_type=platform","request_body":null,"request_headers":{"Content-Type":"application/json","Authorization":"Bearer kOgBL0QrwUjMGCHQmmaQBCXr6xmkHGTzGvvC99OtSq0","Host":"api.civis.test","Cookie":""},"request_query_parameters":{"status":["active","trial"],"org_type":"platform"},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 8,\n \"name\": \"Organization 4\",\n \"slug\": \"organization_e\",\n \"accountManagerId\": null,\n \"csSpecialistId\": null,\n \"status\": \"active\",\n \"orgType\": \"platform\",\n \"customBranding\": null,\n \"contractSize\": 25555,\n \"maxAnalystUsers\": 3,\n \"maxReportUsers\": 20,\n \"vertical\": \"Snake Handling\",\n \"csMetadata\": \"{\\\"second_vertical\\\":\\\"snake disposal\\\"}\",\n \"removeFooterInEmails\": false,\n \"salesforceAccountId\": null,\n \"tableauSiteId\": \"tableau-site-id\",\n \"fedrampEnabled\": false,\n \"createdById\": null,\n \"lastUpdatedById\": null,\n \"advancedSettings\": {\n \"dedicatedDjPoolEnabled\": false\n },\n \"tableauRefreshHistory\": [\n {\n \"time_period\": \"2023-07\",\n \"usage\": 0\n },\n {\n \"time_period\": \"2023-06\",\n \"usage\": 0\n }\n ]\n },\n {\n \"id\": 10,\n \"name\": \"Organization 6\",\n \"slug\": \"organization_g\",\n \"accountManagerId\": null,\n \"csSpecialistId\": null,\n \"status\": \"trial\",\n \"orgType\": \"platform\",\n \"customBranding\": null,\n \"contractSize\": null,\n \"maxAnalystUsers\": null,\n \"maxReportUsers\": null,\n \"vertical\": null,\n \"csMetadata\": null,\n \"removeFooterInEmails\": false,\n \"salesforceAccountId\": null,\n \"tableauSiteId\": \"tableau-site-id\",\n \"fedrampEnabled\": false,\n \"createdById\": null,\n \"lastUpdatedById\": null,\n \"advancedSettings\": {\n \"dedicatedDjPoolEnabled\": false\n },\n \"tableauRefreshHistory\": [\n {\n \"time_period\": \"2023-07\",\n \"usage\": 0\n },\n {\n \"time_period\": \"2023-06\",\n \"usage\": 0\n }\n ]\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"2682b78bfeb17e80b8640cae322434f1\"","X-Request-Id":"7867350a-2bf6-4582-a840-b71ca9033591","X-Runtime":"0.015303","Content-Length":"1183"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/admin/organizations?status[]=active&status[]=trial&org_type=platform\" -X GET \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer kOgBL0QrwUjMGCHQmmaQBCXr6xmkHGTzGvvC99OtSq0\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Admin","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/admin/organizations","description":"List orgs","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/admin/organizations","request_body":null,"request_headers":{"Content-Type":"application/json","Authorization":"Bearer MJeydcFRT9x4SsYUsgBPXa1r1Mxm3h_Iq9FWmB4Drq4","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 11,\n \"name\": \"Organization 7\",\n \"slug\": \"organization_h\",\n \"accountManagerId\": null,\n \"csSpecialistId\": null,\n \"status\": \"active\",\n \"orgType\": \"platform\",\n \"customBranding\": null,\n \"contractSize\": 25555,\n \"maxAnalystUsers\": 3,\n \"maxReportUsers\": 20,\n \"vertical\": \"Snake Handling\",\n \"csMetadata\": \"{\\\"second_vertical\\\":\\\"snake disposal\\\"}\",\n \"removeFooterInEmails\": false,\n \"salesforceAccountId\": null,\n \"tableauSiteId\": \"tableau-site-id\",\n \"fedrampEnabled\": false,\n \"createdById\": null,\n \"lastUpdatedById\": null,\n \"advancedSettings\": {\n \"dedicatedDjPoolEnabled\": false\n },\n \"tableauRefreshHistory\": [\n {\n \"time_period\": \"2023-07\",\n \"usage\": 0\n },\n {\n \"time_period\": \"2023-06\",\n \"usage\": 0\n }\n ]\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"9f2d9ba0bf1356c1edc9eb15df18b528\"","X-Request-Id":"e060652d-6607-433e-b805-f2a88543f09b","X-Runtime":"0.015294","Content-Length":"616"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/admin/organizations\" -X GET \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer MJeydcFRT9x4SsYUsgBPXa1r1Mxm3h_Iq9FWmB4Drq4\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/aliases/{id}/shares":{"get":{"summary":"List users and groups permissioned on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object9"}}}},"x-examples":null,"x-deprecation-warning":null}},"/aliases/{id}/shares/users":{"put":{"summary":"Set the permissions users have on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"Object13","in":"body","schema":{"$ref":"#/definitions/Object13"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object9"}}},"x-examples":null,"x-deprecation-warning":null}},"/aliases/{id}/shares/users/{user_id}":{"delete":{"summary":"Revoke the permissions a user has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"user_id","in":"path","required":true,"description":"The ID of the user.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/aliases/{id}/shares/groups":{"put":{"summary":"Set the permissions groups has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"Object14","in":"body","schema":{"$ref":"#/definitions/Object14"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object9"}}},"x-examples":null,"x-deprecation-warning":null}},"/aliases/{id}/shares/groups/{group_id}":{"delete":{"summary":"Revoke the permissions a group has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"group_id","in":"path","required":true,"description":"The ID of the group.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/aliases/{id}/dependencies":{"get":{"summary":"List dependent objects for this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"user_id","in":"query","required":false,"description":"ID of target user","type":"integer"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object15"}}}},"x-examples":null,"x-deprecation-warning":null}},"/aliases/{id}/transfer":{"put":{"summary":"Transfer ownership of this object to another user","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"Object16","in":"body","schema":{"$ref":"#/definitions/Object16"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object17"}}},"x-examples":null,"x-deprecation-warning":null}},"/aliases/":{"get":{"summary":"List Aliases","description":null,"deprecated":false,"parameters":[{"name":"object_type","in":"query","required":false,"description":"Filter results by object type. Pass multiple object types with a comma-separatedlist. Valid types include: cass_ncoa, container_script, geocode, identity_resolution, dbt_script, python_script, r_script, javascript_script, sql_script, project, notebook, workflow, template_script, template_report, service, report, tableau and service_report.","type":"string"},{"name":"limit","in":"query","required":false,"description":"Number of results to return. Defaults to 50. Maximum allowed is 1000.","type":"integer"},{"name":"page_num","in":"query","required":false,"description":"Page number of the results to return. Defaults to the first page, 1.","type":"integer"},{"name":"order","in":"query","required":false,"description":"The field on which to order the result set. Defaults to id. Must be one of: id, object_type.","type":"string"},{"name":"order_dir","in":"query","required":false,"description":"Direction in which to sort, either asc (ascending) or desc (descending) defaulting to asc.","type":"string"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object19"}}}},"x-examples":null,"x-deprecation-warning":null},"post":{"summary":"Create an Alias","description":null,"deprecated":false,"parameters":[{"name":"Object20","in":"body","schema":{"$ref":"#/definitions/Object20"},"required":true}],"responses":{"201":{"description":"success","schema":{"$ref":"#/definitions/Object19"}}},"x-examples":null,"x-deprecation-warning":null}},"/aliases/{id}":{"get":{"summary":"Get an Alias","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object19"}}},"x-examples":null,"x-deprecation-warning":null},"put":{"summary":"Replace all attributes of this Alias","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The id of the Alias object.","type":"integer"},{"name":"Object21","in":"body","schema":{"$ref":"#/definitions/Object21"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object19"}}},"x-examples":null,"x-deprecation-warning":null},"patch":{"summary":"Update some attributes of this Alias","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The id of the Alias object.","type":"integer"},{"name":"Object22","in":"body","schema":{"$ref":"#/definitions/Object22"},"required":false}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object19"}}},"x-examples":null,"x-deprecation-warning":null},"delete":{"summary":"Delete an alias","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The id of the Alias object.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/aliases/{object_type}/{alias}":{"get":{"summary":"Get details about an alias within an FCO type","description":null,"deprecated":false,"parameters":[{"name":"object_type","in":"path","required":true,"description":"The type of the object. Valid types include: cass_ncoa, container_script, geocode, identity_resolution, dbt_script, python_script, r_script, javascript_script, sql_script, project, notebook, workflow, template_script, template_report, service, report, tableau and service_report.","type":"string"},{"name":"alias","in":"path","required":true,"description":"The alias of the object","type":"string"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object19"}}},"x-examples":null,"x-deprecation-warning":null}},"/announcements/":{"get":{"summary":"List announcements","description":null,"deprecated":false,"parameters":[{"name":"limit","in":"query","required":false,"description":"Number of results to return. Defaults to 10. Maximum allowed is 50.","type":"integer"},{"name":"page_num","in":"query","required":false,"description":"Page number of the results to return. Defaults to the first page, 1.","type":"integer"},{"name":"order","in":"query","required":false,"description":"The field on which to order the result set. Defaults to released_at. Must be one of: released_at.","type":"string"},{"name":"order_dir","in":"query","required":false,"description":"Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc.","type":"string"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object0"}}}},"x-examples":[{"resource":"Announcements","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/announcements","description":"List first page of announcements","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/announcements","request_body":null,"request_headers":{"Content-Type":"application/json","Authorization":"Bearer qEkd3_1rezHTtG68ijdjx5x1ac1ID8o0CPwC9Sm3g6g","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 44,\n \"subject\": \"Important message 44\",\n \"body\": \"The square root of 44 is 6.63.\",\n \"releasedAt\": \"2023-07-18T17:44:24.000Z\",\n \"createdAt\": \"2023-07-18T17:39:24.000Z\",\n \"updatedAt\": \"2023-07-18T17:39:24.000Z\"\n },\n {\n \"id\": 45,\n \"subject\": \"Important message 45\",\n \"body\": \"The square root of 45 is 6.71.\",\n \"releasedAt\": \"2023-07-18T16:44:24.000Z\",\n \"createdAt\": \"2023-07-18T16:39:24.000Z\",\n \"updatedAt\": \"2023-07-18T16:39:24.000Z\"\n },\n {\n \"id\": 46,\n \"subject\": \"Important message 46\",\n \"body\": \"The square root of 46 is 6.78.\",\n \"releasedAt\": \"2023-07-18T15:44:24.000Z\",\n \"createdAt\": \"2023-07-18T15:39:24.000Z\",\n \"updatedAt\": \"2023-07-18T15:39:24.000Z\"\n },\n {\n \"id\": 47,\n \"subject\": \"Important message 47\",\n \"body\": \"The square root of 47 is 6.86.\",\n \"releasedAt\": \"2023-07-18T14:44:24.000Z\",\n \"createdAt\": \"2023-07-18T14:39:24.000Z\",\n \"updatedAt\": \"2023-07-18T14:39:24.000Z\"\n },\n {\n \"id\": 48,\n \"subject\": \"Important message 48\",\n \"body\": \"The square root of 48 is 6.93.\",\n \"releasedAt\": \"2023-07-18T13:44:24.000Z\",\n \"createdAt\": \"2023-07-18T13:39:24.000Z\",\n \"updatedAt\": \"2023-07-18T13:39:24.000Z\"\n },\n {\n \"id\": 49,\n \"subject\": \"Important message 49\",\n \"body\": \"The square root of 49 is 7.0.\",\n \"releasedAt\": \"2023-07-18T12:44:24.000Z\",\n \"createdAt\": \"2023-07-18T12:39:24.000Z\",\n \"updatedAt\": \"2023-07-18T12:39:24.000Z\"\n },\n {\n \"id\": 50,\n \"subject\": \"Important message 50\",\n \"body\": \"The square root of 50 is 7.07.\",\n \"releasedAt\": \"2023-07-18T11:44:24.000Z\",\n \"createdAt\": \"2023-07-18T11:39:24.000Z\",\n \"updatedAt\": \"2023-07-18T11:39:24.000Z\"\n },\n {\n \"id\": 51,\n \"subject\": \"Important message 51\",\n \"body\": \"The square root of 51 is 7.14.\",\n \"releasedAt\": \"2023-07-18T10:44:24.000Z\",\n \"createdAt\": \"2023-07-18T10:39:24.000Z\",\n \"updatedAt\": \"2023-07-18T10:39:24.000Z\"\n },\n {\n \"id\": 52,\n \"subject\": \"Important message 52\",\n \"body\": \"The square root of 52 is 7.21.\",\n \"releasedAt\": \"2023-07-18T09:44:24.000Z\",\n \"createdAt\": \"2023-07-18T09:39:24.000Z\",\n \"updatedAt\": \"2023-07-18T09:39:24.000Z\"\n },\n {\n \"id\": 53,\n \"subject\": \"Important message 53\",\n \"body\": \"The square root of 53 is 7.28.\",\n \"releasedAt\": \"2023-07-18T08:44:24.000Z\",\n \"createdAt\": \"2023-07-18T08:39:24.000Z\",\n \"updatedAt\": \"2023-07-18T08:39:24.000Z\"\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","Date":"2023-07-18T18:39:24.900Z","Access-Control-Expose-Headers":"Date, X-Pagination-Per-Page, X-Pagination-Current-Page, X-Pagination-Total-Pages, X-Pagination-Total-Entries","X-Pagination-Per-Page":"10","X-Pagination-Current-Page":"1","X-Pagination-Total-Pages":"2","X-Pagination-Total-Entries":"20","Content-Type":"application/json; charset=utf-8","ETag":"W/\"9d41de72d1d0ee40af9342bf952fd109\"","X-Request-Id":"a273f2b0-7622-4a3d-a9cb-764b1972eb9c","X-Runtime":"0.014117","Content-Length":"2010"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/announcements\" -X GET \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer qEkd3_1rezHTtG68ijdjx5x1ac1ID8o0CPwC9Sm3g6g\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/clusters/kubernetes":{"get":{"summary":"List Kubernetes Clusters","description":null,"deprecated":false,"parameters":[{"name":"organization_id","in":"query","required":false,"description":"The ID of this cluster's organization. Cannot be used along with the organization slug.","type":"integer"},{"name":"organization_slug","in":"query","required":false,"description":"The slug of this cluster's organization. Cannot be used along with the organization ID.","type":"string"},{"name":"raw_cluster_slug","in":"query","required":false,"description":"The slug of this cluster's raw configuration.","type":"string"},{"name":"exclude_inactive_orgs","in":"query","required":false,"description":"When true, excludes KubeClusters associated with inactive orgs. Defaults to false.","type":"boolean"},{"name":"limit","in":"query","required":false,"description":"Number of results to return. Defaults to its maximum of 50.","type":"integer"},{"name":"page_num","in":"query","required":false,"description":"Page number of the results to return. Defaults to the first page, 1.","type":"integer"},{"name":"order","in":"query","required":false,"description":"The field on which to order the result set. Defaults to organization_id. Must be one of: organization_id, created_at.","type":"string"},{"name":"order_dir","in":"query","required":false,"description":"Direction in which to sort, either asc (ascending) or desc (descending) defaulting to asc.","type":"string"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object24"}}}},"x-examples":[{"resource":"Clusters","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/clusters/kubernetes","description":"List all Kubernetes clusters","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/clusters/kubernetes","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer PEuTh9FL1T9g_zhIBnd2zO7DD9VJSMlStMfgMo91zFc","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 1,\n \"organizationId\": 1,\n \"organizationName\": \"Civis Analytics\",\n \"organizationSlug\": \"civis\",\n \"rawClusterSlug\": \"cluster03-kubernetes-us-east-1\",\n \"customPartitions\": false,\n \"clusterPartitions\": [\n {\n \"clusterPartitionId\": 1,\n \"name\": \"jobs\",\n \"labels\": [\n \"Job\"\n ],\n \"instanceConfigs\": [\n {\n \"instanceConfigId\": 1,\n \"instanceType\": \"m4.xlarge\",\n \"minInstances\": 1,\n \"maxInstances\": 8,\n \"instanceMaxMemory\": 15320,\n \"instanceMaxCpu\": 4096,\n \"instanceMaxDisk\": 90.0,\n \"usageStats\": {\n \"pendingMemoryRequested\": null,\n \"pendingCpuRequested\": null,\n \"runningMemoryRequested\": null,\n \"runningCpuRequested\": null,\n \"pendingDeployments\": null,\n \"runningDeployments\": null\n }\n }\n ],\n \"defaultInstanceConfigId\": 1\n },\n {\n \"clusterPartitionId\": 2,\n \"name\": \"notebook_services\",\n \"labels\": [\n \"Notebook\",\n \"Service\"\n ],\n \"instanceConfigs\": [\n {\n \"instanceConfigId\": 2,\n \"instanceType\": \"m4.xlarge\",\n \"minInstances\": 0,\n \"maxInstances\": 2,\n \"instanceMaxMemory\": 15320,\n \"instanceMaxCpu\": 4096,\n \"instanceMaxDisk\": 90.0,\n \"usageStats\": {\n \"pendingMemoryRequested\": null,\n \"pendingCpuRequested\": null,\n \"runningMemoryRequested\": null,\n \"runningCpuRequested\": null,\n \"pendingDeployments\": null,\n \"runningDeployments\": null\n }\n }\n ],\n \"defaultInstanceConfigId\": 2\n }\n ],\n \"isNatEnabled\": false\n },\n {\n \"id\": 2,\n \"organizationId\": 2,\n \"organizationName\": \"civismatching\",\n \"organizationSlug\": \"platform-matching\",\n \"rawClusterSlug\": \"cluster03-kubernetes-us-east-1\",\n \"customPartitions\": false,\n \"clusterPartitions\": [\n {\n \"clusterPartitionId\": 3,\n \"name\": \"jobs\",\n \"labels\": [\n \"Job\"\n ],\n \"instanceConfigs\": [\n {\n \"instanceConfigId\": 3,\n \"instanceType\": \"m4.xlarge\",\n \"minInstances\": 1,\n \"maxInstances\": 8,\n \"instanceMaxMemory\": 15320,\n \"instanceMaxCpu\": 4096,\n \"instanceMaxDisk\": 90.0,\n \"usageStats\": {\n \"pendingMemoryRequested\": null,\n \"pendingCpuRequested\": null,\n \"runningMemoryRequested\": null,\n \"runningCpuRequested\": null,\n \"pendingDeployments\": null,\n \"runningDeployments\": null\n }\n }\n ],\n \"defaultInstanceConfigId\": 3\n },\n {\n \"clusterPartitionId\": 4,\n \"name\": \"notebook_services\",\n \"labels\": [\n \"Notebook\",\n \"Service\"\n ],\n \"instanceConfigs\": [\n {\n \"instanceConfigId\": 4,\n \"instanceType\": \"m4.xlarge\",\n \"minInstances\": 0,\n \"maxInstances\": 2,\n \"instanceMaxMemory\": 15320,\n \"instanceMaxCpu\": 4096,\n \"instanceMaxDisk\": 90.0,\n \"usageStats\": {\n \"pendingMemoryRequested\": null,\n \"pendingCpuRequested\": null,\n \"runningMemoryRequested\": null,\n \"runningCpuRequested\": null,\n \"pendingDeployments\": null,\n \"runningDeployments\": null\n }\n }\n ],\n \"defaultInstanceConfigId\": 4\n }\n ],\n \"isNatEnabled\": false\n },\n {\n \"id\": 3,\n \"organizationId\": 3,\n \"organizationName\": \"Demo\",\n \"organizationSlug\": \"demo\",\n \"rawClusterSlug\": \"cluster03-kubernetes-us-east-1\",\n \"customPartitions\": false,\n \"clusterPartitions\": [\n {\n \"clusterPartitionId\": 5,\n \"name\": \"jobs\",\n \"labels\": [\n \"Job\"\n ],\n \"instanceConfigs\": [\n {\n \"instanceConfigId\": 5,\n \"instanceType\": \"m4.xlarge\",\n \"minInstances\": 1,\n \"maxInstances\": 8,\n \"instanceMaxMemory\": 15320,\n \"instanceMaxCpu\": 4096,\n \"instanceMaxDisk\": 90.0,\n \"usageStats\": {\n \"pendingMemoryRequested\": null,\n \"pendingCpuRequested\": null,\n \"runningMemoryRequested\": null,\n \"runningCpuRequested\": null,\n \"pendingDeployments\": null,\n \"runningDeployments\": null\n }\n }\n ],\n \"defaultInstanceConfigId\": 5\n },\n {\n \"clusterPartitionId\": 6,\n \"name\": \"notebook_services\",\n \"labels\": [\n \"Notebook\",\n \"Service\"\n ],\n \"instanceConfigs\": [\n {\n \"instanceConfigId\": 6,\n \"instanceType\": \"m4.xlarge\",\n \"minInstances\": 0,\n \"maxInstances\": 2,\n \"instanceMaxMemory\": 15320,\n \"instanceMaxCpu\": 4096,\n \"instanceMaxDisk\": 90.0,\n \"usageStats\": {\n \"pendingMemoryRequested\": null,\n \"pendingCpuRequested\": null,\n \"runningMemoryRequested\": null,\n \"runningCpuRequested\": null,\n \"pendingDeployments\": null,\n \"runningDeployments\": null\n }\n }\n ],\n \"defaultInstanceConfigId\": 6\n }\n ],\n \"isNatEnabled\": false\n },\n {\n \"id\": 4,\n \"organizationId\": 4,\n \"organizationName\": \"Default\",\n \"organizationSlug\": \"default\",\n \"rawClusterSlug\": \"cluster03-kubernetes-us-east-1\",\n \"customPartitions\": false,\n \"clusterPartitions\": [\n {\n \"clusterPartitionId\": 7,\n \"name\": \"jobs\",\n \"labels\": [\n \"Job\"\n ],\n \"instanceConfigs\": [\n {\n \"instanceConfigId\": 7,\n \"instanceType\": \"m4.xlarge\",\n \"minInstances\": 1,\n \"maxInstances\": 8,\n \"instanceMaxMemory\": 15320,\n \"instanceMaxCpu\": 4096,\n \"instanceMaxDisk\": 90.0,\n \"usageStats\": {\n \"pendingMemoryRequested\": null,\n \"pendingCpuRequested\": null,\n \"runningMemoryRequested\": null,\n \"runningCpuRequested\": null,\n \"pendingDeployments\": null,\n \"runningDeployments\": null\n }\n }\n ],\n \"defaultInstanceConfigId\": 7\n },\n {\n \"clusterPartitionId\": 8,\n \"name\": \"notebook_services\",\n \"labels\": [\n \"Notebook\",\n \"Service\"\n ],\n \"instanceConfigs\": [\n {\n \"instanceConfigId\": 8,\n \"instanceType\": \"m4.xlarge\",\n \"minInstances\": 0,\n \"maxInstances\": 2,\n \"instanceMaxMemory\": 15320,\n \"instanceMaxCpu\": 4096,\n \"instanceMaxDisk\": 90.0,\n \"usageStats\": {\n \"pendingMemoryRequested\": null,\n \"pendingCpuRequested\": null,\n \"runningMemoryRequested\": null,\n \"runningCpuRequested\": null,\n \"pendingDeployments\": null,\n \"runningDeployments\": null\n }\n }\n ],\n \"defaultInstanceConfigId\": 8\n }\n ],\n \"isNatEnabled\": false\n },\n {\n \"id\": 5,\n \"organizationId\": 5,\n \"organizationName\": \"Managers\",\n \"organizationSlug\": \"managers\",\n \"rawClusterSlug\": \"cluster03-kubernetes-us-east-1\",\n \"customPartitions\": false,\n \"clusterPartitions\": [\n {\n \"clusterPartitionId\": 9,\n \"name\": \"jobs\",\n \"labels\": [\n \"Job\"\n ],\n \"instanceConfigs\": [\n {\n \"instanceConfigId\": 9,\n \"instanceType\": \"m4.xlarge\",\n \"minInstances\": 1,\n \"maxInstances\": 8,\n \"instanceMaxMemory\": 15320,\n \"instanceMaxCpu\": 4096,\n \"instanceMaxDisk\": 90.0,\n \"usageStats\": {\n \"pendingMemoryRequested\": null,\n \"pendingCpuRequested\": null,\n \"runningMemoryRequested\": null,\n \"runningCpuRequested\": null,\n \"pendingDeployments\": null,\n \"runningDeployments\": null\n }\n }\n ],\n \"defaultInstanceConfigId\": 9\n },\n {\n \"clusterPartitionId\": 10,\n \"name\": \"notebook_services\",\n \"labels\": [\n \"Notebook\",\n \"Service\"\n ],\n \"instanceConfigs\": [\n {\n \"instanceConfigId\": 10,\n \"instanceType\": \"m4.xlarge\",\n \"minInstances\": 0,\n \"maxInstances\": 2,\n \"instanceMaxMemory\": 15320,\n \"instanceMaxCpu\": 4096,\n \"instanceMaxDisk\": 90.0,\n \"usageStats\": {\n \"pendingMemoryRequested\": null,\n \"pendingCpuRequested\": null,\n \"runningMemoryRequested\": null,\n \"runningCpuRequested\": null,\n \"pendingDeployments\": null,\n \"runningDeployments\": null\n }\n }\n ],\n \"defaultInstanceConfigId\": 10\n }\n ],\n \"isNatEnabled\": false\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","X-Pagination-Per-Page":"50","Access-Control-Expose-Headers":"X-Pagination-Per-Page, X-Pagination-Current-Page, X-Pagination-Total-Pages, X-Pagination-Total-Entries","X-Pagination-Current-Page":"1","X-Pagination-Total-Pages":"1","X-Pagination-Total-Entries":"5","Content-Type":"application/json; charset=utf-8","ETag":"W/\"e32c92283e181147f0b84580f272be4c\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"7eda3318-3c02-4ab2-8e5d-eeb2aaea52d1","X-Runtime":"0.274637","Content-Length":"5582"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/clusters/kubernetes\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer PEuTh9FL1T9g_zhIBnd2zO7DD9VJSMlStMfgMo91zFc\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/clusters/kubernetes/{id}":{"get":{"summary":"Describe a Kubernetes Cluster","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"type":"integer"},{"name":"include_usage_stats","in":"query","required":false,"description":"When true, usage stats are returned in instance config objects. Defaults to false.","type":"boolean"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object29"}}},"x-examples":[{"resource":"Clusters","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/clusters/kubernetes/:id","description":"View a Kubernetes cluster's details","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/clusters/kubernetes/6","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer 75M0c0JTdbWo-DQqeMvzHFJEppSvnUkdNHIYmZTjCO0","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 6,\n \"organizationId\": 6,\n \"organizationName\": \"Organization 1\",\n \"organizationSlug\": \"organization_b\",\n \"rawClusterSlug\": \"cluster03-kubernetes-us-east-1\",\n \"customPartitions\": false,\n \"clusterPartitions\": [\n {\n \"clusterPartitionId\": 11,\n \"name\": \"jobs\",\n \"labels\": [\n \"Job\"\n ],\n \"instanceConfigs\": [\n {\n \"instanceConfigId\": 11,\n \"instanceType\": \"m4.xlarge\",\n \"minInstances\": 1,\n \"maxInstances\": 8,\n \"instanceMaxMemory\": 15320,\n \"instanceMaxCpu\": 4096,\n \"instanceMaxDisk\": 90.0,\n \"usageStats\": {\n \"pendingMemoryRequested\": null,\n \"pendingCpuRequested\": null,\n \"runningMemoryRequested\": null,\n \"runningCpuRequested\": null,\n \"pendingDeployments\": null,\n \"runningDeployments\": null\n }\n }\n ],\n \"defaultInstanceConfigId\": 11\n },\n {\n \"clusterPartitionId\": 12,\n \"name\": \"notebook_services\",\n \"labels\": [\n \"Notebook\",\n \"Service\"\n ],\n \"instanceConfigs\": [\n {\n \"instanceConfigId\": 12,\n \"instanceType\": \"m4.xlarge\",\n \"minInstances\": 0,\n \"maxInstances\": 2,\n \"instanceMaxMemory\": 15320,\n \"instanceMaxCpu\": 4096,\n \"instanceMaxDisk\": 90.0,\n \"usageStats\": {\n \"pendingMemoryRequested\": null,\n \"pendingCpuRequested\": null,\n \"runningMemoryRequested\": null,\n \"runningCpuRequested\": null,\n \"pendingDeployments\": null,\n \"runningDeployments\": null\n }\n }\n ],\n \"defaultInstanceConfigId\": 12\n }\n ],\n \"isNatEnabled\": false,\n \"hours\": null\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"b4d9fbe249a34a7e1d776c0d607b6632\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"010df0a9-2240-4a3a-955b-a7a0d20db163","X-Runtime":"0.043880","Content-Length":"1144"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/clusters/kubernetes/6\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer 75M0c0JTdbWo-DQqeMvzHFJEppSvnUkdNHIYmZTjCO0\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/clusters/kubernetes/{id}/compute_hours":{"get":{"summary":"List compute hours for a Kubernetes Cluster","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"type":"integer"},{"name":"include_usage_stats","in":"query","required":false,"description":"When true, usage stats are returned in instance config objects. Defaults to false.","type":"boolean"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object30"}}}},"x-examples":null,"x-deprecation-warning":null}},"/clusters/kubernetes/{id}/deployments":{"get":{"summary":"List the deployments associated with a Kubernetes Cluster","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The id of the cluster.","type":"integer"},{"name":"base_type","in":"query","required":false,"description":"If specified, return deployments of these base types. It accepts a comma-separated list, possible values are 'Notebook', 'Service', 'Run'.","type":"string"},{"name":"state","in":"query","required":false,"description":"If specified, return deployments in these states. It accepts a comma-separated list, possible values are pending, running, terminated, sleeping","type":"string"},{"name":"limit","in":"query","required":false,"description":"Number of results to return. Defaults to its maximum of 50.","type":"integer"},{"name":"page_num","in":"query","required":false,"description":"Page number of the results to return. Defaults to the first page, 1.","type":"integer"},{"name":"order","in":"query","required":false,"description":"The field on which to order the result set. Defaults to created_at. Must be one of: created_at.","type":"string"},{"name":"order_dir","in":"query","required":false,"description":"Direction in which to sort, either asc (ascending) or desc (descending) defaulting to asc.","type":"string"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object32"}}}},"x-examples":null,"x-deprecation-warning":null}},"/clusters/kubernetes/{id}/deployment_stats":{"get":{"summary":"Get stats about deployments associated with a Kubernetes Cluster","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of this cluster.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object34"}}}},"x-examples":null,"x-deprecation-warning":null}},"/clusters/kubernetes/{id}/partitions":{"get":{"summary":"List Cluster Partitions for given cluster","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"type":"integer"},{"name":"include_usage_stats","in":"query","required":false,"description":"When true, usage stats are returned in instance config objects. Defaults to false.","type":"boolean"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object25"}}}},"x-examples":[{"resource":"Clusters","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/clusters/kubernetes/:id/partitions","description":"List all Cluster Partitions for a Kubernetes Cluster","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/clusters/kubernetes/15/partitions","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer 60rc_y6jLuwG_hXTNiNmlmg8ZVeunbSTqJvXPJPbLmA","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"clusterPartitionId\": 29,\n \"name\": \"jobs\",\n \"labels\": [\n \"Job\"\n ],\n \"instanceConfigs\": [\n {\n \"instanceConfigId\": 29,\n \"instanceType\": \"m4.xlarge\",\n \"minInstances\": 1,\n \"maxInstances\": 8,\n \"instanceMaxMemory\": 15320,\n \"instanceMaxCpu\": 4096,\n \"instanceMaxDisk\": 90.0,\n \"usageStats\": {\n \"pendingMemoryRequested\": null,\n \"pendingCpuRequested\": null,\n \"runningMemoryRequested\": null,\n \"runningCpuRequested\": null,\n \"pendingDeployments\": null,\n \"runningDeployments\": null\n }\n }\n ],\n \"defaultInstanceConfigId\": 29\n },\n {\n \"clusterPartitionId\": 30,\n \"name\": \"notebook_services\",\n \"labels\": [\n \"Notebook\",\n \"Service\"\n ],\n \"instanceConfigs\": [\n {\n \"instanceConfigId\": 30,\n \"instanceType\": \"m4.xlarge\",\n \"minInstances\": 0,\n \"maxInstances\": 2,\n \"instanceMaxMemory\": 15320,\n \"instanceMaxCpu\": 4096,\n \"instanceMaxDisk\": 90.0,\n \"usageStats\": {\n \"pendingMemoryRequested\": null,\n \"pendingCpuRequested\": null,\n \"runningMemoryRequested\": null,\n \"runningCpuRequested\": null,\n \"pendingDeployments\": null,\n \"runningDeployments\": null\n }\n }\n ],\n \"defaultInstanceConfigId\": 30\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"7d16f446fd1627e6cd3e86aa2b96185b\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"f0e635b7-1482-489f-a5bc-da5b0f9e0f38","X-Runtime":"0.033846","Content-Length":"915"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/clusters/kubernetes/15/partitions\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer 60rc_y6jLuwG_hXTNiNmlmg8ZVeunbSTqJvXPJPbLmA\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"post":{"summary":"Create a Cluster Partition for given cluster","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the cluster which this partition belongs to.","type":"integer"},{"name":"Object35","in":"body","schema":{"$ref":"#/definitions/Object35"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object25"}}},"x-examples":[{"resource":"Clusters","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/clusters/kubernetes/:id/partitions","description":"Create a Cluster Partition","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/clusters/kubernetes/17/partitions","request_body":"{\n \"name\": \"test\",\n \"labels\": [\n \"testlabel\"\n ],\n \"instance_configs\": [\n {\n \"instance_type\": \"m4.2xlarge\",\n \"min_instances\": 0,\n \"max_instances\": 1\n }\n ]\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer BkAQ68ac3veYVEGSlQefUg8GKgugwF7Jf9UwmnojWOQ","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"clusterPartitionId\": 35,\n \"name\": \"test\",\n \"labels\": [\n \"testlabel\"\n ],\n \"instanceConfigs\": [\n {\n \"instanceConfigId\": 35,\n \"instanceType\": \"m4.2xlarge\",\n \"minInstances\": 0,\n \"maxInstances\": 1,\n \"instanceMaxMemory\": 31641,\n \"instanceMaxCpu\": 8192,\n \"instanceMaxDisk\": 90.0,\n \"usageStats\": {\n \"pendingMemoryRequested\": null,\n \"pendingCpuRequested\": null,\n \"runningMemoryRequested\": null,\n \"runningCpuRequested\": null,\n \"pendingDeployments\": null,\n \"runningDeployments\": null\n }\n }\n ],\n \"defaultInstanceConfigId\": 35\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"6ea66d1269069c4b494c90928c467f29\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"57acd19f-43d9-4074-8f5f-04e4d5494cd1","X-Runtime":"0.034651","Content-Length":"449"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/clusters/kubernetes/17/partitions\" -d '{\"name\":\"test\",\"labels\":[\"testlabel\"],\"instance_configs\":[{\"instance_type\":\"m4.2xlarge\",\"min_instances\":0,\"max_instances\":1}]}' -X POST \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer BkAQ68ac3veYVEGSlQefUg8GKgugwF7Jf9UwmnojWOQ\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/clusters/kubernetes/{id}/partitions/{cluster_partition_id}":{"patch":{"summary":"Update a Cluster Partition","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the cluster which this partition belongs to.","type":"integer"},{"name":"cluster_partition_id","in":"path","required":true,"description":"The ID of this cluster partition.","type":"integer"},{"name":"Object37","in":"body","schema":{"$ref":"#/definitions/Object37"},"required":false}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object25"}}},"x-examples":[{"resource":"Clusters","resource_explanation":null,"http_method":"PATCH","route":"http://api.civis.test/clusters/kubernetes/:id/partitions/:cluster_partition_id","description":"Update a Cluster Partition's details","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"PATCH","request_path":"http://api.civis.test/clusters/kubernetes/19/partitions/38","request_body":"{\n \"labels\": [\n \"this\",\n \"that\"\n ]\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer 1Cxwjl3J1THBsUwcf3u18JXk7AnBoMd1zL7v-FPTqeg","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"clusterPartitionId\": 38,\n \"name\": \"jobs\",\n \"labels\": [\n \"this\",\n \"that\"\n ],\n \"instanceConfigs\": [\n {\n \"instanceConfigId\": 38,\n \"instanceType\": \"m4.xlarge\",\n \"minInstances\": 1,\n \"maxInstances\": 8,\n \"instanceMaxMemory\": 15320,\n \"instanceMaxCpu\": 4096,\n \"instanceMaxDisk\": 90.0,\n \"usageStats\": {\n \"pendingMemoryRequested\": null,\n \"pendingCpuRequested\": null,\n \"runningMemoryRequested\": null,\n \"runningCpuRequested\": null,\n \"pendingDeployments\": null,\n \"runningDeployments\": null\n }\n }\n ],\n \"defaultInstanceConfigId\": 38\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"4bcc6936359fddc61ea40fc591f25287\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"0eabd5d5-bbcb-4131-bf63-c6dbfb2f5962","X-Runtime":"0.056685","Content-Length":"450"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/clusters/kubernetes/19/partitions/38\" -d '{\"labels\":[\"this\",\"that\"]}' -X PATCH \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer 1Cxwjl3J1THBsUwcf3u18JXk7AnBoMd1zL7v-FPTqeg\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Clusters","resource_explanation":null,"http_method":"PATCH","route":"http://api.civis.test/clusters/kubernetes/:id/partitions/:cluster_partition_id","description":"Update a Cluster Partition's instance configuration","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"PATCH","request_path":"http://api.civis.test/clusters/kubernetes/20/partitions/40","request_body":"{\n \"instance_configs\": [\n {\n \"min_instances\": 3,\n \"max_instances\": 5,\n \"instance_type\": \"m4.xlarge\"\n }\n ]\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer 3x2gTCNoHAO_3my-2mFNj40egY-UNscY4rOMzi-0YuQ","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"clusterPartitionId\": 40,\n \"name\": \"jobs\",\n \"labels\": [\n \"Job\"\n ],\n \"instanceConfigs\": [\n {\n \"instanceConfigId\": 42,\n \"instanceType\": \"m4.xlarge\",\n \"minInstances\": 3,\n \"maxInstances\": 5,\n \"instanceMaxMemory\": 15320,\n \"instanceMaxCpu\": 4096,\n \"instanceMaxDisk\": 90.0,\n \"usageStats\": {\n \"pendingMemoryRequested\": null,\n \"pendingCpuRequested\": null,\n \"runningMemoryRequested\": null,\n \"runningCpuRequested\": null,\n \"pendingDeployments\": null,\n \"runningDeployments\": null\n }\n }\n ],\n \"defaultInstanceConfigId\": 42\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"5ddd1dfd427ba88d5f1145de0416b1e9\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"2b799906-1c32-48db-9e04-418d89f48ab7","X-Runtime":"0.034346","Content-Length":"442"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/clusters/kubernetes/20/partitions/40\" -d '{\"instance_configs\":[{\"min_instances\":3,\"max_instances\":5,\"instance_type\":\"m4.xlarge\"}]}' -X PATCH \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer 3x2gTCNoHAO_3my-2mFNj40egY-UNscY4rOMzi-0YuQ\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"delete":{"summary":"Delete a Cluster Partition","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the cluster which this partition belongs to.","type":"integer"},{"name":"cluster_partition_id","in":"path","required":true,"description":"The ID of this cluster partition.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":[{"resource":"Clusters","resource_explanation":null,"http_method":"DELETE","route":"http://api.civis.test/clusters/kubernetes/:id/partitions/:cluster_partition_id","description":"Delete a Cluster Partition","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"DELETE","request_path":"http://api.civis.test/clusters/kubernetes/18/partitions/36","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer eCDDysMwY3wxMK0MX_KPtHceIxgp3khKOg-AzY1KCsQ","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":204,"response_status_text":"No Content","response_body":null,"response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"0d642c2f-95db-4f67-a785-1899cbc39f2a","X-Runtime":"0.039033"},"response_content_type":null,"curl":"curl \"api.civis.testhttp://api.civis.test/clusters/kubernetes/18/partitions/36\" -d '' -X DELETE \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer eCDDysMwY3wxMK0MX_KPtHceIxgp3khKOg-AzY1KCsQ\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"get":{"summary":"Describe a Cluster Partition","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the cluster which this partition belongs to.","type":"integer"},{"name":"include_usage_stats","in":"query","required":false,"description":"When true, usage stats are returned in instance config objects. Defaults to false.","type":"boolean"},{"name":"cluster_partition_id","in":"path","required":true,"description":"The ID of this cluster partition.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object25"}}},"x-examples":[{"resource":"Clusters","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/clusters/kubernetes/:id/partitions/:cluster_partition_id","description":"View a Cluster Partitions's details","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/clusters/kubernetes/16/partitions/31","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer wAE_4Tj9p-YXOmxggOFSB4pI-Q-H3_p0tbjpRvQuydQ","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"clusterPartitionId\": 31,\n \"name\": \"jobs\",\n \"labels\": [\n \"Job\"\n ],\n \"instanceConfigs\": [\n {\n \"instanceConfigId\": 31,\n \"instanceType\": \"m4.xlarge\",\n \"minInstances\": 1,\n \"maxInstances\": 8,\n \"instanceMaxMemory\": 15320,\n \"instanceMaxCpu\": 4096,\n \"instanceMaxDisk\": 90.0,\n \"usageStats\": {\n \"pendingMemoryRequested\": null,\n \"pendingCpuRequested\": null,\n \"runningMemoryRequested\": null,\n \"runningCpuRequested\": null,\n \"pendingDeployments\": null,\n \"runningDeployments\": null\n }\n }\n ],\n \"defaultInstanceConfigId\": 31\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"dbd7647ea74d99f82f21ce96bca09592\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"18f701e1-99d9-4647-855a-6b3a38754f0d","X-Runtime":"0.034285","Content-Length":"442"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/clusters/kubernetes/16/partitions/31\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer wAE_4Tj9p-YXOmxggOFSB4pI-Q-H3_p0tbjpRvQuydQ\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/clusters/kubernetes/instance_configs/{instance_config_id}":{"get":{"summary":"Describe an Instance Config","description":null,"deprecated":false,"parameters":[{"name":"instance_config_id","in":"path","required":true,"description":"The ID of this instance config.","type":"integer"},{"name":"include_usage_stats","in":"query","required":false,"description":"When true, usage stats are returned in instance config objects. Defaults to false.","type":"boolean"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object39"}}},"x-examples":[{"resource":"Clusters","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/clusters/kubernetes/instance_configs/:instance_config_id","description":"View an instance config's details","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/clusters/kubernetes/instance_configs/19","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer OTD6YmdHL0TE2kxj009Uz-zGIax6n2pcPWPGk0sURtk","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"instanceConfigId\": 19,\n \"instanceType\": \"m4.xlarge\",\n \"minInstances\": 1,\n \"maxInstances\": 8,\n \"instanceMaxMemory\": 15320,\n \"instanceMaxCpu\": 4096,\n \"instanceMaxDisk\": 90.0,\n \"usageStats\": {\n \"pendingMemoryRequested\": null,\n \"pendingCpuRequested\": null,\n \"runningMemoryRequested\": null,\n \"runningCpuRequested\": null,\n \"pendingDeployments\": null,\n \"runningDeployments\": null\n },\n \"clusterPartitionId\": 19,\n \"clusterPartitionName\": \"jobs\"\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"d82509e71e535bc0a899995c30dc3ede\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"a895f0c3-651b-4caa-a192-0560a4a1946e","X-Runtime":"0.042051","Content-Length":"390"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/clusters/kubernetes/instance_configs/19\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer OTD6YmdHL0TE2kxj009Uz-zGIax6n2pcPWPGk0sURtk\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/clusters/kubernetes/instance_configs/{id}/active_workloads":{"get":{"summary":"List active workloads in an Instance Config","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The id of the instance config.","type":"integer"},{"name":"state","in":"query","required":false,"description":"If specified, return workloads in these states. It accepts a comma-separated list, possible values are pending, running","type":"string"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object40"}}}},"x-examples":[{"resource":"Clusters","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/clusters/kubernetes/instance_configs/:id/active_workloads","description":"List active workloads in an instance config","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/clusters/kubernetes/instance_configs/27/active_workloads","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer CepXkVqhWlatcSZXR6RJ1fkhmDh4s3QMZFKIgBUcTU4","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 2,\n \"baseType\": \"Run\",\n \"baseId\": 2,\n \"baseObjectName\": \"My python script\",\n \"jobType\": \"python_script\",\n \"jobId\": 4,\n \"jobCancelRequestedAt\": null,\n \"state\": \"running\",\n \"cpu\": 500,\n \"memory\": 2008,\n \"diskSpace\": 1.0,\n \"user\": {\n \"id\": 16,\n \"name\": \"Example User\",\n \"username\": \"devuserfactory2\",\n \"initials\": \"EU\",\n \"online\": null\n },\n \"createdAt\": \"2024-12-30T20:07:36.000Z\",\n \"cancellable\": false\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"9a518345d579af36b940de5d7e570073\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"e3d36b2d-88e0-4627-875e-c28bbdcc708a","X-Runtime":"0.067632","Content-Length":"353"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/clusters/kubernetes/instance_configs/27/active_workloads\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer CepXkVqhWlatcSZXR6RJ1fkhmDh4s3QMZFKIgBUcTU4\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/clusters/kubernetes/instance_configs/{instance_config_id}/user_statistics":{"get":{"summary":"Get statistics about the current users of an Instance Config","description":null,"deprecated":false,"parameters":[{"name":"instance_config_id","in":"path","required":true,"description":"The ID of this instance config.","type":"integer"},{"name":"order","in":"query","required":false,"description":"The field on which to order the result set. Defaults to running_deployments. Must be one of pending_memory_requested, pending_cpu_requested, running_memory_requested, running_cpu_requested, pending_deployments, running_deployments.","type":"string"},{"name":"order_dir","in":"query","required":false,"description":"Direction in which to sort, either asc (ascending) or desc (descending). Defaults to desc.","type":"string"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object41"}}}},"x-examples":[{"resource":"Clusters","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/clusters/kubernetes/instance_configs/:instance_config_id/user_statistics","description":"List user statistics for an instance config","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/clusters/kubernetes/instance_configs/21/user_statistics","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer KHjiiQ6u6y1DmLht9Bra_VjDg7MA5Bul2JOJJkADkik","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"userId\": 12,\n \"userName\": \"Example User\",\n \"pendingDeployments\": 0,\n \"pendingMemoryRequested\": 0,\n \"pendingCpuRequested\": 0,\n \"runningDeployments\": 1,\n \"runningMemoryRequested\": 2008,\n \"runningCpuRequested\": 500\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"e2ecfd5dd9aec9f9c8df865b57ef5223\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"c2398dc9-4f28-462a-9f93-b6d967a22f8a","X-Runtime":"0.046207","Content-Length":"194"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/clusters/kubernetes/instance_configs/21/user_statistics\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer KHjiiQ6u6y1DmLht9Bra_VjDg7MA5Bul2JOJJkADkik\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/clusters/kubernetes/instance_configs/{instance_config_id}/historical_graphs":{"get":{"summary":"Get graphs of historical resource usage in an Instance Config","description":null,"deprecated":false,"parameters":[{"name":"instance_config_id","in":"path","required":true,"description":"The ID of this instance config.","type":"integer"},{"name":"timeframe","in":"query","required":false,"description":"The span of time that the graphs cover. Must be one of 1_day, 1_week.","type":"string"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object42"}}},"x-examples":[{"resource":"Clusters","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/clusters/kubernetes/instance_configs/:instance_config_id/historical_graphs","description":"View historical resource usage graphs for an instance config","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/clusters/kubernetes/instance_configs/23/historical_graphs?timeframe=1_week","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer wn46A44xHYdrbbN_JiejdmkCDo9kf2JbStgmhFiBDJA","Host":"api.civis.test","Cookie":""},"request_query_parameters":{"timeframe":"1_week"},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"cpuGraphUrl\": \"https://app.datadoghq.com/graph/embed?token=cputoken&height=275&width=800&legend=false\",\n \"memGraphUrl\": \"https://app.datadoghq.com/graph/embed?token=memtoken&height=275&width=800&legend=false\"\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"a3c67938cb6d89c42d317be9182e3ef0\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"8ace10df-0f04-4a26-9e88-5a459b06a370","X-Runtime":"0.028394","Content-Length":"237"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/clusters/kubernetes/instance_configs/23/historical_graphs?timeframe=1_week\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer wn46A44xHYdrbbN_JiejdmkCDo9kf2JbStgmhFiBDJA\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/clusters/kubernetes/instance_configs/{instance_config_id}/historical_metrics":{"get":{"summary":"Get graphs of historical resource usage in an Instance Config","description":null,"deprecated":false,"parameters":[{"name":"instance_config_id","in":"path","required":true,"description":"The ID of this instance config.","type":"integer"},{"name":"timeframe","in":"query","required":false,"description":"The span of time that the graphs cover. Must be one of 1_day, 1_week.","type":"string"},{"name":"metric","in":"query","required":false,"description":"The metric to retrieve. Must be one of cpu, memory.","type":"string"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object43"}}},"x-examples":[{"resource":"Clusters","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/clusters/kubernetes/instance_configs/:instance_config_id/historical_metrics","description":"Retrieve historical metrics for an instance config","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/clusters/kubernetes/instance_configs/25/historical_metrics?timeframe=1_week&metric=cpu","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer cBbbSGrAxNXb-7HMvs0wxuVr1gS7eCvvAzTeudRcaOk","Host":"api.civis.test","Cookie":""},"request_query_parameters":{"timeframe":"1_week","metric":"cpu"},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"instanceConfigId\": 25,\n \"metric\": \"cpu\",\n \"timeframe\": \"1_week\",\n \"unit\": \"mCPU\",\n \"metrics\": {\n \"used\": {\n \"times\": [\n 1,\n 2,\n 3\n ],\n \"values\": [\n 5,\n 6,\n 7\n ]\n },\n \"requested\": {\n \"times\": [\n 1,\n 2\n ],\n \"values\": [\n 1,\n 2\n ]\n },\n \"capacity\": {\n \"times\": [\n 1,\n 2\n ],\n \"values\": [\n 3,\n 4\n ]\n }\n }\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"73574d9ed2cd0245f639ce445171e030\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"e07a40eb-38fd-4949-aeba-8b28fc9e85a5","X-Runtime":"0.031020","Content-Length":"212"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/clusters/kubernetes/instance_configs/25/historical_metrics?timeframe=1_week&metric=cpu\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer cBbbSGrAxNXb-7HMvs0wxuVr1gS7eCvvAzTeudRcaOk\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/credentials/types":{"get":{"summary":"Get list of Credential Types","description":null,"deprecated":false,"parameters":[],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object58"}}},"x-examples":null,"x-deprecation-warning":null}},"/credentials/":{"get":{"summary":"List credentials","description":null,"deprecated":false,"parameters":[{"name":"type","in":"query","required":false,"description":"The type (or types) of credentials to return. One or more of: Amazon Web Services S3, Bitbucket, CASS/NCOA PAF, Certificate, Civis Platform, Custom, Database, Google, Github, Salesforce User, Salesforce Client, and TableauUser. Specify multiple values as a comma-separated list (e.g., \"A,B\").","type":"string"},{"name":"remote_host_id","in":"query","required":false,"description":"The ID of the remote host associated with the credentials to return.","type":"integer"},{"name":"default","in":"query","required":false,"description":"If true, will return a list with a single credential which is the current user's default credential.","type":"boolean"},{"name":"system_credentials","in":"query","required":false,"description":"If true, will only return system credentials. System credentials can only be created and viewed by Civis Admins.","type":"boolean"},{"name":"users","in":"query","required":false,"description":"A comma-separated list of user ids. If specified, returns set of credentials owned by the users that requesting user has at least read access on.","type":"string"},{"name":"name","in":"query","required":false,"description":"If specified, will be used to filter the credentials returned. Will search across name and will return any full name containing the search string.","type":"string"},{"name":"limit","in":"query","required":false,"description":"Number of results to return. Defaults to its maximum of 1000.","type":"integer"},{"name":"page_num","in":"query","required":false,"description":"Page number of the results to return. Defaults to the first page, 1.","type":"integer"},{"name":"order","in":"query","required":false,"description":"The field on which to order the result set. Defaults to updated_at. Must be one of: updated_at, created_at, name.","type":"string"},{"name":"order_dir","in":"query","required":false,"description":"Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc.","type":"string"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object59"}}}},"x-examples":[{"resource":"Credentials","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/credentials","description":"#get all credentials","explanation":null,"parameters":[{"required":false,"name":"type","description":"The type (or types) of credentials to return. One or more of: Amazon Web Services S3, Bitbucket, CASS/NCOA PAF, Certificate, Civis Platform, Custom, Database, Google, Github, Salesforce User, Salesforce Client, and TableauUser. Specify multiple values as a comma-separated list (e.g., \"A,B\")."},{"required":false,"name":"remoteHostId","description":"The ID of the remote host associated with the credentials to return."},{"required":false,"name":"default","description":"If true, will return a list with a single credential which is the current user's default credential."},{"required":false,"name":"systemCredentials","description":"If true, will only return system credentials. System credentials can only be created and viewed by Civis Admins."},{"required":false,"name":"users","description":"A comma-separated list of user ids. If specified, returns set of credentials owned by the users that requesting user has at least read access on."},{"required":false,"name":"name","description":"If specified, will be used to filter the credentials returned. Will search across name and will return any full name containing the search string."},{"required":false,"name":"limit","description":"Number of results to return. Defaults to its maximum of 1000."},{"required":false,"name":"pageNum","description":"Page number of the results to return. Defaults to the first page, 1."},{"required":false,"name":"order","description":"The field on which to order the result set. Defaults to updated_at. Must be one of: updated_at, created_at, name."},{"required":false,"name":"orderDir","description":"Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc."}],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/credentials","request_body":null,"request_headers":{"Content-Type":"application/json","Authorization":"Bearer lWRcdYuWQC71P1UU-3Xp0FtBO3m3r4ABIoZgMLNG_QA","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 10,\n \"name\": \"db_user-1\",\n \"type\": \"Database\",\n \"username\": \"db_user-1\",\n \"description\": null,\n \"owner\": \"devuserfactory10\",\n \"user\": {\n \"id\": 34,\n \"name\": \"User devuserfactory10 8\",\n \"username\": \"devuserfactory10\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"remoteHostId\": 12,\n \"remoteHostName\": \"redshift-10000\",\n \"state\": null,\n \"createdAt\": \"2023-07-18T18:39:28.000Z\",\n \"updatedAt\": \"2023-07-18T18:38:28.000Z\",\n \"default\": false,\n \"oauth\": false\n },\n {\n \"id\": 12,\n \"name\": \"db_user-2\",\n \"type\": \"Database\",\n \"username\": \"db_user-2\",\n \"description\": null,\n \"owner\": \"devuserfactory10\",\n \"user\": {\n \"id\": 34,\n \"name\": \"User devuserfactory10 8\",\n \"username\": \"devuserfactory10\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"remoteHostId\": 13,\n \"remoteHostName\": \"redshift-10001\",\n \"state\": null,\n \"createdAt\": \"2023-07-18T18:39:28.000Z\",\n \"updatedAt\": \"2023-07-18T18:37:28.000Z\",\n \"default\": false,\n \"oauth\": false\n },\n {\n \"id\": 13,\n \"name\": \"salesforce-user-key-1\",\n \"type\": \"Salesforce User\",\n \"username\": \"skomanduri@civisanalytics.com\",\n \"description\": null,\n \"owner\": \"devuserfactory10\",\n \"user\": {\n \"id\": 34,\n \"name\": \"User devuserfactory10 8\",\n \"username\": \"devuserfactory10\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"remoteHostId\": null,\n \"remoteHostName\": null,\n \"state\": null,\n \"createdAt\": \"2023-07-18T18:39:28.000Z\",\n \"updatedAt\": \"2023-07-18T18:36:28.000Z\",\n \"default\": false,\n \"oauth\": false\n },\n {\n \"id\": 14,\n \"name\": \"Rentrak\",\n \"type\": \"Amazon Web Services S3\",\n \"username\": \"b1a44ca7-2c68-4a69-9986-cad248264f35\",\n \"description\": null,\n \"owner\": \"devuserfactory10\",\n \"user\": {\n \"id\": 34,\n \"name\": \"User devuserfactory10 8\",\n \"username\": \"devuserfactory10\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"remoteHostId\": null,\n \"remoteHostName\": null,\n \"state\": null,\n \"createdAt\": \"2023-07-18T18:39:28.000Z\",\n \"updatedAt\": \"2023-07-18T18:34:28.000Z\",\n \"default\": false,\n \"oauth\": false\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","X-Pagination-Per-Page":"1000","Access-Control-Expose-Headers":"X-Pagination-Per-Page, X-Pagination-Current-Page, X-Pagination-Total-Pages, X-Pagination-Total-Entries","X-Pagination-Current-Page":"1","X-Pagination-Total-Pages":"1","X-Pagination-Total-Entries":"4","Content-Type":"application/json; charset=utf-8","ETag":"W/\"f5942b4f55bf56bd4d9c3c528db50a41\"","X-Request-Id":"48ca0a58-455b-4492-bd11-97c6db7690d3","X-Runtime":"0.033309","Content-Length":"1655"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/credentials\" -X GET \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer lWRcdYuWQC71P1UU-3Xp0FtBO3m3r4ABIoZgMLNG_QA\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Credentials","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/credentials","description":"#get all credentials","explanation":null,"parameters":[{"required":false,"name":"type","description":"The type (or types) of credentials to return. One or more of: Amazon Web Services S3, Bitbucket, CASS/NCOA PAF, Certificate, Civis Platform, Custom, Database, Google, Github, Salesforce User, Salesforce Client, and TableauUser. Specify multiple values as a comma-separated list (e.g., \"A,B\")."},{"required":false,"name":"remoteHostId","description":"The ID of the remote host associated with the credentials to return."},{"required":false,"name":"default","description":"If true, will return a list with a single credential which is the current user's default credential."},{"required":false,"name":"systemCredentials","description":"If true, will only return system credentials. System credentials can only be created and viewed by Civis Admins."},{"required":false,"name":"users","description":"A comma-separated list of user ids. If specified, returns set of credentials owned by the users that requesting user has at least read access on."},{"required":false,"name":"name","description":"If specified, will be used to filter the credentials returned. Will search across name and will return any full name containing the search string."},{"required":false,"name":"limit","description":"Number of results to return. Defaults to its maximum of 1000."},{"required":false,"name":"pageNum","description":"Page number of the results to return. Defaults to the first page, 1."},{"required":false,"name":"order","description":"The field on which to order the result set. Defaults to updated_at. Must be one of: updated_at, created_at, name."},{"required":false,"name":"orderDir","description":"Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc."}],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/credentials","request_body":null,"request_headers":{"Content-Type":"application/json","Authorization":"Bearer -jElCftQeUXoOmEPiZfC3Nt_rRg_JOJFj_8GGKq6Yak","Accept":"application/vnd.civis-platform.v2","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 16,\n \"name\": \"db_user-3\",\n \"type\": \"Database\",\n \"username\": \"db_user-3\",\n \"description\": null,\n \"owner\": \"devuserfactory11\",\n \"user\": {\n \"id\": 37,\n \"name\": \"User devuserfactory11 9\",\n \"username\": \"devuserfactory11\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"remoteHostId\": 15,\n \"remoteHostName\": \"redshift-10002\",\n \"state\": null,\n \"createdAt\": \"2023-07-18T18:39:28.000Z\",\n \"updatedAt\": \"2023-07-18T18:38:28.000Z\",\n \"default\": false,\n \"oauth\": false\n },\n {\n \"id\": 18,\n \"name\": \"db_user-4\",\n \"type\": \"Database\",\n \"username\": \"db_user-4\",\n \"description\": null,\n \"owner\": \"devuserfactory11\",\n \"user\": {\n \"id\": 37,\n \"name\": \"User devuserfactory11 9\",\n \"username\": \"devuserfactory11\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"remoteHostId\": 16,\n \"remoteHostName\": \"redshift-10003\",\n \"state\": null,\n \"createdAt\": \"2023-07-18T18:39:28.000Z\",\n \"updatedAt\": \"2023-07-18T18:37:28.000Z\",\n \"default\": false,\n \"oauth\": false\n },\n {\n \"id\": 19,\n \"name\": \"salesforce-user-key-2\",\n \"type\": \"Salesforce User\",\n \"username\": \"skomanduri@civisanalytics.com\",\n \"description\": null,\n \"owner\": \"devuserfactory11\",\n \"user\": {\n \"id\": 37,\n \"name\": \"User devuserfactory11 9\",\n \"username\": \"devuserfactory11\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"remoteHostId\": null,\n \"remoteHostName\": null,\n \"state\": null,\n \"createdAt\": \"2023-07-18T18:39:28.000Z\",\n \"updatedAt\": \"2023-07-18T18:36:28.000Z\",\n \"default\": false,\n \"oauth\": false\n },\n {\n \"id\": 20,\n \"name\": \"Rentrak\",\n \"type\": \"Amazon Web Services S3\",\n \"username\": \"b1a44ca7-2c68-4a69-9986-cad248264f35\",\n \"description\": null,\n \"owner\": \"devuserfactory11\",\n \"user\": {\n \"id\": 37,\n \"name\": \"User devuserfactory11 9\",\n \"username\": \"devuserfactory11\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"remoteHostId\": null,\n \"remoteHostName\": null,\n \"state\": null,\n \"createdAt\": \"2023-07-18T18:39:28.000Z\",\n \"updatedAt\": \"2023-07-18T18:34:28.000Z\",\n \"default\": false,\n \"oauth\": false\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","X-Pagination-Per-Page":"1000","Access-Control-Expose-Headers":"X-Pagination-Per-Page, X-Pagination-Current-Page, X-Pagination-Total-Pages, X-Pagination-Total-Entries","X-Pagination-Current-Page":"1","X-Pagination-Total-Pages":"1","X-Pagination-Total-Entries":"4","Content-Type":"application/json; charset=utf-8","ETag":"W/\"efe5254b2f627e525b81252c184fbdd3\"","X-Request-Id":"c75a2cf7-260d-4d8f-a30c-0c803a56c9f1","X-Runtime":"0.021882","Content-Length":"1655"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/credentials\" -X GET \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer -jElCftQeUXoOmEPiZfC3Nt_rRg_JOJFj_8GGKq6Yak\" \\\n\t-H \"Accept: application/vnd.civis-platform.v2\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Credentials","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/credentials?type=Database","description":"List all credentials of the specified type","explanation":null,"parameters":[{"required":false,"name":"type","description":"The type (or types) of credentials to return. One or more of: Amazon Web Services S3, Bitbucket, CASS/NCOA PAF, Certificate, Civis Platform, Custom, Database, Google, Github, Salesforce User, Salesforce Client, and TableauUser. Specify multiple values as a comma-separated list (e.g., \"A,B\")."},{"required":false,"name":"remoteHostId","description":"The ID of the remote host associated with the credentials to return."},{"required":false,"name":"default","description":"If true, will return a list with a single credential which is the current user's default credential."},{"required":false,"name":"systemCredentials","description":"If true, will only return system credentials. System credentials can only be created and viewed by Civis Admins."},{"required":false,"name":"users","description":"A comma-separated list of user ids. If specified, returns set of credentials owned by the users that requesting user has at least read access on."},{"required":false,"name":"name","description":"If specified, will be used to filter the credentials returned. Will search across name and will return any full name containing the search string."},{"required":false,"name":"limit","description":"Number of results to return. Defaults to its maximum of 1000."},{"required":false,"name":"pageNum","description":"Page number of the results to return. Defaults to the first page, 1."},{"required":false,"name":"order","description":"The field on which to order the result set. Defaults to updated_at. Must be one of: updated_at, created_at, name."},{"required":false,"name":"orderDir","description":"Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc."}],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/credentials?type=Database","request_body":null,"request_headers":{"Content-Type":"application/json","Authorization":"Bearer kCJTtAHf9tOeeRMJx-OKl_gsiDq1xLEM2ZlfJHvc3Zw","Host":"api.civis.test","Cookie":""},"request_query_parameters":{"type":"Database"},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 22,\n \"name\": \"db_user-5\",\n \"type\": \"Database\",\n \"username\": \"db_user-5\",\n \"description\": null,\n \"owner\": \"devuserfactory12\",\n \"user\": {\n \"id\": 40,\n \"name\": \"User devuserfactory12 10\",\n \"username\": \"devuserfactory12\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"remoteHostId\": 18,\n \"remoteHostName\": \"redshift-10004\",\n \"state\": null,\n \"createdAt\": \"2023-07-18T18:39:28.000Z\",\n \"updatedAt\": \"2023-07-18T18:38:28.000Z\",\n \"default\": false,\n \"oauth\": false\n },\n {\n \"id\": 24,\n \"name\": \"db_user-6\",\n \"type\": \"Database\",\n \"username\": \"db_user-6\",\n \"description\": null,\n \"owner\": \"devuserfactory12\",\n \"user\": {\n \"id\": 40,\n \"name\": \"User devuserfactory12 10\",\n \"username\": \"devuserfactory12\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"remoteHostId\": 19,\n \"remoteHostName\": \"redshift-10005\",\n \"state\": null,\n \"createdAt\": \"2023-07-18T18:39:28.000Z\",\n \"updatedAt\": \"2023-07-18T18:37:28.000Z\",\n \"default\": false,\n \"oauth\": false\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","X-Pagination-Per-Page":"1000","Access-Control-Expose-Headers":"X-Pagination-Per-Page, X-Pagination-Current-Page, X-Pagination-Total-Pages, X-Pagination-Total-Entries","X-Pagination-Current-Page":"1","X-Pagination-Total-Pages":"1","X-Pagination-Total-Entries":"2","Content-Type":"application/json; charset=utf-8","ETag":"W/\"b0ed064374bcb6f1b44ef1d6956a6370\"","X-Request-Id":"079e5424-f525-4281-846e-28f0c47c5ade","X-Runtime":"0.020379","Content-Length":"801"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/credentials?type=Database\" -X GET \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer kCJTtAHf9tOeeRMJx-OKl_gsiDq1xLEM2ZlfJHvc3Zw\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Credentials","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/credentials?type=Database,Salesforce User","description":"List all credentials of multiple types","explanation":null,"parameters":[{"required":false,"name":"type","description":"The type (or types) of credentials to return. One or more of: Amazon Web Services S3, Bitbucket, CASS/NCOA PAF, Certificate, Civis Platform, Custom, Database, Google, Github, Salesforce User, Salesforce Client, and TableauUser. Specify multiple values as a comma-separated list (e.g., \"A,B\")."},{"required":false,"name":"remoteHostId","description":"The ID of the remote host associated with the credentials to return."},{"required":false,"name":"default","description":"If true, will return a list with a single credential which is the current user's default credential."},{"required":false,"name":"systemCredentials","description":"If true, will only return system credentials. System credentials can only be created and viewed by Civis Admins."},{"required":false,"name":"users","description":"A comma-separated list of user ids. If specified, returns set of credentials owned by the users that requesting user has at least read access on."},{"required":false,"name":"name","description":"If specified, will be used to filter the credentials returned. Will search across name and will return any full name containing the search string."},{"required":false,"name":"limit","description":"Number of results to return. Defaults to its maximum of 1000."},{"required":false,"name":"pageNum","description":"Page number of the results to return. Defaults to the first page, 1."},{"required":false,"name":"order","description":"The field on which to order the result set. Defaults to updated_at. Must be one of: updated_at, created_at, name."},{"required":false,"name":"orderDir","description":"Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc."}],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/credentials?type=Database,Salesforce User","request_body":null,"request_headers":{"Content-Type":"application/json","Authorization":"Bearer ewWXjWGfSIPFHnCkQIpZtpLesBPDFuE4KDus749ubCM","Host":"api.civis.test","Cookie":""},"request_query_parameters":{"type":"Database,Salesforce User"},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 28,\n \"name\": \"db_user-7\",\n \"type\": \"Database\",\n \"username\": \"db_user-7\",\n \"description\": null,\n \"owner\": \"devuserfactory13\",\n \"user\": {\n \"id\": 43,\n \"name\": \"User devuserfactory13 11\",\n \"username\": \"devuserfactory13\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"remoteHostId\": 21,\n \"remoteHostName\": \"redshift-10006\",\n \"state\": null,\n \"createdAt\": \"2023-07-18T18:39:29.000Z\",\n \"updatedAt\": \"2023-07-18T18:38:28.000Z\",\n \"default\": false,\n \"oauth\": false\n },\n {\n \"id\": 30,\n \"name\": \"db_user-8\",\n \"type\": \"Database\",\n \"username\": \"db_user-8\",\n \"description\": null,\n \"owner\": \"devuserfactory13\",\n \"user\": {\n \"id\": 43,\n \"name\": \"User devuserfactory13 11\",\n \"username\": \"devuserfactory13\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"remoteHostId\": 22,\n \"remoteHostName\": \"redshift-10007\",\n \"state\": null,\n \"createdAt\": \"2023-07-18T18:39:29.000Z\",\n \"updatedAt\": \"2023-07-18T18:37:29.000Z\",\n \"default\": false,\n \"oauth\": false\n },\n {\n \"id\": 31,\n \"name\": \"salesforce-user-key-4\",\n \"type\": \"Salesforce User\",\n \"username\": \"skomanduri@civisanalytics.com\",\n \"description\": null,\n \"owner\": \"devuserfactory13\",\n \"user\": {\n \"id\": 43,\n \"name\": \"User devuserfactory13 11\",\n \"username\": \"devuserfactory13\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"remoteHostId\": null,\n \"remoteHostName\": null,\n \"state\": null,\n \"createdAt\": \"2023-07-18T18:39:29.000Z\",\n \"updatedAt\": \"2023-07-18T18:36:29.000Z\",\n \"default\": false,\n \"oauth\": false\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","X-Pagination-Per-Page":"1000","Access-Control-Expose-Headers":"X-Pagination-Per-Page, X-Pagination-Current-Page, X-Pagination-Total-Pages, X-Pagination-Total-Entries","X-Pagination-Current-Page":"1","X-Pagination-Total-Pages":"1","X-Pagination-Total-Entries":"3","Content-Type":"application/json; charset=utf-8","ETag":"W/\"823dfe77904906c002e653ae5b757820\"","X-Request-Id":"c23a6866-e893-482a-bf1e-37da07317130","X-Runtime":"0.020499","Content-Length":"1230"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/credentials?type=Database,Salesforce User\" -X GET \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer ewWXjWGfSIPFHnCkQIpZtpLesBPDFuE4KDus749ubCM\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Credentials","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/credentials?remoteHostId=:remote_host_id","description":"List all credentials of the specified remote host","explanation":null,"parameters":[{"required":false,"name":"type","description":"The type (or types) of credentials to return. One or more of: Amazon Web Services S3, Bitbucket, CASS/NCOA PAF, Certificate, Civis Platform, Custom, Database, Google, Github, Salesforce User, Salesforce Client, and TableauUser. Specify multiple values as a comma-separated list (e.g., \"A,B\")."},{"required":false,"name":"remoteHostId","description":"The ID of the remote host associated with the credentials to return."},{"required":false,"name":"default","description":"If true, will return a list with a single credential which is the current user's default credential."},{"required":false,"name":"systemCredentials","description":"If true, will only return system credentials. System credentials can only be created and viewed by Civis Admins."},{"required":false,"name":"users","description":"A comma-separated list of user ids. If specified, returns set of credentials owned by the users that requesting user has at least read access on."},{"required":false,"name":"name","description":"If specified, will be used to filter the credentials returned. Will search across name and will return any full name containing the search string."},{"required":false,"name":"limit","description":"Number of results to return. Defaults to its maximum of 1000."},{"required":false,"name":"pageNum","description":"Page number of the results to return. Defaults to the first page, 1."},{"required":false,"name":"order","description":"The field on which to order the result set. Defaults to updated_at. Must be one of: updated_at, created_at, name."},{"required":false,"name":"orderDir","description":"Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc."}],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/credentials?remoteHostId=25","request_body":null,"request_headers":{"Content-Type":"application/json","Authorization":"Bearer zzbd9McxSd7aqfXop4oK5fk84cD4MxW1M3YmnP_X2qw","Host":"api.civis.test","Cookie":""},"request_query_parameters":{"remoteHostId":"25"},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 36,\n \"name\": \"db_user-10\",\n \"type\": \"Database\",\n \"username\": \"db_user-10\",\n \"description\": null,\n \"owner\": \"devuserfactory14\",\n \"user\": {\n \"id\": 46,\n \"name\": \"User devuserfactory14 12\",\n \"username\": \"devuserfactory14\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"remoteHostId\": 25,\n \"remoteHostName\": \"redshift-10009\",\n \"state\": null,\n \"createdAt\": \"2023-07-18T18:39:29.000Z\",\n \"updatedAt\": \"2023-07-18T18:37:29.000Z\",\n \"default\": false,\n \"oauth\": false\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","X-Pagination-Per-Page":"1000","Access-Control-Expose-Headers":"X-Pagination-Per-Page, X-Pagination-Current-Page, X-Pagination-Total-Pages, X-Pagination-Total-Entries","X-Pagination-Current-Page":"1","X-Pagination-Total-Pages":"1","X-Pagination-Total-Entries":"1","Content-Type":"application/json; charset=utf-8","ETag":"W/\"7a7fd4e1cc290b5cd2c2cc9c806544be\"","X-Request-Id":"0a44acbe-7bfc-4b52-8415-716ea6025ad3","X-Runtime":"0.022545","Content-Length":"403"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/credentials?remoteHostId=25\" -X GET \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer zzbd9McxSd7aqfXop4oK5fk84cD4MxW1M3YmnP_X2qw\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"post":{"summary":"Create a credential","description":null,"deprecated":false,"parameters":[{"name":"Object60","in":"body","schema":{"$ref":"#/definitions/Object60"},"required":true}],"responses":{"201":{"description":"success","schema":{"$ref":"#/definitions/Object59"}}},"x-examples":[{"resource":"Credentials","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/credentials","description":"Create a credential with a remote host","explanation":null,"parameters":[{"required":false,"name":"type","description":"The type (or types) of credentials to return. One or more of: Amazon Web Services S3, Bitbucket, CASS/NCOA PAF, Certificate, Civis Platform, Custom, Database, Google, Github, Salesforce User, Salesforce Client, and TableauUser. Specify multiple values as a comma-separated list (e.g., \"A,B\")."},{"required":false,"name":"remoteHostId","description":"The ID of the remote host associated with the credentials to return."},{"required":false,"name":"default","description":"If true, will return a list with a single credential which is the current user's default credential."},{"required":false,"name":"systemCredentials","description":"If true, will only return system credentials. System credentials can only be created and viewed by Civis Admins."},{"required":false,"name":"users","description":"A comma-separated list of user ids. If specified, returns set of credentials owned by the users that requesting user has at least read access on."},{"required":false,"name":"name","description":"If specified, will be used to filter the credentials returned. Will search across name and will return any full name containing the search string."},{"required":false,"name":"limit","description":"Number of results to return. Defaults to its maximum of 1000."},{"required":false,"name":"pageNum","description":"Page number of the results to return. Defaults to the first page, 1."},{"required":false,"name":"order","description":"The field on which to order the result set. Defaults to updated_at. Must be one of: updated_at, created_at, name."},{"required":false,"name":"orderDir","description":"Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc."}],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/credentials","request_body":"{\n \"username\": \"myUsername\",\n \"password\": \"myPassword\",\n \"type\": \"Database\",\n \"remote_host_id\": 32\n}","request_headers":{"Content-Type":"application/json","Authorization":"Bearer xwYT64ELyis0oONJywWu3WBL0aC9KYIqL5abCfIeY-4","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":201,"response_status_text":"Created","response_body":"{\n \"id\": 51,\n \"name\": \"myUsername\",\n \"type\": \"Database\",\n \"username\": \"myUsername\",\n \"description\": null,\n \"owner\": \"devuserfactory16\",\n \"user\": {\n \"id\": 52,\n \"name\": \"User devuserfactory16 14\",\n \"username\": \"devuserfactory16\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"remoteHostId\": 32,\n \"remoteHostName\": \"mysql-10006\",\n \"state\": null,\n \"createdAt\": \"2023-07-18T18:39:29.000Z\",\n \"updatedAt\": \"2023-07-18T18:39:29.000Z\",\n \"default\": false,\n \"oauth\": false\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"5060fd02a3871d6ab3bf73a612b296b6\"","X-Request-Id":"7115d4a8-7422-4526-8ca1-080507e854cb","X-Runtime":"0.029738","Content-Length":"398"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/credentials\" -d '{\"username\":\"myUsername\",\"password\":\"myPassword\",\"type\":\"Database\",\"remote_host_id\":32}' -X POST \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer xwYT64ELyis0oONJywWu3WBL0aC9KYIqL5abCfIeY-4\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Credentials","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/credentials","description":"Create a credential without a remote host","explanation":null,"parameters":[{"required":false,"name":"type","description":"The type (or types) of credentials to return. One or more of: Amazon Web Services S3, Bitbucket, CASS/NCOA PAF, Certificate, Civis Platform, Custom, Database, Google, Github, Salesforce User, Salesforce Client, and TableauUser. Specify multiple values as a comma-separated list (e.g., \"A,B\")."},{"required":false,"name":"remoteHostId","description":"The ID of the remote host associated with the credentials to return."},{"required":false,"name":"default","description":"If true, will return a list with a single credential which is the current user's default credential."},{"required":false,"name":"systemCredentials","description":"If true, will only return system credentials. System credentials can only be created and viewed by Civis Admins."},{"required":false,"name":"users","description":"A comma-separated list of user ids. If specified, returns set of credentials owned by the users that requesting user has at least read access on."},{"required":false,"name":"name","description":"If specified, will be used to filter the credentials returned. Will search across name and will return any full name containing the search string."},{"required":false,"name":"limit","description":"Number of results to return. Defaults to its maximum of 1000."},{"required":false,"name":"pageNum","description":"Page number of the results to return. Defaults to the first page, 1."},{"required":false,"name":"order","description":"The field on which to order the result set. Defaults to updated_at. Must be one of: updated_at, created_at, name."},{"required":false,"name":"orderDir","description":"Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc."}],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/credentials","request_body":"{\n \"username\": \"myUsername\",\n \"password\": \"myPassword\",\n \"type\": \"Custom\"\n}","request_headers":{"Content-Type":"application/json","Authorization":"Bearer y06KLhKAk83E9Br0bZUjXZ3wOaiAEZODQgLN7KuU8qo","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":201,"response_status_text":"Created","response_body":"{\n \"id\": 58,\n \"name\": \"myUsername\",\n \"type\": \"Custom\",\n \"username\": \"myUsername\",\n \"description\": null,\n \"owner\": \"devuserfactory17\",\n \"user\": {\n \"id\": 55,\n \"name\": \"User devuserfactory17 15\",\n \"username\": \"devuserfactory17\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"remoteHostId\": null,\n \"remoteHostName\": null,\n \"state\": null,\n \"createdAt\": \"2023-07-18T18:39:30.000Z\",\n \"updatedAt\": \"2023-07-18T18:39:30.000Z\",\n \"default\": false,\n \"oauth\": false\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"ec04daff3f0ae9ce74316dce0ba6ec2d\"","X-Request-Id":"696616d0-1273-4eca-aaff-1f5b40641b61","X-Runtime":"0.022498","Content-Length":"389"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/credentials\" -d '{\"username\":\"myUsername\",\"password\":\"myPassword\",\"type\":\"Custom\"}' -X POST \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer y06KLhKAk83E9Br0bZUjXZ3wOaiAEZODQgLN7KuU8qo\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/credentials/{id}":{"put":{"summary":"Update an existing credential","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the credential.","type":"integer"},{"name":"Object61","in":"body","schema":{"$ref":"#/definitions/Object61"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object59"}}},"x-examples":[{"resource":"Credentials","resource_explanation":null,"http_method":"PUT","route":"http://api.civis.test/credentials/:id","description":"Update a database credential","explanation":null,"parameters":[{"required":false,"name":"type","description":"The type (or types) of credentials to return. One or more of: Amazon Web Services S3, Bitbucket, CASS/NCOA PAF, Certificate, Civis Platform, Custom, Database, Google, Github, Salesforce User, Salesforce Client, and TableauUser. Specify multiple values as a comma-separated list (e.g., \"A,B\")."},{"required":false,"name":"remoteHostId","description":"The ID of the remote host associated with the credentials to return."},{"required":false,"name":"default","description":"If true, will return a list with a single credential which is the current user's default credential."},{"required":false,"name":"systemCredentials","description":"If true, will only return system credentials. System credentials can only be created and viewed by Civis Admins."},{"required":false,"name":"users","description":"A comma-separated list of user ids. If specified, returns set of credentials owned by the users that requesting user has at least read access on."},{"required":false,"name":"name","description":"If specified, will be used to filter the credentials returned. Will search across name and will return any full name containing the search string."},{"required":false,"name":"limit","description":"Number of results to return. Defaults to its maximum of 1000."},{"required":false,"name":"pageNum","description":"Page number of the results to return. Defaults to the first page, 1."},{"required":false,"name":"order","description":"The field on which to order the result set. Defaults to updated_at. Must be one of: updated_at, created_at, name."},{"required":false,"name":"orderDir","description":"Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc."}],"response_fields":[],"requests":[{"request_method":"PUT","request_path":"http://api.civis.test/credentials/64","request_body":"{\n \"name\": \"Updated Credential Name\",\n \"username\": \"myNewUsername\",\n \"password\": \"myNewPassword\",\n \"type\": \"Database\",\n \"remote_host_id\": 38\n}","request_headers":{"Content-Type":"application/json","Authorization":"Bearer Dodr5YT6zH8kyylIQu0SoA0pRPjqfxSPU_22cqItfvE","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 64,\n \"name\": \"Updated Credential Name\",\n \"type\": \"Database\",\n \"username\": \"myNewUsername\",\n \"description\": null,\n \"owner\": \"devuserfactory18\",\n \"user\": {\n \"id\": 58,\n \"name\": \"User devuserfactory18 16\",\n \"username\": \"devuserfactory18\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"remoteHostId\": 38,\n \"remoteHostName\": \"mysql-10008\",\n \"state\": null,\n \"createdAt\": \"2023-07-18T18:39:30.000Z\",\n \"updatedAt\": \"2023-07-18T18:39:31.000Z\",\n \"default\": false,\n \"oauth\": false\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"7642a485f3aceef05ed034dddd076fdd\"","X-Request-Id":"f6e27efc-12bc-4337-b449-3c45acbf56fc","X-Runtime":"0.041967","Content-Length":"414"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/credentials/64\" -d '{\"name\":\"Updated Credential Name\",\"username\":\"myNewUsername\",\"password\":\"myNewPassword\",\"type\":\"Database\",\"remote_host_id\":38}' -X PUT \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer Dodr5YT6zH8kyylIQu0SoA0pRPjqfxSPU_22cqItfvE\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Credentials","resource_explanation":null,"http_method":"PUT","route":"http://api.civis.test/credentials/:id","description":"Update a custom credential","explanation":null,"parameters":[{"required":false,"name":"type","description":"The type (or types) of credentials to return. One or more of: Amazon Web Services S3, Bitbucket, CASS/NCOA PAF, Certificate, Civis Platform, Custom, Database, Google, Github, Salesforce User, Salesforce Client, and TableauUser. Specify multiple values as a comma-separated list (e.g., \"A,B\")."},{"required":false,"name":"remoteHostId","description":"The ID of the remote host associated with the credentials to return."},{"required":false,"name":"default","description":"If true, will return a list with a single credential which is the current user's default credential."},{"required":false,"name":"systemCredentials","description":"If true, will only return system credentials. System credentials can only be created and viewed by Civis Admins."},{"required":false,"name":"users","description":"A comma-separated list of user ids. If specified, returns set of credentials owned by the users that requesting user has at least read access on."},{"required":false,"name":"name","description":"If specified, will be used to filter the credentials returned. Will search across name and will return any full name containing the search string."},{"required":false,"name":"limit","description":"Number of results to return. Defaults to its maximum of 1000."},{"required":false,"name":"pageNum","description":"Page number of the results to return. Defaults to the first page, 1."},{"required":false,"name":"order","description":"The field on which to order the result set. Defaults to updated_at. Must be one of: updated_at, created_at, name."},{"required":false,"name":"orderDir","description":"Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc."}],"response_fields":[],"requests":[{"request_method":"PUT","request_path":"http://api.civis.test/credentials/70","request_body":"{\n \"name\": \"Custom Name\",\n \"username\": \"myUserName\",\n \"password\": \"myNewPassword\",\n \"type\": \"Custom\"\n}","request_headers":{"Content-Type":"application/json","Authorization":"Bearer Zf7FyMc6F99HJPJTMMk_UFK3s6chBUoFoPreVp73X1c","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 70,\n \"name\": \"Custom Name\",\n \"type\": \"Custom\",\n \"username\": \"myUserName\",\n \"description\": null,\n \"owner\": \"devuserfactory19\",\n \"user\": {\n \"id\": 61,\n \"name\": \"User devuserfactory19 17\",\n \"username\": \"devuserfactory19\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"remoteHostId\": null,\n \"remoteHostName\": null,\n \"state\": null,\n \"createdAt\": \"2023-07-18T18:39:31.000Z\",\n \"updatedAt\": \"2023-07-18T18:39:31.000Z\",\n \"default\": false,\n \"oauth\": false\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"00d38ac6ebf68b372c0ee16f9403ba49\"","X-Request-Id":"0dd57aac-b8be-4cb3-ad8a-da37c6bbc69f","X-Runtime":"0.041605","Content-Length":"390"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/credentials/70\" -d '{\"name\":\"Custom Name\",\"username\":\"myUserName\",\"password\":\"myNewPassword\",\"type\":\"Custom\"}' -X PUT \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer Zf7FyMc6F99HJPJTMMk_UFK3s6chBUoFoPreVp73X1c\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"patch":{"summary":"Update some attributes of a credential","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the credential.","type":"integer"},{"name":"Object62","in":"body","schema":{"$ref":"#/definitions/Object62"},"required":false}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object59"}}},"x-examples":null,"x-deprecation-warning":null},"get":{"summary":"Get a credential","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the credential.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object59"}}},"x-examples":[{"resource":"Credentials","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/credentials/:id","description":"#get view credential","explanation":null,"parameters":[{"required":false,"name":"type","description":"The type (or types) of credentials to return. One or more of: Amazon Web Services S3, Bitbucket, CASS/NCOA PAF, Certificate, Civis Platform, Custom, Database, Google, Github, Salesforce User, Salesforce Client, and TableauUser. Specify multiple values as a comma-separated list (e.g., \"A,B\")."},{"required":false,"name":"remoteHostId","description":"The ID of the remote host associated with the credentials to return."},{"required":false,"name":"default","description":"If true, will return a list with a single credential which is the current user's default credential."},{"required":false,"name":"systemCredentials","description":"If true, will only return system credentials. System credentials can only be created and viewed by Civis Admins."},{"required":false,"name":"users","description":"A comma-separated list of user ids. If specified, returns set of credentials owned by the users that requesting user has at least read access on."},{"required":false,"name":"name","description":"If specified, will be used to filter the credentials returned. Will search across name and will return any full name containing the search string."},{"required":false,"name":"limit","description":"Number of results to return. Defaults to its maximum of 1000."},{"required":false,"name":"pageNum","description":"Page number of the results to return. Defaults to the first page, 1."},{"required":false,"name":"order","description":"The field on which to order the result set. Defaults to updated_at. Must be one of: updated_at, created_at, name."},{"required":false,"name":"orderDir","description":"Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc."}],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/credentials/76","request_body":null,"request_headers":{"Content-Type":"application/json","Authorization":"Bearer fVm7FD1_YGm2LtU6ARZP4Xfwh8C5RT3Nbesfu75DqFc","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 76,\n \"name\": \"Rentrak\",\n \"type\": \"Amazon Web Services S3\",\n \"username\": \"b1a44ca7-2c68-4a69-9986-cad248264f35\",\n \"description\": null,\n \"owner\": \"devuserfactory20\",\n \"user\": {\n \"id\": 64,\n \"name\": \"User devuserfactory20 18\",\n \"username\": \"devuserfactory20\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"remoteHostId\": null,\n \"remoteHostName\": null,\n \"state\": null,\n \"createdAt\": \"2023-07-18T18:39:31.000Z\",\n \"updatedAt\": \"2023-07-18T18:34:31.000Z\",\n \"default\": false,\n \"oauth\": false\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"96f0962884a7fdfc83fb021ee638f213\"","X-Request-Id":"9dcc675a-bd46-4bb7-b842-dac944be918e","X-Runtime":"0.015075","Content-Length":"428"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/credentials/76\" -X GET \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer fVm7FD1_YGm2LtU6ARZP4Xfwh8C5RT3Nbesfu75DqFc\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Credentials","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/credentials/:id","description":"#get view credential","explanation":null,"parameters":[{"required":false,"name":"type","description":"The type (or types) of credentials to return. One or more of: Amazon Web Services S3, Bitbucket, CASS/NCOA PAF, Certificate, Civis Platform, Custom, Database, Google, Github, Salesforce User, Salesforce Client, and TableauUser. Specify multiple values as a comma-separated list (e.g., \"A,B\")."},{"required":false,"name":"remoteHostId","description":"The ID of the remote host associated with the credentials to return."},{"required":false,"name":"default","description":"If true, will return a list with a single credential which is the current user's default credential."},{"required":false,"name":"systemCredentials","description":"If true, will only return system credentials. System credentials can only be created and viewed by Civis Admins."},{"required":false,"name":"users","description":"A comma-separated list of user ids. If specified, returns set of credentials owned by the users that requesting user has at least read access on."},{"required":false,"name":"name","description":"If specified, will be used to filter the credentials returned. Will search across name and will return any full name containing the search string."},{"required":false,"name":"limit","description":"Number of results to return. Defaults to its maximum of 1000."},{"required":false,"name":"pageNum","description":"Page number of the results to return. Defaults to the first page, 1."},{"required":false,"name":"order","description":"The field on which to order the result set. Defaults to updated_at. Must be one of: updated_at, created_at, name."},{"required":false,"name":"orderDir","description":"Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc."}],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/credentials/82","request_body":null,"request_headers":{"Content-Type":"application/json","Authorization":"Bearer j96OzcWeFDhObdOSV887ewbsH0RJrd01_VD8MavU1vs","Accept":"application/vnd.civis-platform.v2","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 82,\n \"name\": \"Rentrak\",\n \"type\": \"Amazon Web Services S3\",\n \"username\": \"b1a44ca7-2c68-4a69-9986-cad248264f35\",\n \"description\": null,\n \"owner\": \"devuserfactory21\",\n \"user\": {\n \"id\": 67,\n \"name\": \"User devuserfactory21 19\",\n \"username\": \"devuserfactory21\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"remoteHostId\": null,\n \"remoteHostName\": null,\n \"state\": null,\n \"createdAt\": \"2023-07-18T18:39:31.000Z\",\n \"updatedAt\": \"2023-07-18T18:34:31.000Z\",\n \"default\": false,\n \"oauth\": false\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"419910e9d9661b1208636709c6ee394c\"","X-Request-Id":"89737573-81c8-4253-bbe5-b40f853bea8f","X-Runtime":"0.013984","Content-Length":"428"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/credentials/82\" -X GET \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer j96OzcWeFDhObdOSV887ewbsH0RJrd01_VD8MavU1vs\" \\\n\t-H \"Accept: application/vnd.civis-platform.v2\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"delete":{"summary":"Delete a credential","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the credential.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":[{"resource":"Credentials","resource_explanation":null,"http_method":"DELETE","route":"http://api.civis.test/credentials/:id","description":"Delete a credential","explanation":null,"parameters":[{"required":false,"name":"type","description":"The type (or types) of credentials to return. One or more of: Amazon Web Services S3, Bitbucket, CASS/NCOA PAF, Certificate, Civis Platform, Custom, Database, Google, Github, Salesforce User, Salesforce Client, and TableauUser. Specify multiple values as a comma-separated list (e.g., \"A,B\")."},{"required":false,"name":"remoteHostId","description":"The ID of the remote host associated with the credentials to return."},{"required":false,"name":"default","description":"If true, will return a list with a single credential which is the current user's default credential."},{"required":false,"name":"systemCredentials","description":"If true, will only return system credentials. System credentials can only be created and viewed by Civis Admins."},{"required":false,"name":"users","description":"A comma-separated list of user ids. If specified, returns set of credentials owned by the users that requesting user has at least read access on."},{"required":false,"name":"name","description":"If specified, will be used to filter the credentials returned. Will search across name and will return any full name containing the search string."},{"required":false,"name":"limit","description":"Number of results to return. Defaults to its maximum of 1000."},{"required":false,"name":"pageNum","description":"Page number of the results to return. Defaults to the first page, 1."},{"required":false,"name":"order","description":"The field on which to order the result set. Defaults to updated_at. Must be one of: updated_at, created_at, name."},{"required":false,"name":"orderDir","description":"Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc."}],"response_fields":[],"requests":[{"request_method":"DELETE","request_path":"http://api.civis.test/credentials/40","request_body":null,"request_headers":{"Content-Type":"application/json","Authorization":"Bearer iqzl4lE3AZQeaChCwaQfEdTk8Er7zsf7fWVxRUSJP1I","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":204,"response_status_text":"No Content","response_body":null,"response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","X-Request-Id":"9456c5da-b068-46e2-af77-f9b76754b1e5","X-Runtime":"0.019931"},"response_content_type":null,"curl":"curl \"api.civis.testhttp://api.civis.test/credentials/40\" -d '' -X DELETE \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer iqzl4lE3AZQeaChCwaQfEdTk8Er7zsf7fWVxRUSJP1I\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/credentials/authenticate":{"post":{"summary":"Authenticate against a remote host","description":null,"deprecated":false,"parameters":[{"name":"Object63","in":"body","schema":{"$ref":"#/definitions/Object63"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object59"}}},"x-examples":[{"resource":"Credentials","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/credentials/authenticate","description":"Authenticate","explanation":null,"parameters":[{"required":false,"name":"type","description":"The type (or types) of credentials to return. One or more of: Amazon Web Services S3, Bitbucket, CASS/NCOA PAF, Certificate, Civis Platform, Custom, Database, Google, Github, Salesforce User, Salesforce Client, and TableauUser. Specify multiple values as a comma-separated list (e.g., \"A,B\")."},{"required":false,"name":"remoteHostId","description":"The ID of the remote host associated with the credentials to return."},{"required":false,"name":"default","description":"If true, will return a list with a single credential which is the current user's default credential."},{"required":false,"name":"systemCredentials","description":"If true, will only return system credentials. System credentials can only be created and viewed by Civis Admins."},{"required":false,"name":"users","description":"A comma-separated list of user ids. If specified, returns set of credentials owned by the users that requesting user has at least read access on."},{"required":false,"name":"name","description":"If specified, will be used to filter the credentials returned. Will search across name and will return any full name containing the search string."},{"required":false,"name":"limit","description":"Number of results to return. Defaults to its maximum of 1000."},{"required":false,"name":"pageNum","description":"Page number of the results to return. Defaults to the first page, 1."},{"required":false,"name":"order","description":"The field on which to order the result set. Defaults to updated_at. Must be one of: updated_at, created_at, name."},{"required":false,"name":"orderDir","description":"Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc."}],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/credentials/authenticate","request_body":"{\n \"url\": \"jdbc:mysql//myHost/myDb\",\n \"remote_host_type\": \"RemoteHostTypes::JDBC\",\n \"username\": \"myUsername\",\n \"password\": \"myPassword\"\n}","request_headers":{"Content-Type":"application/json","Authorization":"Bearer BH-FehqJmF7ms0QmgmoV_mSdty8yGVW9VcWobQyuB2c","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"success\": true\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"c955e57777ec0d73639dca6748560d00\"","X-Request-Id":"7f015898-18a7-4fa7-8305-04078909a82d","X-Runtime":"0.051966","Content-Length":"16"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/credentials/authenticate\" -d '{\"url\":\"jdbc:mysql//myHost/myDb\",\"remote_host_type\":\"RemoteHostTypes::JDBC\",\"username\":\"myUsername\",\"password\":\"myPassword\"}' -X POST \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer BH-FehqJmF7ms0QmgmoV_mSdty8yGVW9VcWobQyuB2c\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Credentials","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/credentials/authenticate","description":"Authenticate against incorrect username or password","explanation":null,"parameters":[{"required":false,"name":"type","description":"The type (or types) of credentials to return. One or more of: Amazon Web Services S3, Bitbucket, CASS/NCOA PAF, Certificate, Civis Platform, Custom, Database, Google, Github, Salesforce User, Salesforce Client, and TableauUser. Specify multiple values as a comma-separated list (e.g., \"A,B\")."},{"required":false,"name":"remoteHostId","description":"The ID of the remote host associated with the credentials to return."},{"required":false,"name":"default","description":"If true, will return a list with a single credential which is the current user's default credential."},{"required":false,"name":"systemCredentials","description":"If true, will only return system credentials. System credentials can only be created and viewed by Civis Admins."},{"required":false,"name":"users","description":"A comma-separated list of user ids. If specified, returns set of credentials owned by the users that requesting user has at least read access on."},{"required":false,"name":"name","description":"If specified, will be used to filter the credentials returned. Will search across name and will return any full name containing the search string."},{"required":false,"name":"limit","description":"Number of results to return. Defaults to its maximum of 1000."},{"required":false,"name":"pageNum","description":"Page number of the results to return. Defaults to the first page, 1."},{"required":false,"name":"order","description":"The field on which to order the result set. Defaults to updated_at. Must be one of: updated_at, created_at, name."},{"required":false,"name":"orderDir","description":"Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc."}],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/credentials/authenticate","request_body":"{\n \"url\": \"jdbc:mysql//myHost/myDb\",\n \"remote_host_type\": \"RemoteHostTypes::JDBC\",\n \"username\": \"myUsername\",\n \"password\": \"myPassword\"\n}","request_headers":{"Content-Type":"application/json","Authorization":"Bearer 1A4EUtbG8ZA7wbAe-Y4pr4ebzMmfsU9xFeCt5TRf-TM","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":400,"response_status_text":"Bad Request","response_body":"{\n \"error\": \"authentication_error\",\n \"errorDescription\": \"Username or password is incorrect.\",\n \"code\": 400\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","X-Request-Id":"cba36274-879c-49a9-8fee-3527eb64b75b","X-Runtime":"0.039783","Content-Length":"99"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/credentials/authenticate\" -d '{\"url\":\"jdbc:mysql//myHost/myDb\",\"remote_host_type\":\"RemoteHostTypes::JDBC\",\"username\":\"myUsername\",\"password\":\"myPassword\"}' -X POST \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer 1A4EUtbG8ZA7wbAe-Y4pr4ebzMmfsU9xFeCt5TRf-TM\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/credentials/{id}/temporary":{"post":{"summary":"Generate a temporary credential for accessing S3","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the credential.","type":"integer"},{"name":"Object65","in":"body","schema":{"$ref":"#/definitions/Object65"},"required":false}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object66"}}},"x-examples":[{"resource":"Credentials","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/credentials/:id/temporary","description":"Get a temporary credential","explanation":null,"parameters":[{"required":false,"name":"type","description":"The type (or types) of credentials to return. One or more of: Amazon Web Services S3, Bitbucket, CASS/NCOA PAF, Certificate, Civis Platform, Custom, Database, Google, Github, Salesforce User, Salesforce Client, and TableauUser. Specify multiple values as a comma-separated list (e.g., \"A,B\")."},{"required":false,"name":"remoteHostId","description":"The ID of the remote host associated with the credentials to return."},{"required":false,"name":"default","description":"If true, will return a list with a single credential which is the current user's default credential."},{"required":false,"name":"systemCredentials","description":"If true, will only return system credentials. System credentials can only be created and viewed by Civis Admins."},{"required":false,"name":"users","description":"A comma-separated list of user ids. If specified, returns set of credentials owned by the users that requesting user has at least read access on."},{"required":false,"name":"name","description":"If specified, will be used to filter the credentials returned. Will search across name and will return any full name containing the search string."},{"required":false,"name":"limit","description":"Number of results to return. Defaults to its maximum of 1000."},{"required":false,"name":"pageNum","description":"Page number of the results to return. Defaults to the first page, 1."},{"required":false,"name":"order","description":"The field on which to order the result set. Defaults to updated_at. Must be one of: updated_at, created_at, name."},{"required":false,"name":"orderDir","description":"Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc."}],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/credentials/100/temporary","request_body":null,"request_headers":{"Content-Type":"application/json","Authorization":"Bearer tEyZQ0Iz-qVErw3yRMcPVCmxwoJB8_KaimtXlYgZ2ZI","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"accessKey\": \"ASIAJILWE3NJGDWYTPCA\",\n \"secretAccessKey\": \"e3SVJWODk8FdCBynSarANFXj3W3bRDgoQLiyx28n\",\n \"sessionToken\": \"AQoDYXdzELP//////////wEa8AH5MvO75GKCny05yKXKFPoS+W59JVxHqk/tcsV+7+IXaG5DzkTo6zMq9A5si6DuJb9xYKwZKazsg45zM8elnWBGHV0uJrHJrmHk6kKIPHHykceevKHdElZ+d/q4ZE36JVD6GIO6AuQvbri01kB44nw6Y31CYPDxnzhL8NvJhnw8MlpA0czUCzVl0VhCM7H9HczenL1QCFuB/vOkEdYkkvmdo92+b3cD8ixJfePI9KuFuK2Fp3edfULdIJh61JwLnJAlEEO1Z+KHzbsmz5BckK0yYhD4adCEU+ADmk6AoTuG/NjftT98DdGJCrYVCU426nEgpe+xqQU=\"\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"80b44a0138b553730b3488aae09940bb\"","X-Request-Id":"c3dd96eb-238b-4143-a1c8-7af11eaca148","X-Runtime":"0.017955","Content-Length":"471"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/credentials/100/temporary\" -d '' -X POST \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer tEyZQ0Iz-qVErw3yRMcPVCmxwoJB8_KaimtXlYgZ2ZI\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/credentials/{id}/shares":{"get":{"summary":"List users and groups permissioned on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object9"}}}},"x-examples":null,"x-deprecation-warning":null}},"/credentials/{id}/shares/users":{"put":{"summary":"Set the permissions users have on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"Object67","in":"body","schema":{"$ref":"#/definitions/Object67"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object9"}}},"x-examples":null,"x-deprecation-warning":null}},"/credentials/{id}/shares/users/{user_id}":{"delete":{"summary":"Revoke the permissions a user has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"user_id","in":"path","required":true,"description":"The ID of the user.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/credentials/{id}/shares/groups":{"put":{"summary":"Set the permissions groups has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"Object68","in":"body","schema":{"$ref":"#/definitions/Object68"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object9"}}},"x-examples":null,"x-deprecation-warning":null}},"/credentials/{id}/shares/groups/{group_id}":{"delete":{"summary":"Revoke the permissions a group has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"group_id","in":"path","required":true,"description":"The ID of the group.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/credentials/{id}/dependencies":{"get":{"summary":"List dependent objects for this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"user_id","in":"query","required":false,"description":"ID of target user","type":"integer"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object15"}}}},"x-examples":null,"x-deprecation-warning":null}},"/credentials/{id}/transfer":{"put":{"summary":"Transfer ownership of this object to another user","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"Object69","in":"body","schema":{"$ref":"#/definitions/Object69"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object17"}}},"x-examples":null,"x-deprecation-warning":null}},"/databases/":{"get":{"summary":"List databases","description":null,"deprecated":false,"parameters":[],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object70"}}}},"x-examples":[{"resource":"Databases","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/databases","description":"list all databases","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/databases","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer kAQi7I_HPtOzB6zBy9kR7Imif17uwMfDSEw-ugdmXqM","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 15,\n \"name\": \"redshift the first\",\n \"adapter\": \"redshift\",\n \"clusterIdentifier\": \"cluster_identifier-1\",\n \"host\": \"localhost.factory\",\n \"port\": 1234,\n \"databaseName\": \"dev\",\n \"managed\": true\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"4ccda77ac4b23bdac19cd16e74e07697\"","X-Request-Id":"f44bb3d5-4964-41fc-b148-0d3f3ca5f300","X-Runtime":"0.192268","Content-Length":"178"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/databases\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer kAQi7I_HPtOzB6zBy9kR7Imif17uwMfDSEw-ugdmXqM\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Databases","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/databases","description":"list all databases","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/databases","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer ys8STCl-OQFtNwa4JdbJpyqS0N0R9ddiJf3tX7ylVWU","Accept":"application/vnd.civis-platform.v2","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 20,\n \"name\": \"redshift the first\",\n \"adapter\": \"redshift\",\n \"clusterIdentifier\": \"cluster_identifier-3\",\n \"host\": \"localhost.factory\",\n \"port\": 1234,\n \"databaseName\": \"dev\",\n \"managed\": true\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"0b5419085638678c2cd2052d7845140f\"","X-Request-Id":"0b15c544-cc52-4927-841d-b4fc00ccc0fa","X-Runtime":"0.082549","Content-Length":"178"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/databases\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer ys8STCl-OQFtNwa4JdbJpyqS0N0R9ddiJf3tX7ylVWU\" \\\n\t-H \"Accept: application/vnd.civis-platform.v2\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/databases/{id}":{"get":{"summary":"Show database information","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID for the database.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object70"}}},"x-examples":null,"x-deprecation-warning":null}},"/databases/{id}/schemas":{"get":{"summary":"List schemas in this database","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the database.","type":"integer"},{"name":"name","in":"query","required":false,"description":"If specified, will be used to filter the schemas returned.Substring matching is supported (e.g., \"name=schema\" will return both \"schema1\" and \"schema2\"). Does not apply to BigQuery databases.","type":"string"},{"name":"credential_id","in":"query","required":false,"description":"If provided, schemas will be filtered based on the given credential.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object71"}}}},"x-examples":[{"resource":"Databases","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/databases/:id/schemas","description":"List schemas in a database","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/databases/35/schemas","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer rIgRMYiaDrzl3yLEJcjIp5k7wpnj8BVlI0IyrrqC_5Q","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"schema\": \"visible_schema\"\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"14b9cb91d1854a2bbe42ca553a6b33da\"","X-Request-Id":"deac724e-5590-44fa-ad19-f5be95f41e32","X-Runtime":"0.060185","Content-Length":"29"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/databases/35/schemas\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer rIgRMYiaDrzl3yLEJcjIp5k7wpnj8BVlI0IyrrqC_5Q\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Databases","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/databases/:id/schemas?name=_schema","description":"Filter schemas by name","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/databases/40/schemas?name=_schema","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer B0CyQToEPHfvELu8HKB13l9r32_KHpFR3zGd-c3ToC4","Host":"api.civis.test","Cookie":""},"request_query_parameters":{"name":"_schema"},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"schema\": \"other_schema\"\n },\n {\n \"schema\": \"visible_schema\"\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"daa2dd76b4050f092c55ca635fd427f2\"","X-Request-Id":"565b9ea6-6a36-47db-99b2-0d32c896d270","X-Runtime":"0.080392","Content-Length":"55"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/databases/40/schemas?name=_schema\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer B0CyQToEPHfvELu8HKB13l9r32_KHpFR3zGd-c3ToC4\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/databases/{id}/schemas/{schema_name}/tables":{"get":{"summary":"List tables in this schema","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the database","type":"integer"},{"name":"schema_name","in":"path","required":true,"description":"The name of the schema","type":"string"},{"name":"credential_id","in":"query","required":false,"description":"If provided, schemas will be filtered based on the given credential.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object72"}}}},"x-examples":null,"x-deprecation-warning":null}},"/databases/{id}/schemas/{schema_name}/tables/{table_name}":{"get":{"summary":"Show basic table info","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the database","type":"integer"},{"name":"schema_name","in":"path","required":true,"description":"The name of the schema","type":"string"},{"name":"credential_id","in":"query","required":false,"description":"If provided, schemas will be filtered based on the given credential.","type":"integer"},{"name":"table_name","in":"path","required":true,"description":"The name of the table","type":"string"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object73"}}},"x-examples":null,"x-deprecation-warning":null},"patch":{"summary":"Update a table","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the database","type":"integer"},{"name":"schema_name","in":"path","required":true,"description":"The name of the schema","type":"string"},{"name":"table_name","in":"path","required":true,"description":"The name of the table","type":"string"},{"name":"Object83","in":"body","schema":{"$ref":"#/definitions/Object83"},"required":false}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object73"}}},"x-examples":null,"x-deprecation-warning":null}},"/databases/{id}/schemas/{schema_name}/tables/{table_name}/projects":{"get":{"summary":"List the projects a Table belongs to","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the database","type":"integer"},{"name":"hidden","in":"query","required":false,"description":"If specified to be true, returns hidden items. Defaults to false, returning non-hidden items.","type":"boolean"},{"name":"schema_name","in":"path","required":true,"description":"The name of the schema","type":"string"},{"name":"table_name","in":"path","required":true,"description":"The name of the table","type":"string"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object84"}}}},"x-examples":null,"x-deprecation-warning":null}},"/databases/{id}/schemas/{schema_name}/tables/{table_name}/projects/{project_id}":{"put":{"summary":"Add a Table to a project","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the database","type":"integer"},{"name":"project_id","in":"path","required":true,"description":"The ID of the project.","type":"integer"},{"name":"schema_name","in":"path","required":true,"description":"The name of the schema","type":"string"},{"name":"table_name","in":"path","required":true,"description":"The name of the table","type":"string"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null},"delete":{"summary":"Remove a Table from a project","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the database","type":"integer"},{"name":"project_id","in":"path","required":true,"description":"The ID of the project.","type":"integer"},{"name":"schema_name","in":"path","required":true,"description":"The name of the schema","type":"string"},{"name":"table_name","in":"path","required":true,"description":"The name of the table","type":"string"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/databases/{id}/schemas/scan":{"post":{"summary":"Creates and enqueues a schema scanner job","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the database.","type":"integer"},{"name":"Object85","in":"body","schema":{"$ref":"#/definitions/Object85"},"required":true}],"responses":{"201":{"description":"success","schema":{"$ref":"#/definitions/Object86"}}},"x-examples":[{"resource":"Databases","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/databases/:id/schemas/scan","description":"Scan an entire schema in a database","explanation":null,"parameters":[{"required":true,"name":"id","description":"The ID of the database."},{"required":true,"name":"schema","description":"The name of the schema."},{"required":false,"name":"statsPriority","description":"When to sync table statistics for every table in the schema. Valid options are the following. Option: 'flag' means to flag stats for the next scheduled run of a full table scan on the database. Option: 'block' means to block this job on stats syncing. Option: 'queue' means to queue a separate job for syncing stats and do not block this job on the queued job. Defaults to 'flag'"}],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/databases/45/schemas/scan","request_body":"{\n \"schema\": \"visible_schema\"\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer JJ7Fb5ehnlGWOZv9Lg2gfwNuMn9ornQpIGYe7H8A2c0","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":201,"response_status_text":"Created","response_body":"{\n \"jobId\": 1,\n \"runId\": 1\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"9a7eeddba3b0cada49d41e2eb1d0c886\"","X-Request-Id":"b0c0e268-4812-48ff-a1c4-c92316114645","X-Runtime":"0.350761","Content-Length":"21"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/databases/45/schemas/scan\" -d '{\"schema\":\"visible_schema\"}' -X POST \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer JJ7Fb5ehnlGWOZv9Lg2gfwNuMn9ornQpIGYe7H8A2c0\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/databases/{id}/tables":{"get":{"summary":"List tables in the specified database, deprecated use \"GET /tables\" instead","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the database.","type":"integer"},{"name":"name","in":"query","required":false,"description":"If specified, will be used to filter the tables returned. Substring matching is supported (e.g., \"name=table\" will return both \"table1\" and \"my table\").","type":"string"},{"name":"limit","in":"query","required":false,"description":"Number of results to return. Defaults to 200. Maximum allowed is 1000.","type":"integer"},{"name":"page_num","in":"query","required":false,"description":"Page number of the results to return. Defaults to the first page, 1.","type":"integer"},{"name":"order","in":"query","required":false,"description":"The field on which to order the result set. Defaults to name. Must be one of: name.","type":"string"},{"name":"order_dir","in":"query","required":false,"description":"Direction in which to sort, either asc (ascending) or desc (descending) defaulting to asc.","type":"string"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object87"}}}},"x-examples":[{"resource":"Databases","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/databases/:id/tables","description":"List tables on a redshift cluster","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/databases/25/tables","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer 8z6sQEfHY-BaB_P4FVY0SYtPOcpiRhMYs2NERhCQZYY","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 1,\n \"databaseId\": 25,\n \"schema\": \"visible_schema\",\n \"name\": \"visible_table\",\n \"description\": null,\n \"isView\": false,\n \"rowCount\": 1,\n \"columnCount\": 0,\n \"sizeMb\": null,\n \"owner\": \"dbadmin\",\n \"distkey\": null,\n \"sortkeys\": null,\n \"refreshStatus\": \"current\",\n \"lastRefresh\": null,\n \"refreshId\": null,\n \"lastRun\": null,\n \"tableTags\": [\n\n ]\n },\n {\n \"id\": 3,\n \"databaseId\": 25,\n \"schema\": \"visible_schema\",\n \"name\": \"will_not_find_this_table\",\n \"description\": null,\n \"isView\": false,\n \"rowCount\": 1,\n \"columnCount\": 0,\n \"sizeMb\": null,\n \"owner\": \"dbadmin\",\n \"distkey\": null,\n \"sortkeys\": null,\n \"refreshStatus\": \"current\",\n \"lastRefresh\": null,\n \"refreshId\": null,\n \"lastRun\": null,\n \"tableTags\": [\n\n ]\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","X-Pagination-Per-Page":"200","Access-Control-Expose-Headers":"X-Pagination-Per-Page, X-Pagination-Current-Page, X-Pagination-Total-Pages, X-Pagination-Total-Entries","X-Pagination-Current-Page":"1","X-Pagination-Total-Pages":"1","X-Pagination-Total-Entries":"2","Content-Type":"application/json; charset=utf-8","ETag":"W/\"14146ab0ab5d65a990836c79bdb571f3\"","X-Request-Id":"ef68a4c0-5b6b-48c0-a64b-49d05603efed","X-Runtime":"0.138492","Content-Length":"596"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/databases/25/tables\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer 8z6sQEfHY-BaB_P4FVY0SYtPOcpiRhMYs2NERhCQZYY\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Databases","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/databases/:id/tables?name=visible","description":"Filter tables by schema or table name","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/databases/30/tables?name=visible","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer H_kZq8CsWoYfqdqUgs0HB9AvsfoqIZowaWo9Y6SRwXc","Host":"api.civis.test","Cookie":""},"request_query_parameters":{"name":"visible"},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 4,\n \"databaseId\": 30,\n \"schema\": \"visible_schema\",\n \"name\": \"visible_table\",\n \"description\": null,\n \"isView\": false,\n \"rowCount\": 1,\n \"columnCount\": 0,\n \"sizeMb\": null,\n \"owner\": \"dbadmin\",\n \"distkey\": null,\n \"sortkeys\": null,\n \"refreshStatus\": \"current\",\n \"lastRefresh\": null,\n \"refreshId\": null,\n \"lastRun\": null,\n \"tableTags\": [\n\n ]\n },\n {\n \"id\": 6,\n \"databaseId\": 30,\n \"schema\": \"visible_schema\",\n \"name\": \"will_not_find_this_table\",\n \"description\": null,\n \"isView\": false,\n \"rowCount\": 1,\n \"columnCount\": 0,\n \"sizeMb\": null,\n \"owner\": \"dbadmin\",\n \"distkey\": null,\n \"sortkeys\": null,\n \"refreshStatus\": \"current\",\n \"lastRefresh\": null,\n \"refreshId\": null,\n \"lastRun\": null,\n \"tableTags\": [\n\n ]\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","X-Pagination-Per-Page":"200","Access-Control-Expose-Headers":"X-Pagination-Per-Page, X-Pagination-Current-Page, X-Pagination-Total-Pages, X-Pagination-Total-Entries","X-Pagination-Current-Page":"1","X-Pagination-Total-Pages":"1","X-Pagination-Total-Entries":"2","Content-Type":"application/json; charset=utf-8","ETag":"W/\"26c4eafe29942a4ed51982e59407a2d0\"","X-Request-Id":"a89cd411-5daf-4e13-9538-c83bfc1aac04","X-Runtime":"0.089954","Content-Length":"596"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/databases/30/tables?name=visible\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer H_kZq8CsWoYfqdqUgs0HB9AvsfoqIZowaWo9Y6SRwXc\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/databases/{id}/tables-search":{"get":{"summary":"List tables in the specified database, deprecated use \"GET /tables\" instead","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the database.","type":"integer"},{"name":"name","in":"query","required":false,"description":"If specified, will be used to filter the tables returned. Substring matching is supported (e.g., \"name=table\" will return both \"table1\" and \"my table\").","type":"string"},{"name":"column_name","in":"query","required":false,"description":"Search for tables containing a column with the given name.","type":"string"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object88"}}}},"x-examples":[{"resource":"Table Search","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/databases/:id/tables-search?name=carrots&column_name=aaa","description":"Search using table and column names","explanation":null,"parameters":[{"required":true,"name":"id","description":"The ID of the database."},{"required":false,"name":"name","description":"If specified, will be used to filter the tables returned. Substring matching is supported (e.g., \"name=table\" will return both \"table1\" and \"my table\")."},{"required":false,"name":"columnName","description":"Search for tables containing a column with the given name."}],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/databases/78/tables-search?name=carrots&column_name=aaa","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer bJhXuC4nESXtSXmjkZdq2mLWpMiLO1l8_TWk3DnnmCE","Host":"api.civis.test","Cookie":""},"request_query_parameters":{"name":"carrots","column_name":"aaa"},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 7,\n \"databaseId\": 78,\n \"schema\": \"schema_name\",\n \"name\": \"apples\",\n \"description\": null,\n \"isView\": false,\n \"rowCount\": 1,\n \"columnCount\": 4,\n \"sizeMb\": 10,\n \"owner\": \"dbadmin\",\n \"distkey\": \"c\",\n \"sortkeys\": \"d,e\",\n \"refreshStatus\": \"current\",\n \"lastRefresh\": null,\n \"refreshId\": null,\n \"lastRun\": null,\n \"tableTags\": [\n\n ],\n \"columnNames\": [\n \"aaa\"\n ]\n },\n {\n \"id\": 8,\n \"databaseId\": 78,\n \"schema\": \"schema_name\",\n \"name\": \"carrots\",\n \"description\": null,\n \"isView\": false,\n \"rowCount\": 1,\n \"columnCount\": 0,\n \"sizeMb\": null,\n \"owner\": \"dbadmin\",\n \"distkey\": null,\n \"sortkeys\": null,\n \"refreshStatus\": \"current\",\n \"lastRefresh\": null,\n \"refreshId\": null,\n \"lastRun\": null,\n \"tableTags\": [\n\n ],\n \"columnNames\": [\n \"bbb\"\n ]\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"2c1e20600ed0c0989a6d550c63094eac\"","X-Request-Id":"c8f2240d-13cd-4308-aecf-1be6448913be","X-Runtime":"0.027330","Content-Length":"608"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/databases/78/tables-search?name=carrots&column_name=aaa\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer bJhXuC4nESXtSXmjkZdq2mLWpMiLO1l8_TWk3DnnmCE\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/databases/{id}/table_privileges/{schema_name}/{table_name}":{"get":{"summary":"Show table privileges","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the database","type":"integer"},{"name":"schema_name","in":"path","required":true,"description":"The name of the schema","type":"string"},{"name":"credential_id","in":"query","required":false,"description":"If provided, schemas will be filtered based on the given credential.","type":"integer"},{"name":"table_name","in":"path","required":true,"description":"The name of the table","type":"string"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object89"}}},"x-examples":null,"x-deprecation-warning":null}},"/databases/{id}/schema_privileges/{schema_name}":{"get":{"summary":"Show schema privileges","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the database","type":"integer"},{"name":"schema_name","in":"path","required":true,"description":"The name of the schema","type":"string"},{"name":"credential_id","in":"query","required":false,"description":"If provided, schemas will be filtered based on the given credential.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object89"}}},"x-examples":null,"x-deprecation-warning":null}},"/databases/{id}/users":{"get":{"summary":"Show list of database users","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the database.","type":"integer"},{"name":"active","in":"query","required":false,"description":"If true returns active users. If false returns deactivated users. Defaults to true.","type":"boolean"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object90"}}},"x-examples":null,"x-deprecation-warning":null}},"/databases/{id}/groups":{"get":{"summary":"List groups in the specified database","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID for the database.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object91"}}}},"x-examples":null,"x-deprecation-warning":null}},"/databases/{id}/whitelist-ips":{"get":{"summary":"List whitelisted IPs for the specified database","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID for the database.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object92"}}}},"x-examples":[{"resource":"Databases","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/databases/:id/whitelist-ips","description":"List whitelisted IPs for this database","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/databases/50/whitelist-ips","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer SvoIR_ONwqY4gCPWLkihx5IcigPd0mCA6if1RU-6vJE","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 1,\n \"remoteHostId\": 50,\n \"securityGroupId\": \"sg_group_1\",\n \"subnetMask\": \"some ip\",\n \"createdAt\": \"2024-09-06T16:29:46.000Z\",\n \"updatedAt\": \"2024-09-06T16:29:46.000Z\"\n },\n {\n \"id\": 2,\n \"remoteHostId\": 50,\n \"securityGroupId\": \"sg_group_1\",\n \"subnetMask\": \"some ip\",\n \"createdAt\": \"2024-09-06T16:29:46.000Z\",\n \"updatedAt\": \"2024-09-06T16:29:46.000Z\"\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"07596b1601b97686d9e3bfafb2da8bfc\"","X-Request-Id":"701d0bf9-ed60-4ccc-8579-ce64a440f9d3","X-Runtime":"0.059295","Content-Length":"319"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/databases/50/whitelist-ips\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer SvoIR_ONwqY4gCPWLkihx5IcigPd0mCA6if1RU-6vJE\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/databases/{id}/whitelist-ips/{whitelisted_ip_id}":{"get":{"summary":"View details about a whitelisted IP","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the database this rule is applied to.","type":"integer"},{"name":"whitelisted_ip_id","in":"path","required":true,"description":"The ID of this whitelisted IP address.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object93"}}},"x-examples":[{"resource":"Databases","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/databases/:id/whitelist-ips/:whitelisted_ip_id","description":"View details about a whitelisted IP","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/databases/55/whitelist-ips/3","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer dceS_zo3eQp-r2a3NzhASDRCBv4UM0RUnFShDM4h3gk","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 3,\n \"remoteHostId\": 55,\n \"securityGroupId\": \"sg_group_1\",\n \"subnetMask\": \"some ip\",\n \"authorizedBy\": 59,\n \"isActive\": true,\n \"createdAt\": \"2024-09-06T16:29:46.000Z\",\n \"updatedAt\": \"2024-09-06T16:29:46.000Z\"\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"75c3fb46f053a1721a77635d4fba54b5\"","X-Request-Id":"d50dc39f-d15b-4482-a9ce-51c1f95d76a7","X-Runtime":"0.055960","Content-Length":"192"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/databases/55/whitelist-ips/3\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer dceS_zo3eQp-r2a3NzhASDRCBv4UM0RUnFShDM4h3gk\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/databases/{id}/advanced-settings":{"get":{"summary":"Get the advanced settings for this database","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the database this advanced settings object belongs to.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object94"}}},"x-examples":[{"resource":"Databases","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/databases/:id/advanced-settings","description":"fetches the advanced settings for this database server","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/databases/62/advanced-settings","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer _1Plm3GeOGtw7-Tyr_fFemVIILpY9xigQ7C3a9Ll5lc","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"exportCachingEnabled\": true\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"5b48be69a6593fee654b635cc44b8f45\"","X-Request-Id":"e82617c3-a4ac-4e02-8677-720ba73c905b","X-Runtime":"0.053824","Content-Length":"29"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/databases/62/advanced-settings\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer _1Plm3GeOGtw7-Tyr_fFemVIILpY9xigQ7C3a9Ll5lc\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"patch":{"summary":"Update the advanced settings for this database","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the database this advanced settings object belongs to.","type":"integer"},{"name":"Object95","in":"body","schema":{"$ref":"#/definitions/Object95"},"required":false}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object94"}}},"x-examples":[{"resource":"Databases","resource_explanation":null,"http_method":"PATCH","route":"http://api.civis.test/databases/:id/advanced-settings","description":"updates export_caching_enabled for the advanced settings for this database server","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"PATCH","request_path":"http://api.civis.test/databases/74/advanced-settings","request_body":"{\n \"exportCachingEnabled\": false\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer OC4E7LVUdWyRt7a7onZxU1en5Bb8xR7lWOKRuOigQOY","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"exportCachingEnabled\": false\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"c5ebbaf5f8d3d88c7086ad8758ca4824\"","X-Request-Id":"35d16212-a2d1-4bfa-b093-368bcca4315a","X-Runtime":"0.053461","Content-Length":"30"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/databases/74/advanced-settings\" -d '{\"exportCachingEnabled\":false}' -X PATCH \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer OC4E7LVUdWyRt7a7onZxU1en5Bb8xR7lWOKRuOigQOY\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"put":{"summary":"Edit the advanced settings for this database","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the database this advanced settings object belongs to.","type":"integer"},{"name":"Object96","in":"body","schema":{"$ref":"#/definitions/Object96"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object94"}}},"x-examples":[{"resource":"Databases","resource_explanation":null,"http_method":"PUT","route":"http://api.civis.test/databases/:id/advanced-settings","description":"updates the advanced settings for this database server","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"PUT","request_path":"http://api.civis.test/databases/68/advanced-settings","request_body":"{\n \"exportCachingEnabled\": true\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer Dx1CqHGDSE7hQBnp25wiRlVgRsWcVLL3T4esziqCbJE","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"exportCachingEnabled\": true\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"5b48be69a6593fee654b635cc44b8f45\"","X-Request-Id":"99ec3e4c-91f0-4670-bcf7-c4a32ebf9799","X-Runtime":"0.116363","Content-Length":"29"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/databases/68/advanced-settings\" -d '{\"exportCachingEnabled\":true}' -X PUT \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer Dx1CqHGDSE7hQBnp25wiRlVgRsWcVLL3T4esziqCbJE\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/databases/{id}/status_graphs/timeframe/{timeframe}":{"get":{"summary":"Get the status graphs for this database","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the database.","type":"integer"},{"name":"timeframe","in":"path","required":true,"description":"The span of time that the graphs cover. Must be one of 1_hour, 4_hours, 1_day, 2_days, 1_week.","type":"string"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object97"}}},"x-examples":null,"x-deprecation-warning":null}},"/endpoints/":{"get":{"summary":"List API endpoints","description":null,"deprecated":false,"parameters":[],"responses":{"200":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/enhancements/civis-data-match/":{"post":{"summary":"Create a Civis Data Match Enhancement","description":null,"deprecated":false,"parameters":[{"name":"Object100","in":"body","schema":{"$ref":"#/definitions/Object100"},"required":true}],"responses":{"201":{"description":"success","schema":{"$ref":"#/definitions/Object105"}}},"x-examples":[{"resource":"Enhancements","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/enhancements/civis-data-match","description":"Create a Civis Data Match enhancement","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/enhancements/civis-data-match","request_body":"{\n \"name\": \"My civis data match enhancement\",\n \"input_field_mapping\": {\n \"primary_key\": \"voterbase_id\",\n \"first_name\": \"first\",\n \"last_name\": \"last\",\n \"city\": \"city\",\n \"state\": \"state_code\",\n \"zip\": \"zip\"\n },\n \"input_table\": {\n \"database_name\": \"db1\",\n \"schema\": \"schema1\",\n \"table\": \"tbl1\"\n },\n \"output_table\": {\n \"database_name\": \"output_db\",\n \"schema\": \"output_schema\",\n \"table\": \"output_tbl\"\n },\n \"match_target_id\": 2\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer U5VTRRUrsOYhIrYWjbmEZD_AcY3XwR6QboeUC0NOmg8","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":201,"response_status_text":"Created","response_body":"{\n \"id\": 624,\n \"name\": \"My civis data match enhancement\",\n \"type\": \"Container\",\n \"createdAt\": \"2024-12-03T19:43:28.000Z\",\n \"updatedAt\": \"2024-12-03T19:43:28.000Z\",\n \"author\": {\n \"id\": 614,\n \"name\": \"User devuserfactory483 483\",\n \"username\": \"devuserfactory483\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"state\": \"idle\",\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n },\n \"notifications\": {\n \"urls\": [\n\n ],\n \"successEmailSubject\": null,\n \"successEmailBody\": null,\n \"successEmailAddresses\": [\n\n ],\n \"successEmailFromName\": null,\n \"successEmailReplyTo\": null,\n \"failureEmailAddresses\": [\n\n ],\n \"stallWarningMinutes\": null,\n \"successOn\": true,\n \"failureOn\": true\n },\n \"runningAs\": {\n \"id\": 614,\n \"name\": \"User devuserfactory483 483\",\n \"username\": \"devuserfactory483\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"myPermissionLevel\": \"manage\",\n \"inputFieldMapping\": {\n \"primary_key\": \"voterbase_id\",\n \"first_name\": \"first\",\n \"last_name\": \"last\",\n \"city\": \"city\",\n \"state\": \"state_code\",\n \"zip\": \"zip\"\n },\n \"inputTable\": {\n \"databaseName\": \"db1\",\n \"schema\": \"schema1\",\n \"table\": \"tbl1\"\n },\n \"matchTargetId\": 2,\n \"outputTable\": {\n \"databaseName\": \"output_db\",\n \"schema\": \"output_schema\",\n \"table\": \"output_tbl\"\n },\n \"maxMatches\": null,\n \"threshold\": 0.5,\n \"archived\": false,\n \"lastRun\": null,\n \"parentId\": null\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"94c49254cfa10d42470c339c6773990c\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"124ab9b5-86c1-4c1a-bce5-1084434b6edc","X-Runtime":"0.098097","Content-Length":"1220"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/enhancements/civis-data-match\" -d '{\"name\":\"My civis data match enhancement\",\"input_field_mapping\":{\"primary_key\":\"voterbase_id\",\"first_name\":\"first\",\"last_name\":\"last\",\"city\":\"city\",\"state\":\"state_code\",\"zip\":\"zip\"},\"input_table\":{\"database_name\":\"db1\",\"schema\":\"schema1\",\"table\":\"tbl1\"},\"output_table\":{\"database_name\":\"output_db\",\"schema\":\"output_schema\",\"table\":\"output_tbl\"},\"match_target_id\":2}' -X POST \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer U5VTRRUrsOYhIrYWjbmEZD_AcY3XwR6QboeUC0NOmg8\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/enhancements/civis-data-match/{id}":{"get":{"summary":"Get a Civis Data Match Enhancement","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object105"}}},"x-examples":[{"resource":"Enhancements","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/enhancements/civis-data-match/:civis_data_match_id","description":"View a Civis Data Match enhancement's details","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/enhancements/civis-data-match/396","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer 3Q0XciIWJxCrcOqiUVxm5MWdJVD-9_LPU_FKeXMfH3U","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 396,\n \"name\": \"Script #396\",\n \"type\": \"Container\",\n \"createdAt\": \"2024-12-03T19:43:10.000Z\",\n \"updatedAt\": \"2024-12-03T20:43:09.000Z\",\n \"author\": {\n \"id\": 370,\n \"name\": \"User devuserfactory297 297\",\n \"username\": \"devuserfactory297\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"state\": \"running\",\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n },\n \"notifications\": {\n \"urls\": [\n\n ],\n \"successEmailSubject\": null,\n \"successEmailBody\": null,\n \"successEmailAddresses\": [\n\n ],\n \"successEmailFromName\": null,\n \"successEmailReplyTo\": null,\n \"failureEmailAddresses\": [\n\n ],\n \"stallWarningMinutes\": null,\n \"successOn\": true,\n \"failureOn\": true\n },\n \"runningAs\": {\n \"id\": 370,\n \"name\": \"User devuserfactory297 297\",\n \"username\": \"devuserfactory297\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"myPermissionLevel\": \"manage\",\n \"inputFieldMapping\": {\n \"primary_key\": \"voterbase_id\",\n \"first_name\": \"first\",\n \"last_name\": \"last\",\n \"city\": \"city\",\n \"state\": \"state_code\",\n \"zip\": \"zip\"\n },\n \"inputTable\": {\n \"databaseName\": \"db1\",\n \"schema\": \"schema1\",\n \"table\": \"tbl1\"\n },\n \"matchTargetId\": 1,\n \"outputTable\": {\n \"databaseName\": \"output_db\",\n \"schema\": \"output_schema\",\n \"table\": \"output_tbl\"\n },\n \"maxMatches\": 1,\n \"threshold\": 0.0,\n \"archived\": false,\n \"lastRun\": {\n \"id\": 30,\n \"state\": \"running\",\n \"createdAt\": \"2024-12-03T19:43:10.000Z\",\n \"startedAt\": null,\n \"finishedAt\": null,\n \"error\": null\n },\n \"parentId\": null\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"eb51bd78b84a479ec3f4ba4b496a30f0\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"00d997c6-1b74-4cfb-b93d-48aa973891da","X-Runtime":"0.038037","Content-Length":"1310"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/enhancements/civis-data-match/396\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer 3Q0XciIWJxCrcOqiUVxm5MWdJVD-9_LPU_FKeXMfH3U\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"put":{"summary":"Replace all attributes of this Civis Data Match Enhancement","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID for the enhancement.","type":"integer"},{"name":"Object110","in":"body","schema":{"$ref":"#/definitions/Object110"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object105"}}},"x-examples":null,"x-deprecation-warning":null},"patch":{"summary":"Update some attributes of this Civis Data Match Enhancement","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID for the enhancement.","type":"integer"},{"name":"Object111","in":"body","schema":{"$ref":"#/definitions/Object111"},"required":false}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object105"}}},"x-examples":[{"resource":"Enhancements","resource_explanation":null,"http_method":"PATCH","route":"http://api.civis.test/enhancements/civis-data-match/:civis_data_match_id","description":"Update a Civis Data Match enhancement via PATCH","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"PATCH","request_path":"http://api.civis.test/enhancements/civis-data-match/1781","request_body":"{\n \"threshold\": 0.5,\n \"input_table\": {\n \"database_name\": \"db_input\",\n \"schema\": \"schema_input\",\n \"table\": \"tbl_input\"\n }\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer wYqHLzu5R3tIqObr5qYOV0B9I6zsdGmiI-vMgoL8rq4","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 1781,\n \"name\": \"Script #1781\",\n \"type\": \"Container\",\n \"createdAt\": \"2024-12-03T19:45:00.000Z\",\n \"updatedAt\": \"2024-12-03T20:45:00.000Z\",\n \"author\": {\n \"id\": 1819,\n \"name\": \"User devuserfactory1454 1454\",\n \"username\": \"devuserfactory1454\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"state\": \"running\",\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n },\n \"notifications\": {\n \"urls\": [\n\n ],\n \"successEmailSubject\": null,\n \"successEmailBody\": null,\n \"successEmailAddresses\": [\n\n ],\n \"successEmailFromName\": null,\n \"successEmailReplyTo\": null,\n \"failureEmailAddresses\": [\n\n ],\n \"stallWarningMinutes\": null,\n \"successOn\": true,\n \"failureOn\": true\n },\n \"runningAs\": {\n \"id\": 1819,\n \"name\": \"User devuserfactory1454 1454\",\n \"username\": \"devuserfactory1454\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"myPermissionLevel\": \"manage\",\n \"inputFieldMapping\": {\n \"primary_key\": \"voterbase_id\",\n \"first_name\": \"first\",\n \"last_name\": \"last\",\n \"city\": \"city\",\n \"state\": \"state_code\",\n \"zip\": \"zip\"\n },\n \"inputTable\": {\n \"databaseName\": \"db_input\",\n \"schema\": \"schema_input\",\n \"table\": \"tbl_input\"\n },\n \"matchTargetId\": 1,\n \"outputTable\": {\n \"databaseName\": \"output_db\",\n \"schema\": \"output_schema\",\n \"table\": \"output_tbl\"\n },\n \"maxMatches\": 1,\n \"threshold\": 0.5,\n \"archived\": false,\n \"lastRun\": {\n \"id\": 154,\n \"state\": \"running\",\n \"createdAt\": \"2024-12-03T19:45:00.000Z\",\n \"startedAt\": null,\n \"finishedAt\": null,\n \"error\": null\n },\n \"parentId\": null\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"faea88ecc59d7798aefa2476994e4318\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"46b67fe4-ea8f-4180-aff0-3b1d792f0ef4","X-Runtime":"0.106624","Content-Length":"1336"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/enhancements/civis-data-match/1781\" -d '{\"threshold\":0.5,\"input_table\":{\"database_name\":\"db_input\",\"schema\":\"schema_input\",\"table\":\"tbl_input\"}}' -X PATCH \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer wYqHLzu5R3tIqObr5qYOV0B9I6zsdGmiI-vMgoL8rq4\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Enhancements","resource_explanation":null,"http_method":"PATCH","route":"http://api.civis.test/enhancements/civis-data-match/:civis_data_match_id","description":"Update a Civis Data Match enhancement via PATCH without code attributes","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"PATCH","request_path":"http://api.civis.test/enhancements/civis-data-match/1818","request_body":"{\n \"name\": \"new cdm name\"\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer SfFvLlX7oCRcDpplttRHGJ7oN9xlvpMesqqMKUXC_yo","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 1818,\n \"name\": \"new cdm name\",\n \"type\": \"Container\",\n \"createdAt\": \"2024-12-03T19:45:03.000Z\",\n \"updatedAt\": \"2024-12-03T19:45:03.000Z\",\n \"author\": {\n \"id\": 1856,\n \"name\": \"User devuserfactory1485 1485\",\n \"username\": \"devuserfactory1485\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"state\": \"running\",\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n },\n \"notifications\": {\n \"urls\": [\n\n ],\n \"successEmailSubject\": null,\n \"successEmailBody\": null,\n \"successEmailAddresses\": [\n\n ],\n \"successEmailFromName\": null,\n \"successEmailReplyTo\": null,\n \"failureEmailAddresses\": [\n\n ],\n \"stallWarningMinutes\": null,\n \"successOn\": true,\n \"failureOn\": true\n },\n \"runningAs\": {\n \"id\": 1856,\n \"name\": \"User devuserfactory1485 1485\",\n \"username\": \"devuserfactory1485\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"myPermissionLevel\": \"manage\",\n \"inputFieldMapping\": {\n \"primary_key\": \"voterbase_id\",\n \"first_name\": \"first\",\n \"last_name\": \"last\",\n \"city\": \"city\",\n \"state\": \"state_code\",\n \"zip\": \"zip\"\n },\n \"inputTable\": {\n \"databaseName\": \"db1\",\n \"schema\": \"schema1\",\n \"table\": \"tbl1\"\n },\n \"matchTargetId\": 1,\n \"outputTable\": {\n \"databaseName\": \"output_db\",\n \"schema\": \"output_schema\",\n \"table\": \"output_tbl\"\n },\n \"maxMatches\": 1,\n \"threshold\": 0.0,\n \"archived\": false,\n \"lastRun\": {\n \"id\": 157,\n \"state\": \"running\",\n \"createdAt\": \"2024-12-03T19:45:03.000Z\",\n \"startedAt\": null,\n \"finishedAt\": null,\n \"error\": null\n },\n \"parentId\": null\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"a0d7a6c96155ee8cea4555a801d94e9e\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"360a9d1f-a04e-4ee1-9499-f4c301331122","X-Runtime":"0.127584","Content-Length":"1321"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/enhancements/civis-data-match/1818\" -d '{\"name\":\"new cdm name\"}' -X PATCH \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer SfFvLlX7oCRcDpplttRHGJ7oN9xlvpMesqqMKUXC_yo\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/enhancements/civis-data-match/{id}/clone":{"post":{"summary":"Clone this Civis Data Match Enhancement","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID for the enhancement.","type":"integer"},{"name":"Object114","in":"body","schema":{"$ref":"#/definitions/Object114"},"required":false}],"responses":{"201":{"description":"success","schema":{"$ref":"#/definitions/Object105"}}},"x-examples":[{"resource":"Enhancements","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/enhancements/civis-data-match/:civis_data_match_id/clone","description":"Clone a civis data match enhancement","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/enhancements/civis-data-match/1706/clone","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer OKNB1k9CExr-lG0qqZGK7afdY0s_mu5CEdZcTaqHukI","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":201,"response_status_text":"Created","response_body":"{\n \"id\": 1707,\n \"name\": \"Clone of Enhancement 1706 Script #1706\",\n \"type\": \"Container\",\n \"createdAt\": \"2024-12-03T19:44:54.000Z\",\n \"updatedAt\": \"2024-12-03T19:44:54.000Z\",\n \"author\": {\n \"id\": 1745,\n \"name\": \"User devuserfactory1392 1392\",\n \"username\": \"devuserfactory1392\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"state\": \"idle\",\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n },\n \"notifications\": {\n \"urls\": [\n\n ],\n \"successEmailSubject\": null,\n \"successEmailBody\": null,\n \"successEmailAddresses\": [\n \"enhancements_spec_user@civisanalytics.com\"\n ],\n \"successEmailFromName\": null,\n \"successEmailReplyTo\": null,\n \"failureEmailAddresses\": [\n \"enhancements_spec_user@civisanalytics.com\"\n ],\n \"stallWarningMinutes\": null,\n \"successOn\": true,\n \"failureOn\": true\n },\n \"runningAs\": {\n \"id\": 1745,\n \"name\": \"User devuserfactory1392 1392\",\n \"username\": \"devuserfactory1392\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"myPermissionLevel\": \"manage\",\n \"inputFieldMapping\": {\n \"primary_key\": \"voterbase_id\",\n \"first_name\": \"first\",\n \"last_name\": \"last\",\n \"city\": \"city\",\n \"state\": \"state_code\",\n \"zip\": \"zip\"\n },\n \"inputTable\": {\n \"databaseName\": \"db1\",\n \"schema\": \"schema1\",\n \"table\": \"tbl1\"\n },\n \"matchTargetId\": 1,\n \"outputTable\": {\n \"databaseName\": \"output_db\",\n \"schema\": \"output_schema\",\n \"table\": \"output_tbl\"\n },\n \"maxMatches\": 1,\n \"threshold\": 0.0,\n \"archived\": false,\n \"lastRun\": null,\n \"parentId\": null\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"53ba2363c9e7d844c548b709d6e55f90\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"ba555799-9971-4c62-be39-c31396bd4f1b","X-Runtime":"0.123980","Content-Length":"1319"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/enhancements/civis-data-match/1706/clone\" -d '' -X POST \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer OKNB1k9CExr-lG0qqZGK7afdY0s_mu5CEdZcTaqHukI\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Enhancements","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/enhancements/civis-data-match/:civis_data_match_id/clone","description":"Request 404s","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/enhancements/civis-data-match/1934/clone","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer 4lPEJJD5LeD8Tl7ihB3D5ZbpYk-dwCNze3W_gcOFeYM","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":404,"response_status_text":"Not Found","response_body":"{\n \"error\": \"not_found\",\n \"errorDescription\": \"The requested endpoint could not be found.\",\n \"code\": 404\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"7f6ef3a0-596d-4e94-a6e0-52bcca405451","X-Runtime":"0.022268","Content-Length":"96"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/enhancements/civis-data-match/1934/clone\" -d '' -X POST \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer 4lPEJJD5LeD8Tl7ihB3D5ZbpYk-dwCNze3W_gcOFeYM\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/enhancements/civis-data-match/{id}/runs":{"post":{"summary":"Start a run","description":"Start a run and provide a URI for checking its status. The response will provide a 'Location' header which will contain a URI which may be polled to monitor the status of the run.","deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Civis Data Match job.","type":"integer"}],"responses":{"202":{"description":"success","schema":{"$ref":"#/definitions/Object115"}}},"x-examples":[{"resource":"Enhancements","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/enhancements/civis-data-match/:civis_data_match_to_run_id/runs","description":"Create civis data match run","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/enhancements/civis-data-match/1669/runs","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer kFQBPrj85BNZQyaeljQ8j6epzTolT5bYyYqW1XmbWTc","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":202,"response_status_text":"Accepted","response_body":"{\n \"id\": 145,\n \"civisDataMatchId\": 1669,\n \"state\": \"queued\",\n \"isCancelRequested\": false,\n \"createdAt\": \"2024-12-03T19:44:51.000Z\",\n \"startedAt\": null,\n \"finishedAt\": null,\n \"error\": null\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Location":"http://api.civis.test/civis_data_match/1669/runs/145","Content-Type":"application/json; charset=utf-8","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"a98676d3-c751-4f19-82ba-b1207df3155c","X-Runtime":"0.109690","Content-Length":"164"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/enhancements/civis-data-match/1669/runs\" -d '' -X POST \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer kFQBPrj85BNZQyaeljQ8j6epzTolT5bYyYqW1XmbWTc\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Enhancements","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/enhancements/civis-data-match/:civis_data_match_to_run_id/runs","description":"Request 404s","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/enhancements/civis-data-match/%3Acivis_data_match_to_run_id/runs","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer WV6_wpXphm9fz7fC0hUyhJ0hBWtNo2hlLRWydp02cAg","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":404,"response_status_text":"Not Found","response_body":"{\n \"error\": \"not_found\",\n \"errorDescription\": \"The requested endpoint could not be found.\",\n \"code\": 404\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"8891152d-257a-494b-9576-7d1dd38ce9df","X-Runtime":"0.019938","Content-Length":"96"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/enhancements/civis-data-match/%3Acivis_data_match_to_run_id/runs\" -d '' -X POST \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer WV6_wpXphm9fz7fC0hUyhJ0hBWtNo2hlLRWydp02cAg\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"get":{"summary":"List runs for the given Civis Data Match job","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Civis Data Match job.","type":"integer"},{"name":"limit","in":"query","required":false,"description":"Number of results to return. Defaults to 20. Maximum allowed is 100.","type":"integer"},{"name":"page_num","in":"query","required":false,"description":"Page number of the results to return. Defaults to the first page, 1.","type":"integer"},{"name":"order","in":"query","required":false,"description":"The field on which to order the result set. Defaults to id. Must be one of: id.","type":"string"},{"name":"order_dir","in":"query","required":false,"description":"Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc.","type":"string"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object115"}}}},"x-examples":null,"x-deprecation-warning":null}},"/enhancements/civis-data-match/{id}/runs/{run_id}":{"get":{"summary":"Check status of a run","description":"View the status of a run. This endpoint may be polled to monitor the status of the run. When the 'state' field is no longer 'queued' or 'running' the run has reached its final state.","deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Civis Data Match job.","type":"integer"},{"name":"run_id","in":"path","required":true,"description":"The ID of the run.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object115"}}},"x-examples":[{"resource":"Enhancements","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/enhancements/civis-data-match/:civis_data_match_id/runs/:civis_data_match_run_id","description":"View a civis data match enhancement's run details","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/enhancements/civis-data-match/1744/runs/151","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer EXFe_CGVwcdlLykzlDk_zu4Gkz02BOzuI48MDkjR71c","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 151,\n \"civisDataMatchId\": 1744,\n \"state\": \"running\",\n \"isCancelRequested\": false,\n \"createdAt\": \"2024-12-03T19:44:57.000Z\",\n \"startedAt\": null,\n \"finishedAt\": null,\n \"error\": null\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"877b0f4349f1a00f6cb4ed0712e7a8d1\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"ff12ce8b-8906-40e5-a282-692cedd60b0f","X-Runtime":"0.030336","Content-Length":"165"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/enhancements/civis-data-match/1744/runs/151\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer EXFe_CGVwcdlLykzlDk_zu4Gkz02BOzuI48MDkjR71c\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"delete":{"summary":"Cancel a run","description":"Cancel a currently active run.","deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Civis Data Match job.","type":"integer"},{"name":"run_id","in":"path","required":true,"description":"The ID of the run.","type":"integer"}],"responses":{"202":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/enhancements/civis-data-match/{id}/runs/{run_id}/logs":{"get":{"summary":"Get the logs for a run","description":"Get the logs for a run.","deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Civis Data Match job.","type":"integer"},{"name":"run_id","in":"path","required":true,"description":"The ID of the run.","type":"integer"},{"name":"last_id","in":"query","required":false,"description":"The ID of the last log message received. Log entries with this ID value or lower will be omitted.Logs are sorted by ID if this value is provided, and are otherwise sorted by createdAt.","type":"integer"},{"name":"limit","in":"query","required":false,"description":"The maximum number of log messages to return. Default of 10000.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object116"}}}},"x-examples":null,"x-deprecation-warning":null}},"/enhancements/civis-data-match/{id}/cancel":{"post":{"summary":"Cancel a run","description":"Cancel a run.","deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the job.","type":"integer"}],"responses":{"202":{"description":"success","schema":{"$ref":"#/definitions/Object117"}}},"x-examples":null,"x-deprecation-warning":null}},"/enhancements/civis-data-match/{id}/runs/{run_id}/outputs":{"get":{"summary":"List the outputs for a run","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the job.","type":"integer"},{"name":"run_id","in":"path","required":true,"description":"The ID of the run.","type":"integer"},{"name":"limit","in":"query","required":false,"description":"Number of results to return. Defaults to its maximum of 50.","type":"integer"},{"name":"page_num","in":"query","required":false,"description":"Page number of the results to return. Defaults to the first page, 1.","type":"integer"},{"name":"order","in":"query","required":false,"description":"The field on which to order the result set. Defaults to created_at. Must be one of: created_at, id.","type":"string"},{"name":"order_dir","in":"query","required":false,"description":"Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc.","type":"string"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object118"}}}},"x-examples":[{"resource":"Enhancements","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/enhancements/civis-data-match/:job_with_run_id/runs/:job_run_id/outputs","description":"View a Civis Data Match Enhancement's outputs","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/enhancements/civis-data-match/1858/runs/161/outputs","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer diiWJY8kQQR-KjSmaN7sEZB8ij9D8pHvhNMCV8dm9VM","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"objectType\": \"File\",\n \"objectId\": 24,\n \"name\": \"my output file\",\n \"link\": \"api.civis.test/files/24\",\n \"value\": null\n },\n {\n \"objectType\": \"Report\",\n \"objectId\": 9,\n \"name\": \"my output report\",\n \"link\": \"api.civis.test/reports/9\",\n \"value\": null\n },\n {\n \"objectType\": \"Report\",\n \"objectId\": 10,\n \"name\": \"my output tableau report\",\n \"link\": \"api.civis.test/reports/10\",\n \"value\": null\n },\n {\n \"objectType\": \"Table\",\n \"objectId\": 124,\n \"name\": \"output.table\",\n \"link\": \"api.civis.test/tables/124\",\n \"value\": null\n },\n {\n \"objectType\": \"Project\",\n \"objectId\": 5,\n \"name\": \"my output project\",\n \"link\": \"api.civis.test/projects/5\",\n \"value\": null\n },\n {\n \"objectType\": \"Credential\",\n \"objectId\": 292,\n \"name\": \"my output credential\",\n \"link\": \"api.civis.test/credentials/292\",\n \"value\": null\n },\n {\n \"objectType\": \"JSONValue\",\n \"objectId\": 5,\n \"name\": \"my awesome JSON value\",\n \"link\": \"api.civis.test/json_values/5\",\n \"value\": {\n \"foo\": \"bar\"\n }\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","X-Pagination-Per-Page":"50","Access-Control-Expose-Headers":"X-Pagination-Per-Page, X-Pagination-Current-Page, X-Pagination-Total-Pages, X-Pagination-Total-Entries","X-Pagination-Current-Page":"1","X-Pagination-Total-Pages":"1","X-Pagination-Total-Entries":"7","Content-Type":"application/json; charset=utf-8","ETag":"W/\"c2d70d3d0e416103693197143b9bb8ca\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"c5f79aaa-9b4a-4283-8f3b-84eac310f5c6","X-Runtime":"0.071496","Content-Length":"815"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/enhancements/civis-data-match/1858/runs/161/outputs\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer diiWJY8kQQR-KjSmaN7sEZB8ij9D8pHvhNMCV8dm9VM\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/enhancements/civis-data-match/{id}/shares":{"get":{"summary":"List users and groups permissioned on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object9"}}}},"x-examples":null,"x-deprecation-warning":null}},"/enhancements/civis-data-match/{id}/shares/users":{"put":{"summary":"Set the permissions users have on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"Object119","in":"body","schema":{"$ref":"#/definitions/Object119"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object9"}}},"x-examples":null,"x-deprecation-warning":null}},"/enhancements/civis-data-match/{id}/shares/users/{user_id}":{"delete":{"summary":"Revoke the permissions a user has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"user_id","in":"path","required":true,"description":"The ID of the user.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/enhancements/civis-data-match/{id}/shares/groups":{"put":{"summary":"Set the permissions groups has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"Object120","in":"body","schema":{"$ref":"#/definitions/Object120"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object9"}}},"x-examples":null,"x-deprecation-warning":null}},"/enhancements/civis-data-match/{id}/shares/groups/{group_id}":{"delete":{"summary":"Revoke the permissions a group has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"group_id","in":"path","required":true,"description":"The ID of the group.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/enhancements/civis-data-match/{id}/dependencies":{"get":{"summary":"List dependent objects for this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"user_id","in":"query","required":false,"description":"ID of target user","type":"integer"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object15"}}}},"x-examples":null,"x-deprecation-warning":null}},"/enhancements/civis-data-match/{id}/transfer":{"put":{"summary":"Transfer ownership of this object to another user","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"Object121","in":"body","schema":{"$ref":"#/definitions/Object121"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object17"}}},"x-examples":null,"x-deprecation-warning":null}},"/enhancements/civis-data-match/{id}/archive":{"put":{"summary":"Update the archive status of this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the object.","type":"integer"},{"name":"Object122","in":"body","schema":{"$ref":"#/definitions/Object122"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object105"}}},"x-examples":null,"x-deprecation-warning":null}},"/enhancements/civis-data-match/{id}/projects":{"get":{"summary":"List the projects a Civis Data Match Enhancement belongs to","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Civis Data Match Enhancement.","type":"integer"},{"name":"hidden","in":"query","required":false,"description":"If specified to be true, returns hidden items. Defaults to false, returning non-hidden items.","type":"boolean"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object84"}}}},"x-examples":null,"x-deprecation-warning":null}},"/enhancements/civis-data-match/{id}/projects/{project_id}":{"put":{"summary":"Add a Civis Data Match Enhancement to a project","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Civis Data Match Enhancement.","type":"integer"},{"name":"project_id","in":"path","required":true,"description":"The ID of the project.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null},"delete":{"summary":"Remove a Civis Data Match Enhancement from a project","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Civis Data Match Enhancement.","type":"integer"},{"name":"project_id","in":"path","required":true,"description":"The ID of the project.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/enhancements/identity-resolution/":{"get":{"summary":"List Identity Resolution Enhancements","description":null,"deprecated":false,"parameters":[{"name":"archived","in":"query","required":false,"description":"The archival status of the requested item(s).","type":"string"},{"name":"status","in":"query","required":false,"description":"If specified, returns items with one of these statuses. It accepts a comma-separated list, possible values are 'running', 'failed', 'succeeded', 'idle', 'scheduled'.","type":"string"},{"name":"limit","in":"query","required":false,"description":"Number of results to return. Defaults to 50. Maximum allowed is 100.","type":"integer"},{"name":"page_num","in":"query","required":false,"description":"Page number of the results to return. Defaults to the first page, 1.","type":"integer"},{"name":"order","in":"query","required":false,"description":"The field on which to order the result set. Defaults to updated_at. Must be one of: updated_at, created_at, last_run_updated_at.","type":"string"},{"name":"order_dir","in":"query","required":false,"description":"Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc.","type":"string"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object123"}}}},"x-examples":null,"x-deprecation-warning":null},"post":{"summary":"Create an Identity Resolution Enhancement","description":null,"deprecated":false,"parameters":[{"name":"Object127","in":"body","schema":{"$ref":"#/definitions/Object127"},"required":true}],"responses":{"201":{"description":"success","schema":{"$ref":"#/definitions/Object134"}}},"x-examples":null,"x-deprecation-warning":null}},"/enhancements/identity-resolution/{id}":{"put":{"summary":"Replace all attributes of this Identity Resolution Enhancement","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID for the enhancement.","type":"integer"},{"name":"Object142","in":"body","schema":{"$ref":"#/definitions/Object142"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object134"}}},"x-examples":null,"x-deprecation-warning":null},"patch":{"summary":"Update some attributes of this Identity Resolution Enhancement","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID for the enhancement.","type":"integer"},{"name":"Object143","in":"body","schema":{"$ref":"#/definitions/Object143"},"required":false}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object134"}}},"x-examples":null,"x-deprecation-warning":null},"get":{"summary":"Get an Identity Resolution Enhancement","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID for the enhancement.","type":"integer"},{"name":"is_legacy_id","in":"query","required":false,"description":"Whether the given ID is for the Identity Resolution job in the legacy service app.","type":"boolean"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object134"}}},"x-examples":null,"x-deprecation-warning":null}},"/enhancements/identity-resolution/{id}/clone":{"post":{"summary":"Clone this Identity Resolution Enhancement","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID for the enhancement.","type":"integer"},{"name":"Object114","in":"body","schema":{"$ref":"#/definitions/Object114"},"required":false}],"responses":{"201":{"description":"success","schema":{"$ref":"#/definitions/Object134"}}},"x-examples":[{"resource":"Enhancements","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/enhancements/identity-resolution/:identity_resolution_id/clone","description":"Clone an identity resolution enhancement","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/enhancements/identity-resolution/1273/clone","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer z4jaPDEBfHA1M5AxyiV1E8H70ohpQu7KHLMy00Kf7Vs","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":201,"response_status_text":"Created","response_body":"{\n \"id\": 1274,\n \"name\": \"Clone of Identity Resolution 1273 Identity Resolution #1273\",\n \"type\": \"Identity Resolution\",\n \"createdAt\": \"2024-12-03T19:44:21.000Z\",\n \"updatedAt\": \"2024-12-03T19:44:21.000Z\",\n \"author\": {\n \"id\": 1307,\n \"name\": \"User devuserfactory1025 1025\",\n \"username\": \"devuserfactory1025\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"state\": \"idle\",\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n },\n \"notifications\": {\n \"urls\": [\n\n ],\n \"successEmailSubject\": null,\n \"successEmailBody\": null,\n \"successEmailAddresses\": [\n \"enhancements_spec_user@civisanalytics.com\"\n ],\n \"successEmailFromName\": null,\n \"successEmailReplyTo\": null,\n \"failureEmailAddresses\": [\n \"enhancements_spec_user@civisanalytics.com\"\n ],\n \"stallWarningMinutes\": null,\n \"successOn\": true,\n \"failureOn\": true\n },\n \"runningAs\": {\n \"id\": 1307,\n \"name\": \"User devuserfactory1025 1025\",\n \"username\": \"devuserfactory1025\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"myPermissionLevel\": \"manage\",\n \"archived\": false,\n \"threshold\": 0.5,\n \"sources\": [\n\n ],\n \"matchTargetId\": null,\n \"enforcedLinks\": [\n\n ],\n \"customerGraph\": null,\n \"goldenTable\": null,\n \"linkScores\": null,\n \"legacyId\": null,\n \"lastRun\": null\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"00f102e659ee244b00cd89713bb6e7d1\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"3cb53de1-842b-4813-8de8-f39047773d9c","X-Runtime":"0.097724","Content-Length":"1131"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/enhancements/identity-resolution/1273/clone\" -d '' -X POST \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer z4jaPDEBfHA1M5AxyiV1E8H70ohpQu7KHLMy00Kf7Vs\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/enhancements/identity-resolution/{id}/runs":{"post":{"summary":"Start a run","description":"Start a run and provide a URI for checking its status. The response will provide a 'Location' header which will contain a URI which may be polled to monitor the status of the run.","deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Identity Resolution job.","type":"integer"}],"responses":{"202":{"description":"success","schema":{"$ref":"#/definitions/Object150"}}},"x-examples":[{"resource":"Enhancements","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/enhancements/identity-resolution/:identity_resolution_id/runs","description":"Create a Identity Resolution run","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/enhancements/identity-resolution/1313/runs","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer BZLa2Qpn9BXeSxKxKfslNeFdvqPZ6ScUNMlBx-3LH1c","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":202,"response_status_text":"Accepted","response_body":"{\n \"id\": 109,\n \"identityResolutionId\": 1313,\n \"state\": \"queued\",\n \"isCancelRequested\": false,\n \"createdAt\": \"2024-12-03T19:44:25.000Z\",\n \"startedAt\": null,\n \"finishedAt\": null,\n \"error\": null,\n \"config\": null,\n \"sampleRecordsQuery\": null,\n \"expandClusterQuery\": null,\n \"runMetrics\": null,\n \"errorSection\": null\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Location":"http://api.civis.test/identity_resolution/1313/runs/109","Content-Type":"application/json; charset=utf-8","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"86c9e1be-4029-4881-826b-7fcbc1a9643e","X-Runtime":"0.126655","Content-Length":"272"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/enhancements/identity-resolution/1313/runs\" -d '' -X POST \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer BZLa2Qpn9BXeSxKxKfslNeFdvqPZ6ScUNMlBx-3LH1c\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"get":{"summary":"List runs for the given Identity Resolution job","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Identity Resolution job.","type":"integer"},{"name":"limit","in":"query","required":false,"description":"Number of results to return. Defaults to 20. Maximum allowed is 100.","type":"integer"},{"name":"page_num","in":"query","required":false,"description":"Page number of the results to return. Defaults to the first page, 1.","type":"integer"},{"name":"order","in":"query","required":false,"description":"The field on which to order the result set. Defaults to id. Must be one of: id.","type":"string"},{"name":"order_dir","in":"query","required":false,"description":"Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc.","type":"string"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object151"}}}},"x-examples":[{"resource":"Enhancements","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/enhancements/identity-resolution/:identity_resolution_id/runs","description":"View a Identity Resolution enhancement's runs","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/enhancements/identity-resolution/1391/runs","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer HBBQ0RHYBh14qZG-DG4kaA4k4MJUoS9JO4VgrFLangI","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 119,\n \"identityResolutionId\": 1391,\n \"state\": \"running\",\n \"isCancelRequested\": false,\n \"createdAt\": \"2024-12-03T19:44:30.000Z\",\n \"startedAt\": null,\n \"finishedAt\": \"2024-12-03T19:43:30.000Z\",\n \"error\": null,\n \"sampleRecordsQuery\": \"SELECT * FROM table\",\n \"expandClusterQuery\": \"SELECT * FROM table\",\n \"runMetrics\": {\n \"numRecords\": 3,\n \"uniqueIds\": 2,\n \"uniqueDeduplicatedIds\": 5,\n \"maxClusterSize\": 100,\n \"avgClusterSize\": 50.0,\n \"clusterSizeFrequencies\": {\n }\n }\n },\n {\n \"id\": 118,\n \"identityResolutionId\": 1391,\n \"state\": \"running\",\n \"isCancelRequested\": false,\n \"createdAt\": \"2024-12-03T19:44:30.000Z\",\n \"startedAt\": null,\n \"finishedAt\": \"2024-12-03T19:42:30.000Z\",\n \"error\": null,\n \"sampleRecordsQuery\": \"SELECT * FROM table\",\n \"expandClusterQuery\": \"SELECT * FROM table\",\n \"runMetrics\": {\n \"numRecords\": 3,\n \"uniqueIds\": 2,\n \"uniqueDeduplicatedIds\": 5,\n \"maxClusterSize\": 100,\n \"avgClusterSize\": 50.0,\n \"clusterSizeFrequencies\": {\n }\n }\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","X-Pagination-Per-Page":"20","Access-Control-Expose-Headers":"X-Pagination-Per-Page, X-Pagination-Current-Page, X-Pagination-Total-Pages, X-Pagination-Total-Entries","X-Pagination-Current-Page":"1","X-Pagination-Total-Pages":"1","X-Pagination-Total-Entries":"2","Content-Type":"application/json; charset=utf-8","ETag":"W/\"40309f988aff5525f50c4c68e7066866\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"9d0e8508-bf31-4667-8887-aeb06c6e4b97","X-Runtime":"0.038235","Content-Length":"839"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/enhancements/identity-resolution/1391/runs\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer HBBQ0RHYBh14qZG-DG4kaA4k4MJUoS9JO4VgrFLangI\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/enhancements/identity-resolution/{id}/runs/{run_id}":{"get":{"summary":"Check status of a run","description":"View the status of a run. This endpoint may be polled to monitor the status of the run. When the 'state' field is no longer 'queued' or 'running' the run has reached its final state.","deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Identity Resolution job.","type":"integer"},{"name":"run_id","in":"path","required":true,"description":"The ID of the run.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object150"}}},"x-examples":[{"resource":"Enhancements","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/enhancements/identity-resolution/:identity_resolution_id/runs/:idr_run_id","description":"View a Identity Resolution enhancement's run details","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/enhancements/identity-resolution/1352/runs/113","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer 5ALuB8foVGuGQpnhn-1a69OBIptrBbcNZQffXeOyF1k","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 113,\n \"identityResolutionId\": 1352,\n \"state\": \"running\",\n \"isCancelRequested\": false,\n \"createdAt\": \"2024-12-03T19:44:27.000Z\",\n \"startedAt\": null,\n \"finishedAt\": \"2024-12-03T19:42:27.000Z\",\n \"error\": null,\n \"config\": {\n \"job_id\": 1352,\n \"run_id\": 113,\n \"name\": \"Identity Resolution #1352\",\n \"updated_at\": \"2024-12-03T19:39:27.000Z\",\n \"threshold\": 0.5,\n \"match_target_id\": null,\n \"sources\": [\n\n ],\n \"enforced_links\": [\n\n ],\n \"customer_graph\": null,\n \"golden_table\": null,\n \"link_scores\": null\n },\n \"sampleRecordsQuery\": \"SELECT * FROM table\",\n \"expandClusterQuery\": \"SELECT * FROM table\",\n \"runMetrics\": {\n \"numRecords\": 3,\n \"uniqueIds\": 2,\n \"uniqueDeduplicatedIds\": 5,\n \"maxClusterSize\": 100,\n \"avgClusterSize\": 50.0,\n \"clusterSizeFrequencies\": {\n }\n },\n \"errorSection\": \"data_preparation\"\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"33bda6e77d84a94e640ab07971bad2a2\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"2dd781d3-aaad-4d1d-b80f-37b0ab60fce8","X-Runtime":"0.036446","Content-Length":"698"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/enhancements/identity-resolution/1352/runs/113\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer 5ALuB8foVGuGQpnhn-1a69OBIptrBbcNZQffXeOyF1k\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"delete":{"summary":"Cancel a run","description":"Cancel a currently active run.","deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Identity Resolution job.","type":"integer"},{"name":"run_id","in":"path","required":true,"description":"The ID of the run.","type":"integer"}],"responses":{"202":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/enhancements/identity-resolution/{id}/runs/{run_id}/logs":{"get":{"summary":"Get the logs for a run","description":"Get the logs for a run.","deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Identity Resolution job.","type":"integer"},{"name":"run_id","in":"path","required":true,"description":"The ID of the run.","type":"integer"},{"name":"last_id","in":"query","required":false,"description":"The ID of the last log message received. Log entries with this ID value or lower will be omitted.Logs are sorted by ID if this value is provided, and are otherwise sorted by createdAt.","type":"integer"},{"name":"limit","in":"query","required":false,"description":"The maximum number of log messages to return. Default of 10000.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object116"}}}},"x-examples":null,"x-deprecation-warning":null}},"/enhancements/identity-resolution/{id}/cancel":{"post":{"summary":"Cancel a run","description":"Cancel a run.","deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the job.","type":"integer"}],"responses":{"202":{"description":"success","schema":{"$ref":"#/definitions/Object152"}}},"x-examples":null,"x-deprecation-warning":null}},"/enhancements/types":{"get":{"summary":"List available enhancement types","description":null,"deprecated":false,"parameters":[],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object154"}}}},"x-examples":null,"x-deprecation-warning":null}},"/enhancements/field-mapping":{"get":{"summary":"List the fields in a field mapping for Civis Data Match, Data Unification, and Table Deduplication jobs","description":null,"deprecated":false,"parameters":[],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object155"}}}},"x-examples":[{"resource":"Enhancements","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/enhancements/field-mapping","description":"List the valid fields for a field mapping","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/enhancements/field-mapping","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer cPt-Zu43F3y8HhPM72k26zMF5oQ6dHG_QquJNTfXASA","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"field\": \"primary_key\",\n \"description\": \"A unique identifier.\"\n },\n {\n \"field\": \"first_name\",\n \"description\": \"First name.\"\n },\n {\n \"field\": \"middle_name\",\n \"description\": \"Middle name.\"\n },\n {\n \"field\": \"last_name\",\n \"description\": \"Last name.\"\n },\n {\n \"field\": \"gender\",\n \"description\": \"Gender. The following formats for gender are acceptable: Male/Female or M/F.\"\n },\n {\n \"field\": \"phone\",\n \"description\": \"10-digit phone number. All non-numeric characters (dashes, parentheses, spaces, periods, etc.) will be removed.\"\n },\n {\n \"field\": \"email\",\n \"description\": \"Email address.\"\n },\n {\n \"field\": \"birth_date\",\n \"description\": \"Full birth date, including year, month, and day.\"\n },\n {\n \"field\": \"birth_year\",\n \"description\": \"Birth year.\"\n },\n {\n \"field\": \"birth_month\",\n \"description\": \"Birth month.\"\n },\n {\n \"field\": \"birth_day\",\n \"description\": \"Birth day.\"\n },\n {\n \"field\": \"house_number\",\n \"description\": \"House number.\"\n },\n {\n \"field\": \"street\",\n \"description\": \"Street.\"\n },\n {\n \"field\": \"unit\",\n \"description\": \"Unit/apartment/suite number.\"\n },\n {\n \"field\": \"full_address\",\n \"description\": \"Full address with house number, street, and unit/apartment/suite number\"\n },\n {\n \"field\": \"city\",\n \"description\": \"City.\"\n },\n {\n \"field\": \"state\",\n \"description\": \"Full state name.\"\n },\n {\n \"field\": \"state_code\",\n \"description\": \"Two-digit state code.\"\n },\n {\n \"field\": \"zip\",\n \"description\": \"5-digit or 9-digit zip code. All non-numeric characters will be removed.\"\n },\n {\n \"field\": \"lat\",\n \"description\": \"Latitude.\"\n },\n {\n \"field\": \"lon\",\n \"description\": \"Longitude.\"\n },\n {\n \"field\": \"name_suffix\",\n \"description\": \"A name suffix such as Jr., Sr., etc ...\"\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"09e040220da82d82d92080b8704d210e\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"55037ed8-abce-4fe2-b545-ed0e8daa1b44","X-Runtime":"0.018571","Content-Length":"1457"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/enhancements/field-mapping\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer cPt-Zu43F3y8HhPM72k26zMF5oQ6dHG_QquJNTfXASA\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/enhancements/":{"get":{"summary":"List Enhancements","description":null,"deprecated":false,"parameters":[{"name":"type","in":"query","required":false,"description":"If specified, return items of these types.","type":"string"},{"name":"author","in":"query","required":false,"description":"If specified, return items from any of these authors. It accepts a comma-separated list of user IDs.","type":"string"},{"name":"status","in":"query","required":false,"description":"If specified, returns items with one of these statuses. It accepts a comma-separated list, possible values are 'running', 'failed', 'succeeded', 'idle', 'scheduled'.","type":"string"},{"name":"archived","in":"query","required":false,"description":"The archival status of the requested item(s).","type":"string"},{"name":"limit","in":"query","required":false,"description":"Number of results to return. Defaults to 20. Maximum allowed is 50.","type":"integer"},{"name":"page_num","in":"query","required":false,"description":"Page number of the results to return. Defaults to the first page, 1.","type":"integer"},{"name":"order","in":"query","required":false,"description":"The field on which to order the result set. Defaults to updated_at. Must be one of: updated_at, name, created_at, last_run.updated_at.","type":"string"},{"name":"order_dir","in":"query","required":false,"description":"Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc.","type":"string"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object156"}}}},"x-examples":[{"resource":"Enhancements","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/enhancements","description":"List all enhancements","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/enhancements","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer 2zR0Feo8IVd-UTJFAdH-ZSO0cGdpGg3YDp2R4C2IO70","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 13,\n \"name\": \"Script #13\",\n \"type\": \"Container\",\n \"createdAt\": \"2024-12-03T19:42:40.000Z\",\n \"updatedAt\": \"2024-12-03T22:42:40.000Z\",\n \"author\": {\n \"id\": 6,\n \"name\": \"User devuserfactory1 1\",\n \"username\": \"devuserfactory1\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"state\": \"running\",\n \"archived\": false\n },\n {\n \"id\": 25,\n \"name\": \"Script #25\",\n \"type\": \"Container\",\n \"createdAt\": \"2024-12-03T19:42:42.000Z\",\n \"updatedAt\": \"2024-12-03T21:42:41.000Z\",\n \"author\": {\n \"id\": 6,\n \"name\": \"User devuserfactory1 1\",\n \"username\": \"devuserfactory1\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"state\": \"running\",\n \"archived\": false\n },\n {\n \"id\": 37,\n \"name\": \"Script #37\",\n \"type\": \"Container\",\n \"createdAt\": \"2024-12-03T19:42:42.000Z\",\n \"updatedAt\": \"2024-12-03T20:42:42.000Z\",\n \"author\": {\n \"id\": 6,\n \"name\": \"User devuserfactory1 1\",\n \"username\": \"devuserfactory1\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"state\": \"running\",\n \"archived\": false\n },\n {\n \"id\": 1,\n \"name\": \"CASS/NCOA #1\",\n \"type\": \"CASS-NCOA\",\n \"createdAt\": \"2024-12-03T19:42:40.000Z\",\n \"updatedAt\": \"2024-12-03T19:37:39.000Z\",\n \"author\": {\n \"id\": 6,\n \"name\": \"User devuserfactory1 1\",\n \"username\": \"devuserfactory1\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"state\": \"idle\",\n \"archived\": false\n },\n {\n \"id\": 38,\n \"name\": \"CASS/NCOA #38\",\n \"type\": \"CASS-NCOA\",\n \"createdAt\": \"2024-12-03T19:42:43.000Z\",\n \"updatedAt\": \"2024-12-03T19:32:43.000Z\",\n \"author\": {\n \"id\": 43,\n \"name\": \"User devuserfactory32 32\",\n \"username\": \"devuserfactory32\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"state\": \"idle\",\n \"archived\": false\n },\n {\n \"id\": 41,\n \"name\": \"Script #41\",\n \"type\": \"Container\",\n \"createdAt\": \"2024-12-03T19:42:43.000Z\",\n \"updatedAt\": \"2024-12-03T19:27:43.000Z\",\n \"author\": {\n \"id\": 6,\n \"name\": \"User devuserfactory1 1\",\n \"username\": \"devuserfactory1\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"state\": \"idle\",\n \"archived\": false\n },\n {\n \"id\": 43,\n \"name\": \"Geocode #43\",\n \"type\": \"Geocode\",\n \"createdAt\": \"2024-12-03T19:42:43.000Z\",\n \"updatedAt\": \"2024-12-03T19:17:43.000Z\",\n \"author\": {\n \"id\": 6,\n \"name\": \"User devuserfactory1 1\",\n \"username\": \"devuserfactory1\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"state\": \"idle\",\n \"archived\": false\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","X-Pagination-Per-Page":"20","Access-Control-Expose-Headers":"X-Pagination-Per-Page, X-Pagination-Current-Page, X-Pagination-Total-Pages, X-Pagination-Total-Entries","X-Pagination-Current-Page":"1","X-Pagination-Total-Pages":"1","X-Pagination-Total-Entries":"7","Content-Type":"application/json; charset=utf-8","ETag":"W/\"f6dc8cb55897a243b7ebd14ffdec2bd6\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"c10c66b5-0cb9-4b9a-9e13-9f6ac44314b6","X-Runtime":"0.221880","Content-Length":"1893"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/enhancements\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer 2zR0Feo8IVd-UTJFAdH-ZSO0cGdpGg3YDp2R4C2IO70\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Enhancements","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/enhancements","description":"Filter enhancements by author","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/enhancements?author=87","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer mQKQws9vI0uHYQBIGxdH6qIMifui7v2-sk6eaKROYTg","Host":"api.civis.test","Cookie":""},"request_query_parameters":{"author":"87"},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 81,\n \"name\": \"CASS/NCOA #81\",\n \"type\": \"CASS-NCOA\",\n \"createdAt\": \"2024-12-03T19:42:46.000Z\",\n \"updatedAt\": \"2024-12-03T19:32:46.000Z\",\n \"author\": {\n \"id\": 87,\n \"name\": \"User devuserfactory67 67\",\n \"username\": \"devuserfactory67\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"state\": \"idle\",\n \"archived\": false\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","X-Pagination-Per-Page":"20","Access-Control-Expose-Headers":"X-Pagination-Per-Page, X-Pagination-Current-Page, X-Pagination-Total-Pages, X-Pagination-Total-Entries","X-Pagination-Current-Page":"1","X-Pagination-Total-Pages":"1","X-Pagination-Total-Entries":"1","Content-Type":"application/json; charset=utf-8","ETag":"W/\"9cf668135123810f0beab3ea9025849f\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"5dfe18c8-ec99-41d3-8350-ca3be6ec2348","X-Runtime":"0.037015","Content-Length":"276"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/enhancements?author=87\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer mQKQws9vI0uHYQBIGxdH6qIMifui7v2-sk6eaKROYTg\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Enhancements","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/enhancements","description":"Filter enhancements by type","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/enhancements?type=cass_ncoa","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer KaNGN7Yd7Er2LPJOB-2E6K55C7zJ7lBeM-myKqXjuew","Host":"api.civis.test","Cookie":""},"request_query_parameters":{"type":"cass_ncoa"},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 87,\n \"name\": \"CASS/NCOA #87\",\n \"type\": \"CASS-NCOA\",\n \"createdAt\": \"2024-12-03T19:42:47.000Z\",\n \"updatedAt\": \"2024-12-03T19:37:47.000Z\",\n \"author\": {\n \"id\": 94,\n \"name\": \"User devuserfactory71 71\",\n \"username\": \"devuserfactory71\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"state\": \"idle\",\n \"archived\": false\n },\n {\n \"id\": 124,\n \"name\": \"CASS/NCOA #124\",\n \"type\": \"CASS-NCOA\",\n \"createdAt\": \"2024-12-03T19:42:49.000Z\",\n \"updatedAt\": \"2024-12-03T19:32:49.000Z\",\n \"author\": {\n \"id\": 131,\n \"name\": \"User devuserfactory102 102\",\n \"username\": \"devuserfactory102\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"state\": \"idle\",\n \"archived\": false\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","X-Pagination-Per-Page":"20","Access-Control-Expose-Headers":"X-Pagination-Per-Page, X-Pagination-Current-Page, X-Pagination-Total-Pages, X-Pagination-Total-Entries","X-Pagination-Current-Page":"1","X-Pagination-Total-Pages":"1","X-Pagination-Total-Entries":"2","Content-Type":"application/json; charset=utf-8","ETag":"W/\"f5016f9a7916083df3f6b28291458852\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"f11e8f33-d9a9-479d-b790-4e20df564f34","X-Runtime":"0.030261","Content-Length":"557"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/enhancements?type=cass_ncoa\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer KaNGN7Yd7Er2LPJOB-2E6K55C7zJ7lBeM-myKqXjuew\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Enhancements","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/enhancements","description":"Filter enhancements by status","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/enhancements?status=running","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer IAj70RvpfKU5YW6w3hUGmnjo53iwIOZrXPOJ2up05Yk","Host":"api.civis.test","Cookie":""},"request_query_parameters":{"status":"running"},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 142,\n \"name\": \"Script #142\",\n \"type\": \"Container\",\n \"createdAt\": \"2024-12-03T19:42:51.000Z\",\n \"updatedAt\": \"2024-12-03T22:42:51.000Z\",\n \"author\": {\n \"id\": 138,\n \"name\": \"User devuserfactory106 106\",\n \"username\": \"devuserfactory106\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"state\": \"running\",\n \"archived\": false\n },\n {\n \"id\": 154,\n \"name\": \"Script #154\",\n \"type\": \"Container\",\n \"createdAt\": \"2024-12-03T19:42:51.000Z\",\n \"updatedAt\": \"2024-12-03T21:42:51.000Z\",\n \"author\": {\n \"id\": 138,\n \"name\": \"User devuserfactory106 106\",\n \"username\": \"devuserfactory106\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"state\": \"running\",\n \"archived\": false\n },\n {\n \"id\": 166,\n \"name\": \"Script #166\",\n \"type\": \"Container\",\n \"createdAt\": \"2024-12-03T19:42:52.000Z\",\n \"updatedAt\": \"2024-12-03T20:42:52.000Z\",\n \"author\": {\n \"id\": 138,\n \"name\": \"User devuserfactory106 106\",\n \"username\": \"devuserfactory106\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"state\": \"running\",\n \"archived\": false\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","X-Pagination-Per-Page":"20","Access-Control-Expose-Headers":"X-Pagination-Per-Page, X-Pagination-Current-Page, X-Pagination-Total-Pages, X-Pagination-Total-Entries","X-Pagination-Current-Page":"1","X-Pagination-Total-Pages":"1","X-Pagination-Total-Entries":"3","Content-Type":"application/json; charset=utf-8","ETag":"W/\"47e67e9ddc54da400fe77acd0a472f0e\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"938ec466-da3b-434b-8f58-7a1ad755564c","X-Runtime":"0.044192","Content-Length":"844"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/enhancements?status=running\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer IAj70RvpfKU5YW6w3hUGmnjo53iwIOZrXPOJ2up05Yk\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/enhancements/cass-ncoa":{"post":{"summary":"Create a CASS/NCOA Enhancement","description":null,"deprecated":false,"parameters":[{"name":"Object157","in":"body","schema":{"$ref":"#/definitions/Object157"},"required":true}],"responses":{"201":{"description":"success","schema":{"$ref":"#/definitions/Object163"}}},"x-examples":[{"resource":"Enhancements","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/enhancements/cass-ncoa","description":"Create a CASS/NCOA enhancement","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/enhancements/cass-ncoa","request_body":"{\n \"name\": \"My CASS enhancement\",\n \"source\": {\n \"database_table\": {\n \"remote_host_id\": 5,\n \"schema\": \"schema_name\",\n \"table\": \"table_name25\",\n \"credential_id\": 76\n }\n },\n \"notifications\": {\n \"success_email_addresses\": \"test1@civisanalytics.com\",\n \"failure_email_addresses\": \"test2@civisanalytics.com\"\n }\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer 53G8ayfPnX1zFcvOWzJ3zM4ZsuGnGDZPCpQxKtVeIRA","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":201,"response_status_text":"Created","response_body":"{\n \"id\": 434,\n \"name\": \"My CASS enhancement\",\n \"type\": \"CASS-NCOA\",\n \"createdAt\": \"2024-12-03T19:43:13.000Z\",\n \"updatedAt\": \"2024-12-03T19:43:13.000Z\",\n \"author\": {\n \"id\": 407,\n \"name\": \"User devuserfactory328 328\",\n \"username\": \"devuserfactory328\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"state\": \"idle\",\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n },\n \"notifications\": {\n \"urls\": [\n\n ],\n \"successEmailSubject\": null,\n \"successEmailBody\": null,\n \"successEmailAddresses\": [\n \"test1@civisanalytics.com\"\n ],\n \"successEmailFromName\": null,\n \"successEmailReplyTo\": null,\n \"failureEmailAddresses\": [\n \"test2@civisanalytics.com\"\n ],\n \"stallWarningMinutes\": null,\n \"successOn\": true,\n \"failureOn\": true\n },\n \"runningAs\": {\n \"id\": 407,\n \"name\": \"User devuserfactory328 328\",\n \"username\": \"devuserfactory328\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"myPermissionLevel\": \"manage\",\n \"source\": {\n \"databaseTable\": {\n \"schema\": \"schema_name\",\n \"table\": \"table_name25\",\n \"remoteHostId\": 5,\n \"credentialId\": 76,\n \"multipartKey\": [\n \"primary_key\"\n ]\n }\n },\n \"destination\": {\n \"databaseTable\": {\n \"schema\": \"schema_name\",\n \"table\": \"table_name25_output\"\n }\n },\n \"columnMapping\": {\n \"address1\": \"address1\",\n \"address2\": null,\n \"city\": \"city\",\n \"state\": \"state\",\n \"zip\": \"zip\",\n \"name\": \"first_name+last_name\",\n \"company\": \"company\"\n },\n \"useDefaultColumnMapping\": true,\n \"performNcoa\": false,\n \"ncoaCredentialId\": null,\n \"outputLevel\": \"all\",\n \"limitingSQL\": null,\n \"batchSize\": 250000,\n \"archived\": false,\n \"parentId\": null\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"cf14ad3a6fe189b06d7946f20543c2bf\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"e6d2f96c-56af-4ccd-bfbc-9dcd1b1f08d3","X-Runtime":"0.171235","Content-Length":"1405"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/enhancements/cass-ncoa\" -d '{\"name\":\"My CASS enhancement\",\"source\":{\"database_table\":{\"remote_host_id\":5,\"schema\":\"schema_name\",\"table\":\"table_name25\",\"credential_id\":76}},\"notifications\":{\"success_email_addresses\":\"test1@civisanalytics.com\",\"failure_email_addresses\":\"test2@civisanalytics.com\"}}' -X POST \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer 53G8ayfPnX1zFcvOWzJ3zM4ZsuGnGDZPCpQxKtVeIRA\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Enhancements","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/enhancements/cass-ncoa","description":"Create a CASS/NCOA enhancement with custom mapping","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/enhancements/cass-ncoa","request_body":"{\n \"name\": \"My CASS enhancement\",\n \"source\": {\n \"database_table\": {\n \"remote_host_id\": 5,\n \"schema\": \"schema_name\",\n \"table\": \"table_name37\",\n \"credential_id\": 90\n }\n },\n \"use_default_column_mapping\": false,\n \"column_mapping\": {\n \"address1\": \"street_address\",\n \"city\": \"city\",\n \"state\": \"state\",\n \"zip\": \"postal_code\",\n \"name\": \"resident_name\"\n }\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer K11pNGx6Bvp1FBXU-TfFzilCmarbrhJtzw0eN3Ds-xo","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":201,"response_status_text":"Created","response_body":"{\n \"id\": 472,\n \"name\": \"My CASS enhancement\",\n \"type\": \"CASS-NCOA\",\n \"createdAt\": \"2024-12-03T19:43:17.000Z\",\n \"updatedAt\": \"2024-12-03T19:43:17.000Z\",\n \"author\": {\n \"id\": 455,\n \"name\": \"User devuserfactory359 359\",\n \"username\": \"devuserfactory359\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"state\": \"idle\",\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n },\n \"notifications\": {\n \"urls\": [\n\n ],\n \"successEmailSubject\": null,\n \"successEmailBody\": null,\n \"successEmailAddresses\": [\n\n ],\n \"successEmailFromName\": null,\n \"successEmailReplyTo\": null,\n \"failureEmailAddresses\": [\n\n ],\n \"stallWarningMinutes\": null,\n \"successOn\": true,\n \"failureOn\": true\n },\n \"runningAs\": {\n \"id\": 455,\n \"name\": \"User devuserfactory359 359\",\n \"username\": \"devuserfactory359\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"myPermissionLevel\": \"manage\",\n \"source\": {\n \"databaseTable\": {\n \"schema\": \"schema_name\",\n \"table\": \"table_name37\",\n \"remoteHostId\": 5,\n \"credentialId\": 90,\n \"multipartKey\": [\n \"primary_key\"\n ]\n }\n },\n \"destination\": {\n \"databaseTable\": {\n \"schema\": \"schema_name\",\n \"table\": \"table_name37_output\"\n }\n },\n \"columnMapping\": {\n \"address1\": \"street_address\",\n \"address2\": null,\n \"city\": \"city\",\n \"state\": \"state\",\n \"zip\": \"postal_code\",\n \"name\": \"resident_name\",\n \"company\": null\n },\n \"useDefaultColumnMapping\": false,\n \"performNcoa\": false,\n \"ncoaCredentialId\": null,\n \"outputLevel\": \"all\",\n \"limitingSQL\": null,\n \"batchSize\": 250000,\n \"archived\": false,\n \"parentId\": null\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"14d2c0caef08c21163a1a8d52168466a\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"c9ce5823-d9ae-4644-b56e-61b595788383","X-Runtime":"0.160715","Content-Length":"1356"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/enhancements/cass-ncoa\" -d '{\"name\":\"My CASS enhancement\",\"source\":{\"database_table\":{\"remote_host_id\":5,\"schema\":\"schema_name\",\"table\":\"table_name37\",\"credential_id\":90}},\"use_default_column_mapping\":false,\"column_mapping\":{\"address1\":\"street_address\",\"city\":\"city\",\"state\":\"state\",\"zip\":\"postal_code\",\"name\":\"resident_name\"}}' -X POST \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer K11pNGx6Bvp1FBXU-TfFzilCmarbrhJtzw0eN3Ds-xo\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/enhancements/cass-ncoa/{id}":{"get":{"summary":"Get a CASS/NCOA Enhancement","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object163"}}},"x-examples":[{"resource":"Enhancements","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/enhancements/cass-ncoa/:cass_id","description":"View a CASS/NCOA enhancement's details","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/enhancements/cass-ncoa/210","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer kA1hYCC9xWFgQnP-VItnRm_Tje5RXh-lI2giviazLLo","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 210,\n \"name\": \"CASS/NCOA #210\",\n \"type\": \"CASS-NCOA\",\n \"createdAt\": \"2024-12-03T19:42:56.000Z\",\n \"updatedAt\": \"2024-12-03T19:37:56.000Z\",\n \"author\": {\n \"id\": 219,\n \"name\": \"User devuserfactory172 172\",\n \"username\": \"devuserfactory172\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"state\": \"idle\",\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n },\n \"notifications\": {\n \"urls\": [\n\n ],\n \"successEmailSubject\": null,\n \"successEmailBody\": null,\n \"successEmailAddresses\": [\n\n ],\n \"successEmailFromName\": null,\n \"successEmailReplyTo\": null,\n \"failureEmailAddresses\": [\n\n ],\n \"stallWarningMinutes\": null,\n \"successOn\": true,\n \"failureOn\": true\n },\n \"runningAs\": {\n \"id\": 219,\n \"name\": \"User devuserfactory172 172\",\n \"username\": \"devuserfactory172\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"myPermissionLevel\": \"manage\",\n \"source\": {\n \"databaseTable\": {\n \"schema\": \"schema_name\",\n \"table\": \"table_name18\",\n \"remoteHostId\": 5,\n \"credentialId\": 57,\n \"multipartKey\": [\n \"id\",\n \"another_id\"\n ]\n }\n },\n \"destination\": {\n \"databaseTable\": {\n \"schema\": \"my_schema\",\n \"table\": \"my_table\"\n }\n },\n \"columnMapping\": {\n \"address1\": \"address1\",\n \"address2\": \"address2\",\n \"city\": \"city\",\n \"state\": \"state\",\n \"zip\": \"zip\",\n \"name\": \"first_name + last_name\",\n \"company\": null\n },\n \"useDefaultColumnMapping\": false,\n \"performNcoa\": false,\n \"ncoaCredentialId\": 58,\n \"outputLevel\": \"all\",\n \"limitingSQL\": null,\n \"batchSize\": 250000,\n \"archived\": false,\n \"parentId\": null\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"ce5caef5b9691e9440022980332d8800\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"ef239388-9a69-48f3-b01f-e6fb50204f03","X-Runtime":"0.051531","Content-Length":"1341"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/enhancements/cass-ncoa/210\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer kA1hYCC9xWFgQnP-VItnRm_Tje5RXh-lI2giviazLLo\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"put":{"summary":"Replace all attributes of this CASS/NCOA Enhancement","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID for the enhancement.","type":"integer"},{"name":"Object169","in":"body","schema":{"$ref":"#/definitions/Object169"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object163"}}},"x-examples":[{"resource":"Enhancements","resource_explanation":null,"http_method":"PUT","route":"http://api.civis.test/enhancements/cass-ncoa/:cass_id","description":"Update a CASS/NCOA enhancement via PUT","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"PUT","request_path":"http://api.civis.test/enhancements/cass-ncoa/699","request_body":"{\n \"name\": \"standardize my addresses\",\n \"source\": {\n \"database_table\": {\n \"remote_host_id\": 5,\n \"schema\": \"schema_name\",\n \"table\": \"table_name77\",\n \"credential_id\": 144,\n \"multipart_key\": [\n \"primary key\"\n ]\n }\n },\n \"destination\": {\n \"database_table\": {\n \"schema\": \"schema_name\",\n \"table\": \"table_name77_output\"\n }\n },\n \"limiting_sql\": \"where id < 200\"\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer nHs1J4tqDbcyy5kmERaFzh-E3agO2xmgvLdzSFzLXoU","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 699,\n \"name\": \"standardize my addresses\",\n \"type\": \"CASS-NCOA\",\n \"createdAt\": \"2024-12-03T19:43:36.000Z\",\n \"updatedAt\": \"2024-12-03T19:43:39.000Z\",\n \"author\": {\n \"id\": 747,\n \"name\": \"User devuserfactory576 576\",\n \"username\": \"devuserfactory576\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"state\": \"idle\",\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n },\n \"notifications\": {\n \"urls\": [\n\n ],\n \"successEmailSubject\": null,\n \"successEmailBody\": null,\n \"successEmailAddresses\": [\n\n ],\n \"successEmailFromName\": null,\n \"successEmailReplyTo\": null,\n \"failureEmailAddresses\": [\n\n ],\n \"stallWarningMinutes\": null,\n \"successOn\": true,\n \"failureOn\": true\n },\n \"runningAs\": {\n \"id\": 747,\n \"name\": \"User devuserfactory576 576\",\n \"username\": \"devuserfactory576\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"myPermissionLevel\": \"manage\",\n \"source\": {\n \"databaseTable\": {\n \"schema\": \"schema_name\",\n \"table\": \"table_name77\",\n \"remoteHostId\": 5,\n \"credentialId\": 144,\n \"multipartKey\": [\n \"primary_key\"\n ]\n }\n },\n \"destination\": {\n \"databaseTable\": {\n \"schema\": \"schema_name\",\n \"table\": \"table_name77_output\"\n }\n },\n \"columnMapping\": {\n \"address1\": \"address1\",\n \"address2\": null,\n \"city\": \"city\",\n \"state\": \"state\",\n \"zip\": \"zip\",\n \"name\": \"first_name+last_name\",\n \"company\": \"company\"\n },\n \"useDefaultColumnMapping\": true,\n \"performNcoa\": false,\n \"ncoaCredentialId\": null,\n \"outputLevel\": \"all\",\n \"limitingSQL\": \"where id < 200\",\n \"batchSize\": 250000,\n \"archived\": false,\n \"parentId\": null\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"c3956a5d7a569aa88d01f800c14dedb4\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"02b58a26-965f-4bc8-81db-1badded8399a","X-Runtime":"0.212420","Content-Length":"1376"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/enhancements/cass-ncoa/699\" -d '{\"name\":\"standardize my addresses\",\"source\":{\"database_table\":{\"remote_host_id\":5,\"schema\":\"schema_name\",\"table\":\"table_name77\",\"credential_id\":144,\"multipart_key\":[\"primary key\"]}},\"destination\":{\"database_table\":{\"schema\":\"schema_name\",\"table\":\"table_name77_output\"}},\"limiting_sql\":\"where id \\u003c 200\"}' -X PUT \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer nHs1J4tqDbcyy5kmERaFzh-E3agO2xmgvLdzSFzLXoU\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"patch":{"summary":"Update some attributes of this CASS/NCOA Enhancement","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID for the enhancement.","type":"integer"},{"name":"Object170","in":"body","schema":{"$ref":"#/definitions/Object170"},"required":false}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object163"}}},"x-examples":[{"resource":"Enhancements","resource_explanation":null,"http_method":"PATCH","route":"http://api.civis.test/enhancements/cass-ncoa/:cass_id","description":"Update a CASS/NCOA enhancement via PATCH","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"PATCH","request_path":"http://api.civis.test/enhancements/cass-ncoa/625","request_body":"{\n \"name\": \"Clean Addresses\",\n \"output_level\": \"cass\",\n \"limiting_sql\": \"where id < 300\",\n \"schedule\": {\n \"scheduled\": true,\n \"scheduledDays\": [\n 3\n ],\n \"scheduledHours\": [\n 4,\n 8\n ],\n \"scheduledMinutes\": [\n 30\n ],\n \"scheduledRunsPerHour\": null\n }\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer Fdya1EgPcBdaIUBtxM-gdkMZ9Cif_iZ88-tURR7uIfU","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 625,\n \"name\": \"Clean Addresses\",\n \"type\": \"CASS-NCOA\",\n \"createdAt\": \"2024-12-03T19:43:28.000Z\",\n \"updatedAt\": \"2024-12-03T19:43:31.000Z\",\n \"author\": {\n \"id\": 651,\n \"name\": \"User devuserfactory514 514\",\n \"username\": \"devuserfactory514\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"state\": \"scheduled\",\n \"schedule\": {\n \"scheduled\": true,\n \"scheduledDays\": [\n 3\n ],\n \"scheduledHours\": [\n 4,\n 8\n ],\n \"scheduledMinutes\": [\n 30\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n },\n \"notifications\": {\n \"urls\": [\n\n ],\n \"successEmailSubject\": null,\n \"successEmailBody\": null,\n \"successEmailAddresses\": [\n\n ],\n \"successEmailFromName\": null,\n \"successEmailReplyTo\": null,\n \"failureEmailAddresses\": [\n\n ],\n \"stallWarningMinutes\": null,\n \"successOn\": true,\n \"failureOn\": true\n },\n \"runningAs\": {\n \"id\": 651,\n \"name\": \"User devuserfactory514 514\",\n \"username\": \"devuserfactory514\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"myPermissionLevel\": \"manage\",\n \"source\": {\n \"databaseTable\": {\n \"schema\": \"schema_name\",\n \"table\": \"table_name53\",\n \"remoteHostId\": 5,\n \"credentialId\": 116,\n \"multipartKey\": [\n \"id\",\n \"another_id\"\n ]\n }\n },\n \"destination\": {\n \"databaseTable\": {\n \"schema\": \"my_schema\",\n \"table\": \"my_table\"\n }\n },\n \"columnMapping\": {\n \"address1\": \"address1\",\n \"address2\": \"address2\",\n \"city\": \"city\",\n \"state\": \"state\",\n \"zip\": \"zip\",\n \"name\": \"first_name + last_name\",\n \"company\": null\n },\n \"useDefaultColumnMapping\": false,\n \"performNcoa\": false,\n \"ncoaCredentialId\": 117,\n \"outputLevel\": \"cass\",\n \"limitingSQL\": \"where id < 300\",\n \"batchSize\": 250000,\n \"archived\": false,\n \"parentId\": null\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"bfbfa01074f249a690be984b89ebb87c\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"da0908db-74c0-44cd-bb2d-b33521a0014d","X-Runtime":"0.194891","Content-Length":"1373"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/enhancements/cass-ncoa/625\" -d '{\"name\":\"Clean Addresses\",\"output_level\":\"cass\",\"limiting_sql\":\"where id \\u003c 300\",\"schedule\":{\"scheduled\":true,\"scheduledDays\":[3],\"scheduledHours\":[4,8],\"scheduledMinutes\":[30],\"scheduledRunsPerHour\":null}}' -X PATCH \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer Fdya1EgPcBdaIUBtxM-gdkMZ9Cif_iZ88-tURR7uIfU\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Enhancements","resource_explanation":null,"http_method":"PATCH","route":"http://api.civis.test/enhancements/cass-ncoa/:cass_id","description":"Update the column mapping of a CASS/NCOA enhancement via PATCH","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"PATCH","request_path":"http://api.civis.test/enhancements/cass-ncoa/662","request_body":"{\n \"use_default_column_mapping\": false,\n \"column_mapping\": {\n \"address1\": \"street_address\",\n \"city\": \"city\",\n \"state\": \"state\",\n \"zip\": \"postal_code\"\n }\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer l6mfY_xIEJUOZycGaET8MD6Ms491UKwUCM1uNcrKpM8","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 662,\n \"name\": \"CASS/NCOA #662\",\n \"type\": \"CASS-NCOA\",\n \"createdAt\": \"2024-12-03T19:43:32.000Z\",\n \"updatedAt\": \"2024-12-03T19:43:36.000Z\",\n \"author\": {\n \"id\": 699,\n \"name\": \"User devuserfactory545 545\",\n \"username\": \"devuserfactory545\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"state\": \"idle\",\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n },\n \"notifications\": {\n \"urls\": [\n\n ],\n \"successEmailSubject\": null,\n \"successEmailBody\": null,\n \"successEmailAddresses\": [\n\n ],\n \"successEmailFromName\": null,\n \"successEmailReplyTo\": null,\n \"failureEmailAddresses\": [\n\n ],\n \"stallWarningMinutes\": null,\n \"successOn\": true,\n \"failureOn\": true\n },\n \"runningAs\": {\n \"id\": 699,\n \"name\": \"User devuserfactory545 545\",\n \"username\": \"devuserfactory545\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"myPermissionLevel\": \"manage\",\n \"source\": {\n \"databaseTable\": {\n \"schema\": \"schema_name\",\n \"table\": \"table_name65\",\n \"remoteHostId\": 5,\n \"credentialId\": 130,\n \"multipartKey\": [\n \"id\",\n \"another_id\"\n ]\n }\n },\n \"destination\": {\n \"databaseTable\": {\n \"schema\": \"my_schema\",\n \"table\": \"my_table\"\n }\n },\n \"columnMapping\": {\n \"address1\": \"street_address\",\n \"address2\": null,\n \"city\": \"city\",\n \"state\": \"state\",\n \"zip\": \"postal_code\",\n \"name\": null,\n \"company\": null\n },\n \"useDefaultColumnMapping\": false,\n \"performNcoa\": false,\n \"ncoaCredentialId\": 131,\n \"outputLevel\": \"all\",\n \"limitingSQL\": null,\n \"batchSize\": 250000,\n \"archived\": false,\n \"parentId\": null\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"81b8a8e74d456cc5620aca69938249e1\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"8b818438-fdef-457d-9971-f2eb2dc9807f","X-Runtime":"0.160451","Content-Length":"1331"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/enhancements/cass-ncoa/662\" -d '{\"use_default_column_mapping\":false,\"column_mapping\":{\"address1\":\"street_address\",\"city\":\"city\",\"state\":\"state\",\"zip\":\"postal_code\"}}' -X PATCH \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer l6mfY_xIEJUOZycGaET8MD6Ms491UKwUCM1uNcrKpM8\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/enhancements/cass-ncoa/{id}/runs":{"post":{"summary":"Start a run","description":"Start a run and provide a URI for checking its status. The response will provide a 'Location' header which will contain a URI which may be polled to monitor the status of the run.","deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the CASS NCOA job.","type":"integer"}],"responses":{"202":{"description":"success","schema":{"$ref":"#/definitions/Object171"}}},"x-examples":[{"resource":"Enhancements","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/enhancements/cass-ncoa/:cass_ncoa_to_run_id/runs","description":"Create a CASS/NCOA run","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/enhancements/cass-ncoa/999/runs","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer fsB9hYQjujK53F31Mnw4kl__Tl6R1wnByL3ICLQMquA","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":202,"response_status_text":"Accepted","response_body":"{\n \"id\": 79,\n \"cassNcoaId\": 999,\n \"state\": \"queued\",\n \"isCancelRequested\": false,\n \"createdAt\": \"2024-12-03T19:43:59.000Z\",\n \"startedAt\": null,\n \"finishedAt\": null,\n \"error\": null\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Location":"http://api.civis.test/enhancements/cass-ncoa/999/runs/79","Content-Type":"application/json; charset=utf-8","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"f6141331-37cf-46c2-920c-ddd70c151626","X-Runtime":"0.160939","Content-Length":"156"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/enhancements/cass-ncoa/999/runs\" -d '' -X POST \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer fsB9hYQjujK53F31Mnw4kl__Tl6R1wnByL3ICLQMquA\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"get":{"summary":"List runs for the given CASS NCOA job","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the CASS NCOA job.","type":"integer"},{"name":"limit","in":"query","required":false,"description":"Number of results to return. Defaults to 20. Maximum allowed is 100.","type":"integer"},{"name":"page_num","in":"query","required":false,"description":"Page number of the results to return. Defaults to the first page, 1.","type":"integer"},{"name":"order","in":"query","required":false,"description":"The field on which to order the result set. Defaults to id. Must be one of: id.","type":"string"},{"name":"order_dir","in":"query","required":false,"description":"Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc.","type":"string"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object171"}}}},"x-examples":null,"x-deprecation-warning":null}},"/enhancements/cass-ncoa/{id}/runs/{run_id}":{"get":{"summary":"Check status of a run","description":"View the status of a run. This endpoint may be polled to monitor the status of the run. When the 'state' field is no longer 'queued' or 'running' the run has reached its final state.","deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the CASS NCOA job.","type":"integer"},{"name":"run_id","in":"path","required":true,"description":"The ID of the run.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object171"}}},"x-examples":[{"resource":"Enhancements","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/enhancements/cass-ncoa/:cass_id/runs/:cass_run_id","description":"View a CASS/NCOA enhancement's run details","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/enhancements/cass-ncoa/1000/runs/83","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer txrRIZ5b8db8GiI3vsyPoIkbujTaK61r2K1Kkp8TY3U","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 83,\n \"cassNcoaId\": 1000,\n \"state\": \"running\",\n \"isCancelRequested\": false,\n \"createdAt\": \"2024-12-03T19:44:03.000Z\",\n \"startedAt\": null,\n \"finishedAt\": \"2024-12-03T19:39:03.000Z\",\n \"error\": null\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"9f120e487823eca5ca12c774b75e9a77\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"a4488959-0c25-4552-9a89-5eab6c2993aa","X-Runtime":"0.050748","Content-Length":"180"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/enhancements/cass-ncoa/1000/runs/83\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer txrRIZ5b8db8GiI3vsyPoIkbujTaK61r2K1Kkp8TY3U\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"delete":{"summary":"Cancel a run","description":"Cancel a currently active run.","deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the CASS NCOA job.","type":"integer"},{"name":"run_id","in":"path","required":true,"description":"The ID of the run.","type":"integer"}],"responses":{"202":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/enhancements/cass-ncoa/{id}/runs/{run_id}/logs":{"get":{"summary":"Get the logs for a run","description":"Get the logs for a run.","deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the CASS NCOA job.","type":"integer"},{"name":"run_id","in":"path","required":true,"description":"The ID of the run.","type":"integer"},{"name":"last_id","in":"query","required":false,"description":"The ID of the last log message received. Log entries with this ID value or lower will be omitted.Logs are sorted by ID if this value is provided, and are otherwise sorted by createdAt.","type":"integer"},{"name":"limit","in":"query","required":false,"description":"The maximum number of log messages to return. Default of 10000.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object116"}}}},"x-examples":null,"x-deprecation-warning":null}},"/enhancements/cass-ncoa/{id}/cancel":{"post":{"summary":"Cancel a run","description":"Cancel a run.","deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the job.","type":"integer"}],"responses":{"202":{"description":"success","schema":{"$ref":"#/definitions/Object172"}}},"x-examples":null,"x-deprecation-warning":null}},"/enhancements/cass-ncoa/{id}/runs/{run_id}/outputs":{"get":{"summary":"List the outputs for a run","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the job.","type":"integer"},{"name":"run_id","in":"path","required":true,"description":"The ID of the run.","type":"integer"},{"name":"limit","in":"query","required":false,"description":"Number of results to return. Defaults to its maximum of 50.","type":"integer"},{"name":"page_num","in":"query","required":false,"description":"Page number of the results to return. Defaults to the first page, 1.","type":"integer"},{"name":"order","in":"query","required":false,"description":"The field on which to order the result set. Defaults to created_at. Must be one of: created_at, id.","type":"string"},{"name":"order_dir","in":"query","required":false,"description":"Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc.","type":"string"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object173"}}}},"x-examples":[{"resource":"Enhancements","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/enhancements/cass-ncoa/:job_with_run_id/runs/:job_run_id/outputs","description":"View a CASS/NCOA Enhancement's outputs","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/enhancements/cass-ncoa/1074/runs/87/outputs","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer UPBEsqQvI477lK-x_bmfKYP2vbD1EjD6huz_7bnnszY","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"objectType\": \"File\",\n \"objectId\": 2,\n \"name\": \"my output file\",\n \"link\": \"api.civis.test/files/2\",\n \"value\": null\n },\n {\n \"objectType\": \"Report\",\n \"objectId\": 1,\n \"name\": \"my output report\",\n \"link\": \"api.civis.test/reports/1\",\n \"value\": null\n },\n {\n \"objectType\": \"Report\",\n \"objectId\": 2,\n \"name\": \"my output tableau report\",\n \"link\": \"api.civis.test/reports/2\",\n \"value\": null\n },\n {\n \"objectType\": \"Table\",\n \"objectId\": 97,\n \"name\": \"output.table\",\n \"link\": \"api.civis.test/tables/97\",\n \"value\": null\n },\n {\n \"objectType\": \"Project\",\n \"objectId\": 1,\n \"name\": \"my output project\",\n \"link\": \"api.civis.test/projects/1\",\n \"value\": null\n },\n {\n \"objectType\": \"Credential\",\n \"objectId\": 203,\n \"name\": \"my output credential\",\n \"link\": \"api.civis.test/credentials/203\",\n \"value\": null\n },\n {\n \"objectType\": \"JSONValue\",\n \"objectId\": 1,\n \"name\": \"my awesome JSON value\",\n \"link\": \"api.civis.test/json_values/1\",\n \"value\": {\n \"foo\": \"bar\"\n }\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","X-Pagination-Per-Page":"50","Access-Control-Expose-Headers":"X-Pagination-Per-Page, X-Pagination-Current-Page, X-Pagination-Total-Pages, X-Pagination-Total-Entries","X-Pagination-Current-Page":"1","X-Pagination-Total-Pages":"1","X-Pagination-Total-Entries":"7","Content-Type":"application/json; charset=utf-8","ETag":"W/\"9ebfeccd30f12016061f0f3bb4e4f181\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"79e79167-c0c0-474a-b4bc-be16ee02839d","X-Runtime":"0.073063","Content-Length":"809"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/enhancements/cass-ncoa/1074/runs/87/outputs\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer UPBEsqQvI477lK-x_bmfKYP2vbD1EjD6huz_7bnnszY\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/enhancements/geocode":{"post":{"summary":"Create a Geocode Enhancement","description":null,"deprecated":false,"parameters":[{"name":"Object174","in":"body","schema":{"$ref":"#/definitions/Object174"},"required":true}],"responses":{"201":{"description":"success","schema":{"$ref":"#/definitions/Object175"}}},"x-examples":[{"resource":"Enhancements","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/enhancements/geocode","description":"Create a geocode enhancement","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/enhancements/geocode","request_body":"{\n \"name\": \"Geocoderific\",\n \"remoteHostId\": 5,\n \"credentialId\": 104,\n \"sourceSchemaAndTable\": \"schema_name.table_name49\",\n \"country\": \"us\",\n \"multipartKey\": \"MyString\"\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer 8xGc_GQWOziUEtFoYYnA5zZE42xEaSXDicpIy-7mwwQ","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":201,"response_status_text":"Created","response_body":"{\n \"id\": 510,\n \"name\": \"Geocoderific\",\n \"type\": \"Geocode\",\n \"createdAt\": \"2024-12-03T19:43:20.000Z\",\n \"updatedAt\": \"2024-12-03T19:43:20.000Z\",\n \"author\": {\n \"id\": 503,\n \"name\": \"User devuserfactory390 390\",\n \"username\": \"devuserfactory390\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"state\": \"idle\",\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n },\n \"notifications\": {\n \"urls\": [\n\n ],\n \"successEmailSubject\": null,\n \"successEmailBody\": null,\n \"successEmailAddresses\": [\n\n ],\n \"successEmailFromName\": null,\n \"successEmailReplyTo\": null,\n \"failureEmailAddresses\": [\n\n ],\n \"stallWarningMinutes\": null,\n \"successOn\": true,\n \"failureOn\": true\n },\n \"runningAs\": {\n \"id\": 503,\n \"name\": \"User devuserfactory390 390\",\n \"username\": \"devuserfactory390\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"myPermissionLevel\": \"manage\",\n \"remoteHostId\": 5,\n \"credentialId\": 104,\n \"sourceSchemaAndTable\": \"schema_name.table_name49\",\n \"multipartKey\": [\n \"MyString\"\n ],\n \"limitingSQL\": null,\n \"targetSchema\": null,\n \"targetTable\": null,\n \"country\": \"us\",\n \"provider\": null,\n \"outputAddress\": null,\n \"archived\": false,\n \"parentId\": null\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"929d7060fbd3ef7b09c79ad0b79b743c\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"0f59d5f4-3191-47da-9514-44404cb327f3","X-Runtime":"0.134683","Content-Length":"1059"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/enhancements/geocode\" -d '{\"name\":\"Geocoderific\",\"remoteHostId\":5,\"credentialId\":104,\"sourceSchemaAndTable\":\"schema_name.table_name49\",\"country\":\"us\",\"multipartKey\":\"MyString\"}' -X POST \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer 8xGc_GQWOziUEtFoYYnA5zZE42xEaSXDicpIy-7mwwQ\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/enhancements/geocode/{id}":{"get":{"summary":"Get a Geocode Enhancement","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object175"}}},"x-examples":[{"resource":"Enhancements","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/enhancements/geocode/:geocode_id","description":"View a Geocode enhancement's details","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/enhancements/geocode/285","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer r70DRHM04NGfPLENsiNmJ0JfljS6RwwHL2c-PsRxqEI","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 285,\n \"name\": \"Geocode #285\",\n \"type\": \"Geocode\",\n \"createdAt\": \"2024-12-03T19:43:01.000Z\",\n \"updatedAt\": \"2024-12-03T19:41:01.000Z\",\n \"author\": {\n \"id\": 256,\n \"name\": \"User devuserfactory203 203\",\n \"username\": \"devuserfactory203\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"state\": \"idle\",\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n },\n \"notifications\": {\n \"urls\": [\n\n ],\n \"successEmailSubject\": null,\n \"successEmailBody\": null,\n \"successEmailAddresses\": [\n\n ],\n \"successEmailFromName\": null,\n \"successEmailReplyTo\": null,\n \"failureEmailAddresses\": [\n\n ],\n \"stallWarningMinutes\": null,\n \"successOn\": true,\n \"failureOn\": true\n },\n \"runningAs\": {\n \"id\": 256,\n \"name\": \"User devuserfactory203 203\",\n \"username\": \"devuserfactory203\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"myPermissionLevel\": \"manage\",\n \"remoteHostId\": 32,\n \"credentialId\": 63,\n \"sourceSchemaAndTable\": \"schema_name.table_name21\",\n \"multipartKey\": [\n \"id\",\n \"another_id\"\n ],\n \"limitingSQL\": null,\n \"targetSchema\": \"\",\n \"targetTable\": \"\",\n \"country\": \"us\",\n \"provider\": null,\n \"outputAddress\": false,\n \"archived\": false,\n \"parentId\": null\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"1773b94adb3919f27df26362ee30e5a3\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"14b767a6-6a91-46d5-8dbe-e6e28b4e325e","X-Runtime":"0.045015","Content-Length":"1063"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/enhancements/geocode/285\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer r70DRHM04NGfPLENsiNmJ0JfljS6RwwHL2c-PsRxqEI\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"put":{"summary":"Replace all attributes of this Geocode Enhancement","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID for the enhancement.","type":"integer"},{"name":"Object176","in":"body","schema":{"$ref":"#/definitions/Object176"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object175"}}},"x-examples":null,"x-deprecation-warning":null},"patch":{"summary":"Update some attributes of this Geocode Enhancement","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID for the enhancement.","type":"integer"},{"name":"Object177","in":"body","schema":{"$ref":"#/definitions/Object177"},"required":false}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object175"}}},"x-examples":[{"resource":"Enhancements","resource_explanation":null,"http_method":"PATCH","route":"http://api.civis.test/enhancements/geocode/:geocode_id","description":"Update a Geocode enhancement via PATCH","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"PATCH","request_path":"http://api.civis.test/enhancements/geocode/774","request_body":"{\n \"name\": \"Zeno's endless geocoding job\",\n \"country\": \"ca\",\n \"multipartKey\": [\n \"MyString\"\n ],\n \"limiting_sql\": \"WHERE distance_travelled = 0\",\n \"targetSchema\": \"bow\",\n \"targetTable\": \"arrow\",\n \"outputAddress\": true\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer 2kd5BnYwXsQgEJZu1fo2BhWD0Q0uj3Vl-tavKonHt0c","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 774,\n \"name\": \"Zeno's endless geocoding job\",\n \"type\": \"Geocode\",\n \"createdAt\": \"2024-12-03T19:43:42.000Z\",\n \"updatedAt\": \"2024-12-03T19:43:42.000Z\",\n \"author\": {\n \"id\": 795,\n \"name\": \"User devuserfactory607 607\",\n \"username\": \"devuserfactory607\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"state\": \"idle\",\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n },\n \"notifications\": {\n \"urls\": [\n\n ],\n \"successEmailSubject\": null,\n \"successEmailBody\": null,\n \"successEmailAddresses\": [\n\n ],\n \"successEmailFromName\": null,\n \"successEmailReplyTo\": null,\n \"failureEmailAddresses\": [\n\n ],\n \"stallWarningMinutes\": null,\n \"successOn\": true,\n \"failureOn\": true\n },\n \"runningAs\": {\n \"id\": 795,\n \"name\": \"User devuserfactory607 607\",\n \"username\": \"devuserfactory607\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"myPermissionLevel\": \"manage\",\n \"remoteHostId\": 90,\n \"credentialId\": 161,\n \"sourceSchemaAndTable\": \"schema_name.table_name91\",\n \"multipartKey\": [\n \"MyString\"\n ],\n \"limitingSQL\": \"WHERE distance_travelled = 0\",\n \"targetSchema\": \"bow\",\n \"targetTable\": \"arrow\",\n \"country\": \"ca\",\n \"provider\": null,\n \"outputAddress\": true,\n \"archived\": false,\n \"parentId\": null\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"f3d5439a04d06087eb298a2009a95e08\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"96dd33b6-1e12-423f-b991-e6a0a3dd894a","X-Runtime":"0.119309","Content-Length":"1106"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/enhancements/geocode/774\" -d '{\"name\":\"Zeno\\u0027s endless geocoding job\",\"country\":\"ca\",\"multipartKey\":[\"MyString\"],\"limiting_sql\":\"WHERE distance_travelled = 0\",\"targetSchema\":\"bow\",\"targetTable\":\"arrow\",\"outputAddress\":true}' -X PATCH \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer 2kd5BnYwXsQgEJZu1fo2BhWD0Q0uj3Vl-tavKonHt0c\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Enhancements","resource_explanation":null,"http_method":"PATCH","route":"http://api.civis.test/enhancements/geocode/:geocode_id","description":"Update a Geocode enhancement via PUT","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"PATCH","request_path":"http://api.civis.test/enhancements/geocode/813","request_body":"{\n \"name\": \"Zebracoder\",\n \"remoteHostId\": 5,\n \"credentialId\": 165,\n \"sourceSchemaAndTable\": \"schema_name.table_name92\",\n \"country\": \"ca\",\n \"multipartKey\": [\n \"MyString\"\n ],\n \"limiting_sql\": \"where id < 200\",\n \"targetSchema\": \"human\",\n \"targetTable\": \"friendship\",\n \"outputAddress\": true\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer I3ZAOcw5rMF1gUp-i7Z24lmmxcV7cRcXq01CBoGgzSI","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 813,\n \"name\": \"Zebracoder\",\n \"type\": \"Geocode\",\n \"createdAt\": \"2024-12-03T19:43:45.000Z\",\n \"updatedAt\": \"2024-12-03T19:43:45.000Z\",\n \"author\": {\n \"id\": 835,\n \"name\": \"User devuserfactory639 639\",\n \"username\": \"devuserfactory639\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"state\": \"idle\",\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n },\n \"notifications\": {\n \"urls\": [\n\n ],\n \"successEmailSubject\": null,\n \"successEmailBody\": null,\n \"successEmailAddresses\": [\n\n ],\n \"successEmailFromName\": null,\n \"successEmailReplyTo\": null,\n \"failureEmailAddresses\": [\n\n ],\n \"stallWarningMinutes\": null,\n \"successOn\": true,\n \"failureOn\": true\n },\n \"runningAs\": {\n \"id\": 835,\n \"name\": \"User devuserfactory639 639\",\n \"username\": \"devuserfactory639\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"myPermissionLevel\": \"manage\",\n \"remoteHostId\": 5,\n \"credentialId\": 165,\n \"sourceSchemaAndTable\": \"schema_name.table_name92\",\n \"multipartKey\": [\n \"MyString\"\n ],\n \"limitingSQL\": \"where id < 200\",\n \"targetSchema\": \"human\",\n \"targetTable\": \"friendship\",\n \"country\": \"ca\",\n \"provider\": null,\n \"outputAddress\": true,\n \"archived\": false,\n \"parentId\": null\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"a0f7c24f06e9d310f803458e6e59a43a\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"96bf1352-4b2a-495b-842a-6f72080c71e1","X-Runtime":"0.224569","Content-Length":"1085"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/enhancements/geocode/813\" -d '{\"name\":\"Zebracoder\",\"remoteHostId\":5,\"credentialId\":165,\"sourceSchemaAndTable\":\"schema_name.table_name92\",\"country\":\"ca\",\"multipartKey\":[\"MyString\"],\"limiting_sql\":\"where id \\u003c 200\",\"targetSchema\":\"human\",\"targetTable\":\"friendship\",\"outputAddress\":true}' -X PATCH \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer I3ZAOcw5rMF1gUp-i7Z24lmmxcV7cRcXq01CBoGgzSI\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/enhancements/geocode/{id}/runs":{"post":{"summary":"Start a run","description":"Start a run and provide a URI for checking its status. The response will provide a 'Location' header which will contain a URI which may be polled to monitor the status of the run.","deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Geocode job.","type":"integer"}],"responses":{"202":{"description":"success","schema":{"$ref":"#/definitions/Object178"}}},"x-examples":[{"resource":"Enhancements","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/enhancements/geocode/:geocode_to_run_id/runs","description":"Create a Geocode run","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/enhancements/geocode/1115/runs","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer DyfbyKxoNHJuLxckAWWkMlClnQ9cnisqa9mkXZcN64c","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":202,"response_status_text":"Accepted","response_body":"{\n \"id\": 91,\n \"geocodeId\": 1115,\n \"state\": \"queued\",\n \"isCancelRequested\": false,\n \"createdAt\": \"2024-12-03T19:44:09.000Z\",\n \"startedAt\": null,\n \"finishedAt\": null,\n \"error\": null\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Location":"http://api.civis.test/enhancements/geocode/1115/runs/91","Content-Type":"application/json; charset=utf-8","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"11c72b75-a0f6-4b18-8317-97cedfc15a7e","X-Runtime":"0.148813","Content-Length":"156"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/enhancements/geocode/1115/runs\" -d '' -X POST \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer DyfbyKxoNHJuLxckAWWkMlClnQ9cnisqa9mkXZcN64c\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"get":{"summary":"List runs for the given Geocode job","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Geocode job.","type":"integer"},{"name":"limit","in":"query","required":false,"description":"Number of results to return. Defaults to 20. Maximum allowed is 100.","type":"integer"},{"name":"page_num","in":"query","required":false,"description":"Page number of the results to return. Defaults to the first page, 1.","type":"integer"},{"name":"order","in":"query","required":false,"description":"The field on which to order the result set. Defaults to id. Must be one of: id.","type":"string"},{"name":"order_dir","in":"query","required":false,"description":"Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc.","type":"string"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object178"}}}},"x-examples":null,"x-deprecation-warning":null}},"/enhancements/geocode/{id}/runs/{run_id}":{"get":{"summary":"Check status of a run","description":"View the status of a run. This endpoint may be polled to monitor the status of the run. When the 'state' field is no longer 'queued' or 'running' the run has reached its final state.","deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Geocode job.","type":"integer"},{"name":"run_id","in":"path","required":true,"description":"The ID of the run.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object178"}}},"x-examples":[{"resource":"Enhancements","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/enhancements/geocode/:geocode_id/runs/:geocode_run_id","description":"View a Geocode enhancement's run details","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/enhancements/geocode/1154/runs/95","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer JdKKHxx-_unVidrmTzXXwhAu31S5GR-1DCNnLsRo2cc","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 95,\n \"geocodeId\": 1154,\n \"state\": \"running\",\n \"isCancelRequested\": false,\n \"createdAt\": \"2024-12-03T19:44:12.000Z\",\n \"startedAt\": null,\n \"finishedAt\": \"2024-12-03T19:42:12.000Z\",\n \"error\": null\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"758da940788d7d4683611cab6f93fbf4\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"7ad1d5c3-df64-4b7b-aca2-c6ba34be9072","X-Runtime":"0.031477","Content-Length":"179"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/enhancements/geocode/1154/runs/95\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer JdKKHxx-_unVidrmTzXXwhAu31S5GR-1DCNnLsRo2cc\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"delete":{"summary":"Cancel a run","description":"Cancel a currently active run.","deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Geocode job.","type":"integer"},{"name":"run_id","in":"path","required":true,"description":"The ID of the run.","type":"integer"}],"responses":{"202":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/enhancements/geocode/{id}/runs/{run_id}/logs":{"get":{"summary":"Get the logs for a run","description":"Get the logs for a run.","deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Geocode job.","type":"integer"},{"name":"run_id","in":"path","required":true,"description":"The ID of the run.","type":"integer"},{"name":"last_id","in":"query","required":false,"description":"The ID of the last log message received. Log entries with this ID value or lower will be omitted.Logs are sorted by ID if this value is provided, and are otherwise sorted by createdAt.","type":"integer"},{"name":"limit","in":"query","required":false,"description":"The maximum number of log messages to return. Default of 10000.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object116"}}}},"x-examples":null,"x-deprecation-warning":null}},"/enhancements/geocode/{id}/cancel":{"post":{"summary":"Cancel a run","description":"Cancel a run.","deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the job.","type":"integer"}],"responses":{"202":{"description":"success","schema":{"$ref":"#/definitions/Object179"}}},"x-examples":null,"x-deprecation-warning":null}},"/enhancements/geocode/{id}/runs/{run_id}/outputs":{"get":{"summary":"List the outputs for a run","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the job.","type":"integer"},{"name":"run_id","in":"path","required":true,"description":"The ID of the run.","type":"integer"},{"name":"limit","in":"query","required":false,"description":"Number of results to return. Defaults to its maximum of 50.","type":"integer"},{"name":"page_num","in":"query","required":false,"description":"Page number of the results to return. Defaults to the first page, 1.","type":"integer"},{"name":"order","in":"query","required":false,"description":"The field on which to order the result set. Defaults to created_at. Must be one of: created_at, id.","type":"string"},{"name":"order_dir","in":"query","required":false,"description":"Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc.","type":"string"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object180"}}}},"x-examples":[{"resource":"Enhancements","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/enhancements/geocode/:job_with_run_id/runs/:job_run_id/outputs","description":"View a Geocode Enhancement's outputs","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/enhancements/geocode/1193/runs/99/outputs","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer CKYjGJWdG6Xfrut1mR5rjk-VkyKsDdkzPyrqwSGh5zs","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"objectType\": \"File\",\n \"objectId\": 6,\n \"name\": \"my output file\",\n \"link\": \"api.civis.test/files/6\",\n \"value\": null\n },\n {\n \"objectType\": \"Report\",\n \"objectId\": 3,\n \"name\": \"my output report\",\n \"link\": \"api.civis.test/reports/3\",\n \"value\": null\n },\n {\n \"objectType\": \"Report\",\n \"objectId\": 4,\n \"name\": \"my output tableau report\",\n \"link\": \"api.civis.test/reports/4\",\n \"value\": null\n },\n {\n \"objectType\": \"Table\",\n \"objectId\": 104,\n \"name\": \"output.table\",\n \"link\": \"api.civis.test/tables/104\",\n \"value\": null\n },\n {\n \"objectType\": \"Project\",\n \"objectId\": 2,\n \"name\": \"my output project\",\n \"link\": \"api.civis.test/projects/2\",\n \"value\": null\n },\n {\n \"objectType\": \"Credential\",\n \"objectId\": 228,\n \"name\": \"my output credential\",\n \"link\": \"api.civis.test/credentials/228\",\n \"value\": null\n },\n {\n \"objectType\": \"JSONValue\",\n \"objectId\": 2,\n \"name\": \"my awesome JSON value\",\n \"link\": \"api.civis.test/json_values/2\",\n \"value\": {\n \"foo\": \"bar\"\n }\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","X-Pagination-Per-Page":"50","Access-Control-Expose-Headers":"X-Pagination-Per-Page, X-Pagination-Current-Page, X-Pagination-Total-Pages, X-Pagination-Total-Entries","X-Pagination-Current-Page":"1","X-Pagination-Total-Pages":"1","X-Pagination-Total-Entries":"7","Content-Type":"application/json; charset=utf-8","ETag":"W/\"42e6f1d6a6026e742817c9b8bffadfde\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"1163989a-3873-44e5-9bde-6ebf440e9ce0","X-Runtime":"0.074133","Content-Length":"811"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/enhancements/geocode/1193/runs/99/outputs\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer CKYjGJWdG6Xfrut1mR5rjk-VkyKsDdkzPyrqwSGh5zs\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/enhancements/cass-ncoa/{id}/shares":{"get":{"summary":"List users and groups permissioned on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object9"}}}},"x-examples":null,"x-deprecation-warning":null}},"/enhancements/cass-ncoa/{id}/shares/users":{"put":{"summary":"Set the permissions users have on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"Object198","in":"body","schema":{"$ref":"#/definitions/Object198"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object9"}}},"x-examples":null,"x-deprecation-warning":null}},"/enhancements/cass-ncoa/{id}/shares/users/{user_id}":{"delete":{"summary":"Revoke the permissions a user has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"user_id","in":"path","required":true,"description":"The ID of the user.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/enhancements/cass-ncoa/{id}/shares/groups":{"put":{"summary":"Set the permissions groups has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"Object199","in":"body","schema":{"$ref":"#/definitions/Object199"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object9"}}},"x-examples":null,"x-deprecation-warning":null}},"/enhancements/cass-ncoa/{id}/shares/groups/{group_id}":{"delete":{"summary":"Revoke the permissions a group has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"group_id","in":"path","required":true,"description":"The ID of the group.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/enhancements/cass-ncoa/{id}/dependencies":{"get":{"summary":"List dependent objects for this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"user_id","in":"query","required":false,"description":"ID of target user","type":"integer"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object15"}}}},"x-examples":null,"x-deprecation-warning":null}},"/enhancements/cass-ncoa/{id}/transfer":{"put":{"summary":"Transfer ownership of this object to another user","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"Object200","in":"body","schema":{"$ref":"#/definitions/Object200"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object17"}}},"x-examples":null,"x-deprecation-warning":null}},"/enhancements/cass-ncoa/{id}/projects":{"get":{"summary":"List the projects a CASS/NCOA Enhancement belongs to","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the CASS/NCOA Enhancement.","type":"integer"},{"name":"hidden","in":"query","required":false,"description":"If specified to be true, returns hidden items. Defaults to false, returning non-hidden items.","type":"boolean"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object84"}}}},"x-examples":null,"x-deprecation-warning":null}},"/enhancements/cass-ncoa/{id}/projects/{project_id}":{"put":{"summary":"Add a CASS/NCOA Enhancement to a project","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the CASS/NCOA Enhancement.","type":"integer"},{"name":"project_id","in":"path","required":true,"description":"The ID of the project.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null},"delete":{"summary":"Remove a CASS/NCOA Enhancement from a project","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the CASS/NCOA Enhancement.","type":"integer"},{"name":"project_id","in":"path","required":true,"description":"The ID of the project.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/enhancements/cass-ncoa/{id}/archive":{"put":{"summary":"Update the archive status of this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the object.","type":"integer"},{"name":"Object201","in":"body","schema":{"$ref":"#/definitions/Object201"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object163"}}},"x-examples":null,"x-deprecation-warning":null}},"/enhancements/geocode/{id}/shares":{"get":{"summary":"List users and groups permissioned on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object9"}}}},"x-examples":null,"x-deprecation-warning":null}},"/enhancements/geocode/{id}/shares/users":{"put":{"summary":"Set the permissions users have on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"Object202","in":"body","schema":{"$ref":"#/definitions/Object202"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object9"}}},"x-examples":null,"x-deprecation-warning":null}},"/enhancements/geocode/{id}/shares/users/{user_id}":{"delete":{"summary":"Revoke the permissions a user has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"user_id","in":"path","required":true,"description":"The ID of the user.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/enhancements/geocode/{id}/shares/groups":{"put":{"summary":"Set the permissions groups has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"Object203","in":"body","schema":{"$ref":"#/definitions/Object203"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object9"}}},"x-examples":null,"x-deprecation-warning":null}},"/enhancements/geocode/{id}/shares/groups/{group_id}":{"delete":{"summary":"Revoke the permissions a group has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"group_id","in":"path","required":true,"description":"The ID of the group.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/enhancements/geocode/{id}/dependencies":{"get":{"summary":"List dependent objects for this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"user_id","in":"query","required":false,"description":"ID of target user","type":"integer"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object15"}}}},"x-examples":null,"x-deprecation-warning":null}},"/enhancements/geocode/{id}/transfer":{"put":{"summary":"Transfer ownership of this object to another user","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"Object204","in":"body","schema":{"$ref":"#/definitions/Object204"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object17"}}},"x-examples":null,"x-deprecation-warning":null}},"/enhancements/geocode/{id}/projects":{"get":{"summary":"List the projects a Geocode Enhancement belongs to","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Geocode Enhancement.","type":"integer"},{"name":"hidden","in":"query","required":false,"description":"If specified to be true, returns hidden items. Defaults to false, returning non-hidden items.","type":"boolean"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object84"}}}},"x-examples":null,"x-deprecation-warning":null}},"/enhancements/geocode/{id}/projects/{project_id}":{"put":{"summary":"Add a Geocode Enhancement to a project","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Geocode Enhancement.","type":"integer"},{"name":"project_id","in":"path","required":true,"description":"The ID of the project.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null},"delete":{"summary":"Remove a Geocode Enhancement from a project","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Geocode Enhancement.","type":"integer"},{"name":"project_id","in":"path","required":true,"description":"The ID of the project.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/enhancements/geocode/{id}/archive":{"put":{"summary":"Update the archive status of this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the object.","type":"integer"},{"name":"Object205","in":"body","schema":{"$ref":"#/definitions/Object205"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object175"}}},"x-examples":null,"x-deprecation-warning":null}},"/enhancements/identity-resolution/{id}/shares":{"get":{"summary":"List users and groups permissioned on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object9"}}}},"x-examples":null,"x-deprecation-warning":null}},"/enhancements/identity-resolution/{id}/shares/users":{"put":{"summary":"Set the permissions users have on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"Object206","in":"body","schema":{"$ref":"#/definitions/Object206"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object9"}}},"x-examples":null,"x-deprecation-warning":null}},"/enhancements/identity-resolution/{id}/shares/users/{user_id}":{"delete":{"summary":"Revoke the permissions a user has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"user_id","in":"path","required":true,"description":"The ID of the user.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/enhancements/identity-resolution/{id}/shares/groups":{"put":{"summary":"Set the permissions groups has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"Object207","in":"body","schema":{"$ref":"#/definitions/Object207"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object9"}}},"x-examples":null,"x-deprecation-warning":null}},"/enhancements/identity-resolution/{id}/shares/groups/{group_id}":{"delete":{"summary":"Revoke the permissions a group has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"group_id","in":"path","required":true,"description":"The ID of the group.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/enhancements/identity-resolution/{id}/dependencies":{"get":{"summary":"List dependent objects for this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"user_id","in":"query","required":false,"description":"ID of target user","type":"integer"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object15"}}}},"x-examples":null,"x-deprecation-warning":null}},"/enhancements/identity-resolution/{id}/transfer":{"put":{"summary":"Transfer ownership of this object to another user","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"Object208","in":"body","schema":{"$ref":"#/definitions/Object208"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object17"}}},"x-examples":[{"resource":"Enhancements","resource_explanation":null,"http_method":"PUT","route":"http://api.civis.test/enhancements/identity-resolution/:identity_resolution_id/transfer","description":"Transfer identity resolution enhancement to another user","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"PUT","request_path":"http://api.civis.test/enhancements/identity-resolution/1234/transfer","request_body":"{\n \"id\": 1234,\n \"user_id\": 1306,\n \"include_dependencies\": false\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer Kxd0ecPefx9ehJODa7qORens4nBdKOov_53ftLU_DG8","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"dependencies\": [\n\n ]\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"81059fe6210ccee4e3349c0f34c12d18\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"c1ef36df-46ea-4520-b6ba-59f22de52aaf","X-Runtime":"0.173575","Content-Length":"19"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/enhancements/identity-resolution/1234/transfer\" -d '{\"id\":1234,\"user_id\":1306,\"include_dependencies\":false}' -X PUT \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer Kxd0ecPefx9ehJODa7qORens4nBdKOov_53ftLU_DG8\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/enhancements/identity-resolution/{id}/projects":{"get":{"summary":"List the projects an Identity Resolution Enhancement belongs to","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Identity Resolution Enhancement.","type":"integer"},{"name":"hidden","in":"query","required":false,"description":"If specified to be true, returns hidden items. Defaults to false, returning non-hidden items.","type":"boolean"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object84"}}}},"x-examples":null,"x-deprecation-warning":null}},"/enhancements/identity-resolution/{id}/projects/{project_id}":{"put":{"summary":"Add an Identity Resolution Enhancement to a project","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Identity Resolution Enhancement.","type":"integer"},{"name":"project_id","in":"path","required":true,"description":"The ID of the project.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null},"delete":{"summary":"Remove an Identity Resolution Enhancement from a project","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Identity Resolution Enhancement.","type":"integer"},{"name":"project_id","in":"path","required":true,"description":"The ID of the project.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/enhancements/identity-resolution/{id}/archive":{"put":{"summary":"Update the archive status of this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the object.","type":"integer"},{"name":"Object209","in":"body","schema":{"$ref":"#/definitions/Object209"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object134"}}},"x-examples":null,"x-deprecation-warning":null}},"/exports/":{"get":{"summary":"List ","description":null,"deprecated":false,"parameters":[{"name":"type","in":"query","required":false,"description":"If specified, return exports of these types. It accepts a comma-separated list, possible values are 'database' and 'gdoc'.","type":"string"},{"name":"status","in":"query","required":false,"description":"If specified, returns export with one of these statuses. It accepts a comma-separated list, possible values are 'running', 'failed', 'succeeded', 'idle', 'scheduled'.","type":"string"},{"name":"author","in":"query","required":false,"description":"If specified, return items from any of these authors. It accepts a comma-separated list of user IDs.","type":"string"},{"name":"hidden","in":"query","required":false,"description":"If specified to be true, returns hidden items. Defaults to false, returning non-hidden items.","type":"boolean"},{"name":"archived","in":"query","required":false,"description":"The archival status of the requested item(s).","type":"string"},{"name":"limit","in":"query","required":false,"description":"Number of results to return. Defaults to 20. Maximum allowed is 50.","type":"integer"},{"name":"page_num","in":"query","required":false,"description":"Page number of the results to return. Defaults to the first page, 1.","type":"integer"},{"name":"order","in":"query","required":false,"description":"The field on which to order the result set. Defaults to updated_at. Must be one of: updated_at, name, created_at, last_run.updated_at.","type":"string"},{"name":"order_dir","in":"query","required":false,"description":"Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc.","type":"string"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object210"}}}},"x-examples":[{"resource":"Exports","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/exports","description":"Lists exports","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/exports","request_body":null,"request_headers":{"Content-Type":"application/json","Authorization":"Bearer cXp57HgSVBHD8XxU1btXSLoyDys-dNNUw6IiLxZzWoE","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 1849,\n \"name\": \"Export #1849\",\n \"type\": \"JobTypes::Import\",\n \"createdAt\": \"2023-07-18T18:42:06.000Z\",\n \"updatedAt\": \"2023-07-18T17:42:06.000Z\",\n \"state\": \"idle\",\n \"lastRun\": null,\n \"author\": {\n \"id\": 2132,\n \"name\": \"User devuserfactory1611 1609\",\n \"username\": \"devuserfactory1611\",\n \"initials\": \"UD\",\n \"online\": null\n }\n },\n {\n \"id\": 1856,\n \"name\": \"Export #1856\",\n \"type\": \"JobTypes::Import\",\n \"createdAt\": \"2023-07-18T18:42:06.000Z\",\n \"updatedAt\": \"2023-07-18T15:42:06.000Z\",\n \"state\": \"idle\",\n \"lastRun\": null,\n \"author\": {\n \"id\": 2136,\n \"name\": \"Admin devadminfactory520 520\",\n \"username\": \"devadminfactory520\",\n \"initials\": \"AD\",\n \"online\": null\n }\n },\n {\n \"id\": 1842,\n \"name\": \"Export #1842\",\n \"type\": \"JobTypes::Import\",\n \"createdAt\": \"2023-07-18T18:42:05.000Z\",\n \"updatedAt\": \"2023-07-18T14:42:06.000Z\",\n \"state\": \"idle\",\n \"lastRun\": null,\n \"author\": {\n \"id\": 2125,\n \"name\": \"Admin devadminfactory516 516\",\n \"username\": \"devadminfactory516\",\n \"initials\": \"AD\",\n \"online\": null\n }\n },\n {\n \"id\": 1834,\n \"name\": \"Test Import Job\",\n \"type\": \"JobTypes::Import\",\n \"createdAt\": \"2023-07-18T18:42:05.000Z\",\n \"updatedAt\": \"2023-07-18T13:42:06.000Z\",\n \"state\": \"idle\",\n \"lastRun\": null,\n \"author\": {\n \"id\": 2121,\n \"name\": \"Admin devadminfactory514 514\",\n \"username\": \"devadminfactory514\",\n \"initials\": \"AD\",\n \"online\": null\n }\n },\n {\n \"id\": 1838,\n \"name\": \"Export #1838\",\n \"type\": \"JobTypes::Import\",\n \"createdAt\": \"2023-07-18T18:42:05.000Z\",\n \"updatedAt\": \"2023-07-18T12:42:06.000Z\",\n \"state\": \"idle\",\n \"lastRun\": null,\n \"author\": {\n \"id\": 2123,\n \"name\": \"Admin devadminfactory515 515\",\n \"username\": \"devadminfactory515\",\n \"initials\": \"AD\",\n \"online\": null\n }\n },\n {\n \"id\": 1859,\n \"name\": \"Script #1859\",\n \"type\": \"JobTypes::ContainerDocker\",\n \"createdAt\": \"2023-07-18T18:42:06.000Z\",\n \"updatedAt\": \"2023-07-18T11:42:06.000Z\",\n \"state\": \"succeeded\",\n \"lastRun\": {\n \"id\": 203,\n \"state\": \"succeeded\",\n \"createdAt\": \"2023-07-18T18:42:06.000Z\",\n \"startedAt\": null,\n \"finishedAt\": \"2023-07-18T18:42:06.000Z\",\n \"error\": null\n },\n \"author\": {\n \"id\": 2138,\n \"name\": \"Admin devadminfactory521 521\",\n \"username\": \"devadminfactory521\",\n \"initials\": \"AD\",\n \"online\": null\n }\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","X-Pagination-Per-Page":"20","Access-Control-Expose-Headers":"X-Pagination-Per-Page, X-Pagination-Current-Page, X-Pagination-Total-Pages, X-Pagination-Total-Entries","X-Pagination-Current-Page":"1","X-Pagination-Total-Pages":"1","X-Pagination-Total-Entries":"6","Content-Type":"application/json; charset=utf-8","ETag":"W/\"78a817ab6b3e359dc9520c7602713743\"","X-Request-Id":"42bc3841-a547-41f3-9d91-9ee5b698c2ac","X-Runtime":"0.115299","Content-Length":"1887"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/exports\" -X GET \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer cXp57HgSVBHD8XxU1btXSLoyDys-dNNUw6IiLxZzWoE\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/exports/files/csv/{id}/runs":{"post":{"summary":"Start a run","description":"Start a run and provide a URI for checking its status. The response will provide a 'Location' header which will contain a URI which may be polled to monitor the status of the run.","deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the CSV Export job.","type":"integer"}],"responses":{"202":{"description":"success","schema":{"$ref":"#/definitions/Object211"}}},"x-examples":[{"resource":"Exports","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/exports/files/csv/:id/runs","description":"Run an export","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/exports/files/csv/1865/runs","request_body":null,"request_headers":{"Content-Type":"application/json","Authorization":"Bearer Z7f7RGwC4AsnFylq17wqw3gqkUlCRT5DKW0smBo6hi4","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":202,"response_status_text":"Accepted","response_body":"{\n \"id\": 204,\n \"state\": \"queued\",\n \"createdAt\": \"2023-07-18T18:42:08.000Z\",\n \"startedAt\": null,\n \"finishedAt\": null,\n \"error\": null,\n \"outputCachedOn\": null\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","Location":"http://api.civis.test/exports/files/csv/1865/runs/204","Content-Type":"application/json; charset=utf-8","X-Request-Id":"a0dcf65e-831d-4f4f-be13-76881481e134","X-Runtime":"0.116074","Content-Length":"136"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/exports/files/csv/1865/runs\" -d '' -X POST \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer Z7f7RGwC4AsnFylq17wqw3gqkUlCRT5DKW0smBo6hi4\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"get":{"summary":"List runs for the given CSV Export job","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the CSV Export job.","type":"integer"},{"name":"limit","in":"query","required":false,"description":"Number of results to return. Defaults to 20. Maximum allowed is 100.","type":"integer"},{"name":"page_num","in":"query","required":false,"description":"Page number of the results to return. Defaults to the first page, 1.","type":"integer"},{"name":"order","in":"query","required":false,"description":"The field on which to order the result set. Defaults to id. Must be one of: id.","type":"string"},{"name":"order_dir","in":"query","required":false,"description":"Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc.","type":"string"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object212"}}}},"x-examples":[{"resource":"Exports","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/exports/files/csv/:id/runs","description":"View an export's run history","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/exports/files/csv/1866/runs","request_body":null,"request_headers":{"Content-Type":"application/json","Authorization":"Bearer s4Vajzu6JMQAuUfPojJW4hGVTeEUt2dPhGCVsx9ByFs","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 206,\n \"state\": \"succeeded\",\n \"createdAt\": \"2023-07-18T18:42:09.000Z\",\n \"startedAt\": \"2023-07-18T18:41:09.000Z\",\n \"finishedAt\": \"2023-07-18T19:42:09.000Z\",\n \"error\": null\n },\n {\n \"id\": 205,\n \"state\": \"succeeded\",\n \"createdAt\": \"2023-07-18T18:42:09.000Z\",\n \"startedAt\": \"2023-07-18T18:41:09.000Z\",\n \"finishedAt\": \"2023-07-18T18:42:09.000Z\",\n \"error\": null\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","X-Pagination-Per-Page":"20","Access-Control-Expose-Headers":"X-Pagination-Per-Page, X-Pagination-Current-Page, X-Pagination-Total-Pages, X-Pagination-Total-Entries","X-Pagination-Current-Page":"1","X-Pagination-Total-Pages":"1","X-Pagination-Total-Entries":"2","Content-Type":"application/json; charset=utf-8","ETag":"W/\"c6b7a09750bd858bd5927da4d6d0e3b9\"","X-Request-Id":"6fc14e74-9a09-40ae-8605-4545d302f1e5","X-Runtime":"0.018877","Content-Length":"325"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/exports/files/csv/1866/runs\" -X GET \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer s4Vajzu6JMQAuUfPojJW4hGVTeEUt2dPhGCVsx9ByFs\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/exports/files/csv/{id}/runs/{run_id}":{"get":{"summary":"Check status of a run","description":"View the status of a run. This endpoint may be polled to monitor the status of the run. When the 'state' field is no longer 'queued' or 'running' the run has reached its final state.","deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the CSV Export job.","type":"integer"},{"name":"run_id","in":"path","required":true,"description":"The ID of the run.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object211"}}},"x-examples":[{"resource":"Exports","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/exports/files/csv/:id/runs/:run_id","description":"Get an export run's details","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/exports/files/csv/1867/runs/207","request_body":null,"request_headers":{"Content-Type":"application/json","Authorization":"Bearer jd6XBFWbirXdcGhFR3YywyCBUei3FS0Lb4lLjFaA5B4","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 207,\n \"state\": \"running\",\n \"createdAt\": \"2023-07-18T18:42:09.000Z\",\n \"startedAt\": null,\n \"finishedAt\": null,\n \"error\": null,\n \"outputCachedOn\": null\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"8d0cae164ed1b5584ae415cc9870ae8a\"","X-Request-Id":"5117bb29-26f7-4b5e-b6f0-6e4cbd9c3ede","X-Runtime":"0.016665","Content-Length":"137"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/exports/files/csv/1867/runs/207\" -X GET \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer jd6XBFWbirXdcGhFR3YywyCBUei3FS0Lb4lLjFaA5B4\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"delete":{"summary":"Cancel a run","description":"Cancel a currently active run.","deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the CSV Export job.","type":"integer"},{"name":"run_id","in":"path","required":true,"description":"The ID of the run.","type":"integer"}],"responses":{"202":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/exports/files/csv/{id}/runs/{run_id}/logs":{"get":{"summary":"Get the logs for a run","description":"Get the logs for a run.","deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the CSV Export job.","type":"integer"},{"name":"run_id","in":"path","required":true,"description":"The ID of the run.","type":"integer"},{"name":"last_id","in":"query","required":false,"description":"The ID of the last log message received. Log entries with this ID value or lower will be omitted.Logs are sorted by ID if this value is provided, and are otherwise sorted by createdAt.","type":"integer"},{"name":"limit","in":"query","required":false,"description":"The maximum number of log messages to return. Default of 10000.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object116"}}}},"x-examples":null,"x-deprecation-warning":null}},"/exports/files/csv/{id}/runs/{run_id}/outputs":{"get":{"summary":"List the outputs for a run","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the csv_export.","type":"integer"},{"name":"run_id","in":"path","required":true,"description":"The ID of the run.","type":"integer"},{"name":"limit","in":"query","required":false,"description":"Number of results to return. Defaults to its maximum of 50.","type":"integer"},{"name":"page_num","in":"query","required":false,"description":"Page number of the results to return. Defaults to the first page, 1.","type":"integer"},{"name":"order","in":"query","required":false,"description":"The field on which to order the result set. Defaults to created_at. Must be one of: created_at, id.","type":"string"},{"name":"order_dir","in":"query","required":false,"description":"Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc.","type":"string"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object213"}}}},"x-examples":[{"resource":"Exports","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/exports/files/csv/:job_with_run_id/runs/:job_run_id/outputs","description":"View a CSV Export's outputs","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/exports/files/csv/1868/runs/208/outputs","request_body":null,"request_headers":{"Content-Type":"application/json","Authorization":"Bearer FOblV6y5fyWNI5-lerHmv79JaApx0QhpP7uvJUjwByk","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"objectType\": \"File\",\n \"objectId\": 23,\n \"name\": \"my output file\",\n \"link\": \"api.civis.test/files/23\",\n \"value\": null\n },\n {\n \"objectType\": \"Report\",\n \"objectId\": 11,\n \"name\": \"my output report\",\n \"link\": \"api.civis.test/reports/11\",\n \"value\": null\n },\n {\n \"objectType\": \"Report\",\n \"objectId\": 12,\n \"name\": \"my output tableau report\",\n \"link\": \"api.civis.test/reports/12\",\n \"value\": null\n },\n {\n \"objectType\": \"Table\",\n \"objectId\": 132,\n \"name\": \"output.table\",\n \"link\": \"api.civis.test/tables/132\",\n \"value\": null\n },\n {\n \"objectType\": \"Project\",\n \"objectId\": 6,\n \"name\": \"my output project\",\n \"link\": \"api.civis.test/projects/6\",\n \"value\": null\n },\n {\n \"objectType\": \"Credential\",\n \"objectId\": 479,\n \"name\": \"my output credential\",\n \"link\": \"api.civis.test/credentials/479\",\n \"value\": null\n },\n {\n \"objectType\": \"JSONValue\",\n \"objectId\": 6,\n \"name\": \"my awesome JSON value\",\n \"link\": \"api.civis.test/json_values/6\",\n \"value\": {\n \"foo\": \"bar\"\n }\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","X-Pagination-Per-Page":"50","Access-Control-Expose-Headers":"X-Pagination-Per-Page, X-Pagination-Current-Page, X-Pagination-Total-Pages, X-Pagination-Total-Entries","X-Pagination-Current-Page":"1","X-Pagination-Total-Pages":"1","X-Pagination-Total-Entries":"7","Content-Type":"application/json; charset=utf-8","ETag":"W/\"0a285c874ac97cbcdb9b66fe387d6ad3\"","X-Request-Id":"6fc71b7e-3b4c-446a-b1ad-36caf60014f3","X-Runtime":"0.045534","Content-Length":"817"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/exports/files/csv/1868/runs/208/outputs\" -X GET \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer FOblV6y5fyWNI5-lerHmv79JaApx0QhpP7uvJUjwByk\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/exports/files/csv":{"post":{"summary":"Create a CSV Export","description":null,"deprecated":false,"parameters":[{"name":"Object214","in":"body","schema":{"$ref":"#/definitions/Object214"},"required":true}],"responses":{"201":{"description":"success","schema":{"$ref":"#/definitions/Object218"}}},"x-examples":[{"resource":"Exports","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/exports/files/csv","description":"successfuly creates a Csv Export job with the expected parameters.","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/exports/files/csv","request_body":"{\n \"source\": {\n \"sql\": \"select * from public.tea\",\n \"remote_host_id\": 238,\n \"credential_id\": 452\n },\n \"destination\": {\n \"filename_prefix\": \"prefix\"\n },\n \"compression\": \"zip\"\n}","request_headers":{"Content-Type":"application/json","Authorization":"Bearer uWRkepqbumslBuNCp2bK064pMWQJI4pLxaogF94vk8k","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":201,"response_status_text":"Created","response_body":"{\n \"id\": 1860,\n \"name\": \"CSV Export #1860\",\n \"source\": {\n \"sql\": \"select * from public.tea\",\n \"remoteHostId\": 238,\n \"credentialId\": 452\n },\n \"destination\": {\n \"filenamePrefix\": \"prefix\",\n \"storagePath\": {\n \"filePath\": null,\n \"storageHostId\": null,\n \"credentialId\": null,\n \"existingFiles\": \"fail\"\n }\n },\n \"includeHeader\": true,\n \"compression\": \"zip\",\n \"columnDelimiter\": \"comma\",\n \"hidden\": false,\n \"forceMultifile\": false,\n \"maxFileSize\": null,\n \"myPermissionLevel\": \"manage\"\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"63214430ddb2698d362d78bc107cacec\"","X-Request-Id":"989ceb36-a659-471a-b97d-7e6374b457ce","X-Runtime":"0.102854","Content-Length":"410"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/exports/files/csv\" -d '{\"source\":{\"sql\":\"select * from public.tea\",\"remote_host_id\":238,\"credential_id\":452},\"destination\":{\"filename_prefix\":\"prefix\"},\"compression\":\"zip\"}' -X POST \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer uWRkepqbumslBuNCp2bK064pMWQJI4pLxaogF94vk8k\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Exports","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/exports/files/csv","description":"successfuly creates a Csv Export job with the expected parameters.","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/exports/files/csv","request_body":"{\n \"source\": {\n \"sql\": \"select * from public.tea\",\n \"remote_host_id\": 248,\n \"credential_id\": 482\n },\n \"destination\": {\n \"filename_prefix\": \"prefix\",\n \"storage_path\": {\n \"file_path\": \"file_path1\",\n \"storage_host_id\": 249,\n \"credential_id\": 483,\n \"existing_files\": \"overwrite\"\n }\n },\n \"compression\": \"zip\"\n}","request_headers":{"Content-Type":"application/json","Authorization":"Bearer uohDXXHxhkJ-HDhyzM2tikNiGZ2gEdYEyPB3PiByC-0","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":201,"response_status_text":"Created","response_body":"{\n \"id\": 1872,\n \"name\": \"CSV Export #1872\",\n \"source\": {\n \"sql\": \"select * from public.tea\",\n \"remoteHostId\": 248,\n \"credentialId\": 482\n },\n \"destination\": {\n \"filenamePrefix\": \"prefix\",\n \"storagePath\": {\n \"filePath\": \"file_path1\",\n \"storageHostId\": 249,\n \"credentialId\": 483,\n \"existingFiles\": \"overwrite\"\n }\n },\n \"includeHeader\": true,\n \"compression\": \"zip\",\n \"columnDelimiter\": \"comma\",\n \"hidden\": false,\n \"forceMultifile\": false,\n \"maxFileSize\": null,\n \"myPermissionLevel\": \"manage\"\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"38044f9cd66ac9b6c50563ed2ea0537e\"","X-Request-Id":"1d116e70-7cf6-4996-b479-487bddddb6ce","X-Runtime":"0.080491","Content-Length":"421"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/exports/files/csv\" -d '{\"source\":{\"sql\":\"select * from public.tea\",\"remote_host_id\":248,\"credential_id\":482},\"destination\":{\"filename_prefix\":\"prefix\",\"storage_path\":{\"file_path\":\"file_path1\",\"storage_host_id\":249,\"credential_id\":483,\"existing_files\":\"overwrite\"}},\"compression\":\"zip\"}' -X POST \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer uohDXXHxhkJ-HDhyzM2tikNiGZ2gEdYEyPB3PiByC-0\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/exports/files/csv/{id}":{"get":{"summary":"Get a CSV Export","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object218"}}},"x-examples":[{"resource":"Exports","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/exports/files/csv/:id","description":"successfully retrieves a created Csv Export Job by its ID","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/exports/files/csv/1862","request_body":null,"request_headers":{"Content-Type":"application/json","Authorization":"Bearer VejzVhKXqdbkjcg-MrDkEycMiDemi55DlHUHajfcq7w","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 1862,\n \"name\": \"CSV Export #1862\",\n \"source\": {\n \"sql\": \"SELECT * FROM table LIMIT 10;\",\n \"remoteHostId\": 240,\n \"credentialId\": 457\n },\n \"destination\": {\n \"filenamePrefix\": null,\n \"storagePath\": {\n \"filePath\": null,\n \"storageHostId\": null,\n \"credentialId\": null,\n \"existingFiles\": \"fail\"\n }\n },\n \"includeHeader\": true,\n \"compression\": \"gzip\",\n \"columnDelimiter\": \"comma\",\n \"hidden\": false,\n \"forceMultifile\": false,\n \"maxFileSize\": null,\n \"myPermissionLevel\": \"manage\"\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"56b81bcde66ca87742deda8001ad700d\"","X-Request-Id":"4400e50b-ec0b-4b74-ab52-225783b09c54","X-Runtime":"0.023282","Content-Length":"412"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/exports/files/csv/1862\" -X GET \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer VejzVhKXqdbkjcg-MrDkEycMiDemi55DlHUHajfcq7w\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"put":{"summary":"Replace all attributes of this CSV Export","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of this Csv Export job.","type":"integer"},{"name":"Object222","in":"body","schema":{"$ref":"#/definitions/Object222"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object218"}}},"x-examples":[{"resource":"Exports","resource_explanation":null,"http_method":"PUT","route":"http://api.civis.test/exports/files/csv/:id","description":"successfully replaces all attributes of an existing Csv Export Job","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"PUT","request_path":"http://api.civis.test/exports/files/csv/1863","request_body":"{\n \"source\": {\n \"sql\": \"SELECT * FROM table LIMIT 10;\",\n \"remote_host_id\": 241,\n \"credential_id\": 460\n },\n \"destination\": {\n \"filename_prefix\": \"new_prefix\"\n },\n \"compression\": \"zip\"\n}","request_headers":{"Content-Type":"application/json","Authorization":"Bearer tSUDaPvZOMC9nn7uB4N8eKIiA3IMlN4VqgbmhZPYNc0","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 1863,\n \"name\": \"CSV Export #1863\",\n \"source\": {\n \"sql\": \"SELECT * FROM table LIMIT 10;\",\n \"remoteHostId\": 241,\n \"credentialId\": 460\n },\n \"destination\": {\n \"filenamePrefix\": \"new_prefix\",\n \"storagePath\": {\n \"filePath\": null,\n \"storageHostId\": null,\n \"credentialId\": null,\n \"existingFiles\": \"fail\"\n }\n },\n \"includeHeader\": true,\n \"compression\": \"zip\",\n \"columnDelimiter\": \"comma\",\n \"hidden\": false,\n \"forceMultifile\": false,\n \"maxFileSize\": null,\n \"myPermissionLevel\": \"manage\"\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"b2f18ac80f7acd3d135d2a7692eca0f3\"","X-Request-Id":"8aae9fd8-c7ee-43c4-9918-425ccbddc2f6","X-Runtime":"0.062912","Content-Length":"419"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/exports/files/csv/1863\" -d '{\"source\":{\"sql\":\"SELECT * FROM table LIMIT 10;\",\"remote_host_id\":241,\"credential_id\":460},\"destination\":{\"filename_prefix\":\"new_prefix\"},\"compression\":\"zip\"}' -X PUT \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer tSUDaPvZOMC9nn7uB4N8eKIiA3IMlN4VqgbmhZPYNc0\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"patch":{"summary":"Update some attributes of this CSV Export","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of this Csv Export job.","type":"integer"},{"name":"Object223","in":"body","schema":{"$ref":"#/definitions/Object223"},"required":false}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object218"}}},"x-examples":[{"resource":"Exports","resource_explanation":null,"http_method":"PATCH","route":"http://api.civis.test/exports/files/csv/:id","description":"successfully updates filename_prefix of a created Csv Export Job","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"PATCH","request_path":"http://api.civis.test/exports/files/csv/1864","request_body":"{\n \"destination\": {\n \"filename_prefix\": \"new_prefix\"\n }\n}","request_headers":{"Content-Type":"application/json","Authorization":"Bearer jlnYdV4W323Ke7BlgrkE4l6pzvviPmUtTPHoTH1CUB8","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 1864,\n \"name\": \"CSV Export #1864\",\n \"source\": {\n \"sql\": \"SELECT * FROM table LIMIT 10;\",\n \"remoteHostId\": 242,\n \"credentialId\": 463\n },\n \"destination\": {\n \"filenamePrefix\": \"new_prefix\",\n \"storagePath\": {\n \"filePath\": null,\n \"storageHostId\": null,\n \"credentialId\": null,\n \"existingFiles\": \"fail\"\n }\n },\n \"includeHeader\": true,\n \"compression\": \"gzip\",\n \"columnDelimiter\": \"comma\",\n \"hidden\": false,\n \"forceMultifile\": false,\n \"maxFileSize\": null,\n \"myPermissionLevel\": \"manage\"\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"832994e12eeb634cf98c7c8f5142c2bc\"","X-Request-Id":"cf34df5e-ed28-484f-a110-2564fabd59aa","X-Runtime":"0.060156","Content-Length":"420"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/exports/files/csv/1864\" -d '{\"destination\":{\"filename_prefix\":\"new_prefix\"}}' -X PATCH \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer jlnYdV4W323Ke7BlgrkE4l6pzvviPmUtTPHoTH1CUB8\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/exports/files/csv/{id}/archive":{"put":{"summary":"Update the archive status of this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the object.","type":"integer"},{"name":"Object225","in":"body","schema":{"$ref":"#/definitions/Object225"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object218"}}},"x-examples":null,"x-deprecation-warning":null}},"/files/{id}/projects":{"get":{"summary":"List the projects a File belongs to","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the File.","type":"integer"},{"name":"hidden","in":"query","required":false,"description":"If specified to be true, returns hidden items. Defaults to false, returning non-hidden items.","type":"boolean"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object84"}}}},"x-examples":null,"x-deprecation-warning":null}},"/files/{id}/projects/{project_id}":{"put":{"summary":"Add a File to a project","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the File.","type":"integer"},{"name":"project_id","in":"path","required":true,"description":"The ID of the project.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null},"delete":{"summary":"Remove a File from a project","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the File.","type":"integer"},{"name":"project_id","in":"path","required":true,"description":"The ID of the project.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/files/{id}/shares":{"get":{"summary":"List users and groups permissioned on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object9"}}}},"x-examples":null,"x-deprecation-warning":null}},"/files/{id}/shares/users":{"put":{"summary":"Set the permissions users have on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"Object231","in":"body","schema":{"$ref":"#/definitions/Object231"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object9"}}},"x-examples":null,"x-deprecation-warning":null}},"/files/{id}/shares/users/{user_id}":{"delete":{"summary":"Revoke the permissions a user has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"user_id","in":"path","required":true,"description":"The ID of the user.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/files/{id}/shares/groups":{"put":{"summary":"Set the permissions groups has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"Object232","in":"body","schema":{"$ref":"#/definitions/Object232"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object9"}}},"x-examples":null,"x-deprecation-warning":null}},"/files/{id}/shares/groups/{group_id}":{"delete":{"summary":"Revoke the permissions a group has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"group_id","in":"path","required":true,"description":"The ID of the group.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/files/{id}/dependencies":{"get":{"summary":"List dependent objects for this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"user_id","in":"query","required":false,"description":"ID of target user","type":"integer"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object15"}}}},"x-examples":null,"x-deprecation-warning":null}},"/files/{id}/transfer":{"put":{"summary":"Transfer ownership of this object to another user","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"Object233","in":"body","schema":{"$ref":"#/definitions/Object233"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object17"}}},"x-examples":null,"x-deprecation-warning":null}},"/files/":{"post":{"summary":"Initiate an upload of a file into the platform","description":"Uploading a file begins with this endpoint. This endpoint returns a URL that must be used to complete the upload.","deprecated":false,"parameters":[{"name":"Object234","in":"body","schema":{"$ref":"#/definitions/Object234"},"required":true}],"responses":{"201":{"description":"success","schema":{"$ref":"#/definitions/Object235"}}},"x-examples":[{"resource":"Files","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/files","description":"Initiate an upload of a file","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/files","request_body":"{\n \"name\": \"my_file.csv.gzip\",\n \"description\": \"my description\"\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer UajK_mghHwyt6eoS9RbJKUgyE8PStaogZCPjNMHuxjs","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":201,"response_status_text":"Created","response_body":"{\n \"id\": 1,\n \"name\": \"my_file.csv.gzip\",\n \"createdAt\": \"2016-01-13T12:23:00.000Z\",\n \"fileSize\": 0,\n \"expiresAt\": \"2016-02-12T12:23:00.000Z\",\n \"description\": \"my description\",\n \"uploadUrl\": \"presigned_url\",\n \"uploadFields\": {\n \"a\": \"1\",\n \"b\": \"2\"\n },\n \"myPermissionLevel\": \"manage\"\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"bd669684750d73c094528271ca0bac0f\"","X-Request-Id":"random-key","X-Runtime":"0.587227","Content-Length":"246"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/files\" -d '{\"name\":\"my_file.csv.gzip\",\"description\":\"my description\"}' -X POST \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer UajK_mghHwyt6eoS9RbJKUgyE8PStaogZCPjNMHuxjs\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Files","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/files","description":"Initiate an upload of a file with a non-default expiration","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/files","request_body":"{\n \"name\": \"my_file.csv.gzip\",\n \"expiresAt\": \"2016-12-31 23:59:59\"\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer 8OsBefHwMn9ZiYPIdydgWvHZSCeuzxK8egu9-IQMhTQ","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":201,"response_status_text":"Created","response_body":"{\n \"id\": 2,\n \"name\": \"my_file.csv.gzip\",\n \"createdAt\": \"2016-01-13T12:23:00.000Z\",\n \"fileSize\": 0,\n \"expiresAt\": \"2016-12-31T23:59:59.000Z\",\n \"description\": null,\n \"uploadUrl\": \"presigned_url\",\n \"uploadFields\": {\n \"a\": \"1\",\n \"b\": \"2\"\n },\n \"myPermissionLevel\": \"manage\"\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"5c71d220adc22d7a47e0688fbe4df85d\"","X-Request-Id":"random-key","X-Runtime":"0.100073","Content-Length":"234"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/files\" -d '{\"name\":\"my_file.csv.gzip\",\"expiresAt\":\"2016-12-31 23:59:59\"}' -X POST \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer 8OsBefHwMn9ZiYPIdydgWvHZSCeuzxK8egu9-IQMhTQ\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Files","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/files","description":"Initiate an upload of a file with no expiration","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/files","request_body":"{\n \"name\": \"my_file.csv.gzip\",\n \"expiresAt\": null\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer PSGj8UM0B02x9eJ490Tb7woTZaql6rqzvyKWWI6hDa4","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":201,"response_status_text":"Created","response_body":"{\n \"id\": 3,\n \"name\": \"my_file.csv.gzip\",\n \"createdAt\": \"2016-01-13T12:23:00.000Z\",\n \"fileSize\": 0,\n \"expiresAt\": null,\n \"description\": null,\n \"uploadUrl\": \"presigned_url\",\n \"uploadFields\": {\n \"a\": \"1\",\n \"b\": \"2\"\n },\n \"myPermissionLevel\": \"manage\"\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"4f43625107238aea8b6947415fc5fe38\"","X-Request-Id":"random-key","X-Runtime":"0.133671","Content-Length":"212"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/files\" -d '{\"name\":\"my_file.csv.gzip\",\"expiresAt\":null}' -X POST \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer PSGj8UM0B02x9eJ490Tb7woTZaql6rqzvyKWWI6hDa4\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/files/multipart":{"post":{"summary":"Initiate a multipart upload","description":null,"deprecated":false,"parameters":[{"name":"Object236","in":"body","schema":{"$ref":"#/definitions/Object236"},"required":true}],"responses":{"201":{"description":"success","schema":{"$ref":"#/definitions/Object237"}}},"x-examples":[{"resource":"Files","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/files/multipart","description":"Initiate a multipart upload","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/files/multipart","request_body":"{\n \"name\": \"my_file.csv.gzip\",\n \"num_parts\": 2,\n \"description\": \"my description\"\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer IhKlbNeID6BKsnq_gggEZBOCQPcsJuYpvSUH-4YI7Zw","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":201,"response_status_text":"Created","response_body":"{\n \"id\": 11,\n \"name\": \"my_file.csv.gzip\",\n \"createdAt\": \"2017-09-26T12:23:00.000Z\",\n \"fileSize\": 0,\n \"expiresAt\": \"2017-10-26T12:23:00.000Z\",\n \"description\": \"my description\",\n \"uploadUrls\": [\n \"url/1\",\n \"url/2\"\n ]\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"9dc1e1d13cf75a1724ccc123d0551954\"","X-Request-Id":"69839245-23f7-4c4c-bdc5-f67bcbf5cd94","X-Runtime":"0.112713","Content-Length":"188"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/files/multipart\" -d '{\"name\":\"my_file.csv.gzip\",\"num_parts\":2,\"description\":\"my description\"}' -X POST \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer IhKlbNeID6BKsnq_gggEZBOCQPcsJuYpvSUH-4YI7Zw\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/files/multipart/{id}/complete":{"post":{"summary":"Complete a multipart upload","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the file.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":[{"resource":"Files","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/files/multipart/:id/complete","description":"Complete a multipart upload","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/files/multipart/12/complete","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer Wo3m-U7RIVPR3dNsw4mhTSYz4ryD0tQfRxRLYe08Tis","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":204,"response_status_text":"No Content","response_body":null,"response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","X-Request-Id":"791a637e-d458-49ed-a305-bde67f3c66ac","X-Runtime":"0.043036"},"response_content_type":null,"curl":"curl \"api.civis.testhttp://api.civis.test/files/multipart/12/complete\" -d '' -X POST \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer Wo3m-U7RIVPR3dNsw4mhTSYz4ryD0tQfRxRLYe08Tis\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/files/{id}":{"get":{"summary":"Get details about a file","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the file.","type":"integer"},{"name":"link_expires_at","in":"query","required":false,"description":"The date and time the download link will expire. Must be a time between now and 36 hours from now. Defaults to 30 minutes from now.","type":"string","format":"date-time"},{"name":"inline","in":"query","required":false,"description":"If true, will return a url that can be displayed inline in HTML","type":"boolean"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object238"}}},"x-examples":[{"resource":"Files","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/files/:id","description":"Get a file's path","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/files/4","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer OvX6M2uh2N6dz0KOj5b4ZDcU2QSF5l5pjUAJ-h8A8yQ","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 4,\n \"name\": \"my_file.csv.gzip\",\n \"createdAt\": \"2024-07-24T22:10:25.000Z\",\n \"fileSize\": 42,\n \"expiresAt\": null,\n \"description\": \"my description\",\n \"author\": {\n \"id\": 9,\n \"name\": \"Admin devadminfactory4 4\",\n \"username\": \"devadminfactory4\",\n \"initials\": \"AD\",\n \"online\": null\n },\n \"downloadUrl\": \"https://s3.example.com/post?a=1&b=2&c=3\",\n \"fileUrl\": \"https://s3.example.com/post?a=1&b=2&c=3\",\n \"detectedInfo\": {\n \"includeHeader\": true,\n \"columnDelimiter\": \"comma\",\n \"compression\": \"gzip\",\n \"tableColumns\": [\n {\n \"name\": \"column_1\",\n \"sqlType\": \"INT\"\n },\n {\n \"name\": \"column_2\",\n \"sqlType\": \"VARCHAR(10)\"\n }\n ]\n },\n \"myPermissionLevel\": \"manage\"\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"417aaa4e90dc1aba09b27116c27176af\"","X-Request-Id":"f4a8901e-f8e8-4662-a123-d76f285717b5","X-Runtime":"0.073007","Content-Length":"586"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/files/4\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer OvX6M2uh2N6dz0KOj5b4ZDcU2QSF5l5pjUAJ-h8A8yQ\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Files","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/files/:id","description":"Handle a file with no S3 content","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/files/5","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer wx5oQrWHtsRmuTXJ8sZvpWQZ7ts_3WjVgLaH9LTmo8Y","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 5,\n \"name\": \"my_file.csv.gzip\",\n \"createdAt\": \"2024-07-24T22:10:25.000Z\",\n \"fileSize\": 0,\n \"expiresAt\": null,\n \"description\": \"my description\",\n \"author\": {\n \"id\": 10,\n \"name\": \"Admin devadminfactory5 5\",\n \"username\": \"devadminfactory5\",\n \"initials\": \"AD\",\n \"online\": null\n },\n \"downloadUrl\": null,\n \"fileUrl\": null,\n \"detectedInfo\": {\n \"includeHeader\": null,\n \"columnDelimiter\": null,\n \"compression\": null,\n \"tableColumns\": [\n\n ]\n },\n \"myPermissionLevel\": \"manage\"\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"ac239dd6c91d02984c2d3a126ab1f77c\"","X-Request-Id":"db854eaa-eeac-4b9e-bc82-302be75a5170","X-Runtime":"0.063339","Content-Length":"408"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/files/5\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer wx5oQrWHtsRmuTXJ8sZvpWQZ7ts_3WjVgLaH9LTmo8Y\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"put":{"summary":"Update details about a file","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the file.","type":"integer"},{"name":"Object241","in":"body","schema":{"$ref":"#/definitions/Object241"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object238"}}},"x-examples":[{"resource":"Files","resource_explanation":null,"http_method":"PUT","route":"http://api.civis.test/files/:id","description":"Update a file's name and expiration date","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"PUT","request_path":"http://api.civis.test/files/6","request_body":"{\n \"name\": \"new_name.csv.gzip\",\n \"expires_at\": \"2020-03-25T12:23:00.000Z\",\n \"description\": \"my new description\"\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer 2MnuAObpJzBl9bS-SRsuPmi9gjFDqbOE7DdQpLEBw20","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 6,\n \"name\": \"new_name.csv.gzip\",\n \"createdAt\": \"2020-01-13T12:23:00.000Z\",\n \"fileSize\": 42,\n \"expiresAt\": \"2020-03-25T12:23:00.000Z\",\n \"description\": \"my new description\",\n \"author\": {\n \"id\": 11,\n \"name\": \"Admin devadminfactory6 6\",\n \"username\": \"devadminfactory6\",\n \"initials\": \"AD\",\n \"online\": null\n },\n \"downloadUrl\": \"https://s3.example.com/post?a=1&b=2&c=3\",\n \"fileUrl\": \"https://s3.example.com/post?a=1&b=2&c=3\",\n \"detectedInfo\": {\n \"includeHeader\": true,\n \"columnDelimiter\": \"comma\",\n \"compression\": \"gzip\",\n \"tableColumns\": [\n {\n \"name\": \"column_1\",\n \"sqlType\": \"INT\"\n },\n {\n \"name\": \"column_2\",\n \"sqlType\": \"VARCHAR(10)\"\n }\n ]\n },\n \"myPermissionLevel\": \"manage\"\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"019dde21dc1d537522c14f4dd01c6403\"","X-Request-Id":"cfbfe6b7-9f5d-4230-a763-bcecef495a58","X-Runtime":"0.090537","Content-Length":"614"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/files/6\" -d '{\"name\":\"new_name.csv.gzip\",\"expires_at\":\"2020-03-25T12:23:00.000Z\",\"description\":\"my new description\"}' -X PUT \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer 2MnuAObpJzBl9bS-SRsuPmi9gjFDqbOE7DdQpLEBw20\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Files","resource_explanation":null,"http_method":"PUT","route":"http://api.civis.test/files/:id","description":"Handle a file with no S3 content","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"PUT","request_path":"http://api.civis.test/files/7","request_body":"{\n \"name\": \"new_name.csv.gzip\",\n \"expires_at\": \"2020-03-25T12:23:00.000Z\",\n \"description\": \"my new description\"\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer LXelVAAA5S9pzNTzeJa9JCtXBpkiWw3jvF9YS2BbUM0","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 7,\n \"name\": \"new_name.csv.gzip\",\n \"createdAt\": \"2020-01-13T12:23:00.000Z\",\n \"fileSize\": 0,\n \"expiresAt\": \"2020-03-25T12:23:00.000Z\",\n \"description\": \"my new description\",\n \"author\": {\n \"id\": 12,\n \"name\": \"Admin devadminfactory7 7\",\n \"username\": \"devadminfactory7\",\n \"initials\": \"AD\",\n \"online\": null\n },\n \"downloadUrl\": null,\n \"fileUrl\": null,\n \"detectedInfo\": {\n \"includeHeader\": null,\n \"columnDelimiter\": null,\n \"compression\": null,\n \"tableColumns\": [\n\n ]\n },\n \"myPermissionLevel\": \"manage\"\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"a0d08f0b810166a6e6425c87dab1c48a\"","X-Request-Id":"a1a078fd-3f32-4227-9af6-c7989f65c6c6","X-Runtime":"0.094599","Content-Length":"435"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/files/7\" -d '{\"name\":\"new_name.csv.gzip\",\"expires_at\":\"2020-03-25T12:23:00.000Z\",\"description\":\"my new description\"}' -X PUT \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer LXelVAAA5S9pzNTzeJa9JCtXBpkiWw3jvF9YS2BbUM0\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"patch":{"summary":"Update details about a file","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the file.","type":"integer"},{"name":"Object242","in":"body","schema":{"$ref":"#/definitions/Object242"},"required":false}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object238"}}},"x-examples":[{"resource":"Files","resource_explanation":null,"http_method":"PATCH","route":"http://api.civis.test/files/:id","description":"Update a file's name","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"PATCH","request_path":"http://api.civis.test/files/8","request_body":"{\n \"name\": \"new_name.csv.gzip\",\n \"description\": \"my new description\"\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer REtuDnw5xFM4ROlafU7rocaez-oMGFVAe6yyjkGR7MA","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 8,\n \"name\": \"new_name.csv.gzip\",\n \"createdAt\": \"2020-01-13T12:23:00.000Z\",\n \"fileSize\": 42,\n \"expiresAt\": \"2020-03-13T12:23:00.000Z\",\n \"description\": \"my new description\",\n \"author\": {\n \"id\": 13,\n \"name\": \"Admin devadminfactory8 8\",\n \"username\": \"devadminfactory8\",\n \"initials\": \"AD\",\n \"online\": null\n },\n \"downloadUrl\": \"https://s3.example.com/post?a=1&b=2&c=3\",\n \"fileUrl\": \"https://s3.example.com/post?a=1&b=2&c=3\",\n \"detectedInfo\": {\n \"includeHeader\": true,\n \"columnDelimiter\": \"comma\",\n \"compression\": \"gzip\",\n \"tableColumns\": [\n {\n \"name\": \"column_1\",\n \"sqlType\": \"INT\"\n },\n {\n \"name\": \"column_2\",\n \"sqlType\": \"VARCHAR(10)\"\n }\n ]\n },\n \"myPermissionLevel\": \"manage\"\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"ac43eb33d3328b889eb0af36963907a9\"","X-Request-Id":"3bbd5192-6c0c-4a31-8916-82dddd30b2e8","X-Runtime":"0.094085","Content-Length":"614"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/files/8\" -d '{\"name\":\"new_name.csv.gzip\",\"description\":\"my new description\"}' -X PATCH \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer REtuDnw5xFM4ROlafU7rocaez-oMGFVAe6yyjkGR7MA\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Files","resource_explanation":null,"http_method":"PATCH","route":"http://api.civis.test/files/:id","description":"Update a file's expiration date","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"PATCH","request_path":"http://api.civis.test/files/9","request_body":"{\n \"expires_at\": \"2020-03-25T12:23:00.000Z\",\n \"description\": \"my new description\"\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer jiETCFr1kVumd-iT5S8n___O_Y-wRu1pmsxXV9zNa_s","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 9,\n \"name\": \"my_file.csv.gzip\",\n \"createdAt\": \"2020-01-13T12:23:00.000Z\",\n \"fileSize\": 42,\n \"expiresAt\": \"2020-03-25T12:23:00.000Z\",\n \"description\": \"my new description\",\n \"author\": {\n \"id\": 14,\n \"name\": \"Admin devadminfactory9 9\",\n \"username\": \"devadminfactory9\",\n \"initials\": \"AD\",\n \"online\": null\n },\n \"downloadUrl\": \"https://s3.example.com/post?a=1&b=2&c=3\",\n \"fileUrl\": \"https://s3.example.com/post?a=1&b=2&c=3\",\n \"detectedInfo\": {\n \"includeHeader\": true,\n \"columnDelimiter\": \"comma\",\n \"compression\": \"gzip\",\n \"tableColumns\": [\n {\n \"name\": \"column_1\",\n \"sqlType\": \"INT\"\n },\n {\n \"name\": \"column_2\",\n \"sqlType\": \"VARCHAR(10)\"\n }\n ]\n },\n \"myPermissionLevel\": \"manage\"\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"a97d9ce5d7761fc9d4db9e0b5a9f5537\"","X-Request-Id":"12ea232a-7ccf-4cfa-9f15-1339d79537ac","X-Runtime":"0.051219","Content-Length":"613"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/files/9\" -d '{\"expires_at\":\"2020-03-25T12:23:00.000Z\",\"description\":\"my new description\"}' -X PATCH \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer jiETCFr1kVumd-iT5S8n___O_Y-wRu1pmsxXV9zNa_s\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Files","resource_explanation":null,"http_method":"PATCH","route":"http://api.civis.test/files/:id","description":"Handle a file with no S3 content","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"PATCH","request_path":"http://api.civis.test/files/10","request_body":"{\n \"name\": \"new_name.csv.gzip\",\n \"expires_at\": \"2020-03-25T12:23:00.000Z\",\n \"description\": \"my new description\"\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer Xr4DNyPeryLVuTfxTpIwlrqioXxCSYCThYzPvRCawP8","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 10,\n \"name\": \"new_name.csv.gzip\",\n \"createdAt\": \"2020-01-13T12:23:00.000Z\",\n \"fileSize\": 0,\n \"expiresAt\": \"2020-03-25T12:23:00.000Z\",\n \"description\": \"my new description\",\n \"author\": {\n \"id\": 15,\n \"name\": \"Admin devadminfactory10 10\",\n \"username\": \"devadminfactory10\",\n \"initials\": \"AD\",\n \"online\": null\n },\n \"downloadUrl\": null,\n \"fileUrl\": null,\n \"detectedInfo\": {\n \"includeHeader\": null,\n \"columnDelimiter\": null,\n \"compression\": null,\n \"tableColumns\": [\n\n ]\n },\n \"myPermissionLevel\": \"manage\"\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"0b6f896d837a05f0a5d9b7686a4f81f9\"","X-Request-Id":"f6308f5b-949b-43e9-b95d-c14590242ecd","X-Runtime":"0.053369","Content-Length":"439"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/files/10\" -d '{\"name\":\"new_name.csv.gzip\",\"expires_at\":\"2020-03-25T12:23:00.000Z\",\"description\":\"my new description\"}' -X PATCH \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer Xr4DNyPeryLVuTfxTpIwlrqioXxCSYCThYzPvRCawP8\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/files/preprocess/csv":{"post":{"summary":"Create a Preprocess CSV","description":null,"deprecated":false,"parameters":[{"name":"Object243","in":"body","schema":{"$ref":"#/definitions/Object243"},"required":true}],"responses":{"201":{"description":"success","schema":{"$ref":"#/definitions/Object244"}}},"x-examples":[{"resource":"Files","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/files/preprocess/csv","description":"Preprocess a CSV file","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/files/preprocess/csv","request_body":"{\n \"file_id\": 13\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer OayeswGdIKmGPD5hny44KdjyTykJ-QIK4ORr2YcB0n4","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":201,"response_status_text":"Created","response_body":"{\n \"id\": 1,\n \"fileId\": 13,\n \"inPlace\": true,\n \"detectTableColumns\": false,\n \"forceCharacterSetConversion\": false,\n \"includeHeader\": null,\n \"columnDelimiter\": null,\n \"hidden\": false\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"40170d8773f00c01fd1ec243f4359111\"","X-Request-Id":"2f2d338d-0ca2-4621-928e-f692301983e8","X-Runtime":"0.279042","Content-Length":"157"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/files/preprocess/csv\" -d '{\"file_id\":13}' -X POST \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer OayeswGdIKmGPD5hny44KdjyTykJ-QIK4ORr2YcB0n4\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/files/preprocess/csv/{id}":{"get":{"summary":"Get a Preprocess CSV","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object244"}}},"x-examples":null,"x-deprecation-warning":null},"put":{"summary":"Replace all attributes of this Preprocess CSV","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the job created.","type":"integer"},{"name":"Object245","in":"body","schema":{"$ref":"#/definitions/Object245"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object244"}}},"x-examples":null,"x-deprecation-warning":null},"patch":{"summary":"Update some attributes of this Preprocess CSV","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the job created.","type":"integer"},{"name":"Object246","in":"body","schema":{"$ref":"#/definitions/Object246"},"required":false}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object244"}}},"x-examples":[{"resource":"Files","resource_explanation":null,"http_method":"PATCH","route":"http://api.civis.test/files/preprocess/csv/:id","description":"Update a job","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"PATCH","request_path":"http://api.civis.test/files/preprocess/csv/3","request_body":"{\n \"in_place\": false,\n \"detect_table_columns\": true\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer tQAgxY5HMyCWD4JfRy2VHK8eWG9zfKUqFJkL1I9d6r8","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 3,\n \"fileId\": 14,\n \"inPlace\": false,\n \"detectTableColumns\": true,\n \"forceCharacterSetConversion\": false,\n \"includeHeader\": true,\n \"columnDelimiter\": \"comma\",\n \"hidden\": false\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"c64abbd7f7888ef294d60528e496217d\"","X-Request-Id":"379d45d8-13f8-4685-900c-c0128f761dde","X-Runtime":"0.061130","Content-Length":"160"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/files/preprocess/csv/3\" -d '{\"in_place\":false,\"detect_table_columns\":true}' -X PATCH \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer tQAgxY5HMyCWD4JfRy2VHK8eWG9zfKUqFJkL1I9d6r8\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"delete":{"summary":"Archive a Preprocess CSV (deprecated, use archiving endpoints instead)","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/files/preprocess/csv/{id}/archive":{"put":{"summary":"Update the archive status of this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the object.","type":"integer"},{"name":"Object247","in":"body","schema":{"$ref":"#/definitions/Object247"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object244"}}},"x-examples":null,"x-deprecation-warning":null}},"/git_repos/":{"get":{"summary":"List bookmarked git repositories","description":null,"deprecated":false,"parameters":[{"name":"limit","in":"query","required":false,"description":"Number of results to return. Defaults to 20. Maximum allowed is 100.","type":"integer"},{"name":"page_num","in":"query","required":false,"description":"Page number of the results to return. Defaults to the first page, 1.","type":"integer"},{"name":"order","in":"query","required":false,"description":"The field on which to order the result set. Defaults to repo_url. Must be one of: repo_url, created_at.","type":"string"},{"name":"order_dir","in":"query","required":false,"description":"Direction in which to sort, either asc (ascending) or desc (descending) defaulting to asc.","type":"string"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object248"}}}},"x-examples":[{"resource":"GitRepos","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/git_repos","description":"List all bookmarked git repositories","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/git_repos","request_body":null,"request_headers":{"Content-Type":"application/json","Authorization":"Bearer gDMFKg2zfeqX5ehVJd6bgvzBZ2hKvpSEEtrWY83r-R8","Accept":"application/vnd.civis-platform.v1","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 1,\n \"repoUrl\": \"https://github.com/civisanalytics_10000/console.git\",\n \"createdAt\": \"2023-07-18T18:42:13.000Z\",\n \"updatedAt\": \"2023-07-18T18:42:13.000Z\"\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","X-Pagination-Per-Page":"20","Access-Control-Expose-Headers":"X-Pagination-Per-Page, X-Pagination-Current-Page, X-Pagination-Total-Pages, X-Pagination-Total-Entries","X-Pagination-Current-Page":"1","X-Pagination-Total-Pages":"1","X-Pagination-Total-Entries":"1","Content-Type":"application/json; charset=utf-8","ETag":"W/\"0f8ace0ff70ad96e2c5927799c2c2f3e\"","X-Request-Id":"13b8a7db-505e-482d-bd86-377aaa0d793b","X-Runtime":"0.013031","Content-Length":"152"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/git_repos\" -X GET \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer gDMFKg2zfeqX5ehVJd6bgvzBZ2hKvpSEEtrWY83r-R8\" \\\n\t-H \"Accept: application/vnd.civis-platform.v1\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"post":{"summary":"Bookmark a git repository","description":null,"deprecated":false,"parameters":[{"name":"Object249","in":"body","schema":{"$ref":"#/definitions/Object249"},"required":true}],"responses":{"201":{"description":"success","schema":{"$ref":"#/definitions/Object248"}}},"x-examples":[{"resource":"GitRepos","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/git_repos","description":"Bookmark a git repository from a URL","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/git_repos","request_body":"{\n \"repo_url\": \"https://github.com/civisanalytics/potato.git\"\n}","request_headers":{"Content-Type":"application/json","Authorization":"Bearer 5XVs8Qo37dciUAnG2bBZVoJMsMpjcH34UGDbxwPl0ps","Accept":"application/vnd.civis-platform.v1","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":201,"response_status_text":"Created","response_body":"{\n \"id\": 5,\n \"repoUrl\": \"https://github.com/civisanalytics/potato.git\",\n \"createdAt\": \"2023-07-18T18:42:14.000Z\",\n \"updatedAt\": \"2023-07-18T18:42:14.000Z\"\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"f034712e10b157213de836030e538f25\"","X-Request-Id":"c3c6ae97-a16b-4ffc-b2c6-c447394395e9","X-Runtime":"0.017244","Content-Length":"143"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/git_repos\" -d '{\"repo_url\":\"https://github.com/civisanalytics/potato.git\"}' -X POST \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer 5XVs8Qo37dciUAnG2bBZVoJMsMpjcH34UGDbxwPl0ps\" \\\n\t-H \"Accept: application/vnd.civis-platform.v1\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/git_repos/{id}":{"get":{"summary":"Get a bookmarked git repository","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID for this git repository.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object248"}}},"x-examples":[{"resource":"GitRepos","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/git_repos/:id","description":"View a bookmarked git repository's details","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/git_repos/2","request_body":null,"request_headers":{"Content-Type":"application/json","Authorization":"Bearer D5J_M5qBy2kvRrNxUtgQF_vmQq_WVi4AdHQd2SRoOZY","Accept":"application/vnd.civis-platform.v1","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 2,\n \"repoUrl\": \"https://github.com/civisanalytics_10001/console.git\",\n \"createdAt\": \"2023-07-18T18:42:13.000Z\",\n \"updatedAt\": \"2023-07-18T18:42:13.000Z\"\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"19eeed854e247b773a3d705fd1336a40\"","X-Request-Id":"76bf2893-66b4-4f72-8c65-30f30b857970","X-Runtime":"0.010696","Content-Length":"150"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/git_repos/2\" -X GET \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer D5J_M5qBy2kvRrNxUtgQF_vmQq_WVi4AdHQd2SRoOZY\" \\\n\t-H \"Accept: application/vnd.civis-platform.v1\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"delete":{"summary":"Remove the bookmark on a git repository","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID for this git repository.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":[{"resource":"GitRepos","resource_explanation":null,"http_method":"DELETE","route":"http://api.civis.test/git_repos/:id","description":"Delete the bookmark on a git repository","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"DELETE","request_path":"http://api.civis.test/git_repos/6","request_body":null,"request_headers":{"Content-Type":"application/json","Authorization":"Bearer 8tOH6DaZfhgTXgsTLStVt1DCg5q6TIutR4bFw_nDSXQ","Accept":"application/vnd.civis-platform.v1","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":204,"response_status_text":"No Content","response_body":null,"response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","X-Request-Id":"45b31e1d-84db-464e-bc66-d2423edae9f2","X-Runtime":"0.013497"},"response_content_type":null,"curl":"curl \"api.civis.testhttp://api.civis.test/git_repos/6\" -d '' -X DELETE \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer 8tOH6DaZfhgTXgsTLStVt1DCg5q6TIutR4bFw_nDSXQ\" \\\n\t-H \"Accept: application/vnd.civis-platform.v1\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/git_repos/{id}/refs":{"get":{"summary":"Get all branches and tags of a bookmarked git repository","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID for this git repository.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object250"}}},"x-examples":[{"resource":"GitRepos","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/git_repos/:id/refs","description":"View a bookmarked git repository's branches and tags","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/git_repos/3/refs","request_body":null,"request_headers":{"Content-Type":"application/json","Authorization":"Bearer 9XXc7wvlnIgqPu_Y5ztovlCk47VYN1alMxvvcAscrxw","Accept":"application/vnd.civis-platform.v1","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"branches\": [\n \"main\"\n ],\n \"tags\": [\n \"v0.0.1\"\n ]\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"2013f96a65dfdc7ee597c05cb09c6a9d\"","X-Request-Id":"db4cd1d7-f678-42e5-9d4f-14e7eff6168f","X-Runtime":"0.017421","Content-Length":"39"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/git_repos/3/refs\" -X GET \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer 9XXc7wvlnIgqPu_Y5ztovlCk47VYN1alMxvvcAscrxw\" \\\n\t-H \"Accept: application/vnd.civis-platform.v1\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/groups/":{"get":{"summary":"List Groups","description":null,"deprecated":false,"parameters":[{"name":"query","in":"query","required":false,"description":"If specified, it will filter the groups returned.","type":"string"},{"name":"permission","in":"query","required":false,"description":"A permissions string, one of \"read\", \"write\", or \"manage\". Lists only groups for which the current user has that permission.","type":"string"},{"name":"include_members","in":"query","required":false,"description":"Show members of the group.","type":"boolean"},{"name":"organization_id","in":"query","required":false,"description":"The organization by which to filter groups.","type":"integer"},{"name":"user_ids","in":"query","required":false,"description":"A list of user IDs to filter groups by.Groups will be returned if any of the users is a member","type":"array","items":{"type":"integer"}},{"name":"limit","in":"query","required":false,"description":"Number of results to return. Defaults to 50. Maximum allowed is 1000.","type":"integer"},{"name":"page_num","in":"query","required":false,"description":"Page number of the results to return. Defaults to the first page, 1.","type":"integer"},{"name":"order","in":"query","required":false,"description":"The field on which to order the result set. Defaults to name. Must be one of: name, created_at.","type":"string"},{"name":"order_dir","in":"query","required":false,"description":"Direction in which to sort, either asc (ascending) or desc (descending) defaulting to asc.","type":"string"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object251"}}}},"x-examples":[{"resource":"Groups","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/groups","description":"List groups visible to the current user","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/groups","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer jNRGjLs4QkD9iHE-a6tFOxKnVb2x6OgtFh2vEekEJAs","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 30,\n \"name\": \"Default\",\n \"createdAt\": \"2025-02-26T17:48:11.000Z\",\n \"updatedAt\": \"2025-02-26T17:48:12.000Z\",\n \"description\": null,\n \"slug\": \"default\",\n \"organizationId\": 4,\n \"organizationName\": \"Default\",\n \"memberCount\": 1,\n \"totalMemberCount\": 1,\n \"lastUpdatedById\": null,\n \"createdById\": null,\n \"members\": [\n\n ]\n },\n {\n \"id\": 26,\n \"name\": \"Default Admins\",\n \"createdAt\": \"2025-02-26T17:48:11.000Z\",\n \"updatedAt\": \"2025-02-26T17:48:11.000Z\",\n \"description\": null,\n \"slug\": \"default_admins\",\n \"organizationId\": 4,\n \"organizationName\": \"Default\",\n \"memberCount\": 0,\n \"totalMemberCount\": 0,\n \"lastUpdatedById\": null,\n \"createdById\": null,\n \"members\": [\n\n ]\n },\n {\n \"id\": 28,\n \"name\": \"Default All Database Users\",\n \"createdAt\": \"2025-02-26T17:48:11.000Z\",\n \"updatedAt\": \"2025-02-26T17:48:11.000Z\",\n \"description\": null,\n \"slug\": \"default_dbusers\",\n \"organizationId\": 4,\n \"organizationName\": \"Default\",\n \"memberCount\": 0,\n \"totalMemberCount\": 0,\n \"lastUpdatedById\": null,\n \"createdById\": null,\n \"members\": [\n\n ]\n },\n {\n \"id\": 29,\n \"name\": \"Default Report Viewers\",\n \"createdAt\": \"2025-02-26T17:48:11.000Z\",\n \"updatedAt\": \"2025-02-26T17:48:11.000Z\",\n \"description\": null,\n \"slug\": \"default_reportviewers\",\n \"organizationId\": 4,\n \"organizationName\": \"Default\",\n \"memberCount\": 0,\n \"totalMemberCount\": 0,\n \"lastUpdatedById\": null,\n \"createdById\": null,\n \"members\": [\n\n ]\n },\n {\n \"id\": 27,\n \"name\": \"Default Team Admins\",\n \"createdAt\": \"2025-02-26T17:48:11.000Z\",\n \"updatedAt\": \"2025-02-26T17:48:11.000Z\",\n \"description\": null,\n \"slug\": \"default_teamadmins\",\n \"organizationId\": 4,\n \"organizationName\": \"Default\",\n \"memberCount\": 0,\n \"totalMemberCount\": 0,\n \"lastUpdatedById\": null,\n \"createdById\": null,\n \"members\": [\n\n ]\n },\n {\n \"id\": 49,\n \"name\": \"Group with gc role\",\n \"createdAt\": \"2025-02-26T17:48:15.000Z\",\n \"updatedAt\": \"2025-02-26T17:48:15.000Z\",\n \"description\": null,\n \"slug\": \"group_c\",\n \"organizationId\": 7,\n \"organizationName\": \"Organization 2\",\n \"memberCount\": 1,\n \"totalMemberCount\": 1,\n \"lastUpdatedById\": null,\n \"createdById\": null,\n \"members\": [\n\n ]\n },\n {\n \"id\": 43,\n \"name\": \"Shared Read\",\n \"createdAt\": \"2025-02-26T17:48:15.000Z\",\n \"updatedAt\": \"2025-02-26T17:48:15.000Z\",\n \"description\": null,\n \"slug\": \"group_b\",\n \"organizationId\": 6,\n \"organizationName\": \"Organization 1\",\n \"memberCount\": 1,\n \"totalMemberCount\": 1,\n \"lastUpdatedById\": null,\n \"createdById\": null,\n \"members\": [\n\n ]\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","X-Pagination-Per-Page":"50","Access-Control-Expose-Headers":"X-Pagination-Per-Page, X-Pagination-Current-Page, X-Pagination-Total-Pages, X-Pagination-Total-Entries","X-Pagination-Current-Page":"1","X-Pagination-Total-Pages":"1","X-Pagination-Total-Entries":"7","Content-Type":"application/json; charset=utf-8","ETag":"W/\"5e38176021076f175209f12e3af9466d\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"98e07dd7-b1bd-43c2-b397-e31b7c82d28f","X-Runtime":"0.203060","Content-Length":"2090"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/groups\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer jNRGjLs4QkD9iHE-a6tFOxKnVb2x6OgtFh2vEekEJAs\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"post":{"summary":"Create a Group","description":null,"deprecated":false,"parameters":[{"name":"Object252","in":"body","schema":{"$ref":"#/definitions/Object252"},"required":true}],"responses":{"201":{"description":"success","schema":{"$ref":"#/definitions/Object253"}}},"x-examples":[{"resource":"Groups","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/groups","description":"Create a new group","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/groups","request_body":"{\n \"name\": \"Friendship\"\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer ACETfFY6v3lerD4PbpCDMwgprKMZIUVQsINCBjkgDUk","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":201,"response_status_text":"Created","response_body":"{\n \"id\": 77,\n \"name\": \"Friendship\",\n \"createdAt\": \"2025-02-26T17:48:21.000Z\",\n \"updatedAt\": \"2025-02-26T17:48:21.000Z\",\n \"description\": null,\n \"slug\": \"7cd6860f-211d-4e90-903c-9c74e991a6a5\",\n \"organizationId\": 4,\n \"organizationName\": \"Default\",\n \"memberCount\": 0,\n \"totalMemberCount\": 0,\n \"defaultOtpRequiredForLogin\": null,\n \"roleIds\": [\n\n ],\n \"defaultTimeZone\": null,\n \"defaultJobsLabel\": null,\n \"defaultNotebooksLabel\": null,\n \"defaultServicesLabel\": null,\n \"lastUpdatedById\": 8,\n \"createdById\": 8,\n \"members\": [\n\n ]\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"59fcf4dbf21ccd043e03d40dccee7297\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"3589755b-1e0b-4f52-af19-ec704607b2ab","X-Runtime":"0.099555","Content-Length":"457"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/groups\" -d '{\"name\":\"Friendship\"}' -X POST \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer ACETfFY6v3lerD4PbpCDMwgprKMZIUVQsINCBjkgDUk\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/groups/{id}":{"get":{"summary":"Get a Group","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object253"}}},"x-examples":[{"resource":"Groups","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/groups/:shared_group_id","description":"Show info for a group","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/groups/56","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer YPyuEb9YuxpkYzlduwu5NqqDu-xhnShE76SIP85W4dI","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 56,\n \"name\": \"Shared Read\",\n \"createdAt\": \"2025-02-26T17:48:18.000Z\",\n \"updatedAt\": \"2025-02-26T17:48:18.000Z\",\n \"description\": null,\n \"slug\": \"group_d\",\n \"organizationId\": 8,\n \"organizationName\": \"Organization 3\",\n \"memberCount\": 1,\n \"totalMemberCount\": 1,\n \"defaultOtpRequiredForLogin\": null,\n \"roleIds\": [\n\n ],\n \"defaultTimeZone\": null,\n \"defaultJobsLabel\": null,\n \"defaultNotebooksLabel\": null,\n \"defaultServicesLabel\": null,\n \"lastUpdatedById\": null,\n \"createdById\": null,\n \"members\": [\n {\n \"id\": 7,\n \"name\": \"User devuserfactory2 2\",\n \"username\": \"devuserfactory2\",\n \"initials\": \"UD\",\n \"online\": null,\n \"email\": \"devuserfactory22user@localhost.test\",\n \"primaryGroupId\": 30,\n \"active\": true\n }\n ]\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"4c3a372147c540a1040f7bb56315aa74\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"d8e3204a-ee8a-4e6f-a65c-84b09625c28b","X-Runtime":"0.045865","Content-Length":"621"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/groups/56\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer YPyuEb9YuxpkYzlduwu5NqqDu-xhnShE76SIP85W4dI\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"put":{"summary":"Replace all attributes of this Group","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of this group.","type":"integer"},{"name":"Object255","in":"body","schema":{"$ref":"#/definitions/Object255"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object253"}}},"x-examples":null,"x-deprecation-warning":null},"patch":{"summary":"Update some attributes of this Group","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of this group.","type":"integer"},{"name":"Object256","in":"body","schema":{"$ref":"#/definitions/Object256"},"required":false}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object253"}}},"x-examples":[{"resource":"Groups","resource_explanation":null,"http_method":"PATCH","route":"http://api.civis.test/groups/:shared_group_id","description":"Update a group's name","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"PATCH","request_path":"http://api.civis.test/groups/83","request_body":"{\n \"name\": \"Friendship\"\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer ORJBLXUcyXr4t4HjkeRuSZPdWHDhABqlxH4F9K4V_-I","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 83,\n \"name\": \"Friendship\",\n \"createdAt\": \"2025-02-26T17:48:23.000Z\",\n \"updatedAt\": \"2025-02-26T17:48:24.000Z\",\n \"description\": null,\n \"slug\": \"group_h\",\n \"organizationId\": 12,\n \"organizationName\": \"Organization 7\",\n \"memberCount\": 1,\n \"totalMemberCount\": 1,\n \"defaultOtpRequiredForLogin\": null,\n \"roleIds\": [\n\n ],\n \"defaultTimeZone\": null,\n \"defaultJobsLabel\": null,\n \"defaultNotebooksLabel\": null,\n \"defaultServicesLabel\": null,\n \"lastUpdatedById\": 9,\n \"createdById\": null,\n \"members\": [\n {\n \"id\": 9,\n \"name\": \"User devuserfactory4 4\",\n \"username\": \"devuserfactory4\",\n \"initials\": \"UD\",\n \"online\": null,\n \"email\": \"devuserfactory44user@localhost.test\",\n \"primaryGroupId\": 30,\n \"active\": true\n }\n ]\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"471789e15a0f56ec89fa953aea82f44f\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"8b5c460d-9be4-444a-a4aa-888b58640518","X-Runtime":"0.132031","Content-Length":"618"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/groups/83\" -d '{\"name\":\"Friendship\"}' -X PATCH \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer ORJBLXUcyXr4t4HjkeRuSZPdWHDhABqlxH4F9K4V_-I\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Groups","resource_explanation":null,"http_method":"PATCH","route":"http://api.civis.test/groups/:shared_group_id","description":"Update a group's description","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"PATCH","request_path":"http://api.civis.test/groups/96","request_body":"{\n \"description\": \"Wonderful new description\"\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer BtD8FyVzQ5goaAJNwSiZHmyMQeiNSDvZZvOSsfdRGT8","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 96,\n \"name\": \"Shared Read\",\n \"createdAt\": \"2025-02-26T17:48:26.000Z\",\n \"updatedAt\": \"2025-02-26T17:48:27.000Z\",\n \"description\": \"Wonderful new description\",\n \"slug\": \"group_j\",\n \"organizationId\": 14,\n \"organizationName\": \"Organization 9\",\n \"memberCount\": 1,\n \"totalMemberCount\": 1,\n \"defaultOtpRequiredForLogin\": null,\n \"roleIds\": [\n\n ],\n \"defaultTimeZone\": null,\n \"defaultJobsLabel\": null,\n \"defaultNotebooksLabel\": null,\n \"defaultServicesLabel\": null,\n \"lastUpdatedById\": 10,\n \"createdById\": null,\n \"members\": [\n {\n \"id\": 10,\n \"name\": \"User devuserfactory5 5\",\n \"username\": \"devuserfactory5\",\n \"initials\": \"UD\",\n \"online\": null,\n \"email\": \"devuserfactory55user@localhost.test\",\n \"primaryGroupId\": 30,\n \"active\": true\n }\n ]\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"4f137bdedbafbbe4eb9c0d7a03a2fd5d\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"93b250f2-cd53-42d6-bb8f-d447f0708c30","X-Runtime":"0.097236","Content-Length":"644"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/groups/96\" -d '{\"description\":\"Wonderful new description\"}' -X PATCH \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer BtD8FyVzQ5goaAJNwSiZHmyMQeiNSDvZZvOSsfdRGT8\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"delete":{"summary":"Delete a Group (deprecated)","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":[{"resource":"Groups","resource_explanation":null,"http_method":"DELETE","route":"http://api.civis.test/groups/:shared_group_id","description":"Delete a group","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"DELETE","request_path":"http://api.civis.test/groups/109","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer QPKRFGJAEyWDS5VGICyS2ezNGeHzmrgrJ6OaxTdcCdY","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":204,"response_status_text":"No Content","response_body":null,"response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"3fb35005-e416-4134-af29-cea6412e43b2","X-Runtime":"0.113966"},"response_content_type":null,"curl":"curl \"api.civis.testhttp://api.civis.test/groups/109\" -d '' -X DELETE \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer QPKRFGJAEyWDS5VGICyS2ezNGeHzmrgrJ6OaxTdcCdY\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/groups/{id}/shares":{"get":{"summary":"List users and groups permissioned on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object9"}}}},"x-examples":null,"x-deprecation-warning":null}},"/groups/{id}/shares/users":{"put":{"summary":"Set the permissions users have on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"Object257","in":"body","schema":{"$ref":"#/definitions/Object257"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object9"}}},"x-examples":null,"x-deprecation-warning":null}},"/groups/{id}/shares/users/{user_id}":{"delete":{"summary":"Revoke the permissions a user has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"user_id","in":"path","required":true,"description":"The ID of the user.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/groups/{id}/shares/groups":{"put":{"summary":"Set the permissions groups has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"Object258","in":"body","schema":{"$ref":"#/definitions/Object258"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object9"}}},"x-examples":null,"x-deprecation-warning":null}},"/groups/{id}/shares/groups/{group_id}":{"delete":{"summary":"Revoke the permissions a group has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"group_id","in":"path","required":true,"description":"The ID of the group.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/groups/{id}/members/{user_id}":{"put":{"summary":"Add a user to a group","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the group.","type":"integer"},{"name":"user_id","in":"path","required":true,"description":"The ID of the user.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object253"}}},"x-examples":[{"resource":"Groups","resource_explanation":null,"http_method":"PUT","route":"http://api.civis.test/groups/:group_id/members/:user_id","description":"Add a user to a group","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"PUT","request_path":"http://api.civis.test/groups/124/members/13","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer t_Ue9ZuT25XVYD6TaCdYTmZMerVCg5kEpqJs5t3lj28","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 124,\n \"name\": \"Group 1\",\n \"createdAt\": \"2025-02-26T17:48:30.000Z\",\n \"updatedAt\": \"2025-02-26T17:48:30.000Z\",\n \"description\": null,\n \"slug\": \"group_n\",\n \"organizationId\": 18,\n \"organizationName\": \"Organization 13\",\n \"memberCount\": 1,\n \"totalMemberCount\": 1,\n \"defaultOtpRequiredForLogin\": null,\n \"roleIds\": [\n\n ],\n \"defaultTimeZone\": null,\n \"defaultJobsLabel\": null,\n \"defaultNotebooksLabel\": null,\n \"defaultServicesLabel\": null,\n \"lastUpdatedById\": null,\n \"createdById\": null,\n \"members\": [\n {\n \"id\": 13,\n \"name\": \"User devuserfactory7 7\",\n \"username\": \"devuserfactory7\",\n \"initials\": \"UD\",\n \"online\": null,\n \"email\": \"devuserfactory77user@localhost.test\",\n \"primaryGroupId\": 30,\n \"active\": true\n }\n ]\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"27245b2b99d348a44a7d98bf6d002d60\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"92dd88aa-0fd6-4c3b-bbbc-9389ff277ece","X-Runtime":"0.048870","Content-Length":"621"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/groups/124/members/13\" -d '' -X PUT \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer t_Ue9ZuT25XVYD6TaCdYTmZMerVCg5kEpqJs5t3lj28\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"delete":{"summary":"Remove a user from a group","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the group.","type":"integer"},{"name":"user_id","in":"path","required":true,"description":"The ID of the user.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":[{"resource":"Groups","resource_explanation":null,"http_method":"DELETE","route":"http://api.civis.test/groups/:group_id/members/:user_id","description":"Remove a user from a group","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"DELETE","request_path":"http://api.civis.test/groups/132/members/15","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer lM8X-Ocn907B3r3vxhC4oHxpO7LnnkDgEIQLukYn0LQ","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":204,"response_status_text":"No Content","response_body":null,"response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"e8535034-a6c4-4e5c-8316-5569ddf98f21","X-Runtime":"0.053456"},"response_content_type":null,"curl":"curl \"api.civis.testhttp://api.civis.test/groups/132/members/15\" -d '' -X DELETE \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer lM8X-Ocn907B3r3vxhC4oHxpO7LnnkDgEIQLukYn0LQ\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/groups/{id}/child_groups":{"get":{"summary":"Get child groups of this group","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of this group.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object259"}}},"x-examples":[{"resource":"Groups","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/groups/:group_id/child_groups","description":"Lists groups that this group has permissions on","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/groups/139/child_groups","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer J_0uMW4aGhFsh6pPIcvq79N-nbm8xHyYOPkM-2GM2iA","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"manageable\": [\n {\n \"id\": 145,\n \"name\": \"Group 4\"\n }\n ],\n \"writeable\": [\n {\n \"id\": 151,\n \"name\": \"Group 5\"\n }\n ],\n \"readable\": [\n {\n \"id\": 157,\n \"name\": \"Group 6\"\n }\n ]\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"d18e81098a070aaf4abbb458d5b022bf\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"5e0d3c3c-e31a-4983-91b2-bc694d41d73c","X-Runtime":"0.060658","Content-Length":"127"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/groups/139/child_groups\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer J_0uMW4aGhFsh6pPIcvq79N-nbm8xHyYOPkM-2GM2iA\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/imports/{id}/shares":{"get":{"summary":"List users and groups permissioned on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object9"}}}},"x-examples":null,"x-deprecation-warning":null}},"/imports/{id}/shares/users":{"put":{"summary":"Set the permissions users have on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"Object261","in":"body","schema":{"$ref":"#/definitions/Object261"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object9"}}},"x-examples":null,"x-deprecation-warning":null}},"/imports/{id}/shares/users/{user_id}":{"delete":{"summary":"Revoke the permissions a user has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"user_id","in":"path","required":true,"description":"The ID of the user.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/imports/{id}/shares/groups":{"put":{"summary":"Set the permissions groups has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"Object262","in":"body","schema":{"$ref":"#/definitions/Object262"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object9"}}},"x-examples":null,"x-deprecation-warning":null}},"/imports/{id}/shares/groups/{group_id}":{"delete":{"summary":"Revoke the permissions a group has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"group_id","in":"path","required":true,"description":"The ID of the group.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/imports/{id}/dependencies":{"get":{"summary":"List dependent objects for this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"user_id","in":"query","required":false,"description":"ID of target user","type":"integer"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object15"}}}},"x-examples":null,"x-deprecation-warning":null}},"/imports/{id}/transfer":{"put":{"summary":"Transfer ownership of this object to another user","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"Object263","in":"body","schema":{"$ref":"#/definitions/Object263"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object17"}}},"x-examples":null,"x-deprecation-warning":null}},"/imports/{id}/projects":{"get":{"summary":"List the projects an Import belongs to","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Import.","type":"integer"},{"name":"hidden","in":"query","required":false,"description":"If specified to be true, returns hidden items. Defaults to false, returning non-hidden items.","type":"boolean"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object84"}}}},"x-examples":null,"x-deprecation-warning":null}},"/imports/{id}/projects/{project_id}":{"put":{"summary":"Add an Import to a project","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Import.","type":"integer"},{"name":"project_id","in":"path","required":true,"description":"The ID of the project.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null},"delete":{"summary":"Remove an Import from a project","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Import.","type":"integer"},{"name":"project_id","in":"path","required":true,"description":"The ID of the project.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/imports/{id}/archive":{"put":{"summary":"Update the archive status of this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the object.","type":"integer"},{"name":"Object264","in":"body","schema":{"$ref":"#/definitions/Object264"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object265"}}},"x-examples":null,"x-deprecation-warning":null}},"/imports/":{"get":{"summary":"List Imports","description":null,"deprecated":false,"parameters":[{"name":"type","in":"query","required":false,"description":"If specified, return imports of these types. It accepts a comma-separated list, possible values are Dbsync, AutoImport, GdocImport, and GdocExport.","type":"string"},{"name":"destination","in":"query","required":false,"description":"If specified, returns imports with one of these destinations. It accepts a comma-separated list of remote host ids.","type":"string"},{"name":"source","in":"query","required":false,"description":"If specified, returns imports with one of these sources. It accepts a comma-separated list of remote host ids. 'Dbsync' must be specified for 'type'.","type":"string"},{"name":"status","in":"query","required":false,"description":"If specified, returns imports with one of these statuses. It accepts a comma-separated list, possible values are 'running', 'failed', 'succeeded', 'idle', 'scheduled'.","type":"string"},{"name":"author","in":"query","required":false,"description":"If specified, return items from any of these authors. It accepts a comma-separated list of user IDs.","type":"string"},{"name":"hidden","in":"query","required":false,"description":"If specified to be true, returns hidden items. Defaults to false, returning non-hidden items.","type":"boolean"},{"name":"archived","in":"query","required":false,"description":"The archival status of the requested item(s).","type":"string"},{"name":"limit","in":"query","required":false,"description":"Number of results to return. Defaults to 20. Maximum allowed is 50.","type":"integer"},{"name":"page_num","in":"query","required":false,"description":"Page number of the results to return. Defaults to the first page, 1.","type":"integer"},{"name":"order","in":"query","required":false,"description":"The field on which to order the result set. Defaults to updated_at. Must be one of: updated_at, name, created_at, last_run.updated_at.","type":"string"},{"name":"order_dir","in":"query","required":false,"description":"Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc.","type":"string"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object276"}}}},"x-examples":[{"resource":"Imports","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/imports","description":"List all imports for a user","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/imports","request_body":null,"request_headers":{"Content-Type":"application/json","Authorization":"Bearer 18nRfglG_NmAp5JqYBwwq2FWUXMBj5PRmJpDoKR4LMs","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"name\": \"Import #1899\",\n \"syncType\": \"AutoImport\",\n \"source\": null,\n \"destination\": {\n \"remoteHostId\": 259,\n \"credentialId\": 503,\n \"additionalCredentials\": [\n\n ],\n \"name\": \"redshift-10177\"\n },\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n },\n \"id\": 1899,\n \"isOutbound\": false,\n \"jobType\": \"JobTypes::Import\",\n \"state\": \"idle\",\n \"createdAt\": \"2023-07-18T18:42:30.000Z\",\n \"updatedAt\": \"2023-07-18T18:42:30.000Z\",\n \"lastRun\": null,\n \"user\": {\n \"id\": 2214,\n \"name\": \"User devuserfactory1651 1649\",\n \"username\": \"devuserfactory1651\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"timeZone\": \"America/Chicago\",\n \"archived\": false\n },\n {\n \"name\": \"Import #1880\",\n \"syncType\": \"Dbsync\",\n \"source\": {\n \"remoteHostId\": 251,\n \"credentialId\": 489,\n \"additionalCredentials\": [\n\n ],\n \"name\": \"redshift-10171\"\n },\n \"destination\": {\n \"remoteHostId\": 252,\n \"credentialId\": 491,\n \"additionalCredentials\": [\n\n ],\n \"name\": \"redshift-10172\"\n },\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n },\n \"id\": 1880,\n \"isOutbound\": false,\n \"jobType\": \"JobTypes::Import\",\n \"state\": \"idle\",\n \"createdAt\": \"2023-07-18T18:42:29.000Z\",\n \"updatedAt\": \"2023-07-18T18:37:28.000Z\",\n \"lastRun\": null,\n \"user\": {\n \"id\": 2215,\n \"name\": \"User devuserfactory1652 1650\",\n \"username\": \"devuserfactory1652\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"timeZone\": \"America/Chicago\",\n \"archived\": false\n },\n {\n \"name\": \"Import #1886\",\n \"syncType\": \"Dbsync\",\n \"source\": {\n \"remoteHostId\": 253,\n \"credentialId\": 493,\n \"additionalCredentials\": [\n\n ],\n \"name\": \"redshift-10173\"\n },\n \"destination\": {\n \"remoteHostId\": 254,\n \"credentialId\": 495,\n \"additionalCredentials\": [\n\n ],\n \"name\": \"redshift-10174\"\n },\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n },\n \"id\": 1886,\n \"isOutbound\": false,\n \"jobType\": \"JobTypes::Import\",\n \"state\": \"running\",\n \"createdAt\": \"2023-07-18T18:42:29.000Z\",\n \"updatedAt\": \"2023-07-18T18:32:29.000Z\",\n \"lastRun\": {\n \"id\": 209,\n \"state\": \"running\",\n \"createdAt\": \"2023-07-18T18:42:29.000Z\",\n \"startedAt\": null,\n \"finishedAt\": null,\n \"error\": null\n },\n \"user\": {\n \"id\": 2215,\n \"name\": \"User devuserfactory1652 1650\",\n \"username\": \"devuserfactory1652\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"timeZone\": \"America/Chicago\",\n \"archived\": false\n },\n {\n \"name\": \"Import #1891\",\n \"syncType\": \"GdocImport\",\n \"source\": {\n \"remoteHostId\": 257,\n \"credentialId\": 499,\n \"additionalCredentials\": [\n\n ],\n \"name\": \"redshift-10175\"\n },\n \"destination\": {\n \"remoteHostId\": 258,\n \"credentialId\": 501,\n \"additionalCredentials\": [\n\n ],\n \"name\": \"redshift-10176\"\n },\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n },\n \"id\": 1891,\n \"isOutbound\": false,\n \"jobType\": \"JobTypes::Import\",\n \"state\": \"queued\",\n \"createdAt\": \"2023-07-18T18:42:29.000Z\",\n \"updatedAt\": \"2023-07-18T18:27:29.000Z\",\n \"lastRun\": {\n \"id\": 210,\n \"state\": \"queued\",\n \"createdAt\": \"2023-07-18T18:42:29.000Z\",\n \"startedAt\": null,\n \"finishedAt\": null,\n \"error\": null\n },\n \"user\": {\n \"id\": 2215,\n \"name\": \"User devuserfactory1652 1650\",\n \"username\": \"devuserfactory1652\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"timeZone\": \"America/Chicago\",\n \"archived\": false\n },\n {\n \"name\": \"Script #1894\",\n \"syncType\": null,\n \"source\": null,\n \"destination\": null,\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n },\n \"id\": 1894,\n \"isOutbound\": false,\n \"jobType\": \"JobTypes::ContainerDocker\",\n \"state\": \"idle\",\n \"createdAt\": \"2023-07-18T18:42:29.000Z\",\n \"updatedAt\": \"2023-07-18T18:22:29.000Z\",\n \"lastRun\": null,\n \"user\": {\n \"id\": 2215,\n \"name\": \"User devuserfactory1652 1650\",\n \"username\": \"devuserfactory1652\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"timeZone\": \"America/Chicago\",\n \"archived\": false\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","X-Pagination-Per-Page":"20","Access-Control-Expose-Headers":"X-Pagination-Per-Page, X-Pagination-Current-Page, X-Pagination-Total-Pages, X-Pagination-Total-Entries","X-Pagination-Current-Page":"1","X-Pagination-Total-Pages":"1","X-Pagination-Total-Entries":"5","Content-Type":"application/json; charset=utf-8","ETag":"W/\"3578097c21ff8498410ff874762197d1\"","X-Request-Id":"6aa0e170-f0e5-4dbd-9a8b-e9d35c69e179","X-Runtime":"0.060477","Content-Length":"3607"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/imports\" -X GET \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer 18nRfglG_NmAp5JqYBwwq2FWUXMBj5PRmJpDoKR4LMs\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"post":{"summary":"Create a new import configuration","description":"Imports have a variety of types and consist of one or more syncs. Once you've created your import, use the post syncs endpoint to create new syncs for it. Make sure to set attributes which are compatible with the type of import you're using, either Dbsync, AutoImport, GdocImport or GdocExport.","deprecated":false,"parameters":[{"name":"Object277","in":"body","schema":{"$ref":"#/definitions/Object277"},"required":true}],"responses":{"201":{"description":"success","schema":{"$ref":"#/definitions/Object265"}}},"x-examples":null,"x-deprecation-warning":null}},"/imports/files":{"post":{"summary":"Initate an import of a tabular file into the platform","description":"Importing a tabular file, such as a CSV, begins with this endpoint. \nCompatible files must be comma, tab, or pipe-delimited. \nThey may be uncompressed, gzipped or zipped if the archive contains a single file. \n\nThis endpoint returns two URIs which must be used to complete the import. \nThe `uploadUri` is used to upload the file you wish to import. By default it expects the file contents \nin the body of a PUT request. Some examples of this usage are:\n\n* Python requests:\n\n ```\n requests.put(, data=open('', 'rb'))\n ```\n* curl:\n\n ```\n curl --request PUT --upload-file \n ```\n\nIf you set `multipart: true`, `uploadUri` will expect a `multipart/form-data` POST request \nincluding the attached `uploadFields` plus a `file` field (in this order):\n\n* Browser (AJAX form submission):\n\n ```\n var data = new FormData();\n _.each(, (value, field) => data.append(field, value));\n data.append(\"file\", fileInput.files[0]);\n request.post(, { body: data });\n ```\n\nOnce the upload is complete, the `runUri` field may then be used to \ncomplete the import of the uploaded tabular file.","deprecated":false,"parameters":[{"name":"Object279","in":"body","schema":{"$ref":"#/definitions/Object279"},"required":true}],"responses":{"201":{"description":"success","schema":{"$ref":"#/definitions/Object280"}}},"x-examples":[{"resource":"Imports","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/imports/files","description":"Initiating a file uploading","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/imports/files","request_body":"{\n \"schema\": \"table_schema\",\n \"name\": \"table_name\",\n \"distkey\": \"distkey\",\n \"sortkey1\": \"sort_1\",\n \"sortkey2\": \"sort_2\",\n \"existing_table_rows\": \"append\",\n \"remote_host_id\": 309,\n \"credential_id\": 616\n}","request_headers":{"Content-Type":"application/json","Authorization":"Bearer j6E6Vjb0dRVr2yPKgICZuPc8BUuxQegeL8yxaP64i94","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":201,"response_status_text":"Created","response_body":"{\n \"id\": 2003,\n \"uploadUri\": \"upload_uri\",\n \"runUri\": \"http://api.civis.test/imports/files/2003/runs\",\n \"uploadFields\": {\n }\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"f341c72b876dc30aaaf9a0f5825d7086\"","X-Request-Id":"upload_key","X-Runtime":"0.140196","Content-Length":"111"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/imports/files\" -d '{\"schema\":\"table_schema\",\"name\":\"table_name\",\"distkey\":\"distkey\",\"sortkey1\":\"sort_1\",\"sortkey2\":\"sort_2\",\"existing_table_rows\":\"append\",\"remote_host_id\":309,\"credential_id\":616}' -X POST \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer j6E6Vjb0dRVr2yPKgICZuPc8BUuxQegeL8yxaP64i94\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Imports","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/imports/files","description":"Initiating a multipart file uploading","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/imports/files","request_body":"{\n \"schema\": \"table_schema\",\n \"name\": \"table_name\",\n \"distkey\": \"distkey\",\n \"sortkey1\": \"sort_1\",\n \"sortkey2\": \"sort_2\",\n \"existing_table_rows\": \"append\",\n \"remote_host_id\": 310,\n \"credential_id\": 619,\n \"multipart\": true\n}","request_headers":{"Content-Type":"application/json","Authorization":"Bearer HW4pssfccePALY1hpLORMFP8k_FV7q1hCc8_RbVV-9o","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":201,"response_status_text":"Created","response_body":"{\n \"id\": 2005,\n \"uploadUri\": \"upload_uri\",\n \"runUri\": \"http://api.civis.test/imports/files/2005/runs\",\n \"uploadFields\": {\n \"aws_field1\": \"foo\",\n \"aws_field2\": \"bar\"\n }\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"e6a5ce26e5cc5967d27bdd14b5cecfbe\"","X-Request-Id":"upload_key","X-Runtime":"0.153413","Content-Length":"148"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/imports/files\" -d '{\"schema\":\"table_schema\",\"name\":\"table_name\",\"distkey\":\"distkey\",\"sortkey1\":\"sort_1\",\"sortkey2\":\"sort_2\",\"existing_table_rows\":\"append\",\"remote_host_id\":310,\"credential_id\":619,\"multipart\":true}' -X POST \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer HW4pssfccePALY1hpLORMFP8k_FV7q1hCc8_RbVV-9o\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/imports/files/{id}/runs":{"post":{"summary":"Start a run","description":"Start a run and provide a URI for checking its status. The response will provide a 'Location' header which will contain a URI which may be polled to monitor the status of the run.","deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Import job.","type":"integer"}],"responses":{"202":{"description":"success","schema":{"$ref":"#/definitions/Object281"}}},"x-examples":null,"x-deprecation-warning":null},"get":{"summary":"List runs for the given Import job","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Import job.","type":"integer"},{"name":"limit","in":"query","required":false,"description":"Number of results to return. Defaults to 20. Maximum allowed is 100.","type":"integer"},{"name":"page_num","in":"query","required":false,"description":"Page number of the results to return. Defaults to the first page, 1.","type":"integer"},{"name":"order","in":"query","required":false,"description":"The field on which to order the result set. Defaults to id. Must be one of: id.","type":"string"},{"name":"order_dir","in":"query","required":false,"description":"Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc.","type":"string"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object281"}}}},"x-examples":null,"x-deprecation-warning":null}},"/imports/files/{id}/runs/{run_id}":{"get":{"summary":"Check status of a run","description":"View the status of a run. This endpoint may be polled to monitor the status of the run. When the 'state' field is no longer 'queued' or 'running' the run has reached its final state.","deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Import job.","type":"integer"},{"name":"run_id","in":"path","required":true,"description":"The ID of the run.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object281"}}},"x-examples":null,"x-deprecation-warning":null},"delete":{"summary":"Cancel a run","description":"Cancel a currently active run.","deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Import job.","type":"integer"},{"name":"run_id","in":"path","required":true,"description":"The ID of the run.","type":"integer"}],"responses":{"202":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/imports/files/{id}/runs/{run_id}/logs":{"get":{"summary":"Get the logs for a run","description":"Get the logs for a run.","deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Import job.","type":"integer"},{"name":"run_id","in":"path","required":true,"description":"The ID of the run.","type":"integer"},{"name":"last_id","in":"query","required":false,"description":"The ID of the last log message received. Log entries with this ID value or lower will be omitted.Logs are sorted by ID if this value is provided, and are otherwise sorted by createdAt.","type":"integer"},{"name":"limit","in":"query","required":false,"description":"The maximum number of log messages to return. Default of 10000.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object116"}}}},"x-examples":null,"x-deprecation-warning":null}},"/imports/{id}/runs/{run_id}/logs":{"get":{"summary":"Get the logs for a run","description":"Get the logs for a run.","deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the import job.","type":"integer"},{"name":"run_id","in":"path","required":true,"description":"The ID of the run.","type":"integer"},{"name":"last_id","in":"query","required":false,"description":"The ID of the last log message received. Log entries with this ID value or lower will be omitted.Logs are sorted by ID if this value is provided, and are otherwise sorted by createdAt.","type":"integer"},{"name":"limit","in":"query","required":false,"description":"The maximum number of log messages to return. Default of 10000.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object116"}}}},"x-examples":null,"x-deprecation-warning":null}},"/imports/files/csv":{"post":{"summary":"Create a CSV Import","description":null,"deprecated":false,"parameters":[{"name":"Object282","in":"body","schema":{"$ref":"#/definitions/Object282"},"required":true}],"responses":{"201":{"description":"success","schema":{"$ref":"#/definitions/Object288"}}},"x-examples":[{"resource":"Imports","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/imports/files/csv","description":"Create a CSV file import with Civis file source","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/imports/files/csv","request_body":"{\n \"source\": {\n \"file_ids\": [\n 46\n ]\n },\n \"destination\": {\n \"schema\": \"public\",\n \"table\": \"muppets\",\n \"remote_host_id\": 311,\n \"credential_id\": 622,\n \"primary_keys\": [\n \"muppet_name\"\n ],\n \"last_modified_keys\": [\n \"species\"\n ]\n },\n \"first_row_is_header\": true,\n \"max_errors\": 42,\n \"loosen_types\": true,\n \"redshift_destination_options\": {\n \"distkey\": \"species\",\n \"sortkeys\": [\n \"muppet_name\"\n ]\n },\n \"table_columns\": [\n {\n \"name\": \"muppet_name\",\n \"sql_type\": \"varchar(30)\"\n },\n {\n \"name\": \"species\",\n \"sql_type\": null\n }\n ]\n}","request_headers":{"Content-Type":"application/json","Authorization":"Bearer TRs17wuHhGfrucWLCMoKFY7LnRlJP9ZiQpeOtrnDWnY","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":201,"response_status_text":"Created","response_body":"{\n \"id\": 2007,\n \"name\": \"CSV Import #2007\",\n \"source\": {\n \"fileIds\": [\n 46\n ],\n \"storagePath\": {\n \"storageHostId\": null,\n \"credentialId\": null,\n \"filePaths\": [\n\n ]\n }\n },\n \"destination\": {\n \"schema\": \"public\",\n \"table\": \"muppets\",\n \"remoteHostId\": 311,\n \"credentialId\": 622,\n \"primaryKeys\": [\n \"muppet_name\"\n ],\n \"lastModifiedKeys\": [\n \"species\"\n ]\n },\n \"firstRowIsHeader\": true,\n \"columnDelimiter\": \"comma\",\n \"escaped\": false,\n \"compression\": \"none\",\n \"existingTableRows\": \"fail\",\n \"maxErrors\": 42,\n \"tableColumns\": [\n {\n \"name\": \"muppet_name\",\n \"sqlType\": \"varchar(30)\"\n },\n {\n \"name\": \"species\",\n \"sqlType\": null\n }\n ],\n \"loosenTypes\": true,\n \"execution\": \"delayed\",\n \"redshiftDestinationOptions\": {\n \"diststyle\": \"key\",\n \"distkey\": \"species\",\n \"sortkeys\": [\n \"muppet_name\"\n ]\n },\n \"hidden\": false,\n \"myPermissionLevel\": \"manage\"\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"91fc3eac3ca09af7dfec4c9ae27dc14a\"","X-Request-Id":"da67d8e2-4fb0-46db-9617-82f128c1d0ce","X-Runtime":"0.137674","Content-Length":"694"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/imports/files/csv\" -d '{\"source\":{\"file_ids\":[46]},\"destination\":{\"schema\":\"public\",\"table\":\"muppets\",\"remote_host_id\":311,\"credential_id\":622,\"primary_keys\":[\"muppet_name\"],\"last_modified_keys\":[\"species\"]},\"first_row_is_header\":true,\"max_errors\":42,\"loosen_types\":true,\"redshift_destination_options\":{\"distkey\":\"species\",\"sortkeys\":[\"muppet_name\"]},\"table_columns\":[{\"name\":\"muppet_name\",\"sql_type\":\"varchar(30)\"},{\"name\":\"species\",\"sql_type\":null}]}' -X POST \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer TRs17wuHhGfrucWLCMoKFY7LnRlJP9ZiQpeOtrnDWnY\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Imports","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/imports/files/csv","description":"Create a CSV file import with storage source","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/imports/files/csv","request_body":"{\n \"source\": {\n \"storage_path\": {\n \"storage_host_id\": 312,\n \"credential_id\": 624,\n \"file_paths\": [\n \"test_path/muppets.csv\"\n ]\n }\n },\n \"destination\": {\n \"schema\": \"public\",\n \"table\": \"muppets\",\n \"remote_host_id\": 313,\n \"credential_id\": 626,\n \"primary_keys\": [\n \"muppet_name\"\n ],\n \"last_modified_keys\": [\n \"species\"\n ]\n },\n \"first_row_is_header\": true,\n \"max_errors\": 42,\n \"redshift_destination_options\": {\n \"distkey\": \"species\",\n \"sortkeys\": [\n \"muppet_name\"\n ]\n },\n \"table_columns\": [\n {\n \"name\": \"muppet_name\",\n \"sql_type\": \"varchar(30)\"\n },\n {\n \"name\": \"species\",\n \"sql_type\": null\n }\n ]\n}","request_headers":{"Content-Type":"application/json","Authorization":"Bearer 1Rj74avQr8ccy7pmUjq4U3ieWYpnQvGGhmt83s_fXh0","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":201,"response_status_text":"Created","response_body":"{\n \"id\": 2008,\n \"name\": \"CSV Import #2008\",\n \"source\": {\n \"fileIds\": [\n\n ],\n \"storagePath\": {\n \"storageHostId\": 312,\n \"credentialId\": 624,\n \"filePaths\": [\n \"test_path/muppets.csv\"\n ]\n }\n },\n \"destination\": {\n \"schema\": \"public\",\n \"table\": \"muppets\",\n \"remoteHostId\": 313,\n \"credentialId\": 626,\n \"primaryKeys\": [\n \"muppet_name\"\n ],\n \"lastModifiedKeys\": [\n \"species\"\n ]\n },\n \"firstRowIsHeader\": true,\n \"columnDelimiter\": \"comma\",\n \"escaped\": false,\n \"compression\": \"none\",\n \"existingTableRows\": \"fail\",\n \"maxErrors\": 42,\n \"tableColumns\": [\n {\n \"name\": \"muppet_name\",\n \"sqlType\": \"varchar(30)\"\n },\n {\n \"name\": \"species\",\n \"sqlType\": null\n }\n ],\n \"loosenTypes\": false,\n \"execution\": \"delayed\",\n \"redshiftDestinationOptions\": {\n \"diststyle\": \"key\",\n \"distkey\": \"species\",\n \"sortkeys\": [\n \"muppet_name\"\n ]\n },\n \"hidden\": false,\n \"myPermissionLevel\": \"manage\"\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"684a1f99ba0c0c61c976354363cefed3\"","X-Request-Id":"262678f8-be17-403f-877d-892cf1b1fbd2","X-Runtime":"0.142158","Content-Length":"714"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/imports/files/csv\" -d '{\"source\":{\"storage_path\":{\"storage_host_id\":312,\"credential_id\":624,\"file_paths\":[\"test_path/muppets.csv\"]}},\"destination\":{\"schema\":\"public\",\"table\":\"muppets\",\"remote_host_id\":313,\"credential_id\":626,\"primary_keys\":[\"muppet_name\"],\"last_modified_keys\":[\"species\"]},\"first_row_is_header\":true,\"max_errors\":42,\"redshift_destination_options\":{\"distkey\":\"species\",\"sortkeys\":[\"muppet_name\"]},\"table_columns\":[{\"name\":\"muppet_name\",\"sql_type\":\"varchar(30)\"},{\"name\":\"species\",\"sql_type\":null}]}' -X POST \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer 1Rj74avQr8ccy7pmUjq4U3ieWYpnQvGGhmt83s_fXh0\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/imports/files/csv/{id}":{"get":{"summary":"Get a CSV Import","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object288"}}},"x-examples":null,"x-deprecation-warning":null},"put":{"summary":"Replace all attributes of this CSV Import","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID for the import.","type":"integer"},{"name":"Object294","in":"body","schema":{"$ref":"#/definitions/Object294"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object288"}}},"x-examples":null,"x-deprecation-warning":null},"patch":{"summary":"Update some attributes of this CSV Import","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID for the import.","type":"integer"},{"name":"Object295","in":"body","schema":{"$ref":"#/definitions/Object295"},"required":false}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object288"}}},"x-examples":[{"resource":"Imports","resource_explanation":null,"http_method":"PATCH","route":"http://api.civis.test/imports/files/csv/:id","description":"Update a CSV file import","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"PATCH","request_path":"http://api.civis.test/imports/files/csv/2011","request_body":"{\n \"table_columns\": [\n {\n \"name\": \"muppet_name\",\n \"sql_type\": \"varchar(30)\"\n },\n {\n \"name\": \"species\",\n \"sql_type\": null\n },\n {\n \"name\": \"performer\",\n \"sql_type\": \"varchar(30)\"\n }\n ],\n \"existing_table_rows\": \"drop\"\n}","request_headers":{"Content-Type":"application/json","Authorization":"Bearer uDlK78qJw-s9Q0kWVmxspuLBwH2K9oCXyC7FCyODTIw","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 2011,\n \"name\": \"CSV Import #2011\",\n \"source\": {\n \"fileIds\": [\n 49\n ],\n \"storagePath\": {\n \"storageHostId\": null,\n \"credentialId\": null,\n \"filePaths\": [\n\n ]\n }\n },\n \"destination\": {\n \"schema\": \"my_schema\",\n \"table\": \"my_table\",\n \"remoteHostId\": 314,\n \"credentialId\": 629,\n \"primaryKeys\": [\n\n ],\n \"lastModifiedKeys\": [\n\n ]\n },\n \"firstRowIsHeader\": true,\n \"columnDelimiter\": \"comma\",\n \"escaped\": false,\n \"compression\": \"gzip\",\n \"existingTableRows\": \"drop\",\n \"maxErrors\": null,\n \"tableColumns\": [\n {\n \"name\": \"muppet_name\",\n \"sqlType\": \"varchar(30)\"\n },\n {\n \"name\": \"species\",\n \"sqlType\": null\n },\n {\n \"name\": \"performer\",\n \"sqlType\": \"varchar(30)\"\n }\n ],\n \"loosenTypes\": false,\n \"execution\": \"delayed\",\n \"redshiftDestinationOptions\": {\n \"diststyle\": \"key\",\n \"distkey\": \"mydist\",\n \"sortkeys\": [\n \"mysort\",\n \"anothersort\"\n ]\n },\n \"hidden\": false,\n \"myPermissionLevel\": \"manage\"\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"4a9d346477628ff80df3625bf412ffde\"","X-Request-Id":"00a41806-48a3-428d-adb5-0e0b8f335e80","X-Runtime":"0.203203","Content-Length":"732"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/imports/files/csv/2011\" -d '{\"table_columns\":[{\"name\":\"muppet_name\",\"sql_type\":\"varchar(30)\"},{\"name\":\"species\",\"sql_type\":null},{\"name\":\"performer\",\"sql_type\":\"varchar(30)\"}],\"existing_table_rows\":\"drop\"}' -X PATCH \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer uDlK78qJw-s9Q0kWVmxspuLBwH2K9oCXyC7FCyODTIw\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"delete":{"summary":"Archive a CSV Import (deprecated, use archiving endpoints instead)","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/imports/files/csv/{id}/archive":{"put":{"summary":"Update the archive status of this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the object.","type":"integer"},{"name":"Object298","in":"body","schema":{"$ref":"#/definitions/Object298"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object288"}}},"x-examples":null,"x-deprecation-warning":null}},"/imports/files/csv/{id}/runs":{"post":{"summary":"Start a run","description":"Start a run and provide a URI for checking its status. The response will provide a 'Location' header which will contain a URI which may be polled to monitor the status of the run.","deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the CSV Import job.","type":"integer"}],"responses":{"202":{"description":"success","schema":{"$ref":"#/definitions/Object299"}}},"x-examples":[{"resource":"Imports","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/imports/files/csv/:id/runs","description":"Run an import","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/imports/files/csv/2014/runs","request_body":null,"request_headers":{"Content-Type":"application/json","Authorization":"Bearer NuyT3qm53MbOjSMNU9pcwOkX2JVcEFDTzLyagZNhecU","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":202,"response_status_text":"Accepted","response_body":"{\n \"id\": 215,\n \"csvImportId\": 2014,\n \"state\": \"queued\",\n \"isCancelRequested\": false,\n \"createdAt\": \"2023-07-18T18:42:40.000Z\",\n \"startedAt\": null,\n \"finishedAt\": null,\n \"error\": null\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","Location":"http://api.civis.test/imports/files/csv/2014/runs/215","Content-Type":"application/json; charset=utf-8","X-Request-Id":"f08a8bcb-7093-4c7d-ad28-55734793f1b9","X-Runtime":"0.179308","Content-Length":"159"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/imports/files/csv/2014/runs\" -d '' -X POST \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer NuyT3qm53MbOjSMNU9pcwOkX2JVcEFDTzLyagZNhecU\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"get":{"summary":"List runs for the given CSV Import job","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the CSV Import job.","type":"integer"},{"name":"limit","in":"query","required":false,"description":"Number of results to return. Defaults to 20. Maximum allowed is 100.","type":"integer"},{"name":"page_num","in":"query","required":false,"description":"Page number of the results to return. Defaults to the first page, 1.","type":"integer"},{"name":"order","in":"query","required":false,"description":"The field on which to order the result set. Defaults to id. Must be one of: id.","type":"string"},{"name":"order_dir","in":"query","required":false,"description":"Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc.","type":"string"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object299"}}}},"x-examples":[{"resource":"Imports","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/imports/files/csv/:id/runs","description":"View an import's run history","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/imports/files/csv/2017/runs","request_body":null,"request_headers":{"Content-Type":"application/json","Authorization":"Bearer hVLFkMrpdTCPJdOOItAUaLN5WiHudjb3rc9kkcORA7Q","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 217,\n \"csvImportId\": 2017,\n \"state\": \"succeeded\",\n \"isCancelRequested\": false,\n \"createdAt\": \"2023-07-18T18:42:40.000Z\",\n \"startedAt\": \"2023-07-18T18:41:40.000Z\",\n \"finishedAt\": \"2023-07-18T19:42:40.000Z\",\n \"error\": null\n },\n {\n \"id\": 216,\n \"csvImportId\": 2017,\n \"state\": \"succeeded\",\n \"isCancelRequested\": false,\n \"createdAt\": \"2023-07-18T18:42:40.000Z\",\n \"startedAt\": \"2023-07-18T18:41:40.000Z\",\n \"finishedAt\": \"2023-07-18T18:42:40.000Z\",\n \"error\": null\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","X-Pagination-Per-Page":"20","Access-Control-Expose-Headers":"X-Pagination-Per-Page, X-Pagination-Current-Page, X-Pagination-Total-Pages, X-Pagination-Total-Entries","X-Pagination-Current-Page":"1","X-Pagination-Total-Pages":"1","X-Pagination-Total-Entries":"2","Content-Type":"application/json; charset=utf-8","ETag":"W/\"5a012fc44457ff036c5c70863307476d\"","X-Request-Id":"c62850a9-5a5a-45c2-a206-c7a4c8a79c52","X-Runtime":"0.022337","Content-Length":"415"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/imports/files/csv/2017/runs\" -X GET \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer hVLFkMrpdTCPJdOOItAUaLN5WiHudjb3rc9kkcORA7Q\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/imports/files/csv/{id}/runs/{run_id}":{"get":{"summary":"Check status of a run","description":"View the status of a run. This endpoint may be polled to monitor the status of the run. When the 'state' field is no longer 'queued' or 'running' the run has reached its final state.","deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the CSV Import job.","type":"integer"},{"name":"run_id","in":"path","required":true,"description":"The ID of the run.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object299"}}},"x-examples":null,"x-deprecation-warning":null},"delete":{"summary":"Cancel a run","description":"Cancel a currently active run.","deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the CSV Import job.","type":"integer"},{"name":"run_id","in":"path","required":true,"description":"The ID of the run.","type":"integer"}],"responses":{"202":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/imports/files/csv/{id}/runs/{run_id}/logs":{"get":{"summary":"Get the logs for a run","description":"Get the logs for a run.","deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the CSV Import job.","type":"integer"},{"name":"run_id","in":"path","required":true,"description":"The ID of the run.","type":"integer"},{"name":"last_id","in":"query","required":false,"description":"The ID of the last log message received. Log entries with this ID value or lower will be omitted.Logs are sorted by ID if this value is provided, and are otherwise sorted by createdAt.","type":"integer"},{"name":"limit","in":"query","required":false,"description":"The maximum number of log messages to return. Default of 10000.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object116"}}}},"x-examples":null,"x-deprecation-warning":null}},"/imports/batches":{"get":{"summary":"List batch imports","description":null,"deprecated":false,"parameters":[{"name":"hidden","in":"query","required":false,"description":"If specified to be true, returns hidden items. Defaults to false, returning non-hidden items.","type":"boolean"},{"name":"limit","in":"query","required":false,"description":"Number of results to return. Defaults to 20. Maximum allowed is 50.","type":"integer"},{"name":"page_num","in":"query","required":false,"description":"Page number of the results to return. Defaults to the first page, 1.","type":"integer"},{"name":"order","in":"query","required":false,"description":"The field on which to order the result set. Defaults to updated_at. Must be one of: updated_at, created_at.","type":"string"},{"name":"order_dir","in":"query","required":false,"description":"Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc.","type":"string"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object300"}}}},"x-examples":[{"resource":"Imports","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/imports/batches","description":"List all batch imports for a user","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/imports/batches","request_body":null,"request_headers":{"Content-Type":"application/json","Authorization":"Bearer gp__VtsP2dYc_F8aBEoCr97BwaLpkDh6x6BJLW6u6ro","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 2023,\n \"schema\": \"my_schema\",\n \"table\": \"my_table\",\n \"remoteHostId\": 318,\n \"state\": \"running\",\n \"startedAt\": null,\n \"finishedAt\": null,\n \"error\": null\n },\n {\n \"id\": 2020,\n \"schema\": \"my_schema\",\n \"table\": \"my_table\",\n \"remoteHostId\": 317,\n \"state\": \"running\",\n \"startedAt\": null,\n \"finishedAt\": null,\n \"error\": null\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","X-Pagination-Per-Page":"20","Access-Control-Expose-Headers":"X-Pagination-Per-Page, X-Pagination-Current-Page, X-Pagination-Total-Pages, X-Pagination-Total-Entries","X-Pagination-Current-Page":"1","X-Pagination-Total-Pages":"1","X-Pagination-Total-Entries":"2","Content-Type":"application/json; charset=utf-8","ETag":"W/\"701d77507e8d92b95b353c63cb1c3049\"","X-Request-Id":"904e81ec-8773-47e8-8c7a-135748be830e","X-Runtime":"0.019508","Content-Length":"275"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/imports/batches\" -X GET \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer gp__VtsP2dYc_F8aBEoCr97BwaLpkDh6x6BJLW6u6ro\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"post":{"summary":"Upload multiple files to Civis","description":"This endpoint allows multiple files to be imported into a database table. This will create a job and queue it. You can use the `id` returned to query `GET /imports/batches/:id` to check the job status.","deprecated":false,"parameters":[{"name":"Object302","in":"body","schema":{"$ref":"#/definitions/Object302"},"required":true}],"responses":{"201":{"description":"success","schema":{"$ref":"#/definitions/Object301"}}},"x-examples":[{"resource":"Imports","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/imports/batches","description":"Import 2 files","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/imports/batches","request_body":"{\n \"file_ids\": [\n 57,\n 58\n ],\n \"schema\": \"schema\",\n \"table\": \"table\",\n \"remote_host_id\": 321,\n \"credential_id\": 648\n}","request_headers":{"Content-Type":"application/json","Authorization":"Bearer vb1qpt81nyH3oZq-BFxgiWzZchlFTa_oqUshDUhYJ6M","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":201,"response_status_text":"Created","response_body":"{\n \"id\": 2030,\n \"schema\": \"schema\",\n \"table\": \"table\",\n \"remoteHostId\": 321,\n \"state\": \"queued\",\n \"startedAt\": null,\n \"finishedAt\": null,\n \"error\": null,\n \"hidden\": false\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"01429fe6a2d33c046b0ba227db3e5aac\"","X-Request-Id":"de58e311-e55f-4cd9-adbc-c377004afb28","X-Runtime":"0.148157","Content-Length":"144"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/imports/batches\" -d '{\"file_ids\":[57,58],\"schema\":\"schema\",\"table\":\"table\",\"remote_host_id\":321,\"credential_id\":648}' -X POST \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer vb1qpt81nyH3oZq-BFxgiWzZchlFTa_oqUshDUhYJ6M\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/imports/batches/{id}":{"get":{"summary":"Get details about a batch import","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID for the import.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object301"}}},"x-examples":[{"resource":"Imports","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/imports/batches/:id","description":"View a batch import","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/imports/batches/2026","request_body":null,"request_headers":{"Content-Type":"application/json","Authorization":"Bearer Jpwtxf-KqMexVfyLe5WL9Aw8hm9-SLmvnmtJwDL0W7k","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 2026,\n \"schema\": \"my_schema\",\n \"table\": \"my_table\",\n \"remoteHostId\": 319,\n \"state\": \"running\",\n \"startedAt\": null,\n \"finishedAt\": null,\n \"error\": null,\n \"hidden\": false\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"6e2a4f7586d5ef3c762dd6964cf96429\"","X-Request-Id":"a1540f50-a18c-478c-b577-5ca42b683ecd","X-Runtime":"0.018265","Content-Length":"151"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/imports/batches/2026\" -X GET \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer Jpwtxf-KqMexVfyLe5WL9Aw8hm9-SLmvnmtJwDL0W7k\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/imports/{id}":{"get":{"summary":"Get details about an import","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID for the import.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object265"}}},"x-examples":[{"resource":"Imports","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/imports/:id","description":"View an import","explanation":null,"parameters":[{"required":true,"name":"id","description":"The ID for the import."}],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/imports/1904","request_body":null,"request_headers":{"Content-Type":"application/json","Authorization":"Bearer 4-pbi18GNMPPt-T9lS2RfCMqkXbudHtrEvIjhw8eFUs","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"name\": \"Import #1904\",\n \"syncType\": \"Dbsync\",\n \"source\": {\n \"remoteHostId\": 261,\n \"credentialId\": 508,\n \"additionalCredentials\": [\n\n ],\n \"name\": \"redshift-10179\"\n },\n \"destination\": {\n \"remoteHostId\": 262,\n \"credentialId\": 510,\n \"additionalCredentials\": [\n\n ],\n \"name\": \"redshift-10180\"\n },\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n },\n \"notifications\": {\n \"urls\": [\n\n ],\n \"successEmailSubject\": null,\n \"successEmailBody\": null,\n \"successEmailAddresses\": [\n\n ],\n \"successEmailFromName\": null,\n \"successEmailReplyTo\": null,\n \"failureEmailAddresses\": [\n\n ],\n \"stallWarningMinutes\": null,\n \"successOn\": true,\n \"failureOn\": true\n },\n \"parentId\": null,\n \"id\": 1904,\n \"isOutbound\": false,\n \"jobType\": \"JobTypes::Import\",\n \"syncs\": [\n\n ],\n \"state\": \"idle\",\n \"createdAt\": \"2023-07-18T18:42:30.000Z\",\n \"updatedAt\": \"2023-07-18T18:42:30.000Z\",\n \"lastRun\": null,\n \"user\": {\n \"id\": 2226,\n \"name\": \"User devuserfactory1662 1660\",\n \"username\": \"devuserfactory1662\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"runningAs\": {\n \"id\": 2226,\n \"name\": \"User devuserfactory1662 1660\",\n \"username\": \"devuserfactory1662\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"nextRunAt\": null,\n \"timeZone\": \"America/Chicago\",\n \"hidden\": false,\n \"archived\": false,\n \"myPermissionLevel\": \"manage\"\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"ebba0f53c99c141e62d7269efd475de5\"","X-Request-Id":"d3619b6f-2eaa-4c6d-9a40-ff4daa9e53e5","X-Runtime":"0.025016","Content-Length":"1185"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/imports/1904\" -X GET \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer 4-pbi18GNMPPt-T9lS2RfCMqkXbudHtrEvIjhw8eFUs\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"put":{"summary":"Update an import","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID for the import.","type":"integer"},{"name":"Object303","in":"body","schema":{"$ref":"#/definitions/Object303"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object265"}}},"x-examples":[{"resource":"Imports","resource_explanation":null,"http_method":"PUT","route":"http://api.civis.test/imports/:id","description":"Update an import via PUT","explanation":null,"parameters":[{"required":true,"name":"name","description":"The name of the import."},{"required":true,"name":"syncType","description":"The type of sync to perform; one of Dbsync, AutoImport, GdocImport, and GdocExport."},{"required":false,"name":"source","description":"The data source from which to import."},{"required":false,"name":"destination","description":"The database into which to import."},{"required":false,"name":"schedule","description":"The schedule when the import will run."},{"required":false,"name":"notifications","description":"The notifications to send after the script is run."},{"required":false,"name":"parentId","description":"Parent id to trigger this import from"},{"required":false,"name":"id","description":"The ID for the import."},{"required":true,"name":"isOutbound","description":"is_outbound"},{"required":false,"name":"nextRunAt","description":"The time of the next scheduled run."},{"required":false,"name":"timeZone","description":"The time zone of this import."}],"response_fields":[],"requests":[{"request_method":"PUT","request_path":"http://api.civis.test/imports/1908","request_body":"{\n \"name\": \"Import #1908wee\",\n \"sync_type\": \"Dbsync\",\n \"is_outbound\": false,\n \"source\": {\n \"remoteHostId\": 265,\n \"credentialId\": 517\n },\n \"destination\": {\n \"remoteHostId\": 265,\n \"credentialId\": 517\n },\n \"schedule\": {\n \"scheduled\": true,\n \"scheduledDays\": [\n 1\n ],\n \"scheduledHours\": [\n 0,\n 4\n ],\n \"scheduledMinutes\": [\n 15\n ],\n \"scheduledRunsPerHour\": null\n },\n \"notifications\": {\n \"urls\": [\n \"www.google.com\",\n \"www.bing.com\"\n ],\n \"successEmailSubject\": \"new import subject\",\n \"successEmailBody\": \"new import body\",\n \"successEmailAddresses\": [\n \"new_success_email_1@civisanalytics.com\",\n \"new_success_email_2@civisanalytics.com\"\n ],\n \"failureEmailAddresses\": [\n \"new_failure_email_1@civisanalytics.com\",\n \"new_failure_email_2@civisanalytics.com\"\n ],\n \"stallWarningMinutes\": 15\n }\n}","request_headers":{"Content-Type":"application/json","Authorization":"Bearer 0EITZuQcZBPsL_Jr_VfG-P2pMHHYd3m0cnu__AfPFpM","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"name\": \"Import #1908wee\",\n \"syncType\": \"Dbsync\",\n \"source\": {\n \"remoteHostId\": 265,\n \"credentialId\": 517,\n \"additionalCredentials\": [\n\n ],\n \"name\": \"redshift-10183\"\n },\n \"destination\": {\n \"remoteHostId\": 265,\n \"credentialId\": 517,\n \"additionalCredentials\": [\n\n ],\n \"name\": \"redshift-10183\"\n },\n \"schedule\": {\n \"scheduled\": true,\n \"scheduledDays\": [\n 1\n ],\n \"scheduledHours\": [\n 0,\n 4\n ],\n \"scheduledMinutes\": [\n 15\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n },\n \"notifications\": {\n \"urls\": [\n \"www.google.com\",\n \"www.bing.com\"\n ],\n \"successEmailSubject\": \"new import subject\",\n \"successEmailBody\": \"new import body\",\n \"successEmailAddresses\": [\n \"new_success_email_1@civisanalytics.com\",\n \"new_success_email_2@civisanalytics.com\"\n ],\n \"successEmailFromName\": null,\n \"successEmailReplyTo\": null,\n \"failureEmailAddresses\": [\n \"new_failure_email_1@civisanalytics.com\",\n \"new_failure_email_2@civisanalytics.com\"\n ],\n \"stallWarningMinutes\": 15,\n \"successOn\": true,\n \"failureOn\": true\n },\n \"parentId\": null,\n \"id\": 1908,\n \"isOutbound\": false,\n \"jobType\": \"JobTypes::Import\",\n \"syncs\": [\n\n ],\n \"state\": \"scheduled\",\n \"createdAt\": \"2023-07-18T18:42:31.000Z\",\n \"updatedAt\": \"2023-07-18T18:42:31.000Z\",\n \"lastRun\": null,\n \"user\": {\n \"id\": 2228,\n \"name\": \"User devuserfactory1664 1662\",\n \"username\": \"devuserfactory1664\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"runningAs\": {\n \"id\": 2228,\n \"name\": \"User devuserfactory1664 1662\",\n \"username\": \"devuserfactory1664\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"nextRunAt\": \"2023-07-24T05:15:00.000Z\",\n \"timeZone\": \"America/Chicago\",\n \"hidden\": false,\n \"archived\": false,\n \"myPermissionLevel\": \"manage\"\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"2b5a3e99dca62901378f62d734ddf63e\"","X-Request-Id":"a286bdce-d091-4bc2-84d6-834bd2434901","X-Runtime":"0.119839","Content-Length":"1441"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/imports/1908\" -d '{\"name\":\"Import #1908wee\",\"sync_type\":\"Dbsync\",\"is_outbound\":false,\"source\":{\"remoteHostId\":265,\"credentialId\":517},\"destination\":{\"remoteHostId\":265,\"credentialId\":517},\"schedule\":{\"scheduled\":true,\"scheduledDays\":[1],\"scheduledHours\":[0,4],\"scheduledMinutes\":[15],\"scheduledRunsPerHour\":null},\"notifications\":{\"urls\":[\"www.google.com\",\"www.bing.com\"],\"successEmailSubject\":\"new import subject\",\"successEmailBody\":\"new import body\",\"successEmailAddresses\":[\"new_success_email_1@civisanalytics.com\",\"new_success_email_2@civisanalytics.com\"],\"failureEmailAddresses\":[\"new_failure_email_1@civisanalytics.com\",\"new_failure_email_2@civisanalytics.com\"],\"stallWarningMinutes\":15}}' -X PUT \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer 0EITZuQcZBPsL_Jr_VfG-P2pMHHYd3m0cnu__AfPFpM\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/imports/{id}/runs":{"get":{"summary":"Get the run history of this import","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"type":"integer"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object74"}}}},"x-examples":[{"resource":"Imports","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/imports/:id/runs","description":"View an import's run history","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/imports/1920/runs","request_body":null,"request_headers":{"Content-Type":"application/json","Authorization":"Bearer -6m3WwKkb9r-Lin8WN4hQhwmxdRZ4b1Pzc3_3qIJtGk","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 214,\n \"state\": \"succeeded\",\n \"createdAt\": \"2023-07-18T18:42:32.000Z\",\n \"startedAt\": \"2023-07-18T18:41:32.000Z\",\n \"finishedAt\": \"2023-07-18T19:42:32.000Z\",\n \"error\": null\n },\n {\n \"id\": 213,\n \"state\": \"succeeded\",\n \"createdAt\": \"2023-07-18T18:42:32.000Z\",\n \"startedAt\": \"2023-07-18T18:41:32.000Z\",\n \"finishedAt\": \"2023-07-18T18:42:32.000Z\",\n \"error\": null\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"ae68c575edd4feff1f2562be4fde6169\"","X-Request-Id":"5a977ddc-b3b3-4996-aaff-13bf3f1db14c","X-Runtime":"0.015350","Content-Length":"325"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/imports/1920/runs\" -X GET \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer -6m3WwKkb9r-Lin8WN4hQhwmxdRZ4b1Pzc3_3qIJtGk\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"post":{"summary":"Run an import","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the import to run.","type":"integer"}],"responses":{"202":{"description":"success","schema":{"$ref":"#/definitions/Object304"}}},"x-examples":[{"resource":"Imports","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/imports/:id/runs","description":"Run an import","explanation":null,"parameters":[{"required":true,"name":"id","description":"The ID of the import to run."}],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/imports/1912/runs","request_body":null,"request_headers":{"Content-Type":"application/json","Authorization":"Bearer 3Q8lj3S1j-qK0G9U2KDBd-foEU_M_xLgpPrL-xeVv08","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":202,"response_status_text":"Accepted","response_body":"{\n \"runId\": 211\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","X-Request-Id":"a17ef71e-c4d2-423c-8549-e06367ed81b3","X-Runtime":"0.127383","Content-Length":"13"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/imports/1912/runs\" -d '' -X POST \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer 3Q8lj3S1j-qK0G9U2KDBd-foEU_M_xLgpPrL-xeVv08\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Imports","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/imports/:id/runs","description":"Attempting to queue a running import returns an error","explanation":null,"parameters":[{"required":true,"name":"id","description":"The ID of the import to run."}],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/imports/1916/runs","request_body":null,"request_headers":{"Content-Type":"application/json","Authorization":"Bearer NZykLsrnnOyuBSijXPsWkCwqUQJ0vvkSRPPVjRfS1Dc","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":409,"response_status_text":"Conflict","response_body":"{\n \"error\": \"conflict\",\n \"errorDescription\": \"The import cannot be queued because it is already active.\",\n \"code\": 409\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","X-Request-Id":"c61b9b0a-e864-47d3-8d90-f488f3793420","X-Runtime":"0.015180","Content-Length":"110"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/imports/1916/runs\" -d '' -X POST \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer NZykLsrnnOyuBSijXPsWkCwqUQJ0vvkSRPPVjRfS1Dc\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/imports/{id}/cancel":{"post":{"summary":"Cancel a run","description":"Cancel a run.","deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the job.","type":"integer"}],"responses":{"202":{"description":"success","schema":{"$ref":"#/definitions/Object305"}}},"x-examples":null,"x-deprecation-warning":null}},"/imports/{id}/syncs":{"post":{"summary":"Create a sync","description":"Used to create a new Sync for an Import.","deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"type":"integer"},{"name":"Object306","in":"body","schema":{"$ref":"#/definitions/Object306"},"required":true}],"responses":{"201":{"description":"success","schema":{"$ref":"#/definitions/Object267"}}},"x-examples":[{"resource":"Imports","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/imports/:id/syncs","description":"Create a database sync","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/imports/1924/syncs","request_body":"{\n \"source\": {\n \"databaseTable\": {\n \"schema\": \"test\",\n \"table\": \"table1\"\n }\n },\n \"destination\": {\n \"databaseTable\": {\n \"schema\": \"test2\",\n \"table\": \"table2\"\n }\n }\n}","request_headers":{"Content-Type":"application/json","Authorization":"Bearer TZqGzMU2urhMWtufjyNpqBRRsM84DfMf2OY0SaDP4pE","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":201,"response_status_text":"Created","response_body":"{\n \"id\": 1925,\n \"source\": {\n \"id\": null,\n \"path\": \"\\\"test\\\".\\\"table1\\\"\",\n \"databaseTable\": {\n \"schema\": \"test\",\n \"table\": \"table1\",\n \"useWithoutSchema\": false\n },\n \"file\": null,\n \"googleWorksheet\": null,\n \"salesforce\": null\n },\n \"destination\": {\n \"path\": \"\\\"test2\\\".\\\"table2\\\"\",\n \"databaseTable\": {\n \"schema\": \"test2\",\n \"table\": \"table2\",\n \"useWithoutSchema\": false\n },\n \"googleWorksheet\": null\n },\n \"advancedOptions\": {\n \"maxErrors\": null,\n \"existingTableRows\": null,\n \"diststyle\": null,\n \"distkey\": null,\n \"sortkey1\": null,\n \"sortkey2\": null,\n \"columnDelimiter\": null,\n \"columnOverrides\": {\n },\n \"escaped\": false,\n \"identityColumn\": \"\",\n \"rowChunkSize\": null,\n \"wipeDestinationTable\": false,\n \"truncateLongLines\": false,\n \"invalidCharReplacement\": null,\n \"verifyTableRowCounts\": false,\n \"partitionColumnName\": null,\n \"partitionSchemaName\": null,\n \"partitionTableName\": null,\n \"partitionTablePartitionColumnMinName\": null,\n \"partitionTablePartitionColumnMaxName\": null,\n \"lastModifiedColumn\": null,\n \"mysqlCatalogMatchesSchema\": true,\n \"chunkingMethod\": null,\n \"firstRowIsHeader\": null,\n \"exportAction\": null,\n \"sqlQuery\": null,\n \"contactLists\": null,\n \"soqlQuery\": null,\n \"includeDeletedRecords\": null\n }\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"03372fff5e5bdcc633de84424f8ee823\"","X-Request-Id":"83121ecf-7056-474a-832e-18bc1ad8a431","X-Runtime":"0.061845","Content-Length":"1051"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/imports/1924/syncs\" -d '{\"source\":{\"databaseTable\":{\"schema\":\"test\",\"table\":\"table1\"}},\"destination\":{\"databaseTable\":{\"schema\":\"test2\",\"table\":\"table2\"}}}' -X POST \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer TZqGzMU2urhMWtufjyNpqBRRsM84DfMf2OY0SaDP4pE\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Imports","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/imports/:id/syncs","description":"Specify advanced database options","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/imports/1929/syncs","request_body":"{\n \"source\": {\n \"databaseTable\": {\n \"schema\": \"test\",\n \"table\": \"table1\"\n }\n },\n \"destination\": {\n \"databaseTable\": {\n \"schema\": \"test2\",\n \"table\": \"table2\"\n }\n },\n \"advancedOptions\": {\n \"identityColumn\": \"test\",\n \"rowChunkSize\": 100,\n \"wipeDestinationTable\": true,\n \"truncateLongLines\": false,\n \"verifyTableRowCounts\": true,\n \"partitionColumnName\": \"we\",\n \"partitionSchema_name\": \"are\",\n \"partitionTableName\": \"so\",\n \"partitionTablePartitionColumnMinName\": \"hungry\",\n \"partitionTablePartitionColumnMaxName\": \"today\"\n }\n}","request_headers":{"Content-Type":"application/json","Authorization":"Bearer ykNhBnOUrjIn0fRkhUbIIPzY7fBFLdpOQb7oaLV9N70","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":201,"response_status_text":"Created","response_body":"{\n \"id\": 1930,\n \"source\": {\n \"id\": null,\n \"path\": \"\\\"test\\\".\\\"table1\\\"\",\n \"databaseTable\": {\n \"schema\": \"test\",\n \"table\": \"table1\",\n \"useWithoutSchema\": false\n },\n \"file\": null,\n \"googleWorksheet\": null,\n \"salesforce\": null\n },\n \"destination\": {\n \"path\": \"\\\"test2\\\".\\\"table2\\\"\",\n \"databaseTable\": {\n \"schema\": \"test2\",\n \"table\": \"table2\",\n \"useWithoutSchema\": false\n },\n \"googleWorksheet\": null\n },\n \"advancedOptions\": {\n \"maxErrors\": null,\n \"existingTableRows\": null,\n \"diststyle\": null,\n \"distkey\": null,\n \"sortkey1\": null,\n \"sortkey2\": null,\n \"columnDelimiter\": null,\n \"columnOverrides\": {\n },\n \"escaped\": false,\n \"identityColumn\": \"test\",\n \"rowChunkSize\": 100,\n \"wipeDestinationTable\": true,\n \"truncateLongLines\": false,\n \"invalidCharReplacement\": null,\n \"verifyTableRowCounts\": true,\n \"partitionColumnName\": null,\n \"partitionSchemaName\": null,\n \"partitionTableName\": null,\n \"partitionTablePartitionColumnMinName\": null,\n \"partitionTablePartitionColumnMaxName\": null,\n \"lastModifiedColumn\": null,\n \"mysqlCatalogMatchesSchema\": true,\n \"chunkingMethod\": null,\n \"firstRowIsHeader\": null,\n \"exportAction\": null,\n \"sqlQuery\": null,\n \"contactLists\": null,\n \"soqlQuery\": null,\n \"includeDeletedRecords\": null\n }\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"0000598297e4f7b0dec05e30a4b4f416\"","X-Request-Id":"68b0a794-bb1f-4d0b-ba5e-8c16cf152403","X-Runtime":"0.051519","Content-Length":"1052"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/imports/1929/syncs\" -d '{\"source\":{\"databaseTable\":{\"schema\":\"test\",\"table\":\"table1\"}},\"destination\":{\"databaseTable\":{\"schema\":\"test2\",\"table\":\"table2\"}},\"advancedOptions\":{\"identityColumn\":\"test\",\"rowChunkSize\":100,\"wipeDestinationTable\":true,\"truncateLongLines\":false,\"verifyTableRowCounts\":true,\"partitionColumnName\":\"we\",\"partitionSchema_name\":\"are\",\"partitionTableName\":\"so\",\"partitionTablePartitionColumnMinName\":\"hungry\",\"partitionTablePartitionColumnMaxName\":\"today\"}}' -X POST \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer ykNhBnOUrjIn0fRkhUbIIPzY7fBFLdpOQb7oaLV9N70\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Imports","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/imports/:id/syncs","description":"Specify advanced CSV options","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/imports/1933/syncs","request_body":"{\n \"source\": {\n \"file\": {\n \"id\": 41\n }\n },\n \"destination\": {\n \"databaseTable\": {\n \"schema\": \"test2\",\n \"table\": \"table2\"\n }\n },\n \"advanced_options\": {\n \"existing_table_rows\": \"truncate\",\n \"max_errors\": 10,\n \"distkey\": \"first_name\",\n \"sortkey1\": \"last_name\",\n \"sortkey2\": \"zip\",\n \"column_overrides\": {\n \"0\": {\n \"name\": \"first_name\"\n },\n \"1\": {\n \"name\": \"last_name\",\n \"type\": \"VARCHAR(512)\"\n },\n \"2\": {\n \"type\": \"VARCHAR(64)\"\n }\n }\n }\n}","request_headers":{"Content-Type":"application/json","Authorization":"Bearer xG0HUhOyf0r5C8K2gSHH7K96KDJUYAu_n5oCHGg5oUg","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":201,"response_status_text":"Created","response_body":"{\n \"id\": 1938,\n \"source\": {\n \"id\": 41,\n \"path\": \"fake_name\",\n \"databaseTable\": null,\n \"file\": {\n \"id\": 41\n },\n \"googleWorksheet\": null,\n \"salesforce\": null\n },\n \"destination\": {\n \"path\": \"\\\"test2\\\".\\\"table2\\\"\",\n \"databaseTable\": {\n \"schema\": \"test2\",\n \"table\": \"table2\",\n \"useWithoutSchema\": false\n },\n \"googleWorksheet\": null\n },\n \"advancedOptions\": {\n \"maxErrors\": 10,\n \"existingTableRows\": \"truncate\",\n \"diststyle\": \"\",\n \"distkey\": \"first_name\",\n \"sortkey1\": \"last_name\",\n \"sortkey2\": \"zip\",\n \"columnDelimiter\": null,\n \"columnOverrides\": {\n \"0\": {\n \"name\": \"first_name\"\n },\n \"1\": {\n \"name\": \"last_name\",\n \"type\": \"VARCHAR(512)\"\n },\n \"2\": {\n \"type\": \"VARCHAR(64)\"\n }\n },\n \"escaped\": false,\n \"identityColumn\": null,\n \"rowChunkSize\": null,\n \"wipeDestinationTable\": false,\n \"truncateLongLines\": false,\n \"invalidCharReplacement\": null,\n \"verifyTableRowCounts\": false,\n \"partitionColumnName\": null,\n \"partitionSchemaName\": null,\n \"partitionTableName\": null,\n \"partitionTablePartitionColumnMinName\": null,\n \"partitionTablePartitionColumnMaxName\": null,\n \"lastModifiedColumn\": null,\n \"mysqlCatalogMatchesSchema\": true,\n \"chunkingMethod\": null,\n \"firstRowIsHeader\": null,\n \"exportAction\": null,\n \"sqlQuery\": null,\n \"contactLists\": null,\n \"soqlQuery\": null,\n \"includeDeletedRecords\": null\n }\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"88010f28012145f0be52d9af43629356\"","X-Request-Id":"1d7ee151-0973-46d9-b5e1-65ae4e72caaf","X-Runtime":"0.083074","Content-Length":"1108"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/imports/1933/syncs\" -d '{\"source\":{\"file\":{\"id\":41}},\"destination\":{\"databaseTable\":{\"schema\":\"test2\",\"table\":\"table2\"}},\"advanced_options\":{\"existing_table_rows\":\"truncate\",\"max_errors\":10,\"distkey\":\"first_name\",\"sortkey1\":\"last_name\",\"sortkey2\":\"zip\",\"column_overrides\":{\"0\":{\"name\":\"first_name\"},\"1\":{\"name\":\"last_name\",\"type\":\"VARCHAR(512)\"},\"2\":{\"type\":\"VARCHAR(64)\"}}}}' -X POST \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer xG0HUhOyf0r5C8K2gSHH7K96KDJUYAu_n5oCHGg5oUg\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Imports","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/imports/:id/syncs","description":"Create a Gdoc import","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/imports/1942/syncs","request_body":"{\n \"source\": {\n \"google_worksheet\": {\n \"spreadsheet\": \"my_spreadsheet\",\n \"worksheet\": \"my_worksheet\"\n }\n },\n \"destination\": {\n \"database_table\": {\n \"schema\": \"my_schema\",\n \"table\": \"my_table\"\n }\n }\n}","request_headers":{"Content-Type":"application/json","Authorization":"Bearer cjjkGV74EIOyXgrdQJ4AwE7vhchYjTZrb-YcSSKJqmg","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":201,"response_status_text":"Created","response_body":"{\n \"id\": 1947,\n \"source\": {\n \"id\": 1,\n \"path\": \"\\\"my_spreadsheet\\\".\\\"my_worksheet\\\"\",\n \"databaseTable\": null,\n \"file\": null,\n \"googleWorksheet\": {\n \"spreadsheet\": \"my_spreadsheet\",\n \"spreadsheetId\": null,\n \"worksheet\": \"my_worksheet\",\n \"worksheetId\": null\n },\n \"salesforce\": null\n },\n \"destination\": {\n \"path\": \"\\\"my_schema\\\".\\\"my_table\\\"\",\n \"databaseTable\": {\n \"schema\": \"my_schema\",\n \"table\": \"my_table\",\n \"useWithoutSchema\": false\n },\n \"googleWorksheet\": null\n },\n \"advancedOptions\": {\n \"maxErrors\": null,\n \"existingTableRows\": \"fail\",\n \"diststyle\": null,\n \"distkey\": null,\n \"sortkey1\": null,\n \"sortkey2\": null,\n \"columnDelimiter\": null,\n \"columnOverrides\": {\n },\n \"escaped\": false,\n \"identityColumn\": null,\n \"rowChunkSize\": null,\n \"wipeDestinationTable\": false,\n \"truncateLongLines\": false,\n \"invalidCharReplacement\": null,\n \"verifyTableRowCounts\": false,\n \"partitionColumnName\": null,\n \"partitionSchemaName\": null,\n \"partitionTableName\": null,\n \"partitionTablePartitionColumnMinName\": null,\n \"partitionTablePartitionColumnMaxName\": null,\n \"lastModifiedColumn\": null,\n \"mysqlCatalogMatchesSchema\": true,\n \"chunkingMethod\": null,\n \"firstRowIsHeader\": null,\n \"exportAction\": null,\n \"sqlQuery\": null,\n \"contactLists\": null,\n \"soqlQuery\": null,\n \"includeDeletedRecords\": null\n }\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"9bb2be7fbf1c9165bfe5d982ea5059b1\"","X-Request-Id":"e7c27eba-a35b-4c69-af7e-ac74fe6a2449","X-Runtime":"0.092126","Content-Length":"1120"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/imports/1942/syncs\" -d '{\"source\":{\"google_worksheet\":{\"spreadsheet\":\"my_spreadsheet\",\"worksheet\":\"my_worksheet\"}},\"destination\":{\"database_table\":{\"schema\":\"my_schema\",\"table\":\"my_table\"}}}' -X POST \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer cjjkGV74EIOyXgrdQJ4AwE7vhchYjTZrb-YcSSKJqmg\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Imports","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/imports/:id/syncs","description":"Specify advanced Gdoc import options","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/imports/1951/syncs","request_body":"{\n \"source\": {\n \"google_worksheet\": {\n \"spreadsheet\": \"my_spreadsheet\",\n \"worksheet\": \"my_worksheet\"\n }\n },\n \"destination\": {\n \"database_table\": {\n \"schema\": \"my_schema\",\n \"table\": \"my_table\"\n }\n },\n \"advanced_options\": {\n \"first_row_is_header\": true,\n \"max_errors\": 10,\n \"existing_table_rows\": \"append\"\n }\n}","request_headers":{"Content-Type":"application/json","Authorization":"Bearer OeKA_MlDYFWItQHx6KwrEZwPj0w9HJzh1DzLzdpPOig","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":201,"response_status_text":"Created","response_body":"{\n \"id\": 1956,\n \"source\": {\n \"id\": 2,\n \"path\": \"\\\"my_spreadsheet\\\".\\\"my_worksheet\\\"\",\n \"databaseTable\": null,\n \"file\": null,\n \"googleWorksheet\": {\n \"spreadsheet\": \"my_spreadsheet\",\n \"spreadsheetId\": null,\n \"worksheet\": \"my_worksheet\",\n \"worksheetId\": null\n },\n \"salesforce\": null\n },\n \"destination\": {\n \"path\": \"\\\"my_schema\\\".\\\"my_table\\\"\",\n \"databaseTable\": {\n \"schema\": \"my_schema\",\n \"table\": \"my_table\",\n \"useWithoutSchema\": false\n },\n \"googleWorksheet\": null\n },\n \"advancedOptions\": {\n \"maxErrors\": 10,\n \"existingTableRows\": \"append\",\n \"diststyle\": null,\n \"distkey\": null,\n \"sortkey1\": null,\n \"sortkey2\": null,\n \"columnDelimiter\": null,\n \"columnOverrides\": {\n },\n \"escaped\": false,\n \"identityColumn\": null,\n \"rowChunkSize\": null,\n \"wipeDestinationTable\": false,\n \"truncateLongLines\": false,\n \"invalidCharReplacement\": null,\n \"verifyTableRowCounts\": false,\n \"partitionColumnName\": null,\n \"partitionSchemaName\": null,\n \"partitionTableName\": null,\n \"partitionTablePartitionColumnMinName\": null,\n \"partitionTablePartitionColumnMaxName\": null,\n \"lastModifiedColumn\": null,\n \"mysqlCatalogMatchesSchema\": true,\n \"chunkingMethod\": null,\n \"firstRowIsHeader\": true,\n \"exportAction\": null,\n \"sqlQuery\": null,\n \"contactLists\": null,\n \"soqlQuery\": null,\n \"includeDeletedRecords\": null\n }\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"f468bf128ab686519d1140c822df9200\"","X-Request-Id":"64fe2ae6-fae3-4c36-a23a-dc7217d62e83","X-Runtime":"0.063130","Content-Length":"1120"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/imports/1951/syncs\" -d '{\"source\":{\"google_worksheet\":{\"spreadsheet\":\"my_spreadsheet\",\"worksheet\":\"my_worksheet\"}},\"destination\":{\"database_table\":{\"schema\":\"my_schema\",\"table\":\"my_table\"}},\"advanced_options\":{\"first_row_is_header\":true,\"max_errors\":10,\"existing_table_rows\":\"append\"}}' -X POST \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer OeKA_MlDYFWItQHx6KwrEZwPj0w9HJzh1DzLzdpPOig\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Imports","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/imports/:id/syncs","description":"Create a Gdoc export","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/imports/1960/syncs","request_body":"{\n \"source\": {\n \"database_table\": {\n \"schema\": \"my_schema\",\n \"table\": \"my_table\"\n }\n },\n \"destination\": {\n \"google_worksheet\": {\n \"spreadsheet\": \"my_spreadsheet\",\n \"worksheet\": \"my_worksheet\"\n }\n },\n \"advanced_options\": {\n \"export_action\": \"newwksht\"\n }\n}","request_headers":{"Content-Type":"application/json","Authorization":"Bearer goja3BPHsQLmBNP-m5U_qbrRx2r5A-tiIyT1nnODpCk","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":201,"response_status_text":"Created","response_body":"{\n \"id\": 1965,\n \"source\": {\n \"id\": null,\n \"path\": null,\n \"databaseTable\": null,\n \"file\": null,\n \"googleWorksheet\": null,\n \"salesforce\": null\n },\n \"destination\": {\n \"path\": \"my_spreadsheet.my_worksheet\",\n \"databaseTable\": null,\n \"googleWorksheet\": {\n \"spreadsheet\": \"my_spreadsheet\",\n \"spreadsheetId\": null,\n \"worksheet\": \"my_worksheet\",\n \"worksheetId\": null\n }\n },\n \"advancedOptions\": {\n \"maxErrors\": null,\n \"existingTableRows\": null,\n \"diststyle\": null,\n \"distkey\": null,\n \"sortkey1\": null,\n \"sortkey2\": null,\n \"columnDelimiter\": null,\n \"columnOverrides\": {\n },\n \"escaped\": false,\n \"identityColumn\": null,\n \"rowChunkSize\": null,\n \"wipeDestinationTable\": false,\n \"truncateLongLines\": false,\n \"invalidCharReplacement\": null,\n \"verifyTableRowCounts\": false,\n \"partitionColumnName\": null,\n \"partitionSchemaName\": null,\n \"partitionTableName\": null,\n \"partitionTablePartitionColumnMinName\": null,\n \"partitionTablePartitionColumnMaxName\": null,\n \"lastModifiedColumn\": null,\n \"mysqlCatalogMatchesSchema\": true,\n \"chunkingMethod\": null,\n \"firstRowIsHeader\": null,\n \"exportAction\": \"newwksht\",\n \"sqlQuery\": null,\n \"contactLists\": null,\n \"soqlQuery\": null,\n \"includeDeletedRecords\": null\n }\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"6b2a8e91fd22d7bc3a7b1329d6acc262\"","X-Request-Id":"dee8715f-a184-4622-8c8b-db251aaecea2","X-Runtime":"0.099759","Content-Length":"1033"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/imports/1960/syncs\" -d '{\"source\":{\"database_table\":{\"schema\":\"my_schema\",\"table\":\"my_table\"}},\"destination\":{\"google_worksheet\":{\"spreadsheet\":\"my_spreadsheet\",\"worksheet\":\"my_worksheet\"}},\"advanced_options\":{\"export_action\":\"newwksht\"}}' -X POST \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer goja3BPHsQLmBNP-m5U_qbrRx2r5A-tiIyT1nnODpCk\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Imports","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/imports/:id/syncs","description":"Specify advanced Gdoc export options using query as source","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/imports/1969/syncs","request_body":"{\n \"source\": {},\n \"destination\": {\n \"google_worksheet\": {\n \"spreadsheet\": \"my_spreadsheet\",\n \"worksheet\": \"my_worksheet\"\n }\n },\n \"advanced_options\": {\n \"export_action\": \"newsprsht\",\n \"sql_query\": \"SELECT * from test;\"\n }\n}","request_headers":{"Content-Type":"application/json","Authorization":"Bearer j2O4K38_p3lvyF1WFrTTAGyZf8Ur6SLxoFVh58OKSAI","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":201,"response_status_text":"Created","response_body":"{\n \"id\": 1974,\n \"source\": {\n \"id\": null,\n \"path\": \"SELECT * from test;\",\n \"databaseTable\": null,\n \"file\": null,\n \"googleWorksheet\": null,\n \"salesforce\": null\n },\n \"destination\": {\n \"path\": \"my_spreadsheet.my_worksheet\",\n \"databaseTable\": null,\n \"googleWorksheet\": {\n \"spreadsheet\": \"my_spreadsheet\",\n \"spreadsheetId\": null,\n \"worksheet\": \"my_worksheet\",\n \"worksheetId\": null\n }\n },\n \"advancedOptions\": {\n \"maxErrors\": null,\n \"existingTableRows\": null,\n \"diststyle\": null,\n \"distkey\": null,\n \"sortkey1\": null,\n \"sortkey2\": null,\n \"columnDelimiter\": null,\n \"columnOverrides\": {\n },\n \"escaped\": false,\n \"identityColumn\": null,\n \"rowChunkSize\": null,\n \"wipeDestinationTable\": false,\n \"truncateLongLines\": false,\n \"invalidCharReplacement\": null,\n \"verifyTableRowCounts\": false,\n \"partitionColumnName\": null,\n \"partitionSchemaName\": null,\n \"partitionTableName\": null,\n \"partitionTablePartitionColumnMinName\": null,\n \"partitionTablePartitionColumnMaxName\": null,\n \"lastModifiedColumn\": null,\n \"mysqlCatalogMatchesSchema\": true,\n \"chunkingMethod\": null,\n \"firstRowIsHeader\": null,\n \"exportAction\": \"newsprsht\",\n \"sqlQuery\": \"SELECT * from test;\",\n \"contactLists\": null,\n \"soqlQuery\": null,\n \"includeDeletedRecords\": null\n }\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"f7e57b43514e9043464187a3811a7c3a\"","X-Request-Id":"049c48a8-91d2-41d5-8d5a-e7f9672ad39d","X-Runtime":"0.055821","Content-Length":"1068"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/imports/1969/syncs\" -d '{\"source\":{},\"destination\":{\"google_worksheet\":{\"spreadsheet\":\"my_spreadsheet\",\"worksheet\":\"my_worksheet\"}},\"advanced_options\":{\"export_action\":\"newsprsht\",\"sql_query\":\"SELECT * from test;\"}}' -X POST \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer j2O4K38_p3lvyF1WFrTTAGyZf8Ur6SLxoFVh58OKSAI\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/imports/{id}/syncs/{sync_id}":{"put":{"summary":"Update a sync","description":"Used to update an existing Sync for an Import.","deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the import to fetch.","type":"integer"},{"name":"sync_id","in":"path","required":true,"description":"The ID of the sync to fetch.","type":"integer"},{"name":"Object315","in":"body","schema":{"$ref":"#/definitions/Object315"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object267"}}},"x-examples":[{"resource":"Imports","resource_explanation":null,"http_method":"PUT","route":"http://api.civis.test/imports/:id/syncs/:sync_id","description":"Update a database sync","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"PUT","request_path":"http://api.civis.test/imports/1980/syncs/%3Async_id","request_body":"{\n \"syncId\": 1981,\n \"source\": {\n \"database_table\": {\n \"schema\": \"test\",\n \"table\": \"table1\"\n }\n },\n \"destination\": {\n \"databaseTable\": {\n \"schema\": \"test2\",\n \"table\": \"table2\"\n }\n },\n \"advancedOptions\": {\n \"identityColumn\": \"weak\",\n \"chunkingMethod\": \"sorted_by_identity_columns\",\n \"rowChunkSize\": 100,\n \"wipeDestinationTable\": true,\n \"truncateLongLines\": false,\n \"verifyTableRowCounts\": false,\n \"partitionColumnName\": \"we\",\n \"partitionSchema_name\": \"are\",\n \"partitionTableName\": \"so\",\n \"partitionTablePartitionColumnMinName\": \"hungry\",\n \"partitionTablePartitionColumnMaxName\": \"today\",\n \"lastModifiedColumn\": \"\"\n }\n}","request_headers":{"Content-Type":"application/json","Authorization":"Bearer 6oLoMTv1DSUBADqU-R763tjGidRR9n6X724hAP9_WuM","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 1981,\n \"source\": {\n \"id\": null,\n \"path\": \"\\\"test\\\".\\\"table1\\\"\",\n \"databaseTable\": {\n \"schema\": \"test\",\n \"table\": \"table1\",\n \"useWithoutSchema\": false\n },\n \"file\": null,\n \"googleWorksheet\": null,\n \"salesforce\": null\n },\n \"destination\": {\n \"path\": \"\\\"test2\\\".\\\"table2\\\"\",\n \"databaseTable\": {\n \"schema\": \"test2\",\n \"table\": \"table2\",\n \"useWithoutSchema\": false\n },\n \"googleWorksheet\": null\n },\n \"advancedOptions\": {\n \"maxErrors\": null,\n \"existingTableRows\": null,\n \"diststyle\": null,\n \"distkey\": null,\n \"sortkey1\": null,\n \"sortkey2\": null,\n \"columnDelimiter\": null,\n \"columnOverrides\": {\n },\n \"escaped\": false,\n \"identityColumn\": \"weak\",\n \"rowChunkSize\": 100,\n \"wipeDestinationTable\": true,\n \"truncateLongLines\": false,\n \"invalidCharReplacement\": null,\n \"verifyTableRowCounts\": false,\n \"partitionColumnName\": null,\n \"partitionSchemaName\": null,\n \"partitionTableName\": null,\n \"partitionTablePartitionColumnMinName\": null,\n \"partitionTablePartitionColumnMaxName\": null,\n \"lastModifiedColumn\": \"\",\n \"mysqlCatalogMatchesSchema\": true,\n \"chunkingMethod\": null,\n \"firstRowIsHeader\": null,\n \"exportAction\": null,\n \"sqlQuery\": null,\n \"contactLists\": null,\n \"soqlQuery\": null,\n \"includeDeletedRecords\": null\n }\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"e98005584358916d895abb96d66996ea\"","X-Request-Id":"035a57d3-1fdd-4161-a068-36d84b4f8a1f","X-Runtime":"0.107342","Content-Length":"1051"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/imports/1980/syncs/%3Async_id\" -d '{\"syncId\":1981,\"source\":{\"database_table\":{\"schema\":\"test\",\"table\":\"table1\"}},\"destination\":{\"databaseTable\":{\"schema\":\"test2\",\"table\":\"table2\"}},\"advancedOptions\":{\"identityColumn\":\"weak\",\"chunkingMethod\":\"sorted_by_identity_columns\",\"rowChunkSize\":100,\"wipeDestinationTable\":true,\"truncateLongLines\":false,\"verifyTableRowCounts\":false,\"partitionColumnName\":\"we\",\"partitionSchema_name\":\"are\",\"partitionTableName\":\"so\",\"partitionTablePartitionColumnMinName\":\"hungry\",\"partitionTablePartitionColumnMaxName\":\"today\",\"lastModifiedColumn\":\"\"}}' -X PUT \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer 6oLoMTv1DSUBADqU-R763tjGidRR9n6X724hAP9_WuM\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Imports","resource_explanation":null,"http_method":"PUT","route":"http://api.civis.test/imports/:id/syncs/:sync_id","description":"Update a CSV import","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"PUT","request_path":"http://api.civis.test/imports/1990/syncs/%3Async_id","request_body":"{\n \"syncId\": 1991,\n \"source\": {\n \"file\": {\n \"id\": 43\n }\n },\n \"destination\": {\n \"databaseTable\": {\n \"schema\": \"test2\",\n \"table\": \"table2\"\n }\n },\n \"advancedOptions\": {\n \"existing_table_rows\": \"append\",\n \"max_errors\": 100,\n \"distkey\": \"first_name\",\n \"sortkey1\": \"last_name\",\n \"sortkey2\": \"zip\",\n \"column_delimiter\": \"comma\",\n \"columnOverrides\": {\n \"0\": {\n \"name\": \"first_name\"\n },\n \"1\": {\n \"name\": \"last_name\",\n \"type\": \"VARCHAR(512)\"\n },\n \"2\": {\n \"type\": \"VARCHAR(64)\"\n }\n },\n \"first_row_is_header\": true\n }\n}","request_headers":{"Content-Type":"application/json","Authorization":"Bearer OBepYRq6VUvNz73IWX7z1kUBtxH1bPeqSoSOQ0xMnj8","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 1991,\n \"source\": {\n \"id\": 43,\n \"path\": \"fake_name\",\n \"databaseTable\": null,\n \"file\": {\n \"id\": 43\n },\n \"googleWorksheet\": null,\n \"salesforce\": null\n },\n \"destination\": {\n \"path\": \"\\\"test2\\\".\\\"table2\\\"\",\n \"databaseTable\": {\n \"schema\": \"test2\",\n \"table\": \"table2\",\n \"useWithoutSchema\": false\n },\n \"googleWorksheet\": null\n },\n \"advancedOptions\": {\n \"maxErrors\": 100,\n \"existingTableRows\": \"append\",\n \"diststyle\": \"key\",\n \"distkey\": \"first_name\",\n \"sortkey1\": \"last_name\",\n \"sortkey2\": \"zip\",\n \"columnDelimiter\": \"comma\",\n \"columnOverrides\": {\n \"0\": {\n \"name\": \"first_name\"\n },\n \"1\": {\n \"name\": \"last_name\",\n \"type\": \"VARCHAR(512)\"\n },\n \"2\": {\n \"type\": \"VARCHAR(64)\"\n }\n },\n \"escaped\": false,\n \"identityColumn\": null,\n \"rowChunkSize\": null,\n \"wipeDestinationTable\": false,\n \"truncateLongLines\": false,\n \"invalidCharReplacement\": null,\n \"verifyTableRowCounts\": false,\n \"partitionColumnName\": null,\n \"partitionSchemaName\": null,\n \"partitionTableName\": null,\n \"partitionTablePartitionColumnMinName\": null,\n \"partitionTablePartitionColumnMaxName\": null,\n \"lastModifiedColumn\": null,\n \"mysqlCatalogMatchesSchema\": true,\n \"chunkingMethod\": null,\n \"firstRowIsHeader\": true,\n \"exportAction\": null,\n \"sqlQuery\": null,\n \"contactLists\": null,\n \"soqlQuery\": null,\n \"includeDeletedRecords\": null\n }\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"6f1174623a1550f9428d30f1d92ae3d9\"","X-Request-Id":"656cef77-a8c7-4b2b-bece-b5fff9806440","X-Runtime":"0.087448","Content-Length":"1113"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/imports/1990/syncs/%3Async_id\" -d '{\"syncId\":1991,\"source\":{\"file\":{\"id\":43}},\"destination\":{\"databaseTable\":{\"schema\":\"test2\",\"table\":\"table2\"}},\"advancedOptions\":{\"existing_table_rows\":\"append\",\"max_errors\":100,\"distkey\":\"first_name\",\"sortkey1\":\"last_name\",\"sortkey2\":\"zip\",\"column_delimiter\":\"comma\",\"columnOverrides\":{\"0\":{\"name\":\"first_name\"},\"1\":{\"name\":\"last_name\",\"type\":\"VARCHAR(512)\"},\"2\":{\"type\":\"VARCHAR(64)\"}},\"first_row_is_header\":true}}' -X PUT \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer OBepYRq6VUvNz73IWX7z1kUBtxH1bPeqSoSOQ0xMnj8\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"delete":{"summary":"Archive a sync (deprecated, use the /archive endpoint instead)","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the import to fetch.","type":"integer"},{"name":"sync_id","in":"path","required":true,"description":"The ID of the sync to fetch.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/imports/{id}/syncs/{sync_id}/archive":{"put":{"summary":"Update the archive status of this sync","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the import to fetch.","type":"integer"},{"name":"sync_id","in":"path","required":true,"description":"The ID of the sync to fetch.","type":"integer"},{"name":"Object316","in":"body","schema":{"$ref":"#/definitions/Object316"},"required":false}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object267"}}},"x-examples":null,"x-deprecation-warning":null}},"/jobs/":{"get":{"summary":"List Jobs","description":null,"deprecated":false,"parameters":[{"name":"state","in":"query","required":false,"description":"The job's state. One or more of queued, running, succeeded, failed, and cancelled. Specify multiple values as a comma-separated list (e.g., \"A,B\").","type":"string"},{"name":"type","in":"query","required":false,"description":"The job's type. Specify multiple values as a comma-separated list (e.g., \"A,B\").","type":"string"},{"name":"q","in":"query","required":false,"description":"Query string to search on the id, name, and job type.","type":"string"},{"name":"permission","in":"query","required":false,"description":"A permissions string, one of \"read\", \"write\", or \"manage\". Lists only jobs for which the current user has that permission.","type":"string"},{"name":"scheduled","in":"query","required":false,"description":"If the item is scheduled.","type":"boolean"},{"name":"hidden","in":"query","required":false,"description":"If specified to be true, returns hidden items. Defaults to false, returning non-hidden items.","type":"boolean"},{"name":"archived","in":"query","required":false,"description":"The archival status of the requested item(s).","type":"string"},{"name":"author","in":"query","required":false,"description":"If specified, return items from any of these authors. It accepts a comma-separated list of user IDs.","type":"string"},{"name":"limit","in":"query","required":false,"description":"Number of results to return. Defaults to its maximum of 50.","type":"integer"},{"name":"page_num","in":"query","required":false,"description":"Page number of the results to return. Defaults to the first page, 1.","type":"integer"},{"name":"order","in":"query","required":false,"description":"The field on which to order the result set. Defaults to updated_at. Must be one of: updated_at.","type":"string"},{"name":"order_dir","in":"query","required":false,"description":"Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc.","type":"string"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object317"}}}},"x-examples":[{"resource":"Jobs","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/jobs","description":"List all readable jobs for a user","explanation":null,"parameters":[{"required":false,"name":"state","description":"The job's state. One or more of queued, running, succeeded, failed, and cancelled. Specify multiple values as a comma-separated list (e.g., \"A,B\")."},{"required":false,"name":"type","description":"The job's type. Specify multiple values as a comma-separated list (e.g., \"A,B\")."},{"required":false,"name":"q","description":"Query string to search on the id, name, and job type."},{"required":false,"name":"permission","description":"A permissions string, one of \"read\", \"write\", or \"manage\". Lists only jobs for which the current user has that permission."},{"required":false,"name":"scheduled","description":"If the item is scheduled."},{"required":false,"name":"hidden","description":"If specified to be true, returns hidden items. Defaults to false, returning non-hidden items."},{"required":false,"name":"archived","description":"The archival status of the requested item(s)."},{"required":false,"name":"author","description":"If specified, return items from any of these authors. It accepts a comma-separated list of user IDs."},{"required":false,"name":"limit","description":"Number of results to return. Defaults to its maximum of 50."},{"required":false,"name":"pageNum","description":"Page number of the results to return. Defaults to the first page, 1."},{"required":false,"name":"order","description":"The field on which to order the result set. Defaults to updated_at. Must be one of: updated_at."},{"required":false,"name":"orderDir","description":"Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc."}],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/jobs","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer Azkq2NXGSt3rtMG7D1-WXm56KthfMBsVn2i4rUsdb_E","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 4,\n \"name\": \"Query\",\n \"type\": \"JobTypes::Query\",\n \"fromTemplateId\": null,\n \"state\": \"succeeded\",\n \"createdAt\": \"2025-02-26T17:48:32.000Z\",\n \"updatedAt\": \"2025-02-26T17:18:32.000Z\",\n \"lastRun\": {\n \"id\": 3,\n \"state\": \"succeeded\",\n \"createdAt\": \"2025-02-26T17:48:32.000Z\",\n \"startedAt\": \"2025-02-26T17:17:32.000Z\",\n \"finishedAt\": \"2025-02-26T17:18:32.000Z\",\n \"error\": null\n },\n \"archived\": false,\n \"author\": {\n \"id\": 21,\n \"name\": \"User devuserfactory12 12\",\n \"username\": \"devuserfactory12\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n }\n },\n {\n \"id\": 3,\n \"name\": \"Test Job 3\",\n \"type\": \"JobTypes::CassNcoa\",\n \"fromTemplateId\": null,\n \"state\": \"queued\",\n \"createdAt\": \"2025-02-26T17:48:32.000Z\",\n \"updatedAt\": \"2025-02-26T16:48:32.000Z\",\n \"lastRun\": {\n \"id\": 2,\n \"state\": \"queued\",\n \"createdAt\": \"2025-02-26T17:48:32.000Z\",\n \"startedAt\": null,\n \"finishedAt\": null,\n \"error\": null\n },\n \"archived\": false,\n \"author\": {\n \"id\": 20,\n \"name\": \"User devuserfactory11 11\",\n \"username\": \"devuserfactory11\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"schedule\": {\n \"scheduled\": true,\n \"scheduledDays\": [\n 0\n ],\n \"scheduledHours\": [\n 12\n ],\n \"scheduledMinutes\": [\n 30\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n }\n },\n {\n \"id\": 2,\n \"name\": \"Test Job 2\",\n \"type\": \"JobTypes::Test\",\n \"fromTemplateId\": null,\n \"state\": \"running\",\n \"createdAt\": \"2025-02-26T17:48:32.000Z\",\n \"updatedAt\": \"2025-02-26T15:48:32.000Z\",\n \"lastRun\": {\n \"id\": 1,\n \"state\": \"running\",\n \"createdAt\": \"2025-02-26T17:48:32.000Z\",\n \"startedAt\": null,\n \"finishedAt\": null,\n \"error\": null\n },\n \"archived\": false,\n \"author\": {\n \"id\": 19,\n \"name\": \"User devuserfactory10 10\",\n \"username\": \"devuserfactory10\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n }\n },\n {\n \"id\": 1,\n \"name\": \"Test Job 1\",\n \"type\": \"JobTypes::Test\",\n \"fromTemplateId\": null,\n \"state\": \"idle\",\n \"createdAt\": \"2025-02-26T17:48:31.000Z\",\n \"updatedAt\": \"2025-02-26T14:48:31.000Z\",\n \"lastRun\": null,\n \"archived\": false,\n \"author\": {\n \"id\": 18,\n \"name\": \"User devuserfactory9 9\",\n \"username\": \"devuserfactory9\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n }\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","X-Pagination-Per-Page":"50","Access-Control-Expose-Headers":"X-Pagination-Per-Page, X-Pagination-Current-Page, X-Pagination-Total-Pages, X-Pagination-Total-Entries","X-Pagination-Current-Page":"1","X-Pagination-Total-Pages":"1","X-Pagination-Total-Entries":"4","Content-Type":"application/json; charset=utf-8","ETag":"W/\"94fee55e61f7d1cc3ab0c49f192e39c4\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"756f0b15-d476-48f5-8d9a-0232a7b2ca44","X-Runtime":"0.079190","Content-Length":"2217"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/jobs\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer Azkq2NXGSt3rtMG7D1-WXm56KthfMBsVn2i4rUsdb_E\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Jobs","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/jobs?limit=1","description":"Limit the number of jobs returned","explanation":null,"parameters":[{"required":false,"name":"state","description":"The job's state. One or more of queued, running, succeeded, failed, and cancelled. Specify multiple values as a comma-separated list (e.g., \"A,B\")."},{"required":false,"name":"type","description":"The job's type. Specify multiple values as a comma-separated list (e.g., \"A,B\")."},{"required":false,"name":"q","description":"Query string to search on the id, name, and job type."},{"required":false,"name":"permission","description":"A permissions string, one of \"read\", \"write\", or \"manage\". Lists only jobs for which the current user has that permission."},{"required":false,"name":"scheduled","description":"If the item is scheduled."},{"required":false,"name":"hidden","description":"If specified to be true, returns hidden items. Defaults to false, returning non-hidden items."},{"required":false,"name":"archived","description":"The archival status of the requested item(s)."},{"required":false,"name":"author","description":"If specified, return items from any of these authors. It accepts a comma-separated list of user IDs."},{"required":false,"name":"limit","description":"Number of results to return. Defaults to its maximum of 50."},{"required":false,"name":"pageNum","description":"Page number of the results to return. Defaults to the first page, 1."},{"required":false,"name":"order","description":"The field on which to order the result set. Defaults to updated_at. Must be one of: updated_at."},{"required":false,"name":"orderDir","description":"Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc."}],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/jobs?limit=1","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer k4c0jEMStXU7dPiFbsnKSPb0QDwY_ihRPtaHNdwtN2k","Host":"api.civis.test","Cookie":""},"request_query_parameters":{"limit":"1"},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 9,\n \"name\": \"Query\",\n \"type\": \"JobTypes::Query\",\n \"fromTemplateId\": null,\n \"state\": \"succeeded\",\n \"createdAt\": \"2025-02-26T17:48:32.000Z\",\n \"updatedAt\": \"2025-02-26T17:18:33.000Z\",\n \"lastRun\": {\n \"id\": 6,\n \"state\": \"succeeded\",\n \"createdAt\": \"2025-02-26T17:48:33.000Z\",\n \"startedAt\": \"2025-02-26T17:17:33.000Z\",\n \"finishedAt\": \"2025-02-26T17:18:33.000Z\",\n \"error\": null\n },\n \"archived\": false,\n \"author\": {\n \"id\": 30,\n \"name\": \"User devuserfactory20 20\",\n \"username\": \"devuserfactory20\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n }\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","X-Pagination-Per-Page":"1","Access-Control-Expose-Headers":"X-Pagination-Per-Page, X-Pagination-Current-Page, X-Pagination-Total-Pages, X-Pagination-Total-Entries","X-Pagination-Current-Page":"1","X-Pagination-Total-Pages":"4","X-Pagination-Total-Entries":"4","Content-Type":"application/json; charset=utf-8","ETag":"W/\"f6bb96b640b08a8523615580470772ab\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"77d948fc-9348-45e6-93b2-78f80bf12243","X-Runtime":"0.034772","Content-Length":"615"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/jobs?limit=1\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer k4c0jEMStXU7dPiFbsnKSPb0QDwY_ihRPtaHNdwtN2k\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Jobs","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/jobs?state=running","description":"List all jobs in the specified state","explanation":null,"parameters":[{"required":false,"name":"state","description":"The job's state. One or more of queued, running, succeeded, failed, and cancelled. Specify multiple values as a comma-separated list (e.g., \"A,B\")."},{"required":false,"name":"type","description":"The job's type. Specify multiple values as a comma-separated list (e.g., \"A,B\")."},{"required":false,"name":"q","description":"Query string to search on the id, name, and job type."},{"required":false,"name":"permission","description":"A permissions string, one of \"read\", \"write\", or \"manage\". Lists only jobs for which the current user has that permission."},{"required":false,"name":"scheduled","description":"If the item is scheduled."},{"required":false,"name":"hidden","description":"If specified to be true, returns hidden items. Defaults to false, returning non-hidden items."},{"required":false,"name":"archived","description":"The archival status of the requested item(s)."},{"required":false,"name":"author","description":"If specified, return items from any of these authors. It accepts a comma-separated list of user IDs."},{"required":false,"name":"limit","description":"Number of results to return. Defaults to its maximum of 50."},{"required":false,"name":"pageNum","description":"Page number of the results to return. Defaults to the first page, 1."},{"required":false,"name":"order","description":"The field on which to order the result set. Defaults to updated_at. Must be one of: updated_at."},{"required":false,"name":"orderDir","description":"Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc."}],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/jobs?state=running","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer 2G4G3GtLXAMh3MMa8jLrqmLlAfemR2Bs78xMMFg1WDc","Host":"api.civis.test","Cookie":""},"request_query_parameters":{"state":"running"},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 12,\n \"name\": \"Test Job 10\",\n \"type\": \"JobTypes::Test\",\n \"fromTemplateId\": null,\n \"state\": \"running\",\n \"createdAt\": \"2025-02-26T17:48:33.000Z\",\n \"updatedAt\": \"2025-02-26T15:48:33.000Z\",\n \"lastRun\": {\n \"id\": 7,\n \"state\": \"running\",\n \"createdAt\": \"2025-02-26T17:48:33.000Z\",\n \"startedAt\": null,\n \"finishedAt\": null,\n \"error\": null\n },\n \"archived\": false,\n \"author\": {\n \"id\": 37,\n \"name\": \"User devuserfactory26 26\",\n \"username\": \"devuserfactory26\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n }\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","X-Pagination-Per-Page":"50","Access-Control-Expose-Headers":"X-Pagination-Per-Page, X-Pagination-Current-Page, X-Pagination-Total-Pages, X-Pagination-Total-Entries","X-Pagination-Current-Page":"1","X-Pagination-Total-Pages":"1","X-Pagination-Total-Entries":"1","Content-Type":"application/json; charset=utf-8","ETag":"W/\"cad032ae4d9a0a14bb30348080f0f5fa\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"4cb79d50-c08b-4d92-aa2d-3e6af65e9c74","X-Runtime":"0.029921","Content-Length":"573"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/jobs?state=running\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer 2G4G3GtLXAMh3MMa8jLrqmLlAfemR2Bs78xMMFg1WDc\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Jobs","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/jobs?state=queued,running","description":"List all jobs in multiple state","explanation":null,"parameters":[{"required":false,"name":"state","description":"The job's state. One or more of queued, running, succeeded, failed, and cancelled. Specify multiple values as a comma-separated list (e.g., \"A,B\")."},{"required":false,"name":"type","description":"The job's type. Specify multiple values as a comma-separated list (e.g., \"A,B\")."},{"required":false,"name":"q","description":"Query string to search on the id, name, and job type."},{"required":false,"name":"permission","description":"A permissions string, one of \"read\", \"write\", or \"manage\". Lists only jobs for which the current user has that permission."},{"required":false,"name":"scheduled","description":"If the item is scheduled."},{"required":false,"name":"hidden","description":"If specified to be true, returns hidden items. Defaults to false, returning non-hidden items."},{"required":false,"name":"archived","description":"The archival status of the requested item(s)."},{"required":false,"name":"author","description":"If specified, return items from any of these authors. It accepts a comma-separated list of user IDs."},{"required":false,"name":"limit","description":"Number of results to return. Defaults to its maximum of 50."},{"required":false,"name":"pageNum","description":"Page number of the results to return. Defaults to the first page, 1."},{"required":false,"name":"order","description":"The field on which to order the result set. Defaults to updated_at. Must be one of: updated_at."},{"required":false,"name":"orderDir","description":"Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc."}],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/jobs?state=queued,running","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer hA_BuPFWLYAqcFiUHXofZiI8Z8FYYWTEk_5Rv4RMgxE","Host":"api.civis.test","Cookie":""},"request_query_parameters":{"state":"queued,running"},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 18,\n \"name\": \"Test Job 15\",\n \"type\": \"JobTypes::CassNcoa\",\n \"fromTemplateId\": null,\n \"state\": \"queued\",\n \"createdAt\": \"2025-02-26T17:48:34.000Z\",\n \"updatedAt\": \"2025-02-26T16:48:34.000Z\",\n \"lastRun\": {\n \"id\": 11,\n \"state\": \"queued\",\n \"createdAt\": \"2025-02-26T17:48:34.000Z\",\n \"startedAt\": null,\n \"finishedAt\": null,\n \"error\": null\n },\n \"archived\": false,\n \"author\": {\n \"id\": 47,\n \"name\": \"User devuserfactory35 35\",\n \"username\": \"devuserfactory35\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"schedule\": {\n \"scheduled\": true,\n \"scheduledDays\": [\n 0\n ],\n \"scheduledHours\": [\n 12\n ],\n \"scheduledMinutes\": [\n 30\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n }\n },\n {\n \"id\": 17,\n \"name\": \"Test Job 14\",\n \"type\": \"JobTypes::Test\",\n \"fromTemplateId\": null,\n \"state\": \"running\",\n \"createdAt\": \"2025-02-26T17:48:34.000Z\",\n \"updatedAt\": \"2025-02-26T15:48:34.000Z\",\n \"lastRun\": {\n \"id\": 10,\n \"state\": \"running\",\n \"createdAt\": \"2025-02-26T17:48:34.000Z\",\n \"startedAt\": null,\n \"finishedAt\": null,\n \"error\": null\n },\n \"archived\": false,\n \"author\": {\n \"id\": 46,\n \"name\": \"User devuserfactory34 34\",\n \"username\": \"devuserfactory34\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n }\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","X-Pagination-Per-Page":"50","Access-Control-Expose-Headers":"X-Pagination-Per-Page, X-Pagination-Current-Page, X-Pagination-Total-Pages, X-Pagination-Total-Entries","X-Pagination-Current-Page":"1","X-Pagination-Total-Pages":"1","X-Pagination-Total-Entries":"2","Content-Type":"application/json; charset=utf-8","ETag":"W/\"bba5e87f2ee37ac0e85de617acc19ced\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"96179c2f-5a7f-47f8-8c30-6499ec47135f","X-Runtime":"0.033133","Content-Length":"1154"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/jobs?state=queued,running\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer hA_BuPFWLYAqcFiUHXofZiI8Z8FYYWTEk_5Rv4RMgxE\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Jobs","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/jobs?type=JobTypes::Test","description":"List all jobs of the specified type","explanation":null,"parameters":[{"required":false,"name":"state","description":"The job's state. One or more of queued, running, succeeded, failed, and cancelled. Specify multiple values as a comma-separated list (e.g., \"A,B\")."},{"required":false,"name":"type","description":"The job's type. Specify multiple values as a comma-separated list (e.g., \"A,B\")."},{"required":false,"name":"q","description":"Query string to search on the id, name, and job type."},{"required":false,"name":"permission","description":"A permissions string, one of \"read\", \"write\", or \"manage\". Lists only jobs for which the current user has that permission."},{"required":false,"name":"scheduled","description":"If the item is scheduled."},{"required":false,"name":"hidden","description":"If specified to be true, returns hidden items. Defaults to false, returning non-hidden items."},{"required":false,"name":"archived","description":"The archival status of the requested item(s)."},{"required":false,"name":"author","description":"If specified, return items from any of these authors. It accepts a comma-separated list of user IDs."},{"required":false,"name":"limit","description":"Number of results to return. Defaults to its maximum of 50."},{"required":false,"name":"pageNum","description":"Page number of the results to return. Defaults to the first page, 1."},{"required":false,"name":"order","description":"The field on which to order the result set. Defaults to updated_at. Must be one of: updated_at."},{"required":false,"name":"orderDir","description":"Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc."}],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/jobs?type=JobTypes:%3ATest","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer 3PcJNPltbx8j3TbuMri-z_DIz4jS_P0VEfPqx1-oblA","Host":"api.civis.test","Cookie":""},"request_query_parameters":{"type":"JobTypes::Test"},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 22,\n \"name\": \"Test Job 18\",\n \"type\": \"JobTypes::Test\",\n \"fromTemplateId\": null,\n \"state\": \"running\",\n \"createdAt\": \"2025-02-26T17:48:34.000Z\",\n \"updatedAt\": \"2025-02-26T15:48:34.000Z\",\n \"lastRun\": {\n \"id\": 13,\n \"state\": \"running\",\n \"createdAt\": \"2025-02-26T17:48:34.000Z\",\n \"startedAt\": null,\n \"finishedAt\": null,\n \"error\": null\n },\n \"archived\": false,\n \"author\": {\n \"id\": 55,\n \"name\": \"User devuserfactory42 42\",\n \"username\": \"devuserfactory42\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n }\n },\n {\n \"id\": 21,\n \"name\": \"Test Job 17\",\n \"type\": \"JobTypes::Test\",\n \"fromTemplateId\": null,\n \"state\": \"idle\",\n \"createdAt\": \"2025-02-26T17:48:34.000Z\",\n \"updatedAt\": \"2025-02-26T14:48:34.000Z\",\n \"lastRun\": null,\n \"archived\": false,\n \"author\": {\n \"id\": 54,\n \"name\": \"User devuserfactory41 41\",\n \"username\": \"devuserfactory41\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n }\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","X-Pagination-Per-Page":"50","Access-Control-Expose-Headers":"X-Pagination-Per-Page, X-Pagination-Current-Page, X-Pagination-Total-Pages, X-Pagination-Total-Entries","X-Pagination-Current-Page":"1","X-Pagination-Total-Pages":"1","X-Pagination-Total-Entries":"2","Content-Type":"application/json; charset=utf-8","ETag":"W/\"bd1d4bdbaf745e26a842c81913493594\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"0b23ffde-b817-4251-aef9-2520cc8f279b","X-Runtime":"0.032148","Content-Length":"1034"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/jobs?type=JobTypes:%3ATest\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer 3PcJNPltbx8j3TbuMri-z_DIz4jS_P0VEfPqx1-oblA\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Jobs","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/jobs?type=JobTypes::Test,JobTypes::CassNcoa","description":"List all jobs of multiple types","explanation":null,"parameters":[{"required":false,"name":"state","description":"The job's state. One or more of queued, running, succeeded, failed, and cancelled. Specify multiple values as a comma-separated list (e.g., \"A,B\")."},{"required":false,"name":"type","description":"The job's type. Specify multiple values as a comma-separated list (e.g., \"A,B\")."},{"required":false,"name":"q","description":"Query string to search on the id, name, and job type."},{"required":false,"name":"permission","description":"A permissions string, one of \"read\", \"write\", or \"manage\". Lists only jobs for which the current user has that permission."},{"required":false,"name":"scheduled","description":"If the item is scheduled."},{"required":false,"name":"hidden","description":"If specified to be true, returns hidden items. Defaults to false, returning non-hidden items."},{"required":false,"name":"archived","description":"The archival status of the requested item(s)."},{"required":false,"name":"author","description":"If specified, return items from any of these authors. It accepts a comma-separated list of user IDs."},{"required":false,"name":"limit","description":"Number of results to return. Defaults to its maximum of 50."},{"required":false,"name":"pageNum","description":"Page number of the results to return. Defaults to the first page, 1."},{"required":false,"name":"order","description":"The field on which to order the result set. Defaults to updated_at. Must be one of: updated_at."},{"required":false,"name":"orderDir","description":"Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc."}],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/jobs?type=JobTypes:%3ATest,JobTypes:%3ACassNcoa","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer kXDgh4_ACOlAXlP67TqE5gFs2u57lHWCbO_vGYxphO8","Host":"api.civis.test","Cookie":""},"request_query_parameters":{"type":"JobTypes::Test,JobTypes::CassNcoa"},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 28,\n \"name\": \"Test Job 23\",\n \"type\": \"JobTypes::CassNcoa\",\n \"fromTemplateId\": null,\n \"state\": \"queued\",\n \"createdAt\": \"2025-02-26T17:48:35.000Z\",\n \"updatedAt\": \"2025-02-26T16:48:35.000Z\",\n \"lastRun\": {\n \"id\": 17,\n \"state\": \"queued\",\n \"createdAt\": \"2025-02-26T17:48:35.000Z\",\n \"startedAt\": null,\n \"finishedAt\": null,\n \"error\": null\n },\n \"archived\": false,\n \"author\": {\n \"id\": 65,\n \"name\": \"User devuserfactory51 51\",\n \"username\": \"devuserfactory51\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"schedule\": {\n \"scheduled\": true,\n \"scheduledDays\": [\n 0\n ],\n \"scheduledHours\": [\n 12\n ],\n \"scheduledMinutes\": [\n 30\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n }\n },\n {\n \"id\": 27,\n \"name\": \"Test Job 22\",\n \"type\": \"JobTypes::Test\",\n \"fromTemplateId\": null,\n \"state\": \"running\",\n \"createdAt\": \"2025-02-26T17:48:35.000Z\",\n \"updatedAt\": \"2025-02-26T15:48:35.000Z\",\n \"lastRun\": {\n \"id\": 16,\n \"state\": \"running\",\n \"createdAt\": \"2025-02-26T17:48:35.000Z\",\n \"startedAt\": null,\n \"finishedAt\": null,\n \"error\": null\n },\n \"archived\": false,\n \"author\": {\n \"id\": 64,\n \"name\": \"User devuserfactory50 50\",\n \"username\": \"devuserfactory50\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n }\n },\n {\n \"id\": 26,\n \"name\": \"Test Job 21\",\n \"type\": \"JobTypes::Test\",\n \"fromTemplateId\": null,\n \"state\": \"idle\",\n \"createdAt\": \"2025-02-26T17:48:35.000Z\",\n \"updatedAt\": \"2025-02-26T14:48:35.000Z\",\n \"lastRun\": null,\n \"archived\": false,\n \"author\": {\n \"id\": 63,\n \"name\": \"User devuserfactory49 49\",\n \"username\": \"devuserfactory49\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n }\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","X-Pagination-Per-Page":"50","Access-Control-Expose-Headers":"X-Pagination-Per-Page, X-Pagination-Current-Page, X-Pagination-Total-Pages, X-Pagination-Total-Entries","X-Pagination-Current-Page":"1","X-Pagination-Total-Pages":"1","X-Pagination-Total-Entries":"3","Content-Type":"application/json; charset=utf-8","ETag":"W/\"d9c98db13d98c55a13576b2d95535bbe\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"0bcad674-3197-4506-a6d8-8e4188dcf89b","X-Runtime":"0.035203","Content-Length":"1614"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/jobs?type=JobTypes:%3ATest,JobTypes:%3ACassNcoa\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer kXDgh4_ACOlAXlP67TqE5gFs2u57lHWCbO_vGYxphO8\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Jobs","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/jobs?q=Test Job","description":"List all jobs based on query parameter","explanation":null,"parameters":[{"required":false,"name":"state","description":"The job's state. One or more of queued, running, succeeded, failed, and cancelled. Specify multiple values as a comma-separated list (e.g., \"A,B\")."},{"required":false,"name":"type","description":"The job's type. Specify multiple values as a comma-separated list (e.g., \"A,B\")."},{"required":false,"name":"q","description":"Query string to search on the id, name, and job type."},{"required":false,"name":"permission","description":"A permissions string, one of \"read\", \"write\", or \"manage\". Lists only jobs for which the current user has that permission."},{"required":false,"name":"scheduled","description":"If the item is scheduled."},{"required":false,"name":"hidden","description":"If specified to be true, returns hidden items. Defaults to false, returning non-hidden items."},{"required":false,"name":"archived","description":"The archival status of the requested item(s)."},{"required":false,"name":"author","description":"If specified, return items from any of these authors. It accepts a comma-separated list of user IDs."},{"required":false,"name":"limit","description":"Number of results to return. Defaults to its maximum of 50."},{"required":false,"name":"pageNum","description":"Page number of the results to return. Defaults to the first page, 1."},{"required":false,"name":"order","description":"The field on which to order the result set. Defaults to updated_at. Must be one of: updated_at."},{"required":false,"name":"orderDir","description":"Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc."}],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/jobs?q=Test Job","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer ttYzvX2Br3AcuMeDMQraQigzU_GQVAx48jCsw5O2iys","Host":"api.civis.test","Cookie":""},"request_query_parameters":{"q":"Test Job"},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 33,\n \"name\": \"Test Job 27\",\n \"type\": \"JobTypes::CassNcoa\",\n \"fromTemplateId\": null,\n \"state\": \"queued\",\n \"createdAt\": \"2025-02-26T17:48:36.000Z\",\n \"updatedAt\": \"2025-02-26T16:48:36.000Z\",\n \"lastRun\": {\n \"id\": 20,\n \"state\": \"queued\",\n \"createdAt\": \"2025-02-26T17:48:36.000Z\",\n \"startedAt\": null,\n \"finishedAt\": null,\n \"error\": null\n },\n \"archived\": false,\n \"author\": {\n \"id\": 74,\n \"name\": \"User devuserfactory59 59\",\n \"username\": \"devuserfactory59\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"schedule\": {\n \"scheduled\": true,\n \"scheduledDays\": [\n 0\n ],\n \"scheduledHours\": [\n 12\n ],\n \"scheduledMinutes\": [\n 30\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n }\n },\n {\n \"id\": 32,\n \"name\": \"Test Job 26\",\n \"type\": \"JobTypes::Test\",\n \"fromTemplateId\": null,\n \"state\": \"running\",\n \"createdAt\": \"2025-02-26T17:48:35.000Z\",\n \"updatedAt\": \"2025-02-26T15:48:36.000Z\",\n \"lastRun\": {\n \"id\": 19,\n \"state\": \"running\",\n \"createdAt\": \"2025-02-26T17:48:36.000Z\",\n \"startedAt\": null,\n \"finishedAt\": null,\n \"error\": null\n },\n \"archived\": false,\n \"author\": {\n \"id\": 73,\n \"name\": \"User devuserfactory58 58\",\n \"username\": \"devuserfactory58\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n }\n },\n {\n \"id\": 31,\n \"name\": \"Test Job 25\",\n \"type\": \"JobTypes::Test\",\n \"fromTemplateId\": null,\n \"state\": \"idle\",\n \"createdAt\": \"2025-02-26T17:48:35.000Z\",\n \"updatedAt\": \"2025-02-26T14:48:35.000Z\",\n \"lastRun\": null,\n \"archived\": false,\n \"author\": {\n \"id\": 72,\n \"name\": \"User devuserfactory57 57\",\n \"username\": \"devuserfactory57\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n }\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","X-Pagination-Per-Page":"50","Access-Control-Expose-Headers":"X-Pagination-Per-Page, X-Pagination-Current-Page, X-Pagination-Total-Pages, X-Pagination-Total-Entries","X-Pagination-Current-Page":"1","X-Pagination-Total-Pages":"1","X-Pagination-Total-Entries":"3","Content-Type":"application/json; charset=utf-8","ETag":"W/\"6b4b421175bb3d31d53a5f701d407aa4\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"ea037d12-b009-4235-9466-82cbf2591a2a","X-Runtime":"0.035673","Content-Length":"1614"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/jobs?q=Test Job\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer ttYzvX2Br3AcuMeDMQraQigzU_GQVAx48jCsw5O2iys\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Jobs","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/jobs?scheduled=False","description":"List all jobs based on whether they are scheduled","explanation":null,"parameters":[{"required":false,"name":"state","description":"The job's state. One or more of queued, running, succeeded, failed, and cancelled. Specify multiple values as a comma-separated list (e.g., \"A,B\")."},{"required":false,"name":"type","description":"The job's type. Specify multiple values as a comma-separated list (e.g., \"A,B\")."},{"required":false,"name":"q","description":"Query string to search on the id, name, and job type."},{"required":false,"name":"permission","description":"A permissions string, one of \"read\", \"write\", or \"manage\". Lists only jobs for which the current user has that permission."},{"required":false,"name":"scheduled","description":"If the item is scheduled."},{"required":false,"name":"hidden","description":"If specified to be true, returns hidden items. Defaults to false, returning non-hidden items."},{"required":false,"name":"archived","description":"The archival status of the requested item(s)."},{"required":false,"name":"author","description":"If specified, return items from any of these authors. It accepts a comma-separated list of user IDs."},{"required":false,"name":"limit","description":"Number of results to return. Defaults to its maximum of 50."},{"required":false,"name":"pageNum","description":"Page number of the results to return. Defaults to the first page, 1."},{"required":false,"name":"order","description":"The field on which to order the result set. Defaults to updated_at. Must be one of: updated_at."},{"required":false,"name":"orderDir","description":"Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc."}],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/jobs?scheduled=False","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer -Paxy3hBhi265baytFV1HTvv4Bt6yy6qGUIzpcMvDb4","Host":"api.civis.test","Cookie":""},"request_query_parameters":{"scheduled":"False"},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 39,\n \"name\": \"Query\",\n \"type\": \"JobTypes::Query\",\n \"fromTemplateId\": null,\n \"state\": \"succeeded\",\n \"createdAt\": \"2025-02-26T17:48:36.000Z\",\n \"updatedAt\": \"2025-02-26T17:18:37.000Z\",\n \"lastRun\": {\n \"id\": 24,\n \"state\": \"succeeded\",\n \"createdAt\": \"2025-02-26T17:48:37.000Z\",\n \"startedAt\": \"2025-02-26T17:17:36.000Z\",\n \"finishedAt\": \"2025-02-26T17:18:36.000Z\",\n \"error\": null\n },\n \"archived\": false,\n \"author\": {\n \"id\": 84,\n \"name\": \"User devuserfactory68 68\",\n \"username\": \"devuserfactory68\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n }\n },\n {\n \"id\": 37,\n \"name\": \"Test Job 30\",\n \"type\": \"JobTypes::Test\",\n \"fromTemplateId\": null,\n \"state\": \"running\",\n \"createdAt\": \"2025-02-26T17:48:36.000Z\",\n \"updatedAt\": \"2025-02-26T15:48:36.000Z\",\n \"lastRun\": {\n \"id\": 22,\n \"state\": \"running\",\n \"createdAt\": \"2025-02-26T17:48:36.000Z\",\n \"startedAt\": null,\n \"finishedAt\": null,\n \"error\": null\n },\n \"archived\": false,\n \"author\": {\n \"id\": 82,\n \"name\": \"User devuserfactory66 66\",\n \"username\": \"devuserfactory66\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n }\n },\n {\n \"id\": 36,\n \"name\": \"Test Job 29\",\n \"type\": \"JobTypes::Test\",\n \"fromTemplateId\": null,\n \"state\": \"idle\",\n \"createdAt\": \"2025-02-26T17:48:36.000Z\",\n \"updatedAt\": \"2025-02-26T14:48:36.000Z\",\n \"lastRun\": null,\n \"archived\": false,\n \"author\": {\n \"id\": 81,\n \"name\": \"User devuserfactory65 65\",\n \"username\": \"devuserfactory65\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n }\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","X-Pagination-Per-Page":"50","Access-Control-Expose-Headers":"X-Pagination-Per-Page, X-Pagination-Current-Page, X-Pagination-Total-Pages, X-Pagination-Total-Entries","X-Pagination-Current-Page":"1","X-Pagination-Total-Pages":"1","X-Pagination-Total-Entries":"3","Content-Type":"application/json; charset=utf-8","ETag":"W/\"3679dcb6fb37c389fa4e23a0c914d462\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"4c57b85a-f8a6-4fc5-9154-770c9e4cc7f8","X-Runtime":"0.039814","Content-Length":"1650"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/jobs?scheduled=False\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer -Paxy3hBhi265baytFV1HTvv4Bt6yy6qGUIzpcMvDb4\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Jobs","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/jobs?permission=manage","description":"List only jobs that this user has permission to manage","explanation":null,"parameters":[{"required":false,"name":"state","description":"The job's state. One or more of queued, running, succeeded, failed, and cancelled. Specify multiple values as a comma-separated list (e.g., \"A,B\")."},{"required":false,"name":"type","description":"The job's type. Specify multiple values as a comma-separated list (e.g., \"A,B\")."},{"required":false,"name":"q","description":"Query string to search on the id, name, and job type."},{"required":false,"name":"permission","description":"A permissions string, one of \"read\", \"write\", or \"manage\". Lists only jobs for which the current user has that permission."},{"required":false,"name":"scheduled","description":"If the item is scheduled."},{"required":false,"name":"hidden","description":"If specified to be true, returns hidden items. Defaults to false, returning non-hidden items."},{"required":false,"name":"archived","description":"The archival status of the requested item(s)."},{"required":false,"name":"author","description":"If specified, return items from any of these authors. It accepts a comma-separated list of user IDs."},{"required":false,"name":"limit","description":"Number of results to return. Defaults to its maximum of 50."},{"required":false,"name":"pageNum","description":"Page number of the results to return. Defaults to the first page, 1."},{"required":false,"name":"order","description":"The field on which to order the result set. Defaults to updated_at. Must be one of: updated_at."},{"required":false,"name":"orderDir","description":"Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc."}],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/jobs?permission=manage","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer vFYK6aZG3rFBrKiqVP8py_ekYhobqvU9A5q2TO_KHuA","Host":"api.civis.test","Cookie":""},"request_query_parameters":{"permission":"manage"},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 46,\n \"name\": \"Test Job 37\",\n \"type\": \"JobTypes::Test\",\n \"fromTemplateId\": null,\n \"state\": \"idle\",\n \"createdAt\": \"2025-02-26T17:48:37.000Z\",\n \"updatedAt\": \"2025-02-26T17:48:37.000Z\",\n \"lastRun\": null,\n \"archived\": false,\n \"author\": {\n \"id\": 98,\n \"name\": \"User devuserfactory81 81\",\n \"username\": \"devuserfactory81\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n }\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","X-Pagination-Per-Page":"50","Access-Control-Expose-Headers":"X-Pagination-Per-Page, X-Pagination-Current-Page, X-Pagination-Total-Pages, X-Pagination-Total-Entries","X-Pagination-Current-Page":"1","X-Pagination-Total-Pages":"1","X-Pagination-Total-Entries":"1","Content-Type":"application/json; charset=utf-8","ETag":"W/\"7523784b429c28b32cb8f93f30e1e209\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"85b597fb-ce00-4e96-83e4-9dd9b4bc137b","X-Runtime":"0.034666","Content-Length":"461"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/jobs?permission=manage\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer vFYK6aZG3rFBrKiqVP8py_ekYhobqvU9A5q2TO_KHuA\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/jobs/{id}":{"get":{"summary":"Show basic job info","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID for this job.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object318"}}},"x-examples":[{"resource":"Jobs","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/jobs/:id","description":"View a job","explanation":null,"parameters":[{"required":true,"name":"id","description":"The ID for this job."}],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/jobs/48","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer dm4b-Zb3bkPQMZYduh4V7AocLcFzqFen9N1JQHVS6f8","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 48,\n \"name\": \"Test Job 39\",\n \"type\": \"JobTypes::Test\",\n \"fromTemplateId\": null,\n \"state\": \"running\",\n \"createdAt\": \"2025-02-26T17:48:38.000Z\",\n \"updatedAt\": \"2025-02-26T17:48:38.000Z\",\n \"runs\": [\n {\n \"id\": 28,\n \"state\": \"running\",\n \"createdAt\": \"2025-02-26T17:48:38.000Z\",\n \"startedAt\": null,\n \"finishedAt\": null,\n \"error\": null\n }\n ],\n \"lastRun\": {\n \"id\": 28,\n \"state\": \"running\",\n \"createdAt\": \"2025-02-26T17:48:38.000Z\",\n \"startedAt\": null,\n \"finishedAt\": null,\n \"error\": null\n },\n \"hidden\": false,\n \"archived\": false,\n \"author\": {\n \"id\": 100,\n \"name\": \"Admin devadminfactory14 14\",\n \"username\": \"devadminfactory14\",\n \"initials\": \"AD\",\n \"online\": null\n },\n \"myPermissionLevel\": \"manage\",\n \"successEmailSubject\": null,\n \"successEmailBody\": null,\n \"runningAsUser\": \"devadminfactory14\",\n \"runByUser\": \"devadminfactory14\",\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n }\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"16a0e53120e87d0c12ce9904a2229d0a\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"934e37ab-220d-4c25-978e-d5b089af0715","X-Runtime":"0.040396","Content-Length":"863"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/jobs/48\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer dm4b-Zb3bkPQMZYduh4V7AocLcFzqFen9N1JQHVS6f8\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/jobs/{id}/trigger_email":{"post":{"summary":"Generate and retrieve trigger email address","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID for this job.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object319"}}},"x-examples":[{"resource":"Jobs","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/jobs/:id/trigger_email","description":"Generate an email trigger address","explanation":null,"parameters":[{"required":true,"name":"id","description":"The ID for this job."}],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/jobs/47/trigger_email","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer ejd3iRoT_eIq1VoGwvNJfcQidMOnGB61a8IgIgXE9ok","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"triggerEmail\": \"console-inbound+run.47.ab68878acea1a3c11968f208ad6773c7@civisanalytics.com\"\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"129c0718dda4fbce81934d2c80a7d553\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"99c16634-d64c-4068-a186-1dfa49a0f237","X-Runtime":"0.252221","Content-Length":"93"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/jobs/47/trigger_email\" -d '' -X POST \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer ejd3iRoT_eIq1VoGwvNJfcQidMOnGB61a8IgIgXE9ok\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/jobs/{id}/parents":{"get":{"summary":"Show chain of parents as a list that this job triggers from","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID for this job.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object318"}}},"x-examples":[{"resource":"Jobs","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/jobs/:id/parents","description":"View a job that has no parent","explanation":null,"parameters":[{"required":true,"name":"id","description":"The ID for this job."}],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/jobs/58/parents","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer P7wzs_8xD3CqMNYMfLAWoMfylFXbrcXMaT4MQ5deJtg","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"4f53cda18c2baa0c0354bb5f9a3ecbe5\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"2cc6ffcf-1638-4715-b6a4-25b5ab1aa8e9","X-Runtime":"0.026720","Content-Length":"2"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/jobs/58/parents\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer P7wzs_8xD3CqMNYMfLAWoMfylFXbrcXMaT4MQ5deJtg\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Jobs","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/jobs/:job_with_parent_id/parents","description":"View a job with a parent","explanation":null,"parameters":[{"required":true,"name":"id","description":"The ID for this job."}],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/jobs/60/parents?id=59","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer iHd6_P7tCf-is8T7amE67tfHG7r04z5OyU1r89iXmRs","Host":"api.civis.test","Cookie":""},"request_query_parameters":{"id":"59"},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 59,\n \"name\": \"Test Job 49\",\n \"type\": \"JobTypes::Test\",\n \"fromTemplateId\": null,\n \"state\": \"idle\",\n \"createdAt\": \"2025-02-26T17:48:41.000Z\",\n \"updatedAt\": \"2025-02-26T17:48:41.000Z\",\n \"runs\": [\n\n ],\n \"lastRun\": null,\n \"hidden\": false,\n \"archived\": false,\n \"author\": {\n \"id\": 117,\n \"name\": \"Admin devadminfactory23 23\",\n \"username\": \"devadminfactory23\",\n \"initials\": \"AD\",\n \"online\": null\n },\n \"myPermissionLevel\": \"manage\",\n \"successEmailSubject\": null,\n \"successEmailBody\": null,\n \"runningAsUser\": \"devadminfactory23\",\n \"runByUser\": null,\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n }\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"9b76634bef2abc7b2e2d0cd6ee0b8130\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"52e3925c-07d6-4450-b0e1-ed7c136d845a","X-Runtime":"0.038350","Content-Length":"623"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/jobs/60/parents?id=59\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer iHd6_P7tCf-is8T7amE67tfHG7r04z5OyU1r89iXmRs\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/jobs/{id}/children":{"get":{"summary":"Show nested tree of children that this job triggers","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID for this job.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object320"}}},"x-examples":[{"resource":"Jobs","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/jobs/:id/children","description":"View a job with no children","explanation":null,"parameters":[{"required":true,"name":"id","description":"The ID for this job."}],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/jobs/65/children","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer GmVi1P9dopLge5Nv9ZceNs6NwJFXrkdzD8pssRr-LNE","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"4f53cda18c2baa0c0354bb5f9a3ecbe5\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"95e3a1a2-8991-450a-917f-ea1eafda6863","X-Runtime":"0.029077","Content-Length":"2"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/jobs/65/children\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer GmVi1P9dopLge5Nv9ZceNs6NwJFXrkdzD8pssRr-LNE\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Jobs","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/jobs/:child_job_id/children","description":"View a jobs children","explanation":null,"parameters":[{"required":true,"name":"id","description":"The ID for this job."}],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/jobs/66/children?id=70","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer xyuaoQWB8b5ko9igK5XFlcr0IzJC2432qZgMhxpT8M8","Host":"api.civis.test","Cookie":""},"request_query_parameters":{"id":"70"},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 68,\n \"name\": \"Test Job 58\",\n \"type\": \"JobTypes::Test\",\n \"fromTemplateId\": null,\n \"state\": \"idle\",\n \"createdAt\": \"2025-02-26T17:48:41.000Z\",\n \"updatedAt\": \"2025-02-26T17:48:41.000Z\",\n \"runs\": [\n\n ],\n \"lastRun\": null,\n \"children\": [\n\n ]\n },\n {\n \"id\": 69,\n \"name\": \"Test Job 59\",\n \"type\": \"JobTypes::Test\",\n \"fromTemplateId\": null,\n \"state\": \"idle\",\n \"createdAt\": \"2025-02-26T17:48:41.000Z\",\n \"updatedAt\": \"2025-02-26T17:48:41.000Z\",\n \"runs\": [\n\n ],\n \"lastRun\": null,\n \"children\": [\n\n ]\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"783c27bb5b03b0cfa05fa599e59de429\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"3750ff97-40ea-4e88-9cca-09bf667a961d","X-Runtime":"0.044632","Content-Length":"419"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/jobs/66/children?id=70\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer xyuaoQWB8b5ko9igK5XFlcr0IzJC2432qZgMhxpT8M8\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Jobs","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/jobs/:parent_job_id/children","description":"View a jobs children with grandchild","explanation":null,"parameters":[{"required":true,"name":"id","description":"The ID for this job."}],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/jobs/72/children?id=75","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer Ew-FJ_jSb9IGiCZFCNuB4IneEs1F2DcJE078g9i_u7E","Host":"api.civis.test","Cookie":""},"request_query_parameters":{"id":"75"},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 71,\n \"name\": \"Test Job 61\",\n \"type\": \"JobTypes::Test\",\n \"fromTemplateId\": null,\n \"state\": \"idle\",\n \"createdAt\": \"2025-02-26T17:48:42.000Z\",\n \"updatedAt\": \"2025-02-26T17:48:42.000Z\",\n \"runs\": [\n\n ],\n \"lastRun\": null,\n \"children\": [\n {\n \"id\": 73,\n \"name\": \"Test Job 63\",\n \"type\": \"JobTypes::Test\",\n \"fromTemplateId\": null,\n \"state\": \"idle\",\n \"createdAt\": \"2025-02-26T17:48:42.000Z\",\n \"updatedAt\": \"2025-02-26T17:48:42.000Z\",\n \"runs\": [\n\n ],\n \"lastRun\": null,\n \"children\": [\n\n ]\n },\n {\n \"id\": 74,\n \"name\": \"Test Job 64\",\n \"type\": \"JobTypes::Test\",\n \"fromTemplateId\": null,\n \"state\": \"idle\",\n \"createdAt\": \"2025-02-26T17:48:42.000Z\",\n \"updatedAt\": \"2025-02-26T17:48:42.000Z\",\n \"runs\": [\n\n ],\n \"lastRun\": null,\n \"children\": [\n\n ]\n }\n ]\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"d3aa97c6451ed33b2c523a86192ba9b1\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"a090afad-6f36-4692-b03e-cea6f1d43875","X-Runtime":"0.045253","Content-Length":"627"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/jobs/72/children?id=75\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer Ew-FJ_jSb9IGiCZFCNuB4IneEs1F2DcJE078g9i_u7E\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/jobs/{id}/runs":{"get":{"summary":"List runs for the given job","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID for this job.","type":"integer"},{"name":"limit","in":"query","required":false,"description":"Number of results to return. Defaults to 20. Maximum allowed is 100.","type":"integer"},{"name":"page_num","in":"query","required":false,"description":"Page number of the results to return. Defaults to the first page, 1.","type":"integer"},{"name":"order","in":"query","required":false,"description":"The field on which to order the result set. Defaults to id. Must be one of: id.","type":"string"},{"name":"order_dir","in":"query","required":false,"description":"Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc.","type":"string"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object74"}}}},"x-examples":[{"resource":"Jobs","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/jobs/:id/runs","description":"Get a job's runs","explanation":null,"parameters":[{"required":true,"name":"id","description":"The ID for this job."}],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/jobs/49/runs","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer d290i_EyEWZVNsWEnZeinEXseVIuSL_oAR9grrcLBbU","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 30,\n \"state\": \"failed\",\n \"createdAt\": \"2025-02-26T17:48:38.000Z\",\n \"startedAt\": \"2025-02-26T17:47:38.000Z\",\n \"finishedAt\": \"2025-02-26T17:48:38.000Z\",\n \"error\": null\n },\n {\n \"id\": 29,\n \"state\": \"succeeded\",\n \"createdAt\": \"2025-02-26T17:48:38.000Z\",\n \"startedAt\": \"2025-02-26T17:43:38.000Z\",\n \"finishedAt\": \"2025-02-26T17:44:38.000Z\",\n \"error\": null\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","X-Pagination-Per-Page":"20","Access-Control-Expose-Headers":"X-Pagination-Per-Page, X-Pagination-Current-Page, X-Pagination-Total-Pages, X-Pagination-Total-Entries","X-Pagination-Current-Page":"1","X-Pagination-Total-Pages":"1","X-Pagination-Total-Entries":"2","Content-Type":"application/json; charset=utf-8","ETag":"W/\"cacae7f8b5eae2f62020d47e4b485036\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"316417c3-60d0-4867-97a9-65f8adfa8a2e","X-Runtime":"0.033941","Content-Length":"320"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/jobs/49/runs\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer d290i_EyEWZVNsWEnZeinEXseVIuSL_oAR9grrcLBbU\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"post":{"summary":"Run a job","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID for this job.","type":"integer"}],"responses":{"201":{"description":"success","schema":{"$ref":"#/definitions/Object74"}}},"x-examples":[{"resource":"Jobs","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/jobs/:id/runs","description":"Run a job","explanation":null,"parameters":[{"required":true,"name":"id","description":"The ID for this job."}],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/jobs/50/runs","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer RAzm1VuzkFvJ-YnLlro_CIpOWRVCrBryf6uLw8C_y2c","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":201,"response_status_text":"Created","response_body":"{\n \"id\": 31,\n \"state\": \"queued\",\n \"createdAt\": \"2025-02-26T17:48:38.000Z\",\n \"startedAt\": null,\n \"finishedAt\": null,\n \"error\": null\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"69e6c216523b464c4e9451ca8ce4c5c0\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"774b0c97-375d-4c5b-a367-1d7038c1970a","X-Runtime":"0.091445","Content-Length":"113"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/jobs/50/runs\" -d '' -X POST \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer RAzm1VuzkFvJ-YnLlro_CIpOWRVCrBryf6uLw8C_y2c\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Jobs","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/jobs/:id/runs","description":"Attempting to queue a running job returns an error","explanation":null,"parameters":[{"required":true,"name":"id","description":"The ID for this job."}],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/jobs/51/runs","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer xQWqss4yCTLu-ecmx6bkX7tBnFQcaP0_dis5qEAXF3Y","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":409,"response_status_text":"Conflict","response_body":"{\n \"error\": \"already_running\",\n \"errorDescription\": \"The job cannot be queued because it is already running\",\n \"code\": 409\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"e8c43564-bad4-4a6b-8ea6-aa2cee7cfdcc","X-Runtime":"0.035450","Content-Length":"114"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/jobs/51/runs\" -d '' -X POST \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer xQWqss4yCTLu-ecmx6bkX7tBnFQcaP0_dis5qEAXF3Y\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/jobs/{id}/runs/{run_id}":{"get":{"summary":"Check status of a job","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Job.","type":"integer"},{"name":"run_id","in":"path","required":true,"description":"The ID of the Run.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object74"}}},"x-examples":[{"resource":"Jobs","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/jobs/:id/runs/:run_id","description":"Check status of a job","explanation":null,"parameters":[{"required":true,"name":"id","description":"The ID for this job."}],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/jobs/52/runs/33","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer zincKq_-TAXkS8sPQqU7JQTQ3-sVhJSbeSRh9x1fhTc","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 33,\n \"state\": \"succeeded\",\n \"createdAt\": \"2025-02-26T17:48:39.000Z\",\n \"startedAt\": \"2025-02-26T17:47:39.000Z\",\n \"finishedAt\": \"2025-02-26T17:48:39.000Z\",\n \"error\": null\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"0e58e9750ab6eccc0ca4ef3b46bf0c5c\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"83fe4993-3739-45d5-b059-5d3fea6d13a8","X-Runtime":"0.049053","Content-Length":"160"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/jobs/52/runs/33\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer zincKq_-TAXkS8sPQqU7JQTQ3-sVhJSbeSRh9x1fhTc\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"delete":{"summary":"Cancel a run","description":"Cancel a currently active run.","deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Job.","type":"integer"},{"name":"run_id","in":"path","required":true,"description":"The ID of the Run.","type":"integer"}],"responses":{"202":{"description":"success"}},"x-examples":[{"resource":"Jobs","resource_explanation":null,"http_method":"DELETE","route":"http://api.civis.test/jobs/:id/runs/:run_id","description":"Cancel a running job","explanation":null,"parameters":[{"required":true,"name":"id","description":"The ID for this job."}],"response_fields":[],"requests":[{"request_method":"DELETE","request_path":"http://api.civis.test/jobs/53/runs/34","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer latj6zCiVMDp_olc5tm4ORu0-sM5FzpRfL86vN-umsk","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":202,"response_status_text":"Accepted","response_body":null,"response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"text/plain; charset=utf-8","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"5eb1c855-409b-4a62-8ecc-a1181b84cb76","X-Runtime":"0.168129","Content-Length":"0"},"response_content_type":"text/plain; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/jobs/53/runs/34\" -d '' -X DELETE \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer latj6zCiVMDp_olc5tm4ORu0-sM5FzpRfL86vN-umsk\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/jobs/{id}/runs/{run_id}/outputs":{"get":{"summary":"List the outputs for a run","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the job.","type":"integer"},{"name":"run_id","in":"path","required":true,"description":"The ID of the run.","type":"integer"},{"name":"limit","in":"query","required":false,"description":"Number of results to return. Defaults to its maximum of 50.","type":"integer"},{"name":"page_num","in":"query","required":false,"description":"Page number of the results to return. Defaults to the first page, 1.","type":"integer"},{"name":"order","in":"query","required":false,"description":"The field on which to order the result set. Defaults to created_at. Must be one of: created_at, id.","type":"string"},{"name":"order_dir","in":"query","required":false,"description":"Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc.","type":"string"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object323"}}}},"x-examples":[{"resource":"Jobs","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/jobs/:job_with_run_id/runs/:job_run_id/outputs","description":"View a job's outputs","explanation":null,"parameters":[{"required":true,"name":"id","description":"The ID for this job."}],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/jobs/54/runs/35/outputs?id=57","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer UtUCpgBXdo3W0ZdrNUWo5BNmHGWv_zs_Wq1xWfsvlms","Host":"api.civis.test","Cookie":""},"request_query_parameters":{"id":"57"},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"objectType\": \"File\",\n \"objectId\": 2,\n \"name\": \"my output file\",\n \"link\": \"api.civis.test/files/2\",\n \"value\": null\n },\n {\n \"objectType\": \"Report\",\n \"objectId\": 1,\n \"name\": \"my output report\",\n \"link\": \"api.civis.test/reports/1\",\n \"value\": null\n },\n {\n \"objectType\": \"Report\",\n \"objectId\": 2,\n \"name\": \"my output tableau report\",\n \"link\": \"api.civis.test/reports/2\",\n \"value\": null\n },\n {\n \"objectType\": \"Table\",\n \"objectId\": 1,\n \"name\": \"output.table\",\n \"link\": \"api.civis.test/tables/1\",\n \"value\": null\n },\n {\n \"objectType\": \"Project\",\n \"objectId\": 1,\n \"name\": \"my output project\",\n \"link\": \"api.civis.test/projects/1\",\n \"value\": null\n },\n {\n \"objectType\": \"Credential\",\n \"objectId\": 12,\n \"name\": \"my output credential\",\n \"link\": \"api.civis.test/credentials/12\",\n \"value\": null\n },\n {\n \"objectType\": \"JSONValue\",\n \"objectId\": 1,\n \"name\": \"my awesome JSON value\",\n \"link\": \"api.civis.test/json_values/1\",\n \"value\": {\n \"foo\": \"bar\"\n }\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","X-Pagination-Per-Page":"50","Access-Control-Expose-Headers":"X-Pagination-Per-Page, X-Pagination-Current-Page, X-Pagination-Total-Pages, X-Pagination-Total-Entries","X-Pagination-Current-Page":"1","X-Pagination-Total-Pages":"1","X-Pagination-Total-Entries":"7","Content-Type":"application/json; charset=utf-8","ETag":"W/\"2d1fd73a4b1de6c89ee45525cb8bc74d\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"5a20b30c-2cc3-49d2-97b4-cb1cde0e8eee","X-Runtime":"0.089220","Content-Length":"805"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/jobs/54/runs/35/outputs?id=57\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer UtUCpgBXdo3W0ZdrNUWo5BNmHGWv_zs_Wq1xWfsvlms\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/jobs/{id}/runs/{run_id}/logs":{"get":{"summary":"Get the logs for a run","description":"Get the logs for a run.","deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the job job.","type":"integer"},{"name":"run_id","in":"path","required":true,"description":"The ID of the run.","type":"integer"},{"name":"last_id","in":"query","required":false,"description":"The ID of the last log message received. Log entries with this ID value or lower will be omitted.Logs are sorted by ID if this value is provided, and are otherwise sorted by createdAt.","type":"integer"},{"name":"limit","in":"query","required":false,"description":"The maximum number of log messages to return. Default of 10000.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object116"}}}},"x-examples":[{"resource":"Jobs","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/jobs/:id/runs/:run_id/logs","description":"Get logs for a run","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/jobs/77/runs/36/logs","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer WN3xqcn2SrihIHbUHhrTLHmkPDFpiEdRCweICALOlb8","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 0,\n \"createdAt\": \"2025-02-26T16:48:42.651Z\",\n \"message\": \"Log message 0\",\n \"level\": \"debug\"\n },\n {\n \"id\": 1,\n \"createdAt\": \"2025-02-26T16:49:42.651Z\",\n \"message\": \"Log message 1\",\n \"level\": \"info\"\n },\n {\n \"id\": 2,\n \"createdAt\": \"2025-02-26T16:50:42.651Z\",\n \"message\": \"Log message 2\",\n \"level\": \"warn\"\n },\n {\n \"id\": 3,\n \"createdAt\": \"2025-02-26T16:51:42.651Z\",\n \"message\": \"Log message 3\",\n \"level\": \"error\"\n },\n {\n \"id\": 4,\n \"createdAt\": \"2025-02-26T16:52:42.651Z\",\n \"message\": \"Log message 4\",\n \"level\": \"fatal\"\n },\n {\n \"id\": 5,\n \"createdAt\": \"2025-02-26T16:53:42.651Z\",\n \"message\": \"Log message 5\",\n \"level\": \"unknown\"\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Access-Control-Expose-Headers":["Civis-Cache-Control","Civis-Max-Id"],"Civis-Cache-Control":"no-store","Civis-Max-Id":null,"Content-Type":"application/json; charset=utf-8","ETag":"W/\"0513f1e0bbbb98175f587effa78f8eff\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"e709e7e2-381f-4fe6-8a19-8fd28477c80d","X-Runtime":"0.028930","Content-Length":"541"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/jobs/77/runs/36/logs\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer WN3xqcn2SrihIHbUHhrTLHmkPDFpiEdRCweICALOlb8\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/jobs/{id}/workflows":{"get":{"summary":"List the workflows a job belongs to","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"type":"integer"},{"name":"archived","in":"query","required":false,"description":"The archival status of the requested item(s).","type":"string"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object324"}}}},"x-examples":[{"resource":"Jobs","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/jobs/:id/workflows","description":"View workflows associated with a job","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/jobs/76/workflows","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer OlW6UvLao5LBCalcv3sF5ldQeFmRedjVaDazkT5dx6k","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 1,\n \"name\": \"Test Workflow\",\n \"description\": null,\n \"valid\": true,\n \"fileId\": 5,\n \"user\": {\n \"id\": 121,\n \"name\": \"Admin devadminfactory27 27\",\n \"username\": \"devadminfactory27\",\n \"initials\": \"AD\",\n \"online\": null\n },\n \"state\": \"idle\",\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n },\n \"allowConcurrentExecutions\": true,\n \"timeZone\": \"America/Chicago\",\n \"nextExecutionAt\": null,\n \"archived\": false,\n \"createdAt\": \"2025-02-26T17:48:42.000Z\",\n \"updatedAt\": \"2025-02-26T17:48:42.000Z\"\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"0d7a91e3369c80d01d3448f3acfa3712\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"0b8d79e3-60ee-45a1-9caf-0c41c32cc477","X-Runtime":"0.039699","Content-Length":"531"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/jobs/76/workflows\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer OlW6UvLao5LBCalcv3sF5ldQeFmRedjVaDazkT5dx6k\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/jobs/{id}/shares":{"get":{"summary":"List users and groups permissioned on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object9"}}}},"x-examples":null,"x-deprecation-warning":null}},"/jobs/{id}/shares/users":{"put":{"summary":"Set the permissions users have on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"Object328","in":"body","schema":{"$ref":"#/definitions/Object328"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object9"}}},"x-examples":null,"x-deprecation-warning":null}},"/jobs/{id}/shares/users/{user_id}":{"delete":{"summary":"Revoke the permissions a user has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"user_id","in":"path","required":true,"description":"The ID of the user.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/jobs/{id}/shares/groups":{"put":{"summary":"Set the permissions groups has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"Object329","in":"body","schema":{"$ref":"#/definitions/Object329"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object9"}}},"x-examples":null,"x-deprecation-warning":null}},"/jobs/{id}/shares/groups/{group_id}":{"delete":{"summary":"Revoke the permissions a group has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"group_id","in":"path","required":true,"description":"The ID of the group.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/jobs/{id}/dependencies":{"get":{"summary":"List dependent objects for this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"user_id","in":"query","required":false,"description":"ID of target user","type":"integer"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object15"}}}},"x-examples":null,"x-deprecation-warning":null}},"/jobs/{id}/transfer":{"put":{"summary":"Transfer ownership of this object to another user","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"Object330","in":"body","schema":{"$ref":"#/definitions/Object330"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object17"}}},"x-examples":null,"x-deprecation-warning":null}},"/jobs/{id}/projects":{"get":{"summary":"List the projects a Job belongs to","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Job.","type":"integer"},{"name":"hidden","in":"query","required":false,"description":"If specified to be true, returns hidden items. Defaults to false, returning non-hidden items.","type":"boolean"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object84"}}}},"x-examples":null,"x-deprecation-warning":null}},"/jobs/{id}/projects/{project_id}":{"put":{"summary":"Add a Job to a project","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Job.","type":"integer"},{"name":"project_id","in":"path","required":true,"description":"The ID of the project.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null},"delete":{"summary":"Remove a Job from a project","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Job.","type":"integer"},{"name":"project_id","in":"path","required":true,"description":"The ID of the project.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/jobs/{id}/archive":{"put":{"summary":"Update the archive status of this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the object.","type":"integer"},{"name":"Object331","in":"body","schema":{"$ref":"#/definitions/Object331"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object318"}}},"x-examples":null,"x-deprecation-warning":null}},"/json_values/":{"post":{"summary":"Create a JSON Value","description":"Creates a JSON Value in Platform that can be used as a run output.","deprecated":false,"parameters":[{"name":"Object332","in":"body","schema":{"$ref":"#/definitions/Object332"},"required":true}],"responses":{"201":{"description":"success","schema":{"$ref":"#/definitions/Object333"}}},"x-examples":[{"resource":"JSONValues","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/json_values","description":"Create a JSONValue","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/json_values","request_body":"{\n \"name\": \"my awesome JSON Value\",\n \"value_str\": \"{\\\"foo\\\": \\\"bar\\\"}\"\n}","request_headers":{"Content-Type":"application/json","Authorization":"Bearer Ukc1HQdp7UIQBgEcwk41faLrWYeOAKkWsgXm8w5Vhqw","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":201,"response_status_text":"Created","response_body":"{\n \"id\": 11,\n \"name\": \"my awesome JSON Value\",\n \"value\": {\n \"foo\": \"bar\"\n }\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"b877ca0df07da087c3e9463a0346622f\"","X-Request-Id":"f8645842-e376-468d-acd1-0b98cee53493","X-Runtime":"0.050270","Content-Length":"62"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/json_values\" -d '{\"name\":\"my awesome JSON Value\",\"value_str\":\"{\\\"foo\\\": \\\"bar\\\"}\"}' -X POST \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer Ukc1HQdp7UIQBgEcwk41faLrWYeOAKkWsgXm8w5Vhqw\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/json_values/{id}":{"get":{"summary":"Get details about a JSON Value","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the JSON Value.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object333"}}},"x-examples":[{"resource":"JSONValues","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/json_values/:id","description":"Get a JSONValue","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/json_values/12","request_body":null,"request_headers":{"Content-Type":"application/json","Authorization":"Bearer ox1fOrN8_pW2Vu1UXGoqNo53Bri0Ul-dHJRJNV8CrEE","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 12,\n \"name\": \"my awesome JSON Value\",\n \"value\": 8\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"bc58617e74a168ad9a4b50e5eedbaf28\"","X-Request-Id":"ff85043a-ba9d-41b8-bdd4-322e5c42610a","X-Runtime":"0.043691","Content-Length":"50"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/json_values/12\" -X GET \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer ox1fOrN8_pW2Vu1UXGoqNo53Bri0Ul-dHJRJNV8CrEE\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"patch":{"summary":"Update some attributes of this JSON Value","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the JSON Value.","type":"integer"},{"name":"Object334","in":"body","schema":{"$ref":"#/definitions/Object334"},"required":false}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object333"}}},"x-examples":[{"resource":"JSONValues","resource_explanation":null,"http_method":"PATCH","route":"http://api.civis.test/json_values/:id","description":"Update a JSONValue","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"PATCH","request_path":"http://api.civis.test/json_values/13","request_body":"{\n \"name\": \"updated name\",\n \"value_str\": \"{\\\"foo2\\\": \\\"bar2\\\"}\"\n}","request_headers":{"Content-Type":"application/json","Authorization":"Bearer Vx9TB9DO_5OFKIPXMLFtIanSyOyLpF8-qo672-0tz_M","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 13,\n \"name\": \"updated name\",\n \"value\": {\n \"foo2\": \"bar2\"\n }\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"5fced5cf0d91a9b1b67ae65029af7f56\"","X-Request-Id":"dac51c95-00e4-4e40-a43c-18f7c24691df","X-Runtime":"0.020514","Content-Length":"55"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/json_values/13\" -d '{\"name\":\"updated name\",\"value_str\":\"{\\\"foo2\\\": \\\"bar2\\\"}\"}' -X PATCH \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer Vx9TB9DO_5OFKIPXMLFtIanSyOyLpF8-qo672-0tz_M\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/json_values/{id}/shares":{"get":{"summary":"List users and groups permissioned on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object9"}}}},"x-examples":null,"x-deprecation-warning":null}},"/json_values/{id}/shares/users":{"put":{"summary":"Set the permissions users have on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"Object335","in":"body","schema":{"$ref":"#/definitions/Object335"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object9"}}},"x-examples":null,"x-deprecation-warning":null}},"/json_values/{id}/shares/users/{user_id}":{"delete":{"summary":"Revoke the permissions a user has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"user_id","in":"path","required":true,"description":"The ID of the user.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/json_values/{id}/shares/groups":{"put":{"summary":"Set the permissions groups has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"Object336","in":"body","schema":{"$ref":"#/definitions/Object336"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object9"}}},"x-examples":null,"x-deprecation-warning":null}},"/json_values/{id}/shares/groups/{group_id}":{"delete":{"summary":"Revoke the permissions a group has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"group_id","in":"path","required":true,"description":"The ID of the group.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/json_values/{id}/dependencies":{"get":{"summary":"List dependent objects for this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"user_id","in":"query","required":false,"description":"ID of target user","type":"integer"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object15"}}}},"x-examples":null,"x-deprecation-warning":null}},"/json_values/{id}/transfer":{"put":{"summary":"Transfer ownership of this object to another user","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"Object337","in":"body","schema":{"$ref":"#/definitions/Object337"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object17"}}},"x-examples":null,"x-deprecation-warning":null}},"/match_targets/{id}/shares":{"get":{"summary":"List users and groups permissioned on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object9"}}}},"x-examples":null,"x-deprecation-warning":null}},"/match_targets/{id}/shares/users":{"put":{"summary":"Set the permissions users have on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"Object341","in":"body","schema":{"$ref":"#/definitions/Object341"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object9"}}},"x-examples":null,"x-deprecation-warning":null}},"/match_targets/{id}/shares/users/{user_id}":{"delete":{"summary":"Revoke the permissions a user has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"user_id","in":"path","required":true,"description":"The ID of the user.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/match_targets/{id}/shares/groups":{"put":{"summary":"Set the permissions groups has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"Object342","in":"body","schema":{"$ref":"#/definitions/Object342"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object9"}}},"x-examples":null,"x-deprecation-warning":null}},"/match_targets/{id}/shares/groups/{group_id}":{"delete":{"summary":"Revoke the permissions a group has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"group_id","in":"path","required":true,"description":"The ID of the group.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/match_targets/{id}/archive":{"put":{"summary":"Update the archive status of this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the object.","type":"integer"},{"name":"Object343","in":"body","schema":{"$ref":"#/definitions/Object343"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object344"}}},"x-examples":null,"x-deprecation-warning":null}},"/match_targets/":{"get":{"summary":"List match targets","description":null,"deprecated":false,"parameters":[],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object344"}}}},"x-examples":[{"resource":"Match Targets","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/match_targets","description":"Lists match targets","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/match_targets","request_body":null,"request_headers":{"Content-Type":"application/json","Authorization":"Bearer Nw5eZgitOQCAsxEv1JGuXzUbBGY3qplaqXhZxvYlk-M","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 1,\n \"name\": \"FriendlyString\",\n \"targetFileName\": \"some_file_in_s3\",\n \"createdAt\": \"2023-07-18T18:42:50.000Z\",\n \"updatedAt\": \"2023-07-18T18:42:50.000Z\",\n \"archived\": false\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"3b6c9b07b23fc50f3acd09a74a997a57\"","X-Request-Id":"0ed54c63-9004-4a31-931b-e9510213f255","X-Runtime":"0.012321","Content-Length":"164"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/match_targets\" -X GET \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer Nw5eZgitOQCAsxEv1JGuXzUbBGY3qplaqXhZxvYlk-M\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"post":{"summary":"Create a new match target","description":null,"deprecated":false,"parameters":[{"name":"Object345","in":"body","schema":{"$ref":"#/definitions/Object345"},"required":true}],"responses":{"201":{"description":"success","schema":{"$ref":"#/definitions/Object344"}}},"x-examples":[{"resource":"Match Targets","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/match_targets","description":"Creates a Dynamo match target","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/match_targets","request_body":"{\n \"name\": \"New Match Target\",\n \"target_file_name\": \"file_name\"\n}","request_headers":{"Content-Type":"application/json","Authorization":"Bearer EhjJXvOEbNSYHC8AT1tW4w3D5fpCzbRTS3x9GrEtVWM","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":201,"response_status_text":"Created","response_body":"{\n \"id\": null,\n \"name\": \"New Match Target\",\n \"targetFileName\": \"file_name\",\n \"createdAt\": null,\n \"updatedAt\": null,\n \"archived\": false\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"04710ce4d85980c79660116ceddd2a9f\"","X-Request-Id":"d6091c62-31af-4122-8282-f3d956bdfa4f","X-Runtime":"0.024653","Content-Length":"117"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/match_targets\" -d '{\"name\":\"New Match Target\",\"target_file_name\":\"file_name\"}' -X POST \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer EhjJXvOEbNSYHC8AT1tW4w3D5fpCzbRTS3x9GrEtVWM\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/match_targets/{id}":{"get":{"summary":"Show Match Target info","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the match target","type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object344"}}},"x-examples":[{"resource":"Match Targets","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/match_targets/:id","description":"View a match target's details","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/match_targets/2","request_body":null,"request_headers":{"Content-Type":"application/json","Authorization":"Bearer elw2EdkZB9_QLmgq0MyJXSJHGt58IZG6qIOsb6vxYi8","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 2,\n \"name\": \"FriendlyString\",\n \"targetFileName\": \"some_file_in_s3\",\n \"createdAt\": \"2023-07-18T18:42:50.000Z\",\n \"updatedAt\": \"2023-07-18T18:42:50.000Z\",\n \"archived\": false\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"2d5c426769a1148961bcb00798d80bf8\"","X-Request-Id":"d7aeec2c-6852-4fa9-9310-f9730109eccd","X-Runtime":"0.012820","Content-Length":"162"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/match_targets/2\" -X GET \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer elw2EdkZB9_QLmgq0MyJXSJHGt58IZG6qIOsb6vxYi8\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"patch":{"summary":"Update a match target","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the match target","type":"integer"},{"name":"Object346","in":"body","schema":{"$ref":"#/definitions/Object346"},"required":false}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object344"}}},"x-examples":[{"resource":"Match Targets","resource_explanation":null,"http_method":"PATCH","route":"http://api.civis.test/match_targets/:id","description":"updates a match target","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"PATCH","request_path":"http://api.civis.test/match_targets/4","request_body":"{\n \"name\": \"New Match Target\",\n \"target_file_name\": \"new_file_name\"\n}","request_headers":{"Content-Type":"application/json","Authorization":"Bearer 2YAS2HxMobnvRx6MVhsUZZlopOnOOA1_n6jdojWptds","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 4,\n \"name\": \"New Match Target\",\n \"targetFileName\": \"new_file_name\",\n \"createdAt\": \"2023-07-18T18:42:51.000Z\",\n \"updatedAt\": \"2023-07-18T18:42:51.000Z\",\n \"archived\": false\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"2e6f028a5396009da5b10b7b3a48f50e\"","X-Request-Id":"f1e4e33b-6c13-4e95-b735-b446003ca8a7","X-Runtime":"0.016458","Content-Length":"162"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/match_targets/4\" -d '{\"name\":\"New Match Target\",\"target_file_name\":\"new_file_name\"}' -X PATCH \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer 2YAS2HxMobnvRx6MVhsUZZlopOnOOA1_n6jdojWptds\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/media/spot_orders/{id}/shares":{"get":{"summary":"List users and groups permissioned on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object9"}}}},"x-examples":null,"x-deprecation-warning":null}},"/media/spot_orders/{id}/shares/users":{"put":{"summary":"Set the permissions users have on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"Object347","in":"body","schema":{"$ref":"#/definitions/Object347"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object9"}}},"x-examples":null,"x-deprecation-warning":null}},"/media/spot_orders/{id}/shares/users/{user_id}":{"delete":{"summary":"Revoke the permissions a user has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"user_id","in":"path","required":true,"description":"The ID of the user.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/media/spot_orders/{id}/shares/groups":{"put":{"summary":"Set the permissions groups has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"Object348","in":"body","schema":{"$ref":"#/definitions/Object348"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object9"}}},"x-examples":null,"x-deprecation-warning":null}},"/media/spot_orders/{id}/shares/groups/{group_id}":{"delete":{"summary":"Revoke the permissions a group has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"group_id","in":"path","required":true,"description":"The ID of the group.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/media/spot_orders/{id}/archive":{"put":{"summary":"Update the archive status of this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the object.","type":"integer"},{"name":"Object349","in":"body","schema":{"$ref":"#/definitions/Object349"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object350"}}},"x-examples":null,"x-deprecation-warning":null}},"/media/optimizations/{id}/shares":{"get":{"summary":"List users and groups permissioned on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object9"}}}},"x-examples":null,"x-deprecation-warning":null}},"/media/optimizations/{id}/shares/users":{"put":{"summary":"Set the permissions users have on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"Object351","in":"body","schema":{"$ref":"#/definitions/Object351"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object9"}}},"x-examples":null,"x-deprecation-warning":null}},"/media/optimizations/{id}/shares/users/{user_id}":{"delete":{"summary":"Revoke the permissions a user has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"user_id","in":"path","required":true,"description":"The ID of the user.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/media/optimizations/{id}/shares/groups":{"put":{"summary":"Set the permissions groups has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"Object352","in":"body","schema":{"$ref":"#/definitions/Object352"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object9"}}},"x-examples":null,"x-deprecation-warning":null}},"/media/optimizations/{id}/shares/groups/{group_id}":{"delete":{"summary":"Revoke the permissions a group has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"group_id","in":"path","required":true,"description":"The ID of the group.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/media/optimizations/{id}/archive":{"put":{"summary":"Update the archive status of this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the object.","type":"integer"},{"name":"Object353","in":"body","schema":{"$ref":"#/definitions/Object353"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object354"}}},"x-examples":null,"x-deprecation-warning":null}},"/media/ratecards/{id}/shares":{"get":{"summary":"List users and groups permissioned on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object9"}}}},"x-examples":null,"x-deprecation-warning":null}},"/media/ratecards/{id}/shares/users":{"put":{"summary":"Set the permissions users have on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"Object357","in":"body","schema":{"$ref":"#/definitions/Object357"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object9"}}},"x-examples":null,"x-deprecation-warning":null}},"/media/ratecards/{id}/shares/users/{user_id}":{"delete":{"summary":"Revoke the permissions a user has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"user_id","in":"path","required":true,"description":"The ID of the user.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/media/ratecards/{id}/shares/groups":{"put":{"summary":"Set the permissions groups has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"Object358","in":"body","schema":{"$ref":"#/definitions/Object358"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object9"}}},"x-examples":null,"x-deprecation-warning":null}},"/media/ratecards/{id}/shares/groups/{group_id}":{"delete":{"summary":"Revoke the permissions a group has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"group_id","in":"path","required":true,"description":"The ID of the group.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/media/ratecards/{id}/archive":{"put":{"summary":"Update the archive status of this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the object.","type":"integer"},{"name":"Object359","in":"body","schema":{"$ref":"#/definitions/Object359"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object360"}}},"x-examples":null,"x-deprecation-warning":null}},"/media/optimizations":{"get":{"summary":"List all optimizations","description":null,"deprecated":false,"parameters":[{"name":"archived","in":"query","required":false,"description":"The archival status of the requested item(s).","type":"string"},{"name":"limit","in":"query","required":false,"description":"Number of results to return. Defaults to 20. Maximum allowed is 50.","type":"integer"},{"name":"page_num","in":"query","required":false,"description":"Page number of the results to return. Defaults to the first page, 1.","type":"integer"},{"name":"order","in":"query","required":false,"description":"The field on which to order the result set. Defaults to created_at. Must be one of: created_at, author, name.","type":"string"},{"name":"order_dir","in":"query","required":false,"description":"Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc.","type":"string"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object361"}}}},"x-examples":null,"x-deprecation-warning":null},"post":{"summary":"Create a new optimization","description":null,"deprecated":false,"parameters":[{"name":"Object362","in":"body","schema":{"$ref":"#/definitions/Object362"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object354"}}},"x-examples":null,"x-deprecation-warning":null}},"/media/optimizations/{id}":{"get":{"summary":"Show a single optimization","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The optimization ID.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object354"}}},"x-examples":null,"x-deprecation-warning":null},"patch":{"summary":"Edit an existing optimization","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The optimization ID.","type":"integer"},{"name":"Object366","in":"body","schema":{"$ref":"#/definitions/Object366"},"required":false}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object354"}}},"x-examples":null,"x-deprecation-warning":null}},"/media/optimizations/{id}/clone":{"post":{"summary":"Clone an existing optimization","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The optimization ID.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object354"}}},"x-examples":null,"x-deprecation-warning":null}},"/media/optimizations/{id}/runs":{"post":{"summary":"Start a run","description":"Start a run and provide a URI for checking its status. The response will provide a 'Location' header which will contain a URI which may be polled to monitor the status of the run.","deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Optimization job.","type":"integer"}],"responses":{"202":{"description":"success","schema":{"$ref":"#/definitions/Object365"}}},"x-examples":null,"x-deprecation-warning":null},"get":{"summary":"List runs for the given Optimization job","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Optimization job.","type":"integer"},{"name":"limit","in":"query","required":false,"description":"Number of results to return. Defaults to 20. Maximum allowed is 100.","type":"integer"},{"name":"page_num","in":"query","required":false,"description":"Page number of the results to return. Defaults to the first page, 1.","type":"integer"},{"name":"order","in":"query","required":false,"description":"The field on which to order the result set. Defaults to id. Must be one of: id.","type":"string"},{"name":"order_dir","in":"query","required":false,"description":"Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc.","type":"string"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object365"}}}},"x-examples":null,"x-deprecation-warning":null}},"/media/optimizations/{id}/runs/{run_id}":{"get":{"summary":"Check status of a run","description":"View the status of a run. This endpoint may be polled to monitor the status of the run. When the 'state' field is no longer 'queued' or 'running' the run has reached its final state.","deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Optimization job.","type":"integer"},{"name":"run_id","in":"path","required":true,"description":"The ID of the run.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object365"}}},"x-examples":null,"x-deprecation-warning":null},"delete":{"summary":"Cancel a run","description":"Cancel a currently active run.","deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Optimization job.","type":"integer"},{"name":"run_id","in":"path","required":true,"description":"The ID of the run.","type":"integer"}],"responses":{"202":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/media/optimizations/{id}/runs/{run_id}/logs":{"get":{"summary":"Get the logs for a run","description":"Get the logs for a run.","deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Optimization job.","type":"integer"},{"name":"run_id","in":"path","required":true,"description":"The ID of the run.","type":"integer"},{"name":"last_id","in":"query","required":false,"description":"The ID of the last log message received. Log entries with this ID value or lower will be omitted.Logs are sorted by ID if this value is provided, and are otherwise sorted by createdAt.","type":"integer"},{"name":"limit","in":"query","required":false,"description":"The maximum number of log messages to return. Default of 10000.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object116"}}}},"x-examples":null,"x-deprecation-warning":null}},"/media/spot_orders":{"get":{"summary":"List all spot orders","description":null,"deprecated":false,"parameters":[{"name":"id","in":"query","required":false,"description":"The ID for the spot order.","type":"integer"},{"name":"archived","in":"query","required":false,"description":"The archival status of the requested item(s).","type":"string"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object369"}}}},"x-examples":null,"x-deprecation-warning":null},"post":{"summary":"Create a spot order","description":null,"deprecated":false,"parameters":[{"name":"Object370","in":"body","schema":{"$ref":"#/definitions/Object370"},"required":false}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object350"}}},"x-examples":null,"x-deprecation-warning":null}},"/media/spot_orders/{id}":{"get":{"summary":"Show a single spot order","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID for the spot order.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object350"}}},"x-examples":null,"x-deprecation-warning":null},"put":{"summary":"Edit the specified spot order","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID for the spot order.","type":"integer"},{"name":"Object371","in":"body","schema":{"$ref":"#/definitions/Object371"},"required":false}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object350"}}},"x-examples":null,"x-deprecation-warning":null}},"/media/ratecards":{"get":{"summary":"List all ratecards","description":null,"deprecated":false,"parameters":[{"name":"archived","in":"query","required":false,"description":"The archival status of the requested item(s).","type":"string"},{"name":"filename","in":"query","required":false,"description":"If specified, will be used to filter the ratecards returned. Substring matching is supported with \"%\" and \"*\" wildcards (e.g., \"filename=%ratecard%\" will return both \"ratecard 1\" and \"my ratecard\").","type":"string"},{"name":"dma_number","in":"query","required":false,"description":"If specified, will be used to filter the ratecards by DMA.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object360"}}}},"x-examples":null,"x-deprecation-warning":null},"post":{"summary":"Create a Ratecard","description":null,"deprecated":false,"parameters":[{"name":"Object372","in":"body","schema":{"$ref":"#/definitions/Object372"},"required":true}],"responses":{"201":{"description":"success","schema":{"$ref":"#/definitions/Object360"}}},"x-examples":null,"x-deprecation-warning":null}},"/media/ratecards/{id}":{"get":{"summary":"Get a Ratecard","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object360"}}},"x-examples":null,"x-deprecation-warning":null},"put":{"summary":"Replace all attributes of this Ratecard","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ratecard ID.","type":"integer"},{"name":"Object373","in":"body","schema":{"$ref":"#/definitions/Object373"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object360"}}},"x-examples":null,"x-deprecation-warning":null},"patch":{"summary":"Update some attributes of this Ratecard","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ratecard ID.","type":"integer"},{"name":"Object374","in":"body","schema":{"$ref":"#/definitions/Object374"},"required":false}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object360"}}},"x-examples":null,"x-deprecation-warning":null}},"/media/dmas":{"get":{"summary":"List all Designated Market Areas","description":null,"deprecated":false,"parameters":[{"name":"name","in":"query","required":false,"description":"If specified, will be used to filter the DMAs returned. Substring matching is supported with \"%\" and \"*\" wildcards (e.g., \"name=%region%\" will return both \"region1\" and \"my region\").","type":"string"},{"name":"number","in":"query","required":false,"description":"If specified, will be used to filter the DMAS by number.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object375"}}}},"x-examples":null,"x-deprecation-warning":null}},"/media/targets":{"get":{"summary":"List all Media Targets","description":null,"deprecated":false,"parameters":[{"name":"name","in":"query","required":false,"description":"The name of the target.","type":"string"},{"name":"identifier","in":"query","required":false,"description":"A unique identifier for this target.","type":"string"},{"name":"data_source","in":"query","required":false,"description":"The source of viewership data for this target.","type":"string"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object376"}}}},"x-examples":null,"x-deprecation-warning":null}},"/models/types":{"get":{"summary":"List all available model types","description":null,"deprecated":false,"parameters":[],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object377"}}}},"x-examples":[{"resource":"Models","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/models/types","description":"List model types","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/models/types","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer pMwQCpfoYhfba3GApatyOnOtlvK1isbJk1MKrD2IOjk","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 18,\n \"algorithm\": \"Sparse Logistic\",\n \"dvType\": \"Binary\",\n \"fintAllowed\": true\n },\n {\n \"id\": 19,\n \"algorithm\": \"Vowpal Wabbit\",\n \"dvType\": \"Binary\",\n \"fintAllowed\": false\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"8e957afce90f7cdfe58e2b2c1159ebbd\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"38fd202c-f23f-48d9-9be5-d6ffb15e0b8b","X-Runtime":"0.050903","Content-Length":"154"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/models/types\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer pMwQCpfoYhfba3GApatyOnOtlvK1isbJk1MKrD2IOjk\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/models/":{"get":{"summary":"List ","description":null,"deprecated":false,"parameters":[{"name":"model_name","in":"query","required":false,"description":"If specified, will be used to filter the models returned. Substring matching is supported. (e.g., \"modelName=model\" will return both \"model1\" and \"my model\").","type":"string"},{"name":"training_table_name","in":"query","required":false,"description":"If specified, will be used to filter the models returned by the training dataset table name. Substring matching is supported. (e.g., \"trainingTableName=table\" will return both \"table1\" and \"my_table\").","type":"string"},{"name":"dependent_variable","in":"query","required":false,"description":"If specified, will be used to filter the models returned by the dependent variable column name. Substring matching is supported. (e.g., \"dependentVariable=predictor\" will return both \"predictor\" and \"my predictor\").","type":"string"},{"name":"status","in":"query","required":false,"description":"If specified, returns models with one of these statuses. It accepts a comma-separated list, possible values are 'running', 'failed', 'succeeded', 'idle', 'scheduled'.","type":"string"},{"name":"author","in":"query","required":false,"description":"If specified, return items from any of these authors. It accepts a comma-separated list of user IDs.","type":"string"},{"name":"hidden","in":"query","required":false,"description":"If specified to be true, returns hidden items. Defaults to false, returning non-hidden items.","type":"boolean"},{"name":"archived","in":"query","required":false,"description":"The archival status of the requested item(s).","type":"string"},{"name":"limit","in":"query","required":false,"description":"Number of results to return. Defaults to its maximum of 50.","type":"integer"},{"name":"page_num","in":"query","required":false,"description":"Page number of the results to return. Defaults to the first page, 1.","type":"integer"},{"name":"order","in":"query","required":false,"description":"The field on which to order the result set. Defaults to updated_at. Must be one of: updated_at, name, created_at, last_run.updated_at.","type":"string"},{"name":"order_dir","in":"query","required":false,"description":"Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc.","type":"string"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object378"}}}},"x-examples":[{"resource":"Models","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/models","description":"List models","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/models","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer 56pYoFTY2nP2stVB3M6eeoklAHCgIsqZ5Ha4Q0Mqfpg","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 86,\n \"tableName\": \"schema_name.table_name15\",\n \"databaseId\": 32,\n \"credentialId\": 38,\n \"modelName\": \"and_this_model\",\n \"description\": \"it is a really good model\",\n \"interactionTerms\": false,\n \"boxCoxTransformation\": null,\n \"modelTypeId\": 5,\n \"primaryKey\": \"id\",\n \"dependentVariable\": \"dv\",\n \"dependentVariableOrder\": [\n\n ],\n \"excludedColumns\": [\n\n ],\n \"limitingSQL\": null,\n \"crossValidationParameters\": {\n },\n \"numberOfFolds\": null,\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n },\n \"parentId\": null,\n \"timeZone\": \"America/Chicago\",\n \"lastRun\": null,\n \"user\": {\n \"id\": 147,\n \"name\": \"Admin devadminfactory45 45\",\n \"username\": \"devadminfactory45\",\n \"initials\": \"AD\",\n \"online\": null\n },\n \"createdAt\": \"2025-02-26T17:48:46.000Z\",\n \"updatedAt\": \"2025-02-26T16:48:46.000Z\",\n \"currentBuildState\": \"idle\",\n \"currentBuildException\": null,\n \"builds\": [\n\n ],\n \"predictions\": [\n\n ],\n \"lastOutputLocation\": null,\n \"archived\": false\n },\n {\n \"id\": 85,\n \"tableName\": \"schema_name.table_name14\",\n \"databaseId\": 30,\n \"credentialId\": 35,\n \"modelName\": \"find_this_model_too\",\n \"description\": \"it is a really good model\",\n \"interactionTerms\": false,\n \"boxCoxTransformation\": null,\n \"modelTypeId\": 4,\n \"primaryKey\": \"id\",\n \"dependentVariable\": \"dv\",\n \"dependentVariableOrder\": [\n\n ],\n \"excludedColumns\": [\n\n ],\n \"limitingSQL\": null,\n \"crossValidationParameters\": {\n },\n \"numberOfFolds\": null,\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n },\n \"parentId\": null,\n \"timeZone\": \"America/Chicago\",\n \"lastRun\": null,\n \"user\": {\n \"id\": 148,\n \"name\": \"Admin devadminfactory46 46\",\n \"username\": \"devadminfactory46\",\n \"initials\": \"AD\",\n \"online\": null\n },\n \"createdAt\": \"2025-02-26T17:48:46.000Z\",\n \"updatedAt\": \"2025-02-26T15:48:46.000Z\",\n \"currentBuildState\": \"idle\",\n \"currentBuildException\": null,\n \"builds\": [\n\n ],\n \"predictions\": [\n\n ],\n \"lastOutputLocation\": null,\n \"archived\": false\n },\n {\n \"id\": 83,\n \"tableName\": \"schema_name.table_name12\",\n \"databaseId\": 27,\n \"credentialId\": 31,\n \"modelName\": \"find_this_model\",\n \"description\": \"it is a really good model\",\n \"interactionTerms\": false,\n \"boxCoxTransformation\": null,\n \"modelTypeId\": 3,\n \"primaryKey\": \"id\",\n \"dependentVariable\": \"dv\",\n \"dependentVariableOrder\": [\n\n ],\n \"excludedColumns\": [\n\n ],\n \"limitingSQL\": null,\n \"crossValidationParameters\": {\n },\n \"numberOfFolds\": null,\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n },\n \"parentId\": null,\n \"timeZone\": \"America/Chicago\",\n \"lastRun\": null,\n \"user\": {\n \"id\": 148,\n \"name\": \"Admin devadminfactory46 46\",\n \"username\": \"devadminfactory46\",\n \"initials\": \"AD\",\n \"online\": null\n },\n \"createdAt\": \"2025-02-26T17:48:45.000Z\",\n \"updatedAt\": \"2025-02-26T14:48:46.000Z\",\n \"currentBuildState\": \"idle\",\n \"currentBuildException\": null,\n \"builds\": [\n {\n \"id\": 40,\n \"name\": \"v3\",\n \"createdAt\": \"2025-02-26T17:48:46.000Z\",\n \"description\": null,\n \"rootMeanSquaredError\": null,\n \"rSquaredError\": null,\n \"rocAuc\": null\n }\n ],\n \"predictions\": [\n\n ],\n \"lastOutputLocation\": null,\n \"archived\": false\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","X-Pagination-Per-Page":"50","Access-Control-Expose-Headers":"X-Pagination-Per-Page, X-Pagination-Current-Page, X-Pagination-Total-Pages, X-Pagination-Total-Entries","X-Pagination-Current-Page":"1","X-Pagination-Total-Pages":"1","X-Pagination-Total-Entries":"3","Content-Type":"application/json; charset=utf-8","ETag":"W/\"71db636e8b5683a687a95afe4ba59f88\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"f7ae132c-2d1c-4e16-a257-f2960be31ab8","X-Runtime":"0.066441","Content-Length":"2885"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/models\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer 56pYoFTY2nP2stVB3M6eeoklAHCgIsqZ5Ha4Q0Mqfpg\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Models","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/models?modelName=find_this_model","description":"Filter models by model name","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/models?modelName=find_this_model","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer nqRZ0I7ulM7tFX-2B2babDKZrRARQsmzMDP8zG_v8CU","Host":"api.civis.test","Cookie":""},"request_query_parameters":{"modelName":"find_this_model"},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 89,\n \"tableName\": \"schema_name.table_name18\",\n \"databaseId\": 37,\n \"credentialId\": 45,\n \"modelName\": \"find_this_model_too\",\n \"description\": \"it is a really good model\",\n \"interactionTerms\": false,\n \"boxCoxTransformation\": null,\n \"modelTypeId\": 7,\n \"primaryKey\": \"id\",\n \"dependentVariable\": \"dv\",\n \"dependentVariableOrder\": [\n\n ],\n \"excludedColumns\": [\n\n ],\n \"limitingSQL\": null,\n \"crossValidationParameters\": {\n },\n \"numberOfFolds\": null,\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n },\n \"parentId\": null,\n \"timeZone\": \"America/Chicago\",\n \"lastRun\": null,\n \"user\": {\n \"id\": 155,\n \"name\": \"Admin devadminfactory52 52\",\n \"username\": \"devadminfactory52\",\n \"initials\": \"AD\",\n \"online\": null\n },\n \"createdAt\": \"2025-02-26T17:48:47.000Z\",\n \"updatedAt\": \"2025-02-26T15:48:47.000Z\",\n \"currentBuildState\": \"idle\",\n \"currentBuildException\": null,\n \"builds\": [\n\n ],\n \"predictions\": [\n\n ],\n \"lastOutputLocation\": null,\n \"archived\": false\n },\n {\n \"id\": 87,\n \"tableName\": \"schema_name.table_name16\",\n \"databaseId\": 34,\n \"credentialId\": 41,\n \"modelName\": \"find_this_model\",\n \"description\": \"it is a really good model\",\n \"interactionTerms\": false,\n \"boxCoxTransformation\": null,\n \"modelTypeId\": 6,\n \"primaryKey\": \"id\",\n \"dependentVariable\": \"dv\",\n \"dependentVariableOrder\": [\n\n ],\n \"excludedColumns\": [\n\n ],\n \"limitingSQL\": null,\n \"crossValidationParameters\": {\n },\n \"numberOfFolds\": null,\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n },\n \"parentId\": null,\n \"timeZone\": \"America/Chicago\",\n \"lastRun\": null,\n \"user\": {\n \"id\": 155,\n \"name\": \"Admin devadminfactory52 52\",\n \"username\": \"devadminfactory52\",\n \"initials\": \"AD\",\n \"online\": null\n },\n \"createdAt\": \"2025-02-26T17:48:47.000Z\",\n \"updatedAt\": \"2025-02-26T14:48:47.000Z\",\n \"currentBuildState\": \"idle\",\n \"currentBuildException\": null,\n \"builds\": [\n {\n \"id\": 41,\n \"name\": \"v4\",\n \"createdAt\": \"2025-02-26T17:48:47.000Z\",\n \"description\": null,\n \"rootMeanSquaredError\": null,\n \"rSquaredError\": null,\n \"rocAuc\": null\n }\n ],\n \"predictions\": [\n\n ],\n \"lastOutputLocation\": null,\n \"archived\": false\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","X-Pagination-Per-Page":"50","Access-Control-Expose-Headers":"X-Pagination-Per-Page, X-Pagination-Current-Page, X-Pagination-Total-Pages, X-Pagination-Total-Entries","X-Pagination-Current-Page":"1","X-Pagination-Total-Pages":"1","X-Pagination-Total-Entries":"2","Content-Type":"application/json; charset=utf-8","ETag":"W/\"5b9688d483255f284aabcd46701f98be\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"e7a8954d-d3bb-4126-9248-98a63917704a","X-Runtime":"0.055989","Content-Length":"1973"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/models?modelName=find_this_model\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer nqRZ0I7ulM7tFX-2B2babDKZrRARQsmzMDP8zG_v8CU\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Models","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/models?trainingTableName=training_table","description":"Filter models by training table name","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/models?trainingTableName=training_table","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer KXgz3gCEB5IaoOhsEs0KF-OK4mJkfRc0v5frFLjvm1w","Host":"api.civis.test","Cookie":""},"request_query_parameters":{"trainingTableName":"training_table"},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 94,\n \"tableName\": \"my_training_table\",\n \"databaseId\": 46,\n \"credentialId\": 58,\n \"modelName\": \"find_this_model_too\",\n \"description\": \"it is a really good model\",\n \"interactionTerms\": false,\n \"boxCoxTransformation\": null,\n \"modelTypeId\": 11,\n \"primaryKey\": \"id\",\n \"dependentVariable\": \"dv\",\n \"dependentVariableOrder\": [\n\n ],\n \"excludedColumns\": [\n\n ],\n \"limitingSQL\": null,\n \"crossValidationParameters\": {\n },\n \"numberOfFolds\": null,\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n },\n \"parentId\": null,\n \"timeZone\": \"America/Chicago\",\n \"lastRun\": null,\n \"user\": {\n \"id\": 163,\n \"name\": \"Admin devadminfactory59 59\",\n \"username\": \"devadminfactory59\",\n \"initials\": \"AD\",\n \"online\": null\n },\n \"createdAt\": \"2025-02-26T17:48:49.000Z\",\n \"updatedAt\": \"2025-02-26T15:48:49.000Z\",\n \"currentBuildState\": \"idle\",\n \"currentBuildException\": null,\n \"builds\": [\n\n ],\n \"predictions\": [\n\n ],\n \"lastOutputLocation\": null,\n \"archived\": false\n },\n {\n \"id\": 92,\n \"tableName\": \"training_table\",\n \"databaseId\": 43,\n \"credentialId\": 54,\n \"modelName\": \"find_this_model\",\n \"description\": \"it is a really good model\",\n \"interactionTerms\": false,\n \"boxCoxTransformation\": null,\n \"modelTypeId\": 10,\n \"primaryKey\": \"id\",\n \"dependentVariable\": \"dv\",\n \"dependentVariableOrder\": [\n\n ],\n \"excludedColumns\": [\n\n ],\n \"limitingSQL\": null,\n \"crossValidationParameters\": {\n },\n \"numberOfFolds\": null,\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n },\n \"parentId\": null,\n \"timeZone\": \"America/Chicago\",\n \"lastRun\": null,\n \"user\": {\n \"id\": 163,\n \"name\": \"Admin devadminfactory59 59\",\n \"username\": \"devadminfactory59\",\n \"initials\": \"AD\",\n \"online\": null\n },\n \"createdAt\": \"2025-02-26T17:48:48.000Z\",\n \"updatedAt\": \"2025-02-26T14:48:48.000Z\",\n \"currentBuildState\": \"idle\",\n \"currentBuildException\": null,\n \"builds\": [\n {\n \"id\": 42,\n \"name\": \"v5\",\n \"createdAt\": \"2025-02-26T17:48:48.000Z\",\n \"description\": null,\n \"rootMeanSquaredError\": null,\n \"rSquaredError\": null,\n \"rocAuc\": null\n }\n ],\n \"predictions\": [\n\n ],\n \"lastOutputLocation\": null,\n \"archived\": false\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","X-Pagination-Per-Page":"50","Access-Control-Expose-Headers":"X-Pagination-Per-Page, X-Pagination-Current-Page, X-Pagination-Total-Pages, X-Pagination-Total-Entries","X-Pagination-Current-Page":"1","X-Pagination-Total-Pages":"1","X-Pagination-Total-Entries":"2","Content-Type":"application/json; charset=utf-8","ETag":"W/\"962c7f847ca1d2858524654f1dd3a758\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"bc58c369-a6c2-4b52-86d6-5fc6a403b74d","X-Runtime":"0.067097","Content-Length":"1958"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/models?trainingTableName=training_table\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer KXgz3gCEB5IaoOhsEs0KF-OK4mJkfRc0v5frFLjvm1w\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Models","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/models?dependentVariable=dv","description":"Filter models by dependent variable","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/models?dependentVariable=dv","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer Qk7uTKc96xx6E8qHzbcAdh2M8kJbCvfMXJZODrbyhnI","Host":"api.civis.test","Cookie":""},"request_query_parameters":{"dependentVariable":"dv"},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 99,\n \"tableName\": \"schema_name.table_name28\",\n \"databaseId\": 55,\n \"credentialId\": 71,\n \"modelName\": \"find_this_model_too\",\n \"description\": \"it is a really good model\",\n \"interactionTerms\": false,\n \"boxCoxTransformation\": null,\n \"modelTypeId\": 15,\n \"primaryKey\": \"id\",\n \"dependentVariable\": \"my_dv\",\n \"dependentVariableOrder\": [\n\n ],\n \"excludedColumns\": [\n\n ],\n \"limitingSQL\": null,\n \"crossValidationParameters\": {\n },\n \"numberOfFolds\": null,\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n },\n \"parentId\": null,\n \"timeZone\": \"America/Chicago\",\n \"lastRun\": null,\n \"user\": {\n \"id\": 171,\n \"name\": \"Admin devadminfactory66 66\",\n \"username\": \"devadminfactory66\",\n \"initials\": \"AD\",\n \"online\": null\n },\n \"createdAt\": \"2025-02-26T17:48:50.000Z\",\n \"updatedAt\": \"2025-02-26T15:48:50.000Z\",\n \"currentBuildState\": \"idle\",\n \"currentBuildException\": null,\n \"builds\": [\n\n ],\n \"predictions\": [\n\n ],\n \"lastOutputLocation\": null,\n \"archived\": false\n },\n {\n \"id\": 97,\n \"tableName\": \"schema_name.table_name26\",\n \"databaseId\": 52,\n \"credentialId\": 67,\n \"modelName\": \"find_this_model\",\n \"description\": \"it is a really good model\",\n \"interactionTerms\": false,\n \"boxCoxTransformation\": null,\n \"modelTypeId\": 14,\n \"primaryKey\": \"id\",\n \"dependentVariable\": \"dv\",\n \"dependentVariableOrder\": [\n\n ],\n \"excludedColumns\": [\n\n ],\n \"limitingSQL\": null,\n \"crossValidationParameters\": {\n },\n \"numberOfFolds\": null,\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n },\n \"parentId\": null,\n \"timeZone\": \"America/Chicago\",\n \"lastRun\": null,\n \"user\": {\n \"id\": 171,\n \"name\": \"Admin devadminfactory66 66\",\n \"username\": \"devadminfactory66\",\n \"initials\": \"AD\",\n \"online\": null\n },\n \"createdAt\": \"2025-02-26T17:48:49.000Z\",\n \"updatedAt\": \"2025-02-26T14:48:50.000Z\",\n \"currentBuildState\": \"idle\",\n \"currentBuildException\": null,\n \"builds\": [\n {\n \"id\": 43,\n \"name\": \"v6\",\n \"createdAt\": \"2025-02-26T17:48:50.000Z\",\n \"description\": null,\n \"rootMeanSquaredError\": null,\n \"rSquaredError\": null,\n \"rocAuc\": null\n }\n ],\n \"predictions\": [\n\n ],\n \"lastOutputLocation\": null,\n \"archived\": false\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","X-Pagination-Per-Page":"50","Access-Control-Expose-Headers":"X-Pagination-Per-Page, X-Pagination-Current-Page, X-Pagination-Total-Pages, X-Pagination-Total-Entries","X-Pagination-Current-Page":"1","X-Pagination-Total-Pages":"1","X-Pagination-Total-Entries":"2","Content-Type":"application/json; charset=utf-8","ETag":"W/\"eac5b21c61e34574669be9d86c8b2041\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"e678df4e-274e-4d3a-aa0b-308b50444861","X-Runtime":"0.064744","Content-Length":"1978"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/models?dependentVariable=dv\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer Qk7uTKc96xx6E8qHzbcAdh2M8kJbCvfMXJZODrbyhnI\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/models/{id}":{"get":{"summary":"Retrieve model configuration","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the model.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object381"}}},"x-examples":[{"resource":"Models","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/models/:id","description":"Get a model","explanation":null,"parameters":[{"required":true,"name":"id","description":"The ID of the model."}],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/models/80","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer l2Y9SDM2bDwqVcsgGYudxT4d46kBwIkrDyf03sx0S8M","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 80,\n \"tableName\": \"schema_name.table_name10\",\n \"databaseId\": 24,\n \"credentialId\": 27,\n \"modelName\": \"Model #80\",\n \"description\": \"it is a really good model\",\n \"interactionTerms\": false,\n \"boxCoxTransformation\": null,\n \"modelTypeId\": 2,\n \"primaryKey\": \"id\",\n \"dependentVariable\": \"dv\",\n \"dependentVariableOrder\": [\n\n ],\n \"excludedColumns\": [\n\n ],\n \"limitingSQL\": null,\n \"activeBuildId\": null,\n \"crossValidationParameters\": {\n },\n \"numberOfFolds\": null,\n \"notifications\": {\n \"urls\": [\n\n ],\n \"successEmailSubject\": null,\n \"successEmailBody\": null,\n \"successEmailAddresses\": [\n\n ],\n \"successEmailFromName\": null,\n \"successEmailReplyTo\": null,\n \"failureEmailAddresses\": [\n\n ],\n \"stallWarningMinutes\": null,\n \"successOn\": true,\n \"failureOn\": true\n },\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n },\n \"parentId\": null,\n \"runningAs\": {\n \"id\": 138,\n \"name\": \"Admin devadminfactory41 41\",\n \"username\": \"devadminfactory41\",\n \"initials\": \"AD\",\n \"online\": null\n },\n \"timeZone\": \"America/Chicago\",\n \"lastRun\": {\n \"id\": 39,\n \"state\": \"failed\",\n \"createdAt\": \"2025-02-26T17:48:45.000Z\",\n \"startedAt\": null,\n \"finishedAt\": null,\n \"error\": null\n },\n \"hidden\": false,\n \"user\": {\n \"id\": 138,\n \"name\": \"Admin devadminfactory41 41\",\n \"username\": \"devadminfactory41\",\n \"initials\": \"AD\",\n \"online\": null\n },\n \"createdAt\": \"2025-02-26T17:48:44.000Z\",\n \"updatedAt\": \"2025-02-26T17:48:44.000Z\",\n \"currentBuildState\": \"failed\",\n \"currentBuildException\": null,\n \"builds\": [\n {\n \"id\": 37,\n \"name\": \"v1\",\n \"createdAt\": \"2025-02-26T17:48:44.000Z\",\n \"description\": null,\n \"rootMeanSquaredError\": null,\n \"rSquaredError\": null,\n \"rocAuc\": null\n }\n ],\n \"predictions\": [\n {\n \"id\": 82,\n \"tableName\": \"schema_name.table_name2\",\n \"primaryKey\": [\n \"personid\"\n ],\n \"limitingSQL\": null,\n \"outputTable\": \"schema.out_table\",\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n },\n \"state\": \"idle\"\n }\n ],\n \"lastOutputLocation\": null,\n \"archived\": false\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"6853220586d05588d0845f60ebeb4ebe\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"0586484c-9aa1-4911-9508-f9d9512ea247","X-Runtime":"0.190568","Content-Length":"1849"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/models/80\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer l2Y9SDM2bDwqVcsgGYudxT4d46kBwIkrDyf03sx0S8M\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/models/{id}/builds/{build_id}":{"get":{"summary":"Check status of a build","description":"View the status of a build. This endpoint may be polled to monitor the status of the build. When the 'state' field is no longer 'queued' or 'running' the build has reached its final state.","deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Model job.","type":"integer"},{"name":"build_id","in":"path","required":true,"description":"The ID of the build.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object383"}}},"x-examples":[{"resource":"Models","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/models/:model_id/builds/:build_id","description":"Show build output","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/models/8/builds/44","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer s6qB3rZb1Dw1cYfE8m9TRfmHYHbdtWjCThcP4QAtP8U","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 44,\n \"state\": \"queued\",\n \"error\": null,\n \"name\": \"v7\",\n \"createdAt\": \"2025-02-26T17:48:51.000Z\",\n \"description\": null,\n \"rootMeanSquaredError\": null,\n \"rSquaredError\": null,\n \"rocAuc\": null,\n \"transformationMetadata\": {\n },\n \"output\": \"{\\\"a\\\": 1}\",\n \"outputLocation\": \"http://dummy_output_uri\"\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"7a5041ad3acdf06ad15079c582a88fe1\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"f1cbad9e-9600-4b12-8cb3-00a0b8a9312d","X-Runtime":"0.075560","Content-Length":"265"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/models/8/builds/44\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer s6qB3rZb1Dw1cYfE8m9TRfmHYHbdtWjCThcP4QAtP8U\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"delete":{"summary":"Cancel a build","description":"Cancel a currently active build.","deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Model job.","type":"integer"},{"name":"build_id","in":"path","required":true,"description":"The ID of the build.","type":"integer"}],"responses":{"202":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/models/{id}/builds":{"get":{"summary":"List builds for the given Model job","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Model job.","type":"integer"},{"name":"limit","in":"query","required":false,"description":"Number of results to return. Defaults to 20. Maximum allowed is 100.","type":"integer"},{"name":"page_num","in":"query","required":false,"description":"Page number of the results to return. Defaults to the first page, 1.","type":"integer"},{"name":"order","in":"query","required":false,"description":"The field on which to order the result set. Defaults to id. Must be one of: id.","type":"string"},{"name":"order_dir","in":"query","required":false,"description":"Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc.","type":"string"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object383"}}}},"x-examples":[{"resource":"Models","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/models/:model_id/builds","description":"Show build output","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/models/8/builds","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer QCifE6s1VRU3uf8htlXmhnkZexEz38VK2E_ntHwPcQM","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 46,\n \"state\": \"running\",\n \"error\": null,\n \"name\": \"v9\",\n \"createdAt\": \"2025-02-26T17:48:52.000Z\",\n \"description\": null,\n \"rootMeanSquaredError\": null,\n \"rSquaredError\": null,\n \"rocAuc\": null,\n \"transformationMetadata\": {\n },\n \"output\": null,\n \"outputLocation\": \"http://dummy_output_uri\"\n },\n {\n \"id\": 45,\n \"state\": \"queued\",\n \"error\": null,\n \"name\": \"v8\",\n \"createdAt\": \"2025-02-26T17:48:52.000Z\",\n \"description\": null,\n \"rootMeanSquaredError\": null,\n \"rSquaredError\": null,\n \"rocAuc\": null,\n \"transformationMetadata\": {\n },\n \"output\": \"{\\\"a\\\": 1}\",\n \"outputLocation\": \"http://dummy_output_uri\"\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","X-Pagination-Per-Page":"20","Access-Control-Expose-Headers":"X-Pagination-Per-Page, X-Pagination-Current-Page, X-Pagination-Total-Pages, X-Pagination-Total-Entries","X-Pagination-Current-Page":"1","X-Pagination-Total-Pages":"1","X-Pagination-Total-Entries":"2","Content-Type":"application/json; charset=utf-8","ETag":"W/\"7b6ae44178d7eec15352efb104f32fe2\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"7ed8df71-64fe-4e64-9336-290696c19751","X-Runtime":"0.105335","Content-Length":"526"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/models/8/builds\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer QCifE6s1VRU3uf8htlXmhnkZexEz38VK2E_ntHwPcQM\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/models/{id}/builds/{build_id}/logs":{"get":{"summary":"Get the logs for a build","description":"Get the logs for a build.","deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Model job.","type":"integer"},{"name":"build_id","in":"path","required":true,"description":"The ID of the build.","type":"integer"},{"name":"last_id","in":"query","required":false,"description":"The ID of the last log message received. Log entries with this ID value or lower will be omitted.Logs are sorted by ID if this value is provided, and are otherwise sorted by createdAt.","type":"integer"},{"name":"limit","in":"query","required":false,"description":"The maximum number of log messages to return. Default of 10000.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object116"}}}},"x-examples":null,"x-deprecation-warning":null}},"/models/{id}/shares":{"get":{"summary":"List users and groups permissioned on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object9"}}}},"x-examples":null,"x-deprecation-warning":null}},"/models/{id}/shares/users":{"put":{"summary":"Set the permissions users have on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"Object384","in":"body","schema":{"$ref":"#/definitions/Object384"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object9"}}},"x-examples":null,"x-deprecation-warning":null}},"/models/{id}/shares/users/{user_id}":{"delete":{"summary":"Revoke the permissions a user has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"user_id","in":"path","required":true,"description":"The ID of the user.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/models/{id}/shares/groups":{"put":{"summary":"Set the permissions groups has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"Object385","in":"body","schema":{"$ref":"#/definitions/Object385"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object9"}}},"x-examples":null,"x-deprecation-warning":null}},"/models/{id}/shares/groups/{group_id}":{"delete":{"summary":"Revoke the permissions a group has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"group_id","in":"path","required":true,"description":"The ID of the group.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/models/{id}/dependencies":{"get":{"summary":"List dependent objects for this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"user_id","in":"query","required":false,"description":"ID of target user","type":"integer"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object15"}}}},"x-examples":null,"x-deprecation-warning":null}},"/models/{id}/transfer":{"put":{"summary":"Transfer ownership of this object to another user","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"Object386","in":"body","schema":{"$ref":"#/definitions/Object386"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object17"}}},"x-examples":null,"x-deprecation-warning":null}},"/models/{id}/projects":{"get":{"summary":"List the projects a Model belongs to","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Model.","type":"integer"},{"name":"hidden","in":"query","required":false,"description":"If specified to be true, returns hidden items. Defaults to false, returning non-hidden items.","type":"boolean"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object84"}}}},"x-examples":null,"x-deprecation-warning":null}},"/models/{id}/projects/{project_id}":{"put":{"summary":"Add a Model to a project","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Model.","type":"integer"},{"name":"project_id","in":"path","required":true,"description":"The ID of the project.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null},"delete":{"summary":"Remove a Model from a project","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Model.","type":"integer"},{"name":"project_id","in":"path","required":true,"description":"The ID of the project.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/models/{id}/archive":{"put":{"summary":"Update the archive status of this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the object.","type":"integer"},{"name":"Object387","in":"body","schema":{"$ref":"#/definitions/Object387"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object381"}}},"x-examples":null,"x-deprecation-warning":null}},"/models/{id}/schedules":{"get":{"summary":"Show the model build schedule","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the model associated with this schedule.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object388"}}},"x-examples":[{"resource":"Models","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/models/:id/schedules","description":"View a model's schedule","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/models/78/schedules","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer IZqw8tmj3kagOYtnFNe3OUXLOraSfBE5hagTzhsihrQ","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 78,\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n }\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"c452548657cab88c9acd47a0f12ddfa0\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"7173189d-8d83-42c0-b834-73f2cf0f3530","X-Runtime":"0.071361","Content-Length":"154"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/models/78/schedules\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer IZqw8tmj3kagOYtnFNe3OUXLOraSfBE5hagTzhsihrQ\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/notebooks/":{"get":{"summary":"List Notebooks","description":null,"deprecated":false,"parameters":[{"name":"hidden","in":"query","required":false,"description":"If specified to be true, returns hidden items. Defaults to false, returning non-hidden items.","type":"boolean"},{"name":"archived","in":"query","required":false,"description":"The archival status of the requested item(s).","type":"string"},{"name":"author","in":"query","required":false,"description":"If specified, return items from any of these authors. It accepts a comma-separated list of user IDs.","type":"string"},{"name":"status","in":"query","required":false,"description":"If specified, returns notebooks with one of these statuses. It accepts a comma-separated list, possible values are 'running', 'pending', 'idle'.","type":"string"},{"name":"limit","in":"query","required":false,"description":"Number of results to return. Defaults to 20. Maximum allowed is 50.","type":"integer"},{"name":"page_num","in":"query","required":false,"description":"Page number of the results to return. Defaults to the first page, 1.","type":"integer"},{"name":"order","in":"query","required":false,"description":"The field on which to order the result set. Defaults to updated_at. Must be one of: updated_at, name, created_at.","type":"string"},{"name":"order_dir","in":"query","required":false,"description":"Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc.","type":"string"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object389"}}}},"x-examples":[{"resource":"Notebooks","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/notebooks","description":"List all notebooks","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/notebooks","request_body":null,"request_headers":{"Content-Type":"application/json","Authorization":"Bearer CKAL5MX5aRiYWcDNiM8oR_Zhl6OyQddAWoJ_COLDFDg","Accept":"application/vnd.civis-platform.v1","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 1,\n \"name\": \"Test Notebook\",\n \"language\": \"python3\",\n \"description\": null,\n \"user\": {\n \"id\": 2515,\n \"name\": \"User devuserfactory1841 1839\",\n \"username\": \"devuserfactory1841\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"createdAt\": \"2023-07-18T18:42:58.000Z\",\n \"updatedAt\": \"2023-07-18T18:42:58.000Z\",\n \"mostRecentDeployment\": null,\n \"archived\": false\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","X-Pagination-Per-Page":"20","Access-Control-Expose-Headers":"X-Pagination-Per-Page, X-Pagination-Current-Page, X-Pagination-Total-Pages, X-Pagination-Total-Entries","X-Pagination-Current-Page":"1","X-Pagination-Total-Pages":"1","X-Pagination-Total-Entries":"1","Content-Type":"application/json; charset=utf-8","ETag":"W/\"be934a57a069f5e1df52babec133c50b\"","X-Request-Id":"a25a3d90-a46d-46c8-a81a-20fed26112cb","X-Runtime":"0.020943","Content-Length":"315"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/notebooks\" -X GET \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer CKAL5MX5aRiYWcDNiM8oR_Zhl6OyQddAWoJ_COLDFDg\" \\\n\t-H \"Accept: application/vnd.civis-platform.v1\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"post":{"summary":"Create a Notebook","description":null,"deprecated":false,"parameters":[{"name":"Object391","in":"body","schema":{"$ref":"#/definitions/Object391"},"required":false}],"responses":{"201":{"description":"success","schema":{"$ref":"#/definitions/Object392"}}},"x-examples":[{"resource":"Notebooks","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/notebooks","description":"Create a notebook","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/notebooks","request_body":"{\n \"name\": \"Custom Name\",\n \"language\": \"python3\",\n \"docker_image_tag\": \"1.0.0\"\n}","request_headers":{"Content-Type":"application/json","Authorization":"Bearer X-9aGPhHNWjtyvWu7I_dQUKvT2v5Ug31DtO5KO2toSg","Accept":"application/vnd.civis-platform.v1","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":201,"response_status_text":"Created","response_body":"{\n \"id\": 6,\n \"name\": \"Custom Name\",\n \"language\": \"python3\",\n \"description\": null,\n \"notebookUrl\": \"https://civis-console.s3.amazonaws.com/tgtg/notebooks/1/notebook.ipynb?AWSAccessKeyId=XXX&Expires=1490366474&Signature=XXX&response-content-type=application%2Foctet-stream&x-amz-security-token=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX\",\n \"notebookPreviewUrl\": \"https://civis-console.s3.amazonaws.com/tgtg/notebooks/1/preview.html?AWSAccessKeyId=XXX&Expires=1490366474&Signature=XXX&response-content-type=application%2Foctet-stream&x-amz-security-token=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX\",\n \"requirementsUrl\": \"https://civis-console.s3.amazonaws.com/tgtg/notebooks/1/requirements.txt?AWSAccessKeyId=XXX&Expires=1490366474&Signature=XXX&response-content-type=application%2Foctet-stream&x-amz-security-token=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX\",\n \"fileId\": 86,\n \"requirementsFileId\": 88,\n \"user\": {\n \"id\": 2528,\n \"name\": \"User devuserfactory1854 1852\",\n \"username\": \"devuserfactory1854\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"dockerImageName\": \"civisanalytics/civis-jupyter-python3\",\n \"dockerImageTag\": \"1.0.0\",\n \"instanceType\": null,\n \"memory\": 3000,\n \"cpu\": 800,\n \"createdAt\": \"2023-07-18T18:43:00.000Z\",\n \"updatedAt\": \"2023-07-18T18:43:00.000Z\",\n \"mostRecentDeployment\": null,\n \"credentials\": [\n\n ],\n \"environmentVariables\": {\n },\n \"idleTimeout\": 3,\n \"partitionLabel\": null,\n \"gitRepoId\": null,\n \"gitRepoUrl\": null,\n \"gitRef\": null,\n \"gitPath\": null,\n \"myPermissionLevel\": \"manage\",\n \"archived\": false,\n \"hidden\": false\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"5a34f8453aa32ad9b41ebd62f521ce32\"","X-Request-Id":"2f7c15c3-188f-40cf-bca3-bb2ae190bf43","X-Runtime":"0.193441","Content-Length":"1573"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/notebooks\" -d '{\"name\":\"Custom Name\",\"language\":\"python3\",\"docker_image_tag\":\"1.0.0\"}' -X POST \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer X-9aGPhHNWjtyvWu7I_dQUKvT2v5Ug31DtO5KO2toSg\" \\\n\t-H \"Accept: application/vnd.civis-platform.v1\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Notebooks","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/notebooks","description":"Create a notebook with non-default values","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/notebooks","request_body":"{\n \"name\": \"Custom name\",\n \"language\": \"r\",\n \"memory\": 3000,\n \"cpu\": 600,\n \"dockerImageName\": \"dummy\",\n \"dockerImageTag\": \"dummy\",\n \"credentials\": [\n 728\n ]\n}","request_headers":{"Content-Type":"application/json","Authorization":"Bearer MD16yK7MwwSCyIyb1Xuzx-2xEwgAQYX6rQJqJmxKlNg","Accept":"application/vnd.civis-platform.v1","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":201,"response_status_text":"Created","response_body":"{\n \"id\": 8,\n \"name\": \"Custom name\",\n \"language\": \"r\",\n \"description\": null,\n \"notebookUrl\": \"https://civis-console.s3.amazonaws.com/tgtg/notebooks/1/notebook.ipynb?AWSAccessKeyId=XXX&Expires=1490366474&Signature=XXX&response-content-type=application%2Foctet-stream&x-amz-security-token=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX\",\n \"notebookPreviewUrl\": \"https://civis-console.s3.amazonaws.com/tgtg/notebooks/1/preview.html?AWSAccessKeyId=XXX&Expires=1490366474&Signature=XXX&response-content-type=application%2Foctet-stream&x-amz-security-token=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX\",\n \"requirementsUrl\": \"https://civis-console.s3.amazonaws.com/tgtg/notebooks/1/requirements.txt?AWSAccessKeyId=XXX&Expires=1490366474&Signature=XXX&response-content-type=application%2Foctet-stream&x-amz-security-token=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX\",\n \"fileId\": 92,\n \"requirementsFileId\": 94,\n \"user\": {\n \"id\": 2533,\n \"name\": \"User devuserfactory1859 1857\",\n \"username\": \"devuserfactory1859\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"dockerImageName\": \"dummy\",\n \"dockerImageTag\": \"dummy\",\n \"instanceType\": null,\n \"memory\": 3000,\n \"cpu\": 600,\n \"createdAt\": \"2023-07-18T18:43:00.000Z\",\n \"updatedAt\": \"2023-07-18T18:43:00.000Z\",\n \"mostRecentDeployment\": null,\n \"credentials\": [\n {\n \"id\": 728,\n \"name\": \"api-key-1\"\n }\n ],\n \"environmentVariables\": {\n },\n \"idleTimeout\": 3,\n \"partitionLabel\": null,\n \"gitRepoId\": null,\n \"gitRepoUrl\": null,\n \"gitRef\": null,\n \"gitPath\": null,\n \"myPermissionLevel\": \"manage\",\n \"archived\": false,\n \"hidden\": false\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"b8c572169a911cea56c4625be8c8bb26\"","X-Request-Id":"763a29ef-6793-4630-9608-99019f686b9b","X-Runtime":"0.190343","Content-Length":"1565"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/notebooks\" -d '{\"name\":\"Custom name\",\"language\":\"r\",\"memory\":3000,\"cpu\":600,\"dockerImageName\":\"dummy\",\"dockerImageTag\":\"dummy\",\"credentials\":[728]}' -X POST \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer MD16yK7MwwSCyIyb1Xuzx-2xEwgAQYX6rQJqJmxKlNg\" \\\n\t-H \"Accept: application/vnd.civis-platform.v1\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/notebooks/{id}":{"get":{"summary":"Get a Notebook","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object392"}}},"x-examples":[{"resource":"Notebooks","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/notebooks/:id","description":"View a notebooks's details","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/notebooks/2","request_body":null,"request_headers":{"Content-Type":"application/json","Authorization":"Bearer Z-qcZ_47g4EV_PG-nzACgJ1ehfs_dg2__7Jkhe1W-x0","Accept":"application/vnd.civis-platform.v1","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 2,\n \"name\": \"Test Notebook\",\n \"language\": \"python3\",\n \"description\": null,\n \"notebookUrl\": \"https://civis-console.s3.amazonaws.com/tgtg/notebooks/1/notebook.ipynb?AWSAccessKeyId=XXX&Expires=1490366474&Signature=XXX&response-content-type=application%2Foctet-stream&x-amz-security-token=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX\",\n \"notebookPreviewUrl\": \"https://civis-console.s3.amazonaws.com/tgtg/notebooks/1/preview.html?AWSAccessKeyId=XXX&Expires=1490366474&Signature=XXX&response-content-type=application%2Foctet-stream&x-amz-security-token=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX\",\n \"requirementsUrl\": \"https://civis-console.s3.amazonaws.com/tgtg/notebooks/1/requirements.txt?AWSAccessKeyId=XXX&Expires=1490366474&Signature=XXX&response-content-type=application%2Foctet-stream&x-amz-security-token=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX\",\n \"fileId\": 74,\n \"requirementsFileId\": 76,\n \"user\": {\n \"id\": 2518,\n \"name\": \"User devuserfactory1844 1842\",\n \"username\": \"devuserfactory1844\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"dockerImageName\": \"civisanalytics/civis-jupyter-python3\",\n \"dockerImageTag\": \"foo\",\n \"instanceType\": null,\n \"memory\": 3000,\n \"cpu\": 800,\n \"createdAt\": \"2023-07-18T18:42:59.000Z\",\n \"updatedAt\": \"2023-07-18T18:42:59.000Z\",\n \"mostRecentDeployment\": null,\n \"credentials\": [\n\n ],\n \"environmentVariables\": {\n },\n \"idleTimeout\": 3,\n \"partitionLabel\": null,\n \"gitRepoId\": null,\n \"gitRepoUrl\": null,\n \"gitRef\": null,\n \"gitPath\": null,\n \"myPermissionLevel\": \"manage\",\n \"archived\": false,\n \"hidden\": false\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"6b74428e9fec1957b93d3be2cfb4b3ba\"","X-Request-Id":"5abf896c-3116-4d6d-9136-8d6a696dbd27","X-Runtime":"0.030792","Content-Length":"1573"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/notebooks/2\" -X GET \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer Z-qcZ_47g4EV_PG-nzACgJ1ehfs_dg2__7Jkhe1W-x0\" \\\n\t-H \"Accept: application/vnd.civis-platform.v1\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Notebooks","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/notebooks/:id","description":"View details of a notebook including an active deployment","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/notebooks/3","request_body":null,"request_headers":{"Content-Type":"application/json","Authorization":"Bearer rwNO9z6ZjRUnSV6sLxUGvu0R8Zf4a6PPJya63inPEz4","Accept":"application/vnd.civis-platform.v1","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 3,\n \"name\": \"Test Notebook\",\n \"language\": \"python3\",\n \"description\": null,\n \"notebookUrl\": \"https://civis-console.s3.amazonaws.com/tgtg/notebooks/1/notebook.ipynb?AWSAccessKeyId=XXX&Expires=1490366474&Signature=XXX&response-content-type=application%2Foctet-stream&x-amz-security-token=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX\",\n \"notebookPreviewUrl\": \"https://civis-console.s3.amazonaws.com/tgtg/notebooks/1/preview.html?AWSAccessKeyId=XXX&Expires=1490366474&Signature=XXX&response-content-type=application%2Foctet-stream&x-amz-security-token=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX\",\n \"requirementsUrl\": \"https://civis-console.s3.amazonaws.com/tgtg/notebooks/1/requirements.txt?AWSAccessKeyId=XXX&Expires=1490366474&Signature=XXX&response-content-type=application%2Foctet-stream&x-amz-security-token=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX\",\n \"fileId\": 77,\n \"requirementsFileId\": 79,\n \"user\": {\n \"id\": 2521,\n \"name\": \"User devuserfactory1847 1845\",\n \"username\": \"devuserfactory1847\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"dockerImageName\": \"civisanalytics/civis-jupyter-python3\",\n \"dockerImageTag\": \"foo\",\n \"instanceType\": null,\n \"memory\": 3000,\n \"cpu\": 800,\n \"createdAt\": \"2023-07-18T18:42:59.000Z\",\n \"updatedAt\": \"2023-07-18T18:42:59.000Z\",\n \"mostRecentDeployment\": {\n \"deploymentId\": 3,\n \"userId\": 2524,\n \"host\": \"deployment.foo.com\",\n \"name\": \"deployment\",\n \"dockerImageName\": \"civis-custom-image\",\n \"dockerImageTag\": \"1.1\",\n \"displayUrl\": \"https://deployment.foo.com/civis-platform-auth?token=bm9uY2UyMTNfWFhYWFhYXzI0X2J5dGVzywz4O2fOZE0_u6JvdF3U0t3Zs0lOTho1WiPDK8olECtZlbbcTGWk31vDshg8REPJ45_ZPY2TNDj_UCdOlAu21GGdbgJpnLw4O2ptocsWiSuTnqrykic8G_f7rQpmSqnL9TnBHbJAX-xXRQETDV90Mci2z4X7eQ86eNWMuM3goOfmU0lAv_TfK97dAa5nRnwQInzxWPvu2pkgAga_XfFJqTYF85A0CXTRS9mMYvwY03uOS3ONIYD7AJ4JneMAv-5dO7eniun-I0n7Den_Ab6jOWJzVNYgqDwB8PQj2gO60j66LmwPYFbyVbilsBKNQwHkdy8yOhZCJxkyWe6eo0hAjqvxiP-P0l1ul7A1_guxT0U5g3gSW9CGNq1CUn5ZjscW2oOD-s-dJye3jiU6Bu5ixmClE6c_KzUEY0M=\",\n \"instanceType\": \"m4.xlarge\",\n \"memory\": 2008,\n \"cpu\": 500,\n \"state\": \"running\",\n \"stateMessage\": null,\n \"maxMemoryUsage\": null,\n \"maxCpuUsage\": null,\n \"createdAt\": \"2023-07-18T18:42:59.000Z\",\n \"updatedAt\": \"2023-07-18T18:42:59.000Z\",\n \"notebookId\": 3\n },\n \"credentials\": [\n\n ],\n \"environmentVariables\": {\n },\n \"idleTimeout\": 3,\n \"partitionLabel\": null,\n \"gitRepoId\": null,\n \"gitRepoUrl\": null,\n \"gitRef\": null,\n \"gitPath\": null,\n \"myPermissionLevel\": \"manage\",\n \"archived\": false,\n \"hidden\": false\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"b6a746540a13eb5f165ac2a933600a63\"","X-Request-Id":"0377a9e7-78cd-4da3-804c-b4527d4212a1","X-Runtime":"0.031352","Content-Length":"2455"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/notebooks/3\" -X GET \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer rwNO9z6ZjRUnSV6sLxUGvu0R8Zf4a6PPJya63inPEz4\" \\\n\t-H \"Accept: application/vnd.civis-platform.v1\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"put":{"summary":"Replace all attributes of this Notebook","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID for this notebook.","type":"integer"},{"name":"Object394","in":"body","schema":{"$ref":"#/definitions/Object394"},"required":false}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object392"}}},"x-examples":null,"x-deprecation-warning":null},"patch":{"summary":"Update some attributes of this Notebook","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID for this notebook.","type":"integer"},{"name":"Object394","in":"body","schema":{"$ref":"#/definitions/Object394"},"required":false}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object392"}}},"x-examples":null,"x-deprecation-warning":null},"delete":{"summary":"Archive a Notebook (deprecated, use archiving endpoints instead)","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/notebooks/{id}/update-links":{"get":{"summary":"Get URLs to update notebook","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object395"}}},"x-examples":[{"resource":"Notebooks","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/notebooks/:id/update-links","description":"View URLs for PUTing new notebook contents","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/notebooks/4/update-links","request_body":null,"request_headers":{"Content-Type":"application/json","Authorization":"Bearer FXe2TbAKDyDAD8dxJtornWT9DTfRGnMy0ObEv1wrkek","Accept":"application/vnd.civis-platform.v1","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"updateUrl\": \"https://civis-console.s3.amazonaws.com/tgtg/notebooks/1/notebook.ipynb?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=XXXX%2FXXX%2Faws4_request&X-Amz-Date=20170324T143614Z&X-Amz-Expires=300&X-Amz-SignedHeaders=host&X-Amz-Signature=XXXX\",\n \"updatePreviewUrl\": \"https://civis-console.s3.amazonaws.com/tgtg/notebooks/1/preview.html?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=XXXX%2FXXX%2Faws4_request&X-Amz-Date=20170324T143614Z&X-Amz-Expires=300&X-Amz-SignedHeaders=host&X-Amz-Signature=XXXX\"\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"2d520d4b544eda6ce3b3b852488e3e56\"","X-Request-Id":"5de447a5-d2fe-4366-a1d7-a8ba256383d9","X-Runtime":"0.013694","Content-Length":"562"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/notebooks/4/update-links\" -X GET \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer FXe2TbAKDyDAD8dxJtornWT9DTfRGnMy0ObEv1wrkek\" \\\n\t-H \"Accept: application/vnd.civis-platform.v1\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/notebooks/{id}/clone":{"post":{"summary":"Clone this Notebook","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"type":"integer"}],"responses":{"201":{"description":"success","schema":{"$ref":"#/definitions/Object392"}}},"x-examples":[{"resource":"Notebooks","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/notebooks/:id/clone","description":"Make a clone of an existing notebook","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/notebooks/9/clone","request_body":null,"request_headers":{"Content-Type":"application/json","Authorization":"Bearer FFV85rV6jBfqb1bqrM2UUdRJMjskz_48JlUPKnfnobI","Accept":"application/vnd.civis-platform.v1","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":201,"response_status_text":"Created","response_body":"{\n \"id\": 10,\n \"name\": \"Clone of Test Notebook\",\n \"language\": \"python3\",\n \"description\": null,\n \"notebookUrl\": \"https://civis-console.s3.amazonaws.com/tgtg/notebooks/1/notebook.ipynb?AWSAccessKeyId=XXX&Expires=1490366474&Signature=XXX&response-content-type=application%2Foctet-stream&x-amz-security-token=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX\",\n \"notebookPreviewUrl\": \"https://civis-console.s3.amazonaws.com/tgtg/notebooks/1/preview.html?AWSAccessKeyId=XXX&Expires=1490366474&Signature=XXX&response-content-type=application%2Foctet-stream&x-amz-security-token=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX\",\n \"requirementsUrl\": \"https://civis-console.s3.amazonaws.com/tgtg/notebooks/1/requirements.txt?AWSAccessKeyId=XXX&Expires=1490366474&Signature=XXX&response-content-type=application%2Foctet-stream&x-amz-security-token=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX\",\n \"fileId\": 98,\n \"requirementsFileId\": 100,\n \"user\": {\n \"id\": 2538,\n \"name\": \"User devuserfactory1864 1862\",\n \"username\": \"devuserfactory1864\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"dockerImageName\": \"civisanalytics/civis-jupyter-python3\",\n \"dockerImageTag\": \"foo\",\n \"instanceType\": null,\n \"memory\": 3000,\n \"cpu\": 800,\n \"createdAt\": \"2023-07-18T18:43:00.000Z\",\n \"updatedAt\": \"2023-07-18T18:43:00.000Z\",\n \"mostRecentDeployment\": null,\n \"credentials\": [\n\n ],\n \"environmentVariables\": {\n },\n \"idleTimeout\": 3,\n \"partitionLabel\": null,\n \"gitRepoId\": null,\n \"gitRepoUrl\": null,\n \"gitRef\": null,\n \"gitPath\": null,\n \"myPermissionLevel\": \"manage\",\n \"archived\": false,\n \"hidden\": false\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"3f7c181c74b27ebd906de42a019db1e1\"","X-Request-Id":"b82d282b-da20-40eb-9a61-aa61d4e6417a","X-Runtime":"0.180598","Content-Length":"1584"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/notebooks/9/clone\" -d '' -X POST \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer FFV85rV6jBfqb1bqrM2UUdRJMjskz_48JlUPKnfnobI\" \\\n\t-H \"Accept: application/vnd.civis-platform.v1\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/notebooks/{id}/shares":{"get":{"summary":"List users and groups permissioned on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object9"}}}},"x-examples":null,"x-deprecation-warning":null}},"/notebooks/{id}/shares/users":{"put":{"summary":"Set the permissions users have on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"Object396","in":"body","schema":{"$ref":"#/definitions/Object396"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object9"}}},"x-examples":null,"x-deprecation-warning":null}},"/notebooks/{id}/shares/users/{user_id}":{"delete":{"summary":"Revoke the permissions a user has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"user_id","in":"path","required":true,"description":"The ID of the user.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/notebooks/{id}/shares/groups":{"put":{"summary":"Set the permissions groups has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"Object397","in":"body","schema":{"$ref":"#/definitions/Object397"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object9"}}},"x-examples":null,"x-deprecation-warning":null}},"/notebooks/{id}/shares/groups/{group_id}":{"delete":{"summary":"Revoke the permissions a group has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"group_id","in":"path","required":true,"description":"The ID of the group.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/notebooks/{id}/dependencies":{"get":{"summary":"List dependent objects for this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"user_id","in":"query","required":false,"description":"ID of target user","type":"integer"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object15"}}}},"x-examples":null,"x-deprecation-warning":null}},"/notebooks/{id}/transfer":{"put":{"summary":"Transfer ownership of this object to another user","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"Object398","in":"body","schema":{"$ref":"#/definitions/Object398"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object17"}}},"x-examples":null,"x-deprecation-warning":null}},"/notebooks/{id}/archive":{"put":{"summary":"Update the archive status of this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the object.","type":"integer"},{"name":"Object399","in":"body","schema":{"$ref":"#/definitions/Object399"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object392"}}},"x-examples":null,"x-deprecation-warning":null}},"/notebooks/{id}/projects":{"get":{"summary":"List the projects a Notebook belongs to","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Notebook.","type":"integer"},{"name":"hidden","in":"query","required":false,"description":"If specified to be true, returns hidden items. Defaults to false, returning non-hidden items.","type":"boolean"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object84"}}}},"x-examples":null,"x-deprecation-warning":null}},"/notebooks/{id}/projects/{project_id}":{"put":{"summary":"Add a Notebook to a project","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Notebook.","type":"integer"},{"name":"project_id","in":"path","required":true,"description":"The ID of the project.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null},"delete":{"summary":"Remove a Notebook from a project","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Notebook.","type":"integer"},{"name":"project_id","in":"path","required":true,"description":"The ID of the project.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/notebooks/{notebook_id}/deployments":{"get":{"summary":"List deployments for a Notebook","description":null,"deprecated":false,"parameters":[{"name":"notebook_id","in":"path","required":true,"description":"The ID of the owning Notebook","type":"integer"},{"name":"deployment_id","in":"query","required":false,"description":"The ID for this deployment","type":"integer"},{"name":"limit","in":"query","required":false,"description":"Number of results to return. Defaults to 20. Maximum allowed is 50.","type":"integer"},{"name":"page_num","in":"query","required":false,"description":"Page number of the results to return. Defaults to the first page, 1.","type":"integer"},{"name":"order","in":"query","required":false,"description":"The field on which to order the result set. Defaults to created_at. Must be one of: created_at.","type":"string"},{"name":"order_dir","in":"query","required":false,"description":"Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc.","type":"string"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object390"}}}},"x-examples":[{"resource":"Notebooks","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/notebooks/:notebook_id/deployments","description":"List all Deployments for a notebook","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/notebooks/11/deployments","request_body":null,"request_headers":{"Content-Type":"application/json","Authorization":"Bearer GqkfHLcYSk2SXyIpqFm8rS51upQ8Bs6yjy9W6rsnCjw","Accept":"application/vnd.civis-platform.v1","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"deploymentId\": 4,\n \"userId\": 2543,\n \"host\": \"deployment.foo.com\",\n \"name\": \"deployment\",\n \"dockerImageName\": \"civis-custom-image\",\n \"dockerImageTag\": \"1.1\",\n \"instanceType\": \"m4.xlarge\",\n \"memory\": 2008,\n \"cpu\": 500,\n \"state\": null,\n \"stateMessage\": null,\n \"maxMemoryUsage\": null,\n \"maxCpuUsage\": null,\n \"createdAt\": \"2023-07-18T18:43:01.000Z\",\n \"updatedAt\": \"2023-07-18T18:43:01.000Z\",\n \"notebookId\": 11\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","X-Pagination-Per-Page":"20","Access-Control-Expose-Headers":"X-Pagination-Per-Page, X-Pagination-Current-Page, X-Pagination-Total-Pages, X-Pagination-Total-Entries","X-Pagination-Current-Page":"1","X-Pagination-Total-Pages":"1","X-Pagination-Total-Entries":"1","Content-Type":"application/json; charset=utf-8","ETag":"W/\"88ffd4b0672326438560dc4631b03383\"","X-Request-Id":"79580e58-6209-438a-968c-452ab0db5223","X-Runtime":"0.017668","Content-Length":"363"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/notebooks/11/deployments\" -X GET \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer GqkfHLcYSk2SXyIpqFm8rS51upQ8Bs6yjy9W6rsnCjw\" \\\n\t-H \"Accept: application/vnd.civis-platform.v1\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"post":{"summary":"Deploy a Notebook","description":null,"deprecated":false,"parameters":[{"name":"notebook_id","in":"path","required":true,"description":"The ID of the owning Notebook","type":"integer"},{"name":"Object400","in":"body","schema":{"$ref":"#/definitions/Object400"},"required":false}],"responses":{"201":{"description":"success","schema":{"$ref":"#/definitions/Object393"}}},"x-examples":[{"resource":"Notebooks","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/notebooks/:notebook_id/deployments","description":"Create a deployment for a notebook","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/notebooks/14/deployments","request_body":null,"request_headers":{"Content-Type":"application/json","Authorization":"Bearer dARbakSNs3dTh-MNUSr_SfFyXrJ9BpYOceIgyTd2EM8","Accept":"application/vnd.civis-platform.v1","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":201,"response_status_text":"Created","response_body":"{\n \"deploymentId\": 7,\n \"userId\": 2551,\n \"host\": \"deployment.foo.com\",\n \"name\": \"deployment\",\n \"dockerImageName\": \"civis-custom-image\",\n \"dockerImageTag\": \"1.1\",\n \"displayUrl\": \"https://deployment.foo.com/civis-platform-auth?token=bm9uY2UyMTNfWFhYWFhYXzI0X2J5dGVzuV1_xogAaANpzAZzkPEy4X05eodHpWFX4aOxQbRdnPtix7wZKb7yC88Yla3ETUJdRkliso7_9JZSH_00PbtDY1y-yXSxPhsNGu1rC1LooqsAtiEin09UXUPSZjktNn8LuLM1DPehzl0OVtcfjacIk3p4smNHX2nfL7I2jPjRfvbQym90NuURdCER-UZYwl2ZrInGHg5PP0ZHZEbCeRpcT3j6VpGfS4Gsd7yVsW47259cZH8I3hNKRNg--Jt69y1YdZAMUWAp5rGx7WaF-O6EG8ew1-X-FeiG89oTviOVgqBH9DPY9t0An0XEXl7C-XCZ37RWHycftVqE2x3qlvPYcXfTXRqI3lrh5Cf_xYTw5qyzaDx3biW3KbrvsWYKV3zDphGbkefJ4JAMtanLEXEVGO6AoqxF2K16-10=\",\n \"instanceType\": \"m4.xlarge\",\n \"memory\": 2008,\n \"cpu\": 500,\n \"state\": null,\n \"stateMessage\": null,\n \"maxMemoryUsage\": null,\n \"maxCpuUsage\": null,\n \"createdAt\": \"2023-07-18T18:43:01.000Z\",\n \"updatedAt\": \"2023-07-18T18:43:01.000Z\",\n \"notebookId\": 14\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"8df05aff45abb8af3e391ecfd9e07c1a\"","X-Request-Id":"e76232f2-c8f1-4abc-8e38-acc3e93f8cf9","X-Runtime":"0.020275","Content-Length":"882"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/notebooks/14/deployments\" -d '' -X POST \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer dARbakSNs3dTh-MNUSr_SfFyXrJ9BpYOceIgyTd2EM8\" \\\n\t-H \"Accept: application/vnd.civis-platform.v1\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/notebooks/{notebook_id}/deployments/{deployment_id}":{"get":{"summary":"Get details about a Notebook deployment","description":null,"deprecated":false,"parameters":[{"name":"notebook_id","in":"path","required":true,"description":"The ID of the owning Notebook","type":"integer"},{"name":"deployment_id","in":"path","required":true,"description":"The ID for this deployment","type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object393"}}},"x-examples":[{"resource":"Notebooks","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/notebooks/:notebook_id/deployments/:deployment_id","description":"View a notebook deployment's details","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/notebooks/12/deployments/5","request_body":null,"request_headers":{"Content-Type":"application/json","Authorization":"Bearer ob6CYh8SvRf9Jk5hlqoPWF-l_kcOZj7g5iKh0DQ-45E","Accept":"application/vnd.civis-platform.v1","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"deploymentId\": 5,\n \"userId\": 2547,\n \"host\": \"deployment.foo.com\",\n \"name\": \"deployment\",\n \"dockerImageName\": \"civis-custom-image\",\n \"dockerImageTag\": \"1.1\",\n \"displayUrl\": \"https://deployment.foo.com/civis-platform-auth?token=bm9uY2UyMTNfWFhYWFhYXzI0X2J5dGVzMTc2fH5GiQJfEO0LWPDnF_EnyVt22pXUy2queGqSkpIFAfYxuETBTutrM3LxA71FOYSF13RX9uoQAF7CbpaXWuw8qgeoQush0HQrp1-AYR05TyqXFd7jRqaYJR0ap90IdXV0VXWupkYeWj4Ud7vnxfFRmY1EYpPklcKFsJvuOZipexX_Msc_wQgiUMSUEBU2-eI9FknCwJDT-5I_z0kxCNJLM5UB8WwnW65Ri6dpqbqF2GJ3qO5sM_9q9FsxxaFG0mgske3dJ8rT3I5R60hnGqvA5-IyvhRSKt9Dje14fWACXFab3bki6pT-1ZzD3PaM6ChOoo7gWBnlX9P35tWJl9ZzNH88umv7ZMpBJ6x9vYLmp9bgSMpC8QChdrpjNK4DyMlUu5FGyw4jODsm4pvumXSOrjtDazD_eLw=\",\n \"instanceType\": \"m4.xlarge\",\n \"memory\": 2008,\n \"cpu\": 500,\n \"state\": null,\n \"stateMessage\": null,\n \"maxMemoryUsage\": null,\n \"maxCpuUsage\": null,\n \"createdAt\": \"2023-07-18T18:43:01.000Z\",\n \"updatedAt\": \"2023-07-18T18:43:01.000Z\",\n \"notebookId\": 12\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"d39e37d5392c96f1759e911543a07dd5\"","X-Request-Id":"5cd3dfe9-aed7-4ac6-85fa-0f54f474344b","X-Runtime":"0.019256","Content-Length":"882"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/notebooks/12/deployments/5\" -X GET \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer ob6CYh8SvRf9Jk5hlqoPWF-l_kcOZj7g5iKh0DQ-45E\" \\\n\t-H \"Accept: application/vnd.civis-platform.v1\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"delete":{"summary":"Delete a Notebook deployment","description":null,"deprecated":false,"parameters":[{"name":"notebook_id","in":"path","required":true,"description":"The ID of the owning Notebook","type":"integer"},{"name":"deployment_id","in":"path","required":true,"description":"The ID for this deployment","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":[{"resource":"Notebooks","resource_explanation":null,"http_method":"DELETE","route":"http://api.civis.test/notebooks/:notebook_id/deployments/:deployment_id","description":"Delete a deployment for a notebook","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"DELETE","request_path":"http://api.civis.test/notebooks/15/deployments/8","request_body":null,"request_headers":{"Content-Type":"application/json","Authorization":"Bearer 0nnkNn_tUoRH7qWCjbeKse4mA9dmlGQ9kGEpZESXr9Q","Accept":"application/vnd.civis-platform.v1","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":204,"response_status_text":"No Content","response_body":null,"response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","X-Request-Id":"26e97429-3fbf-4e8f-a8f0-ddc9b4621567","X-Runtime":"0.017184"},"response_content_type":null,"curl":"curl \"api.civis.testhttp://api.civis.test/notebooks/15/deployments/8\" -d '' -X DELETE \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer 0nnkNn_tUoRH7qWCjbeKse4mA9dmlGQ9kGEpZESXr9Q\" \\\n\t-H \"Accept: application/vnd.civis-platform.v1\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/notebooks/{id}/deployments/{deployment_id}/logs":{"get":{"summary":"Get the logs for a Notebook deployment","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the owning Notebook.","type":"integer"},{"name":"deployment_id","in":"path","required":true,"description":"The ID for this deployment.","type":"integer"},{"name":"start_at","in":"query","required":false,"description":"Log entries with a lower timestamp will be omitted.","type":"string","format":"date-time"},{"name":"end_at","in":"query","required":false,"description":"Log entries with a higher timestamp will be omitted.","type":"string","format":"date-time"},{"name":"limit","in":"query","required":false,"description":"The maximum number of log messages to return. Default of 10000.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object57"}}}},"x-examples":null,"x-deprecation-warning":null}},"/notebooks/{id}/git":{"get":{"summary":"Get the git metadata attached to an item","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the item.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object402"}}},"x-examples":null,"x-deprecation-warning":null},"put":{"summary":"Attach an item to a file in a git repo","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the item.","type":"integer"},{"name":"Object403","in":"body","schema":{"$ref":"#/definitions/Object403"},"required":false}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object402"}}},"x-examples":null,"x-deprecation-warning":null},"patch":{"summary":"Update an attached git file","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the item.","type":"integer"},{"name":"Object403","in":"body","schema":{"$ref":"#/definitions/Object403"},"required":false}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object402"}}},"x-examples":null,"x-deprecation-warning":null}},"/notebooks/{id}/git/commits":{"get":{"summary":"Get the git commits for an item on the current branch","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the item.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object404"}}},"x-examples":null,"x-deprecation-warning":null},"post":{"summary":"Commit and push a new version of the file","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the item.","type":"integer"},{"name":"Object405","in":"body","schema":{"$ref":"#/definitions/Object405"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object406"}}},"x-examples":null,"x-deprecation-warning":null}},"/notebooks/{id}/git/commits/{commit_hash}":{"get":{"summary":"Get file contents at git ref","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the item.","type":"integer"},{"name":"commit_hash","in":"path","required":true,"description":"The SHA (full or shortened) of the desired git commit.","type":"string"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object406"}}},"x-examples":null,"x-deprecation-warning":null}},"/notifications/":{"get":{"summary":"Receive a stream of notifications as they come in","description":null,"deprecated":false,"parameters":[{"name":"last_event_id","in":"query","required":false,"description":"allows browser to keep track of last event fired","type":"string"},{"name":"r","in":"query","required":false,"description":"specifies retry/reconnect timeout","type":"string"},{"name":"mock","in":"query","required":false,"description":"used for testing","type":"string"}],"responses":{"200":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/ontology/":{"get":{"summary":"List the ontology of column names Civis uses","description":null,"deprecated":false,"parameters":[{"name":"subset","in":"query","required":false,"description":"A subset of fields to return.","type":"string"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object411"}}}},"x-examples":[{"resource":"Ontology","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/ontology","description":"List the ontology","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/ontology","request_body":null,"request_headers":{"Authorization":"Bearer t5ypz45C2EeizJFxGUJ0hkJzFyyZ598BSWBsdGzv9hs","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":null,"response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"key\": \"primary_key\",\n \"title\": \"Primary Key\",\n \"desc\": \"A primary key (aka an ID) for a record\",\n \"aliases\": [\n \"id\"\n ]\n },\n {\n \"key\": \"name\",\n \"title\": \"Full Name\",\n \"desc\": \"Some combination of first, last, and maybe middle name\",\n \"aliases\": [\n \"full_name\"\n ]\n },\n {\n \"key\": \"company\",\n \"title\": \"Company\",\n \"desc\": \"The company/firm/organization name \",\n \"aliases\": [\n\n ]\n },\n {\n \"key\": \"first_name\",\n \"title\": \"First Name\",\n \"desc\": \"A person's first (given) name\",\n \"aliases\": [\n \"first\",\n \"firstname\"\n ]\n },\n {\n \"key\": \"middle_name\",\n \"title\": \"Middle Name\",\n \"desc\": \"A person's middle name\",\n \"aliases\": [\n \"middle\",\n \"middlename\"\n ]\n },\n {\n \"key\": \"middle_initial\",\n \"title\": \"Middle Initial\",\n \"desc\": \"The first letter of a person's middle name\",\n \"aliases\": [\n \"mi\"\n ]\n },\n {\n \"key\": \"last_name\",\n \"title\": \"Last Name\",\n \"desc\": \"A person's last name (surname)\",\n \"aliases\": [\n \"last\",\n \"lastname\"\n ]\n },\n {\n \"key\": \"gender\",\n \"title\": \"Gender\",\n \"desc\": \"A person's gender\",\n \"aliases\": [\n \"sex\"\n ]\n },\n {\n \"key\": \"birth_date\",\n \"title\": \"Birth Date\",\n \"desc\": \"A person's full birth date, including year, month, and day\",\n \"aliases\": [\n \"dob\",\n \"birthdate\"\n ]\n },\n {\n \"key\": \"phone\",\n \"title\": \"Phone\",\n \"desc\": \"A person's phone number\",\n \"aliases\": [\n\n ]\n },\n {\n \"key\": \"email\",\n \"title\": \"Email\",\n \"desc\": \"A person's email address\",\n \"aliases\": [\n \"email_address\"\n ]\n },\n {\n \"key\": \"birth_year\",\n \"title\": \"Birth Year\",\n \"desc\": \"The year in which a person was born\",\n \"aliases\": [\n \"birthyear\"\n ]\n },\n {\n \"key\": \"birth_month\",\n \"title\": \"Birth Month\",\n \"desc\": \"The month in which a person was born\",\n \"aliases\": [\n \"birthmonth\"\n ]\n },\n {\n \"key\": \"birth_day\",\n \"title\": \"Birth Day\",\n \"desc\": \"The day of the month in which a person was born\",\n \"aliases\": [\n \"birthday\"\n ]\n },\n {\n \"key\": \"house_number\",\n \"title\": \"House Number\",\n \"desc\": \"The house number portion of a Street Address\",\n \"aliases\": [\n \"addresshouse\"\n ]\n },\n {\n \"key\": \"street\",\n \"title\": \"Street\",\n \"desc\": \"The street name portion of a Street Address\",\n \"aliases\": [\n \"addressstreet\"\n ]\n },\n {\n \"key\": \"unit\",\n \"title\": \"Address Unit Number\",\n \"desc\": \"The unit/apartment number portion of a Street Address\",\n \"aliases\": [\n \"addressapt\",\n \"addressunit\"\n ]\n },\n {\n \"key\": \"full_address\",\n \"title\": \"Full Address\",\n \"desc\": \"A complete address in a single string\",\n \"aliases\": [\n \"address\"\n ]\n },\n {\n \"key\": \"address1\",\n \"title\": \"Street Address\",\n \"desc\": \"The first line of an address\",\n \"aliases\": [\n \"street_address\",\n \"street_address1\"\n ]\n },\n {\n \"key\": \"address2\",\n \"title\": \"Address 2\",\n \"desc\": \"The second line of an address, usually for a unit #\",\n \"aliases\": [\n \"street_address2\"\n ]\n },\n {\n \"key\": \"city\",\n \"title\": \"City\",\n \"desc\": \"The city name\",\n \"aliases\": [\n \"town\"\n ]\n },\n {\n \"key\": \"state\",\n \"title\": \"State Name\",\n \"desc\": \"The name of the state\",\n \"aliases\": [\n\n ]\n },\n {\n \"key\": \"state_code\",\n \"title\": \"State Abbreviation\",\n \"desc\": \"The state's abbreviation\",\n \"aliases\": [\n\n ]\n },\n {\n \"key\": \"county\",\n \"title\": \"County\",\n \"desc\": \"The US county or parish\",\n \"aliases\": [\n\n ]\n },\n {\n \"key\": \"zip\",\n \"title\": \"Zip Code\",\n \"desc\": \"A postal code, possibly zip-5 or zip-9\",\n \"aliases\": [\n \"zip_code\",\n \"zipcode\",\n \"postalcode\",\n \"pcode\"\n ]\n },\n {\n \"key\": \"zip5\",\n \"title\": \"5-digit zip code\",\n \"desc\": \"\",\n \"aliases\": [\n\n ]\n },\n {\n \"key\": \"zip4\",\n \"title\": \"4-digit zip code\",\n \"desc\": \"The final four digits of a 9-digit zip code\",\n \"aliases\": [\n\n ]\n },\n {\n \"key\": \"zip9\",\n \"title\": \"9-digit zip code\",\n \"desc\": \"A full 9-digit US postal code\",\n \"aliases\": [\n\n ]\n },\n {\n \"key\": \"lat\",\n \"title\": \"Latitude\",\n \"desc\": \"\",\n \"aliases\": [\n \"latitude\"\n ]\n },\n {\n \"key\": \"lon\",\n \"title\": \"Longitude\",\n \"desc\": \"\",\n \"aliases\": [\n \"longitude\",\n \"long\"\n ]\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"cb9e7271ce6121f520d1d93777093847\"","X-Request-Id":"9ac7635a-5af6-425c-afb8-dc6b36371c54","X-Runtime":"0.012576","Content-Length":"3152"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/ontology\" -X GET \\\n\t-H \"Authorization: Bearer t5ypz45C2EeizJFxGUJ0hkJzFyyZ598BSWBsdGzv9hs\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/organizations/favorites":{"get":{"summary":"List Favorites","description":"List organization-level favorites.","deprecated":false,"parameters":[{"name":"object_id","in":"query","required":false,"description":"The id of the object. If specified as a query parameter, must also specify object_type parameter.","type":"integer"},{"name":"object_type","in":"query","required":false,"description":"The type of the object that is favorited. Valid options: Container Script, Identity Resolution, Import, Python Script, R Script, dbt Script, JavaScript Script, SQL Script, Template Script, Project, Workflow, Tableau Report, Service Report, HTML Report, SQL Report","type":"string"},{"name":"limit","in":"query","required":false,"description":"Number of results to return. Defaults to 50. Maximum allowed is 1000.","type":"integer"},{"name":"page_num","in":"query","required":false,"description":"Page number of the results to return. Defaults to the first page, 1.","type":"integer"},{"name":"order","in":"query","required":false,"description":"The field on which to order the result set. Defaults to created_at. Must be one of: created_at, object_type, object_id.","type":"string"},{"name":"order_dir","in":"query","required":false,"description":"Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc.","type":"string"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object412"}}}},"x-examples":null,"x-deprecation-warning":null},"post":{"summary":"Favorite an item for your organization","description":"Only available for Organization Admin users.","deprecated":false,"parameters":[{"name":"Object413","in":"body","schema":{"$ref":"#/definitions/Object413"},"required":true}],"responses":{"201":{"description":"success","schema":{"$ref":"#/definitions/Object414"}}},"x-examples":null,"x-deprecation-warning":null}},"/organizations/favorites/{id}":{"delete":{"summary":"Unfavorite an item for your organization","description":"Only available for Organization Admin users.","deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The id of the favorite.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/permission_sets/":{"get":{"summary":"List Permission Sets","description":null,"deprecated":false,"parameters":[{"name":"archived","in":"query","required":false,"description":"The archival status of the requested item(s).","type":"string"},{"name":"author","in":"query","required":false,"description":"If specified, return items from any of these authors. It accepts a comma-separated list of user IDs.","type":"string"},{"name":"limit","in":"query","required":false,"description":"Number of results to return. Defaults to 20. Maximum allowed is 50.","type":"integer"},{"name":"page_num","in":"query","required":false,"description":"Page number of the results to return. Defaults to the first page, 1.","type":"integer"},{"name":"order","in":"query","required":false,"description":"The field on which to order the result set. Defaults to updated_at. Must be one of: updated_at, name, created_at.","type":"string"},{"name":"order_dir","in":"query","required":false,"description":"Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc.","type":"string"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object415"}}}},"x-examples":[{"resource":"PermissionSets","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/permission_sets","description":"List all permission sets","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/permission_sets","request_body":null,"request_headers":{"Content-Type":"application/json","Authorization":"Bearer Yb1bWbkrPEOwa0jUafbpml2ytdTVItfI8TUSznrvi68","Accept":"application/vnd.civis-platform.v1","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 1,\n \"name\": \"permission set\",\n \"description\": null,\n \"author\": {\n \"id\": 2566,\n \"name\": \"User devuserfactory1888 1886\",\n \"username\": \"devuserfactory1888\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"createdAt\": \"2023-07-18T18:43:02.000Z\",\n \"updatedAt\": \"2023-07-18T18:43:02.000Z\",\n \"archived\": false\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","X-Pagination-Per-Page":"20","Access-Control-Expose-Headers":"X-Pagination-Per-Page, X-Pagination-Current-Page, X-Pagination-Total-Pages, X-Pagination-Total-Entries","X-Pagination-Current-Page":"1","X-Pagination-Total-Pages":"1","X-Pagination-Total-Entries":"1","Content-Type":"application/json; charset=utf-8","ETag":"W/\"22c98349607cd82dccadc85fcfd876b7\"","X-Request-Id":"6342574a-0eb2-48ed-a967-adb5146302c2","X-Runtime":"0.016662","Content-Length":"269"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/permission_sets\" -X GET \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer Yb1bWbkrPEOwa0jUafbpml2ytdTVItfI8TUSznrvi68\" \\\n\t-H \"Accept: application/vnd.civis-platform.v1\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"post":{"summary":"Create a Permission Set","description":null,"deprecated":false,"parameters":[{"name":"Object416","in":"body","schema":{"$ref":"#/definitions/Object416"},"required":true}],"responses":{"201":{"description":"success","schema":{"$ref":"#/definitions/Object415"}}},"x-examples":[{"resource":"PermissionSets","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/permission_sets","description":"Create a permission set","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/permission_sets","request_body":"{\n \"name\": \"service permissions\"\n}","request_headers":{"Content-Type":"application/json","Authorization":"Bearer 5anL9DoDsZLfe1qXjrnTONv9MzAH65mzEF1pr4KAF4k","Accept":"application/vnd.civis-platform.v1","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":201,"response_status_text":"Created","response_body":"{\n \"id\": 3,\n \"name\": \"service permissions\",\n \"description\": null,\n \"author\": {\n \"id\": 2567,\n \"name\": \"User devuserfactory1889 1887\",\n \"username\": \"devuserfactory1889\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"createdAt\": \"2023-07-18T18:43:02.000Z\",\n \"updatedAt\": \"2023-07-18T18:43:02.000Z\",\n \"archived\": false\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"a83e33e36f8cbfda869b7751e4640add\"","X-Request-Id":"eee01563-b565-48eb-a10c-b29d0b94dfcf","X-Runtime":"0.049765","Content-Length":"272"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/permission_sets\" -d '{\"name\":\"service permissions\"}' -X POST \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer 5anL9DoDsZLfe1qXjrnTONv9MzAH65mzEF1pr4KAF4k\" \\\n\t-H \"Accept: application/vnd.civis-platform.v1\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/permission_sets/{id}":{"get":{"summary":"Get a Permission Set","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object415"}}},"x-examples":[{"resource":"PermissionSets","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/permission_sets/:id","description":"View a permission set's details","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/permission_sets/4","request_body":null,"request_headers":{"Content-Type":"application/json","Authorization":"Bearer A83QH9sK5Jtg1_q0LvCtRYEo1UWIecSJ6QsyaZ4gBVA","Accept":"application/vnd.civis-platform.v1","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 4,\n \"name\": \"permission set\",\n \"description\": null,\n \"author\": {\n \"id\": 2568,\n \"name\": \"User devuserfactory1890 1888\",\n \"username\": \"devuserfactory1890\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"createdAt\": \"2023-07-18T18:43:03.000Z\",\n \"updatedAt\": \"2023-07-18T18:43:03.000Z\",\n \"archived\": false\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"e11578662bb76800f503ff52a52eb5ad\"","X-Request-Id":"06bbeaff-4fc9-4d05-96ad-d13b7b849c77","X-Runtime":"0.014690","Content-Length":"267"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/permission_sets/4\" -X GET \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer A83QH9sK5Jtg1_q0LvCtRYEo1UWIecSJ6QsyaZ4gBVA\" \\\n\t-H \"Accept: application/vnd.civis-platform.v1\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"put":{"summary":"Replace all attributes of this Permission Set","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID for this permission set.","type":"integer"},{"name":"Object417","in":"body","schema":{"$ref":"#/definitions/Object417"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object415"}}},"x-examples":null,"x-deprecation-warning":null},"patch":{"summary":"Update some attributes of this Permission Set","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID for this permission set.","type":"integer"},{"name":"Object418","in":"body","schema":{"$ref":"#/definitions/Object418"},"required":false}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object415"}}},"x-examples":[{"resource":"PermissionSets","resource_explanation":null,"http_method":"PATCH","route":"http://api.civis.test/permission_sets/:id","description":"Update a permission set","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"PATCH","request_path":"http://api.civis.test/permission_sets/5","request_body":"{\n \"description\": \"access control\"\n}","request_headers":{"Content-Type":"application/json","Authorization":"Bearer JpmL-LNTUqMbtd5Mg3gX2YhVJBSiDxiOwGFeUNw5HJc","Accept":"application/vnd.civis-platform.v1","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 5,\n \"name\": \"permission set\",\n \"description\": \"access control\",\n \"author\": {\n \"id\": 2569,\n \"name\": \"User devuserfactory1891 1889\",\n \"username\": \"devuserfactory1891\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"createdAt\": \"2023-07-18T18:43:03.000Z\",\n \"updatedAt\": \"2023-07-18T18:43:03.000Z\",\n \"archived\": false\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"bf8af75545627f86ffcd95ff5acce5a7\"","X-Request-Id":"7af7060f-ccea-4591-81e5-e1990991f403","X-Runtime":"0.023627","Content-Length":"279"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/permission_sets/5\" -d '{\"description\":\"access control\"}' -X PATCH \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer JpmL-LNTUqMbtd5Mg3gX2YhVJBSiDxiOwGFeUNw5HJc\" \\\n\t-H \"Accept: application/vnd.civis-platform.v1\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/permission_sets/{id}/shares":{"get":{"summary":"List users and groups permissioned on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object9"}}}},"x-examples":null,"x-deprecation-warning":null}},"/permission_sets/{id}/shares/users":{"put":{"summary":"Set the permissions users have on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"Object419","in":"body","schema":{"$ref":"#/definitions/Object419"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object9"}}},"x-examples":null,"x-deprecation-warning":null}},"/permission_sets/{id}/shares/users/{user_id}":{"delete":{"summary":"Revoke the permissions a user has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"user_id","in":"path","required":true,"description":"The ID of the user.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/permission_sets/{id}/shares/groups":{"put":{"summary":"Set the permissions groups has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"Object420","in":"body","schema":{"$ref":"#/definitions/Object420"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object9"}}},"x-examples":null,"x-deprecation-warning":null}},"/permission_sets/{id}/shares/groups/{group_id}":{"delete":{"summary":"Revoke the permissions a group has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"group_id","in":"path","required":true,"description":"The ID of the group.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/permission_sets/{id}/dependencies":{"get":{"summary":"List dependent objects for this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"user_id","in":"query","required":false,"description":"ID of target user","type":"integer"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object15"}}}},"x-examples":null,"x-deprecation-warning":null}},"/permission_sets/{id}/transfer":{"put":{"summary":"Transfer ownership of this object to another user","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"Object421","in":"body","schema":{"$ref":"#/definitions/Object421"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object17"}}},"x-examples":null,"x-deprecation-warning":null}},"/permission_sets/{id}/archive":{"put":{"summary":"Update the archive status of this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the object.","type":"integer"},{"name":"Object422","in":"body","schema":{"$ref":"#/definitions/Object422"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object415"}}},"x-examples":null,"x-deprecation-warning":null}},"/permission_sets/{id}/users/{user_id}/permissions":{"get":{"summary":"Get all permissions for a user, in this permission set","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID for this permission set.","type":"integer"},{"name":"user_id","in":"path","required":true,"description":"The ID for the user.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object423"}}}},"x-examples":[{"resource":"PermissionSets","resource_explanation":null,"http_method":"GET","route":"https://api.civis.test/permission_sets/:id/users/:user_id/permissions","description":"Retrieve all permissions for a user in this permission set","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"https://api.civis.test/permission_sets/11/users/2576/permissions","request_body":null,"request_headers":{"Content-Type":"application/json","Authorization":"Bearer NMfdIGafki57EwqMfuVY4kJt90M5p221EK17itms5Bs","Accept":"application/vnd.civis-platform.v1","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"resourceName\": \"resource_10\",\n \"read\": true,\n \"write\": false,\n \"manage\": false\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"f2489b65e86e25aa08d87503f016bd55\"","X-Request-Id":"83837a8b-5369-4513-9e84-ea50c54eb829","X-Runtime":"0.061662","Content-Length":"73"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttps://api.civis.test/permission_sets/11/users/2576/permissions\" -X GET \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer NMfdIGafki57EwqMfuVY4kJt90M5p221EK17itms5Bs\" \\\n\t-H \"Accept: application/vnd.civis-platform.v1\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/permission_sets/{id}/resources":{"get":{"summary":"List resources in a permission set","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID for this permission set.","type":"integer"},{"name":"limit","in":"query","required":false,"description":"Number of results to return. Defaults to 50. Maximum allowed is 1000.","type":"integer"},{"name":"page_num","in":"query","required":false,"description":"Page number of the results to return. Defaults to the first page, 1.","type":"integer"},{"name":"order","in":"query","required":false,"description":"The field on which to order the result set. Defaults to name. Must be one of: name, id, updated_at, created_at.","type":"string"},{"name":"order_dir","in":"query","required":false,"description":"Direction in which to sort, either asc (ascending) or desc (descending) defaulting to asc.","type":"string"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object424"}}}},"x-examples":[{"resource":"PermissionSets","resource_explanation":null,"http_method":"GET","route":"https://api.civis.test/permission_sets/:id/resources","description":"List all resources in a permission set","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"https://api.civis.test/permission_sets/6/resources","request_body":null,"request_headers":{"Content-Type":"application/json","Authorization":"Bearer y2nHhHOyGBpWSweICPAKzb6Eppq-SuLs4hK6Gmy5gFo","Accept":"application/vnd.civis-platform.v1","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"permissionSetId\": 6,\n \"name\": \"resource_5\",\n \"description\": null,\n \"createdAt\": \"2023-07-18T18:43:03.000Z\",\n \"updatedAt\": \"2023-07-18T18:43:03.000Z\"\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","X-Pagination-Per-Page":"50","Access-Control-Expose-Headers":"X-Pagination-Per-Page, X-Pagination-Current-Page, X-Pagination-Total-Pages, X-Pagination-Total-Entries","X-Pagination-Current-Page":"1","X-Pagination-Total-Pages":"1","X-Pagination-Total-Entries":"1","Content-Type":"application/json; charset=utf-8","ETag":"W/\"644c8327ad8601c8ef89922dd0e4ad75\"","X-Request-Id":"d8269832-484b-48cd-ad47-d0903298ffd5","X-Runtime":"0.017848","Content-Length":"140"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttps://api.civis.test/permission_sets/6/resources\" -X GET \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer y2nHhHOyGBpWSweICPAKzb6Eppq-SuLs4hK6Gmy5gFo\" \\\n\t-H \"Accept: application/vnd.civis-platform.v1\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"post":{"summary":"Create a resource in a permission set","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID for this permission set.","type":"integer"},{"name":"Object425","in":"body","schema":{"$ref":"#/definitions/Object425"},"required":true}],"responses":{"201":{"description":"success","schema":{"$ref":"#/definitions/Object424"}}},"x-examples":[{"resource":"PermissionSets","resource_explanation":null,"http_method":"POST","route":"https://api.civis.test/permission_sets/:id/resources","description":"Create a resource in a permission set","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"https://api.civis.test/permission_sets/7/resources","request_body":"{\n \"name\": \"new_resource\"\n}","request_headers":{"Content-Type":"application/json","Authorization":"Bearer 6M0c8dRU7c0JyHu_bAXxCmCz9IUTPXGMOZeSfyp9Vlc","Accept":"application/vnd.civis-platform.v1","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":201,"response_status_text":"Created","response_body":"{\n \"permissionSetId\": 7,\n \"name\": \"new_resource\",\n \"description\": null,\n \"createdAt\": \"2023-07-18T18:43:03.000Z\",\n \"updatedAt\": \"2023-07-18T18:43:03.000Z\"\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"8a21c45bc91871bc07c68ef70cb4cf3c\"","X-Request-Id":"2cdcc9a8-c98e-45bc-b113-396076ae7890","X-Runtime":"0.019039","Content-Length":"140"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttps://api.civis.test/permission_sets/7/resources\" -d '{\"name\":\"new_resource\"}' -X POST \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer 6M0c8dRU7c0JyHu_bAXxCmCz9IUTPXGMOZeSfyp9Vlc\" \\\n\t-H \"Accept: application/vnd.civis-platform.v1\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/permission_sets/{id}/resources/{name}":{"get":{"summary":"Get a resource in a permission set","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID for this permission set.","type":"integer"},{"name":"name","in":"path","required":true,"description":"The name of this resource.","type":"string"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object424"}}},"x-examples":[{"resource":"PermissionSets","resource_explanation":null,"http_method":"GET","route":"https://api.civis.test/permission_sets/:id/resources/:name","description":"View a resource's details","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"https://api.civis.test/permission_sets/8/resources/resource_7","request_body":null,"request_headers":{"Content-Type":"application/json","Authorization":"Bearer qD3Fxvtxro6olrCCpDz3CjFVngiGDTBMb6QFEjkqaL4","Accept":"application/vnd.civis-platform.v1","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"permissionSetId\": 8,\n \"name\": \"resource_7\",\n \"description\": null,\n \"createdAt\": \"2023-07-18T18:43:03.000Z\",\n \"updatedAt\": \"2023-07-18T18:43:03.000Z\"\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"ae0b55bb9acaa873bd299f46ec9b10b9\"","X-Request-Id":"45d6ee23-6d35-4668-a4fe-e62d71280ebe","X-Runtime":"0.014550","Content-Length":"138"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttps://api.civis.test/permission_sets/8/resources/resource_7\" -X GET \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer qD3Fxvtxro6olrCCpDz3CjFVngiGDTBMb6QFEjkqaL4\" \\\n\t-H \"Accept: application/vnd.civis-platform.v1\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"patch":{"summary":"Update a resource in a permission set","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID for this permission set.","type":"integer"},{"name":"name","in":"path","required":true,"description":"The name of this resource.","type":"string"},{"name":"Object426","in":"body","schema":{"$ref":"#/definitions/Object426"},"required":false}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object424"}}},"x-examples":[{"resource":"PermissionSets","resource_explanation":null,"http_method":"PATCH","route":"https://api.civis.test/permission_sets/:id/resources/:name","description":"Update a resource in a permission set","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"PATCH","request_path":"https://api.civis.test/permission_sets/9/resources/resource_8","request_body":"{\n \"description\": \"security\"\n}","request_headers":{"Content-Type":"application/json","Authorization":"Bearer tuLO11CAIUWHE_e5FG26hTMys6V0QXLEbegwEGdm_j4","Accept":"application/vnd.civis-platform.v1","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"permissionSetId\": 9,\n \"name\": \"resource_8\",\n \"description\": \"security\",\n \"createdAt\": \"2023-07-18T18:43:03.000Z\",\n \"updatedAt\": \"2023-07-18T18:43:03.000Z\"\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"167e69dd22590cd5ea7a3f181a56330b\"","X-Request-Id":"8ac5b481-745f-4e00-8e87-000abdcaf01e","X-Runtime":"0.018431","Content-Length":"144"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttps://api.civis.test/permission_sets/9/resources/resource_8\" -d '{\"description\":\"security\"}' -X PATCH \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer tuLO11CAIUWHE_e5FG26hTMys6V0QXLEbegwEGdm_j4\" \\\n\t-H \"Accept: application/vnd.civis-platform.v1\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"delete":{"summary":"Delete a resource in a permission set","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID for this permission set.","type":"integer"},{"name":"name","in":"path","required":true,"description":"The name of this resource.","type":"string"}],"responses":{"204":{"description":"success"}},"x-examples":[{"resource":"PermissionSets","resource_explanation":null,"http_method":"DELETE","route":"https://api.civis.test/permission_sets/:id/resources/:name","description":"Delete a resource in a permission set","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"DELETE","request_path":"https://api.civis.test/permission_sets/10/resources/resource_9","request_body":null,"request_headers":{"Content-Type":"application/json","Authorization":"Bearer fBALXDU3Ltz47HJDk6HuWfv8y_5qYejQQrh3NrYEYNc","Accept":"application/vnd.civis-platform.v1","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":204,"response_status_text":"No Content","response_body":null,"response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","X-Request-Id":"6e297d45-2fba-42f2-b01a-8c5c342d9d3c","X-Runtime":"0.021675"},"response_content_type":null,"curl":"curl \"api.civis.testhttps://api.civis.test/permission_sets/10/resources/resource_9\" -d '' -X DELETE \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer fBALXDU3Ltz47HJDk6HuWfv8y_5qYejQQrh3NrYEYNc\" \\\n\t-H \"Accept: application/vnd.civis-platform.v1\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/permission_sets/{id}/resources/{name}/shares":{"get":{"summary":"List users and groups permissioned on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID for this permission set.","type":"integer"},{"name":"name","in":"path","required":true,"description":"The name of this resource.","type":"string"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object9"}}}},"x-examples":null,"x-deprecation-warning":null}},"/permission_sets/{id}/resources/{name}/shares/users":{"put":{"summary":"Set the permissions users have on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID for this permission set.","type":"integer"},{"name":"name","in":"path","required":true,"description":"The name of this resource.","type":"string"},{"name":"Object427","in":"body","schema":{"$ref":"#/definitions/Object427"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object9"}}},"x-examples":null,"x-deprecation-warning":null}},"/permission_sets/{id}/resources/{name}/shares/users/{user_id}":{"delete":{"summary":"Revoke the permissions a user has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID for this permission set.","type":"integer"},{"name":"name","in":"path","required":true,"description":"The name of this resource.","type":"string"},{"name":"user_id","in":"path","required":true,"description":"The ID of the user.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/permission_sets/{id}/resources/{name}/shares/groups":{"put":{"summary":"Set the permissions groups has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID for this permission set.","type":"integer"},{"name":"name","in":"path","required":true,"description":"The name of this resource.","type":"string"},{"name":"Object428","in":"body","schema":{"$ref":"#/definitions/Object428"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object9"}}},"x-examples":null,"x-deprecation-warning":null}},"/permission_sets/{id}/resources/{name}/shares/groups/{group_id}":{"delete":{"summary":"Revoke the permissions a group has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID for this permission set.","type":"integer"},{"name":"name","in":"path","required":true,"description":"The name of this resource.","type":"string"},{"name":"group_id","in":"path","required":true,"description":"The ID of the group.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/predictions/":{"get":{"summary":"List predictions","description":null,"deprecated":false,"parameters":[{"name":"model_id","in":"query","required":false,"description":"If specified, only return predictions associated with this model ID.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object429"}}}},"x-examples":[{"resource":"Predictions","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/predictions?modelId=:model_id","description":"Filter predictions by predictive model","explanation":null,"parameters":[{"required":false,"name":"modelId","description":"If specified, only return predictions associated with this model ID."}],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/predictions?modelId=2127","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer yC-xAgHtHYbIlNVLB4x6kjEgONQegEjaxgPBNCuz5bQ","Host":"api.civis.test","Cookie":""},"request_query_parameters":{"modelId":"2127"},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 2132,\n \"modelId\": 2127,\n \"scoredTableId\": 132,\n \"scoredTableName\": \"schema_name.table_name137\",\n \"outputTableName\": null,\n \"state\": \"running\",\n \"error\": null,\n \"startedAt\": \"2015-01-01T01:01:01.000Z\",\n \"finishedAt\": \"2012-02-02T02:02:02.000Z\",\n \"lastRun\": {\n \"id\": 190,\n \"state\": \"running\",\n \"createdAt\": \"2024-03-29T15:00:40.000Z\",\n \"startedAt\": \"2015-01-01T01:01:01.000Z\",\n \"finishedAt\": \"2012-02-02T02:02:02.000Z\",\n \"error\": null\n }\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"289c8862324503cf9150563b650736cb\"","X-Request-Id":"48a5740e-fdda-449d-beba-8e04c0e8d131","X-Runtime":"0.030223","Content-Length":"397"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/predictions?modelId=2127\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer yC-xAgHtHYbIlNVLB4x6kjEgONQegEjaxgPBNCuz5bQ\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Predictions","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/predictions","description":"List visible predictions","explanation":null,"parameters":[{"required":false,"name":"modelId","description":"If specified, only return predictions associated with this model ID."}],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/predictions","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer mBlTWzap-KZMlH3yO0d9ZSYmEGkdiTyOh7gYS03BBXY","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 2143,\n \"modelId\": 2140,\n \"scoredTableId\": 159,\n \"scoredTableName\": \"schema_name.table_name164\",\n \"outputTableName\": null,\n \"state\": \"running\",\n \"error\": null,\n \"startedAt\": \"2015-01-01T01:01:01.000Z\",\n \"finishedAt\": \"2012-02-02T02:02:02.000Z\",\n \"lastRun\": {\n \"id\": 195,\n \"state\": \"running\",\n \"createdAt\": \"2024-03-29T15:00:43.000Z\",\n \"startedAt\": \"2015-01-01T01:01:01.000Z\",\n \"finishedAt\": \"2012-02-02T02:02:02.000Z\",\n \"error\": null\n }\n },\n {\n \"id\": 2142,\n \"modelId\": 2137,\n \"scoredTableId\": 150,\n \"scoredTableName\": \"schema_name.table_name155\",\n \"outputTableName\": null,\n \"state\": \"running\",\n \"error\": null,\n \"startedAt\": \"2015-01-01T01:01:01.000Z\",\n \"finishedAt\": \"2012-02-02T02:02:02.000Z\",\n \"lastRun\": {\n \"id\": 194,\n \"state\": \"running\",\n \"createdAt\": \"2024-03-29T15:00:43.000Z\",\n \"startedAt\": \"2015-01-01T01:01:01.000Z\",\n \"finishedAt\": \"2012-02-02T02:02:02.000Z\",\n \"error\": null\n }\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"a412eac0bec8714550c7bd9c84abd0d8\"","X-Request-Id":"03ed568a-0cdb-4ead-af95-357f3935e8bf","X-Runtime":"0.033118","Content-Length":"793"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/predictions\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer mBlTWzap-KZMlH3yO0d9ZSYmEGkdiTyOh7gYS03BBXY\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/predictions/{id}":{"get":{"summary":"Show the specified prediction","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the prediction.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object430"}}},"x-examples":[{"resource":"Predictions","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/predictions/:id","description":"View a prediction","explanation":null,"parameters":[{"required":true,"name":"id","description":"The ID of the prediction."}],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/predictions/2149","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer vOC65m_mBdKCIdRigXkojIZ6S1rWhusO-rNWCiduhqk","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 2149,\n \"modelId\": 2147,\n \"scoredTableId\": 168,\n \"scoredTableName\": \"schema_name.table_name173\",\n \"outputTableName\": null,\n \"state\": \"running\",\n \"error\": null,\n \"startedAt\": \"2015-01-01T01:01:01.000Z\",\n \"finishedAt\": \"2012-02-02T02:02:02.000Z\",\n \"lastRun\": {\n \"id\": 197,\n \"state\": \"running\",\n \"createdAt\": \"2024-03-29T15:00:44.000Z\",\n \"startedAt\": \"2015-01-01T01:01:01.000Z\",\n \"finishedAt\": \"2012-02-02T02:02:02.000Z\",\n \"error\": null\n },\n \"scoredTables\": [\n {\n \"id\": 1,\n \"schema\": \"schema_name\",\n \"name\": \"table_name183\",\n \"createdAt\": \"2024-03-29T15:00:44.000Z\",\n \"scoreStats\": [\n {\n \"scoreName\": \"score\",\n \"histogram\": [\n 1,\n 2,\n 3,\n 4,\n 5,\n 6,\n 7,\n 8,\n 9,\n 10,\n 11,\n 12,\n 13,\n 14,\n 15,\n 16,\n 17,\n 18,\n 19,\n 20\n ],\n \"avgScore\": 0.5,\n \"minScore\": 0.1,\n \"maxScore\": 0.9\n }\n ]\n },\n {\n \"id\": 2,\n \"schema\": \"schema_name\",\n \"name\": \"table_name185\",\n \"createdAt\": \"2024-03-29T15:00:45.000Z\",\n \"scoreStats\": [\n {\n \"scoreName\": \"score\",\n \"histogram\": [\n 1,\n 2,\n 3,\n 4,\n 5,\n 6,\n 7,\n 8,\n 9,\n 10,\n 11,\n 12,\n 13,\n 14,\n 15,\n 16,\n 17,\n 18,\n 19,\n 20\n ],\n \"avgScore\": 0.5,\n \"minScore\": 0.1,\n \"maxScore\": 0.9\n }\n ]\n }\n ],\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n },\n \"limitingSQL\": null,\n \"primaryKey\": [\n \"personid\"\n ]\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"46a9b69eccfa9e69f3cc783ec43043d3\"","X-Request-Id":"2ddd9029-e119-486f-b586-66a65921ae4a","X-Runtime":"0.036726","Content-Length":"1084"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/predictions/2149\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer vOC65m_mBdKCIdRigXkojIZ6S1rWhusO-rNWCiduhqk\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/predictions/{id}/schedules":{"get":{"summary":"Show the prediction schedule","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"ID of the prediction associated with this schedule.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object433"}}},"x-examples":[{"resource":"Predictions","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/predictions/:id/schedules","description":"show prediction schedule","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/predictions/2156/schedules","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer IfxYd3UXTG1GzkovGbU9tV0B5sB4zqEwfOv-o33pKw4","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 2156,\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n },\n \"scoreOnModelBuild\": false\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"64074594ca3da685820338a46607307f\"","X-Request-Id":"01d5fa24-79a4-4620-b471-13b6a73f234f","X-Runtime":"0.028659","Content-Length":"182"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/predictions/2156/schedules\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer IfxYd3UXTG1GzkovGbU9tV0B5sB4zqEwfOv-o33pKw4\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/projects/":{"get":{"summary":"List projects","description":null,"deprecated":false,"parameters":[{"name":"permission","in":"query","required":false,"description":"A permissions string, one of \"read\", \"write\", or \"manage\". Lists only projects for which the current user has that permission.","type":"string"},{"name":"auto_share","in":"query","required":false,"description":"Used to filter projects based on whether the project is autoshare enabled or not.","type":"boolean"},{"name":"author","in":"query","required":false,"description":"If specified, return items from any of these authors. It accepts a comma-separated list of user IDs.","type":"string"},{"name":"hidden","in":"query","required":false,"description":"If specified to be true, returns hidden items. Defaults to false, returning non-hidden items.","type":"boolean"},{"name":"archived","in":"query","required":false,"description":"The archival status of the requested item(s).","type":"string"},{"name":"limit","in":"query","required":false,"description":"Number of results to return. Defaults to 20. Maximum allowed is 1000.","type":"integer"},{"name":"page_num","in":"query","required":false,"description":"Page number of the results to return. Defaults to the first page, 1.","type":"integer"},{"name":"order","in":"query","required":false,"description":"The field on which to order the result set. Defaults to updated_at. Must be one of: updated_at, name, created_at.","type":"string"},{"name":"order_dir","in":"query","required":false,"description":"Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc.","type":"string"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object84"}}}},"x-examples":[{"resource":"Projects","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/projects","description":"Lists projects","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/projects","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer cLKTrThHf-BYgKmV0dM8zCuMm9k5zDuA_xyK0o6wvZc","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 5,\n \"author\": {\n \"id\": 227,\n \"name\": \"User devuserfactory133 133\",\n \"username\": \"devuserfactory133\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"name\": \"Test Project\",\n \"description\": null,\n \"users\": [\n {\n \"id\": 227,\n \"name\": \"User devuserfactory133 133\",\n \"username\": \"devuserfactory133\",\n \"initials\": \"UD\",\n \"online\": null\n }\n ],\n \"autoShare\": false,\n \"createdAt\": \"2025-02-26T17:48:58.000Z\",\n \"updatedAt\": \"2025-02-26T19:48:58.000Z\",\n \"archived\": false\n },\n {\n \"id\": 2,\n \"author\": {\n \"id\": 194,\n \"name\": \"User devuserfactory109 109\",\n \"username\": \"devuserfactory109\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"name\": \"Test Project\",\n \"description\": null,\n \"users\": [\n {\n \"id\": 194,\n \"name\": \"User devuserfactory109 109\",\n \"username\": \"devuserfactory109\",\n \"initials\": \"UD\",\n \"online\": null\n }\n ],\n \"autoShare\": false,\n \"createdAt\": \"2025-02-26T17:48:54.000Z\",\n \"updatedAt\": \"2025-02-26T18:48:57.000Z\",\n \"archived\": false\n },\n {\n \"id\": 3,\n \"author\": {\n \"id\": 194,\n \"name\": \"User devuserfactory109 109\",\n \"username\": \"devuserfactory109\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"name\": \"Test Project\",\n \"description\": null,\n \"users\": [\n {\n \"id\": 194,\n \"name\": \"User devuserfactory109 109\",\n \"username\": \"devuserfactory109\",\n \"initials\": \"UD\",\n \"online\": null\n }\n ],\n \"autoShare\": false,\n \"createdAt\": \"2025-02-26T17:48:57.000Z\",\n \"updatedAt\": \"2025-02-26T17:48:57.000Z\",\n \"archived\": false\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","X-Pagination-Per-Page":"20","Access-Control-Expose-Headers":"X-Pagination-Per-Page, X-Pagination-Current-Page, X-Pagination-Total-Pages, X-Pagination-Total-Entries","X-Pagination-Current-Page":"1","X-Pagination-Total-Pages":"1","X-Pagination-Total-Entries":"3","Content-Type":"application/json; charset=utf-8","ETag":"W/\"93f866947d760576266693079fdbe0e0\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"156fd807-0ffb-4997-b160-dc4e16d6ffbb","X-Runtime":"0.041020","Content-Length":"1195"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/projects\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer cLKTrThHf-BYgKmV0dM8zCuMm9k5zDuA_xyK0o6wvZc\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Projects","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/projects","description":"Filter projects by author","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/projects?author=261","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer yC7LCnL9x953gPrKMNTbaNbDEoajOTL4Qh2tcKfEhXM","Host":"api.civis.test","Cookie":""},"request_query_parameters":{"author":"261"},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 9,\n \"author\": {\n \"id\": 261,\n \"name\": \"User devuserfactory158 158\",\n \"username\": \"devuserfactory158\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"name\": \"Test Project\",\n \"description\": null,\n \"users\": [\n {\n \"id\": 261,\n \"name\": \"User devuserfactory158 158\",\n \"username\": \"devuserfactory158\",\n \"initials\": \"UD\",\n \"online\": null\n }\n ],\n \"autoShare\": false,\n \"createdAt\": \"2025-02-26T17:49:05.000Z\",\n \"updatedAt\": \"2025-02-26T19:49:05.000Z\",\n \"archived\": false\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","X-Pagination-Per-Page":"20","Access-Control-Expose-Headers":"X-Pagination-Per-Page, X-Pagination-Current-Page, X-Pagination-Total-Pages, X-Pagination-Total-Entries","X-Pagination-Current-Page":"1","X-Pagination-Total-Pages":"1","X-Pagination-Total-Entries":"1","Content-Type":"application/json; charset=utf-8","ETag":"W/\"c434f8a1d79ebe1b6c76051c7127696c\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"d78ee7cc-250d-47ae-8dd7-8d64bc1d75f6","X-Runtime":"0.048909","Content-Length":"399"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/projects?author=261\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer yC7LCnL9x953gPrKMNTbaNbDEoajOTL4Qh2tcKfEhXM\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Projects","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/projects","description":"Filter projects by multiple authors","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/projects?author=295%2C262","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer bgbdBUpsJGf1urHDcSnsESpMMzYQXEdC-_7WICnslJw","Host":"api.civis.test","Cookie":""},"request_query_parameters":{"author":"295,262"},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 13,\n \"author\": {\n \"id\": 295,\n \"name\": \"User devuserfactory183 183\",\n \"username\": \"devuserfactory183\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"name\": \"Test Project\",\n \"description\": null,\n \"users\": [\n {\n \"id\": 295,\n \"name\": \"User devuserfactory183 183\",\n \"username\": \"devuserfactory183\",\n \"initials\": \"UD\",\n \"online\": null\n }\n ],\n \"autoShare\": false,\n \"createdAt\": \"2025-02-26T17:49:15.000Z\",\n \"updatedAt\": \"2025-02-26T19:49:15.000Z\",\n \"archived\": false\n },\n {\n \"id\": 10,\n \"author\": {\n \"id\": 262,\n \"name\": \"User devuserfactory159 159\",\n \"username\": \"devuserfactory159\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"name\": \"Test Project\",\n \"description\": null,\n \"users\": [\n {\n \"id\": 262,\n \"name\": \"User devuserfactory159 159\",\n \"username\": \"devuserfactory159\",\n \"initials\": \"UD\",\n \"online\": null\n }\n ],\n \"autoShare\": false,\n \"createdAt\": \"2025-02-26T17:49:10.000Z\",\n \"updatedAt\": \"2025-02-26T18:49:14.000Z\",\n \"archived\": false\n },\n {\n \"id\": 11,\n \"author\": {\n \"id\": 262,\n \"name\": \"User devuserfactory159 159\",\n \"username\": \"devuserfactory159\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"name\": \"Test Project\",\n \"description\": null,\n \"users\": [\n {\n \"id\": 262,\n \"name\": \"User devuserfactory159 159\",\n \"username\": \"devuserfactory159\",\n \"initials\": \"UD\",\n \"online\": null\n }\n ],\n \"autoShare\": false,\n \"createdAt\": \"2025-02-26T17:49:14.000Z\",\n \"updatedAt\": \"2025-02-26T17:49:14.000Z\",\n \"archived\": false\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","X-Pagination-Per-Page":"20","Access-Control-Expose-Headers":"X-Pagination-Per-Page, X-Pagination-Current-Page, X-Pagination-Total-Pages, X-Pagination-Total-Entries","X-Pagination-Current-Page":"1","X-Pagination-Total-Pages":"1","X-Pagination-Total-Entries":"3","Content-Type":"application/json; charset=utf-8","ETag":"W/\"c1801d07e501bffa66c394fea2902ace\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"d7974d08-4659-4350-9709-4af42e9f436d","X-Runtime":"0.057537","Content-Length":"1198"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/projects?author=295%2C262\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer bgbdBUpsJGf1urHDcSnsESpMMzYQXEdC-_7WICnslJw\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Projects","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/projects","description":"Filter projects by permission","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/projects?permission=write","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer AGFs6g7I81GlWOYPTcupi--VK9c49O9nt98T_kaFjkE","Host":"api.civis.test","Cookie":""},"request_query_parameters":{"permission":"write"},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 14,\n \"author\": {\n \"id\": 296,\n \"name\": \"User devuserfactory184 184\",\n \"username\": \"devuserfactory184\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"name\": \"Test Project\",\n \"description\": null,\n \"users\": [\n {\n \"id\": 296,\n \"name\": \"User devuserfactory184 184\",\n \"username\": \"devuserfactory184\",\n \"initials\": \"UD\",\n \"online\": null\n }\n ],\n \"autoShare\": false,\n \"createdAt\": \"2025-02-26T17:49:19.000Z\",\n \"updatedAt\": \"2025-02-26T18:49:21.000Z\",\n \"archived\": false\n },\n {\n \"id\": 15,\n \"author\": {\n \"id\": 296,\n \"name\": \"User devuserfactory184 184\",\n \"username\": \"devuserfactory184\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"name\": \"Test Project\",\n \"description\": null,\n \"users\": [\n {\n \"id\": 296,\n \"name\": \"User devuserfactory184 184\",\n \"username\": \"devuserfactory184\",\n \"initials\": \"UD\",\n \"online\": null\n }\n ],\n \"autoShare\": false,\n \"createdAt\": \"2025-02-26T17:49:21.000Z\",\n \"updatedAt\": \"2025-02-26T17:49:21.000Z\",\n \"archived\": false\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","X-Pagination-Per-Page":"20","Access-Control-Expose-Headers":"X-Pagination-Per-Page, X-Pagination-Current-Page, X-Pagination-Total-Pages, X-Pagination-Total-Entries","X-Pagination-Current-Page":"1","X-Pagination-Total-Pages":"1","X-Pagination-Total-Entries":"2","Content-Type":"application/json; charset=utf-8","ETag":"W/\"482c29591dc62ac310d661933f25859f\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"a434a3fe-ab28-496d-8bf7-1010a208c85a","X-Runtime":"0.036522","Content-Length":"799"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/projects?permission=write\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer AGFs6g7I81GlWOYPTcupi--VK9c49O9nt98T_kaFjkE\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"post":{"summary":"Create a project","description":null,"deprecated":false,"parameters":[{"name":"Object434","in":"body","schema":{"$ref":"#/definitions/Object434"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object435"}}},"x-examples":[{"resource":"Projects","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/projects","description":"Create a project","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/projects","request_body":"{\n \"name\": \"NewProject\",\n \"description\": \"NewDescription\",\n \"note\": \"NewNote\"\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer ptgdEphAqWGg9lhoGo_shsNjbA1CuCIgO7CAeKX4_IA","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 25,\n \"author\": {\n \"id\": 384,\n \"name\": \"User devuserfactory250 250\",\n \"username\": \"devuserfactory250\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"name\": \"NewProject\",\n \"description\": \"NewDescription\",\n \"users\": [\n {\n \"id\": 384,\n \"name\": \"User devuserfactory250 250\",\n \"username\": \"devuserfactory250\",\n \"initials\": \"UD\",\n \"online\": null\n }\n ],\n \"autoShare\": false,\n \"createdAt\": \"2025-02-26T17:49:35.000Z\",\n \"updatedAt\": \"2025-02-26T17:49:35.000Z\",\n \"tables\": [\n\n ],\n \"surveys\": [\n\n ],\n \"scripts\": [\n\n ],\n \"imports\": [\n\n ],\n \"exports\": [\n\n ],\n \"models\": [\n\n ],\n \"notebooks\": [\n\n ],\n \"services\": [\n\n ],\n \"workflows\": [\n\n ],\n \"reports\": [\n\n ],\n \"scriptTemplates\": [\n\n ],\n \"files\": [\n\n ],\n \"enhancements\": [\n\n ],\n \"projects\": [\n\n ],\n \"allObjects\": [\n\n ],\n \"note\": \"NewNote\",\n \"canCurrentUserEnableAutoShare\": true,\n \"hidden\": false,\n \"archived\": false,\n \"parentProject\": null,\n \"myPermissionLevel\": \"manage\"\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"0c2326ee5ffa74d704dfeddde2ec7467\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"e4acaafa-042e-4fc0-9bc1-4a07e8ac4bbd","X-Runtime":"0.109475","Content-Length":"740"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/projects\" -d '{\"name\":\"NewProject\",\"description\":\"NewDescription\",\"note\":\"NewNote\"}' -X POST \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer ptgdEphAqWGg9lhoGo_shsNjbA1CuCIgO7CAeKX4_IA\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/projects/{id}/clone":{"post":{"summary":"Clone this ","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID for this project.","type":"integer"},{"name":"Object452","in":"body","schema":{"$ref":"#/definitions/Object452"},"required":false}],"responses":{"201":{"description":"success","schema":{"$ref":"#/definitions/Object435"}}},"x-examples":null,"x-deprecation-warning":null}},"/projects/{project_id}":{"get":{"summary":"Get a detailed view of a project and the objects in it","description":null,"deprecated":false,"parameters":[{"name":"project_id","in":"path","required":true,"type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object435"}}},"x-examples":[{"resource":"Projects","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/projects/:project_id","description":"View a project","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/projects/17","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer lwQL5X9lhKIb6WuzAOL-SJtcGfNumFu-8_clAIfeeWU","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 17,\n \"author\": {\n \"id\": 329,\n \"name\": \"User devuserfactory208 208\",\n \"username\": \"devuserfactory208\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"name\": \"Test Project\",\n \"description\": null,\n \"users\": [\n {\n \"id\": 329,\n \"name\": \"User devuserfactory208 208\",\n \"username\": \"devuserfactory208\",\n \"initials\": \"UD\",\n \"online\": null\n }\n ],\n \"autoShare\": false,\n \"createdAt\": \"2025-02-26T17:49:24.000Z\",\n \"updatedAt\": \"2025-02-26T18:49:27.000Z\",\n \"tables\": [\n {\n \"schema\": \"schema_name\",\n \"name\": \"table_name49\",\n \"rowCount\": 1,\n \"columnCount\": 1,\n \"createdAt\": \"2025-02-26T17:49:24.000Z\",\n \"updatedAt\": \"2025-02-26T17:49:24.000Z\"\n }\n ],\n \"surveys\": [\n\n ],\n \"scripts\": [\n {\n \"id\": 191,\n \"createdAt\": \"2025-02-26T17:49:22.000Z\",\n \"updatedAt\": \"2025-02-26T17:49:22.000Z\",\n \"name\": \"Script #191\",\n \"type\": \"JobTypes::SqlRunner\",\n \"finishedAt\": \"2025-02-26T17:49:22.000Z\",\n \"state\": \"running\",\n \"lastRun\": {\n \"state\": \"running\",\n \"updatedAt\": \"2025-02-26T17:49:22.000Z\"\n }\n }\n ],\n \"imports\": [\n {\n \"id\": 202,\n \"createdAt\": \"2025-02-26T17:49:25.000Z\",\n \"updatedAt\": \"2025-02-26T17:49:25.000Z\",\n \"name\": \"Import #202\",\n \"type\": \"JobTypes::Import\",\n \"finishedAt\": null,\n \"state\": \"idle\",\n \"lastRun\": null\n }\n ],\n \"exports\": [\n {\n \"id\": 206,\n \"createdAt\": \"2025-02-26T17:49:25.000Z\",\n \"updatedAt\": \"2025-02-26T17:49:25.000Z\",\n \"name\": \"Export #206\",\n \"type\": \"JobTypes::Import\",\n \"finishedAt\": null,\n \"state\": \"running\",\n \"lastRun\": {\n \"state\": \"running\",\n \"updatedAt\": \"2025-02-26T17:49:25.000Z\"\n }\n }\n ],\n \"models\": [\n {\n \"id\": 198,\n \"createdAt\": \"2025-02-26T17:49:24.000Z\",\n \"updatedAt\": \"2025-02-26T17:49:24.000Z\",\n \"name\": \"Model #198\",\n \"state\": \"idle\"\n }\n ],\n \"notebooks\": [\n {\n \"id\": 9,\n \"createdAt\": \"2025-02-26T17:49:26.000Z\",\n \"updatedAt\": \"2025-02-26T17:49:26.000Z\",\n \"name\": \"Test Notebook\",\n \"currentDeploymentId\": null,\n \"lastDeploy\": null\n },\n {\n \"id\": 10,\n \"createdAt\": \"2025-02-26T17:49:26.000Z\",\n \"updatedAt\": \"2025-02-26T17:49:26.000Z\",\n \"name\": \"Test Notebook\",\n \"currentDeploymentId\": 9,\n \"lastDeploy\": {\n \"state\": \"running\",\n \"updatedAt\": \"2025-02-26T17:49:27.000Z\"\n }\n }\n ],\n \"services\": [\n {\n \"id\": 9,\n \"createdAt\": \"2025-02-26T17:49:26.000Z\",\n \"updatedAt\": \"2025-02-26T17:49:26.000Z\",\n \"name\": \"Service #9\",\n \"currentDeploymentId\": null,\n \"lastDeploy\": null\n },\n {\n \"id\": 10,\n \"createdAt\": \"2025-02-26T17:49:27.000Z\",\n \"updatedAt\": \"2025-02-26T17:49:27.000Z\",\n \"name\": \"Service #10\",\n \"currentDeploymentId\": null,\n \"lastDeploy\": {\n \"state\": \"terminated\",\n \"updatedAt\": \"2025-02-26T17:49:27.000Z\"\n }\n }\n ],\n \"workflows\": [\n {\n \"id\": 6,\n \"createdAt\": \"2025-02-26T17:49:26.000Z\",\n \"updatedAt\": \"2025-02-26T17:49:26.000Z\",\n \"name\": \"Test Workflow\",\n \"state\": \"idle\",\n \"lastExecution\": null\n }\n ],\n \"reports\": [\n {\n \"id\": 15,\n \"createdAt\": \"2025-02-26T17:49:23.000Z\",\n \"updatedAt\": \"2025-02-26T17:49:23.000Z\",\n \"name\": \"Project report\",\n \"state\": \"idle\"\n }\n ],\n \"scriptTemplates\": [\n {\n \"id\": 5,\n \"createdAt\": \"2025-02-26T17:49:26.000Z\",\n \"updatedAt\": \"2025-02-26T17:49:26.000Z\",\n \"name\": \"awesome sql template\"\n }\n ],\n \"files\": [\n {\n \"id\": 56,\n \"createdAt\": \"2025-02-26T17:49:26.000Z\",\n \"updatedAt\": \"2025-02-26T17:49:26.000Z\",\n \"fileName\": \"fake_name\",\n \"fileSize\": 1,\n \"expired\": null\n }\n ],\n \"enhancements\": [\n {\n \"id\": 211,\n \"createdAt\": \"2025-02-26T17:49:26.000Z\",\n \"updatedAt\": \"2025-02-26T17:49:26.000Z\",\n \"name\": \"CASS/NCOA #211\",\n \"lastRun\": null\n }\n ],\n \"projects\": [\n {\n \"id\": 18,\n \"createdAt\": \"2025-02-26T17:49:27.000Z\",\n \"updatedAt\": \"2025-02-26T17:49:27.000Z\",\n \"name\": \"Test Project\",\n \"description\": null\n }\n ],\n \"allObjects\": [\n {\n \"projectId\": 17,\n \"objectId\": 191,\n \"objectType\": \"JobTypes::SqlRunner\",\n \"fcoType\": \"scripts/sql\",\n \"subType\": null,\n \"name\": \"Script #191\",\n \"icon\": \"civicon-scripts\",\n \"author\": \"Admin devadminfactory117 117\",\n \"updatedAt\": \"2025-02-26T17:49:22.000Z\",\n \"autoShare\": null,\n \"archived\": false,\n \"hidden\": true,\n \"myPermissionLevel\": \"write\"\n },\n {\n \"projectId\": 17,\n \"objectId\": 202,\n \"objectType\": \"JobTypes::Import\",\n \"fcoType\": \"imports\",\n \"subType\": null,\n \"name\": \"Import #202\",\n \"icon\": \"civicon-imports\",\n \"author\": \"User devuserfactory208 208\",\n \"updatedAt\": \"2025-02-26T17:49:25.000Z\",\n \"autoShare\": null,\n \"archived\": false,\n \"hidden\": false,\n \"myPermissionLevel\": \"manage\"\n },\n {\n \"projectId\": 17,\n \"objectId\": 206,\n \"objectType\": \"JobTypes::Import\",\n \"fcoType\": \"exports\",\n \"subType\": null,\n \"name\": \"Export #206\",\n \"icon\": \"civicon-exports\",\n \"author\": \"User devuserfactory208 208\",\n \"updatedAt\": \"2025-02-26T17:49:25.000Z\",\n \"autoShare\": null,\n \"archived\": false,\n \"hidden\": false,\n \"myPermissionLevel\": \"manage\"\n },\n {\n \"projectId\": 17,\n \"objectId\": 198,\n \"objectType\": \"JobTypes::BuildModel\",\n \"fcoType\": \"models\",\n \"subType\": null,\n \"name\": \"Model #198\",\n \"icon\": \"civicon-modeling\",\n \"author\": \"Admin devadminfactory121 121\",\n \"updatedAt\": \"2025-02-26T17:49:24.000Z\",\n \"autoShare\": null,\n \"archived\": false,\n \"hidden\": false,\n \"myPermissionLevel\": \"write\"\n },\n {\n \"projectId\": 17,\n \"objectId\": 9,\n \"objectType\": \"Notebook\",\n \"fcoType\": \"notebooks\",\n \"subType\": null,\n \"name\": \"Test Notebook\",\n \"icon\": \"civicon-book\",\n \"author\": \"User devuserfactory208 208\",\n \"updatedAt\": \"2025-02-26T17:49:26.000Z\",\n \"autoShare\": null,\n \"archived\": false,\n \"hidden\": false,\n \"myPermissionLevel\": \"manage\"\n },\n {\n \"projectId\": 17,\n \"objectId\": 10,\n \"objectType\": \"Notebook\",\n \"fcoType\": \"notebooks\",\n \"subType\": null,\n \"name\": \"Test Notebook\",\n \"icon\": \"civicon-book\",\n \"author\": \"User devuserfactory208 208\",\n \"updatedAt\": \"2025-02-26T17:49:26.000Z\",\n \"autoShare\": null,\n \"archived\": false,\n \"hidden\": false,\n \"myPermissionLevel\": \"manage\"\n },\n {\n \"projectId\": 17,\n \"objectId\": 6,\n \"objectType\": \"Workflow::Workflow\",\n \"fcoType\": \"workflows\",\n \"subType\": null,\n \"name\": \"Test Workflow\",\n \"icon\": \"civicon-workflows\",\n \"author\": \"User devuserfactory208 208\",\n \"updatedAt\": \"2025-02-26T17:49:26.000Z\",\n \"autoShare\": null,\n \"archived\": false,\n \"hidden\": false,\n \"myPermissionLevel\": \"manage\"\n },\n {\n \"projectId\": 17,\n \"objectId\": 15,\n \"objectType\": \"ReportTypes::Html\",\n \"fcoType\": \"reports\",\n \"subType\": null,\n \"name\": \"Project report\",\n \"icon\": \"civicon-reports\",\n \"author\": \"User devuserfactory212 212\",\n \"updatedAt\": \"2025-02-26T17:49:23.000Z\",\n \"autoShare\": null,\n \"archived\": false,\n \"hidden\": false,\n \"myPermissionLevel\": \"write\"\n },\n {\n \"projectId\": 17,\n \"objectId\": 50,\n \"objectType\": \"Database::Table\",\n \"fcoType\": \"tables\",\n \"subType\": null,\n \"name\": \"table_name49\",\n \"icon\": \"civicon-table\",\n \"author\": \"dbadmin\",\n \"updatedAt\": \"2025-02-26T17:49:24.000Z\",\n \"autoShare\": null,\n \"archived\": false,\n \"hidden\": false,\n \"myPermissionLevel\": null\n },\n {\n \"projectId\": 17,\n \"objectId\": 5,\n \"objectType\": \"Template::Script\",\n \"fcoType\": \"script_templates\",\n \"subType\": null,\n \"name\": \"awesome sql template\",\n \"icon\": \"civicon-scripts\",\n \"author\": \"User devuserfactory223 223\",\n \"updatedAt\": \"2025-02-26T17:49:26.000Z\",\n \"autoShare\": null,\n \"archived\": false,\n \"hidden\": false,\n \"myPermissionLevel\": \"read\"\n },\n {\n \"projectId\": 17,\n \"objectId\": 211,\n \"objectType\": \"JobTypes::CassNcoa\",\n \"fcoType\": \"enhancements\",\n \"subType\": null,\n \"name\": \"CASS/NCOA #211\",\n \"icon\": \"civicon-enhancements\",\n \"author\": \"User devuserfactory208 208\",\n \"updatedAt\": \"2025-02-26T17:49:26.000Z\",\n \"autoShare\": null,\n \"archived\": false,\n \"hidden\": false,\n \"myPermissionLevel\": \"manage\"\n },\n {\n \"projectId\": 17,\n \"objectId\": 56,\n \"objectType\": \"S3File\",\n \"fcoType\": \"files\",\n \"subType\": null,\n \"name\": \"fake_name\",\n \"icon\": \"civicon-csv\",\n \"author\": \"User devuserfactory208 208\",\n \"updatedAt\": \"2025-02-26T17:49:26.000Z\",\n \"autoShare\": null,\n \"archived\": false,\n \"hidden\": false,\n \"myPermissionLevel\": \"manage\"\n },\n {\n \"projectId\": 17,\n \"objectId\": 9,\n \"objectType\": \"ServiceTypes::App\",\n \"fcoType\": \"services\",\n \"subType\": null,\n \"name\": \"Service #9\",\n \"icon\": \"civicon-dashboard\",\n \"author\": \"User devuserfactory208 208\",\n \"updatedAt\": \"2025-02-26T17:49:26.000Z\",\n \"autoShare\": null,\n \"archived\": false,\n \"hidden\": false,\n \"myPermissionLevel\": \"manage\"\n },\n {\n \"projectId\": 17,\n \"objectId\": 10,\n \"objectType\": \"ServiceTypes::App\",\n \"fcoType\": \"services\",\n \"subType\": null,\n \"name\": \"Service #10\",\n \"icon\": \"civicon-dashboard\",\n \"author\": \"User devuserfactory208 208\",\n \"updatedAt\": \"2025-02-26T17:49:27.000Z\",\n \"autoShare\": null,\n \"archived\": false,\n \"hidden\": false,\n \"myPermissionLevel\": \"manage\"\n },\n {\n \"projectId\": 17,\n \"objectId\": 18,\n \"objectType\": \"Project\",\n \"fcoType\": \"projects\",\n \"subType\": null,\n \"name\": \"Test Project\",\n \"icon\": \"civicon-MuiDriveFolderUploadIcon\",\n \"author\": \"User devuserfactory208 208\",\n \"updatedAt\": \"2025-02-26T17:49:27.000Z\",\n \"autoShare\": false,\n \"archived\": false,\n \"hidden\": false,\n \"myPermissionLevel\": \"manage\"\n }\n ],\n \"note\": null,\n \"canCurrentUserEnableAutoShare\": false,\n \"hidden\": false,\n \"archived\": false,\n \"parentProject\": null,\n \"myPermissionLevel\": \"manage\"\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"66b7c86dd03f2dac0949d89c5aa159e8\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"e50aef83-7208-4dcc-b7a1-8431f4b4c1da","X-Runtime":"0.242145","Content-Length":"7691"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/projects/17\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer lwQL5X9lhKIb6WuzAOL-SJtcGfNumFu-8_clAIfeeWU\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"put":{"summary":"Update a project","description":null,"deprecated":false,"parameters":[{"name":"project_id","in":"path","required":true,"type":"integer"},{"name":"Object453","in":"body","schema":{"$ref":"#/definitions/Object453"},"required":false}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object435"}}},"x-examples":[{"resource":"Projects","resource_explanation":null,"http_method":"PUT","route":"http://api.civis.test/projects/:project_id","description":"Update a project","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"PUT","request_path":"http://api.civis.test/projects/26","request_body":"{\n \"name\": \"newname\",\n \"description\": \"super_cool_description\"\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer icTZKdDSCZ-WLhUxbDlSnPv34Es6HBlagWDGLXwCBME","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 26,\n \"author\": {\n \"id\": 417,\n \"name\": \"User devuserfactory274 274\",\n \"username\": \"devuserfactory274\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"name\": \"newname\",\n \"description\": \"super_cool_description\",\n \"users\": [\n {\n \"id\": 417,\n \"name\": \"User devuserfactory274 274\",\n \"username\": \"devuserfactory274\",\n \"initials\": \"UD\",\n \"online\": null\n }\n ],\n \"autoShare\": false,\n \"createdAt\": \"2025-02-26T17:49:37.000Z\",\n \"updatedAt\": \"2025-02-26T17:49:41.000Z\",\n \"tables\": [\n {\n \"schema\": \"schema_name\",\n \"name\": \"table_name55\",\n \"rowCount\": 1,\n \"columnCount\": 1,\n \"createdAt\": \"2025-02-26T17:49:38.000Z\",\n \"updatedAt\": \"2025-02-26T17:49:38.000Z\"\n }\n ],\n \"surveys\": [\n\n ],\n \"scripts\": [\n {\n \"id\": 243,\n \"createdAt\": \"2025-02-26T17:49:36.000Z\",\n \"updatedAt\": \"2025-02-26T17:49:36.000Z\",\n \"name\": \"Script #243\",\n \"type\": \"JobTypes::SqlRunner\",\n \"finishedAt\": \"2025-02-26T17:49:36.000Z\",\n \"state\": \"running\",\n \"lastRun\": {\n \"state\": \"running\",\n \"updatedAt\": \"2025-02-26T17:49:36.000Z\"\n }\n }\n ],\n \"imports\": [\n {\n \"id\": 254,\n \"createdAt\": \"2025-02-26T17:49:38.000Z\",\n \"updatedAt\": \"2025-02-26T17:49:38.000Z\",\n \"name\": \"Import #254\",\n \"type\": \"JobTypes::Import\",\n \"finishedAt\": null,\n \"state\": \"idle\",\n \"lastRun\": null\n }\n ],\n \"exports\": [\n {\n \"id\": 258,\n \"createdAt\": \"2025-02-26T17:49:39.000Z\",\n \"updatedAt\": \"2025-02-26T17:49:39.000Z\",\n \"name\": \"Export #258\",\n \"type\": \"JobTypes::Import\",\n \"finishedAt\": null,\n \"state\": \"running\",\n \"lastRun\": {\n \"state\": \"running\",\n \"updatedAt\": \"2025-02-26T17:49:39.000Z\"\n }\n }\n ],\n \"models\": [\n {\n \"id\": 250,\n \"createdAt\": \"2025-02-26T17:49:38.000Z\",\n \"updatedAt\": \"2025-02-26T17:49:38.000Z\",\n \"name\": \"Model #250\",\n \"state\": \"idle\"\n }\n ],\n \"notebooks\": [\n {\n \"id\": 14,\n \"createdAt\": \"2025-02-26T17:49:40.000Z\",\n \"updatedAt\": \"2025-02-26T17:49:40.000Z\",\n \"name\": \"Test Notebook\",\n \"currentDeploymentId\": null,\n \"lastDeploy\": null\n },\n {\n \"id\": 15,\n \"createdAt\": \"2025-02-26T17:49:40.000Z\",\n \"updatedAt\": \"2025-02-26T17:49:40.000Z\",\n \"name\": \"Test Notebook\",\n \"currentDeploymentId\": 15,\n \"lastDeploy\": {\n \"state\": \"running\",\n \"updatedAt\": \"2025-02-26T17:49:40.000Z\"\n }\n }\n ],\n \"services\": [\n {\n \"id\": 14,\n \"createdAt\": \"2025-02-26T17:49:40.000Z\",\n \"updatedAt\": \"2025-02-26T17:49:40.000Z\",\n \"name\": \"Service #14\",\n \"currentDeploymentId\": null,\n \"lastDeploy\": null\n },\n {\n \"id\": 15,\n \"createdAt\": \"2025-02-26T17:49:40.000Z\",\n \"updatedAt\": \"2025-02-26T17:49:40.000Z\",\n \"name\": \"Service #15\",\n \"currentDeploymentId\": null,\n \"lastDeploy\": {\n \"state\": \"terminated\",\n \"updatedAt\": \"2025-02-26T17:49:41.000Z\"\n }\n }\n ],\n \"workflows\": [\n {\n \"id\": 8,\n \"createdAt\": \"2025-02-26T17:49:40.000Z\",\n \"updatedAt\": \"2025-02-26T17:49:40.000Z\",\n \"name\": \"Test Workflow\",\n \"state\": \"idle\",\n \"lastExecution\": null\n }\n ],\n \"reports\": [\n {\n \"id\": 24,\n \"createdAt\": \"2025-02-26T17:49:37.000Z\",\n \"updatedAt\": \"2025-02-26T17:49:37.000Z\",\n \"name\": \"Project report\",\n \"state\": \"idle\"\n },\n {\n \"id\": 26,\n \"createdAt\": \"2025-02-26T17:49:37.000Z\",\n \"updatedAt\": \"2025-02-26T17:49:37.000Z\",\n \"name\": \"test_report\",\n \"state\": \"idle\"\n }\n ],\n \"scriptTemplates\": [\n {\n \"id\": 7,\n \"createdAt\": \"2025-02-26T17:49:39.000Z\",\n \"updatedAt\": \"2025-02-26T17:49:39.000Z\",\n \"name\": \"awesome sql template\"\n }\n ],\n \"files\": [\n {\n \"id\": 84,\n \"createdAt\": \"2025-02-26T17:49:39.000Z\",\n \"updatedAt\": \"2025-02-26T17:49:39.000Z\",\n \"fileName\": \"fake_name\",\n \"fileSize\": 1,\n \"expired\": null\n }\n ],\n \"enhancements\": [\n {\n \"id\": 263,\n \"createdAt\": \"2025-02-26T17:49:40.000Z\",\n \"updatedAt\": \"2025-02-26T17:49:40.000Z\",\n \"name\": \"CASS/NCOA #263\",\n \"lastRun\": null\n }\n ],\n \"projects\": [\n {\n \"id\": 27,\n \"createdAt\": \"2025-02-26T17:49:40.000Z\",\n \"updatedAt\": \"2025-02-26T17:49:40.000Z\",\n \"name\": \"Test Project\",\n \"description\": null\n }\n ],\n \"allObjects\": [\n\n ],\n \"note\": null,\n \"canCurrentUserEnableAutoShare\": false,\n \"hidden\": false,\n \"archived\": false,\n \"parentProject\": null,\n \"myPermissionLevel\": \"manage\"\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"6e9fcb340fd531d3802c80744847243b\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"eb8b0755-3740-45b3-ba60-6888e883fb39","X-Runtime":"0.156674","Content-Length":"3336"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/projects/26\" -d '{\"name\":\"newname\",\"description\":\"super_cool_description\"}' -X PUT \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer icTZKdDSCZ-WLhUxbDlSnPv34Es6HBlagWDGLXwCBME\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"delete":{"summary":"Archive a project (deprecated, use the /archive endpoint instead)","description":null,"deprecated":false,"parameters":[{"name":"project_id","in":"path","required":true,"type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":[{"resource":"Projects","resource_explanation":null,"http_method":"DELETE","route":"http://api.civis.test/projects/:project_id","description":"Delete a project (deprecated, now archives the project)","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"DELETE","request_path":"http://api.civis.test/projects/20","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer BmVsOt4cEn9gd8bumHMqAjSoGl7qhowiz2Zas3yKsDo","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":204,"response_status_text":"No Content","response_body":null,"response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"6bd073fe-884f-4b2d-8ddd-dae914e14fbd","X-Runtime":"0.063440"},"response_content_type":null,"curl":"curl \"api.civis.testhttp://api.civis.test/projects/20\" -d '' -X DELETE \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer BmVsOt4cEn9gd8bumHMqAjSoGl7qhowiz2Zas3yKsDo\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/projects/{project_id}/auto_share":{"put":{"summary":"Enable or disable Auto-Share on a project","description":null,"deprecated":false,"parameters":[{"name":"project_id","in":"path","required":true,"type":"integer"},{"name":"Object454","in":"body","schema":{"$ref":"#/definitions/Object454"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object435"}}},"x-examples":null,"x-deprecation-warning":null}},"/projects/{id}/shares":{"get":{"summary":"List users and groups permissioned on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object9"}}}},"x-examples":null,"x-deprecation-warning":null}},"/projects/{id}/shares/users":{"put":{"summary":"Set the permissions users have on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"Object455","in":"body","schema":{"$ref":"#/definitions/Object455"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object9"}}},"x-examples":null,"x-deprecation-warning":null}},"/projects/{id}/shares/users/{user_id}":{"delete":{"summary":"Revoke the permissions a user has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"user_id","in":"path","required":true,"description":"The ID of the user.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/projects/{id}/shares/groups":{"put":{"summary":"Set the permissions groups has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"Object456","in":"body","schema":{"$ref":"#/definitions/Object456"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object9"}}},"x-examples":null,"x-deprecation-warning":null}},"/projects/{id}/shares/groups/{group_id}":{"delete":{"summary":"Revoke the permissions a group has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"group_id","in":"path","required":true,"description":"The ID of the group.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/projects/{id}/dependencies":{"get":{"summary":"List dependent objects for this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"user_id","in":"query","required":false,"description":"ID of target user","type":"integer"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object15"}}}},"x-examples":null,"x-deprecation-warning":null}},"/projects/{id}/transfer":{"put":{"summary":"Transfer ownership of this object to another user","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"Object457","in":"body","schema":{"$ref":"#/definitions/Object457"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object17"}}},"x-examples":null,"x-deprecation-warning":null}},"/projects/{id}/archive":{"put":{"summary":"Update the archive status of this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the object.","type":"integer"},{"name":"Object458","in":"body","schema":{"$ref":"#/definitions/Object458"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object435"}}},"x-examples":null,"x-deprecation-warning":null}},"/projects/{id}/parent_projects":{"get":{"summary":"List the Parent Projects an item belongs to","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the item.","type":"integer"},{"name":"hidden","in":"query","required":false,"description":"If specified to be true, returns hidden items. Defaults to false, returning non-hidden items.","type":"boolean"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object84"}}}},"x-examples":null,"x-deprecation-warning":null}},"/projects/{id}/parent_projects/{parent_project_id}":{"put":{"summary":"Add an item to a Parent Project","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the item.","type":"integer"},{"name":"parent_project_id","in":"path","required":true,"description":"The ID of the Parent Project.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null},"delete":{"summary":"Remove an item from a Parent Project","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the item.","type":"integer"},{"name":"parent_project_id","in":"path","required":true,"description":"The ID of the Parent Project.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/queries/":{"get":{"summary":"List queries","description":null,"deprecated":false,"parameters":[{"name":"query","in":"query","required":false,"description":"Space delimited query for searching queries by their SQL. Supports wild card characters \"?\" for any single character, and \"*\" for zero or more characters.","type":"string"},{"name":"database_id","in":"query","required":false,"description":"The database ID.","type":"integer"},{"name":"credential_id","in":"query","required":false,"description":"The credential ID.","type":"integer"},{"name":"author_id","in":"query","required":false,"description":"The author of the query.","type":"integer"},{"name":"created_before","in":"query","required":false,"description":"An upper bound for the creation date of the query.","type":"string","format":"date-time"},{"name":"created_after","in":"query","required":false,"description":"A lower bound for the creation date of the query.","type":"string","format":"date-time"},{"name":"started_before","in":"query","required":false,"description":"An upper bound for the start date of the last run.","type":"string","format":"date-time"},{"name":"started_after","in":"query","required":false,"description":"A lower bound for the start date of the last run.","type":"string","format":"date-time"},{"name":"state","in":"query","required":false,"description":"The state of the last run. One or more of queued, running, succeeded, failed, and cancelled. Specify multiple values as a comma-separated list (e.g., \"A,B\").","type":"array","items":{"type":"string"}},{"name":"exclude_results","in":"query","required":false,"description":"If true, does not return cached query results.","type":"boolean"},{"name":"hidden","in":"query","required":false,"description":"If specified to be true, returns hidden items. Defaults to false, returning non-hidden items.","type":"boolean"},{"name":"archived","in":"query","required":false,"description":"The archival status of the requested item(s).","type":"string"},{"name":"limit","in":"query","required":false,"description":"Number of results to return. Defaults to 20. Maximum allowed is 50.","type":"integer"},{"name":"page_num","in":"query","required":false,"description":"Page number of the results to return. Defaults to the first page, 1.","type":"integer"},{"name":"order","in":"query","required":false,"description":"The field on which to order the result set. Defaults to created_at. Must be one of: created_at, started_at.","type":"string"},{"name":"order_dir","in":"query","required":false,"description":"Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc.","type":"string"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object459"}}}},"x-examples":[{"resource":"Queries","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/queries","description":"List all queries","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/queries","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer NpofuSAXVl5sn5zxHUZF30MfUPLJFhxz9aZCg7hC3To","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 264,\n \"database\": 177,\n \"sql\": \"SELECT * FROM table LIMIT 10;\",\n \"credential\": 345,\n \"resultRows\": [\n\n ],\n \"resultColumns\": [\n\n ],\n \"error\": null,\n \"startedAt\": null,\n \"finishedAt\": null,\n \"state\": \"idle\",\n \"scriptId\": null,\n \"exception\": null,\n \"createdAt\": \"2025-02-26T17:49:41.000Z\",\n \"updatedAt\": \"2025-02-26T17:49:41.000Z\",\n \"lastRunId\": null,\n \"archived\": false,\n \"previewRows\": 3,\n \"reportId\": null\n },\n {\n \"id\": 265,\n \"database\": 179,\n \"sql\": \"SELECT * FROM table LIMIT 10;\",\n \"credential\": 347,\n \"resultRows\": [\n [\n 1,\n 2\n ],\n [\n 3,\n 4\n ]\n ],\n \"resultColumns\": [\n \"id\",\n \"value\"\n ],\n \"error\": null,\n \"startedAt\": null,\n \"finishedAt\": null,\n \"state\": \"idle\",\n \"scriptId\": null,\n \"exception\": null,\n \"createdAt\": \"2025-02-26T17:49:36.000Z\",\n \"updatedAt\": \"2025-02-26T17:49:41.000Z\",\n \"lastRunId\": null,\n \"archived\": false,\n \"previewRows\": 3,\n \"reportId\": null\n },\n {\n \"id\": 266,\n \"database\": 180,\n \"sql\": \"SELECT * FROM table LIMIT 10;\",\n \"credential\": 349,\n \"resultRows\": [\n\n ],\n \"resultColumns\": [\n\n ],\n \"error\": null,\n \"startedAt\": null,\n \"finishedAt\": null,\n \"state\": \"idle\",\n \"scriptId\": null,\n \"exception\": null,\n \"createdAt\": \"2025-02-26T17:49:26.000Z\",\n \"updatedAt\": \"2025-02-26T17:49:42.000Z\",\n \"lastRunId\": null,\n \"archived\": false,\n \"previewRows\": 3,\n \"reportId\": null\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","X-Pagination-Per-Page":"20","Access-Control-Expose-Headers":"X-Pagination-Per-Page, X-Pagination-Current-Page, X-Pagination-Total-Pages, X-Pagination-Total-Entries","X-Pagination-Current-Page":"1","X-Pagination-Total-Pages":"1","X-Pagination-Total-Entries":"3","Content-Type":"application/json; charset=utf-8","ETag":"W/\"f3ceb22091ff6dc66edfd1fcb338b388\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"9dae5a15-181c-4905-bbb7-00a1c22f3f68","X-Runtime":"0.053374","Content-Length":"1092"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/queries\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer NpofuSAXVl5sn5zxHUZF30MfUPLJFhxz9aZCg7hC3To\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Queries","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/queries","description":"Filter queries by database","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/queries?databaseId=183","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer oHK-Jn7I8Ub-3k6Ka8-a1sM42Z4aX7O611QHZAMmtI0","Host":"api.civis.test","Cookie":""},"request_query_parameters":{"databaseId":"183"},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 268,\n \"database\": 183,\n \"sql\": \"SELECT * FROM table LIMIT 10;\",\n \"credential\": 355,\n \"resultRows\": [\n [\n 1,\n 2\n ],\n [\n 3,\n 4\n ]\n ],\n \"resultColumns\": [\n \"id\",\n \"value\"\n ],\n \"error\": null,\n \"startedAt\": null,\n \"finishedAt\": null,\n \"state\": \"idle\",\n \"scriptId\": null,\n \"exception\": null,\n \"createdAt\": \"2025-02-26T17:49:37.000Z\",\n \"updatedAt\": \"2025-02-26T17:49:42.000Z\",\n \"lastRunId\": null,\n \"archived\": false,\n \"previewRows\": 3,\n \"reportId\": null\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","X-Pagination-Per-Page":"20","Access-Control-Expose-Headers":"X-Pagination-Per-Page, X-Pagination-Current-Page, X-Pagination-Total-Pages, X-Pagination-Total-Entries","X-Pagination-Current-Page":"1","X-Pagination-Total-Pages":"1","X-Pagination-Total-Entries":"1","Content-Type":"application/json; charset=utf-8","ETag":"W/\"35743446ad5362da947b1c0bbf28fb9a\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"995a41c9-25ac-4ca5-9577-ce6a0ac44795","X-Runtime":"0.045185","Content-Length":"380"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/queries?databaseId=183\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer oHK-Jn7I8Ub-3k6Ka8-a1sM42Z4aX7O611QHZAMmtI0\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Queries","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/queries","description":"Filter queries by author","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/queries?authorId=462","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer Hlt0myMagt1Xo9pvkC4ZPESq8yVArJsQieilI3B0eVI","Host":"api.civis.test","Cookie":""},"request_query_parameters":{"authorId":"462"},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 270,\n \"database\": 186,\n \"sql\": \"SELECT * FROM table LIMIT 10;\",\n \"credential\": 361,\n \"resultRows\": [\n\n ],\n \"resultColumns\": [\n\n ],\n \"error\": null,\n \"startedAt\": null,\n \"finishedAt\": null,\n \"state\": \"idle\",\n \"scriptId\": null,\n \"exception\": null,\n \"createdAt\": \"2025-02-26T17:49:28.000Z\",\n \"updatedAt\": \"2025-02-26T17:49:43.000Z\",\n \"lastRunId\": null,\n \"archived\": false,\n \"previewRows\": 3,\n \"reportId\": null\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","X-Pagination-Per-Page":"20","Access-Control-Expose-Headers":"X-Pagination-Per-Page, X-Pagination-Current-Page, X-Pagination-Total-Pages, X-Pagination-Total-Entries","X-Pagination-Current-Page":"1","X-Pagination-Total-Pages":"1","X-Pagination-Total-Entries":"1","Content-Type":"application/json; charset=utf-8","ETag":"W/\"208f5b404523b41cfb80788944faa299\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"0ea81dae-528b-4110-a2f7-40dcffa18507","X-Runtime":"0.039853","Content-Length":"357"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/queries?authorId=462\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer Hlt0myMagt1Xo9pvkC4ZPESq8yVArJsQieilI3B0eVI\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Queries","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/queries","description":"Filter queries by creation date","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/queries?createdBefore=2025-02-26T17%3A49%3A43.000Z&createdAfter=2025-02-26T17%3A49%3A28.000Z","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer VWMfOjtbNLA9PUlix4G4nqZJV2iofHGh1K-eZvaW0LY","Host":"api.civis.test","Cookie":""},"request_query_parameters":{"createdBefore":"2025-02-26T17:49:43.000Z","createdAfter":"2025-02-26T17:49:28.000Z"},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 273,\n \"database\": 190,\n \"sql\": \"SELECT * FROM table LIMIT 10;\",\n \"credential\": 369,\n \"resultRows\": [\n [\n 1,\n 2\n ],\n [\n 3,\n 4\n ]\n ],\n \"resultColumns\": [\n \"id\",\n \"value\"\n ],\n \"error\": null,\n \"startedAt\": null,\n \"finishedAt\": null,\n \"state\": \"idle\",\n \"scriptId\": null,\n \"exception\": null,\n \"createdAt\": \"2025-02-26T17:49:38.000Z\",\n \"updatedAt\": \"2025-02-26T17:49:44.000Z\",\n \"lastRunId\": null,\n \"archived\": false,\n \"previewRows\": 3,\n \"reportId\": null\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","X-Pagination-Per-Page":"20","Access-Control-Expose-Headers":"X-Pagination-Per-Page, X-Pagination-Current-Page, X-Pagination-Total-Pages, X-Pagination-Total-Entries","X-Pagination-Current-Page":"1","X-Pagination-Total-Pages":"1","X-Pagination-Total-Entries":"1","Content-Type":"application/json; charset=utf-8","ETag":"W/\"c5a179834dfdaabeab6795731c8f1b6e\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"5b7c4276-73c4-4650-afb8-5a5df9b64013","X-Runtime":"0.041492","Content-Length":"380"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/queries?createdBefore=2025-02-26T17%3A49%3A43.000Z&createdAfter=2025-02-26T17%3A49%3A28.000Z\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer VWMfOjtbNLA9PUlix4G4nqZJV2iofHGh1K-eZvaW0LY\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Queries","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/queries","description":"Includes rows/cols from response normally","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/queries","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer H15SoLQ0Ox3zyRsi_hubSanSwJGHTztN2XEA3O7j9qg","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 274,\n \"database\": 192,\n \"sql\": \"SELECT * FROM table LIMIT 10;\",\n \"credential\": 372,\n \"resultRows\": [\n [\n 1,\n 2\n ],\n [\n 3,\n 4\n ]\n ],\n \"resultColumns\": [\n \"id\",\n \"value\"\n ],\n \"error\": null,\n \"startedAt\": null,\n \"finishedAt\": null,\n \"state\": \"idle\",\n \"scriptId\": null,\n \"exception\": null,\n \"createdAt\": \"2025-02-26T17:49:39.000Z\",\n \"updatedAt\": \"2025-02-26T17:49:44.000Z\",\n \"lastRunId\": null,\n \"archived\": false,\n \"previewRows\": 3,\n \"reportId\": null\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","X-Pagination-Per-Page":"20","Access-Control-Expose-Headers":"X-Pagination-Per-Page, X-Pagination-Current-Page, X-Pagination-Total-Pages, X-Pagination-Total-Entries","X-Pagination-Current-Page":"1","X-Pagination-Total-Pages":"1","X-Pagination-Total-Entries":"1","Content-Type":"application/json; charset=utf-8","ETag":"W/\"183303195534bc82fd119afa260f541c\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"5131fb3c-79bc-4710-929b-9926c84bedfa","X-Runtime":"0.039571","Content-Length":"380"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/queries\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer H15SoLQ0Ox3zyRsi_hubSanSwJGHTztN2XEA3O7j9qg\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Queries","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/queries","description":"Exclude rows/cols from response with excludeResults=true","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/queries?excludeResults=true","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer HaUkk6hj63obNDO6DOItYN_d4MOxGwHDLBzm_ux_c4k","Host":"api.civis.test","Cookie":""},"request_query_parameters":{"excludeResults":"true"},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 275,\n \"database\": 194,\n \"sql\": \"SELECT * FROM table LIMIT 10;\",\n \"credential\": 375,\n \"resultRows\": [\n\n ],\n \"resultColumns\": [\n\n ],\n \"error\": null,\n \"startedAt\": null,\n \"finishedAt\": null,\n \"state\": \"idle\",\n \"scriptId\": null,\n \"exception\": null,\n \"createdAt\": \"2025-02-26T17:49:40.000Z\",\n \"updatedAt\": \"2025-02-26T17:49:45.000Z\",\n \"lastRunId\": null,\n \"archived\": false,\n \"previewRows\": 3,\n \"reportId\": null\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","X-Pagination-Per-Page":"20","Access-Control-Expose-Headers":"X-Pagination-Per-Page, X-Pagination-Current-Page, X-Pagination-Total-Pages, X-Pagination-Total-Entries","X-Pagination-Current-Page":"1","X-Pagination-Total-Pages":"1","X-Pagination-Total-Entries":"1","Content-Type":"application/json; charset=utf-8","ETag":"W/\"384bca1d8e6755fdd6be9c06dba0f294\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"1f8e9b2a-99b6-45bb-b4da-9aa75a823455","X-Runtime":"0.063933","Content-Length":"357"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/queries?excludeResults=true\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer HaUkk6hj63obNDO6DOItYN_d4MOxGwHDLBzm_ux_c4k\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Queries","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/queries","description":"Lists searched queries","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/queries?query=LIMIT","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer YdE0zuCp3S7kfZqgBtpo1JCJ4TJmsQwasCU64m-1HRU","Host":"api.civis.test","Cookie":""},"request_query_parameters":{"query":"LIMIT"},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 276,\n \"database\": 195,\n \"sql\": \"SELECT * FROM table LIMIT 10;\",\n \"credential\": 379,\n \"resultRows\": [\n\n ],\n \"resultColumns\": [\n\n ],\n \"error\": null,\n \"startedAt\": \"2025-02-26T17:49:45.000Z\",\n \"finishedAt\": null,\n \"state\": \"succeeded\",\n \"scriptId\": null,\n \"exception\": null,\n \"createdAt\": \"2025-02-26T17:49:45.000Z\",\n \"updatedAt\": \"2025-02-26T17:49:45.000Z\",\n \"lastRunId\": 62,\n \"archived\": false,\n \"previewRows\": 3,\n \"reportId\": null\n },\n {\n \"id\": 277,\n \"database\": 197,\n \"sql\": \"SELECT * FROM table LIMIT 10;\",\n \"credential\": 381,\n \"resultRows\": [\n\n ],\n \"resultColumns\": [\n\n ],\n \"error\": null,\n \"startedAt\": \"2025-02-26T17:49:40.000Z\",\n \"finishedAt\": null,\n \"state\": \"cancelled\",\n \"scriptId\": null,\n \"exception\": null,\n \"createdAt\": \"2025-02-26T17:49:30.000Z\",\n \"updatedAt\": \"2025-02-26T17:49:46.000Z\",\n \"lastRunId\": 63,\n \"archived\": false,\n \"previewRows\": 3,\n \"reportId\": null\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","X-Pagination-Current-Page":"1","Access-Control-Expose-Headers":"X-Pagination-Current-Page, X-Pagination-Total-Entries, X-Pagination-Total-Pages, X-Pagination-Per-Page","X-Pagination-Total-Entries":"2","X-Pagination-Total-Pages":"1","X-Pagination-Per-Page":"20","Content-Type":"application/json; charset=utf-8","ETag":"W/\"9ebd67e1f98ae1a4908c11a009dd2332\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"d1f02b9e-869b-4527-bb21-c4d94bd27ad9","X-Runtime":"0.162709","Content-Length":"763"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/queries?query=LIMIT\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer YdE0zuCp3S7kfZqgBtpo1JCJ4TJmsQwasCU64m-1HRU\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"post":{"summary":"Execute a query","description":null,"deprecated":false,"parameters":[{"name":"Object461","in":"body","schema":{"$ref":"#/definitions/Object461"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object462"}}},"x-examples":[{"resource":"Queries","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/queries","description":"Submit a query","explanation":null,"parameters":[{"required":true,"name":"database","description":"The database ID."},{"required":true,"name":"sql","description":"The SQL to execute."},{"required":false,"name":"credential","description":"The credential ID."},{"required":false,"name":"hidden","description":"The hidden status of the item."},{"required":false,"name":"interactive","description":"Deprecated and not used."},{"required":true,"name":"previewRows","description":"The number of rows to save from the query's result (maximum: 1000)."},{"required":false,"name":"includeHeader","description":"Whether the CSV output should include a header row [default: true]."},{"required":false,"name":"compression","description":"The type of compression. One of gzip or zip, or none [default: gzip]."},{"required":false,"name":"columnDelimiter","description":"The delimiter to use. One of comma or tab, or pipe [default: comma]."},{"required":false,"name":"unquoted","description":"If true, will not quote fields."},{"required":false,"name":"filenamePrefix","description":"The output filename prefix."}],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/queries","request_body":"{\n \"sql\": \"SELECT 1\",\n \"credential\": 383,\n \"database\": 198,\n \"previewRows\": 10\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer Xr1IojIS1drNfLJK_cqCb13hzvg4dCnDmlcMPRQbyaQ","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 278,\n \"database\": 198,\n \"sql\": \"SELECT 1\",\n \"credential\": 383,\n \"resultRows\": [\n\n ],\n \"resultColumns\": [\n\n ],\n \"error\": null,\n \"startedAt\": null,\n \"finishedAt\": null,\n \"state\": \"queued\",\n \"scriptId\": null,\n \"exception\": null,\n \"createdAt\": \"2025-02-26T17:49:46.000Z\",\n \"updatedAt\": \"2025-02-26T17:49:46.000Z\",\n \"lastRunId\": 64,\n \"hidden\": false,\n \"archived\": false,\n \"myPermissionLevel\": \"manage\",\n \"interactive\": false,\n \"previewRows\": 10,\n \"includeHeader\": true,\n \"compression\": \"gzip\",\n \"columnDelimiter\": \"comma\",\n \"unquoted\": null,\n \"filenamePrefix\": null,\n \"reportId\": null\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"6c261a1aa0d7aab976952220f5336d6a\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"4ad44eed-0d4a-43e8-b8a7-926eebe7e5f6","X-Runtime":"0.319027","Content-Length":"505"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/queries\" -d '{\"sql\":\"SELECT 1\",\"credential\":383,\"database\":198,\"previewRows\":10}' -X POST \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer Xr1IojIS1drNfLJK_cqCb13hzvg4dCnDmlcMPRQbyaQ\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Queries","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/queries","description":"Specifying optional parameters","explanation":null,"parameters":[{"required":true,"name":"database","description":"The database ID."},{"required":true,"name":"sql","description":"The SQL to execute."},{"required":false,"name":"credential","description":"The credential ID."},{"required":false,"name":"hidden","description":"The hidden status of the item."},{"required":false,"name":"interactive","description":"Deprecated and not used."},{"required":true,"name":"previewRows","description":"The number of rows to save from the query's result (maximum: 1000)."},{"required":false,"name":"includeHeader","description":"Whether the CSV output should include a header row [default: true]."},{"required":false,"name":"compression","description":"The type of compression. One of gzip or zip, or none [default: gzip]."},{"required":false,"name":"columnDelimiter","description":"The delimiter to use. One of comma or tab, or pipe [default: comma]."},{"required":false,"name":"unquoted","description":"If true, will not quote fields."},{"required":false,"name":"filenamePrefix","description":"The output filename prefix."}],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/queries","request_body":"{\n \"sql\": \"SELECT 1\",\n \"credential\": 385,\n \"database\": 199,\n \"preview_rows\": 12,\n \"include_header\": false,\n \"compression\": \"none\",\n \"column_delimiter\": \"tab\",\n \"unquoted\": true,\n \"filename_prefix\": \"pfx\"\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer gYFazXvgVPB0GCjFcckaDQ3ppGeFjXCJOymJjUTYdRI","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 279,\n \"database\": 199,\n \"sql\": \"SELECT 1\",\n \"credential\": 385,\n \"resultRows\": [\n\n ],\n \"resultColumns\": [\n\n ],\n \"error\": null,\n \"startedAt\": null,\n \"finishedAt\": null,\n \"state\": \"queued\",\n \"scriptId\": null,\n \"exception\": null,\n \"createdAt\": \"2025-02-26T17:49:47.000Z\",\n \"updatedAt\": \"2025-02-26T17:49:47.000Z\",\n \"lastRunId\": 65,\n \"hidden\": false,\n \"archived\": false,\n \"myPermissionLevel\": \"manage\",\n \"interactive\": false,\n \"previewRows\": 12,\n \"includeHeader\": false,\n \"compression\": \"none\",\n \"columnDelimiter\": \"tab\",\n \"unquoted\": true,\n \"filenamePrefix\": \"pfx\",\n \"reportId\": null\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"be38ee81ebd914dcc0da8c28559a1af5\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"759abb9d-eb14-4148-be60-7623eb558735","X-Runtime":"0.304038","Content-Length":"505"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/queries\" -d '{\"sql\":\"SELECT 1\",\"credential\":385,\"database\":199,\"preview_rows\":12,\"include_header\":false,\"compression\":\"none\",\"column_delimiter\":\"tab\",\"unquoted\":true,\"filename_prefix\":\"pfx\"}' -X POST \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer gYFazXvgVPB0GCjFcckaDQ3ppGeFjXCJOymJjUTYdRI\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/queries/{id}/runs":{"post":{"summary":"Start a run","description":"Start a run and provide a URI for checking its status. The response will provide a 'Location' header which will contain a URI which may be polled to monitor the status of the run.","deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Query job.","type":"integer"}],"responses":{"202":{"description":"success","schema":{"$ref":"#/definitions/Object460"}}},"x-examples":null,"x-deprecation-warning":null},"get":{"summary":"List runs for the given Query job","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Query job.","type":"integer"},{"name":"limit","in":"query","required":false,"description":"Number of results to return. Defaults to 20. Maximum allowed is 100.","type":"integer"},{"name":"page_num","in":"query","required":false,"description":"Page number of the results to return. Defaults to the first page, 1.","type":"integer"},{"name":"order","in":"query","required":false,"description":"The field on which to order the result set. Defaults to id. Must be one of: id.","type":"string"},{"name":"order_dir","in":"query","required":false,"description":"Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc.","type":"string"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object460"}}}},"x-examples":null,"x-deprecation-warning":null}},"/queries/{id}/runs/{run_id}":{"get":{"summary":"Check status of a run","description":"View the status of a run. This endpoint may be polled to monitor the status of the run. When the 'state' field is no longer 'queued' or 'running' the run has reached its final state.","deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Query job.","type":"integer"},{"name":"run_id","in":"path","required":true,"description":"The ID of the run.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object460"}}},"x-examples":null,"x-deprecation-warning":null},"delete":{"summary":"Cancel a run","description":"Cancel a currently active run.","deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Query job.","type":"integer"},{"name":"run_id","in":"path","required":true,"description":"The ID of the run.","type":"integer"}],"responses":{"202":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/queries/{id}/runs/{run_id}/logs":{"get":{"summary":"Get the logs for a run","description":"Get the logs for a run.","deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Query job.","type":"integer"},{"name":"run_id","in":"path","required":true,"description":"The ID of the run.","type":"integer"},{"name":"last_id","in":"query","required":false,"description":"The ID of the last log message received. Log entries with this ID value or lower will be omitted.Logs are sorted by ID if this value is provided, and are otherwise sorted by createdAt.","type":"integer"},{"name":"limit","in":"query","required":false,"description":"The maximum number of log messages to return. Default of 10000.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object116"}}}},"x-examples":null,"x-deprecation-warning":null}},"/queries/{id}/scripts/{script_id}":{"put":{"summary":"Update the query's associated script","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The query ID.","type":"integer"},{"name":"script_id","in":"path","required":true,"description":"The ID of the script associated with this query.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object463"}}},"x-examples":[{"resource":"Queries","resource_explanation":null,"http_method":"PUT","route":"http://api.civis.test/queries/:id/scripts/:script_id","description":"Update a query","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"PUT","request_path":"http://api.civis.test/queries/283/scripts/73","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer 5qvMuZOQpCdulGUtS1V4ExOgz_zkZqNTxgJMRouuPBY","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 283,\n \"database\": 204,\n \"sql\": \"SELECT * FROM table LIMIT 10;\",\n \"credential\": 394,\n \"resultRows\": [\n [\n 1,\n 2\n ],\n [\n 3,\n 4\n ]\n ],\n \"resultColumns\": [\n \"id\",\n \"value\"\n ],\n \"error\": null,\n \"startedAt\": null,\n \"finishedAt\": null,\n \"state\": \"idle\",\n \"scriptId\": 73,\n \"exception\": null,\n \"createdAt\": \"2025-02-26T17:49:43.000Z\",\n \"updatedAt\": \"2025-02-26T17:49:48.000Z\",\n \"lastRunId\": null,\n \"hidden\": false,\n \"archived\": false,\n \"name\": \"Query #283\",\n \"author\": {\n \"id\": 490,\n \"name\": \"User devuserfactory327 327\",\n \"username\": \"devuserfactory327\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"reportId\": null\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"696b4086b098e0eb383b3522bd501b09\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"0ab942b5-c8a2-45ff-8bf9-6ba03a42b078","X-Runtime":"0.090569","Content-Length":"512"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/queries/283/scripts/73\" -d '' -X PUT \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer 5qvMuZOQpCdulGUtS1V4ExOgz_zkZqNTxgJMRouuPBY\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/queries/{id}":{"get":{"summary":"Get details about a query","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The query ID.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object463"}}},"x-examples":[{"resource":"Queries","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/queries/:id","description":"View a query","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/queries/280","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer meveRdr09vYisSLuYOlmk_iW0F54UiLO3-QKpO5KjF0","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 280,\n \"database\": 201,\n \"sql\": \"SELECT * FROM table LIMIT 10;\",\n \"credential\": 388,\n \"resultRows\": [\n [\n 1,\n 2\n ],\n [\n 3,\n 4\n ]\n ],\n \"resultColumns\": [\n \"id\",\n \"value\"\n ],\n \"error\": null,\n \"startedAt\": \"2015-01-01T01:01:01.000Z\",\n \"finishedAt\": \"2012-02-02T02:02:02.000Z\",\n \"state\": \"running\",\n \"scriptId\": null,\n \"exception\": null,\n \"createdAt\": \"2025-02-26T17:49:42.000Z\",\n \"updatedAt\": \"2025-02-26T17:49:47.000Z\",\n \"lastRunId\": 66,\n \"hidden\": false,\n \"archived\": false,\n \"name\": \"Query #280\",\n \"author\": {\n \"id\": 485,\n \"name\": \"User devuserfactory323 323\",\n \"username\": \"devuserfactory323\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"reportId\": null\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"7685b36e43c073d28fbeae3f9bebe209\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"8db5ea08-6a69-48fd-a180-9f1b42750b19","X-Runtime":"0.042164","Content-Length":"559"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/queries/280\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer meveRdr09vYisSLuYOlmk_iW0F54UiLO3-QKpO5KjF0\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"delete":{"summary":"Sets Query Hidden to true","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The query ID.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object463"}}},"x-examples":null,"x-deprecation-warning":null}},"/remote_hosts/":{"get":{"summary":"List Remote Hosts","description":null,"deprecated":false,"parameters":[{"name":"type","in":"query","required":false,"description":"The type of remote host. One of: RemoteHostTypes::Bigquery, RemoteHostTypes::Bitbucket, RemoteHostTypes::GitSSH, RemoteHostTypes::Github, RemoteHostTypes::GoogleDoc, RemoteHostTypes::JDBC, RemoteHostTypes::Postgres, RemoteHostTypes::Redshift, RemoteHostTypes::S3Storage, and RemoteHostTypes::Salesforce","type":"string"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object464"}}}},"x-examples":[{"resource":"RemoteHosts","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/remote_hosts","description":"List all remote hosts","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/remote_hosts","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer e4Ocdc7yY2YTow1p9IblBHzIYTTzfkvGgv7moeTlrO4","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 1,\n \"name\": \"Github API Connection\",\n \"type\": \"RemoteHostTypes::Github\",\n \"url\": \"http://www.github.com\"\n },\n {\n \"id\": 2,\n \"name\": \"Bitbucket API Connection\",\n \"type\": \"RemoteHostTypes::Bitbucket\",\n \"url\": \"http://www.bitbucket.org\"\n },\n {\n \"id\": 3,\n \"name\": \"Google\",\n \"type\": \"RemoteHostTypes::GoogleDoc\",\n \"url\": \"http://www.google.com\"\n },\n {\n \"id\": 206,\n \"name\": \"JDBC Remote Host\",\n \"type\": \"RemoteHostTypes::JDBC\",\n \"url\": \"jdbc:redshift://address/db\"\n },\n {\n \"id\": 207,\n \"name\": \"redshift-10194\",\n \"type\": \"RemoteHostTypes::Redshift\",\n \"url\": \"jdbc:redshift://localhost.civis.io/db\"\n },\n {\n \"id\": 208,\n \"name\": \"prod salesforce 10000\",\n \"type\": \"RemoteHostTypes::Salesforce\",\n \"url\": \"https://login.salesforce.com\"\n },\n {\n \"id\": 210,\n \"name\": \"S3Storage\",\n \"type\": \"RemoteHostTypes::S3Storage\",\n \"url\": \"https://mybucket.s3.amazonaws.com\"\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"dea6c7b11d58fb723e3828819b0e5636\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"5fee878d-8a8e-4e25-8aaf-4685dfaee509","X-Runtime":"0.080915","Content-Length":"750"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/remote_hosts\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer e4Ocdc7yY2YTow1p9IblBHzIYTTzfkvGgv7moeTlrO4\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"RemoteHosts","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/remote_hosts","description":"List all remote hosts","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/remote_hosts","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer MVfGrIKjHkpeLCepBl8XzLm3Y4qOhvtlx30SJx9ZrRE","Accept":"application/vnd.civis-platform.v2","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 1,\n \"name\": \"Github API Connection\",\n \"type\": \"RemoteHostTypes::Github\",\n \"url\": \"http://www.github.com\"\n },\n {\n \"id\": 2,\n \"name\": \"Bitbucket API Connection\",\n \"type\": \"RemoteHostTypes::Bitbucket\",\n \"url\": \"http://www.bitbucket.org\"\n },\n {\n \"id\": 3,\n \"name\": \"Google\",\n \"type\": \"RemoteHostTypes::GoogleDoc\",\n \"url\": \"http://www.google.com\"\n },\n {\n \"id\": 211,\n \"name\": \"JDBC Remote Host\",\n \"type\": \"RemoteHostTypes::JDBC\",\n \"url\": \"jdbc:redshift://address/db\"\n },\n {\n \"id\": 212,\n \"name\": \"redshift-10196\",\n \"type\": \"RemoteHostTypes::Redshift\",\n \"url\": \"jdbc:redshift://localhost.civis.io/db\"\n },\n {\n \"id\": 213,\n \"name\": \"prod salesforce 10001\",\n \"type\": \"RemoteHostTypes::Salesforce\",\n \"url\": \"https://login.salesforce.com\"\n },\n {\n \"id\": 215,\n \"name\": \"S3Storage\",\n \"type\": \"RemoteHostTypes::S3Storage\",\n \"url\": \"https://mybucket.s3.amazonaws.com\"\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"bc6a73301f2fae0b9ae09a59f43eb332\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"b2c4369a-1eda-49ca-8cb5-893bea22721e","X-Runtime":"0.077788","Content-Length":"750"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/remote_hosts\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer MVfGrIKjHkpeLCepBl8XzLm3Y4qOhvtlx30SJx9ZrRE\" \\\n\t-H \"Accept: application/vnd.civis-platform.v2\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"RemoteHosts","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/remote_hosts","description":"List all remote hosts for a user","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/remote_hosts","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer -mJhBgoIyNpnH5K_lFJ2nU9lPTynSNk0rZs4UBQGrmQ","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 1,\n \"name\": \"Github API Connection\",\n \"type\": \"RemoteHostTypes::Github\",\n \"url\": \"http://www.github.com\"\n },\n {\n \"id\": 2,\n \"name\": \"Bitbucket API Connection\",\n \"type\": \"RemoteHostTypes::Bitbucket\",\n \"url\": \"http://www.bitbucket.org\"\n },\n {\n \"id\": 3,\n \"name\": \"Google\",\n \"type\": \"RemoteHostTypes::GoogleDoc\",\n \"url\": \"http://www.google.com\"\n },\n {\n \"id\": 216,\n \"name\": \"JDBC Remote Host\",\n \"type\": \"RemoteHostTypes::JDBC\",\n \"url\": \"jdbc:redshift://address/db\"\n },\n {\n \"id\": 217,\n \"name\": \"redshift-10198\",\n \"type\": \"RemoteHostTypes::Redshift\",\n \"url\": \"jdbc:redshift://localhost.civis.io/db\"\n },\n {\n \"id\": 218,\n \"name\": \"prod salesforce 10002\",\n \"type\": \"RemoteHostTypes::Salesforce\",\n \"url\": \"https://login.salesforce.com\"\n },\n {\n \"id\": 220,\n \"name\": \"S3Storage\",\n \"type\": \"RemoteHostTypes::S3Storage\",\n \"url\": \"https://mybucket.s3.amazonaws.com\"\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"071ff19d257011545f8f9190353f70dd\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"c751f02e-5bbe-4556-9558-c2fa7bd3a8a0","X-Runtime":"0.067661","Content-Length":"750"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/remote_hosts\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer -mJhBgoIyNpnH5K_lFJ2nU9lPTynSNk0rZs4UBQGrmQ\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"post":{"summary":"Create a Remote Host","description":null,"deprecated":false,"parameters":[{"name":"Object465","in":"body","schema":{"$ref":"#/definitions/Object465"},"required":true}],"responses":{"201":{"description":"success","schema":{"$ref":"#/definitions/Object466"}}},"x-examples":[{"resource":"RemoteHosts","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/remote_hosts","description":"Create a Remote Host","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/remote_hosts","request_body":"{\n \"name\": \"My Remote Host\",\n \"url\": \"jdbc:mysql://address/db\",\n \"type\": \"RemoteHostTypes::JDBC\"\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer 7G8DeMGR4tLBw-MbwZtCyLHqIyknEn86BmhSaqkf85o","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":201,"response_status_text":"Created","response_body":"{\n \"id\": 226,\n \"name\": \"My Remote Host\",\n \"type\": \"RemoteHostTypes::JDBC\",\n \"url\": \"jdbc:mysql://address/db\",\n \"description\": null,\n \"myPermissionLevel\": \"manage\",\n \"user\": {\n \"id\": 499,\n \"name\": \"User devuserfactory333 333\",\n \"username\": \"devuserfactory333\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"createdAt\": \"2025-02-26T17:49:50.000Z\",\n \"updatedAt\": \"2025-02-26T17:49:50.000Z\"\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"3c84672274a57ebc2ac1a233a73073a0\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"aee60e8c-fcd1-4995-a390-86690065d221","X-Runtime":"0.062086","Content-Length":"338"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/remote_hosts\" -d '{\"name\":\"My Remote Host\",\"url\":\"jdbc:mysql://address/db\",\"type\":\"RemoteHostTypes::JDBC\"}' -X POST \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer 7G8DeMGR4tLBw-MbwZtCyLHqIyknEn86BmhSaqkf85o\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/remote_hosts/{id}":{"get":{"summary":"Get a Remote Host","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object466"}}},"x-examples":[{"resource":"RemoteHosts","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/remote_hosts/:id","description":"View a Remote Host's details","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/remote_hosts/227","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer 4eKSCTVf_H-AueFFogIlIEcSdEc_MRCrWGhWJK3zius","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 227,\n \"name\": \"JDBC Remote Host\",\n \"type\": \"RemoteHostTypes::JDBC\",\n \"url\": \"jdbc:redshift://address/db\",\n \"description\": null,\n \"myPermissionLevel\": \"manage\",\n \"user\": {\n \"id\": 501,\n \"name\": \"User devuserfactory334 334\",\n \"username\": \"devuserfactory334\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"createdAt\": \"2025-02-26T17:49:50.000Z\",\n \"updatedAt\": \"2025-02-26T17:49:50.000Z\"\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"c5c84a0c27b74b2010a423a66cc3c750\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"62069a1b-bb53-43b6-88c1-7384d374787b","X-Runtime":"0.031301","Content-Length":"343"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/remote_hosts/227\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer 4eKSCTVf_H-AueFFogIlIEcSdEc_MRCrWGhWJK3zius\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"put":{"summary":"Replace all attributes of this Remote Host","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the remote host.","type":"integer"},{"name":"Object467","in":"body","schema":{"$ref":"#/definitions/Object467"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object466"}}},"x-examples":[{"resource":"RemoteHosts","resource_explanation":null,"http_method":"PUT","route":"http://api.civis.test/remote_hosts/:id","description":"Replace all attributes of a Remote Host","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"PUT","request_path":"http://api.civis.test/remote_hosts/237","request_body":"{\n \"name\": \"New Name\",\n \"type\": \"RemoteHostTypes::JDBC\",\n \"url\": \"jdbc:redshift://new-address/db\",\n \"description\": \"New description\"\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer jqIOZCkoxtVjXmp4ZcxKhZUFvmsdcA6RsXpFB-Srvlk","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 237,\n \"name\": \"New Name\",\n \"type\": \"RemoteHostTypes::JDBC\",\n \"url\": \"jdbc:redshift://new-address/db\",\n \"description\": \"New description\",\n \"myPermissionLevel\": \"manage\",\n \"user\": {\n \"id\": 505,\n \"name\": \"User devuserfactory336 336\",\n \"username\": \"devuserfactory336\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"createdAt\": \"2025-02-26T17:49:51.000Z\",\n \"updatedAt\": \"2025-02-26T17:49:51.000Z\"\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"23902bf09e14cd53d455433a4727cd57\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"e3c80f1d-587d-4761-b452-daa6829a2149","X-Runtime":"0.050333","Content-Length":"352"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/remote_hosts/237\" -d '{\"name\":\"New Name\",\"type\":\"RemoteHostTypes::JDBC\",\"url\":\"jdbc:redshift://new-address/db\",\"description\":\"New description\"}' -X PUT \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer jqIOZCkoxtVjXmp4ZcxKhZUFvmsdcA6RsXpFB-Srvlk\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"patch":{"summary":"Update some attributes of this Remote Host","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the remote host.","type":"integer"},{"name":"Object468","in":"body","schema":{"$ref":"#/definitions/Object468"},"required":false}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object466"}}},"x-examples":[{"resource":"RemoteHosts","resource_explanation":null,"http_method":"PATCH","route":"http://api.civis.test/remote_hosts/:id","description":"Update a Remote Host","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"PATCH","request_path":"http://api.civis.test/remote_hosts/232","request_body":"{\n \"name\": \"New Name\"\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer AjwctydRoYoo9Rt-F3T7-VITPyEHX6D8fcTgdmmsqa8","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 232,\n \"name\": \"New Name\",\n \"type\": \"RemoteHostTypes::JDBC\",\n \"url\": \"jdbc:redshift://address/db\",\n \"description\": null,\n \"myPermissionLevel\": \"manage\",\n \"user\": {\n \"id\": 503,\n \"name\": \"User devuserfactory335 335\",\n \"username\": \"devuserfactory335\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"createdAt\": \"2025-02-26T17:49:50.000Z\",\n \"updatedAt\": \"2025-02-26T17:49:51.000Z\"\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"7de13fbc73a35615cfd77c2cbcf999d9\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"9b8ca87e-3b12-404d-9ec6-ab82b183c6a6","X-Runtime":"0.056349","Content-Length":"335"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/remote_hosts/232\" -d '{\"name\":\"New Name\"}' -X PATCH \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer AjwctydRoYoo9Rt-F3T7-VITPyEHX6D8fcTgdmmsqa8\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/remote_hosts/{id}/shares":{"get":{"summary":"List users and groups permissioned on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object9"}}}},"x-examples":null,"x-deprecation-warning":null}},"/remote_hosts/{id}/shares/users":{"put":{"summary":"Set the permissions users have on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"Object469","in":"body","schema":{"$ref":"#/definitions/Object469"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object9"}}},"x-examples":null,"x-deprecation-warning":null}},"/remote_hosts/{id}/shares/users/{user_id}":{"delete":{"summary":"Revoke the permissions a user has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"user_id","in":"path","required":true,"description":"The ID of the user.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/remote_hosts/{id}/shares/groups":{"put":{"summary":"Set the permissions groups has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"Object470","in":"body","schema":{"$ref":"#/definitions/Object470"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object9"}}},"x-examples":null,"x-deprecation-warning":null}},"/remote_hosts/{id}/shares/groups/{group_id}":{"delete":{"summary":"Revoke the permissions a group has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"group_id","in":"path","required":true,"description":"The ID of the group.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/remote_hosts/{id}/authenticate":{"post":{"summary":"Authenticate against a remote host using either a credential or a user name and password","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the remote host.","type":"integer"},{"name":"Object471","in":"body","schema":{"$ref":"#/definitions/Object471"},"required":false}],"responses":{"204":{"description":"success"}},"x-examples":[{"resource":"RemoteHosts","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/remote_hosts/:id/authenticate","description":"Authenticate against the remote host","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/remote_hosts/242/authenticate","request_body":"{\n \"credential_id\": 415\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer 7dz0ql_hpHcQX83IFUCRd5EodlIn_H3KbGRubqpXEek","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":204,"response_status_text":"No Content","response_body":null,"response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"73c70107-9914-48f5-b953-5df1d410c6d4","X-Runtime":"0.030662"},"response_content_type":null,"curl":"curl \"api.civis.testhttp://api.civis.test/remote_hosts/242/authenticate\" -d '{\"credential_id\":415}' -X POST \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer 7dz0ql_hpHcQX83IFUCRd5EodlIn_H3KbGRubqpXEek\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"RemoteHosts","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/remote_hosts/:id/authenticate","description":"Authenticate against the remote host can fail","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/remote_hosts/248/authenticate","request_body":"{\n \"credential_id\": 419\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer ifsjHu756kof7XmuMqQXqHCawhxsXDgTWhbMjGZ9B4g","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":400,"response_status_text":"Bad Request","response_body":"{\n \"error\": \"authentication_error\",\n \"errorDescription\": \"Username or password is incorrect.\",\n \"code\": 400\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"836967e4-7c83-49a7-a63c-df9b713c8a6f","X-Runtime":"0.029796","Content-Length":"99"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/remote_hosts/248/authenticate\" -d '{\"credential_id\":419}' -X POST \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer ifsjHu756kof7XmuMqQXqHCawhxsXDgTWhbMjGZ9B4g\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/remote_hosts/{id}/data_sets":{"get":{"summary":"List data sets available from a remote host","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the remote host.","type":"integer"},{"name":"credential_id","in":"query","required":false,"description":"The credential ID.","type":"integer"},{"name":"username","in":"query","required":false,"description":"The user name for remote host.","type":"string"},{"name":"password","in":"query","required":false,"description":"The password for remote host.","type":"string"},{"name":"q","in":"query","required":false,"description":"The query string for data set.","type":"string"},{"name":"s","in":"query","required":false,"description":"If true will only return schemas, otherwise, the results will be the full path.","type":"boolean"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object472"}}}},"x-examples":[{"resource":"RemoteHosts","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/remote_hosts/:id/data_sets?credential_id=:credential_id","description":"List all data sets for a user","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/remote_hosts/254/data_sets?credential_id=423","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer yWxJUkiY3STj0jB3cZa_FUjWpEe4df_wYdz8CNv-MjI","Host":"api.civis.test","Cookie":""},"request_query_parameters":{"credential_id":"423"},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"name\": \"table_schema.table_name\",\n \"fullPath\": false\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"14a255c21424381eabfdd24ebee5fd3b\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"b0cd88bc-6496-440c-9de7-27e4b1936fd3","X-Runtime":"0.026468","Content-Length":"53"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/remote_hosts/254/data_sets?credential_id=423\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer yWxJUkiY3STj0jB3cZa_FUjWpEe4df_wYdz8CNv-MjI\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/reports/":{"get":{"summary":"List Reports","description":null,"deprecated":false,"parameters":[{"name":"type","in":"query","required":false,"description":"If specified, return report of these types. It accepts a comma-separated list, possible values are 'tableau' or 'other'.","type":"string"},{"name":"template_id","in":"query","required":false,"description":"If specified, return reports using the provided Template.","type":"integer"},{"name":"author","in":"query","required":false,"description":"If specified, return items from any of these authors. It accepts a comma-separated list of user IDs.","type":"string"},{"name":"hidden","in":"query","required":false,"description":"If specified to be true, returns hidden items. Defaults to false, returning non-hidden items.","type":"boolean"},{"name":"archived","in":"query","required":false,"description":"The archival status of the requested item(s).","type":"string"},{"name":"limit","in":"query","required":false,"description":"Number of results to return. Defaults to 20. Maximum allowed is 50.","type":"integer"},{"name":"page_num","in":"query","required":false,"description":"Page number of the results to return. Defaults to the first page, 1.","type":"integer"},{"name":"order","in":"query","required":false,"description":"The field on which to order the result set. Defaults to updated_at. Must be one of: updated_at, name, created_at.","type":"string"},{"name":"order_dir","in":"query","required":false,"description":"Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc.","type":"string"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object473"}}}},"x-examples":[{"resource":"Report","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/reports","description":"List all reports","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/reports","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer UHqSYTcHLGW1nmYo4a5uN1dRpWabVxtW-AXOo1ZG9v8","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 1,\n \"name\": \"test_report\",\n \"user\": {\n \"id\": 7,\n \"name\": \"User devuserfactory2 2\",\n \"username\": \"devuserfactory2\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"createdAt\": \"2016-03-01T01:01:00.000Z\",\n \"updatedAt\": \"2016-03-01T01:01:00.000Z\",\n \"type\": \"ReportTypes::Html\",\n \"projects\": [\n {\n \"id\": 1,\n \"name\": \"Test Project\"\n }\n ],\n \"state\": \"running\",\n \"finishedAt\": \"2024-03-14T15:40:49.000Z\",\n \"vizUpdatedAt\": null,\n \"script\": {\n \"id\": 2,\n \"name\": \"Script #2\",\n \"sql\": \"SELECT * FROM table LIMIT 10;\"\n },\n \"jobPath\": \"/scripts/sql/2\",\n \"tableauId\": null,\n \"templateId\": null,\n \"authThumbnailUrl\": null,\n \"lastRun\": {\n \"id\": 1,\n \"state\": \"running\",\n \"createdAt\": \"2024-03-14T15:40:49.000Z\",\n \"startedAt\": null,\n \"finishedAt\": \"2024-03-14T15:40:49.000Z\",\n \"error\": null\n },\n \"archived\": false\n },\n {\n \"id\": 2,\n \"name\": \"custom tableau view\",\n \"user\": {\n \"id\": 7,\n \"name\": \"User devuserfactory2 2\",\n \"username\": \"devuserfactory2\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"createdAt\": \"2024-03-14T15:40:49.000Z\",\n \"updatedAt\": \"2016-02-01T01:01:00.000Z\",\n \"type\": \"ReportTypes::Tableau\",\n \"projects\": [\n\n ],\n \"state\": null,\n \"finishedAt\": null,\n \"vizUpdatedAt\": null,\n \"script\": null,\n \"jobPath\": null,\n \"tableauId\": 1,\n \"templateId\": null,\n \"authThumbnailUrl\": null,\n \"lastRun\": null,\n \"archived\": false\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","X-Pagination-Per-Page":"20","Access-Control-Expose-Headers":"X-Pagination-Per-Page, X-Pagination-Current-Page, X-Pagination-Total-Pages, X-Pagination-Total-Entries","X-Pagination-Current-Page":"1","X-Pagination-Total-Pages":"1","X-Pagination-Total-Entries":"2","Content-Type":"application/json; charset=utf-8","ETag":"W/\"2895d73f9ea709e21dcc8eb796a14984\"","X-Request-Id":"d64b01ea-39cc-497c-a4dc-f01e8e08eeee","X-Runtime":"0.147772","Content-Length":"1124"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/reports\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer UHqSYTcHLGW1nmYo4a5uN1dRpWabVxtW-AXOo1ZG9v8\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Report","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/reports?templateId=:template_id","description":"Filter reports by Template ID","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/reports?templateId=1","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer d9H3LD4CWSmVEJdMAHF7c-VKZbvNzX2iwEHSy3WhinI","Host":"api.civis.test","Cookie":""},"request_query_parameters":{"templateId":"1"},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 8,\n \"name\": \"test_report\",\n \"user\": {\n \"id\": 31,\n \"name\": \"User devuserfactory20 20\",\n \"username\": \"devuserfactory20\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"createdAt\": \"2024-03-14T15:40:51.000Z\",\n \"updatedAt\": \"2024-03-14T15:40:51.000Z\",\n \"type\": \"ReportTypes::Html\",\n \"projects\": [\n\n ],\n \"state\": \"running\",\n \"finishedAt\": \"2024-03-14T15:40:50.000Z\",\n \"vizUpdatedAt\": null,\n \"script\": {\n \"id\": 6,\n \"name\": \"Script #6\",\n \"sql\": \"SELECT * FROM table LIMIT 10;\"\n },\n \"jobPath\": \"/scripts/sql/6\",\n \"tableauId\": null,\n \"templateId\": 1,\n \"authThumbnailUrl\": null,\n \"lastRun\": {\n \"id\": 2,\n \"state\": \"running\",\n \"createdAt\": \"2024-03-14T15:40:50.000Z\",\n \"startedAt\": null,\n \"finishedAt\": \"2024-03-14T15:40:50.000Z\",\n \"error\": null\n },\n \"archived\": false\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","X-Pagination-Per-Page":"20","Access-Control-Expose-Headers":"X-Pagination-Per-Page, X-Pagination-Current-Page, X-Pagination-Total-Pages, X-Pagination-Total-Entries","X-Pagination-Current-Page":"1","X-Pagination-Total-Pages":"1","X-Pagination-Total-Entries":"1","Content-Type":"application/json; charset=utf-8","ETag":"W/\"addb5e02068e01194f35667d5383cdfa\"","X-Request-Id":"5fa9910f-f152-46cd-8936-d69adb14fba5","X-Runtime":"0.038287","Content-Length":"660"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/reports?templateId=1\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer d9H3LD4CWSmVEJdMAHF7c-VKZbvNzX2iwEHSy3WhinI\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"post":{"summary":"Create an HTML report","description":null,"deprecated":false,"parameters":[{"name":"Object477","in":"body","schema":{"$ref":"#/definitions/Object477"},"required":false}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object476"}}},"x-examples":[{"resource":"Report","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/reports","description":"Create a report","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/reports","request_body":"{\n \"script_id\": 12,\n \"name\": \"Custom Name\"\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer i3Pcc7Xh4K7oeMlAjNB_BIUt3h4bu-Kdv230DFa27B0","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 15,\n \"name\": \"Custom Name\",\n \"user\": {\n \"id\": 43,\n \"name\": \"User devuserfactory30 30\",\n \"username\": \"devuserfactory30\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"createdAt\": \"2024-03-14T15:40:54.000Z\",\n \"updatedAt\": \"2024-03-14T15:40:54.000Z\",\n \"type\": \"ReportTypes::Html\",\n \"description\": null,\n \"myPermissionLevel\": \"manage\",\n \"projects\": [\n\n ],\n \"state\": \"idle\",\n \"finishedAt\": null,\n \"vizUpdatedAt\": null,\n \"script\": {\n \"id\": 12,\n \"name\": \"Script #12\",\n \"sql\": \"SELECT * FROM table LIMIT 10;\"\n },\n \"jobPath\": \"/scripts/sql/12\",\n \"tableauId\": null,\n \"templateId\": null,\n \"authThumbnailUrl\": null,\n \"lastRun\": null,\n \"archived\": false,\n \"hidden\": false,\n \"authDataUrl\": \"\",\n \"authCodeUrl\": \"\",\n \"config\": null,\n \"validOutputFile\": false,\n \"provideAPIKey\": false,\n \"apiKey\": null,\n \"apiKeyId\": null,\n \"appState\": {\n },\n \"useViewersTableauUsername\": false\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"a0663130c3226e8474eb83c8aa5ad935\"","X-Request-Id":"d7971346-6e2b-4b92-8be5-1f122a9aa66b","X-Runtime":"0.086713","Content-Length":"744"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/reports\" -d '{\"script_id\":12,\"name\":\"Custom Name\"}' -X POST \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer i3Pcc7Xh4K7oeMlAjNB_BIUt3h4bu-Kdv230DFa27B0\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Report","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/reports","description":"Create a report specifying a code body","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/reports","request_body":"{\n \"script_id\": 16,\n \"name\": \"Custom Name\",\n \"code_body\": \"

Hello Civis

\"\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer R8VTdgCT-fezsAgWZuNmJMyhg5kdlX6yJrJf0nHPEE4","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 19,\n \"name\": \"Custom Name\",\n \"user\": {\n \"id\": 55,\n \"name\": \"User devuserfactory38 38\",\n \"username\": \"devuserfactory38\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"createdAt\": \"2024-03-14T15:40:55.000Z\",\n \"updatedAt\": \"2024-03-14T15:40:55.000Z\",\n \"type\": \"ReportTypes::Html\",\n \"description\": null,\n \"myPermissionLevel\": \"manage\",\n \"projects\": [\n\n ],\n \"state\": \"idle\",\n \"finishedAt\": null,\n \"vizUpdatedAt\": null,\n \"script\": {\n \"id\": 16,\n \"name\": \"Script #16\",\n \"sql\": \"SELECT * FROM table LIMIT 10;\"\n },\n \"jobPath\": \"/scripts/sql/16\",\n \"tableauId\": null,\n \"templateId\": null,\n \"authThumbnailUrl\": null,\n \"lastRun\": null,\n \"archived\": false,\n \"hidden\": false,\n \"authDataUrl\": \"\",\n \"authCodeUrl\": \"http://s3_url\",\n \"config\": null,\n \"validOutputFile\": false,\n \"provideAPIKey\": false,\n \"apiKey\": null,\n \"apiKeyId\": null,\n \"appState\": {\n },\n \"useViewersTableauUsername\": false\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"dde55cc3e39894ce9bfc9f9a14b2653b\"","X-Request-Id":"5fae3ad1-3df6-4a5a-b741-ae85de5f99e5","X-Runtime":"0.078129","Content-Length":"757"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/reports\" -d '{\"script_id\":16,\"name\":\"Custom Name\",\"code_body\":\"\\u003ch1\\u003eHello Civis\\u003c/h1\\u003e\"}' -X POST \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer R8VTdgCT-fezsAgWZuNmJMyhg5kdlX6yJrJf0nHPEE4\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/reports/{id}/git":{"get":{"summary":"Get the git metadata attached to an item","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the item.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object402"}}},"x-examples":null,"x-deprecation-warning":null},"put":{"summary":"Attach an item to a file in a git repo","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the item.","type":"integer"},{"name":"Object403","in":"body","schema":{"$ref":"#/definitions/Object403"},"required":false}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object402"}}},"x-examples":null,"x-deprecation-warning":null},"patch":{"summary":"Update an attached git file","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the item.","type":"integer"},{"name":"Object403","in":"body","schema":{"$ref":"#/definitions/Object403"},"required":false}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object402"}}},"x-examples":null,"x-deprecation-warning":null}},"/reports/{id}/git/commits":{"get":{"summary":"Get the git commits for an item on the current branch","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the item.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object404"}}},"x-examples":null,"x-deprecation-warning":null},"post":{"summary":"Commit and push a new version of the file","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the item.","type":"integer"},{"name":"Object405","in":"body","schema":{"$ref":"#/definitions/Object405"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object406"}}},"x-examples":null,"x-deprecation-warning":null}},"/reports/{id}/git/commits/{commit_hash}":{"get":{"summary":"Get file contents at git ref","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the item.","type":"integer"},{"name":"commit_hash","in":"path","required":true,"description":"The SHA (full or shortened) of the desired git commit.","type":"string"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object406"}}},"x-examples":null,"x-deprecation-warning":null}},"/reports/{id}":{"get":{"summary":"Get a single report","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of this report.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object476"}}},"x-examples":[{"resource":"Report","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/reports/:id","description":"View a report's details","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/reports/9","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer QcoMjIy8sSXYgbw13SSdYgOBMUhfZr0HKDv2VrlsxJk","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 9,\n \"name\": \"test_report\",\n \"user\": {\n \"id\": 34,\n \"name\": \"User devuserfactory23 23\",\n \"username\": \"devuserfactory23\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"createdAt\": \"2016-03-01T01:01:00.000Z\",\n \"updatedAt\": \"2016-03-01T01:01:00.000Z\",\n \"type\": \"ReportTypes::Html\",\n \"description\": null,\n \"myPermissionLevel\": \"manage\",\n \"projects\": [\n {\n \"id\": 3,\n \"name\": \"Test Project\"\n }\n ],\n \"state\": \"running\",\n \"finishedAt\": \"2024-03-14T15:40:52.000Z\",\n \"vizUpdatedAt\": null,\n \"script\": {\n \"id\": 8,\n \"name\": \"Script #8\",\n \"sql\": \"SELECT * FROM table LIMIT 10;\"\n },\n \"jobPath\": \"/scripts/sql/8\",\n \"tableauId\": null,\n \"templateId\": null,\n \"authThumbnailUrl\": null,\n \"lastRun\": {\n \"id\": 3,\n \"state\": \"running\",\n \"createdAt\": \"2024-03-14T15:40:52.000Z\",\n \"startedAt\": null,\n \"finishedAt\": \"2024-03-14T15:40:52.000Z\",\n \"error\": null\n },\n \"archived\": false,\n \"hidden\": false,\n \"authDataUrl\": \"\",\n \"authCodeUrl\": \"http://s3_url\",\n \"config\": null,\n \"validOutputFile\": false,\n \"provideAPIKey\": false,\n \"apiKey\": null,\n \"apiKeyId\": null,\n \"appState\": {\n },\n \"useViewersTableauUsername\": false\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"f88ae87b3b6ca452e4b2a97b524107e5\"","X-Request-Id":"be33b29e-1588-4f54-b6a0-8c85b80eee81","X-Runtime":"0.196145","Content-Length":"939"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/reports/9\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer QcoMjIy8sSXYgbw13SSdYgOBMUhfZr0HKDv2VrlsxJk\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"patch":{"summary":"Update a report","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the report to modify.","type":"integer"},{"name":"Object478","in":"body","schema":{"$ref":"#/definitions/Object478"},"required":false}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object476"}}},"x-examples":[{"resource":"Report","resource_explanation":null,"http_method":"PATCH","route":"http://api.civis.test/reports/:id","description":"Update a report's app_state","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"PATCH","request_path":"http://api.civis.test/reports/20","request_body":"{\n \"app_state\": {\n \"app_state\": \"blob\"\n }\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer ImfIxfIE0p3Xfn1PpWDdmQHOrmh6GLEzsXHXNVzWw4o","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 20,\n \"name\": \"test_report\",\n \"user\": {\n \"id\": 67,\n \"name\": \"User devuserfactory46 46\",\n \"username\": \"devuserfactory46\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"createdAt\": \"2016-03-01T01:01:00.000Z\",\n \"updatedAt\": \"2024-03-14T15:40:56.000Z\",\n \"type\": \"ReportTypes::Html\",\n \"description\": null,\n \"myPermissionLevel\": \"manage\",\n \"projects\": [\n {\n \"id\": 6,\n \"name\": \"Test Project\"\n }\n ],\n \"state\": \"running\",\n \"finishedAt\": \"2024-03-14T15:40:55.000Z\",\n \"vizUpdatedAt\": null,\n \"script\": {\n \"id\": 18,\n \"name\": \"Script #18\",\n \"sql\": \"SELECT * FROM table LIMIT 10;\"\n },\n \"jobPath\": \"/scripts/sql/18\",\n \"tableauId\": null,\n \"templateId\": null,\n \"authThumbnailUrl\": null,\n \"lastRun\": {\n \"id\": 6,\n \"state\": \"running\",\n \"createdAt\": \"2024-03-14T15:40:55.000Z\",\n \"startedAt\": null,\n \"finishedAt\": \"2024-03-14T15:40:55.000Z\",\n \"error\": null\n },\n \"archived\": false,\n \"hidden\": false,\n \"authDataUrl\": \"\",\n \"authCodeUrl\": \"http://s3_url\",\n \"config\": null,\n \"validOutputFile\": false,\n \"provideAPIKey\": false,\n \"apiKey\": null,\n \"apiKeyId\": null,\n \"appState\": {\n \"app_state\": \"blob\"\n },\n \"useViewersTableauUsername\": false\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"751d7b3f0c56cfac0d55d3f704ba1044\"","X-Request-Id":"945f41ee-7194-41fd-89f2-eea5578d448f","X-Runtime":"0.083227","Content-Length":"961"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/reports/20\" -d '{\"app_state\":{\"app_state\":\"blob\"}}' -X PATCH \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer ImfIxfIE0p3Xfn1PpWDdmQHOrmh6GLEzsXHXNVzWw4o\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Report","resource_explanation":null,"http_method":"PATCH","route":"http://api.civis.test/reports/:id","description":"Update a report's name, script job, and code_body","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"PATCH","request_path":"http://api.civis.test/reports/23","request_body":"{\n \"name\": \"New Name\",\n \"script_id\": 22,\n \"code_body\": \"

New Code Body

\"\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer qagGaFGyuhuHYW-rHpF9R1tmabHxauqo1HyzRI5gM1w","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 23,\n \"name\": \"New Name\",\n \"user\": {\n \"id\": 76,\n \"name\": \"User devuserfactory53 53\",\n \"username\": \"devuserfactory53\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"createdAt\": \"2016-03-01T01:01:00.000Z\",\n \"updatedAt\": \"2024-03-14T15:40:57.000Z\",\n \"type\": \"ReportTypes::Html\",\n \"description\": null,\n \"myPermissionLevel\": \"manage\",\n \"projects\": [\n {\n \"id\": 7,\n \"name\": \"Test Project\"\n }\n ],\n \"state\": \"idle\",\n \"finishedAt\": null,\n \"vizUpdatedAt\": null,\n \"script\": {\n \"id\": 22,\n \"name\": \"Script #22\",\n \"sql\": \"SELECT * FROM table LIMIT 10;\"\n },\n \"jobPath\": \"/scripts/sql/22\",\n \"tableauId\": null,\n \"templateId\": null,\n \"authThumbnailUrl\": null,\n \"lastRun\": null,\n \"archived\": false,\n \"hidden\": false,\n \"authDataUrl\": \"\",\n \"authCodeUrl\": \"http://s3_url\",\n \"config\": null,\n \"validOutputFile\": false,\n \"provideAPIKey\": false,\n \"apiKey\": null,\n \"apiKeyId\": null,\n \"appState\": {\n },\n \"useViewersTableauUsername\": false\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"1910584f1146cfc3a792181ed01cb0a5\"","X-Request-Id":"5a75c87d-e699-49d3-a418-203389ce79f1","X-Runtime":"0.048498","Content-Length":"784"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/reports/23\" -d '{\"name\":\"New Name\",\"script_id\":22,\"code_body\":\"\\u003ch1\\u003eNew Code Body\\u003c/h1\\u003e\"}' -X PATCH \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer qagGaFGyuhuHYW-rHpF9R1tmabHxauqo1HyzRI5gM1w\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Report","resource_explanation":null,"http_method":"PATCH","route":"http://api.civis.test/reports/:id","description":"Update a report's template","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"PATCH","request_path":"http://api.civis.test/reports/26","request_body":"{\n \"template_id\": 2\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer MJmQlo8s0KRZOiDQt39OhvMnGwlJjYBOsLsCBJIvZ50","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 26,\n \"name\": \"test_report\",\n \"user\": {\n \"id\": 88,\n \"name\": \"User devuserfactory61 61\",\n \"username\": \"devuserfactory61\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"createdAt\": \"2016-03-01T01:01:00.000Z\",\n \"updatedAt\": \"2024-03-14T15:40:58.000Z\",\n \"type\": \"ReportTypes::Html\",\n \"description\": null,\n \"myPermissionLevel\": \"manage\",\n \"projects\": [\n {\n \"id\": 8,\n \"name\": \"Test Project\"\n }\n ],\n \"state\": \"running\",\n \"finishedAt\": \"2024-03-14T15:40:57.000Z\",\n \"vizUpdatedAt\": null,\n \"script\": {\n \"id\": 24,\n \"name\": \"Script #24\",\n \"sql\": \"SELECT * FROM table LIMIT 10;\"\n },\n \"jobPath\": \"/scripts/sql/24\",\n \"tableauId\": null,\n \"templateId\": 2,\n \"authThumbnailUrl\": null,\n \"lastRun\": {\n \"id\": 8,\n \"state\": \"running\",\n \"createdAt\": \"2024-03-14T15:40:57.000Z\",\n \"startedAt\": null,\n \"finishedAt\": \"2024-03-14T15:40:57.000Z\",\n \"error\": null\n },\n \"archived\": false,\n \"hidden\": false,\n \"authDataUrl\": \"\",\n \"authCodeUrl\": \"http://s3_url\",\n \"config\": null,\n \"validOutputFile\": false,\n \"provideAPIKey\": null,\n \"apiKey\": null,\n \"apiKeyId\": null,\n \"appState\": {\n },\n \"useViewersTableauUsername\": false\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"5e8ed63205928690803d7b34c5a2aab4\"","X-Request-Id":"2e108d79-fe53-4669-976f-12c7f6f61abc","X-Runtime":"0.057747","Content-Length":"939"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/reports/26\" -d '{\"template_id\":2}' -X PATCH \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer MJmQlo8s0KRZOiDQt39OhvMnGwlJjYBOsLsCBJIvZ50\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/reports/{id}/grants":{"post":{"summary":"Grant this report the ability to perform Civis platform API operations on your behalf","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of this report.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object476"}}},"x-examples":[{"resource":"Report","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/reports/:id/grants","description":"Grant access to the Civis platform API to a report","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/reports/38/grants","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer Jwn23yHHq99O5w5ffbIgqYTRH70L_7RrIoQxuyY4YOc","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 38,\n \"name\": \"test_report\",\n \"user\": {\n \"id\": 126,\n \"name\": \"User devuserfactory91 91\",\n \"username\": \"devuserfactory91\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"createdAt\": \"2016-03-01T01:01:00.000Z\",\n \"updatedAt\": \"2016-03-01T01:01:00.000Z\",\n \"type\": \"ReportTypes::Html\",\n \"description\": null,\n \"myPermissionLevel\": \"manage\",\n \"projects\": [\n {\n \"id\": 12,\n \"name\": \"Test Project\"\n }\n ],\n \"state\": \"running\",\n \"finishedAt\": \"2024-03-14T15:41:01.000Z\",\n \"vizUpdatedAt\": null,\n \"script\": {\n \"id\": 32,\n \"name\": \"Script #32\",\n \"sql\": \"SELECT * FROM table LIMIT 10;\"\n },\n \"jobPath\": \"/scripts/sql/32\",\n \"tableauId\": null,\n \"templateId\": null,\n \"authThumbnailUrl\": null,\n \"lastRun\": {\n \"id\": 12,\n \"state\": \"running\",\n \"createdAt\": \"2024-03-14T15:41:01.000Z\",\n \"startedAt\": null,\n \"finishedAt\": \"2024-03-14T15:41:01.000Z\",\n \"error\": null\n },\n \"archived\": false,\n \"hidden\": false,\n \"authDataUrl\": \"\",\n \"authCodeUrl\": \"http://s3_url\",\n \"config\": null,\n \"validOutputFile\": false,\n \"provideAPIKey\": false,\n \"apiKey\": \"13AEDvgtaqIcGM5NjbBh-_T2wDFhkmyRaC7SVoB1RoQ\",\n \"apiKeyId\": 13,\n \"appState\": {\n },\n \"useViewersTableauUsername\": false\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"5905b6bb02f7b9b870bc0c4766443d5d\"","X-Request-Id":"ec2f72f0-5af8-4788-8be8-9131337887bf","X-Runtime":"0.083148","Content-Length":"985"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/reports/38/grants\" -d '' -X POST \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer Jwn23yHHq99O5w5ffbIgqYTRH70L_7RrIoQxuyY4YOc\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"delete":{"summary":"Revoke permission for this report to perform Civis platform API operations on your behalf","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of this report.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":[{"resource":"Report","resource_explanation":null,"http_method":"DELETE","route":"http://api.civis.test/reports/:id/grants","description":"Revoke access to the Civis platform API from a report","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"DELETE","request_path":"http://api.civis.test/reports/41/grants","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer wor9kxnz5DZ5ohaLjQV9I-YIyJIwr6pRgjp4fYdjmTc","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":204,"response_status_text":"No Content","response_body":null,"response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","X-Request-Id":"0bb6a3be-d87e-40be-b088-1989a6afabcb","X-Runtime":"0.030907"},"response_content_type":null,"curl":"curl \"api.civis.testhttp://api.civis.test/reports/41/grants\" -d '' -X DELETE \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer wor9kxnz5DZ5ohaLjQV9I-YIyJIwr6pRgjp4fYdjmTc\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/reports/{id}/shares":{"get":{"summary":"List users and groups permissioned on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object9"}}}},"x-examples":null,"x-deprecation-warning":null}},"/reports/{id}/shares/users":{"put":{"summary":"Set the permissions users have on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"Object479","in":"body","schema":{"$ref":"#/definitions/Object479"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object9"}}},"x-examples":null,"x-deprecation-warning":null}},"/reports/{id}/shares/users/{user_id}":{"delete":{"summary":"Revoke the permissions a user has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"user_id","in":"path","required":true,"description":"The ID of the user.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/reports/{id}/shares/groups":{"put":{"summary":"Set the permissions groups has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"Object480","in":"body","schema":{"$ref":"#/definitions/Object480"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object9"}}},"x-examples":null,"x-deprecation-warning":null}},"/reports/{id}/shares/groups/{group_id}":{"delete":{"summary":"Revoke the permissions a group has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"group_id","in":"path","required":true,"description":"The ID of the group.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/reports/{id}/dependencies":{"get":{"summary":"List dependent objects for this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"user_id","in":"query","required":false,"description":"ID of target user","type":"integer"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object15"}}}},"x-examples":null,"x-deprecation-warning":null}},"/reports/{id}/transfer":{"put":{"summary":"Transfer ownership of this object to another user","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"Object481","in":"body","schema":{"$ref":"#/definitions/Object481"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object17"}}},"x-examples":null,"x-deprecation-warning":null}},"/reports/{id}/projects":{"get":{"summary":"List the projects a Report belongs to","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Report.","type":"integer"},{"name":"hidden","in":"query","required":false,"description":"If specified to be true, returns hidden items. Defaults to false, returning non-hidden items.","type":"boolean"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object84"}}}},"x-examples":null,"x-deprecation-warning":null}},"/reports/{id}/projects/{project_id}":{"put":{"summary":"Add a Report to a project","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Report.","type":"integer"},{"name":"project_id","in":"path","required":true,"description":"The ID of the project.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null},"delete":{"summary":"Remove a Report from a project","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Report.","type":"integer"},{"name":"project_id","in":"path","required":true,"description":"The ID of the project.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/reports/{id}/archive":{"put":{"summary":"Update the archive status of this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the object.","type":"integer"},{"name":"Object482","in":"body","schema":{"$ref":"#/definitions/Object482"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object476"}}},"x-examples":null,"x-deprecation-warning":null}},"/reports/services/{id}":{"get":{"summary":"Get a single service report","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of this report.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object483"}}},"x-examples":null,"x-deprecation-warning":null},"patch":{"summary":"Update some attributes of this service report","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of this report.","type":"integer"},{"name":"Object485","in":"body","schema":{"$ref":"#/definitions/Object485"},"required":false}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object483"}}},"x-examples":null,"x-deprecation-warning":null}},"/reports/services":{"post":{"summary":"Create a service report","description":null,"deprecated":false,"parameters":[{"name":"Object484","in":"body","schema":{"$ref":"#/definitions/Object484"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object483"}}},"x-examples":null,"x-deprecation-warning":null}},"/reports/services/{id}/shares":{"get":{"summary":"List users and groups permissioned on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object9"}}}},"x-examples":null,"x-deprecation-warning":null}},"/reports/services/{id}/shares/users":{"put":{"summary":"Set the permissions users have on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"Object486","in":"body","schema":{"$ref":"#/definitions/Object486"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object9"}}},"x-examples":null,"x-deprecation-warning":null}},"/reports/services/{id}/shares/users/{user_id}":{"delete":{"summary":"Revoke the permissions a user has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"user_id","in":"path","required":true,"description":"The ID of the user.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/reports/services/{id}/shares/groups":{"put":{"summary":"Set the permissions groups has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"Object487","in":"body","schema":{"$ref":"#/definitions/Object487"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object9"}}},"x-examples":null,"x-deprecation-warning":null}},"/reports/services/{id}/shares/groups/{group_id}":{"delete":{"summary":"Revoke the permissions a group has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"group_id","in":"path","required":true,"description":"The ID of the group.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/reports/services/{id}/dependencies":{"get":{"summary":"List dependent objects for this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"user_id","in":"query","required":false,"description":"ID of target user","type":"integer"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object15"}}}},"x-examples":null,"x-deprecation-warning":null}},"/reports/services/{id}/transfer":{"put":{"summary":"Transfer ownership of this object to another user","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"Object488","in":"body","schema":{"$ref":"#/definitions/Object488"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object17"}}},"x-examples":null,"x-deprecation-warning":null}},"/reports/services/{id}/projects":{"get":{"summary":"List the projects a Service Report belongs to","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Service Report.","type":"integer"},{"name":"hidden","in":"query","required":false,"description":"If specified to be true, returns hidden items. Defaults to false, returning non-hidden items.","type":"boolean"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object84"}}}},"x-examples":null,"x-deprecation-warning":null}},"/reports/services/{id}/projects/{project_id}":{"put":{"summary":"Add a Service Report to a project","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Service Report.","type":"integer"},{"name":"project_id","in":"path","required":true,"description":"The ID of the project.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null},"delete":{"summary":"Remove a Service Report from a project","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Service Report.","type":"integer"},{"name":"project_id","in":"path","required":true,"description":"The ID of the project.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/reports/services/{id}/archive":{"put":{"summary":"Update the archive status of this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the object.","type":"integer"},{"name":"Object489","in":"body","schema":{"$ref":"#/definitions/Object489"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object483"}}},"x-examples":null,"x-deprecation-warning":null}},"/reports/{id}/refresh":{"post":{"summary":"Refresh the data in this Tableau report","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of this report.","type":"integer"}],"responses":{"202":{"description":"success","schema":{"$ref":"#/definitions/Object490"}}},"x-examples":[{"resource":"Report","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/reports/:id/refresh","description":"Refresh the data in a Tableau report","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/reports/30/refresh","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer di6K2UpxsKQKPqo8GK2vJNL4BN52AM6MUBAq9OVj0Ys","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":202,"response_status_text":"Accepted","response_body":"{\n \"id\": 30,\n \"organization\": {\n \"id\": 21,\n \"tableauRefreshUsage\": 0,\n \"tableauRefreshLimit\": 5000,\n \"tableauRefreshHistory\": [\n {\n \"time_period\": \"2019-01\",\n \"usage\": 0\n },\n {\n \"time_period\": \"2018-12\",\n \"usage\": 0\n }\n ]\n }\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","X-Request-Id":"de23c92a-6d86-4a48-ab74-dfa7f3e091e5","X-Runtime":"0.044789","Content-Length":"183"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/reports/30/refresh\" -d '' -X POST \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer di6K2UpxsKQKPqo8GK2vJNL4BN52AM6MUBAq9OVj0Ys\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Report","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/reports/:id/refresh","description":"For a report with no data sources","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/reports/33/refresh","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer mbAjIvz4iR7-H_LhOJKmrWOGX7il4TZTa-tyqSr_Nnc","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":502,"response_status_text":"Bad Gateway","response_body":"{\n \"error\": \"refresh_failed\",\n \"errorDescription\": \"Tableau was unable to schedule a manual refresh. This workbook may not have associated data sources.\",\n \"code\": 502\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","X-Request-Id":"fc519fb6-5578-4a63-ba27-7e0de379d4fa","X-Runtime":"0.047650","Content-Length":"159"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/reports/33/refresh\" -d '' -X POST \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer mbAjIvz4iR7-H_LhOJKmrWOGX7il4TZTa-tyqSr_Nnc\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Report","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/reports/:id/refresh","description":"For an organization over its refresh limit","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/reports/36/refresh","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer x5RBjRGWq5Z1jOPrQKwXm0qO1RmqhjBWneSCcKe21sE","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":403,"response_status_text":"Forbidden","response_body":"{\n \"error\": \"refresh_limit\",\n \"errorDescription\": \"Organization's refresh limit has been reached. Contact your organization manager or client success to consider increasing this limit.\",\n \"code\": 403\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","X-Request-Id":"d5a6b098-494a-4d29-a65c-8096f12456c3","X-Runtime":"0.028620","Content-Length":"191"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/reports/36/refresh\" -d '' -X POST \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer x5RBjRGWq5Z1jOPrQKwXm0qO1RmqhjBWneSCcKe21sE\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/reports/sql":{"post":{"summary":"Create a SQL report","description":null,"deprecated":false,"parameters":[{"name":"Object492","in":"body","schema":{"$ref":"#/definitions/Object492"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object493"}}},"x-examples":null,"x-deprecation-warning":null}},"/reports/sql/{id}":{"get":{"summary":"Get a single SQL report","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of this report.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object493"}}},"x-examples":null,"x-deprecation-warning":null},"patch":{"summary":"Update a SQL report","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of this report.","type":"integer"},{"name":"Object495","in":"body","schema":{"$ref":"#/definitions/Object495"},"required":false}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object493"}}},"x-examples":null,"x-deprecation-warning":null}},"/reports/sql/{id}/refresh":{"post":{"summary":"Refresh the data in a SQL report","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of this report.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object493"}}},"x-examples":null,"x-deprecation-warning":null}},"/reports/sql/{id}/shares":{"get":{"summary":"List users and groups permissioned on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object9"}}}},"x-examples":null,"x-deprecation-warning":null}},"/reports/sql/{id}/shares/users":{"put":{"summary":"Set the permissions users have on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"Object496","in":"body","schema":{"$ref":"#/definitions/Object496"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object9"}}},"x-examples":null,"x-deprecation-warning":null}},"/reports/sql/{id}/shares/users/{user_id}":{"delete":{"summary":"Revoke the permissions a user has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"user_id","in":"path","required":true,"description":"The ID of the user.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/reports/sql/{id}/shares/groups":{"put":{"summary":"Set the permissions groups has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"Object497","in":"body","schema":{"$ref":"#/definitions/Object497"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object9"}}},"x-examples":null,"x-deprecation-warning":null}},"/reports/sql/{id}/shares/groups/{group_id}":{"delete":{"summary":"Revoke the permissions a group has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"group_id","in":"path","required":true,"description":"The ID of the group.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/reports/sql/{id}/dependencies":{"get":{"summary":"List dependent objects for this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"user_id","in":"query","required":false,"description":"ID of target user","type":"integer"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object15"}}}},"x-examples":null,"x-deprecation-warning":null}},"/reports/sql/{id}/transfer":{"put":{"summary":"Transfer ownership of this object to another user","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"Object498","in":"body","schema":{"$ref":"#/definitions/Object498"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object17"}}},"x-examples":null,"x-deprecation-warning":null}},"/reports/sql/{id}/projects":{"get":{"summary":"List the projects a SQL Report belongs to","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the SQL Report.","type":"integer"},{"name":"hidden","in":"query","required":false,"description":"If specified to be true, returns hidden items. Defaults to false, returning non-hidden items.","type":"boolean"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object84"}}}},"x-examples":null,"x-deprecation-warning":null}},"/reports/sql/{id}/projects/{project_id}":{"put":{"summary":"Add a SQL Report to a project","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the SQL Report.","type":"integer"},{"name":"project_id","in":"path","required":true,"description":"The ID of the project.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null},"delete":{"summary":"Remove a SQL Report from a project","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the SQL Report.","type":"integer"},{"name":"project_id","in":"path","required":true,"description":"The ID of the project.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/reports/sql/{id}/archive":{"put":{"summary":"Update the archive status of this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the object.","type":"integer"},{"name":"Object499","in":"body","schema":{"$ref":"#/definitions/Object499"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object493"}}},"x-examples":null,"x-deprecation-warning":null}},"/roles/":{"get":{"summary":"List Roles","description":null,"deprecated":false,"parameters":[{"name":"limit","in":"query","required":false,"description":"Number of results to return. Defaults to 50. Maximum allowed is 1000.","type":"integer"},{"name":"page_num","in":"query","required":false,"description":"Page number of the results to return. Defaults to the first page, 1.","type":"integer"},{"name":"order","in":"query","required":false,"description":"The field on which to order the result set. Defaults to id. Must be one of: id.","type":"string"},{"name":"order_dir","in":"query","required":false,"description":"Direction in which to sort, either asc (ascending) or desc (descending) defaulting to asc.","type":"string"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object500"}}}},"x-examples":[{"resource":"Roles","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/roles","description":"List roles visible to the current user","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/roles","request_body":null,"request_headers":{"Content-Type":"application/json","Authorization":"Bearer Fc8UWP9XvtFfswTIBlY1NQjtMI1zrry98NGOSmK1kSg","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 1,\n \"name\": \"Standard Data Management\",\n \"slug\": \"sdm\",\n \"description\": null\n },\n {\n \"id\": 2,\n \"name\": \"Civis Staff\",\n \"slug\": \"cstaff\",\n \"description\": null\n },\n {\n \"id\": 3,\n \"name\": \"User Creator\",\n \"slug\": \"uc\",\n \"description\": null\n },\n {\n \"id\": 4,\n \"name\": \"Group Creator\",\n \"slug\": \"gc\",\n \"description\": null\n },\n {\n \"id\": 5,\n \"name\": \"User Maintenance\",\n \"slug\": \"um\",\n \"description\": null\n },\n {\n \"id\": 6,\n \"name\": \"Org Group Manager Override\",\n \"slug\": \"ogmo\",\n \"description\": null\n },\n {\n \"id\": 7,\n \"name\": \"Can Enable Superadmin Mode\",\n \"slug\": \"cesm\",\n \"description\": null\n },\n {\n \"id\": 8,\n \"name\": \"Table Tag Admin\",\n \"slug\": \"tta\",\n \"description\": null\n },\n {\n \"id\": 9,\n \"name\": \"Report Viewer\",\n \"slug\": \"rv\",\n \"description\": null\n },\n {\n \"id\": 10,\n \"name\": \"Auto-Grant Trusted\",\n \"slug\": \"agt\",\n \"description\": null\n },\n {\n \"id\": 11,\n \"name\": \"Standard User\",\n \"slug\": \"standard_user\",\n \"description\": null\n },\n {\n \"id\": 12,\n \"name\": \"Custom Visualizations\",\n \"slug\": \"cusviz\",\n \"description\": null\n },\n {\n \"id\": 13,\n \"name\": \"Modeling\",\n \"slug\": \"mdl\",\n \"description\": null\n },\n {\n \"id\": 14,\n \"name\": \"Custom Scripts\",\n \"slug\": \"cusscr\",\n \"description\": null\n },\n {\n \"id\": 15,\n \"name\": \"Team Admin\",\n \"slug\": \"team_admin\",\n \"description\": null\n },\n {\n \"id\": 16,\n \"name\": \"Organization Admin\",\n \"slug\": \"org_admin\",\n \"description\": null\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","X-Pagination-Per-Page":"50","Access-Control-Expose-Headers":"X-Pagination-Per-Page, X-Pagination-Current-Page, X-Pagination-Total-Pages, X-Pagination-Total-Entries","X-Pagination-Current-Page":"1","X-Pagination-Total-Pages":"1","X-Pagination-Total-Entries":"16","Content-Type":"application/json; charset=utf-8","ETag":"W/\"ce308b10d644a2ea23ce547a8b772ee0\"","X-Request-Id":"bfa66837-2167-4db6-a8b8-f705995f71b7","X-Runtime":"0.016044","Content-Length":"1112"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/roles\" -X GET \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer Fc8UWP9XvtFfswTIBlY1NQjtMI1zrry98NGOSmK1kSg\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/scripts/types":{"get":{"summary":"List available script types","description":null,"deprecated":false,"parameters":[],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object519"}}}},"x-examples":[{"resource":"Scripts","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/scripts/types","description":"List all types","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/scripts/types","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer BCtFanjgno2HEk_PPq7PviCzKIzVi0fEOqRsB19oGKs","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"name\": \"sql\"\n },\n {\n \"name\": \"python3\"\n },\n {\n \"name\": \"javascript\"\n },\n {\n \"name\": \"r\"\n },\n {\n \"name\": \"containers\"\n },\n {\n \"name\": \"dbt\"\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"613065e885b2eb4bec91adf8a3227d61\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"cfdc8282-3a13-4179-8aa6-2622d6422bf8","X-Runtime":"0.045219","Content-Length":"107"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/scripts/types\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer BCtFanjgno2HEk_PPq7PviCzKIzVi0fEOqRsB19oGKs\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/scripts/{id}/history":{"get":{"summary":"Get the run history and outputs of this script","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID for the script.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object520"}}},"x-examples":[{"resource":"Scripts","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/scripts/:id/history","description":"View a script's run history","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/scripts/2275/history","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer 6bAGG4tfoDtZ2OZuvlNiTtjjLYDvEI3uJxcbk_2tdsM","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 193,\n \"sqlId\": 2275,\n \"state\": \"failed\",\n \"isCancelRequested\": false,\n \"finishedAt\": \"2024-12-03T20:45:44.000Z\",\n \"error\": \"silly error\",\n \"output\": [\n\n ]\n },\n {\n \"id\": 192,\n \"sqlId\": 2275,\n \"state\": \"succeeded\",\n \"isCancelRequested\": false,\n \"finishedAt\": \"2024-12-03T19:45:44.000Z\",\n \"error\": null,\n \"output\": [\n {\n \"outputName\": \"output_file\",\n \"fileId\": 45,\n \"path\": \"http://aws/file.csv\"\n }\n ]\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"49359aa3c394e8a209660f3542a890ef\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"acb12ec3-d0ef-4f6f-b205-4d934a60f511","X-Runtime":"0.033998","Content-Length":"346"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/scripts/2275/history\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer 6bAGG4tfoDtZ2OZuvlNiTtjjLYDvEI3uJxcbk_2tdsM\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/scripts/":{"post":{"summary":"Create a script (legacy)","description":"Deprecated endpoint for creating SQL Scripts. Please use POST scripts/sql instead.","deprecated":false,"parameters":[{"name":"Object522","in":"body","schema":{"$ref":"#/definitions/Object522"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object524"}}},"x-examples":[{"resource":"Scripts","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/scripts","description":"Create a script","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/scripts","request_body":"{\n \"name\": \"My new script\",\n \"remote_host_id\": 221,\n \"credential_id\": 604,\n \"sql\": \"select * from tablename\",\n \"notifications\": {\n \"success_email_addresses\": \"test1@civisanalytics.com\",\n \"failure_email_addresses\": \"test2@civisanalytics.com\"\n }\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer 5sQV_7CbsTdWM4VCzbO48DwKWyCpBvpexxPHaO5Et1k","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 2284,\n \"name\": \"My new script\",\n \"type\": \"SQL\",\n \"createdAt\": \"2024-12-03T19:45:45.000Z\",\n \"updatedAt\": \"2024-12-03T19:45:45.000Z\",\n \"author\": {\n \"id\": 2338,\n \"name\": \"User devuserfactory1888 1888\",\n \"username\": \"devuserfactory1888\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"state\": \"idle\",\n \"finishedAt\": null,\n \"category\": \"script\",\n \"projects\": [\n\n ],\n \"parentId\": null,\n \"userContext\": \"runner\",\n \"params\": [\n\n ],\n \"arguments\": {\n },\n \"isTemplate\": false,\n \"publishedAsTemplateId\": null,\n \"fromTemplateId\": null,\n \"templateDependentsCount\": null,\n \"templateScriptName\": null,\n \"links\": {\n \"details\": \"api.civis.test/scripts/sql/2284\",\n \"runs\": \"api.civis.test/scripts/sql/2284/runs\"\n },\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n },\n \"notifications\": {\n \"urls\": [\n\n ],\n \"successEmailSubject\": null,\n \"successEmailBody\": null,\n \"successEmailAddresses\": [\n \"test1@civisanalytics.com\"\n ],\n \"successEmailFromName\": null,\n \"successEmailReplyTo\": null,\n \"failureEmailAddresses\": [\n \"test2@civisanalytics.com\"\n ],\n \"stallWarningMinutes\": null,\n \"successOn\": true,\n \"failureOn\": true\n },\n \"runningAs\": {\n \"id\": 2338,\n \"name\": \"User devuserfactory1888 1888\",\n \"username\": \"devuserfactory1888\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"nextRunAt\": null,\n \"timeZone\": \"America/Chicago\",\n \"lastRun\": null,\n \"myPermissionLevel\": \"manage\",\n \"hidden\": false,\n \"targetProjectId\": null,\n \"archived\": false,\n \"templateScriptId\": null\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"b9776c5fa2b5196b3619e77fb107bb38\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"7fcaecf7-a5e3-4e13-a7af-9cd21367e6d3","X-Runtime":"0.105227","Content-Length":"1345"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/scripts\" -d '{\"name\":\"My new script\",\"remote_host_id\":221,\"credential_id\":604,\"sql\":\"select * from tablename\",\"notifications\":{\"success_email_addresses\":\"test1@civisanalytics.com\",\"failure_email_addresses\":\"test2@civisanalytics.com\"}}' -X POST \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer 5sQV_7CbsTdWM4VCzbO48DwKWyCpBvpexxPHaO5Et1k\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Scripts","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/scripts","description":"Create a script with params","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/scripts","request_body":"{\n \"name\": \"My new template script\",\n \"remote_host_id\": 224,\n \"credential_id\": 613,\n \"params\": [\n {\n \"name\": \"numb\",\n \"label\": \"Number\",\n \"description\": null,\n \"type\": \"integer\",\n \"required\": true,\n \"value\": null,\n \"default\": null,\n \"allowedValues\": []\n }\n ],\n \"arguments\": {\n \"numb\": 2\n },\n \"sql\": \"Select {{ numb }};\"\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer PbXz4VXVNH6UyquuhPKfkjBI4AuC8u5FlLgargzwEr4","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 2291,\n \"name\": \"My new template script\",\n \"type\": \"SQL\",\n \"createdAt\": \"2024-12-03T19:45:46.000Z\",\n \"updatedAt\": \"2024-12-03T19:45:46.000Z\",\n \"author\": {\n \"id\": 2345,\n \"name\": \"User devuserfactory1894 1894\",\n \"username\": \"devuserfactory1894\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"state\": \"idle\",\n \"finishedAt\": null,\n \"category\": \"script\",\n \"projects\": [\n\n ],\n \"parentId\": null,\n \"userContext\": \"runner\",\n \"params\": [\n {\n \"name\": \"numb\",\n \"label\": \"Number\",\n \"description\": null,\n \"type\": \"integer\",\n \"required\": true,\n \"value\": null,\n \"default\": null,\n \"allowedValues\": [\n\n ]\n }\n ],\n \"arguments\": {\n \"numb\": 2\n },\n \"isTemplate\": false,\n \"publishedAsTemplateId\": null,\n \"fromTemplateId\": null,\n \"templateDependentsCount\": null,\n \"templateScriptName\": null,\n \"links\": {\n \"details\": \"api.civis.test/scripts/sql/2291\",\n \"runs\": \"api.civis.test/scripts/sql/2291/runs\"\n },\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n },\n \"notifications\": {\n \"urls\": [\n\n ],\n \"successEmailSubject\": null,\n \"successEmailBody\": null,\n \"successEmailAddresses\": [\n\n ],\n \"successEmailFromName\": null,\n \"successEmailReplyTo\": null,\n \"failureEmailAddresses\": [\n\n ],\n \"stallWarningMinutes\": null,\n \"successOn\": true,\n \"failureOn\": true\n },\n \"runningAs\": {\n \"id\": 2345,\n \"name\": \"User devuserfactory1894 1894\",\n \"username\": \"devuserfactory1894\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"nextRunAt\": null,\n \"timeZone\": \"America/Chicago\",\n \"lastRun\": null,\n \"myPermissionLevel\": \"manage\",\n \"hidden\": false,\n \"targetProjectId\": null,\n \"archived\": false,\n \"templateScriptId\": null\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"af803e54c7e098b260d1bd0990db63af\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"0f0d57bc-1339-42d0-8f1a-0307d1d7c9ba","X-Runtime":"0.096431","Content-Length":"1441"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/scripts\" -d '{\"name\":\"My new template script\",\"remote_host_id\":224,\"credential_id\":613,\"params\":[{\"name\":\"numb\",\"label\":\"Number\",\"description\":null,\"type\":\"integer\",\"required\":true,\"value\":null,\"default\":null,\"allowedValues\":[]}],\"arguments\":{\"numb\":2},\"sql\":\"Select {{ numb }};\"}' -X POST \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer PbXz4VXVNH6UyquuhPKfkjBI4AuC8u5FlLgargzwEr4\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"get":{"summary":"List Scripts","description":null,"deprecated":false,"parameters":[{"name":"type","in":"query","required":false,"description":"If specified, return items of these types. The valid types are sql, python3, javascript, r, containers, and dbt.","type":"string"},{"name":"category","in":"query","required":false,"description":"A job category for filtering scripts. Must be one of script, import, export, and enhancement.","type":"string"},{"name":"author","in":"query","required":false,"description":"If specified, return items from any of these authors. It accepts a comma-separated list of user IDs.","type":"string"},{"name":"status","in":"query","required":false,"description":"If specified, returns items with one of these statuses. It accepts a comma-separated list, possible values are 'running', 'failed', 'succeeded', 'idle', 'scheduled'.","type":"string"},{"name":"hidden","in":"query","required":false,"description":"If specified to be true, returns hidden items. Defaults to false, returning non-hidden items.","type":"boolean"},{"name":"archived","in":"query","required":false,"description":"The archival status of the requested item(s).","type":"string"},{"name":"limit","in":"query","required":false,"description":"Number of results to return. Defaults to 20. Maximum allowed is 50.","type":"integer"},{"name":"page_num","in":"query","required":false,"description":"Page number of the results to return. Defaults to the first page, 1.","type":"integer"},{"name":"order","in":"query","required":false,"description":"The field on which to order the result set. Defaults to updated_at. Must be one of: updated_at, name, created_at, last_run.updated_at.","type":"string"},{"name":"order_dir","in":"query","required":false,"description":"Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc.","type":"string"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object541"}}}},"x-examples":[{"resource":"Scripts","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/scripts","description":"List all scripts","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/scripts","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer J67XqylSKznwsEm3CEGrOuWu5twgecz1yAe2FKOjRKw","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 2014,\n \"name\": \"Script #2014\",\n \"type\": \"SQL\",\n \"createdAt\": \"2024-12-03T19:45:18.000Z\",\n \"updatedAt\": \"2024-12-03T19:45:18.000Z\",\n \"author\": {\n \"id\": 2086,\n \"name\": \"User devuserfactory1677 1677\",\n \"username\": \"devuserfactory1677\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"state\": \"idle\",\n \"finishedAt\": null,\n \"projects\": [\n\n ],\n \"parentId\": null,\n \"isTemplate\": false,\n \"fromTemplateId\": null,\n \"links\": {\n \"details\": \"api.civis.test/scripts/sql/2014\",\n \"runs\": \"api.civis.test/scripts/sql/2014/runs\"\n },\n \"timeZone\": \"America/Chicago\",\n \"lastRun\": null,\n \"archived\": false,\n \"templateScriptId\": null\n },\n {\n \"id\": 2012,\n \"name\": \"Script #2012\",\n \"type\": \"SQL\",\n \"createdAt\": \"2024-12-03T19:45:18.000Z\",\n \"updatedAt\": \"2024-12-03T19:45:17.000Z\",\n \"author\": {\n \"id\": 2086,\n \"name\": \"User devuserfactory1677 1677\",\n \"username\": \"devuserfactory1677\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"state\": \"running\",\n \"finishedAt\": \"2024-12-03T19:45:18.000Z\",\n \"projects\": [\n {\n \"id\": 6,\n \"name\": \"Test Project\"\n }\n ],\n \"parentId\": null,\n \"isTemplate\": false,\n \"fromTemplateId\": null,\n \"links\": {\n \"details\": \"api.civis.test/scripts/sql/2012\",\n \"runs\": \"api.civis.test/scripts/sql/2012/runs\"\n },\n \"timeZone\": \"America/Chicago\",\n \"lastRun\": {\n \"id\": 174,\n \"state\": \"running\",\n \"createdAt\": \"2024-12-03T19:45:18.000Z\",\n \"startedAt\": null,\n \"finishedAt\": \"2024-12-03T19:45:18.000Z\",\n \"error\": null\n },\n \"archived\": false,\n \"templateScriptId\": null\n },\n {\n \"id\": 2017,\n \"name\": \"Script #2017\",\n \"type\": \"Container\",\n \"createdAt\": \"2024-12-03T19:45:18.000Z\",\n \"updatedAt\": \"2024-12-03T19:44:18.000Z\",\n \"author\": {\n \"id\": 2086,\n \"name\": \"User devuserfactory1677 1677\",\n \"username\": \"devuserfactory1677\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"state\": \"idle\",\n \"finishedAt\": null,\n \"projects\": [\n\n ],\n \"parentId\": null,\n \"isTemplate\": false,\n \"fromTemplateId\": null,\n \"links\": {\n \"details\": \"api.civis.test/scripts/containers/2017\",\n \"runs\": \"api.civis.test/scripts/containers/2017/runs\"\n },\n \"timeZone\": \"America/Chicago\",\n \"lastRun\": null,\n \"archived\": false,\n \"templateScriptId\": null\n },\n {\n \"id\": 2020,\n \"name\": \"Script #2020\",\n \"type\": \"Python\",\n \"createdAt\": \"2024-12-03T19:45:18.000Z\",\n \"updatedAt\": \"2024-12-03T19:43:18.000Z\",\n \"author\": {\n \"id\": 2086,\n \"name\": \"User devuserfactory1677 1677\",\n \"username\": \"devuserfactory1677\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"state\": \"idle\",\n \"finishedAt\": null,\n \"projects\": [\n\n ],\n \"parentId\": null,\n \"isTemplate\": false,\n \"fromTemplateId\": null,\n \"links\": {\n \"details\": \"api.civis.test/scripts/python3/2020\",\n \"runs\": \"api.civis.test/scripts/python3/2020/runs\"\n },\n \"timeZone\": \"America/Chicago\",\n \"lastRun\": null,\n \"archived\": false,\n \"templateScriptId\": null\n },\n {\n \"id\": 2023,\n \"name\": \"Script #2023\",\n \"type\": \"R\",\n \"createdAt\": \"2024-12-03T19:45:18.000Z\",\n \"updatedAt\": \"2024-12-03T19:42:18.000Z\",\n \"author\": {\n \"id\": 2086,\n \"name\": \"User devuserfactory1677 1677\",\n \"username\": \"devuserfactory1677\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"state\": \"idle\",\n \"finishedAt\": null,\n \"projects\": [\n\n ],\n \"parentId\": null,\n \"isTemplate\": false,\n \"fromTemplateId\": null,\n \"links\": {\n \"details\": \"api.civis.test/scripts/r/2023\",\n \"runs\": \"api.civis.test/scripts/r/2023/runs\"\n },\n \"timeZone\": \"America/Chicago\",\n \"lastRun\": null,\n \"archived\": false,\n \"templateScriptId\": null\n },\n {\n \"id\": 2025,\n \"name\": \"Script #2025\",\n \"type\": \"JavaScript\",\n \"createdAt\": \"2024-12-03T19:45:19.000Z\",\n \"updatedAt\": \"2024-12-03T19:41:18.000Z\",\n \"author\": {\n \"id\": 2086,\n \"name\": \"User devuserfactory1677 1677\",\n \"username\": \"devuserfactory1677\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"state\": \"idle\",\n \"finishedAt\": null,\n \"projects\": [\n\n ],\n \"parentId\": null,\n \"isTemplate\": false,\n \"fromTemplateId\": null,\n \"links\": {\n \"details\": \"api.civis.test/scripts/javascript/2025\",\n \"runs\": \"api.civis.test/scripts/javascript/2025/runs\"\n },\n \"timeZone\": \"America/Chicago\",\n \"lastRun\": null,\n \"archived\": false,\n \"templateScriptId\": null\n },\n {\n \"id\": 2028,\n \"name\": \"Script #2028\",\n \"type\": \"Python\",\n \"createdAt\": \"2024-12-03T19:45:19.000Z\",\n \"updatedAt\": \"2024-12-03T19:40:19.000Z\",\n \"author\": {\n \"id\": 2098,\n \"name\": \"User devuserfactory1689 1689\",\n \"username\": \"devuserfactory1689\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"state\": \"idle\",\n \"finishedAt\": null,\n \"projects\": [\n\n ],\n \"parentId\": null,\n \"isTemplate\": false,\n \"fromTemplateId\": null,\n \"links\": {\n \"details\": \"api.civis.test/scripts/python3/2028\",\n \"runs\": \"api.civis.test/scripts/python3/2028/runs\"\n },\n \"timeZone\": \"America/Chicago\",\n \"lastRun\": null,\n \"archived\": false,\n \"templateScriptId\": null\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","X-Pagination-Per-Page":"20","Access-Control-Expose-Headers":"X-Pagination-Per-Page, X-Pagination-Current-Page, X-Pagination-Total-Pages, X-Pagination-Total-Entries","X-Pagination-Current-Page":"1","X-Pagination-Total-Pages":"1","X-Pagination-Total-Entries":"7","Content-Type":"application/json; charset=utf-8","ETag":"W/\"325b141b9d40f7b48852532064abbb10\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"825e6dae-368f-44e6-93da-c2eed8bf384d","X-Runtime":"0.072037","Content-Length":"3991"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/scripts\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer J67XqylSKznwsEm3CEGrOuWu5twgecz1yAe2FKOjRKw\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Scripts","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/scripts","description":"Filter scripts by author","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/scripts?author=2115","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer 6rqtXiOB1cflOrRsXytywh-vp13YCZr0K9cLfOt9x_4","Host":"api.civis.test","Cookie":""},"request_query_parameters":{"author":"2115"},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 2048,\n \"name\": \"Script #2048\",\n \"type\": \"Python\",\n \"createdAt\": \"2024-12-03T19:45:20.000Z\",\n \"updatedAt\": \"2024-12-03T19:40:20.000Z\",\n \"author\": {\n \"id\": 2115,\n \"name\": \"User devuserfactory1705 1705\",\n \"username\": \"devuserfactory1705\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"state\": \"idle\",\n \"finishedAt\": null,\n \"projects\": [\n\n ],\n \"parentId\": null,\n \"isTemplate\": false,\n \"fromTemplateId\": null,\n \"links\": {\n \"details\": \"api.civis.test/scripts/python3/2048\",\n \"runs\": \"api.civis.test/scripts/python3/2048/runs\"\n },\n \"timeZone\": \"America/Chicago\",\n \"lastRun\": null,\n \"archived\": false,\n \"templateScriptId\": null\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","X-Pagination-Per-Page":"20","Access-Control-Expose-Headers":"X-Pagination-Per-Page, X-Pagination-Current-Page, X-Pagination-Total-Pages, X-Pagination-Total-Entries","X-Pagination-Current-Page":"1","X-Pagination-Total-Pages":"1","X-Pagination-Total-Entries":"1","Content-Type":"application/json; charset=utf-8","ETag":"W/\"da0b7368d6fe3973ac5b26f19cacf577\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"ec5f1406-250f-403b-9165-8acf9fc68600","X-Runtime":"0.033179","Content-Length":"547"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/scripts?author=2115\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer 6rqtXiOB1cflOrRsXytywh-vp13YCZr0K9cLfOt9x_4\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Scripts","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/scripts","description":"Filter scripts by type","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/scripts?type=r","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer Kj3RI-nXjlK46nWJT7QdESl28vXUUjztMreaDLYPY1U","Host":"api.civis.test","Cookie":""},"request_query_parameters":{"type":"r"},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 2063,\n \"name\": \"Script #2063\",\n \"type\": \"R\",\n \"createdAt\": \"2024-12-03T19:45:22.000Z\",\n \"updatedAt\": \"2024-12-03T19:42:22.000Z\",\n \"author\": {\n \"id\": 2120,\n \"name\": \"User devuserfactory1709 1709\",\n \"username\": \"devuserfactory1709\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"state\": \"idle\",\n \"finishedAt\": null,\n \"projects\": [\n\n ],\n \"parentId\": null,\n \"isTemplate\": false,\n \"fromTemplateId\": null,\n \"links\": {\n \"details\": \"api.civis.test/scripts/r/2063\",\n \"runs\": \"api.civis.test/scripts/r/2063/runs\"\n },\n \"timeZone\": \"America/Chicago\",\n \"lastRun\": null,\n \"archived\": false,\n \"templateScriptId\": null\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","X-Pagination-Per-Page":"20","Access-Control-Expose-Headers":"X-Pagination-Per-Page, X-Pagination-Current-Page, X-Pagination-Total-Pages, X-Pagination-Total-Entries","X-Pagination-Current-Page":"1","X-Pagination-Total-Pages":"1","X-Pagination-Total-Entries":"1","Content-Type":"application/json; charset=utf-8","ETag":"W/\"60fe8e60297dfd0af45f8d9361f6f25f\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"26c393c9-f7da-46eb-9b7c-20dc3c72c912","X-Runtime":"0.032498","Content-Length":"530"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/scripts?type=r\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer Kj3RI-nXjlK46nWJT7QdESl28vXUUjztMreaDLYPY1U\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Scripts","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/scripts","description":"Filter scripts by status","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/scripts?status=running","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer U6YEBHkJYyQAdaux40E7zjFvPIKVwuduIdgWCVFbTZQ","Host":"api.civis.test","Cookie":""},"request_query_parameters":{"status":"running"},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 2072,\n \"name\": \"Script #2072\",\n \"type\": \"SQL\",\n \"createdAt\": \"2024-12-03T19:45:22.000Z\",\n \"updatedAt\": \"2024-12-03T19:45:22.000Z\",\n \"author\": {\n \"id\": 2137,\n \"name\": \"User devuserfactory1725 1725\",\n \"username\": \"devuserfactory1725\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"state\": \"running\",\n \"finishedAt\": \"2024-12-03T19:45:22.000Z\",\n \"projects\": [\n {\n \"id\": 9,\n \"name\": \"Test Project\"\n }\n ],\n \"parentId\": null,\n \"isTemplate\": false,\n \"fromTemplateId\": null,\n \"links\": {\n \"details\": \"api.civis.test/scripts/sql/2072\",\n \"runs\": \"api.civis.test/scripts/sql/2072/runs\"\n },\n \"timeZone\": \"America/Chicago\",\n \"lastRun\": {\n \"id\": 177,\n \"state\": \"running\",\n \"createdAt\": \"2024-12-03T19:45:22.000Z\",\n \"startedAt\": null,\n \"finishedAt\": \"2024-12-03T19:45:22.000Z\",\n \"error\": null\n },\n \"archived\": false,\n \"templateScriptId\": null\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","X-Pagination-Per-Page":"20","Access-Control-Expose-Headers":"X-Pagination-Per-Page, X-Pagination-Current-Page, X-Pagination-Total-Pages, X-Pagination-Total-Entries","X-Pagination-Current-Page":"1","X-Pagination-Total-Pages":"1","X-Pagination-Total-Entries":"1","Content-Type":"application/json; charset=utf-8","ETag":"W/\"ac1ec961892e938a18947daef72e94dc\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"306beabd-de6a-49fc-93b0-ba1ada606e81","X-Runtime":"0.054492","Content-Length":"724"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/scripts?status=running\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer U6YEBHkJYyQAdaux40E7zjFvPIKVwuduIdgWCVFbTZQ\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Scripts","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/scripts?page_num=1&limit=2","description":"List all scripts ordered by updatedAt desc","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/scripts?page_num=1&limit=2","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer tjmngyqVI2bApfGTET1Ae7YhDEilRUG7ucPtptLrxvg","Host":"api.civis.test","Cookie":""},"request_query_parameters":{"page_num":"1","limit":"2"},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 2098,\n \"name\": \"Script #2098\",\n \"type\": \"SQL\",\n \"createdAt\": \"2024-12-03T19:45:25.000Z\",\n \"updatedAt\": \"2024-12-03T22:45:25.000Z\",\n \"author\": {\n \"id\": 2154,\n \"name\": \"User devuserfactory1741 1741\",\n \"username\": \"devuserfactory1741\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"state\": \"idle\",\n \"finishedAt\": null,\n \"projects\": [\n\n ],\n \"parentId\": null,\n \"isTemplate\": false,\n \"fromTemplateId\": null,\n \"links\": {\n \"details\": \"api.civis.test/scripts/sql/2098\",\n \"runs\": \"api.civis.test/scripts/sql/2098/runs\"\n },\n \"timeZone\": \"America/Chicago\",\n \"lastRun\": null,\n \"archived\": false,\n \"templateScriptId\": null\n },\n {\n \"id\": 2096,\n \"name\": \"Script #2096\",\n \"type\": \"SQL\",\n \"createdAt\": \"2024-12-03T19:45:25.000Z\",\n \"updatedAt\": \"2024-12-03T20:45:24.000Z\",\n \"author\": {\n \"id\": 2154,\n \"name\": \"User devuserfactory1741 1741\",\n \"username\": \"devuserfactory1741\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"state\": \"idle\",\n \"finishedAt\": null,\n \"projects\": [\n\n ],\n \"parentId\": null,\n \"isTemplate\": false,\n \"fromTemplateId\": null,\n \"links\": {\n \"details\": \"api.civis.test/scripts/sql/2096\",\n \"runs\": \"api.civis.test/scripts/sql/2096/runs\"\n },\n \"timeZone\": \"America/Chicago\",\n \"lastRun\": null,\n \"archived\": false,\n \"templateScriptId\": null\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","X-Pagination-Per-Page":"2","Access-Control-Expose-Headers":"X-Pagination-Per-Page, X-Pagination-Current-Page, X-Pagination-Total-Pages, X-Pagination-Total-Entries","X-Pagination-Current-Page":"1","X-Pagination-Total-Pages":"2","X-Pagination-Total-Entries":"4","Content-Type":"application/json; charset=utf-8","ETag":"W/\"d1f25ba7711200b66e21efec889086f1\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"baf15ff7-5bdd-44bb-b355-b160424321a7","X-Runtime":"0.038899","Content-Length":"1071"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/scripts?page_num=1&limit=2\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer tjmngyqVI2bApfGTET1Ae7YhDEilRUG7ucPtptLrxvg\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/scripts/{id}/run":{"post":{"summary":"Run a SQL script (legacy)","description":"Deprecated. Please use POST scripts/sql/:id/run instead.","deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID for the script.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":[{"resource":"Scripts","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/scripts/:id/run","description":"Run a script","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/scripts/2576/run","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer xcSlNzVRS1TdeaqGtAT95YndeYXZbBaanklR-bbVYd8","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":204,"response_status_text":"No Content","response_body":null,"response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"9aabd72f-4f29-404a-a917-f5c31844879d","X-Runtime":"0.166105"},"response_content_type":null,"curl":"curl \"api.civis.testhttp://api.civis.test/scripts/2576/run\" -d '' -X POST \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer xcSlNzVRS1TdeaqGtAT95YndeYXZbBaanklR-bbVYd8\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Scripts","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/scripts/:id/run","description":"Attempting to queue a running job returns an error","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/scripts/2582/run","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer 7rHqLZ3wlifGhkvP0JHts5nsgHfBbEXeXfLhCTvhlHo","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":409,"response_status_text":"Conflict","response_body":"{\n \"error\": \"conflict\",\n \"errorDescription\": \"The script cannot be queued because it is already active.\",\n \"code\": 409\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"e136dfed-75ee-425b-9fa8-b4b605c8ac6e","X-Runtime":"0.024608","Content-Length":"110"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/scripts/2582/run\" -d '' -X POST \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer 7rHqLZ3wlifGhkvP0JHts5nsgHfBbEXeXfLhCTvhlHo\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/scripts/{id}/cancel":{"post":{"summary":"Cancel a run","description":"Cancel a run.","deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the job.","type":"integer"}],"responses":{"202":{"description":"success","schema":{"$ref":"#/definitions/Object528"}}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/{id}":{"delete":{"summary":"Archive a script (deprecated, use archive endpoints instead)","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID for the script.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null},"get":{"summary":"Get details about a SQL script (legacy)","description":"Deprecated. Please use GET scripts/sql/:id instead.","deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID for the script.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object575"}}},"x-examples":[{"resource":"Scripts","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/scripts/:id","description":"View a script's details","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/scripts/2150","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer mjOYNwjFT1L_66u5iScTY_-W-2aBVTLCnBbAfkuhMjY","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 2150,\n \"name\": \"Script #2150\",\n \"type\": \"JobTypes::SqlRunner\",\n \"createdAt\": \"2024-12-03T19:45:30.000Z\",\n \"updatedAt\": \"2024-12-03T19:45:30.000Z\",\n \"author\": {\n \"id\": 2209,\n \"name\": \"User devuserfactory1783 1783\",\n \"username\": \"devuserfactory1783\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"state\": \"running\",\n \"finishedAt\": \"2024-12-03T19:45:30.000Z\",\n \"category\": \"script\",\n \"projects\": [\n {\n \"id\": 13,\n \"name\": \"Test Project\"\n }\n ],\n \"parentId\": null,\n \"userContext\": \"runner\",\n \"params\": [\n {\n \"name\": \"id\",\n \"label\": \"ID\",\n \"description\": null,\n \"type\": \"integer\",\n \"required\": true,\n \"value\": null,\n \"default\": null,\n \"allowedValues\": [\n\n ]\n },\n {\n \"name\": \"state\",\n \"label\": \"State\",\n \"description\": null,\n \"type\": \"string\",\n \"required\": true,\n \"value\": null,\n \"default\": null,\n \"allowedValues\": [\n\n ]\n },\n {\n \"name\": \"table\",\n \"label\": \"Table\",\n \"description\": null,\n \"type\": \"string\",\n \"required\": false,\n \"value\": null,\n \"default\": null,\n \"allowedValues\": [\n\n ]\n },\n {\n \"name\": \"abool\",\n \"label\": \"A Bool\",\n \"description\": null,\n \"type\": \"bool\",\n \"required\": false,\n \"value\": null,\n \"default\": false,\n \"allowedValues\": [\n\n ]\n },\n {\n \"name\": \"afloat\",\n \"label\": \"A Float\",\n \"description\": null,\n \"type\": \"float\",\n \"required\": false,\n \"value\": null,\n \"default\": null,\n \"allowedValues\": [\n\n ]\n },\n {\n \"name\": \"optionalstr\",\n \"label\": \"Optional String\",\n \"description\": null,\n \"type\": \"string\",\n \"required\": false,\n \"value\": null,\n \"default\": null,\n \"allowedValues\": [\n\n ]\n },\n {\n \"name\": \"cred\",\n \"label\": \"Cred\",\n \"description\": null,\n \"type\": \"credential_redshift\",\n \"required\": false,\n \"value\": null,\n \"default\": null,\n \"allowedValues\": [\n\n ]\n },\n {\n \"name\": \"cred2\",\n \"label\": \"Cred AWS\",\n \"description\": null,\n \"type\": \"credential_aws\",\n \"required\": false,\n \"value\": null,\n \"default\": null,\n \"allowedValues\": [\n\n ]\n }\n ],\n \"arguments\": {\n \"id\": 2,\n \"state\": \"IL\",\n \"table\": \"test.test\"\n },\n \"isTemplate\": false,\n \"publishedAsTemplateId\": null,\n \"fromTemplateId\": null,\n \"templateDependentsCount\": null,\n \"templateScriptName\": null,\n \"links\": {\n \"details\": \"api.civis.test/scripts/sql/2150\",\n \"runs\": \"api.civis.test/scripts/sql/2150/runs\"\n },\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n },\n \"notifications\": {\n \"urls\": [\n\n ],\n \"successEmailSubject\": \"success email subject\",\n \"successEmailBody\": \"success_email_template\",\n \"successEmailAddresses\": [\n \"script_spec_user@civisanalytics.com\"\n ],\n \"successEmailFromName\": null,\n \"successEmailReplyTo\": null,\n \"failureEmailAddresses\": [\n \"script_spec_user@civisanalytics.com\"\n ],\n \"stallWarningMinutes\": null,\n \"successOn\": true,\n \"failureOn\": true\n },\n \"runningAs\": {\n \"id\": 2209,\n \"name\": \"User devuserfactory1783 1783\",\n \"username\": \"devuserfactory1783\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"nextRunAt\": null,\n \"timeZone\": \"America/Chicago\",\n \"lastRun\": {\n \"id\": 181,\n \"state\": \"running\",\n \"createdAt\": \"2024-12-03T19:45:30.000Z\",\n \"startedAt\": null,\n \"finishedAt\": \"2024-12-03T19:45:30.000Z\",\n \"error\": null\n },\n \"myPermissionLevel\": \"manage\",\n \"hidden\": false,\n \"targetProjectId\": null,\n \"archived\": false,\n \"sql\": \"SELECT * FROM table LIMIT 10;\",\n \"expandedArguments\": {\n \"id\": 2,\n \"state\": \"IL\",\n \"state.literal\": \"'IL'\",\n \"state.identifier\": \"\\\"IL\\\"\",\n \"state.shell_escaped\": \"IL\",\n \"table\": \"test.test\",\n \"table.literal\": \"'test.test'\",\n \"table.identifier\": \"\\\"test.test\\\"\",\n \"table.shell_escaped\": \"test.test\",\n \"abool\": false,\n \"afloat\": 0,\n \"optionalstr\": \"\",\n \"optionalstr.literal\": \"''\",\n \"optionalstr.identifier\": \"\\\"\\\"\",\n \"optionalstr.shell_escaped\": \"''\",\n \"cred.id\": \"\",\n \"cred.username\": \"\",\n \"cred.password\": \"\",\n \"cred2.id\": \"\",\n \"cred2.access_key_id\": \"\",\n \"cred2.secret_access_key\": \"\"\n },\n \"templateScriptId\": null\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"1cf20be71b47205997d2ae0a0b55bf3b\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"6fa2180d-12f1-4554-bc3d-7cc5f0433cd8","X-Runtime":"0.046007","Content-Length":"3267"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/scripts/2150\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer mjOYNwjFT1L_66u5iScTY_-W-2aBVTLCnBbAfkuhMjY\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Scripts","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/scripts/:script_dependent_id","description":"View a script's details that is a template dependent","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/scripts/2166","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer APsCbI3VgF3J4SGI-4JsHircKiKRFWDvJv4w_JCrffQ","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 2166,\n \"name\": \"awesome sql template #2166\",\n \"type\": \"JobTypes::SqlRunner\",\n \"createdAt\": \"2024-12-03T19:45:32.000Z\",\n \"updatedAt\": \"2024-12-03T19:45:32.000Z\",\n \"author\": {\n \"id\": 2216,\n \"name\": \"User devuserfactory1789 1789\",\n \"username\": \"devuserfactory1789\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"state\": \"idle\",\n \"finishedAt\": null,\n \"category\": \"script\",\n \"projects\": [\n\n ],\n \"parentId\": null,\n \"userContext\": \"runner\",\n \"params\": [\n {\n \"name\": \"id\",\n \"label\": \"ID\",\n \"description\": null,\n \"type\": \"integer\",\n \"required\": true,\n \"value\": null,\n \"default\": null,\n \"allowedValues\": [\n\n ]\n },\n {\n \"name\": \"state\",\n \"label\": \"State\",\n \"description\": null,\n \"type\": \"string\",\n \"required\": true,\n \"value\": null,\n \"default\": null,\n \"allowedValues\": [\n\n ]\n },\n {\n \"name\": \"table\",\n \"label\": \"Table\",\n \"description\": null,\n \"type\": \"string\",\n \"required\": false,\n \"value\": null,\n \"default\": null,\n \"allowedValues\": [\n\n ]\n }\n ],\n \"arguments\": {\n \"id\": 2,\n \"state\": \"IL\",\n \"table\": \"test.test\"\n },\n \"isTemplate\": false,\n \"publishedAsTemplateId\": null,\n \"fromTemplateId\": 161,\n \"templateDependentsCount\": null,\n \"templateScriptName\": \"Script #2163\",\n \"links\": {\n \"details\": \"api.civis.test/scripts/custom/2166\",\n \"runs\": \"api.civis.test/scripts/custom/2166/runs\"\n },\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n },\n \"notifications\": {\n \"urls\": [\n\n ],\n \"successEmailSubject\": null,\n \"successEmailBody\": null,\n \"successEmailAddresses\": [\n\n ],\n \"successEmailFromName\": null,\n \"successEmailReplyTo\": null,\n \"failureEmailAddresses\": [\n\n ],\n \"stallWarningMinutes\": null,\n \"successOn\": true,\n \"failureOn\": true\n },\n \"runningAs\": {\n \"id\": 2216,\n \"name\": \"User devuserfactory1789 1789\",\n \"username\": \"devuserfactory1789\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"nextRunAt\": null,\n \"timeZone\": \"America/Chicago\",\n \"lastRun\": null,\n \"myPermissionLevel\": \"manage\",\n \"hidden\": false,\n \"targetProjectId\": null,\n \"archived\": false,\n \"sql\": \"select * from {{table}} where id = {{id}} and state = '{{state}}'\",\n \"expandedArguments\": {\n \"id\": 2,\n \"state\": \"IL\",\n \"state.literal\": \"'IL'\",\n \"state.identifier\": \"\\\"IL\\\"\",\n \"state.shell_escaped\": \"IL\",\n \"table\": \"test.test\",\n \"table.literal\": \"'test.test'\",\n \"table.identifier\": \"\\\"test.test\\\"\",\n \"table.shell_escaped\": \"test.test\"\n },\n \"templateScriptId\": null\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"0d69228f5ed2e6333dcca52f5fb60ac6\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"0be48b75-34de-469a-b779-97c6c1b04bd5","X-Runtime":"0.061341","Content-Length":"2077"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/scripts/2166\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer APsCbI3VgF3J4SGI-4JsHircKiKRFWDvJv4w_JCrffQ\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Scripts","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/scripts/:script_template_id","description":"View a script's details that is a template","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/scripts/2176","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer nLqigCCJSE5VplCLpjUQFMAWnBYnZCAjfFZBLHjSORw","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 2176,\n \"name\": \"Script #2176\",\n \"type\": \"JobTypes::SqlRunner\",\n \"createdAt\": \"2024-12-03T19:45:33.000Z\",\n \"updatedAt\": \"2024-12-03T19:45:33.000Z\",\n \"author\": {\n \"id\": 2229,\n \"name\": \"User devuserfactory1799 1799\",\n \"username\": \"devuserfactory1799\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"state\": \"idle\",\n \"finishedAt\": null,\n \"category\": \"script\",\n \"projects\": [\n\n ],\n \"parentId\": null,\n \"userContext\": \"runner\",\n \"params\": [\n {\n \"name\": \"id\",\n \"label\": \"ID\",\n \"description\": null,\n \"type\": \"integer\",\n \"required\": true,\n \"value\": null,\n \"default\": null,\n \"allowedValues\": [\n\n ]\n },\n {\n \"name\": \"state\",\n \"label\": \"State\",\n \"description\": null,\n \"type\": \"string\",\n \"required\": true,\n \"value\": null,\n \"default\": null,\n \"allowedValues\": [\n\n ]\n },\n {\n \"name\": \"table\",\n \"label\": \"Table\",\n \"description\": null,\n \"type\": \"string\",\n \"required\": false,\n \"value\": null,\n \"default\": null,\n \"allowedValues\": [\n\n ]\n }\n ],\n \"arguments\": {\n },\n \"isTemplate\": true,\n \"publishedAsTemplateId\": 162,\n \"fromTemplateId\": null,\n \"templateDependentsCount\": 1,\n \"templateScriptName\": null,\n \"links\": {\n \"details\": \"api.civis.test/scripts/sql/2176\",\n \"runs\": \"api.civis.test/scripts/sql/2176/runs\"\n },\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n },\n \"notifications\": {\n \"urls\": [\n\n ],\n \"successEmailSubject\": null,\n \"successEmailBody\": null,\n \"successEmailAddresses\": [\n\n ],\n \"successEmailFromName\": null,\n \"successEmailReplyTo\": null,\n \"failureEmailAddresses\": [\n\n ],\n \"stallWarningMinutes\": null,\n \"successOn\": true,\n \"failureOn\": true\n },\n \"runningAs\": {\n \"id\": 2229,\n \"name\": \"User devuserfactory1799 1799\",\n \"username\": \"devuserfactory1799\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"nextRunAt\": null,\n \"timeZone\": \"America/Chicago\",\n \"lastRun\": null,\n \"myPermissionLevel\": \"manage\",\n \"hidden\": false,\n \"targetProjectId\": null,\n \"archived\": false,\n \"sql\": \"select * from {{table}} where id = {{id}} and state = '{{state}}'\",\n \"expandedArguments\": {\n \"id\": null,\n \"state\": null,\n \"state.literal\": null,\n \"state.identifier\": null,\n \"state.shell_escaped\": null,\n \"table\": \"\",\n \"table.literal\": \"''\",\n \"table.identifier\": \"\\\"\\\"\",\n \"table.shell_escaped\": \"''\"\n },\n \"templateScriptId\": null\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"d2f6f515dfce665a57570ac91e215bef\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"6b1c06aa-1bbd-4fed-950d-4dd483768672","X-Runtime":"0.059276","Content-Length":"1967"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/scripts/2176\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer nLqigCCJSE5VplCLpjUQFMAWnBYnZCAjfFZBLHjSORw\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/scripts/containers":{"post":{"summary":"Create a container","description":null,"deprecated":false,"parameters":[{"name":"Object529","in":"body","schema":{"$ref":"#/definitions/Object529"},"required":true}],"responses":{"201":{"description":"success","schema":{"$ref":"#/definitions/Object531"}}},"x-examples":[{"resource":"Scripts","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/scripts/containers","description":"Create a container script","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/scripts/containers","request_body":"{\n \"name\": \"My new container script\",\n \"repo_http_uri\": \"github.com/my_repo\",\n \"repo_ref\": \"master\",\n \"docker_command\": \"python3 main.py\",\n \"docker_image_name\": \"civisanalytics/datascience-base\",\n \"docker_image_tag\": \"awesome_tag\",\n \"git_credential_id\": 659,\n \"required_resources\": {\n \"cpu\": 99,\n \"memory\": 98,\n \"disk_space\": 4.0\n },\n \"remote_host_credential_id\": 658\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer GDdH4_xn7K5PHj3lHVUQexmvuEuqwMxJKtgJlClALtU","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":201,"response_status_text":"Created","response_body":"{\n \"id\": 2326,\n \"fromTemplateAliases\": [\n\n ],\n \"name\": \"My new container script\",\n \"type\": \"Container\",\n \"createdAt\": \"2024-12-03T19:45:50.000Z\",\n \"updatedAt\": \"2024-12-03T19:45:50.000Z\",\n \"author\": {\n \"id\": 2380,\n \"name\": \"User devuserfactory1924 1924\",\n \"username\": \"devuserfactory1924\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"state\": \"idle\",\n \"finishedAt\": null,\n \"category\": \"script\",\n \"projects\": [\n\n ],\n \"parentId\": null,\n \"userContext\": \"runner\",\n \"params\": [\n\n ],\n \"arguments\": {\n },\n \"isTemplate\": false,\n \"templateDependentsCount\": null,\n \"publishedAsTemplateId\": null,\n \"fromTemplateId\": null,\n \"templateScriptName\": null,\n \"links\": {\n \"details\": \"api.civis.test/scripts/containers/2326\",\n \"runs\": \"api.civis.test/scripts/containers/2326/runs\"\n },\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n },\n \"notifications\": {\n \"urls\": [\n\n ],\n \"successEmailSubject\": null,\n \"successEmailBody\": null,\n \"successEmailAddresses\": [\n\n ],\n \"successEmailFromName\": null,\n \"successEmailReplyTo\": null,\n \"failureEmailAddresses\": [\n\n ],\n \"stallWarningMinutes\": null,\n \"successOn\": true,\n \"failureOn\": true\n },\n \"runningAs\": {\n \"id\": 2380,\n \"name\": \"User devuserfactory1924 1924\",\n \"username\": \"devuserfactory1924\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"requiredResources\": {\n \"cpu\": 99,\n \"memory\": 98,\n \"diskSpace\": 4.0\n },\n \"repoHttpUri\": \"github.com/my_repo\",\n \"repoRef\": \"master\",\n \"remoteHostCredentialId\": 658,\n \"gitCredentialId\": 659,\n \"dockerCommand\": \"python3 main.py\",\n \"dockerImageName\": \"civisanalytics/datascience-base\",\n \"dockerImageTag\": \"awesome_tag\",\n \"instanceType\": null,\n \"cancelTimeout\": 0,\n \"lastRun\": null,\n \"timeZone\": \"America/Chicago\",\n \"partitionLabel\": null,\n \"myPermissionLevel\": \"manage\",\n \"hidden\": false,\n \"archived\": false,\n \"targetProjectId\": null,\n \"runningAsId\": 2380\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"fae6139a0aa43154953727da7677a33a\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"4aead607-8f8c-4525-9f2e-a3424fe827aa","X-Runtime":"0.099772","Content-Length":"1667"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/scripts/containers\" -d '{\"name\":\"My new container script\",\"repo_http_uri\":\"github.com/my_repo\",\"repo_ref\":\"master\",\"docker_command\":\"python3 main.py\",\"docker_image_name\":\"civisanalytics/datascience-base\",\"docker_image_tag\":\"awesome_tag\",\"git_credential_id\":659,\"required_resources\":{\"cpu\":99,\"memory\":98,\"disk_space\":4.0},\"remote_host_credential_id\":658}' -X POST \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer GDdH4_xn7K5PHj3lHVUQexmvuEuqwMxJKtgJlClALtU\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Scripts","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/scripts/containers","description":"Create a parameterized container script","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/scripts/containers","request_body":"{\n \"name\": \"My new container script\",\n \"params\": [\n {\n \"name\": \"schema\",\n \"label\": \"Schema\",\n \"description\": \"the schema of the table\",\n \"type\": \"string\",\n \"required\": true,\n \"value\": null,\n \"default\": null,\n \"allowedValues\": []\n },\n {\n \"name\": \"table\",\n \"label\": \"Table\",\n \"description\": \"the name of the table\",\n \"type\": \"string\",\n \"required\": true,\n \"value\": null,\n \"default\": null,\n \"allowedValues\": []\n },\n {\n \"name\": \"fixed_cred\",\n \"label\": \"My fixed credential\",\n \"description\": \"A fixed credential\",\n \"type\": \"credential_redshift\",\n \"required\": true,\n \"value\": \"670\",\n \"default\": null,\n \"allowedValues\": []\n },\n {\n \"name\": \"file\",\n \"label\": \"File\",\n \"description\": \"the name of the file\",\n \"type\": \"file\",\n \"required\": true,\n \"value\": null,\n \"default\": null,\n \"allowedValues\": []\n }\n ],\n \"arguments\": {\n \"schema\": \"my_schema\",\n \"table\": \"my_table\",\n \"file\": 54\n },\n \"repo_http_uri\": \"github.com/my_repo\",\n \"repo_ref\": \"master\",\n \"docker_command\": \"python3 main.py\",\n \"docker_image_name\": \"civisanalytics/datascience-base\",\n \"docker_image_tag\": \"awesome_tag\",\n \"git_credential_id\": 671,\n \"user_context\": \"author\",\n \"required_resources\": {\n \"cpu\": 99,\n \"memory\": 98,\n \"disk_space\": 4\n }\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer uiMrT6LwZWPZST3ke8FgQBQJ-I0k5Wo5HwTC_xHZoxE","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":201,"response_status_text":"Created","response_body":"{\n \"id\": 2333,\n \"fromTemplateAliases\": [\n\n ],\n \"name\": \"My new container script\",\n \"type\": \"Container\",\n \"createdAt\": \"2024-12-03T19:45:51.000Z\",\n \"updatedAt\": \"2024-12-03T19:45:51.000Z\",\n \"author\": {\n \"id\": 2387,\n \"name\": \"User devuserfactory1930 1930\",\n \"username\": \"devuserfactory1930\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"state\": \"idle\",\n \"finishedAt\": null,\n \"category\": \"script\",\n \"projects\": [\n\n ],\n \"parentId\": null,\n \"userContext\": \"author\",\n \"params\": [\n {\n \"name\": \"schema\",\n \"label\": \"Schema\",\n \"description\": \"the schema of the table\",\n \"type\": \"string\",\n \"required\": true,\n \"value\": null,\n \"default\": null,\n \"allowedValues\": [\n\n ]\n },\n {\n \"name\": \"table\",\n \"label\": \"Table\",\n \"description\": \"the name of the table\",\n \"type\": \"string\",\n \"required\": true,\n \"value\": null,\n \"default\": null,\n \"allowedValues\": [\n\n ]\n },\n {\n \"name\": \"fixed_cred\",\n \"label\": \"My fixed credential\",\n \"description\": \"A fixed credential\",\n \"type\": \"credential_redshift\",\n \"required\": true,\n \"value\": \"670\",\n \"default\": null,\n \"allowedValues\": [\n\n ]\n },\n {\n \"name\": \"file\",\n \"label\": \"File\",\n \"description\": \"the name of the file\",\n \"type\": \"file\",\n \"required\": true,\n \"value\": null,\n \"default\": null,\n \"allowedValues\": [\n\n ]\n }\n ],\n \"arguments\": {\n \"schema\": \"my_schema\",\n \"table\": \"my_table\",\n \"file\": 54\n },\n \"isTemplate\": false,\n \"templateDependentsCount\": null,\n \"publishedAsTemplateId\": null,\n \"fromTemplateId\": null,\n \"templateScriptName\": null,\n \"links\": {\n \"details\": \"api.civis.test/scripts/containers/2333\",\n \"runs\": \"api.civis.test/scripts/containers/2333/runs\"\n },\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n },\n \"notifications\": {\n \"urls\": [\n\n ],\n \"successEmailSubject\": null,\n \"successEmailBody\": null,\n \"successEmailAddresses\": [\n\n ],\n \"successEmailFromName\": null,\n \"successEmailReplyTo\": null,\n \"failureEmailAddresses\": [\n\n ],\n \"stallWarningMinutes\": null,\n \"successOn\": true,\n \"failureOn\": true\n },\n \"runningAs\": {\n \"id\": 2387,\n \"name\": \"User devuserfactory1930 1930\",\n \"username\": \"devuserfactory1930\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"requiredResources\": {\n \"cpu\": 99,\n \"memory\": 98,\n \"diskSpace\": 4.0\n },\n \"repoHttpUri\": \"github.com/my_repo\",\n \"repoRef\": \"master\",\n \"remoteHostCredentialId\": null,\n \"gitCredentialId\": 671,\n \"dockerCommand\": \"python3 main.py\",\n \"dockerImageName\": \"civisanalytics/datascience-base\",\n \"dockerImageTag\": \"awesome_tag\",\n \"instanceType\": null,\n \"cancelTimeout\": 0,\n \"lastRun\": null,\n \"timeZone\": \"America/Chicago\",\n \"partitionLabel\": null,\n \"myPermissionLevel\": \"manage\",\n \"hidden\": false,\n \"archived\": false,\n \"targetProjectId\": null,\n \"runningAsId\": 2387\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"ba2c2ec78efe0e627115b7cbe39ea2fe\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"548b412a-be42-4ec9-86b0-ec055cd9ba67","X-Runtime":"0.095972","Content-Length":"2345"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/scripts/containers\" -d '{\"name\":\"My new container script\",\"params\":[{\"name\":\"schema\",\"label\":\"Schema\",\"description\":\"the schema of the table\",\"type\":\"string\",\"required\":true,\"value\":null,\"default\":null,\"allowedValues\":[]},{\"name\":\"table\",\"label\":\"Table\",\"description\":\"the name of the table\",\"type\":\"string\",\"required\":true,\"value\":null,\"default\":null,\"allowedValues\":[]},{\"name\":\"fixed_cred\",\"label\":\"My fixed credential\",\"description\":\"A fixed credential\",\"type\":\"credential_redshift\",\"required\":true,\"value\":\"670\",\"default\":null,\"allowedValues\":[]},{\"name\":\"file\",\"label\":\"File\",\"description\":\"the name of the file\",\"type\":\"file\",\"required\":true,\"value\":null,\"default\":null,\"allowedValues\":[]}],\"arguments\":{\"schema\":\"my_schema\",\"table\":\"my_table\",\"file\":54},\"repo_http_uri\":\"github.com/my_repo\",\"repo_ref\":\"master\",\"docker_command\":\"python3 main.py\",\"docker_image_name\":\"civisanalytics/datascience-base\",\"docker_image_tag\":\"awesome_tag\",\"git_credential_id\":671,\"user_context\":\"author\",\"required_resources\":{\"cpu\":99,\"memory\":98,\"disk_space\":4}}' -X POST \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer uiMrT6LwZWPZST3ke8FgQBQJ-I0k5Wo5HwTC_xHZoxE\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Scripts","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/scripts/containers","description":"Create a parameterized container script with defaults","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/scripts/containers","request_body":"{\n \"name\": \"My new container script\",\n \"params\": [\n {\n \"name\": \"schema\",\n \"label\": \"Schema\",\n \"description\": \"the schema of the table\",\n \"type\": \"string\",\n \"required\": false,\n \"value\": null,\n \"default\": \"cool_schema\",\n \"allowedValues\": []\n },\n {\n \"name\": \"table\",\n \"label\": \"Table\",\n \"description\": \"the name of the table\",\n \"type\": \"string\",\n \"required\": false,\n \"value\": null,\n \"default\": \"cool_table\",\n \"allowedValues\": []\n },\n {\n \"name\": \"db\",\n \"label\": \"Database\",\n \"description\": \"the name of the database\",\n \"type\": \"database\",\n \"required\": true,\n \"value\": null,\n \"default\": null,\n \"allowedValues\": []\n }\n ],\n \"arguments\": {\n \"db\": {\n \"database\": 248,\n \"credential\": 683\n }\n },\n \"repo_http_uri\": \"github.com/my_repo\",\n \"repo_ref\": \"master\",\n \"docker_command\": \"python3 main.py\",\n \"docker_image_name\": \"civisanalytics/datascience-base\",\n \"docker_image_tag\": \"awesome_tag\",\n \"git_credential_id\": 684,\n \"required_resources\": {\n \"cpu\": 99,\n \"memory\": 98,\n \"disk_space\": 4\n }\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer evxcvQKM0m_IVkadvzvZf3lkvByeKA29eVdA9jGEfhA","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":201,"response_status_text":"Created","response_body":"{\n \"id\": 2340,\n \"fromTemplateAliases\": [\n\n ],\n \"name\": \"My new container script\",\n \"type\": \"Container\",\n \"createdAt\": \"2024-12-03T19:45:52.000Z\",\n \"updatedAt\": \"2024-12-03T19:45:52.000Z\",\n \"author\": {\n \"id\": 2395,\n \"name\": \"User devuserfactory1936 1936\",\n \"username\": \"devuserfactory1936\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"state\": \"idle\",\n \"finishedAt\": null,\n \"category\": \"script\",\n \"projects\": [\n\n ],\n \"parentId\": null,\n \"userContext\": \"runner\",\n \"params\": [\n {\n \"name\": \"schema\",\n \"label\": \"Schema\",\n \"description\": \"the schema of the table\",\n \"type\": \"string\",\n \"required\": false,\n \"value\": null,\n \"default\": \"cool_schema\",\n \"allowedValues\": [\n\n ]\n },\n {\n \"name\": \"table\",\n \"label\": \"Table\",\n \"description\": \"the name of the table\",\n \"type\": \"string\",\n \"required\": false,\n \"value\": null,\n \"default\": \"cool_table\",\n \"allowedValues\": [\n\n ]\n },\n {\n \"name\": \"db\",\n \"label\": \"Database\",\n \"description\": \"the name of the database\",\n \"type\": \"database\",\n \"required\": true,\n \"value\": null,\n \"default\": null,\n \"allowedValues\": [\n\n ]\n }\n ],\n \"arguments\": {\n \"db\": {\n \"database\": 248,\n \"credential\": 683\n }\n },\n \"isTemplate\": false,\n \"templateDependentsCount\": null,\n \"publishedAsTemplateId\": null,\n \"fromTemplateId\": null,\n \"templateScriptName\": null,\n \"links\": {\n \"details\": \"api.civis.test/scripts/containers/2340\",\n \"runs\": \"api.civis.test/scripts/containers/2340/runs\"\n },\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n },\n \"notifications\": {\n \"urls\": [\n\n ],\n \"successEmailSubject\": null,\n \"successEmailBody\": null,\n \"successEmailAddresses\": [\n\n ],\n \"successEmailFromName\": null,\n \"successEmailReplyTo\": null,\n \"failureEmailAddresses\": [\n\n ],\n \"stallWarningMinutes\": null,\n \"successOn\": true,\n \"failureOn\": true\n },\n \"runningAs\": {\n \"id\": 2395,\n \"name\": \"User devuserfactory1936 1936\",\n \"username\": \"devuserfactory1936\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"requiredResources\": {\n \"cpu\": 99,\n \"memory\": 98,\n \"diskSpace\": 4.0\n },\n \"repoHttpUri\": \"github.com/my_repo\",\n \"repoRef\": \"master\",\n \"remoteHostCredentialId\": null,\n \"gitCredentialId\": 684,\n \"dockerCommand\": \"python3 main.py\",\n \"dockerImageName\": \"civisanalytics/datascience-base\",\n \"dockerImageTag\": \"awesome_tag\",\n \"instanceType\": null,\n \"cancelTimeout\": 0,\n \"lastRun\": null,\n \"timeZone\": \"America/Chicago\",\n \"partitionLabel\": null,\n \"myPermissionLevel\": \"manage\",\n \"hidden\": false,\n \"archived\": false,\n \"targetProjectId\": null,\n \"runningAsId\": 2395\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"ea8c787fbf544d2a04ccb68e166a0ec0\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"40862fb5-7ff4-4fea-8d0a-d9774fb71bce","X-Runtime":"0.100475","Content-Length":"2183"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/scripts/containers\" -d '{\"name\":\"My new container script\",\"params\":[{\"name\":\"schema\",\"label\":\"Schema\",\"description\":\"the schema of the table\",\"type\":\"string\",\"required\":false,\"value\":null,\"default\":\"cool_schema\",\"allowedValues\":[]},{\"name\":\"table\",\"label\":\"Table\",\"description\":\"the name of the table\",\"type\":\"string\",\"required\":false,\"value\":null,\"default\":\"cool_table\",\"allowedValues\":[]},{\"name\":\"db\",\"label\":\"Database\",\"description\":\"the name of the database\",\"type\":\"database\",\"required\":true,\"value\":null,\"default\":null,\"allowedValues\":[]}],\"arguments\":{\"db\":{\"database\":248,\"credential\":683}},\"repo_http_uri\":\"github.com/my_repo\",\"repo_ref\":\"master\",\"docker_command\":\"python3 main.py\",\"docker_image_name\":\"civisanalytics/datascience-base\",\"docker_image_tag\":\"awesome_tag\",\"git_credential_id\":684,\"required_resources\":{\"cpu\":99,\"memory\":98,\"disk_space\":4}}' -X POST \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer evxcvQKM0m_IVkadvzvZf3lkvByeKA29eVdA9jGEfhA\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Scripts","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/scripts/containers","description":"Fails if provides a default param value to required param","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/scripts/containers","request_body":"{\n \"name\": \"My new container script\",\n \"params\": [\n {\n \"name\": \"schema\",\n \"label\": \"Schema\",\n \"description\": \"the schema of the table\",\n \"type\": \"string\",\n \"required\": true,\n \"value\": null,\n \"default\": \"cool_schema\",\n \"allowedValues\": []\n },\n {\n \"name\": \"table\",\n \"label\": \"Table\",\n \"description\": \"the name of the table\",\n \"type\": \"string\",\n \"required\": true,\n \"value\": null,\n \"default\": \"cool_table\",\n \"allowedValues\": []\n }\n ],\n \"repo_http_uri\": \"github.com/my_repo\",\n \"repo_ref\": \"master\",\n \"docker_command\": \"python3 main.py\",\n \"docker_image_name\": \"civisanalytics/datascience-base\",\n \"docker_image_tag\": \"awesome_tag\",\n \"git_credential_id\": 694,\n \"required_resources\": {\n \"cpu\": 1024,\n \"memory\": 8,\n \"disk_space\": 2\n }\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer 5tK3-TL_Vue_SjeTtIC1wLBAF_ZNGriyZ3kFu1dtoeY","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":400,"response_status_text":"Bad Request","response_body":"{\n \"error\": \"bad_request\",\n \"errorDescription\": \"The given request was not as expected: Validation failed: Code.Parameters schema cannot have a default value since it is required., Code.Parameters table cannot have a default value since it is required.\",\n \"code\": 400\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"d14cd725-7a11-4a94-8a16-c9e2e425de58","X-Runtime":"0.056048","Content-Length":"259"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/scripts/containers\" -d '{\"name\":\"My new container script\",\"params\":[{\"name\":\"schema\",\"label\":\"Schema\",\"description\":\"the schema of the table\",\"type\":\"string\",\"required\":true,\"value\":null,\"default\":\"cool_schema\",\"allowedValues\":[]},{\"name\":\"table\",\"label\":\"Table\",\"description\":\"the name of the table\",\"type\":\"string\",\"required\":true,\"value\":null,\"default\":\"cool_table\",\"allowedValues\":[]}],\"repo_http_uri\":\"github.com/my_repo\",\"repo_ref\":\"master\",\"docker_command\":\"python3 main.py\",\"docker_image_name\":\"civisanalytics/datascience-base\",\"docker_image_tag\":\"awesome_tag\",\"git_credential_id\":694,\"required_resources\":{\"cpu\":1024,\"memory\":8,\"disk_space\":2}}' -X POST \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer 5tK3-TL_Vue_SjeTtIC1wLBAF_ZNGriyZ3kFu1dtoeY\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/scripts/containers/{id}":{"get":{"summary":"View a container","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID for the script.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object531"}}},"x-examples":[{"resource":"Scripts","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/scripts/containers/:container_id","description":"View a Container script's details","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/scripts/containers/2225","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer U2BGEALpVOiI8ek7SfBbmViPWr8LEqrTx6VYjGj7cFM","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 2225,\n \"fromTemplateAliases\": [\n\n ],\n \"name\": \"Script #2225\",\n \"type\": \"Container\",\n \"createdAt\": \"2024-12-03T19:45:38.000Z\",\n \"updatedAt\": \"2024-12-03T19:45:38.000Z\",\n \"author\": {\n \"id\": 2278,\n \"name\": \"User devuserfactory1840 1840\",\n \"username\": \"devuserfactory1840\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"state\": \"idle\",\n \"finishedAt\": null,\n \"category\": \"script\",\n \"projects\": [\n\n ],\n \"parentId\": null,\n \"userContext\": \"runner\",\n \"params\": [\n\n ],\n \"arguments\": {\n },\n \"isTemplate\": false,\n \"templateDependentsCount\": null,\n \"publishedAsTemplateId\": null,\n \"fromTemplateId\": null,\n \"templateScriptName\": null,\n \"links\": {\n \"details\": \"api.civis.test/scripts/containers/2225\",\n \"runs\": \"api.civis.test/scripts/containers/2225/runs\"\n },\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n },\n \"notifications\": {\n \"urls\": [\n\n ],\n \"successEmailSubject\": null,\n \"successEmailBody\": null,\n \"successEmailAddresses\": [\n\n ],\n \"successEmailFromName\": null,\n \"successEmailReplyTo\": null,\n \"failureEmailAddresses\": [\n\n ],\n \"stallWarningMinutes\": null,\n \"successOn\": true,\n \"failureOn\": true\n },\n \"runningAs\": {\n \"id\": 2278,\n \"name\": \"User devuserfactory1840 1840\",\n \"username\": \"devuserfactory1840\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"requiredResources\": {\n \"cpu\": null,\n \"memory\": null,\n \"diskSpace\": 1.0\n },\n \"repoHttpUri\": \"git_repo_url\",\n \"repoRef\": \"git_repo_ref\",\n \"remoteHostCredentialId\": null,\n \"gitCredentialId\": null,\n \"dockerCommand\": \"command\",\n \"dockerImageName\": \"docker_image_name\",\n \"dockerImageTag\": \"mock_latest_tag\",\n \"instanceType\": null,\n \"cancelTimeout\": 0,\n \"lastRun\": null,\n \"timeZone\": \"America/Chicago\",\n \"partitionLabel\": null,\n \"myPermissionLevel\": \"manage\",\n \"hidden\": false,\n \"archived\": false,\n \"targetProjectId\": null,\n \"runningAsId\": 2278\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"d99588f584d9f10bfbdbf74856e4bccb\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"0017757e-1b03-4711-b523-124d9310836a","X-Runtime":"0.051852","Content-Length":"1644"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/scripts/containers/2225\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer U2BGEALpVOiI8ek7SfBbmViPWr8LEqrTx6VYjGj7cFM\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"put":{"summary":"Edit a container","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID for the script.","type":"integer"},{"name":"Object534","in":"body","schema":{"$ref":"#/definitions/Object534"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object531"}}},"x-examples":[{"resource":"Scripts","resource_explanation":null,"http_method":"PUT","route":"http://api.civis.test/scripts/containers/:container_id","description":"Update a Container Script via Put","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"PUT","request_path":"http://api.civis.test/scripts/containers/2462","request_body":"{\n \"id\": 2462,\n \"name\": \"My updated Container script\",\n \"parent_id\": null,\n \"repo_http_uri\": \"github.com/new_repo\",\n \"repo_ref\": \"cool-branch\",\n \"docker_command\": \"python3 new_main.py\",\n \"docker_image_name\": \"new_docker_image\",\n \"required_resources\": {\n \"cpu\": 1024,\n \"memory\": 1024,\n \"disk_space\": 4\n },\n \"remote_host_credential_id\": 839,\n \"running_as_id\": 2519,\n \"docker_image_tag\": \"latest\"\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer ZtT5dnsK7yOa_tGZqZjLL1CfakyRfO1pHZ8pFBtaBWk","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 2462,\n \"fromTemplateAliases\": [\n\n ],\n \"name\": \"My updated Container script\",\n \"type\": \"Container\",\n \"createdAt\": \"2024-12-03T19:46:07.000Z\",\n \"updatedAt\": \"2024-12-03T19:46:07.000Z\",\n \"author\": {\n \"id\": 2519,\n \"name\": \"User devuserfactory2041 2041\",\n \"username\": \"devuserfactory2041\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"state\": \"idle\",\n \"finishedAt\": null,\n \"category\": \"script\",\n \"projects\": [\n\n ],\n \"parentId\": null,\n \"userContext\": \"runner\",\n \"params\": [\n\n ],\n \"arguments\": {\n },\n \"isTemplate\": false,\n \"templateDependentsCount\": null,\n \"publishedAsTemplateId\": null,\n \"fromTemplateId\": null,\n \"templateScriptName\": null,\n \"links\": {\n \"details\": \"api.civis.test/scripts/containers/2462\",\n \"runs\": \"api.civis.test/scripts/containers/2462/runs\"\n },\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n },\n \"notifications\": {\n \"urls\": [\n\n ],\n \"successEmailSubject\": null,\n \"successEmailBody\": null,\n \"successEmailAddresses\": [\n\n ],\n \"successEmailFromName\": null,\n \"successEmailReplyTo\": null,\n \"failureEmailAddresses\": [\n\n ],\n \"stallWarningMinutes\": null,\n \"successOn\": true,\n \"failureOn\": true\n },\n \"runningAs\": {\n \"id\": 2519,\n \"name\": \"User devuserfactory2041 2041\",\n \"username\": \"devuserfactory2041\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"requiredResources\": {\n \"cpu\": 1024,\n \"memory\": 1024,\n \"diskSpace\": 4.0\n },\n \"repoHttpUri\": \"github.com/new_repo\",\n \"repoRef\": \"cool-branch\",\n \"remoteHostCredentialId\": 839,\n \"gitCredentialId\": null,\n \"dockerCommand\": \"python3 new_main.py\",\n \"dockerImageName\": \"new_docker_image\",\n \"dockerImageTag\": \"latest\",\n \"instanceType\": null,\n \"cancelTimeout\": 0,\n \"lastRun\": null,\n \"timeZone\": \"America/Chicago\",\n \"partitionLabel\": null,\n \"myPermissionLevel\": \"manage\",\n \"hidden\": false,\n \"archived\": false,\n \"targetProjectId\": null,\n \"runningAsId\": 2519\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"fc2836ae324504934fe2a040c5d9c4a4\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"25c82d49-054f-4707-8735-93fdfec56804","X-Runtime":"0.105065","Content-Length":"1666"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/scripts/containers/2462\" -d '{\"id\":2462,\"name\":\"My updated Container script\",\"parent_id\":null,\"repo_http_uri\":\"github.com/new_repo\",\"repo_ref\":\"cool-branch\",\"docker_command\":\"python3 new_main.py\",\"docker_image_name\":\"new_docker_image\",\"required_resources\":{\"cpu\":1024,\"memory\":1024,\"disk_space\":4},\"remote_host_credential_id\":839,\"running_as_id\":2519,\"docker_image_tag\":\"latest\"}' -X PUT \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer ZtT5dnsK7yOa_tGZqZjLL1CfakyRfO1pHZ8pFBtaBWk\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"patch":{"summary":"Update a container","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID for the script.","type":"integer"},{"name":"Object535","in":"body","schema":{"$ref":"#/definitions/Object535"},"required":false}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object531"}}},"x-examples":[{"resource":"Scripts","resource_explanation":null,"http_method":"PATCH","route":"http://api.civis.test/scripts/containers/:container_id","description":"Update a Container Script via Patch","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"PATCH","request_path":"http://api.civis.test/scripts/containers/2407","request_body":"{\n \"name\": \"My updated Container script\",\n \"repo_http_uri\": \"github.com/new_repo\",\n \"repo_ref\": \"cool-branch\",\n \"docker_command\": \"python3 new_main.py\",\n \"docker_image_name\": \"new_docker_image\",\n \"required_resources\": {\n \"cpu\": 500,\n \"memory\": 2000,\n \"disk_space\": 3\n }\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer _TkRemGqzGrPTq9r_pnGIdEIye8r7Uo3nKf1NpVmyhc","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 2407,\n \"fromTemplateAliases\": [\n\n ],\n \"name\": \"My updated Container script\",\n \"type\": \"Container\",\n \"createdAt\": \"2024-12-03T19:46:00.000Z\",\n \"updatedAt\": \"2024-12-03T19:46:01.000Z\",\n \"author\": {\n \"id\": 2464,\n \"name\": \"User devuserfactory1994 1994\",\n \"username\": \"devuserfactory1994\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"state\": \"idle\",\n \"finishedAt\": null,\n \"category\": \"script\",\n \"projects\": [\n\n ],\n \"parentId\": null,\n \"userContext\": \"runner\",\n \"params\": [\n\n ],\n \"arguments\": {\n },\n \"isTemplate\": false,\n \"templateDependentsCount\": null,\n \"publishedAsTemplateId\": null,\n \"fromTemplateId\": null,\n \"templateScriptName\": null,\n \"links\": {\n \"details\": \"api.civis.test/scripts/containers/2407\",\n \"runs\": \"api.civis.test/scripts/containers/2407/runs\"\n },\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n },\n \"notifications\": {\n \"urls\": [\n\n ],\n \"successEmailSubject\": null,\n \"successEmailBody\": null,\n \"successEmailAddresses\": [\n\n ],\n \"successEmailFromName\": null,\n \"successEmailReplyTo\": null,\n \"failureEmailAddresses\": [\n\n ],\n \"stallWarningMinutes\": null,\n \"successOn\": true,\n \"failureOn\": true\n },\n \"runningAs\": {\n \"id\": 2464,\n \"name\": \"User devuserfactory1994 1994\",\n \"username\": \"devuserfactory1994\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"requiredResources\": {\n \"cpu\": 500,\n \"memory\": 2000,\n \"diskSpace\": 3.0\n },\n \"repoHttpUri\": \"github.com/new_repo\",\n \"repoRef\": \"cool-branch\",\n \"remoteHostCredentialId\": null,\n \"gitCredentialId\": null,\n \"dockerCommand\": \"python3 new_main.py\",\n \"dockerImageName\": \"new_docker_image\",\n \"dockerImageTag\": \"mock_latest_tag\",\n \"instanceType\": null,\n \"cancelTimeout\": 0,\n \"lastRun\": null,\n \"timeZone\": \"America/Chicago\",\n \"partitionLabel\": null,\n \"myPermissionLevel\": \"manage\",\n \"hidden\": false,\n \"archived\": false,\n \"targetProjectId\": null,\n \"runningAsId\": 2464\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"71864f567daea252ebc7cc3f79b4fe49\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"bb348ea9-027a-4751-baca-27e87c8ab0d8","X-Runtime":"0.091974","Content-Length":"1675"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/scripts/containers/2407\" -d '{\"name\":\"My updated Container script\",\"repo_http_uri\":\"github.com/new_repo\",\"repo_ref\":\"cool-branch\",\"docker_command\":\"python3 new_main.py\",\"docker_image_name\":\"new_docker_image\",\"required_resources\":{\"cpu\":500,\"memory\":2000,\"disk_space\":3}}' -X PATCH \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer _TkRemGqzGrPTq9r_pnGIdEIye8r7Uo3nKf1NpVmyhc\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Scripts","resource_explanation":null,"http_method":"PATCH","route":"http://api.civis.test/scripts/containers/:container_id","description":"Update a Container Script via Patch","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"PATCH","request_path":"http://api.civis.test/scripts/containers/2471","request_body":"{\n \"id\": 2471,\n \"name\": \"My patched Container script\"\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer pFgtu0eNzOi7PkCDzxiGY0Z9HQA-fX8u1HHFHWXU-gY","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 2471,\n \"fromTemplateAliases\": [\n\n ],\n \"name\": \"My patched Container script\",\n \"type\": \"Container\",\n \"createdAt\": \"2024-12-03T19:46:08.000Z\",\n \"updatedAt\": \"2024-12-03T19:46:08.000Z\",\n \"author\": {\n \"id\": 2528,\n \"name\": \"User devuserfactory2049 2049\",\n \"username\": \"devuserfactory2049\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"state\": \"idle\",\n \"finishedAt\": null,\n \"category\": \"script\",\n \"projects\": [\n\n ],\n \"parentId\": null,\n \"userContext\": \"runner\",\n \"params\": [\n\n ],\n \"arguments\": {\n },\n \"isTemplate\": false,\n \"templateDependentsCount\": null,\n \"publishedAsTemplateId\": null,\n \"fromTemplateId\": null,\n \"templateScriptName\": null,\n \"links\": {\n \"details\": \"api.civis.test/scripts/containers/2471\",\n \"runs\": \"api.civis.test/scripts/containers/2471/runs\"\n },\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n },\n \"notifications\": {\n \"urls\": [\n\n ],\n \"successEmailSubject\": null,\n \"successEmailBody\": null,\n \"successEmailAddresses\": [\n\n ],\n \"successEmailFromName\": null,\n \"successEmailReplyTo\": null,\n \"failureEmailAddresses\": [\n\n ],\n \"stallWarningMinutes\": null,\n \"successOn\": true,\n \"failureOn\": true\n },\n \"runningAs\": {\n \"id\": 2528,\n \"name\": \"User devuserfactory2049 2049\",\n \"username\": \"devuserfactory2049\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"requiredResources\": {\n \"cpu\": null,\n \"memory\": null,\n \"diskSpace\": 1.0\n },\n \"repoHttpUri\": \"git_repo_url\",\n \"repoRef\": \"git_repo_ref\",\n \"remoteHostCredentialId\": null,\n \"gitCredentialId\": null,\n \"dockerCommand\": \"command\",\n \"dockerImageName\": \"docker_image_name\",\n \"dockerImageTag\": \"mock_latest_tag\",\n \"instanceType\": null,\n \"cancelTimeout\": 0,\n \"lastRun\": null,\n \"timeZone\": \"America/Chicago\",\n \"partitionLabel\": null,\n \"myPermissionLevel\": \"manage\",\n \"hidden\": false,\n \"archived\": false,\n \"targetProjectId\": null,\n \"runningAsId\": 2528\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"c394e0c47b856bec0ac2dd9ad586d213\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"69d950b1-7d8f-4097-8a84-1f03c374bc74","X-Runtime":"0.084713","Content-Length":"1659"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/scripts/containers/2471\" -d '{\"id\":2471,\"name\":\"My patched Container script\"}' -X PATCH \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer pFgtu0eNzOi7PkCDzxiGY0Z9HQA-fX8u1HHFHWXU-gY\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"delete":{"summary":"Archive a container (deprecated, use archive endpoints)","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID for the script.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/containers/{id}/runs/{run_id}/logs":{"post":{"summary":"Add log messages","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the script.","type":"integer"},{"name":"run_id","in":"path","required":true,"description":"The ID of the script run.","type":"integer"},{"name":"Object539","in":"body","schema":{"$ref":"#/definitions/Object539"},"required":false}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null},"get":{"summary":"Get the logs for a run","description":"Get the logs for a run.","deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Container job.","type":"integer"},{"name":"run_id","in":"path","required":true,"description":"The ID of the run.","type":"integer"},{"name":"last_id","in":"query","required":false,"description":"The ID of the last log message received. Log entries with this ID value or lower will be omitted.Logs are sorted by ID if this value is provided, and are otherwise sorted by createdAt.","type":"integer"},{"name":"limit","in":"query","required":false,"description":"The maximum number of log messages to return. Default of 10000.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object116"}}}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/sql":{"post":{"summary":"Create a SQL Script","description":null,"deprecated":false,"parameters":[{"name":"Object542","in":"body","schema":{"$ref":"#/definitions/Object542"},"required":true}],"responses":{"201":{"description":"success","schema":{"$ref":"#/definitions/Object544"}}},"x-examples":[{"resource":"Scripts","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/scripts/sql","description":"Create a sql script","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/scripts/sql","request_body":"{\n \"name\": \"My new sql script\",\n \"remote_host_id\": 227,\n \"credential_id\": 622,\n \"sql\": \"select * from tablename\",\n \"notifications\": {\n \"success_email_addresses\": \"test1@civisanalytics.com\",\n \"failure_email_addresses\": \"test2@civisanalytics.com\",\n \"urls\": \"civisanalytics.com\",\n \"successEmailSubject\": \"test subject\",\n \"successEmailBody\": \"test body\",\n \"stallWarningMinutes\": 15,\n \"successOn\": true,\n \"failureOn\": true\n }\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer 8Spt7ZjttIYIyzDpi1ZCBtW5YhXbtKfQryrBjoEbznk","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":201,"response_status_text":"Created","response_body":"{\n \"id\": 2298,\n \"name\": \"My new sql script\",\n \"type\": \"SQL\",\n \"createdAt\": \"2024-12-03T19:45:47.000Z\",\n \"updatedAt\": \"2024-12-03T19:45:47.000Z\",\n \"author\": {\n \"id\": 2352,\n \"name\": \"User devuserfactory1900 1900\",\n \"username\": \"devuserfactory1900\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"state\": \"idle\",\n \"finishedAt\": null,\n \"category\": \"script\",\n \"projects\": [\n\n ],\n \"parentId\": null,\n \"userContext\": \"runner\",\n \"params\": [\n\n ],\n \"arguments\": {\n },\n \"isTemplate\": false,\n \"publishedAsTemplateId\": null,\n \"fromTemplateId\": null,\n \"templateDependentsCount\": null,\n \"templateScriptName\": null,\n \"links\": {\n \"details\": \"api.civis.test/scripts/sql/2298\",\n \"runs\": \"api.civis.test/scripts/sql/2298/runs\"\n },\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n },\n \"notifications\": {\n \"urls\": [\n \"civisanalytics.com\"\n ],\n \"successEmailSubject\": \"test subject\",\n \"successEmailBody\": \"test body\",\n \"successEmailAddresses\": [\n \"test1@civisanalytics.com\"\n ],\n \"successEmailFromName\": null,\n \"successEmailReplyTo\": null,\n \"failureEmailAddresses\": [\n \"test2@civisanalytics.com\"\n ],\n \"stallWarningMinutes\": 15,\n \"successOn\": true,\n \"failureOn\": true\n },\n \"runningAs\": {\n \"id\": 2352,\n \"name\": \"User devuserfactory1900 1900\",\n \"username\": \"devuserfactory1900\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"nextRunAt\": null,\n \"timeZone\": \"America/Chicago\",\n \"lastRun\": null,\n \"myPermissionLevel\": \"manage\",\n \"hidden\": false,\n \"targetProjectId\": null,\n \"archived\": false,\n \"sql\": \"select * from tablename\",\n \"expandedArguments\": {\n },\n \"remoteHostId\": 227,\n \"credentialId\": 622,\n \"codePreview\": \"select * from tablename\",\n \"csvSettings\": {\n \"includeHeader\": true,\n \"compression\": \"gzip\",\n \"columnDelimiter\": \"comma\",\n \"unquoted\": false,\n \"forceMultifile\": false,\n \"filenamePrefix\": null,\n \"maxFileSize\": null\n },\n \"runningAsId\": 2352\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"cfd060f1c741a1fa3bd0c2327ed7820e\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"406cac50-5af9-457d-b057-eb2d981e0ca6","X-Runtime":"0.143285","Content-Length":"1677"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/scripts/sql\" -d '{\"name\":\"My new sql script\",\"remote_host_id\":227,\"credential_id\":622,\"sql\":\"select * from tablename\",\"notifications\":{\"success_email_addresses\":\"test1@civisanalytics.com\",\"failure_email_addresses\":\"test2@civisanalytics.com\",\"urls\":\"civisanalytics.com\",\"successEmailSubject\":\"test subject\",\"successEmailBody\":\"test body\",\"stallWarningMinutes\":15,\"successOn\":true,\"failureOn\":true}}' -X POST \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer 8Spt7ZjttIYIyzDpi1ZCBtW5YhXbtKfQryrBjoEbznk\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Scripts","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/scripts/sql","description":"Create a sql script with custom export settings","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/scripts/sql","request_body":"{\n \"name\": \"My new export settings sql script\",\n \"remote_host_id\": 230,\n \"credential_id\": 631,\n \"sql\": \"select * from tablename\",\n \"csv_settings\": {\n \"include_header\": false,\n \"compression\": \"none\",\n \"column_delimiter\": \"tab\",\n \"unquoted\": true,\n \"force_multifile\": true,\n \"filename_prefix\": \"test_prefix_\"\n }\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer WVQOX-IGzXjr4iq0A-JaHrftLulo8y4-tmnKb--FMfY","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":201,"response_status_text":"Created","response_body":"{\n \"id\": 2305,\n \"name\": \"My new export settings sql script\",\n \"type\": \"SQL\",\n \"createdAt\": \"2024-12-03T19:45:48.000Z\",\n \"updatedAt\": \"2024-12-03T19:45:48.000Z\",\n \"author\": {\n \"id\": 2359,\n \"name\": \"User devuserfactory1906 1906\",\n \"username\": \"devuserfactory1906\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"state\": \"idle\",\n \"finishedAt\": null,\n \"category\": \"script\",\n \"projects\": [\n\n ],\n \"parentId\": null,\n \"userContext\": \"runner\",\n \"params\": [\n\n ],\n \"arguments\": {\n },\n \"isTemplate\": false,\n \"publishedAsTemplateId\": null,\n \"fromTemplateId\": null,\n \"templateDependentsCount\": null,\n \"templateScriptName\": null,\n \"links\": {\n \"details\": \"api.civis.test/scripts/sql/2305\",\n \"runs\": \"api.civis.test/scripts/sql/2305/runs\"\n },\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n },\n \"notifications\": {\n \"urls\": [\n\n ],\n \"successEmailSubject\": null,\n \"successEmailBody\": null,\n \"successEmailAddresses\": [\n\n ],\n \"successEmailFromName\": null,\n \"successEmailReplyTo\": null,\n \"failureEmailAddresses\": [\n\n ],\n \"stallWarningMinutes\": null,\n \"successOn\": true,\n \"failureOn\": true\n },\n \"runningAs\": {\n \"id\": 2359,\n \"name\": \"User devuserfactory1906 1906\",\n \"username\": \"devuserfactory1906\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"nextRunAt\": null,\n \"timeZone\": \"America/Chicago\",\n \"lastRun\": null,\n \"myPermissionLevel\": \"manage\",\n \"hidden\": false,\n \"targetProjectId\": null,\n \"archived\": false,\n \"sql\": \"select * from tablename\",\n \"expandedArguments\": {\n },\n \"remoteHostId\": 230,\n \"credentialId\": 631,\n \"codePreview\": \"select * from tablename\",\n \"csvSettings\": {\n \"includeHeader\": false,\n \"compression\": \"none\",\n \"columnDelimiter\": \"tab\",\n \"unquoted\": true,\n \"forceMultifile\": true,\n \"filenamePrefix\": \"test_prefix_\",\n \"maxFileSize\": null\n },\n \"runningAsId\": 2359\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"9cc1b31525ed03eda86504448658ad49\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"9969d52c-a836-4c3b-b400-6ebaadc9adba","X-Runtime":"0.123811","Content-Length":"1613"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/scripts/sql\" -d '{\"name\":\"My new export settings sql script\",\"remote_host_id\":230,\"credential_id\":631,\"sql\":\"select * from tablename\",\"csv_settings\":{\"include_header\":false,\"compression\":\"none\",\"column_delimiter\":\"tab\",\"unquoted\":true,\"force_multifile\":true,\"filename_prefix\":\"test_prefix_\"}}' -X POST \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer WVQOX-IGzXjr4iq0A-JaHrftLulo8y4-tmnKb--FMfY\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Scripts","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/scripts/sql","description":"Create a parameterized sql script","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/scripts/sql","request_body":"{\n \"name\": \"My new parameterized sql script\",\n \"remote_host_id\": 233,\n \"credential_id\": 640,\n \"sql\": \"select * from {{schema}}.{{table}}\",\n \"params\": [\n {\n \"name\": \"schema\",\n \"label\": \"Schema\",\n \"description\": \"the schema of the table\",\n \"type\": \"string\",\n \"required\": true,\n \"value\": null,\n \"default\": null,\n \"allowedValues\": []\n },\n {\n \"name\": \"credential\",\n \"label\": \"Credential\",\n \"description\": \"the credential to use\",\n \"type\": \"credential_redshift\",\n \"required\": true,\n \"value\": null,\n \"default\": null,\n \"allowedValues\": []\n },\n {\n \"name\": \"table\",\n \"label\": \"Table\",\n \"description\": \"the name of the table\",\n \"type\": \"string\",\n \"required\": true,\n \"value\": null,\n \"default\": null,\n \"allowedValues\": []\n }\n ]\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer 5fcOxqt6r9F1MrLGbf_Lr2un-OviQjCeLtda9NfIJOI","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":201,"response_status_text":"Created","response_body":"{\n \"id\": 2312,\n \"name\": \"My new parameterized sql script\",\n \"type\": \"SQL\",\n \"createdAt\": \"2024-12-03T19:45:49.000Z\",\n \"updatedAt\": \"2024-12-03T19:45:49.000Z\",\n \"author\": {\n \"id\": 2366,\n \"name\": \"User devuserfactory1912 1912\",\n \"username\": \"devuserfactory1912\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"state\": \"idle\",\n \"finishedAt\": null,\n \"category\": \"script\",\n \"projects\": [\n\n ],\n \"parentId\": null,\n \"userContext\": \"runner\",\n \"params\": [\n {\n \"name\": \"schema\",\n \"label\": \"Schema\",\n \"description\": \"the schema of the table\",\n \"type\": \"string\",\n \"required\": true,\n \"value\": null,\n \"default\": null,\n \"allowedValues\": [\n\n ]\n },\n {\n \"name\": \"credential\",\n \"label\": \"Credential\",\n \"description\": \"the credential to use\",\n \"type\": \"credential_redshift\",\n \"required\": true,\n \"value\": null,\n \"default\": null,\n \"allowedValues\": [\n\n ]\n },\n {\n \"name\": \"table\",\n \"label\": \"Table\",\n \"description\": \"the name of the table\",\n \"type\": \"string\",\n \"required\": true,\n \"value\": null,\n \"default\": null,\n \"allowedValues\": [\n\n ]\n }\n ],\n \"arguments\": {\n },\n \"isTemplate\": false,\n \"publishedAsTemplateId\": null,\n \"fromTemplateId\": null,\n \"templateDependentsCount\": null,\n \"templateScriptName\": null,\n \"links\": {\n \"details\": \"api.civis.test/scripts/sql/2312\",\n \"runs\": \"api.civis.test/scripts/sql/2312/runs\"\n },\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n },\n \"notifications\": {\n \"urls\": [\n\n ],\n \"successEmailSubject\": null,\n \"successEmailBody\": null,\n \"successEmailAddresses\": [\n\n ],\n \"successEmailFromName\": null,\n \"successEmailReplyTo\": null,\n \"failureEmailAddresses\": [\n\n ],\n \"stallWarningMinutes\": null,\n \"successOn\": true,\n \"failureOn\": true\n },\n \"runningAs\": {\n \"id\": 2366,\n \"name\": \"User devuserfactory1912 1912\",\n \"username\": \"devuserfactory1912\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"nextRunAt\": null,\n \"timeZone\": \"America/Chicago\",\n \"lastRun\": null,\n \"myPermissionLevel\": \"manage\",\n \"hidden\": false,\n \"targetProjectId\": null,\n \"archived\": false,\n \"sql\": \"select * from {{schema}}.{{table}}\",\n \"expandedArguments\": {\n \"schema\": null,\n \"schema.literal\": null,\n \"schema.identifier\": null,\n \"schema.shell_escaped\": null,\n \"credential.id\": \"[redacted Credential id]\",\n \"credential.username\": \"[redacted Credential username]\",\n \"credential.password\": \"[redacted Credential password]\",\n \"table\": null,\n \"table.literal\": null,\n \"table.identifier\": null,\n \"table.shell_escaped\": null\n },\n \"remoteHostId\": 233,\n \"credentialId\": 640,\n \"codePreview\": \"select * from {{schema}}.{{table}}\",\n \"csvSettings\": {\n \"includeHeader\": true,\n \"compression\": \"gzip\",\n \"columnDelimiter\": \"comma\",\n \"unquoted\": false,\n \"forceMultifile\": false,\n \"filenamePrefix\": null,\n \"maxFileSize\": null\n },\n \"runningAsId\": 2366\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"dd8661f8b7371202726f64a39bbda46e\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"042a95f6-340a-469e-8f06-2f2eebc373f3","X-Runtime":"0.136057","Content-Length":"2428"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/scripts/sql\" -d '{\"name\":\"My new parameterized sql script\",\"remote_host_id\":233,\"credential_id\":640,\"sql\":\"select * from {{schema}}.{{table}}\",\"params\":[{\"name\":\"schema\",\"label\":\"Schema\",\"description\":\"the schema of the table\",\"type\":\"string\",\"required\":true,\"value\":null,\"default\":null,\"allowedValues\":[]},{\"name\":\"credential\",\"label\":\"Credential\",\"description\":\"the credential to use\",\"type\":\"credential_redshift\",\"required\":true,\"value\":null,\"default\":null,\"allowedValues\":[]},{\"name\":\"table\",\"label\":\"Table\",\"description\":\"the name of the table\",\"type\":\"string\",\"required\":true,\"value\":null,\"default\":null,\"allowedValues\":[]}]}' -X POST \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer 5fcOxqt6r9F1MrLGbf_Lr2un-OviQjCeLtda9NfIJOI\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Scripts","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/scripts/sql","description":"Create a parameterized sql script with default params","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/scripts/sql","request_body":"{\n \"name\": \"My new parameterized sql script\",\n \"remote_host_id\": 236,\n \"credential_id\": 649,\n \"sql\": \"select * from {{schema}}.{{table}} where \\\"{{colName}}\\\" = {{coolBool}} limit {{limit}}\",\n \"params\": [\n {\n \"name\": \"schema\",\n \"label\": \"Schema\",\n \"description\": \"the schema of the table\",\n \"type\": \"string\",\n \"required\": false,\n \"value\": null,\n \"default\": \"my_schema\",\n \"allowedValues\": []\n },\n {\n \"name\": \"table\",\n \"label\": \"Table\",\n \"description\": \"the name of the table\",\n \"type\": \"string\",\n \"required\": false,\n \"value\": null,\n \"default\": \"my_table\",\n \"allowedValues\": []\n },\n {\n \"name\": \"coolBool\",\n \"label\": \"Cool Bool\",\n \"description\": \"bool val for the column\",\n \"type\": \"bool\",\n \"required\": false,\n \"value\": null,\n \"default\": true,\n \"allowedValues\": []\n },\n {\n \"name\": \"colName\",\n \"label\": \"Column Name\",\n \"description\": \"column to select on\",\n \"type\": \"string\",\n \"required\": false,\n \"value\": null,\n \"default\": \"foo\",\n \"allowedValues\": []\n },\n {\n \"name\": \"limit\",\n \"label\": \"Limit\",\n \"description\": \"the limit\",\n \"type\": \"integer\",\n \"required\": false,\n \"value\": null,\n \"default\": null,\n \"allowedValues\": []\n }\n ]\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer wND6z5XyB4IDSSed33bI279iZ6Sj1kPhUh8ranZWQ6U","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":201,"response_status_text":"Created","response_body":"{\n \"id\": 2319,\n \"name\": \"My new parameterized sql script\",\n \"type\": \"SQL\",\n \"createdAt\": \"2024-12-03T19:45:49.000Z\",\n \"updatedAt\": \"2024-12-03T19:45:49.000Z\",\n \"author\": {\n \"id\": 2373,\n \"name\": \"User devuserfactory1918 1918\",\n \"username\": \"devuserfactory1918\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"state\": \"idle\",\n \"finishedAt\": null,\n \"category\": \"script\",\n \"projects\": [\n\n ],\n \"parentId\": null,\n \"userContext\": \"runner\",\n \"params\": [\n {\n \"name\": \"schema\",\n \"label\": \"Schema\",\n \"description\": \"the schema of the table\",\n \"type\": \"string\",\n \"required\": false,\n \"value\": null,\n \"default\": \"my_schema\",\n \"allowedValues\": [\n\n ]\n },\n {\n \"name\": \"table\",\n \"label\": \"Table\",\n \"description\": \"the name of the table\",\n \"type\": \"string\",\n \"required\": false,\n \"value\": null,\n \"default\": \"my_table\",\n \"allowedValues\": [\n\n ]\n },\n {\n \"name\": \"coolBool\",\n \"label\": \"Cool Bool\",\n \"description\": \"bool val for the column\",\n \"type\": \"bool\",\n \"required\": false,\n \"value\": null,\n \"default\": true,\n \"allowedValues\": [\n\n ]\n },\n {\n \"name\": \"colName\",\n \"label\": \"Column Name\",\n \"description\": \"column to select on\",\n \"type\": \"string\",\n \"required\": false,\n \"value\": null,\n \"default\": \"foo\",\n \"allowedValues\": [\n\n ]\n },\n {\n \"name\": \"limit\",\n \"label\": \"Limit\",\n \"description\": \"the limit\",\n \"type\": \"integer\",\n \"required\": false,\n \"value\": null,\n \"default\": null,\n \"allowedValues\": [\n\n ]\n }\n ],\n \"arguments\": {\n },\n \"isTemplate\": false,\n \"publishedAsTemplateId\": null,\n \"fromTemplateId\": null,\n \"templateDependentsCount\": null,\n \"templateScriptName\": null,\n \"links\": {\n \"details\": \"api.civis.test/scripts/sql/2319\",\n \"runs\": \"api.civis.test/scripts/sql/2319/runs\"\n },\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n },\n \"notifications\": {\n \"urls\": [\n\n ],\n \"successEmailSubject\": null,\n \"successEmailBody\": null,\n \"successEmailAddresses\": [\n\n ],\n \"successEmailFromName\": null,\n \"successEmailReplyTo\": null,\n \"failureEmailAddresses\": [\n\n ],\n \"stallWarningMinutes\": null,\n \"successOn\": true,\n \"failureOn\": true\n },\n \"runningAs\": {\n \"id\": 2373,\n \"name\": \"User devuserfactory1918 1918\",\n \"username\": \"devuserfactory1918\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"nextRunAt\": null,\n \"timeZone\": \"America/Chicago\",\n \"lastRun\": null,\n \"myPermissionLevel\": \"manage\",\n \"hidden\": false,\n \"targetProjectId\": null,\n \"archived\": false,\n \"sql\": \"select * from {{schema}}.{{table}} where \\\"{{colName}}\\\" = {{coolBool}} limit {{limit}}\",\n \"expandedArguments\": {\n \"schema\": \"my_schema\",\n \"schema.literal\": \"'my_schema'\",\n \"schema.identifier\": \"\\\"my_schema\\\"\",\n \"schema.shell_escaped\": \"my_schema\",\n \"table\": \"my_table\",\n \"table.literal\": \"'my_table'\",\n \"table.identifier\": \"\\\"my_table\\\"\",\n \"table.shell_escaped\": \"my_table\",\n \"coolBool\": true,\n \"colName\": \"foo\",\n \"colName.literal\": \"'foo'\",\n \"colName.identifier\": \"\\\"foo\\\"\",\n \"colName.shell_escaped\": \"foo\",\n \"limit\": 0\n },\n \"remoteHostId\": 236,\n \"credentialId\": 649,\n \"codePreview\": \"select * from my_schema.my_table where \\\"foo\\\" = true limit 0\",\n \"csvSettings\": {\n \"includeHeader\": true,\n \"compression\": \"gzip\",\n \"columnDelimiter\": \"comma\",\n \"unquoted\": false,\n \"forceMultifile\": false,\n \"filenamePrefix\": null,\n \"maxFileSize\": null\n },\n \"runningAsId\": 2373\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"465e4e73de53a42f8a5ff44b2784fddf\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"d9798f2c-1fbe-42dd-910d-92a0312687d7","X-Runtime":"0.117033","Content-Length":"2846"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/scripts/sql\" -d '{\"name\":\"My new parameterized sql script\",\"remote_host_id\":236,\"credential_id\":649,\"sql\":\"select * from {{schema}}.{{table}} where \\\"{{colName}}\\\" = {{coolBool}} limit {{limit}}\",\"params\":[{\"name\":\"schema\",\"label\":\"Schema\",\"description\":\"the schema of the table\",\"type\":\"string\",\"required\":false,\"value\":null,\"default\":\"my_schema\",\"allowedValues\":[]},{\"name\":\"table\",\"label\":\"Table\",\"description\":\"the name of the table\",\"type\":\"string\",\"required\":false,\"value\":null,\"default\":\"my_table\",\"allowedValues\":[]},{\"name\":\"coolBool\",\"label\":\"Cool Bool\",\"description\":\"bool val for the column\",\"type\":\"bool\",\"required\":false,\"value\":null,\"default\":true,\"allowedValues\":[]},{\"name\":\"colName\",\"label\":\"Column Name\",\"description\":\"column to select on\",\"type\":\"string\",\"required\":false,\"value\":null,\"default\":\"foo\",\"allowedValues\":[]},{\"name\":\"limit\",\"label\":\"Limit\",\"description\":\"the limit\",\"type\":\"integer\",\"required\":false,\"value\":null,\"default\":null,\"allowedValues\":[]}]}' -X POST \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer wND6z5XyB4IDSSed33bI279iZ6Sj1kPhUh8ranZWQ6U\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/scripts/sql/{id}":{"get":{"summary":"Get a SQL Script","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object544"}}},"x-examples":[{"resource":"Scripts","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/scripts/sql/:id","description":"View a SQL script's details","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/scripts/sql/2188","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer JYsAzWYgM7gt5K04849zxfafVwx0xDvM7VB25Xpqk-E","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 2188,\n \"name\": \"Script #2188\",\n \"type\": \"SQL\",\n \"createdAt\": \"2024-12-03T19:45:34.000Z\",\n \"updatedAt\": \"2024-12-03T19:45:34.000Z\",\n \"author\": {\n \"id\": 2245,\n \"name\": \"User devuserfactory1811 1811\",\n \"username\": \"devuserfactory1811\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"state\": \"running\",\n \"finishedAt\": \"2024-12-03T19:45:34.000Z\",\n \"category\": \"script\",\n \"projects\": [\n {\n \"id\": 16,\n \"name\": \"Test Project\"\n }\n ],\n \"parentId\": null,\n \"userContext\": \"runner\",\n \"params\": [\n {\n \"name\": \"id\",\n \"label\": \"ID\",\n \"description\": null,\n \"type\": \"integer\",\n \"required\": true,\n \"value\": null,\n \"default\": null,\n \"allowedValues\": [\n\n ]\n },\n {\n \"name\": \"state\",\n \"label\": \"State\",\n \"description\": null,\n \"type\": \"string\",\n \"required\": true,\n \"value\": null,\n \"default\": null,\n \"allowedValues\": [\n\n ]\n },\n {\n \"name\": \"table\",\n \"label\": \"Table\",\n \"description\": null,\n \"type\": \"string\",\n \"required\": false,\n \"value\": null,\n \"default\": null,\n \"allowedValues\": [\n\n ]\n },\n {\n \"name\": \"abool\",\n \"label\": \"A Bool\",\n \"description\": null,\n \"type\": \"bool\",\n \"required\": false,\n \"value\": null,\n \"default\": false,\n \"allowedValues\": [\n\n ]\n },\n {\n \"name\": \"afloat\",\n \"label\": \"A Float\",\n \"description\": null,\n \"type\": \"float\",\n \"required\": false,\n \"value\": null,\n \"default\": null,\n \"allowedValues\": [\n\n ]\n },\n {\n \"name\": \"optionalstr\",\n \"label\": \"Optional String\",\n \"description\": null,\n \"type\": \"string\",\n \"required\": false,\n \"value\": null,\n \"default\": null,\n \"allowedValues\": [\n\n ]\n },\n {\n \"name\": \"cred\",\n \"label\": \"Cred\",\n \"description\": null,\n \"type\": \"credential_redshift\",\n \"required\": false,\n \"value\": null,\n \"default\": null,\n \"allowedValues\": [\n\n ]\n },\n {\n \"name\": \"cred2\",\n \"label\": \"Cred AWS\",\n \"description\": null,\n \"type\": \"credential_aws\",\n \"required\": false,\n \"value\": null,\n \"default\": null,\n \"allowedValues\": [\n\n ]\n }\n ],\n \"arguments\": {\n \"id\": 2,\n \"state\": \"IL\",\n \"table\": \"test.test\"\n },\n \"isTemplate\": false,\n \"publishedAsTemplateId\": null,\n \"fromTemplateId\": null,\n \"templateDependentsCount\": null,\n \"templateScriptName\": null,\n \"links\": {\n \"details\": \"api.civis.test/scripts/sql/2188\",\n \"runs\": \"api.civis.test/scripts/sql/2188/runs\"\n },\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n },\n \"notifications\": {\n \"urls\": [\n\n ],\n \"successEmailSubject\": \"success email subject\",\n \"successEmailBody\": \"success_email_template\",\n \"successEmailAddresses\": [\n \"script_spec_user@civisanalytics.com\"\n ],\n \"successEmailFromName\": null,\n \"successEmailReplyTo\": null,\n \"failureEmailAddresses\": [\n \"script_spec_user@civisanalytics.com\"\n ],\n \"stallWarningMinutes\": null,\n \"successOn\": true,\n \"failureOn\": true\n },\n \"runningAs\": {\n \"id\": 2245,\n \"name\": \"User devuserfactory1811 1811\",\n \"username\": \"devuserfactory1811\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"nextRunAt\": null,\n \"timeZone\": \"America/Chicago\",\n \"lastRun\": {\n \"id\": 184,\n \"state\": \"running\",\n \"createdAt\": \"2024-12-03T19:45:34.000Z\",\n \"startedAt\": null,\n \"finishedAt\": \"2024-12-03T19:45:34.000Z\",\n \"error\": null\n },\n \"myPermissionLevel\": \"manage\",\n \"hidden\": false,\n \"targetProjectId\": null,\n \"archived\": false,\n \"sql\": \"SELECT * FROM table LIMIT 10;\",\n \"expandedArguments\": {\n \"id\": 2,\n \"state\": \"IL\",\n \"state.literal\": \"'IL'\",\n \"state.identifier\": \"\\\"IL\\\"\",\n \"state.shell_escaped\": \"IL\",\n \"table\": \"test.test\",\n \"table.literal\": \"'test.test'\",\n \"table.identifier\": \"\\\"test.test\\\"\",\n \"table.shell_escaped\": \"test.test\",\n \"abool\": false,\n \"afloat\": 0,\n \"optionalstr\": \"\",\n \"optionalstr.literal\": \"''\",\n \"optionalstr.identifier\": \"\\\"\\\"\",\n \"optionalstr.shell_escaped\": \"''\",\n \"cred.id\": \"\",\n \"cred.username\": \"\",\n \"cred.password\": \"\",\n \"cred2.id\": \"\",\n \"cred2.access_key_id\": \"\",\n \"cred2.secret_access_key\": \"\"\n },\n \"remoteHostId\": 179,\n \"credentialId\": 483,\n \"codePreview\": \"SELECT * FROM table LIMIT 10;\",\n \"csvSettings\": {\n \"includeHeader\": true,\n \"compression\": \"gzip\",\n \"columnDelimiter\": \"comma\",\n \"unquoted\": false,\n \"forceMultifile\": false,\n \"filenamePrefix\": null,\n \"maxFileSize\": null\n },\n \"runningAsId\": 2245\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"628c9aac010017356b0e857052e0f863\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"3c54b232-de41-4af4-b140-b19e67fcee89","X-Runtime":"0.056800","Content-Length":"3495"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/scripts/sql/2188\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer JYsAzWYgM7gt5K04849zxfafVwx0xDvM7VB25Xpqk-E\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Scripts","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/scripts/sql/:script_dependent_id","description":"View a script's details that is a template dependent","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/scripts/sql/2239","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer aph4cNq-95RGmzkibsECPJUkLpICMIB2Kp-tfnUaBmw","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 2239,\n \"name\": \"awesome sql template #2239\",\n \"type\": \"Custom\",\n \"createdAt\": \"2024-12-03T19:45:39.000Z\",\n \"updatedAt\": \"2024-12-03T19:45:39.000Z\",\n \"author\": {\n \"id\": 2287,\n \"name\": \"User devuserfactory1848 1848\",\n \"username\": \"devuserfactory1848\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"state\": \"idle\",\n \"finishedAt\": null,\n \"category\": \"script\",\n \"projects\": [\n\n ],\n \"parentId\": null,\n \"userContext\": \"runner\",\n \"params\": [\n {\n \"name\": \"id\",\n \"label\": \"ID\",\n \"description\": null,\n \"type\": \"integer\",\n \"required\": true,\n \"value\": null,\n \"default\": null,\n \"allowedValues\": [\n\n ]\n },\n {\n \"name\": \"state\",\n \"label\": \"State\",\n \"description\": null,\n \"type\": \"string\",\n \"required\": true,\n \"value\": null,\n \"default\": null,\n \"allowedValues\": [\n\n ]\n },\n {\n \"name\": \"table\",\n \"label\": \"Table\",\n \"description\": null,\n \"type\": \"string\",\n \"required\": false,\n \"value\": null,\n \"default\": null,\n \"allowedValues\": [\n\n ]\n }\n ],\n \"arguments\": {\n \"id\": 2,\n \"state\": \"IL\",\n \"table\": \"test.test\"\n },\n \"isTemplate\": false,\n \"publishedAsTemplateId\": null,\n \"fromTemplateId\": 164,\n \"templateDependentsCount\": null,\n \"templateScriptName\": \"Script #2236\",\n \"links\": {\n \"details\": \"api.civis.test/scripts/custom/2239\",\n \"runs\": \"api.civis.test/scripts/custom/2239/runs\"\n },\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n },\n \"notifications\": {\n \"urls\": [\n\n ],\n \"successEmailSubject\": null,\n \"successEmailBody\": null,\n \"successEmailAddresses\": [\n\n ],\n \"successEmailFromName\": null,\n \"successEmailReplyTo\": null,\n \"failureEmailAddresses\": [\n\n ],\n \"stallWarningMinutes\": null,\n \"successOn\": true,\n \"failureOn\": true\n },\n \"runningAs\": {\n \"id\": 2287,\n \"name\": \"User devuserfactory1848 1848\",\n \"username\": \"devuserfactory1848\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"nextRunAt\": null,\n \"timeZone\": \"America/Chicago\",\n \"lastRun\": null,\n \"myPermissionLevel\": \"manage\",\n \"hidden\": false,\n \"targetProjectId\": null,\n \"archived\": false,\n \"sql\": \"select * from {{table}} where id = {{id}} and state = '{{state}}'\",\n \"expandedArguments\": {\n \"id\": 2,\n \"state\": \"IL\",\n \"state.literal\": \"'IL'\",\n \"state.identifier\": \"\\\"IL\\\"\",\n \"state.shell_escaped\": \"IL\",\n \"table\": \"test.test\",\n \"table.literal\": \"'test.test'\",\n \"table.identifier\": \"\\\"test.test\\\"\",\n \"table.shell_escaped\": \"test.test\"\n },\n \"remoteHostId\": 197,\n \"credentialId\": 535,\n \"codePreview\": \"select * from test.test where id = 2 and state = 'IL'\",\n \"csvSettings\": {\n \"includeHeader\": true,\n \"compression\": \"gzip\",\n \"columnDelimiter\": \"comma\",\n \"unquoted\": false,\n \"forceMultifile\": false,\n \"filenamePrefix\": null,\n \"maxFileSize\": null\n },\n \"runningAsId\": 2287\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"34c30851b2b0967eeb20095785c525c8\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"877f723b-f18e-49d7-9725-199588782937","X-Runtime":"0.071346","Content-Length":"2332"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/scripts/sql/2239\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer aph4cNq-95RGmzkibsECPJUkLpICMIB2Kp-tfnUaBmw\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Scripts","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/scripts/sql/:script_template_id","description":"View a script's details that is a template dependent","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/scripts/sql/2249","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer MCBMXCmq2XladYDSiXWy-JnuyuLHiWKNb4QK8SUKo5E","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 2249,\n \"name\": \"Script #2249\",\n \"type\": \"SQL\",\n \"createdAt\": \"2024-12-03T19:45:41.000Z\",\n \"updatedAt\": \"2024-12-03T19:45:41.000Z\",\n \"author\": {\n \"id\": 2300,\n \"name\": \"User devuserfactory1858 1858\",\n \"username\": \"devuserfactory1858\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"state\": \"idle\",\n \"finishedAt\": null,\n \"category\": \"script\",\n \"projects\": [\n\n ],\n \"parentId\": null,\n \"userContext\": \"runner\",\n \"params\": [\n {\n \"name\": \"id\",\n \"label\": \"ID\",\n \"description\": null,\n \"type\": \"integer\",\n \"required\": true,\n \"value\": null,\n \"default\": null,\n \"allowedValues\": [\n\n ]\n },\n {\n \"name\": \"state\",\n \"label\": \"State\",\n \"description\": null,\n \"type\": \"string\",\n \"required\": true,\n \"value\": null,\n \"default\": null,\n \"allowedValues\": [\n\n ]\n },\n {\n \"name\": \"table\",\n \"label\": \"Table\",\n \"description\": null,\n \"type\": \"string\",\n \"required\": false,\n \"value\": null,\n \"default\": null,\n \"allowedValues\": [\n\n ]\n }\n ],\n \"arguments\": {\n },\n \"isTemplate\": true,\n \"publishedAsTemplateId\": 165,\n \"fromTemplateId\": null,\n \"templateDependentsCount\": 1,\n \"templateScriptName\": null,\n \"links\": {\n \"details\": \"api.civis.test/scripts/sql/2249\",\n \"runs\": \"api.civis.test/scripts/sql/2249/runs\"\n },\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n },\n \"notifications\": {\n \"urls\": [\n\n ],\n \"successEmailSubject\": null,\n \"successEmailBody\": null,\n \"successEmailAddresses\": [\n\n ],\n \"successEmailFromName\": null,\n \"successEmailReplyTo\": null,\n \"failureEmailAddresses\": [\n\n ],\n \"stallWarningMinutes\": null,\n \"successOn\": true,\n \"failureOn\": true\n },\n \"runningAs\": {\n \"id\": 2300,\n \"name\": \"User devuserfactory1858 1858\",\n \"username\": \"devuserfactory1858\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"nextRunAt\": null,\n \"timeZone\": \"America/Chicago\",\n \"lastRun\": null,\n \"myPermissionLevel\": \"manage\",\n \"hidden\": false,\n \"targetProjectId\": null,\n \"archived\": false,\n \"sql\": \"select * from {{table}} where id = {{id}} and state = '{{state}}'\",\n \"expandedArguments\": {\n \"id\": null,\n \"state\": null,\n \"state.literal\": null,\n \"state.identifier\": null,\n \"state.shell_escaped\": null,\n \"table\": \"\",\n \"table.literal\": \"''\",\n \"table.identifier\": \"\\\"\\\"\",\n \"table.shell_escaped\": \"''\"\n },\n \"remoteHostId\": 205,\n \"credentialId\": 557,\n \"codePreview\": \"select * from where id = {{id}} and state = '{{state}}'\",\n \"csvSettings\": {\n \"includeHeader\": true,\n \"compression\": \"gzip\",\n \"columnDelimiter\": \"comma\",\n \"unquoted\": false,\n \"forceMultifile\": false,\n \"filenamePrefix\": null,\n \"maxFileSize\": null\n },\n \"runningAsId\": 2300\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"ff0b6d58310e576966c57043e47d54d3\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"585563e0-bb5d-488a-847e-7a015a599c6d","X-Runtime":"0.049912","Content-Length":"2222"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/scripts/sql/2249\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer MCBMXCmq2XladYDSiXWy-JnuyuLHiWKNb4QK8SUKo5E\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"put":{"summary":"Replace all attributes of this SQL Script","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID for the script.","type":"integer"},{"name":"Object546","in":"body","schema":{"$ref":"#/definitions/Object546"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object544"}}},"x-examples":[{"resource":"Scripts","resource_explanation":null,"http_method":"PUT","route":"http://api.civis.test/scripts/sql/:id","description":"Update a SQL Script via Put","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"PUT","request_path":"http://api.civis.test/scripts/sql/2451","request_body":"{\n \"name\": \"My updated SQL script\",\n \"parent_id\": null,\n \"sql\": \"select * from a_new.table\",\n \"remote_host_id\": 298,\n \"credential_id\": 830,\n \"running_as_id\": 2512,\n \"notifications\": {\n \"success_email_addresses\": \"test3@civisanalytics.com\",\n \"failure_email_addresses\": \"test4@civisanalytics.com\",\n \"urls\": \"civisanalytics2.com\",\n \"successEmailSubject\": \"new test subject\",\n \"successEmailBody\": \"new test body\",\n \"stallWarningMinutes\": 30,\n \"successOn\": true,\n \"failureOn\": false\n }\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer yIQLLjRRu2YmWo-Go9kjUcZkKozl7WPBCpXVmlBV_ro","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 2451,\n \"name\": \"My updated SQL script\",\n \"type\": \"SQL\",\n \"createdAt\": \"2024-12-03T19:46:06.000Z\",\n \"updatedAt\": \"2024-12-03T19:46:06.000Z\",\n \"author\": {\n \"id\": 2512,\n \"name\": \"User devuserfactory2035 2035\",\n \"username\": \"devuserfactory2035\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"state\": \"running\",\n \"finishedAt\": \"2024-12-03T19:46:06.000Z\",\n \"category\": \"script\",\n \"projects\": [\n {\n \"id\": 47,\n \"name\": \"Test Project\"\n }\n ],\n \"parentId\": null,\n \"userContext\": \"runner\",\n \"params\": [\n\n ],\n \"arguments\": {\n },\n \"isTemplate\": false,\n \"publishedAsTemplateId\": null,\n \"fromTemplateId\": null,\n \"templateDependentsCount\": null,\n \"templateScriptName\": null,\n \"links\": {\n \"details\": \"api.civis.test/scripts/sql/2451\",\n \"runs\": \"api.civis.test/scripts/sql/2451/runs\"\n },\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n },\n \"notifications\": {\n \"urls\": [\n \"civisanalytics2.com\"\n ],\n \"successEmailSubject\": \"new test subject\",\n \"successEmailBody\": \"new test body\",\n \"successEmailAddresses\": [\n \"test3@civisanalytics.com\"\n ],\n \"successEmailFromName\": null,\n \"successEmailReplyTo\": null,\n \"failureEmailAddresses\": [\n \"test4@civisanalytics.com\"\n ],\n \"stallWarningMinutes\": 30,\n \"successOn\": true,\n \"failureOn\": false\n },\n \"runningAs\": {\n \"id\": 2512,\n \"name\": \"User devuserfactory2035 2035\",\n \"username\": \"devuserfactory2035\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"nextRunAt\": null,\n \"timeZone\": \"America/Chicago\",\n \"lastRun\": {\n \"id\": 216,\n \"state\": \"running\",\n \"createdAt\": \"2024-12-03T19:46:06.000Z\",\n \"startedAt\": null,\n \"finishedAt\": \"2024-12-03T19:46:06.000Z\",\n \"error\": null\n },\n \"myPermissionLevel\": \"manage\",\n \"hidden\": false,\n \"targetProjectId\": null,\n \"archived\": false,\n \"sql\": \"select * from a_new.table\",\n \"expandedArguments\": {\n },\n \"remoteHostId\": 298,\n \"credentialId\": 830,\n \"codePreview\": \"select * from a_new.table\",\n \"csvSettings\": {\n \"includeHeader\": true,\n \"compression\": \"gzip\",\n \"columnDelimiter\": \"comma\",\n \"unquoted\": false,\n \"forceMultifile\": false,\n \"filenamePrefix\": null,\n \"maxFileSize\": null\n },\n \"runningAsId\": 2512\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"44195027e42e8c57a769ce1e91879427\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"95730af5-8d96-4171-a509-80f1017a3d2c","X-Runtime":"0.159517","Content-Length":"1884"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/scripts/sql/2451\" -d '{\"name\":\"My updated SQL script\",\"parent_id\":null,\"sql\":\"select * from a_new.table\",\"remote_host_id\":298,\"credential_id\":830,\"running_as_id\":2512,\"notifications\":{\"success_email_addresses\":\"test3@civisanalytics.com\",\"failure_email_addresses\":\"test4@civisanalytics.com\",\"urls\":\"civisanalytics2.com\",\"successEmailSubject\":\"new test subject\",\"successEmailBody\":\"new test body\",\"stallWarningMinutes\":30,\"successOn\":true,\"failureOn\":false}}' -X PUT \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer yIQLLjRRu2YmWo-Go9kjUcZkKozl7WPBCpXVmlBV_ro\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"patch":{"summary":"Update some attributes of this SQL Script","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID for the script.","type":"integer"},{"name":"Object547","in":"body","schema":{"$ref":"#/definitions/Object547"},"required":false}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object544"}}},"x-examples":[{"resource":"Scripts","resource_explanation":null,"http_method":"PATCH","route":"http://api.civis.test/scripts/sql/:id","description":"Update a SQL Script via Patch","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"PATCH","request_path":"http://api.civis.test/scripts/sql/2396","request_body":"{\n \"name\": \"My updated SQL script\",\n \"sql\": \"select * from a_new.table\",\n \"schedule\": {\n \"scheduled\": true,\n \"scheduledDays\": [\n 1\n ],\n \"scheduledHours\": [\n 0,\n 4\n ],\n \"scheduledMinutes\": [\n 15\n ],\n \"scheduledRunsPerHour\": null\n },\n \"notifications\": {\n \"success_email_addresses\": \"test3@civisanalytics.com\",\n \"failure_email_addresses\": \"test4@civisanalytics.com\",\n \"urls\": \"civisanalytics2.com\",\n \"successEmailSubject\": \"new test subject\",\n \"successEmailBody\": \"new test body\",\n \"stallWarningMinutes\": 30,\n \"successOn\": true,\n \"failureOn\": false\n }\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer q311ZYywFiHXp9D6930aV69ZRm1jeoxLUM8boRSL4A0","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 2396,\n \"name\": \"My updated SQL script\",\n \"type\": \"SQL\",\n \"createdAt\": \"2024-12-03T19:45:59.000Z\",\n \"updatedAt\": \"2024-12-03T19:46:00.000Z\",\n \"author\": {\n \"id\": 2457,\n \"name\": \"User devuserfactory1988 1988\",\n \"username\": \"devuserfactory1988\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"state\": \"running\",\n \"finishedAt\": \"2024-12-03T19:45:59.000Z\",\n \"category\": \"script\",\n \"projects\": [\n {\n \"id\": 41,\n \"name\": \"Test Project\"\n }\n ],\n \"parentId\": null,\n \"userContext\": \"runner\",\n \"params\": [\n {\n \"name\": \"id\",\n \"label\": \"ID\",\n \"description\": null,\n \"type\": \"integer\",\n \"required\": true,\n \"value\": null,\n \"default\": null,\n \"allowedValues\": [\n\n ]\n },\n {\n \"name\": \"state\",\n \"label\": \"State\",\n \"description\": null,\n \"type\": \"string\",\n \"required\": true,\n \"value\": null,\n \"default\": null,\n \"allowedValues\": [\n\n ]\n },\n {\n \"name\": \"table\",\n \"label\": \"Table\",\n \"description\": null,\n \"type\": \"string\",\n \"required\": false,\n \"value\": null,\n \"default\": null,\n \"allowedValues\": [\n\n ]\n },\n {\n \"name\": \"abool\",\n \"label\": \"A Bool\",\n \"description\": null,\n \"type\": \"bool\",\n \"required\": false,\n \"value\": null,\n \"default\": false,\n \"allowedValues\": [\n\n ]\n },\n {\n \"name\": \"afloat\",\n \"label\": \"A Float\",\n \"description\": null,\n \"type\": \"float\",\n \"required\": false,\n \"value\": null,\n \"default\": null,\n \"allowedValues\": [\n\n ]\n },\n {\n \"name\": \"optionalstr\",\n \"label\": \"Optional String\",\n \"description\": null,\n \"type\": \"string\",\n \"required\": false,\n \"value\": null,\n \"default\": null,\n \"allowedValues\": [\n\n ]\n },\n {\n \"name\": \"cred\",\n \"label\": \"Cred\",\n \"description\": null,\n \"type\": \"credential_redshift\",\n \"required\": false,\n \"value\": null,\n \"default\": null,\n \"allowedValues\": [\n\n ]\n },\n {\n \"name\": \"cred2\",\n \"label\": \"Cred AWS\",\n \"description\": null,\n \"type\": \"credential_aws\",\n \"required\": false,\n \"value\": null,\n \"default\": null,\n \"allowedValues\": [\n\n ]\n }\n ],\n \"arguments\": {\n \"id\": 2,\n \"state\": \"IL\",\n \"table\": \"test.test\"\n },\n \"isTemplate\": false,\n \"publishedAsTemplateId\": null,\n \"fromTemplateId\": null,\n \"templateDependentsCount\": null,\n \"templateScriptName\": null,\n \"links\": {\n \"details\": \"api.civis.test/scripts/sql/2396\",\n \"runs\": \"api.civis.test/scripts/sql/2396/runs\"\n },\n \"schedule\": {\n \"scheduled\": true,\n \"scheduledDays\": [\n 1\n ],\n \"scheduledHours\": [\n 0,\n 4\n ],\n \"scheduledMinutes\": [\n 15\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n },\n \"notifications\": {\n \"urls\": [\n \"civisanalytics2.com\"\n ],\n \"successEmailSubject\": \"new test subject\",\n \"successEmailBody\": \"new test body\",\n \"successEmailAddresses\": [\n \"test3@civisanalytics.com\"\n ],\n \"successEmailFromName\": null,\n \"successEmailReplyTo\": null,\n \"failureEmailAddresses\": [\n \"test4@civisanalytics.com\"\n ],\n \"stallWarningMinutes\": 30,\n \"successOn\": true,\n \"failureOn\": false\n },\n \"runningAs\": {\n \"id\": 2457,\n \"name\": \"User devuserfactory1988 1988\",\n \"username\": \"devuserfactory1988\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"nextRunAt\": \"2024-12-09T06:15:00.000Z\",\n \"timeZone\": \"America/Chicago\",\n \"lastRun\": {\n \"id\": 210,\n \"state\": \"running\",\n \"createdAt\": \"2024-12-03T19:45:59.000Z\",\n \"startedAt\": null,\n \"finishedAt\": \"2024-12-03T19:45:59.000Z\",\n \"error\": null\n },\n \"myPermissionLevel\": \"manage\",\n \"hidden\": false,\n \"targetProjectId\": null,\n \"archived\": false,\n \"sql\": \"select * from a_new.table\",\n \"expandedArguments\": {\n \"id\": 2,\n \"state\": \"IL\",\n \"state.literal\": \"'IL'\",\n \"state.identifier\": \"\\\"IL\\\"\",\n \"state.shell_escaped\": \"IL\",\n \"table\": \"test.test\",\n \"table.literal\": \"'test.test'\",\n \"table.identifier\": \"\\\"test.test\\\"\",\n \"table.shell_escaped\": \"test.test\",\n \"abool\": false,\n \"afloat\": 0,\n \"optionalstr\": \"\",\n \"optionalstr.literal\": \"''\",\n \"optionalstr.identifier\": \"\\\"\\\"\",\n \"optionalstr.shell_escaped\": \"''\",\n \"cred.id\": \"\",\n \"cred.username\": \"\",\n \"cred.password\": \"\",\n \"cred2.id\": \"\",\n \"cred2.access_key_id\": \"\",\n \"cred2.secret_access_key\": \"\"\n },\n \"remoteHostId\": 275,\n \"credentialId\": 761,\n \"codePreview\": \"select * from a_new.table\",\n \"csvSettings\": {\n \"includeHeader\": true,\n \"compression\": \"gzip\",\n \"columnDelimiter\": \"comma\",\n \"unquoted\": false,\n \"forceMultifile\": false,\n \"filenamePrefix\": null,\n \"maxFileSize\": null\n },\n \"runningAsId\": 2457\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"b76af624eead8f1bf54ca6a766e48174\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"dfcb99b9-bc32-46a7-bd33-f203337037c2","X-Runtime":"0.128779","Content-Length":"3508"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/scripts/sql/2396\" -d '{\"name\":\"My updated SQL script\",\"sql\":\"select * from a_new.table\",\"schedule\":{\"scheduled\":true,\"scheduledDays\":[1],\"scheduledHours\":[0,4],\"scheduledMinutes\":[15],\"scheduledRunsPerHour\":null},\"notifications\":{\"success_email_addresses\":\"test3@civisanalytics.com\",\"failure_email_addresses\":\"test4@civisanalytics.com\",\"urls\":\"civisanalytics2.com\",\"successEmailSubject\":\"new test subject\",\"successEmailBody\":\"new test body\",\"stallWarningMinutes\":30,\"successOn\":true,\"failureOn\":false}}' -X PATCH \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer q311ZYywFiHXp9D6930aV69ZRm1jeoxLUM8boRSL4A0\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"delete":{"summary":"Archive a SQL Script (deprecated, use archiving endpoints instead)","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/python3":{"post":{"summary":"Create a Python Script","description":null,"deprecated":false,"parameters":[{"name":"Object548","in":"body","schema":{"$ref":"#/definitions/Object548"},"required":true}],"responses":{"201":{"description":"success","schema":{"$ref":"#/definitions/Object549"}}},"x-examples":[{"resource":"Scripts","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/scripts/python3","description":"Create a python script","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/scripts/python3","request_body":"{\n \"name\": \"My new python script\",\n \"source\": \"print('Hello World')\"\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer ved9CeroAsKrCSAF0pjMhA6MsoSihWPfpC2oVTRkUD4","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":201,"response_status_text":"Created","response_body":"{\n \"id\": 2353,\n \"name\": \"My new python script\",\n \"type\": \"Python\",\n \"createdAt\": \"2024-12-03T19:45:54.000Z\",\n \"updatedAt\": \"2024-12-03T19:45:54.000Z\",\n \"author\": {\n \"id\": 2410,\n \"name\": \"User devuserfactory1948 1948\",\n \"username\": \"devuserfactory1948\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"state\": \"idle\",\n \"finishedAt\": null,\n \"category\": \"script\",\n \"projects\": [\n\n ],\n \"parentId\": null,\n \"userContext\": \"runner\",\n \"params\": [\n\n ],\n \"arguments\": {\n },\n \"isTemplate\": false,\n \"publishedAsTemplateId\": null,\n \"fromTemplateId\": null,\n \"templateDependentsCount\": null,\n \"templateScriptName\": null,\n \"links\": {\n \"details\": \"api.civis.test/scripts/python3/2353\",\n \"runs\": \"api.civis.test/scripts/python3/2353/runs\"\n },\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n },\n \"notifications\": {\n \"urls\": [\n\n ],\n \"successEmailSubject\": null,\n \"successEmailBody\": null,\n \"successEmailAddresses\": [\n\n ],\n \"successEmailFromName\": null,\n \"successEmailReplyTo\": null,\n \"failureEmailAddresses\": [\n\n ],\n \"stallWarningMinutes\": null,\n \"successOn\": true,\n \"failureOn\": true\n },\n \"runningAs\": {\n \"id\": 2410,\n \"name\": \"User devuserfactory1948 1948\",\n \"username\": \"devuserfactory1948\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"nextRunAt\": null,\n \"timeZone\": \"America/Chicago\",\n \"lastRun\": null,\n \"myPermissionLevel\": \"manage\",\n \"hidden\": false,\n \"targetProjectId\": null,\n \"archived\": false,\n \"requiredResources\": {\n \"cpu\": null,\n \"memory\": null,\n \"diskSpace\": null\n },\n \"instanceType\": null,\n \"cancelTimeout\": 0,\n \"dockerImageTag\": \"mock_latest_tag\",\n \"partitionLabel\": null,\n \"runningAsId\": 2410,\n \"source\": \"print('Hello World')\"\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"fef3cd0247ee95158d97d325aa0148a9\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"3031aa31-833a-4358-8d2e-ccc5e680b83b","X-Runtime":"0.103710","Content-Length":"1497"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/scripts/python3\" -d '{\"name\":\"My new python script\",\"source\":\"print(\\u0027Hello World\\u0027)\"}' -X POST \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer ved9CeroAsKrCSAF0pjMhA6MsoSihWPfpC2oVTRkUD4\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Scripts","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/scripts/python3","description":"Fails if provides a default param value to required param","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/scripts/python3","request_body":"{\n \"name\": \"My new python script\",\n \"params\": [\n {\n \"name\": \"schema\",\n \"label\": \"Schema\",\n \"description\": \"the schema of the table\",\n \"type\": \"string\",\n \"required\": true,\n \"value\": null,\n \"default\": \"cool_schema\",\n \"allowedValues\": []\n },\n {\n \"name\": \"table\",\n \"label\": \"Table\",\n \"description\": \"the name of the table\",\n \"type\": \"string\",\n \"required\": true,\n \"value\": null,\n \"default\": \"cool_table\",\n \"allowedValues\": []\n }\n ],\n \"source\": \"print(\\\"Hello world\\\")\"\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer QjONc9qGRoPCo7bD9mhj5R4yHCDXEYdj9l6IHMY_yok","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":400,"response_status_text":"Bad Request","response_body":"{\n \"error\": \"bad_request\",\n \"errorDescription\": \"The given request was not as expected: Validation failed: Code.Parameters schema cannot have a default value since it is required., Code.Parameters table cannot have a default value since it is required.\",\n \"code\": 400\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"100fb2be-9940-4c25-a365-f832d04dc32b","X-Runtime":"0.066173","Content-Length":"259"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/scripts/python3\" -d '{\"name\":\"My new python script\",\"params\":[{\"name\":\"schema\",\"label\":\"Schema\",\"description\":\"the schema of the table\",\"type\":\"string\",\"required\":true,\"value\":null,\"default\":\"cool_schema\",\"allowedValues\":[]},{\"name\":\"table\",\"label\":\"Table\",\"description\":\"the name of the table\",\"type\":\"string\",\"required\":true,\"value\":null,\"default\":\"cool_table\",\"allowedValues\":[]}],\"source\":\"print(\\\"Hello world\\\")\"}' -X POST \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer QjONc9qGRoPCo7bD9mhj5R4yHCDXEYdj9l6IHMY_yok\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/scripts/python3/{id}":{"get":{"summary":"Get a Python Script","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object549"}}},"x-examples":[{"resource":"Scripts","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/scripts/python3/:python_id","description":"View a Python script's details","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/scripts/python3/2199","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer nvHi8XEhuCaAEcuihEUAIEt8fdzF7AOL3REq4dALf_k","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 2199,\n \"name\": \"Script #2199\",\n \"type\": \"Python\",\n \"createdAt\": \"2024-12-03T19:45:35.000Z\",\n \"updatedAt\": \"2024-12-03T19:45:35.000Z\",\n \"author\": {\n \"id\": 2252,\n \"name\": \"User devuserfactory1817 1817\",\n \"username\": \"devuserfactory1817\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"state\": \"idle\",\n \"finishedAt\": null,\n \"category\": \"script\",\n \"projects\": [\n\n ],\n \"parentId\": null,\n \"userContext\": \"runner\",\n \"params\": [\n\n ],\n \"arguments\": {\n },\n \"isTemplate\": false,\n \"publishedAsTemplateId\": null,\n \"fromTemplateId\": null,\n \"templateDependentsCount\": null,\n \"templateScriptName\": null,\n \"links\": {\n \"details\": \"api.civis.test/scripts/python3/2199\",\n \"runs\": \"api.civis.test/scripts/python3/2199/runs\"\n },\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n },\n \"notifications\": {\n \"urls\": [\n\n ],\n \"successEmailSubject\": null,\n \"successEmailBody\": null,\n \"successEmailAddresses\": [\n\n ],\n \"successEmailFromName\": null,\n \"successEmailReplyTo\": null,\n \"failureEmailAddresses\": [\n\n ],\n \"stallWarningMinutes\": null,\n \"successOn\": true,\n \"failureOn\": true\n },\n \"runningAs\": {\n \"id\": 2252,\n \"name\": \"User devuserfactory1817 1817\",\n \"username\": \"devuserfactory1817\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"nextRunAt\": null,\n \"timeZone\": \"America/Chicago\",\n \"lastRun\": null,\n \"myPermissionLevel\": \"manage\",\n \"hidden\": false,\n \"targetProjectId\": null,\n \"archived\": false,\n \"requiredResources\": {\n \"cpu\": null,\n \"memory\": null,\n \"diskSpace\": 1.0\n },\n \"instanceType\": null,\n \"cancelTimeout\": 0,\n \"dockerImageTag\": \"mock_latest_tag\",\n \"partitionLabel\": null,\n \"runningAsId\": 2252,\n \"source\": \"print 'Hello World'\"\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"cd3b7f74d115e82dc598b0384d35b63a\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"3938e5b4-2d27-4751-8d2e-1500caa96505","X-Runtime":"0.060167","Content-Length":"1487"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/scripts/python3/2199\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer nvHi8XEhuCaAEcuihEUAIEt8fdzF7AOL3REq4dALf_k\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"put":{"summary":"Replace all attributes of this Python Script","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID for the script.","type":"integer"},{"name":"Object550","in":"body","schema":{"$ref":"#/definitions/Object550"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object549"}}},"x-examples":[{"resource":"Scripts","resource_explanation":null,"http_method":"PUT","route":"http://api.civis.test/scripts/python3/:python_id","description":"Update a Python Script via Put","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"PUT","request_path":"http://api.civis.test/scripts/python3/2480","request_body":"{\n \"id\": 2480,\n \"name\": \"My updated Python script\",\n \"parent_id\": null,\n \"running_as_id\": 2537,\n \"source\": \"print('Hello New World')\"\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer rNnLbjnOruBUsnujgDLRIHiXqvcFIL35R9JEmm7L3TQ","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 2480,\n \"name\": \"My updated Python script\",\n \"type\": \"Python\",\n \"createdAt\": \"2024-12-03T19:46:09.000Z\",\n \"updatedAt\": \"2024-12-03T19:46:09.000Z\",\n \"author\": {\n \"id\": 2537,\n \"name\": \"User devuserfactory2057 2057\",\n \"username\": \"devuserfactory2057\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"state\": \"idle\",\n \"finishedAt\": null,\n \"category\": \"script\",\n \"projects\": [\n\n ],\n \"parentId\": null,\n \"userContext\": \"runner\",\n \"params\": [\n\n ],\n \"arguments\": {\n },\n \"isTemplate\": false,\n \"publishedAsTemplateId\": null,\n \"fromTemplateId\": null,\n \"templateDependentsCount\": null,\n \"templateScriptName\": null,\n \"links\": {\n \"details\": \"api.civis.test/scripts/python3/2480\",\n \"runs\": \"api.civis.test/scripts/python3/2480/runs\"\n },\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n },\n \"notifications\": {\n \"urls\": [\n\n ],\n \"successEmailSubject\": null,\n \"successEmailBody\": null,\n \"successEmailAddresses\": [\n\n ],\n \"successEmailFromName\": null,\n \"successEmailReplyTo\": null,\n \"failureEmailAddresses\": [\n\n ],\n \"stallWarningMinutes\": null,\n \"successOn\": true,\n \"failureOn\": true\n },\n \"runningAs\": {\n \"id\": 2537,\n \"name\": \"User devuserfactory2057 2057\",\n \"username\": \"devuserfactory2057\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"nextRunAt\": null,\n \"timeZone\": \"America/Chicago\",\n \"lastRun\": null,\n \"myPermissionLevel\": \"manage\",\n \"hidden\": false,\n \"targetProjectId\": null,\n \"archived\": false,\n \"requiredResources\": {\n \"cpu\": null,\n \"memory\": null,\n \"diskSpace\": 1.0\n },\n \"instanceType\": null,\n \"cancelTimeout\": 0,\n \"dockerImageTag\": null,\n \"partitionLabel\": null,\n \"runningAsId\": 2537,\n \"source\": \"print('Hello New World')\"\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"be82b2aaf9720a3b768de45dbe0ef541\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"f81edff0-2644-468c-af70-48425ad3bbff","X-Runtime":"0.089531","Content-Length":"1491"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/scripts/python3/2480\" -d '{\"id\":2480,\"name\":\"My updated Python script\",\"parent_id\":null,\"running_as_id\":2537,\"source\":\"print(\\u0027Hello New World\\u0027)\"}' -X PUT \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer rNnLbjnOruBUsnujgDLRIHiXqvcFIL35R9JEmm7L3TQ\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"patch":{"summary":"Update some attributes of this Python Script","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID for the script.","type":"integer"},{"name":"Object551","in":"body","schema":{"$ref":"#/definitions/Object551"},"required":false}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object549"}}},"x-examples":[{"resource":"Scripts","resource_explanation":null,"http_method":"PATCH","route":"http://api.civis.test/scripts/python3/:python_id","description":"Update a Python Script via Patch","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"PATCH","request_path":"http://api.civis.test/scripts/python3/2416","request_body":"{\n \"name\": \"My updated Python script\",\n \"source\": \"print('Hello New World')\"\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer 4mPqJKQSV_pa8qnwsgmW85ILwxJHZf6Be6-bamE3Sn4","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 2416,\n \"name\": \"My updated Python script\",\n \"type\": \"Python\",\n \"createdAt\": \"2024-12-03T19:46:01.000Z\",\n \"updatedAt\": \"2024-12-03T19:46:02.000Z\",\n \"author\": {\n \"id\": 2473,\n \"name\": \"User devuserfactory2002 2002\",\n \"username\": \"devuserfactory2002\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"state\": \"idle\",\n \"finishedAt\": null,\n \"category\": \"script\",\n \"projects\": [\n\n ],\n \"parentId\": null,\n \"userContext\": \"runner\",\n \"params\": [\n\n ],\n \"arguments\": {\n },\n \"isTemplate\": false,\n \"publishedAsTemplateId\": null,\n \"fromTemplateId\": null,\n \"templateDependentsCount\": null,\n \"templateScriptName\": null,\n \"links\": {\n \"details\": \"api.civis.test/scripts/python3/2416\",\n \"runs\": \"api.civis.test/scripts/python3/2416/runs\"\n },\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n },\n \"notifications\": {\n \"urls\": [\n\n ],\n \"successEmailSubject\": null,\n \"successEmailBody\": null,\n \"successEmailAddresses\": [\n\n ],\n \"successEmailFromName\": null,\n \"successEmailReplyTo\": null,\n \"failureEmailAddresses\": [\n\n ],\n \"stallWarningMinutes\": null,\n \"successOn\": true,\n \"failureOn\": true\n },\n \"runningAs\": {\n \"id\": 2473,\n \"name\": \"User devuserfactory2002 2002\",\n \"username\": \"devuserfactory2002\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"nextRunAt\": null,\n \"timeZone\": \"America/Chicago\",\n \"lastRun\": null,\n \"myPermissionLevel\": \"manage\",\n \"hidden\": false,\n \"targetProjectId\": null,\n \"archived\": false,\n \"requiredResources\": {\n \"cpu\": null,\n \"memory\": null,\n \"diskSpace\": 1.0\n },\n \"instanceType\": null,\n \"cancelTimeout\": 0,\n \"dockerImageTag\": \"mock_latest_tag\",\n \"partitionLabel\": null,\n \"runningAsId\": 2473,\n \"source\": \"print('Hello New World')\"\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"eddd20f58c2b72428d9b2e67589a65e2\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"263e3b61-8273-4585-aaa2-e3b34229b15c","X-Runtime":"0.097011","Content-Length":"1504"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/scripts/python3/2416\" -d '{\"name\":\"My updated Python script\",\"source\":\"print(\\u0027Hello New World\\u0027)\"}' -X PATCH \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer 4mPqJKQSV_pa8qnwsgmW85ILwxJHZf6Be6-bamE3Sn4\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"delete":{"summary":"Archive a Python Script (deprecated, use archiving endpoints instead)","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/r":{"post":{"summary":"Create an R Script","description":null,"deprecated":false,"parameters":[{"name":"Object552","in":"body","schema":{"$ref":"#/definitions/Object552"},"required":true}],"responses":{"201":{"description":"success","schema":{"$ref":"#/definitions/Object553"}}},"x-examples":[{"resource":"Scripts","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/scripts/r","description":"Create an R script","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/scripts/r","request_body":"{\n \"name\": \"My new R script\",\n \"source\": \"cat('Hello World')\"\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer sO2S-TUqogDM6lYVKivJNE0oECaQKJuwAK2m_SiiHFw","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":201,"response_status_text":"Created","response_body":"{\n \"id\": 2366,\n \"name\": \"My new R script\",\n \"type\": \"R\",\n \"createdAt\": \"2024-12-03T19:45:55.000Z\",\n \"updatedAt\": \"2024-12-03T19:45:55.000Z\",\n \"author\": {\n \"id\": 2424,\n \"name\": \"User devuserfactory1960 1960\",\n \"username\": \"devuserfactory1960\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"state\": \"idle\",\n \"finishedAt\": null,\n \"category\": \"script\",\n \"projects\": [\n\n ],\n \"parentId\": null,\n \"userContext\": \"runner\",\n \"params\": [\n\n ],\n \"arguments\": {\n },\n \"isTemplate\": false,\n \"publishedAsTemplateId\": null,\n \"fromTemplateId\": null,\n \"templateDependentsCount\": null,\n \"templateScriptName\": null,\n \"links\": {\n \"details\": \"api.civis.test/scripts/r/2366\",\n \"runs\": \"api.civis.test/scripts/r/2366/runs\"\n },\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n },\n \"notifications\": {\n \"urls\": [\n\n ],\n \"successEmailSubject\": null,\n \"successEmailBody\": null,\n \"successEmailAddresses\": [\n\n ],\n \"successEmailFromName\": null,\n \"successEmailReplyTo\": null,\n \"failureEmailAddresses\": [\n\n ],\n \"stallWarningMinutes\": null,\n \"successOn\": true,\n \"failureOn\": true\n },\n \"runningAs\": {\n \"id\": 2424,\n \"name\": \"User devuserfactory1960 1960\",\n \"username\": \"devuserfactory1960\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"nextRunAt\": null,\n \"timeZone\": \"America/Chicago\",\n \"lastRun\": null,\n \"myPermissionLevel\": \"manage\",\n \"hidden\": false,\n \"targetProjectId\": null,\n \"archived\": false,\n \"requiredResources\": {\n \"cpu\": null,\n \"memory\": null,\n \"diskSpace\": null\n },\n \"instanceType\": null,\n \"cancelTimeout\": 0,\n \"dockerImageTag\": \"mock_latest_tag\",\n \"partitionLabel\": null,\n \"runningAsId\": 2424,\n \"source\": \"cat('Hello World')\"\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"b2568a2883e18d732ded793d8ad471e6\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"c8f8553a-d1ab-4dce-b001-4a3fe1a9e1c6","X-Runtime":"0.141476","Content-Length":"1473"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/scripts/r\" -d '{\"name\":\"My new R script\",\"source\":\"cat(\\u0027Hello World\\u0027)\"}' -X POST \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer sO2S-TUqogDM6lYVKivJNE0oECaQKJuwAK2m_SiiHFw\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Scripts","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/scripts/r","description":"Fails if provides a default param value to required param","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/scripts/r","request_body":"{\n \"name\": \"My new R script\",\n \"params\": [\n {\n \"name\": \"schema\",\n \"label\": \"Schema\",\n \"description\": \"the schema of the table\",\n \"type\": \"string\",\n \"required\": true,\n \"value\": null,\n \"default\": \"cool_schema\",\n \"allowedValues\": []\n },\n {\n \"name\": \"table\",\n \"label\": \"Table\",\n \"description\": \"the name of the table\",\n \"type\": \"string\",\n \"required\": true,\n \"value\": null,\n \"default\": \"cool_table\",\n \"allowedValues\": []\n }\n ],\n \"source\": \"cat(\\\"Hello world\\\")\"\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer 7jwjdtpRuTKp4KTpSIXLi8n1sJxxCdPfQY1013SFQwU","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":400,"response_status_text":"Bad Request","response_body":"{\n \"error\": \"bad_request\",\n \"errorDescription\": \"The given request was not as expected: Validation failed: Code.Parameters schema cannot have a default value since it is required., Code.Parameters table cannot have a default value since it is required.\",\n \"code\": 400\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"f41b9f68-15ff-4f5a-a2d3-364ea3a95e9a","X-Runtime":"0.055710","Content-Length":"259"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/scripts/r\" -d '{\"name\":\"My new R script\",\"params\":[{\"name\":\"schema\",\"label\":\"Schema\",\"description\":\"the schema of the table\",\"type\":\"string\",\"required\":true,\"value\":null,\"default\":\"cool_schema\",\"allowedValues\":[]},{\"name\":\"table\",\"label\":\"Table\",\"description\":\"the name of the table\",\"type\":\"string\",\"required\":true,\"value\":null,\"default\":\"cool_table\",\"allowedValues\":[]}],\"source\":\"cat(\\\"Hello world\\\")\"}' -X POST \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer 7jwjdtpRuTKp4KTpSIXLi8n1sJxxCdPfQY1013SFQwU\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/scripts/r/{id}":{"get":{"summary":"Get an R Script","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object553"}}},"x-examples":[{"resource":"Scripts","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/scripts/r/:r_id","description":"View an R script's details","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/scripts/r/2208","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer x1RwnT3IxT4aVs4tDC8YDlFky18rDBLr-Nb-0OqsOZA","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 2208,\n \"name\": \"Script #2208\",\n \"type\": \"R\",\n \"createdAt\": \"2024-12-03T19:45:36.000Z\",\n \"updatedAt\": \"2024-12-03T19:45:36.000Z\",\n \"author\": {\n \"id\": 2261,\n \"name\": \"User devuserfactory1825 1825\",\n \"username\": \"devuserfactory1825\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"state\": \"idle\",\n \"finishedAt\": null,\n \"category\": \"script\",\n \"projects\": [\n\n ],\n \"parentId\": null,\n \"userContext\": \"runner\",\n \"params\": [\n\n ],\n \"arguments\": {\n },\n \"isTemplate\": false,\n \"publishedAsTemplateId\": null,\n \"fromTemplateId\": null,\n \"templateDependentsCount\": null,\n \"templateScriptName\": null,\n \"links\": {\n \"details\": \"api.civis.test/scripts/r/2208\",\n \"runs\": \"api.civis.test/scripts/r/2208/runs\"\n },\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n },\n \"notifications\": {\n \"urls\": [\n\n ],\n \"successEmailSubject\": null,\n \"successEmailBody\": null,\n \"successEmailAddresses\": [\n\n ],\n \"successEmailFromName\": null,\n \"successEmailReplyTo\": null,\n \"failureEmailAddresses\": [\n\n ],\n \"stallWarningMinutes\": null,\n \"successOn\": true,\n \"failureOn\": true\n },\n \"runningAs\": {\n \"id\": 2261,\n \"name\": \"User devuserfactory1825 1825\",\n \"username\": \"devuserfactory1825\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"nextRunAt\": null,\n \"timeZone\": \"America/Chicago\",\n \"lastRun\": null,\n \"myPermissionLevel\": \"manage\",\n \"hidden\": false,\n \"targetProjectId\": null,\n \"archived\": false,\n \"requiredResources\": {\n \"cpu\": null,\n \"memory\": null,\n \"diskSpace\": 1.0\n },\n \"instanceType\": null,\n \"cancelTimeout\": 0,\n \"dockerImageTag\": \"mock_latest_tag\",\n \"partitionLabel\": null,\n \"runningAsId\": 2261,\n \"source\": \"cat('Hello World')\"\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"e54aaa517930589b3070911d34cf1a5e\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"3a788de8-c88b-417e-ac83-a7e45f2942ef","X-Runtime":"0.039921","Content-Length":"1469"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/scripts/r/2208\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer x1RwnT3IxT4aVs4tDC8YDlFky18rDBLr-Nb-0OqsOZA\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"put":{"summary":"Replace all attributes of this R Script","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID for the script.","type":"integer"},{"name":"Object554","in":"body","schema":{"$ref":"#/definitions/Object554"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object553"}}},"x-examples":[{"resource":"Scripts","resource_explanation":null,"http_method":"PUT","route":"http://api.civis.test/scripts/r/:r_id","description":"Update an R Script via Put","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"PUT","request_path":"http://api.civis.test/scripts/r/2489","request_body":"{\n \"id\": 2489,\n \"name\": \"My updated R script\",\n \"parent_id\": null,\n \"running_as_id\": 2546,\n \"source\": \"cat('Hello New World')\"\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer B5gQ7spUoWTu6oMxmunI-WWqVi3xxuHzUV2OEAUiBhI","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 2489,\n \"name\": \"My updated R script\",\n \"type\": \"R\",\n \"createdAt\": \"2024-12-03T19:46:10.000Z\",\n \"updatedAt\": \"2024-12-03T19:46:10.000Z\",\n \"author\": {\n \"id\": 2546,\n \"name\": \"User devuserfactory2065 2065\",\n \"username\": \"devuserfactory2065\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"state\": \"idle\",\n \"finishedAt\": null,\n \"category\": \"script\",\n \"projects\": [\n\n ],\n \"parentId\": null,\n \"userContext\": \"runner\",\n \"params\": [\n\n ],\n \"arguments\": {\n },\n \"isTemplate\": false,\n \"publishedAsTemplateId\": null,\n \"fromTemplateId\": null,\n \"templateDependentsCount\": null,\n \"templateScriptName\": null,\n \"links\": {\n \"details\": \"api.civis.test/scripts/r/2489\",\n \"runs\": \"api.civis.test/scripts/r/2489/runs\"\n },\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n },\n \"notifications\": {\n \"urls\": [\n\n ],\n \"successEmailSubject\": null,\n \"successEmailBody\": null,\n \"successEmailAddresses\": [\n\n ],\n \"successEmailFromName\": null,\n \"successEmailReplyTo\": null,\n \"failureEmailAddresses\": [\n\n ],\n \"stallWarningMinutes\": null,\n \"successOn\": true,\n \"failureOn\": true\n },\n \"runningAs\": {\n \"id\": 2546,\n \"name\": \"User devuserfactory2065 2065\",\n \"username\": \"devuserfactory2065\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"nextRunAt\": null,\n \"timeZone\": \"America/Chicago\",\n \"lastRun\": null,\n \"myPermissionLevel\": \"manage\",\n \"hidden\": false,\n \"targetProjectId\": null,\n \"archived\": false,\n \"requiredResources\": {\n \"cpu\": null,\n \"memory\": null,\n \"diskSpace\": 1.0\n },\n \"instanceType\": null,\n \"cancelTimeout\": 0,\n \"dockerImageTag\": null,\n \"partitionLabel\": null,\n \"runningAsId\": 2546,\n \"source\": \"cat('Hello New World')\"\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"5dc0e626e207c778088524910fb9cf6c\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"39182e10-1b0b-4cb5-b70f-026c43a5e84e","X-Runtime":"0.093974","Content-Length":"1467"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/scripts/r/2489\" -d '{\"id\":2489,\"name\":\"My updated R script\",\"parent_id\":null,\"running_as_id\":2546,\"source\":\"cat(\\u0027Hello New World\\u0027)\"}' -X PUT \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer B5gQ7spUoWTu6oMxmunI-WWqVi3xxuHzUV2OEAUiBhI\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"patch":{"summary":"Update some attributes of this R Script","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID for the script.","type":"integer"},{"name":"Object555","in":"body","schema":{"$ref":"#/definitions/Object555"},"required":false}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object553"}}},"x-examples":[{"resource":"Scripts","resource_explanation":null,"http_method":"PATCH","route":"http://api.civis.test/scripts/r/:r_id","description":"Update an R Script via Patch","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"PATCH","request_path":"http://api.civis.test/scripts/r/2425","request_body":"{\n \"name\": \"My updated R script\",\n \"source\": \"cat('Hello New World')\"\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer a-lGknPYK8ywZoM83c0Dcp2SvZDpfUjpMRNS6tHw40Y","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 2425,\n \"name\": \"My updated R script\",\n \"type\": \"R\",\n \"createdAt\": \"2024-12-03T19:46:02.000Z\",\n \"updatedAt\": \"2024-12-03T19:46:03.000Z\",\n \"author\": {\n \"id\": 2482,\n \"name\": \"User devuserfactory2010 2010\",\n \"username\": \"devuserfactory2010\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"state\": \"idle\",\n \"finishedAt\": null,\n \"category\": \"script\",\n \"projects\": [\n\n ],\n \"parentId\": null,\n \"userContext\": \"runner\",\n \"params\": [\n\n ],\n \"arguments\": {\n },\n \"isTemplate\": false,\n \"publishedAsTemplateId\": null,\n \"fromTemplateId\": null,\n \"templateDependentsCount\": null,\n \"templateScriptName\": null,\n \"links\": {\n \"details\": \"api.civis.test/scripts/r/2425\",\n \"runs\": \"api.civis.test/scripts/r/2425/runs\"\n },\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n },\n \"notifications\": {\n \"urls\": [\n\n ],\n \"successEmailSubject\": null,\n \"successEmailBody\": null,\n \"successEmailAddresses\": [\n\n ],\n \"successEmailFromName\": null,\n \"successEmailReplyTo\": null,\n \"failureEmailAddresses\": [\n\n ],\n \"stallWarningMinutes\": null,\n \"successOn\": true,\n \"failureOn\": true\n },\n \"runningAs\": {\n \"id\": 2482,\n \"name\": \"User devuserfactory2010 2010\",\n \"username\": \"devuserfactory2010\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"nextRunAt\": null,\n \"timeZone\": \"America/Chicago\",\n \"lastRun\": null,\n \"myPermissionLevel\": \"manage\",\n \"hidden\": false,\n \"targetProjectId\": null,\n \"archived\": false,\n \"requiredResources\": {\n \"cpu\": null,\n \"memory\": null,\n \"diskSpace\": 1.0\n },\n \"instanceType\": null,\n \"cancelTimeout\": 0,\n \"dockerImageTag\": \"mock_latest_tag\",\n \"partitionLabel\": null,\n \"runningAsId\": 2482,\n \"source\": \"cat('Hello New World')\"\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"6926cc54eacb4084668801df02aa07a1\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"23f63c49-37b8-4cb5-b011-4c51af026961","X-Runtime":"0.118605","Content-Length":"1480"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/scripts/r/2425\" -d '{\"name\":\"My updated R script\",\"source\":\"cat(\\u0027Hello New World\\u0027)\"}' -X PATCH \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer a-lGknPYK8ywZoM83c0Dcp2SvZDpfUjpMRNS6tHw40Y\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"delete":{"summary":"Archive an R Script (deprecated, use archiving endpoints instead)","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/dbt":{"post":{"summary":"Create a dbt Script","description":null,"deprecated":false,"parameters":[{"name":"Object556","in":"body","schema":{"$ref":"#/definitions/Object556"},"required":true}],"responses":{"201":{"description":"success","schema":{"$ref":"#/definitions/Object559"}}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/dbt/{id}":{"get":{"summary":"Get a dbt Script","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object559"}}},"x-examples":null,"x-deprecation-warning":null},"put":{"summary":"Replace all attributes of this dbt Script","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID for the script.","type":"integer"},{"name":"Object562","in":"body","schema":{"$ref":"#/definitions/Object562"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object559"}}},"x-examples":null,"x-deprecation-warning":null},"patch":{"summary":"Update some attributes of this dbt Script","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID for the script.","type":"integer"},{"name":"Object563","in":"body","schema":{"$ref":"#/definitions/Object563"},"required":false}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object559"}}},"x-examples":null,"x-deprecation-warning":null},"delete":{"summary":"Archive a dbt Script (deprecated, use archiving endpoints instead)","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/javascript":{"post":{"summary":"Create a JavaScript Script","description":null,"deprecated":false,"parameters":[{"name":"Object565","in":"body","schema":{"$ref":"#/definitions/Object565"},"required":true}],"responses":{"201":{"description":"success","schema":{"$ref":"#/definitions/Object566"}}},"x-examples":[{"resource":"Scripts","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/scripts/javascript","description":"Create a JavaScript script","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/scripts/javascript","request_body":"{\n \"name\": \"My new JavaScript script\",\n \"remoteHostId\": 268,\n \"credentialId\": 741,\n \"source\": \"log('Hello World')\"\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer hb9OF-tY7UXfWaQ8k6s8w7s5SvBujLrfJpAXEhsSmSQ","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":201,"response_status_text":"Created","response_body":"{\n \"id\": 2381,\n \"name\": \"My new JavaScript script\",\n \"type\": \"JavaScript\",\n \"createdAt\": \"2024-12-03T19:45:57.000Z\",\n \"updatedAt\": \"2024-12-03T19:45:57.000Z\",\n \"author\": {\n \"id\": 2438,\n \"name\": \"User devuserfactory1972 1972\",\n \"username\": \"devuserfactory1972\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"state\": \"idle\",\n \"finishedAt\": null,\n \"category\": \"script\",\n \"projects\": [\n\n ],\n \"parentId\": null,\n \"userContext\": \"runner\",\n \"params\": [\n\n ],\n \"arguments\": {\n },\n \"isTemplate\": false,\n \"publishedAsTemplateId\": null,\n \"fromTemplateId\": null,\n \"templateDependentsCount\": null,\n \"templateScriptName\": null,\n \"links\": {\n \"details\": \"api.civis.test/scripts/javascript/2381\",\n \"runs\": \"api.civis.test/scripts/javascript/2381/runs\"\n },\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n },\n \"notifications\": {\n \"urls\": [\n\n ],\n \"successEmailSubject\": null,\n \"successEmailBody\": null,\n \"successEmailAddresses\": [\n\n ],\n \"successEmailFromName\": null,\n \"successEmailReplyTo\": null,\n \"failureEmailAddresses\": [\n\n ],\n \"stallWarningMinutes\": null,\n \"successOn\": true,\n \"failureOn\": true\n },\n \"runningAs\": {\n \"id\": 2438,\n \"name\": \"User devuserfactory1972 1972\",\n \"username\": \"devuserfactory1972\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"nextRunAt\": null,\n \"timeZone\": \"America/Chicago\",\n \"lastRun\": null,\n \"myPermissionLevel\": \"manage\",\n \"hidden\": false,\n \"targetProjectId\": null,\n \"archived\": false,\n \"source\": \"log('Hello World')\",\n \"remoteHostId\": 268,\n \"credentialId\": 741,\n \"runningAsId\": 2438\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"37c91e60ba2a786bc93fff253f438812\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"a5259877-cad3-40be-b783-31b22da5855b","X-Runtime":"0.109764","Content-Length":"1388"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/scripts/javascript\" -d '{\"name\":\"My new JavaScript script\",\"remoteHostId\":268,\"credentialId\":741,\"source\":\"log(\\u0027Hello World\\u0027)\"}' -X POST \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer hb9OF-tY7UXfWaQ8k6s8w7s5SvBujLrfJpAXEhsSmSQ\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/scripts/javascript/{id}":{"get":{"summary":"Get a JavaScript Script","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object566"}}},"x-examples":[{"resource":"Scripts","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/scripts/javascript/:job_id","description":"View a JavaScript script's details","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/scripts/javascript/2216","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer tNTd98rQSbwU8Gfpzsix-1yArOur4YjgKXamVTj0lVE","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 2216,\n \"name\": \"Script #2216\",\n \"type\": \"JavaScript\",\n \"createdAt\": \"2024-12-03T19:45:37.000Z\",\n \"updatedAt\": \"2024-12-03T19:45:37.000Z\",\n \"author\": {\n \"id\": 2270,\n \"name\": \"User devuserfactory1833 1833\",\n \"username\": \"devuserfactory1833\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"state\": \"idle\",\n \"finishedAt\": null,\n \"category\": \"script\",\n \"projects\": [\n\n ],\n \"parentId\": null,\n \"userContext\": \"runner\",\n \"params\": [\n\n ],\n \"arguments\": {\n },\n \"isTemplate\": false,\n \"publishedAsTemplateId\": null,\n \"fromTemplateId\": null,\n \"templateDependentsCount\": null,\n \"templateScriptName\": null,\n \"links\": {\n \"details\": \"api.civis.test/scripts/javascript/2216\",\n \"runs\": \"api.civis.test/scripts/javascript/2216/runs\"\n },\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n },\n \"notifications\": {\n \"urls\": [\n\n ],\n \"successEmailSubject\": \"success email subject\",\n \"successEmailBody\": \"success_email_template\",\n \"successEmailAddresses\": [\n \"script_spec_user@civisanalytics.com\"\n ],\n \"successEmailFromName\": null,\n \"successEmailReplyTo\": null,\n \"failureEmailAddresses\": [\n \"script_spec_user@civisanalytics.com\"\n ],\n \"stallWarningMinutes\": null,\n \"successOn\": true,\n \"failureOn\": true\n },\n \"runningAs\": {\n \"id\": 2270,\n \"name\": \"User devuserfactory1833 1833\",\n \"username\": \"devuserfactory1833\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"nextRunAt\": null,\n \"timeZone\": \"America/Chicago\",\n \"lastRun\": null,\n \"myPermissionLevel\": \"manage\",\n \"hidden\": false,\n \"targetProjectId\": null,\n \"archived\": false,\n \"source\": \"log('hello world')\",\n \"remoteHostId\": 190,\n \"credentialId\": 515,\n \"runningAsId\": 2270\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"5d3137953aa65409751de977e8b4f3c9\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"432057a0-ca57-431b-868e-eda59cb8cb0f","X-Runtime":"0.045108","Content-Length":"1489"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/scripts/javascript/2216\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer tNTd98rQSbwU8Gfpzsix-1yArOur4YjgKXamVTj0lVE\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"put":{"summary":"Replace all attributes of this JavaScript Script","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID for the script.","type":"integer"},{"name":"Object567","in":"body","schema":{"$ref":"#/definitions/Object567"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object566"}}},"x-examples":[{"resource":"Scripts","resource_explanation":null,"http_method":"PUT","route":"http://api.civis.test/scripts/javascript/:job_id","description":"Update a JavaScript Script via Put","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"PUT","request_path":"http://api.civis.test/scripts/javascript/2497","request_body":"{\n \"id\": {\n \"id\": 2497,\n \"name\": \"Script #2497\",\n \"cron\": null,\n \"next_run_at\": null,\n \"created_at\": \"2024-12-03T19:46:11.000Z\",\n \"updated_at\": \"2024-12-03T19:46:11.000Z\",\n \"user_id\": 2555,\n \"success_emails\": \"script_spec_user@civisanalytics.com\",\n \"failure_emails\": \"script_spec_user@civisanalytics.com\",\n \"scheduled\": null,\n \"scheduled_days\": [],\n \"scheduled_hours\": [],\n \"scheduled_runs_per_hour\": null,\n \"ancestry\": null,\n \"parent_run_id\": null,\n \"inherited_traits\": {},\n \"waits_for_descendants\": null,\n \"job_priority\": null,\n \"post_hooks\": \"\",\n \"api_token\": null,\n \"success_email_template\": \"success_email_template\",\n \"success_email_subject\": \"success email subject\",\n \"scheduled_minutes\": [],\n \"stall_warning_minutes\": null,\n \"success_on\": true,\n \"failure_on\": true,\n \"owners_user_set_id\": 5173,\n \"writers_user_set_id\": 5174,\n \"readers_user_set_id\": 5174,\n \"last_run_id\": null,\n \"running_as_id\": null,\n \"archived_at\": null,\n \"time_zone\": \"America/Chicago\",\n \"hidden\": false,\n \"last_run_finished_at\": null,\n \"last_run_updated_at\": null,\n \"last_run_state\": null,\n \"archived\": false,\n \"category\": \"script\",\n \"success_email_from_name\": null,\n \"success_email_reply_to\": null,\n \"warning_on\": true,\n \"warning_emails\": null,\n \"scheduled_days_of_month\": []\n },\n \"name\": \"My updated JavaScript script\",\n \"parentId\": null,\n \"source\": \"log('Hello New World')\",\n \"running_as_id\": 2555,\n \"remoteHostId\": 315,\n \"credentialId\": 877\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer R1yzOCsGFtCvJZ9oHa5Kku3p2taQzZGc9rcAXkBZjXg","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 2497,\n \"name\": \"My updated JavaScript script\",\n \"type\": \"JavaScript\",\n \"createdAt\": \"2024-12-03T19:46:11.000Z\",\n \"updatedAt\": \"2024-12-03T19:46:11.000Z\",\n \"author\": {\n \"id\": 2555,\n \"name\": \"User devuserfactory2073 2073\",\n \"username\": \"devuserfactory2073\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"state\": \"idle\",\n \"finishedAt\": null,\n \"category\": \"script\",\n \"projects\": [\n\n ],\n \"parentId\": null,\n \"userContext\": \"runner\",\n \"params\": [\n\n ],\n \"arguments\": {\n },\n \"isTemplate\": false,\n \"publishedAsTemplateId\": null,\n \"fromTemplateId\": null,\n \"templateDependentsCount\": null,\n \"templateScriptName\": null,\n \"links\": {\n \"details\": \"api.civis.test/scripts/javascript/2497\",\n \"runs\": \"api.civis.test/scripts/javascript/2497/runs\"\n },\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n },\n \"notifications\": {\n \"urls\": [\n\n ],\n \"successEmailSubject\": \"success email subject\",\n \"successEmailBody\": \"success_email_template\",\n \"successEmailAddresses\": [\n \"script_spec_user@civisanalytics.com\"\n ],\n \"successEmailFromName\": null,\n \"successEmailReplyTo\": null,\n \"failureEmailAddresses\": [\n \"script_spec_user@civisanalytics.com\"\n ],\n \"stallWarningMinutes\": null,\n \"successOn\": true,\n \"failureOn\": true\n },\n \"runningAs\": {\n \"id\": 2555,\n \"name\": \"User devuserfactory2073 2073\",\n \"username\": \"devuserfactory2073\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"nextRunAt\": null,\n \"timeZone\": \"America/Chicago\",\n \"lastRun\": null,\n \"myPermissionLevel\": \"manage\",\n \"hidden\": false,\n \"targetProjectId\": null,\n \"archived\": false,\n \"source\": \"log('Hello New World')\",\n \"remoteHostId\": 315,\n \"credentialId\": 877,\n \"runningAsId\": 2555\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"76c9666c5082af90e96028124f47d651\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"71da5e15-fcf7-4d35-b471-6ef3e6ce2b7d","X-Runtime":"0.137095","Content-Length":"1509"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/scripts/javascript/2497\" -d '{\"id\":{\"id\":2497,\"name\":\"Script #2497\",\"cron\":null,\"next_run_at\":null,\"created_at\":\"2024-12-03T19:46:11.000Z\",\"updated_at\":\"2024-12-03T19:46:11.000Z\",\"user_id\":2555,\"success_emails\":\"script_spec_user@civisanalytics.com\",\"failure_emails\":\"script_spec_user@civisanalytics.com\",\"scheduled\":null,\"scheduled_days\":[],\"scheduled_hours\":[],\"scheduled_runs_per_hour\":null,\"ancestry\":null,\"parent_run_id\":null,\"inherited_traits\":{},\"waits_for_descendants\":null,\"job_priority\":null,\"post_hooks\":\"\",\"api_token\":null,\"success_email_template\":\"success_email_template\",\"success_email_subject\":\"success email subject\",\"scheduled_minutes\":[],\"stall_warning_minutes\":null,\"success_on\":true,\"failure_on\":true,\"owners_user_set_id\":5173,\"writers_user_set_id\":5174,\"readers_user_set_id\":5174,\"last_run_id\":null,\"running_as_id\":null,\"archived_at\":null,\"time_zone\":\"America/Chicago\",\"hidden\":false,\"last_run_finished_at\":null,\"last_run_updated_at\":null,\"last_run_state\":null,\"archived\":false,\"category\":\"script\",\"success_email_from_name\":null,\"success_email_reply_to\":null,\"warning_on\":true,\"warning_emails\":null,\"scheduled_days_of_month\":[]},\"name\":\"My updated JavaScript script\",\"parentId\":null,\"source\":\"log(\\u0027Hello New World\\u0027)\",\"running_as_id\":2555,\"remoteHostId\":315,\"credentialId\":877}' -X PUT \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer R1yzOCsGFtCvJZ9oHa5Kku3p2taQzZGc9rcAXkBZjXg\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"patch":{"summary":"Update some attributes of this JavaScript Script","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID for the script.","type":"integer"},{"name":"Object568","in":"body","schema":{"$ref":"#/definitions/Object568"},"required":false}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object566"}}},"x-examples":[{"resource":"Scripts","resource_explanation":null,"http_method":"PATCH","route":"http://api.civis.test/scripts/javascript/:job_id","description":"Update a JavaScript Script via Patch","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"PATCH","request_path":"http://api.civis.test/scripts/javascript/2433","request_body":"{\n \"name\": \"My updated JavaScript script\",\n \"source\": \"log('Hello New World')\"\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer TM6Gm8sKROeRN8snhp7lb5AAq_63CF80Djbs1dL4z8s","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 2433,\n \"name\": \"My updated JavaScript script\",\n \"type\": \"JavaScript\",\n \"createdAt\": \"2024-12-03T19:46:04.000Z\",\n \"updatedAt\": \"2024-12-03T19:46:04.000Z\",\n \"author\": {\n \"id\": 2491,\n \"name\": \"User devuserfactory2018 2018\",\n \"username\": \"devuserfactory2018\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"state\": \"idle\",\n \"finishedAt\": null,\n \"category\": \"script\",\n \"projects\": [\n\n ],\n \"parentId\": null,\n \"userContext\": \"runner\",\n \"params\": [\n\n ],\n \"arguments\": {\n },\n \"isTemplate\": false,\n \"publishedAsTemplateId\": null,\n \"fromTemplateId\": null,\n \"templateDependentsCount\": null,\n \"templateScriptName\": null,\n \"links\": {\n \"details\": \"api.civis.test/scripts/javascript/2433\",\n \"runs\": \"api.civis.test/scripts/javascript/2433/runs\"\n },\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n },\n \"notifications\": {\n \"urls\": [\n\n ],\n \"successEmailSubject\": \"success email subject\",\n \"successEmailBody\": \"success_email_template\",\n \"successEmailAddresses\": [\n \"script_spec_user@civisanalytics.com\"\n ],\n \"successEmailFromName\": null,\n \"successEmailReplyTo\": null,\n \"failureEmailAddresses\": [\n \"script_spec_user@civisanalytics.com\"\n ],\n \"stallWarningMinutes\": null,\n \"successOn\": true,\n \"failureOn\": true\n },\n \"runningAs\": {\n \"id\": 2491,\n \"name\": \"User devuserfactory2018 2018\",\n \"username\": \"devuserfactory2018\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"nextRunAt\": null,\n \"timeZone\": \"America/Chicago\",\n \"lastRun\": null,\n \"myPermissionLevel\": \"manage\",\n \"hidden\": false,\n \"targetProjectId\": null,\n \"archived\": false,\n \"source\": \"log('Hello New World')\",\n \"remoteHostId\": 289,\n \"credentialId\": 802,\n \"runningAsId\": 2491\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"82770927bf373979d70ffe31e9466766\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"5724e130-3e7b-4348-a535-efcb178fb304","X-Runtime":"0.109469","Content-Length":"1509"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/scripts/javascript/2433\" -d '{\"name\":\"My updated JavaScript script\",\"source\":\"log(\\u0027Hello New World\\u0027)\"}' -X PATCH \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer TM6Gm8sKROeRN8snhp7lb5AAq_63CF80Djbs1dL4z8s\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"delete":{"summary":"Archive a JavaScript Script (deprecated, use archiving endpoints instead)","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/custom":{"get":{"summary":"List Custom Scripts","description":null,"deprecated":false,"parameters":[{"name":"from_template_id","in":"query","required":false,"description":"If specified, return scripts based on the template with this ID. Specify multiple IDs as a comma-separated list.","type":"string"},{"name":"author","in":"query","required":false,"description":"If specified, return items from any of these authors. It accepts a comma-separated list of user IDs.","type":"string"},{"name":"status","in":"query","required":false,"description":"If specified, returns items with one of these statuses. It accepts a comma-separated list, possible values are 'running', 'failed', 'succeeded', 'idle', 'scheduled'.","type":"string"},{"name":"hidden","in":"query","required":false,"description":"If specified to be true, returns hidden items. Defaults to false, returning non-hidden items.","type":"boolean"},{"name":"archived","in":"query","required":false,"description":"The archival status of the requested item(s).","type":"string"},{"name":"limit","in":"query","required":false,"description":"Number of results to return. Defaults to its maximum of 50.","type":"integer"},{"name":"page_num","in":"query","required":false,"description":"Page number of the results to return. Defaults to the first page, 1.","type":"integer"},{"name":"order","in":"query","required":false,"description":"The field on which to order the result set. Defaults to updated_at. Must be one of: updated_at, name, created_at.","type":"string"},{"name":"order_dir","in":"query","required":false,"description":"Direction in which to sort, either asc (ascending) or desc (descending) defaulting to asc.","type":"string"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object569"}}}},"x-examples":[{"resource":"Scripts","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/scripts/custom","description":"List all custom scripts","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/scripts/custom","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer SMGOHksF6ZVWtwG5qLMNuUi7fm0_4iEqFolmSmWf_xw","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 2112,\n \"name\": \"awesome sql template #2112\",\n \"type\": \"Custom\",\n \"backingScriptType\": \"SQL\",\n \"createdAt\": \"2024-12-03T19:45:26.000Z\",\n \"updatedAt\": \"2024-12-03T19:45:26.000Z\",\n \"author\": {\n \"id\": 2168,\n \"name\": \"User devuserfactory1754 1754\",\n \"username\": \"devuserfactory1754\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"state\": \"idle\",\n \"finishedAt\": null,\n \"projects\": [\n\n ],\n \"parentId\": null,\n \"fromTemplateId\": 157,\n \"timeZone\": \"America/Chicago\",\n \"lastRun\": null,\n \"archived\": false,\n \"lastSuccessfulRun\": null\n },\n {\n \"id\": 2120,\n \"name\": \"awesome sql template #2120\",\n \"type\": \"Custom\",\n \"backingScriptType\": \"SQL\",\n \"createdAt\": \"2024-12-03T19:45:27.000Z\",\n \"updatedAt\": \"2024-12-03T19:45:27.000Z\",\n \"author\": {\n \"id\": 2175,\n \"name\": \"User devuserfactory1759 1759\",\n \"username\": \"devuserfactory1759\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"state\": \"idle\",\n \"finishedAt\": null,\n \"projects\": [\n\n ],\n \"parentId\": null,\n \"fromTemplateId\": 158,\n \"timeZone\": \"America/Chicago\",\n \"lastRun\": null,\n \"archived\": false,\n \"lastSuccessfulRun\": null\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","X-Pagination-Per-Page":"50","Access-Control-Expose-Headers":"X-Pagination-Per-Page, X-Pagination-Current-Page, X-Pagination-Total-Pages, X-Pagination-Total-Entries","X-Pagination-Current-Page":"1","X-Pagination-Total-Pages":"1","X-Pagination-Total-Entries":"2","Content-Type":"application/json; charset=utf-8","ETag":"W/\"40cef94fe9f3e5688c14aec7e42aa31c\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"cc79235f-151e-4c31-8e52-bc63dfba1990","X-Runtime":"0.036182","Content-Length":"919"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/scripts/custom\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer SMGOHksF6ZVWtwG5qLMNuUi7fm0_4iEqFolmSmWf_xw\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Scripts","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/scripts/custom","description":"Filter custom scripts by template id","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/scripts/custom?fromTemplateId=160","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer VCOdYaaT5vrY_bTwDzCsmwRT8HXU7bEDHnQ_D3eVavQ","Host":"api.civis.test","Cookie":""},"request_query_parameters":{"fromTemplateId":"160"},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 2144,\n \"name\": \"awesome sql template #2144\",\n \"type\": \"Custom\",\n \"backingScriptType\": \"SQL\",\n \"createdAt\": \"2024-12-03T19:45:29.000Z\",\n \"updatedAt\": \"2024-12-03T19:45:29.000Z\",\n \"author\": {\n \"id\": 2198,\n \"name\": \"User devuserfactory1776 1776\",\n \"username\": \"devuserfactory1776\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"state\": \"idle\",\n \"finishedAt\": null,\n \"projects\": [\n\n ],\n \"parentId\": null,\n \"fromTemplateId\": 160,\n \"timeZone\": \"America/Chicago\",\n \"lastRun\": null,\n \"archived\": false,\n \"lastSuccessfulRun\": null\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","X-Pagination-Per-Page":"50","Access-Control-Expose-Headers":"X-Pagination-Per-Page, X-Pagination-Current-Page, X-Pagination-Total-Pages, X-Pagination-Total-Entries","X-Pagination-Current-Page":"1","X-Pagination-Total-Pages":"1","X-Pagination-Total-Entries":"1","Content-Type":"application/json; charset=utf-8","ETag":"W/\"ef92904a47147e88bf2ead40988bf282\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"50677d03-58db-4962-9801-a06721a56f49","X-Runtime":"0.031310","Content-Length":"460"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/scripts/custom?fromTemplateId=160\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer VCOdYaaT5vrY_bTwDzCsmwRT8HXU7bEDHnQ_D3eVavQ\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"post":{"summary":"Create a Custom Script","description":null,"deprecated":false,"parameters":[{"name":"Object570","in":"body","schema":{"$ref":"#/definitions/Object570"},"required":true}],"responses":{"201":{"description":"success","schema":{"$ref":"#/definitions/Object572"}}},"x-examples":[{"resource":"Scripts","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/scripts/custom","description":"Create a custom script","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/scripts/custom","request_body":"{\n \"name\": \"My appified sql script\",\n \"fromTemplateId\": 168,\n \"arguments\": {\n \"id\": 2,\n \"state\": \"IL\",\n \"table\": \"test.test\"\n },\n \"remote_host_id\": 270,\n \"credential_id\": 750\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer 8Ox644yBxgvelgyHlTIj-otbacfTMJPFUs2MNU0gNzs","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":201,"response_status_text":"Created","response_body":"{\n \"id\": 2392,\n \"fromTemplateAliases\": [\n\n ],\n \"name\": \"My appified sql script\",\n \"type\": \"Custom\",\n \"backingScriptType\": \"SQL\",\n \"createdAt\": \"2024-12-03T19:45:59.000Z\",\n \"updatedAt\": \"2024-12-03T19:45:59.000Z\",\n \"author\": {\n \"id\": 2446,\n \"name\": \"User devuserfactory1979 1979\",\n \"username\": \"devuserfactory1979\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"state\": \"idle\",\n \"finishedAt\": null,\n \"category\": \"script\",\n \"projects\": [\n\n ],\n \"parentId\": null,\n \"params\": [\n {\n \"name\": \"id\",\n \"label\": \"ID\",\n \"description\": null,\n \"type\": \"integer\",\n \"required\": true,\n \"value\": null,\n \"default\": null,\n \"allowedValues\": [\n\n ]\n },\n {\n \"name\": \"state\",\n \"label\": \"State\",\n \"description\": null,\n \"type\": \"string\",\n \"required\": true,\n \"value\": null,\n \"default\": null,\n \"allowedValues\": [\n\n ]\n },\n {\n \"name\": \"table\",\n \"label\": \"Table\",\n \"description\": null,\n \"type\": \"string\",\n \"required\": false,\n \"value\": null,\n \"default\": null,\n \"allowedValues\": [\n\n ]\n }\n ],\n \"arguments\": {\n \"id\": 2,\n \"state\": \"IL\",\n \"table\": \"test.test\"\n },\n \"isTemplate\": false,\n \"publishedAsTemplateId\": null,\n \"fromTemplateId\": 168,\n \"uiReportUrl\": null,\n \"uiReportId\": null,\n \"uiReportProvideAPIKey\": null,\n \"templateScriptName\": \"Script #2391\",\n \"templateNote\": null,\n \"remoteHostId\": 270,\n \"credentialId\": 750,\n \"codePreview\": \"select * from test.test where id = 2 and state = 'IL'\",\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n },\n \"notifications\": {\n \"urls\": [\n\n ],\n \"successEmailSubject\": null,\n \"successEmailBody\": null,\n \"successEmailAddresses\": [\n\n ],\n \"successEmailFromName\": null,\n \"successEmailReplyTo\": null,\n \"failureEmailAddresses\": [\n\n ],\n \"stallWarningMinutes\": null,\n \"successOn\": true,\n \"failureOn\": true\n },\n \"runningAs\": {\n \"id\": 2446,\n \"name\": \"User devuserfactory1979 1979\",\n \"username\": \"devuserfactory1979\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"timeZone\": \"America/Chicago\",\n \"lastRun\": null,\n \"myPermissionLevel\": \"manage\",\n \"hidden\": false,\n \"archived\": false,\n \"targetProjectId\": null,\n \"lastSuccessfulRun\": null,\n \"requiredResources\": null,\n \"partitionLabel\": null,\n \"runningAsId\": 2446\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"56b5588cd97b9cd6d7fb294853c7f601\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"f8bc9a13-f445-4c96-a523-b23243d46daf","X-Runtime":"0.384251","Content-Length":"1882"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/scripts/custom\" -d '{\"name\":\"My appified sql script\",\"fromTemplateId\":168,\"arguments\":{\"id\":2,\"state\":\"IL\",\"table\":\"test.test\"},\"remote_host_id\":270,\"credential_id\":750}' -X POST \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer 8Ox644yBxgvelgyHlTIj-otbacfTMJPFUs2MNU0gNzs\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/scripts/custom/{id}":{"get":{"summary":"Get a Custom Script","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object572"}}},"x-examples":[{"resource":"Scripts","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/scripts/custom/:custom_script","description":"View a custom script's details","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/scripts/custom/2271","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer r0ixSC-5rv0CI6ukTbGtphhbutObkDJ9cYCed_AWbrg","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 2271,\n \"fromTemplateAliases\": [\n\n ],\n \"name\": \"awesome sql template #2271\",\n \"type\": \"Custom\",\n \"backingScriptType\": \"SQL\",\n \"createdAt\": \"2024-12-03T19:45:43.000Z\",\n \"updatedAt\": \"2024-12-03T19:45:43.000Z\",\n \"author\": {\n \"id\": 2317,\n \"name\": \"User devuserfactory1871 1871\",\n \"username\": \"devuserfactory1871\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"state\": \"idle\",\n \"finishedAt\": null,\n \"category\": \"script\",\n \"projects\": [\n\n ],\n \"parentId\": null,\n \"params\": [\n {\n \"name\": \"id\",\n \"label\": \"ID\",\n \"description\": null,\n \"type\": \"integer\",\n \"required\": true,\n \"value\": null,\n \"default\": null,\n \"allowedValues\": [\n\n ]\n },\n {\n \"name\": \"state\",\n \"label\": \"State\",\n \"description\": null,\n \"type\": \"string\",\n \"required\": true,\n \"value\": null,\n \"default\": null,\n \"allowedValues\": [\n\n ]\n },\n {\n \"name\": \"table\",\n \"label\": \"Table\",\n \"description\": null,\n \"type\": \"string\",\n \"required\": false,\n \"value\": null,\n \"default\": null,\n \"allowedValues\": [\n\n ]\n }\n ],\n \"arguments\": {\n \"id\": 2,\n \"state\": \"IL\",\n \"table\": \"test.test\"\n },\n \"isTemplate\": false,\n \"publishedAsTemplateId\": null,\n \"fromTemplateId\": 167,\n \"uiReportUrl\": null,\n \"uiReportId\": null,\n \"uiReportProvideAPIKey\": null,\n \"templateScriptName\": \"Script #2268\",\n \"templateNote\": null,\n \"remoteHostId\": 213,\n \"credentialId\": 578,\n \"codePreview\": \"select * from test.test where id = 2 and state = 'IL'\",\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n },\n \"notifications\": {\n \"urls\": [\n\n ],\n \"successEmailSubject\": null,\n \"successEmailBody\": null,\n \"successEmailAddresses\": [\n\n ],\n \"successEmailFromName\": null,\n \"successEmailReplyTo\": null,\n \"failureEmailAddresses\": [\n\n ],\n \"stallWarningMinutes\": null,\n \"successOn\": true,\n \"failureOn\": true\n },\n \"runningAs\": {\n \"id\": 2317,\n \"name\": \"User devuserfactory1871 1871\",\n \"username\": \"devuserfactory1871\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"timeZone\": \"America/Chicago\",\n \"lastRun\": null,\n \"myPermissionLevel\": \"manage\",\n \"hidden\": false,\n \"archived\": false,\n \"targetProjectId\": null,\n \"lastSuccessfulRun\": null,\n \"requiredResources\": null,\n \"partitionLabel\": null,\n \"runningAsId\": 2317\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"e21f83e7cdaa2dd5fd12620d66b22694\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"26348fa5-855d-4010-bf70-e9148d013ed3","X-Runtime":"0.064247","Content-Length":"1886"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/scripts/custom/2271\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer r0ixSC-5rv0CI6ukTbGtphhbutObkDJ9cYCed_AWbrg\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"put":{"summary":"Replace all attributes of this Custom Script","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID for the script.","type":"integer"},{"name":"Object574","in":"body","schema":{"$ref":"#/definitions/Object574"},"required":false}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object572"}}},"x-examples":[{"resource":"Scripts","resource_explanation":null,"http_method":"PUT","route":"http://api.civis.test/scripts/custom/:custom_script_id","description":"Update a Custom Script via Put","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"PUT","request_path":"http://api.civis.test/scripts/custom/2511","request_body":"{\n \"id\": 2511,\n \"name\": \"My updated custom script\",\n \"parent_id\": null,\n \"arguments\": {\n \"id\": 3,\n \"state\": \"FL\",\n \"table\": \"test_new.test_new\"\n },\n \"running_as_id\": 2563,\n \"remote_host_id\": 317,\n \"credential_id\": 886\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer Clf8b4cQTtZMcHcQnPgwMLATKw-V1BiiToOoyXRrFgY","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 2511,\n \"fromTemplateAliases\": [\n\n ],\n \"name\": \"My updated custom script\",\n \"type\": \"Custom\",\n \"backingScriptType\": \"SQL\",\n \"createdAt\": \"2024-12-03T19:46:12.000Z\",\n \"updatedAt\": \"2024-12-03T19:46:12.000Z\",\n \"author\": {\n \"id\": 2563,\n \"name\": \"User devuserfactory2080 2080\",\n \"username\": \"devuserfactory2080\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"state\": \"idle\",\n \"finishedAt\": null,\n \"category\": \"script\",\n \"projects\": [\n\n ],\n \"parentId\": null,\n \"params\": [\n {\n \"name\": \"id\",\n \"label\": \"ID\",\n \"description\": null,\n \"type\": \"integer\",\n \"required\": true,\n \"value\": null,\n \"default\": null,\n \"allowedValues\": [\n\n ]\n },\n {\n \"name\": \"state\",\n \"label\": \"State\",\n \"description\": null,\n \"type\": \"string\",\n \"required\": true,\n \"value\": null,\n \"default\": null,\n \"allowedValues\": [\n\n ]\n },\n {\n \"name\": \"table\",\n \"label\": \"Table\",\n \"description\": null,\n \"type\": \"string\",\n \"required\": false,\n \"value\": null,\n \"default\": null,\n \"allowedValues\": [\n\n ]\n }\n ],\n \"arguments\": {\n \"id\": 3,\n \"state\": \"FL\",\n \"table\": \"test_new.test_new\"\n },\n \"isTemplate\": false,\n \"publishedAsTemplateId\": null,\n \"fromTemplateId\": 170,\n \"uiReportUrl\": null,\n \"uiReportId\": null,\n \"uiReportProvideAPIKey\": null,\n \"templateScriptName\": \"Script #2508\",\n \"templateNote\": null,\n \"remoteHostId\": 317,\n \"credentialId\": 886,\n \"codePreview\": \"select * from test_new.test_new where id = 3 and state = 'FL'\",\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n },\n \"notifications\": {\n \"urls\": [\n\n ],\n \"successEmailSubject\": null,\n \"successEmailBody\": null,\n \"successEmailAddresses\": [\n\n ],\n \"successEmailFromName\": null,\n \"successEmailReplyTo\": null,\n \"failureEmailAddresses\": [\n\n ],\n \"stallWarningMinutes\": null,\n \"successOn\": true,\n \"failureOn\": true\n },\n \"runningAs\": {\n \"id\": 2563,\n \"name\": \"User devuserfactory2080 2080\",\n \"username\": \"devuserfactory2080\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"timeZone\": \"America/Chicago\",\n \"lastRun\": null,\n \"myPermissionLevel\": \"manage\",\n \"hidden\": false,\n \"archived\": false,\n \"targetProjectId\": null,\n \"lastSuccessfulRun\": null,\n \"requiredResources\": null,\n \"partitionLabel\": null,\n \"runningAsId\": 2563\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"2c2aebf1ead782eeb4ffd6c9c385c899\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"8b397963-6a44-4b00-8ff5-dafab97965e7","X-Runtime":"0.177368","Content-Length":"1900"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/scripts/custom/2511\" -d '{\"id\":2511,\"name\":\"My updated custom script\",\"parent_id\":null,\"arguments\":{\"id\":3,\"state\":\"FL\",\"table\":\"test_new.test_new\"},\"running_as_id\":2563,\"remote_host_id\":317,\"credential_id\":886}' -X PUT \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer Clf8b4cQTtZMcHcQnPgwMLATKw-V1BiiToOoyXRrFgY\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"patch":{"summary":"Update some attributes of this Custom Script","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID for the script.","type":"integer"},{"name":"Object574","in":"body","schema":{"$ref":"#/definitions/Object574"},"required":false}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object572"}}},"x-examples":[{"resource":"Scripts","resource_explanation":null,"http_method":"PATCH","route":"http://api.civis.test/scripts/custom/:custom_script_id","description":"Update a Custom Script via Patch","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"PATCH","request_path":"http://api.civis.test/scripts/custom/2447","request_body":"{\n \"name\": \"My updated Custom Script\",\n \"arguments\": {\n \"id\": 3,\n \"state\": \"FL\",\n \"table\": \"test_new.test_new\"\n }\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer DbN-Z9xILkkqbzSo35MuH12PU55BXzWt0prPo0ftuWY","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 2447,\n \"fromTemplateAliases\": [\n\n ],\n \"name\": \"My updated Custom Script\",\n \"type\": \"Custom\",\n \"backingScriptType\": \"SQL\",\n \"createdAt\": \"2024-12-03T19:46:05.000Z\",\n \"updatedAt\": \"2024-12-03T19:46:05.000Z\",\n \"author\": {\n \"id\": 2499,\n \"name\": \"User devuserfactory2025 2025\",\n \"username\": \"devuserfactory2025\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"state\": \"idle\",\n \"finishedAt\": null,\n \"category\": \"script\",\n \"projects\": [\n\n ],\n \"parentId\": null,\n \"params\": [\n {\n \"name\": \"id\",\n \"label\": \"ID\",\n \"description\": null,\n \"type\": \"integer\",\n \"required\": true,\n \"value\": null,\n \"default\": null,\n \"allowedValues\": [\n\n ]\n },\n {\n \"name\": \"state\",\n \"label\": \"State\",\n \"description\": null,\n \"type\": \"string\",\n \"required\": true,\n \"value\": null,\n \"default\": null,\n \"allowedValues\": [\n\n ]\n },\n {\n \"name\": \"table\",\n \"label\": \"Table\",\n \"description\": null,\n \"type\": \"string\",\n \"required\": false,\n \"value\": null,\n \"default\": null,\n \"allowedValues\": [\n\n ]\n }\n ],\n \"arguments\": {\n \"id\": 3,\n \"state\": \"FL\",\n \"table\": \"test_new.test_new\"\n },\n \"isTemplate\": false,\n \"publishedAsTemplateId\": null,\n \"fromTemplateId\": 169,\n \"uiReportUrl\": null,\n \"uiReportId\": null,\n \"uiReportProvideAPIKey\": null,\n \"templateScriptName\": \"Script #2444\",\n \"templateNote\": null,\n \"remoteHostId\": 293,\n \"credentialId\": 813,\n \"codePreview\": \"select * from test_new.test_new where id = 3 and state = 'FL'\",\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n },\n \"notifications\": {\n \"urls\": [\n\n ],\n \"successEmailSubject\": null,\n \"successEmailBody\": null,\n \"successEmailAddresses\": [\n\n ],\n \"successEmailFromName\": null,\n \"successEmailReplyTo\": null,\n \"failureEmailAddresses\": [\n\n ],\n \"stallWarningMinutes\": null,\n \"successOn\": true,\n \"failureOn\": true\n },\n \"runningAs\": {\n \"id\": 2499,\n \"name\": \"User devuserfactory2025 2025\",\n \"username\": \"devuserfactory2025\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"timeZone\": \"America/Chicago\",\n \"lastRun\": null,\n \"myPermissionLevel\": \"manage\",\n \"hidden\": false,\n \"archived\": false,\n \"targetProjectId\": null,\n \"lastSuccessfulRun\": null,\n \"requiredResources\": null,\n \"partitionLabel\": null,\n \"runningAsId\": 2499\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"655cf00273c44de03ff33e120ced7c25\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"0592ffef-f6c4-4f3d-be20-0e2f8b19f0fb","X-Runtime":"0.130173","Content-Length":"1900"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/scripts/custom/2447\" -d '{\"name\":\"My updated Custom Script\",\"arguments\":{\"id\":3,\"state\":\"FL\",\"table\":\"test_new.test_new\"}}' -X PATCH \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer DbN-Z9xILkkqbzSo35MuH12PU55BXzWt0prPo0ftuWY\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"delete":{"summary":"Archive a Custom Script (deprecated, use archiving endpoints instead)","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/sql/{id}/runs":{"post":{"summary":"Start a run","description":"Start a run and provide a URI for checking its status. The response will provide a 'Location' header which will contain a URI which may be polled to monitor the status of the run.","deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the SQL job.","type":"integer"}],"responses":{"202":{"description":"success","schema":{"$ref":"#/definitions/Object576"}}},"x-examples":[{"resource":"Scripts","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/scripts/sql/:script_to_run_id/runs","description":"Create a sql run","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/scripts/sql/2592/runs","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer QI0bYitY2h4rbklQadH7h3n1YkXSndhdaaIF9G76xz8","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":202,"response_status_text":"Accepted","response_body":"{\n \"id\": 233,\n \"sqlId\": 2592,\n \"state\": \"queued\",\n \"isCancelRequested\": false,\n \"createdAt\": \"2024-12-03T19:46:22.000Z\",\n \"startedAt\": null,\n \"finishedAt\": null,\n \"error\": null,\n \"output\": [\n\n ],\n \"outputCachedOn\": null\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Location":"http://api.civis.test/scripts/sql/2592/runs/233","Content-Type":"application/json; charset=utf-8","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"2135f131-4bb3-40f0-9e80-5e37c9d199ee","X-Runtime":"0.170022","Content-Length":"187"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/scripts/sql/2592/runs\" -d '' -X POST \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer QI0bYitY2h4rbklQadH7h3n1YkXSndhdaaIF9G76xz8\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"get":{"summary":"List runs for the given SQL job","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the SQL job.","type":"integer"},{"name":"limit","in":"query","required":false,"description":"Number of results to return. Defaults to 20. Maximum allowed is 100.","type":"integer"},{"name":"page_num","in":"query","required":false,"description":"Page number of the results to return. Defaults to the first page, 1.","type":"integer"},{"name":"order","in":"query","required":false,"description":"The field on which to order the result set. Defaults to id. Must be one of: id.","type":"string"},{"name":"order_dir","in":"query","required":false,"description":"Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc.","type":"string"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object576"}}}},"x-examples":[{"resource":"Scripts","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/scripts/sql/:id/runs","description":"View a SQL script's runs","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/scripts/sql/2799/runs","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer VPLWGpLYUHn2DoNnjuYN1AFEz6CsqD4jhA-TYU54HVw","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 292,\n \"sqlId\": 2799,\n \"state\": \"failed\",\n \"isCancelRequested\": false,\n \"createdAt\": \"2024-12-03T19:46:48.000Z\",\n \"startedAt\": \"2024-12-03T19:45:48.000Z\",\n \"finishedAt\": \"2024-12-04T05:46:48.000Z\",\n \"error\": \"err\",\n \"output\": [\n\n ],\n \"outputCachedOn\": null\n },\n {\n \"id\": 291,\n \"sqlId\": 2799,\n \"state\": \"running\",\n \"isCancelRequested\": false,\n \"createdAt\": \"2024-12-03T19:46:47.000Z\",\n \"startedAt\": null,\n \"finishedAt\": \"2024-12-03T19:46:47.000Z\",\n \"error\": null,\n \"output\": [\n {\n \"outputName\": \"output_file\",\n \"fileId\": 139,\n \"path\": \"http://aws/file.csv\"\n }\n ],\n \"outputCachedOn\": null\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","X-Pagination-Per-Page":"20","Access-Control-Expose-Headers":"X-Pagination-Per-Page, X-Pagination-Current-Page, X-Pagination-Total-Pages, X-Pagination-Total-Entries","X-Pagination-Current-Page":"1","X-Pagination-Total-Pages":"1","X-Pagination-Total-Entries":"2","Content-Type":"application/json; charset=utf-8","ETag":"W/\"7e610181c91b734f69634b94f9a4457b\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"732470ff-e1b8-4b46-abc6-43d7d74a88b8","X-Runtime":"0.042590","Content-Length":"515"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/scripts/sql/2799/runs\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer VPLWGpLYUHn2DoNnjuYN1AFEz6CsqD4jhA-TYU54HVw\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/scripts/sql/{id}/runs/{run_id}":{"get":{"summary":"Check status of a run","description":"View the status of a run. This endpoint may be polled to monitor the status of the run. When the 'state' field is no longer 'queued' or 'running' the run has reached its final state.","deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the SQL job.","type":"integer"},{"name":"run_id","in":"path","required":true,"description":"The ID of the run.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object576"}}},"x-examples":[{"resource":"Scripts","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/scripts/sql/:id/runs/:script_run_id","description":"View a SQL script's run details","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/scripts/sql/2643/runs/244","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer lUWmWA4R60fQAO-Eckj-wWnZA0GHNNdHYOaKlHYaTgM","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 244,\n \"sqlId\": 2643,\n \"state\": \"running\",\n \"isCancelRequested\": false,\n \"createdAt\": \"2024-12-03T19:46:28.000Z\",\n \"startedAt\": null,\n \"finishedAt\": \"2024-12-03T19:46:28.000Z\",\n \"error\": null,\n \"output\": [\n {\n \"outputName\": \"output_file\",\n \"fileId\": 90,\n \"path\": \"http://aws/file.csv\"\n }\n ],\n \"outputCachedOn\": null\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"c26ad3cde0d8fa6c2f9746e8598006dd\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"9502d31a-d365-4dc0-b30f-ec652ca83e77","X-Runtime":"0.036413","Content-Length":"279"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/scripts/sql/2643/runs/244\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer lUWmWA4R60fQAO-Eckj-wWnZA0GHNNdHYOaKlHYaTgM\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"delete":{"summary":"Cancel a run","description":"Cancel a currently active run.","deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the SQL job.","type":"integer"},{"name":"run_id","in":"path","required":true,"description":"The ID of the run.","type":"integer"}],"responses":{"202":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null},"patch":{"summary":"Update the given run","description":"Update the run.","deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"ID of the Job","type":"integer"},{"name":"run_id","in":"path","required":true,"description":"ID of the Run","type":"integer"},{"name":"Object598","in":"body","schema":{"$ref":"#/definitions/Object598"},"required":false}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/sql/{id}/runs/{run_id}/logs":{"get":{"summary":"Get the logs for a run","description":"Get the logs for a run.","deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the SQL job.","type":"integer"},{"name":"run_id","in":"path","required":true,"description":"The ID of the run.","type":"integer"},{"name":"last_id","in":"query","required":false,"description":"The ID of the last log message received. Log entries with this ID value or lower will be omitted.Logs are sorted by ID if this value is provided, and are otherwise sorted by createdAt.","type":"integer"},{"name":"limit","in":"query","required":false,"description":"The maximum number of log messages to return. Default of 10000.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object116"}}}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/containers/{id}/runs":{"post":{"summary":"Start a run","description":"Start a run and provide a URI for checking its status. The response will provide a 'Location' header which will contain a URI which may be polled to monitor the status of the run.","deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Container job.","type":"integer"}],"responses":{"202":{"description":"success","schema":{"$ref":"#/definitions/Object577"}}},"x-examples":[{"resource":"Scripts","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/scripts/containers/:script_to_run_id/runs","description":"Create a container run","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/scripts/containers/2601/runs","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer 29_XgsepCJlbJwe1TSq5aiWoWLcV1Yoxwpfc4KCVMVU","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":202,"response_status_text":"Accepted","response_body":"{\n \"id\": 235,\n \"containerId\": 2601,\n \"state\": \"queued\",\n \"isCancelRequested\": false,\n \"createdAt\": \"2024-12-03T19:46:23.000Z\",\n \"startedAt\": null,\n \"finishedAt\": null,\n \"error\": null,\n \"maxMemoryUsage\": null,\n \"maxCpuUsage\": null\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Location":"http://api.civis.test/scripts/containers/2601/runs/235","Content-Type":"application/json; charset=utf-8","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"0ceb52cc-d001-4773-8c15-84f184e8a0f4","X-Runtime":"0.133217","Content-Length":"200"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/scripts/containers/2601/runs\" -d '' -X POST \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer 29_XgsepCJlbJwe1TSq5aiWoWLcV1Yoxwpfc4KCVMVU\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"get":{"summary":"List runs for the given Container job","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Container job.","type":"integer"},{"name":"limit","in":"query","required":false,"description":"Number of results to return. Defaults to 20. Maximum allowed is 100.","type":"integer"},{"name":"page_num","in":"query","required":false,"description":"Page number of the results to return. Defaults to the first page, 1.","type":"integer"},{"name":"order","in":"query","required":false,"description":"The field on which to order the result set. Defaults to id. Must be one of: id.","type":"string"},{"name":"order_dir","in":"query","required":false,"description":"Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc.","type":"string"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object577"}}}},"x-examples":[{"resource":"Scripts","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/scripts/containers/:script_job_id/runs","description":"View a Container script's runs","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/scripts/containers/2811/runs","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer a4ahf8ZM_Kpn81YaZbup988ZYcxpslWTvb-xiCMUpVc","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 295,\n \"containerId\": 2811,\n \"state\": \"running\",\n \"isCancelRequested\": false,\n \"createdAt\": \"2024-12-03T19:46:49.000Z\",\n \"startedAt\": \"2024-12-03T19:45:49.000Z\",\n \"finishedAt\": \"2024-12-04T05:46:49.000Z\",\n \"error\": null,\n \"maxMemoryUsage\": null,\n \"maxCpuUsage\": null\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","X-Pagination-Per-Page":"20","Access-Control-Expose-Headers":"X-Pagination-Per-Page, X-Pagination-Current-Page, X-Pagination-Total-Pages, X-Pagination-Total-Entries","X-Pagination-Current-Page":"1","X-Pagination-Total-Pages":"1","X-Pagination-Total-Entries":"1","Content-Type":"application/json; charset=utf-8","ETag":"W/\"5c9e6e284fbbaab3b1ea11755fa82516\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"936db003-6a2b-4d73-9d07-f5de43babef4","X-Runtime":"0.030857","Content-Length":"247"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/scripts/containers/2811/runs\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer a4ahf8ZM_Kpn81YaZbup988ZYcxpslWTvb-xiCMUpVc\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/scripts/containers/{id}/runs/{run_id}":{"get":{"summary":"Check status of a run","description":"View the status of a run. This endpoint may be polled to monitor the status of the run. When the 'state' field is no longer 'queued' or 'running' the run has reached its final state.","deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Container job.","type":"integer"},{"name":"run_id","in":"path","required":true,"description":"The ID of the run.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object577"}}},"x-examples":[{"resource":"Scripts","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/scripts/containers/:script_with_run_id/runs/:script_run_id","description":"View a Container script's run details","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/scripts/containers/2652/runs/246","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer FeOkE9dAMJj70jbuGhwOgXbd0Mxbj2-qkOmjzyPzVB8","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 246,\n \"containerId\": 2652,\n \"state\": \"running\",\n \"isCancelRequested\": false,\n \"createdAt\": \"2024-12-03T19:46:29.000Z\",\n \"startedAt\": \"2024-12-03T19:45:29.000Z\",\n \"finishedAt\": \"2024-12-03T19:46:29.000Z\",\n \"error\": null,\n \"maxMemoryUsage\": null,\n \"maxCpuUsage\": null\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"4a11ea26cd8f63e0bf689fc144674ded\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"ba5dcef7-b42e-479b-907c-418f923e5453","X-Runtime":"0.030767","Content-Length":"245"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/scripts/containers/2652/runs/246\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer FeOkE9dAMJj70jbuGhwOgXbd0Mxbj2-qkOmjzyPzVB8\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"delete":{"summary":"Cancel a run","description":"Cancel a currently active run.","deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Container job.","type":"integer"},{"name":"run_id","in":"path","required":true,"description":"The ID of the run.","type":"integer"}],"responses":{"202":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/python3/{id}/runs":{"post":{"summary":"Start a run","description":"Start a run and provide a URI for checking its status. The response will provide a 'Location' header which will contain a URI which may be polled to monitor the status of the run.","deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Python job.","type":"integer"}],"responses":{"202":{"description":"success","schema":{"$ref":"#/definitions/Object578"}}},"x-examples":[{"resource":"Scripts","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/scripts/python3/:script_to_run_id/runs","description":"Create a python run","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/scripts/python3/2610/runs","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer bF7ULpw066ofQlCt4rINb5JWauIo_jvZoNcaDPktUTU","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":202,"response_status_text":"Accepted","response_body":"{\n \"id\": 237,\n \"pythonId\": 2610,\n \"state\": \"queued\",\n \"isCancelRequested\": false,\n \"createdAt\": \"2024-12-03T19:46:24.000Z\",\n \"startedAt\": null,\n \"finishedAt\": null,\n \"error\": null,\n \"maxMemoryUsage\": null,\n \"maxCpuUsage\": null\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Location":"http://api.civis.test/scripts/python3/2610/runs/237","Content-Type":"application/json; charset=utf-8","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"fd9b5a22-938e-4553-980a-826b5e2cd728","X-Runtime":"0.110186","Content-Length":"197"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/scripts/python3/2610/runs\" -d '' -X POST \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer bF7ULpw066ofQlCt4rINb5JWauIo_jvZoNcaDPktUTU\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"get":{"summary":"List runs for the given Python job","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Python job.","type":"integer"},{"name":"limit","in":"query","required":false,"description":"Number of results to return. Defaults to 20. Maximum allowed is 100.","type":"integer"},{"name":"page_num","in":"query","required":false,"description":"Page number of the results to return. Defaults to the first page, 1.","type":"integer"},{"name":"order","in":"query","required":false,"description":"The field on which to order the result set. Defaults to id. Must be one of: id.","type":"string"},{"name":"order_dir","in":"query","required":false,"description":"Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc.","type":"string"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object578"}}}},"x-examples":[{"resource":"Scripts","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/scripts/python3/:script_job_id/runs","description":"View a Python script's runs","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/scripts/python3/2820/runs","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer m6_Ih1jfN7frs5V81aABO3-ERHvqbe-ntFP14sspIj4","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 298,\n \"pythonId\": 2820,\n \"state\": \"running\",\n \"isCancelRequested\": false,\n \"createdAt\": \"2024-12-03T19:46:50.000Z\",\n \"startedAt\": \"2024-12-03T19:45:50.000Z\",\n \"finishedAt\": \"2024-12-04T05:46:50.000Z\",\n \"error\": null,\n \"maxMemoryUsage\": null,\n \"maxCpuUsage\": null\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","X-Pagination-Per-Page":"20","Access-Control-Expose-Headers":"X-Pagination-Per-Page, X-Pagination-Current-Page, X-Pagination-Total-Pages, X-Pagination-Total-Entries","X-Pagination-Current-Page":"1","X-Pagination-Total-Pages":"1","X-Pagination-Total-Entries":"1","Content-Type":"application/json; charset=utf-8","ETag":"W/\"93cdedb8c0de207982d1916e3c06f4a0\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"69db4347-3817-44be-b74c-a2e4c3f356fb","X-Runtime":"0.033654","Content-Length":"244"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/scripts/python3/2820/runs\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer m6_Ih1jfN7frs5V81aABO3-ERHvqbe-ntFP14sspIj4\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/scripts/python3/{id}/runs/{run_id}":{"get":{"summary":"Check status of a run","description":"View the status of a run. This endpoint may be polled to monitor the status of the run. When the 'state' field is no longer 'queued' or 'running' the run has reached its final state.","deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Python job.","type":"integer"},{"name":"run_id","in":"path","required":true,"description":"The ID of the run.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object578"}}},"x-examples":[{"resource":"Scripts","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/scripts/python3/:script_with_run_id/runs/:script_run_id","description":"View a Python script's run details","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/scripts/python3/2661/runs/248","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer _N1FlBu87ZAbQAmnoN3VHOAo9BMLERG998Ee7HqT2UI","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 248,\n \"pythonId\": 2661,\n \"state\": \"running\",\n \"isCancelRequested\": false,\n \"createdAt\": \"2024-12-03T19:46:30.000Z\",\n \"startedAt\": \"2024-12-03T19:45:30.000Z\",\n \"finishedAt\": \"2024-12-03T19:46:30.000Z\",\n \"error\": null,\n \"maxMemoryUsage\": null,\n \"maxCpuUsage\": null\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"34c6f1b582b4c6a4a9985e60088df969\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"b8cf0d77-0f13-4d9d-b51f-143ae9507fb4","X-Runtime":"0.029178","Content-Length":"242"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/scripts/python3/2661/runs/248\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer _N1FlBu87ZAbQAmnoN3VHOAo9BMLERG998Ee7HqT2UI\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"delete":{"summary":"Cancel a run","description":"Cancel a currently active run.","deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Python job.","type":"integer"},{"name":"run_id","in":"path","required":true,"description":"The ID of the run.","type":"integer"}],"responses":{"202":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null},"patch":{"summary":"Update the given run","description":"Update the run.","deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"ID of the Job","type":"integer"},{"name":"run_id","in":"path","required":true,"description":"ID of the Run","type":"integer"},{"name":"Object596","in":"body","schema":{"$ref":"#/definitions/Object596"},"required":false}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/python3/{id}/runs/{run_id}/logs":{"get":{"summary":"Get the logs for a run","description":"Get the logs for a run.","deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Python job.","type":"integer"},{"name":"run_id","in":"path","required":true,"description":"The ID of the run.","type":"integer"},{"name":"last_id","in":"query","required":false,"description":"The ID of the last log message received. Log entries with this ID value or lower will be omitted.Logs are sorted by ID if this value is provided, and are otherwise sorted by createdAt.","type":"integer"},{"name":"limit","in":"query","required":false,"description":"The maximum number of log messages to return. Default of 10000.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object116"}}}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/r/{id}/runs":{"post":{"summary":"Start a run","description":"Start a run and provide a URI for checking its status. The response will provide a 'Location' header which will contain a URI which may be polled to monitor the status of the run.","deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the R job.","type":"integer"}],"responses":{"202":{"description":"success","schema":{"$ref":"#/definitions/Object579"}}},"x-examples":[{"resource":"Scripts","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/scripts/r/:script_to_run_id/runs","description":"Create an R run","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/scripts/r/2619/runs","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer ZwNAsRTVcEAen6W2yFeEM5a5xZOXeuzNpNlsPpQx8z4","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":202,"response_status_text":"Accepted","response_body":"{\n \"id\": 239,\n \"rId\": 2619,\n \"state\": \"queued\",\n \"isCancelRequested\": false,\n \"createdAt\": \"2024-12-03T19:46:25.000Z\",\n \"startedAt\": null,\n \"finishedAt\": null,\n \"error\": null,\n \"maxMemoryUsage\": null,\n \"maxCpuUsage\": null\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Location":"http://api.civis.test/scripts/r/2619/runs/239","Content-Type":"application/json; charset=utf-8","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"467ab180-b812-42ef-8d1e-27f569f663f9","X-Runtime":"0.114546","Content-Length":"192"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/scripts/r/2619/runs\" -d '' -X POST \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer ZwNAsRTVcEAen6W2yFeEM5a5xZOXeuzNpNlsPpQx8z4\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"get":{"summary":"List runs for the given R job","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the R job.","type":"integer"},{"name":"limit","in":"query","required":false,"description":"Number of results to return. Defaults to 20. Maximum allowed is 100.","type":"integer"},{"name":"page_num","in":"query","required":false,"description":"Page number of the results to return. Defaults to the first page, 1.","type":"integer"},{"name":"order","in":"query","required":false,"description":"The field on which to order the result set. Defaults to id. Must be one of: id.","type":"string"},{"name":"order_dir","in":"query","required":false,"description":"Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc.","type":"string"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object579"}}}},"x-examples":[{"resource":"Scripts","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/scripts/r/:script_job_id/runs","description":"View an R script's runs","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/scripts/r/2829/runs","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer 1Rl6ICeurTLW6jUypCMfvJLtK0hjaJPWblBJN09zbeo","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 301,\n \"rId\": 2829,\n \"state\": \"running\",\n \"isCancelRequested\": false,\n \"createdAt\": \"2024-12-03T19:46:50.000Z\",\n \"startedAt\": \"2024-12-03T19:45:50.000Z\",\n \"finishedAt\": \"2024-12-04T05:46:50.000Z\",\n \"error\": null,\n \"maxMemoryUsage\": null,\n \"maxCpuUsage\": null\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","X-Pagination-Per-Page":"20","Access-Control-Expose-Headers":"X-Pagination-Per-Page, X-Pagination-Current-Page, X-Pagination-Total-Pages, X-Pagination-Total-Entries","X-Pagination-Current-Page":"1","X-Pagination-Total-Pages":"1","X-Pagination-Total-Entries":"1","Content-Type":"application/json; charset=utf-8","ETag":"W/\"b7cff832e0bbb40e6e09c4b36916a10e\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"016b07d9-ec76-4adf-b28a-16f19f5eec9e","X-Runtime":"0.035974","Content-Length":"239"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/scripts/r/2829/runs\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer 1Rl6ICeurTLW6jUypCMfvJLtK0hjaJPWblBJN09zbeo\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/scripts/r/{id}/runs/{run_id}":{"get":{"summary":"Check status of a run","description":"View the status of a run. This endpoint may be polled to monitor the status of the run. When the 'state' field is no longer 'queued' or 'running' the run has reached its final state.","deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the R job.","type":"integer"},{"name":"run_id","in":"path","required":true,"description":"The ID of the run.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object579"}}},"x-examples":[{"resource":"Scripts","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/scripts/r/:script_with_run_id/runs/:script_run_id","description":"View an R script's run details","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/scripts/r/2670/runs/250","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer ng1hnUZKTS-TE7YWt67rVP6FyS1KGVaKLvpIjiAhbvY","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 250,\n \"rId\": 2670,\n \"state\": \"running\",\n \"isCancelRequested\": false,\n \"createdAt\": \"2024-12-03T19:46:31.000Z\",\n \"startedAt\": \"2024-12-03T19:45:31.000Z\",\n \"finishedAt\": \"2024-12-03T19:46:31.000Z\",\n \"error\": null,\n \"maxMemoryUsage\": null,\n \"maxCpuUsage\": null\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"a2a5058e6d02647d67080fce30ede2d4\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"542a3ae8-c9d0-43c4-a89e-baea92762f15","X-Runtime":"0.033584","Content-Length":"237"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/scripts/r/2670/runs/250\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer ng1hnUZKTS-TE7YWt67rVP6FyS1KGVaKLvpIjiAhbvY\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"delete":{"summary":"Cancel a run","description":"Cancel a currently active run.","deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the R job.","type":"integer"},{"name":"run_id","in":"path","required":true,"description":"The ID of the run.","type":"integer"}],"responses":{"202":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null},"patch":{"summary":"Update the given run","description":"Update the run.","deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"ID of the Job","type":"integer"},{"name":"run_id","in":"path","required":true,"description":"ID of the Run","type":"integer"},{"name":"Object599","in":"body","schema":{"$ref":"#/definitions/Object599"},"required":false}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/r/{id}/runs/{run_id}/logs":{"get":{"summary":"Get the logs for a run","description":"Get the logs for a run.","deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the R job.","type":"integer"},{"name":"run_id","in":"path","required":true,"description":"The ID of the run.","type":"integer"},{"name":"last_id","in":"query","required":false,"description":"The ID of the last log message received. Log entries with this ID value or lower will be omitted.Logs are sorted by ID if this value is provided, and are otherwise sorted by createdAt.","type":"integer"},{"name":"limit","in":"query","required":false,"description":"The maximum number of log messages to return. Default of 10000.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object116"}}}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/dbt/{id}/runs":{"post":{"summary":"Start a run","description":"Start a run and provide a URI for checking its status. The response will provide a 'Location' header which will contain a URI which may be polled to monitor the status of the run.","deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the dbt job.","type":"integer"}],"responses":{"202":{"description":"success","schema":{"$ref":"#/definitions/Object580"}}},"x-examples":null,"x-deprecation-warning":null},"get":{"summary":"List runs for the given dbt job","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the dbt job.","type":"integer"},{"name":"limit","in":"query","required":false,"description":"Number of results to return. Defaults to 20. Maximum allowed is 100.","type":"integer"},{"name":"page_num","in":"query","required":false,"description":"Page number of the results to return. Defaults to the first page, 1.","type":"integer"},{"name":"order","in":"query","required":false,"description":"The field on which to order the result set. Defaults to id. Must be one of: id.","type":"string"},{"name":"order_dir","in":"query","required":false,"description":"Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc.","type":"string"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object580"}}}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/dbt/{id}/runs/{run_id}":{"get":{"summary":"Check status of a run","description":"View the status of a run. This endpoint may be polled to monitor the status of the run. When the 'state' field is no longer 'queued' or 'running' the run has reached its final state.","deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the dbt job.","type":"integer"},{"name":"run_id","in":"path","required":true,"description":"The ID of the run.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object580"}}},"x-examples":null,"x-deprecation-warning":null},"delete":{"summary":"Cancel a run","description":"Cancel a currently active run.","deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the dbt job.","type":"integer"},{"name":"run_id","in":"path","required":true,"description":"The ID of the run.","type":"integer"}],"responses":{"202":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null},"patch":{"summary":"Update the given run","description":"Update the run.","deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"ID of the Job","type":"integer"},{"name":"run_id","in":"path","required":true,"description":"ID of the Run","type":"integer"},{"name":"Object600","in":"body","schema":{"$ref":"#/definitions/Object600"},"required":false}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/dbt/{id}/runs/{run_id}/logs":{"get":{"summary":"Get the logs for a run","description":"Get the logs for a run.","deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the dbt job.","type":"integer"},{"name":"run_id","in":"path","required":true,"description":"The ID of the run.","type":"integer"},{"name":"last_id","in":"query","required":false,"description":"The ID of the last log message received. Log entries with this ID value or lower will be omitted.Logs are sorted by ID if this value is provided, and are otherwise sorted by createdAt.","type":"integer"},{"name":"limit","in":"query","required":false,"description":"The maximum number of log messages to return. Default of 10000.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object116"}}}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/javascript/{id}/runs":{"post":{"summary":"Start a run","description":"Start a run and provide a URI for checking its status. The response will provide a 'Location' header which will contain a URI which may be polled to monitor the status of the run.","deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Javascript job.","type":"integer"}],"responses":{"202":{"description":"success","schema":{"$ref":"#/definitions/Object581"}}},"x-examples":[{"resource":"Scripts","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/scripts/javascript/:script_to_run_id/runs","description":"Create a JavaScript run","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/scripts/javascript/2627/runs","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer zo_BhlOzHiQRE7_2H2RG-Y_dGlbnNKJ01UkbLZ1vmrU","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":202,"response_status_text":"Accepted","response_body":"{\n \"id\": 241,\n \"javascriptId\": 2627,\n \"state\": \"queued\",\n \"isCancelRequested\": false,\n \"createdAt\": \"2024-12-03T19:46:26.000Z\",\n \"startedAt\": null,\n \"finishedAt\": null,\n \"error\": null\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Location":"http://api.civis.test/scripts/javascript/2627/runs/241","Content-Type":"application/json; charset=utf-8","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"b9f8430d-2a58-472e-aa84-ac64d6f517e3","X-Runtime":"0.143685","Content-Length":"160"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/scripts/javascript/2627/runs\" -d '' -X POST \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer zo_BhlOzHiQRE7_2H2RG-Y_dGlbnNKJ01UkbLZ1vmrU\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"get":{"summary":"List runs for the given Javascript job","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Javascript job.","type":"integer"},{"name":"limit","in":"query","required":false,"description":"Number of results to return. Defaults to 20. Maximum allowed is 100.","type":"integer"},{"name":"page_num","in":"query","required":false,"description":"Page number of the results to return. Defaults to the first page, 1.","type":"integer"},{"name":"order","in":"query","required":false,"description":"The field on which to order the result set. Defaults to id. Must be one of: id.","type":"string"},{"name":"order_dir","in":"query","required":false,"description":"Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc.","type":"string"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object581"}}}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/javascript/{id}/runs/{run_id}":{"get":{"summary":"Check status of a run","description":"View the status of a run. This endpoint may be polled to monitor the status of the run. When the 'state' field is no longer 'queued' or 'running' the run has reached its final state.","deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Javascript job.","type":"integer"},{"name":"run_id","in":"path","required":true,"description":"The ID of the run.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object581"}}},"x-examples":null,"x-deprecation-warning":null},"delete":{"summary":"Cancel a run","description":"Cancel a currently active run.","deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Javascript job.","type":"integer"},{"name":"run_id","in":"path","required":true,"description":"The ID of the run.","type":"integer"}],"responses":{"202":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null},"patch":{"summary":"Update the given run","description":"Update the run.","deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"ID of the Job","type":"integer"},{"name":"run_id","in":"path","required":true,"description":"ID of the Run","type":"integer"},{"name":"Object597","in":"body","schema":{"$ref":"#/definitions/Object597"},"required":false}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/javascript/{id}/runs/{run_id}/logs":{"get":{"summary":"Get the logs for a run","description":"Get the logs for a run.","deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Javascript job.","type":"integer"},{"name":"run_id","in":"path","required":true,"description":"The ID of the run.","type":"integer"},{"name":"last_id","in":"query","required":false,"description":"The ID of the last log message received. Log entries with this ID value or lower will be omitted.Logs are sorted by ID if this value is provided, and are otherwise sorted by createdAt.","type":"integer"},{"name":"limit","in":"query","required":false,"description":"The maximum number of log messages to return. Default of 10000.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object116"}}}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/custom/{id}/runs":{"post":{"summary":"Start a run","description":"Start a run and provide a URI for checking its status. The response will provide a 'Location' header which will contain a URI which may be polled to monitor the status of the run.","deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Custom job.","type":"integer"}],"responses":{"202":{"description":"success","schema":{"$ref":"#/definitions/Object582"}}},"x-examples":[{"resource":"Scripts","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/scripts/custom/:custom_script_to_run_id/runs","description":"Create a Custom run","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/scripts/custom/2639/runs","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer fWXdUQQazI-TsC7bVZZTpGEvvS7A9YA2qi4Foz8Turc","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":202,"response_status_text":"Accepted","response_body":"{\n \"id\": 243,\n \"customId\": 2639,\n \"state\": \"queued\",\n \"isCancelRequested\": false,\n \"createdAt\": \"2024-12-03T19:46:27.000Z\",\n \"startedAt\": null,\n \"finishedAt\": null,\n \"error\": null,\n \"maxMemoryUsage\": null,\n \"maxCpuUsage\": null\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Location":"http://api.civis.test/scripts/custom/2639/runs/243","Content-Type":"application/json; charset=utf-8","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"f8b3460d-a5ff-4600-9ae8-25a2e4f7f123","X-Runtime":"0.144289","Content-Length":"197"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/scripts/custom/2639/runs\" -d '' -X POST \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer fWXdUQQazI-TsC7bVZZTpGEvvS7A9YA2qi4Foz8Turc\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"get":{"summary":"List runs for the given Custom job","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Custom job.","type":"integer"},{"name":"limit","in":"query","required":false,"description":"Number of results to return. Defaults to 20. Maximum allowed is 100.","type":"integer"},{"name":"page_num","in":"query","required":false,"description":"Page number of the results to return. Defaults to the first page, 1.","type":"integer"},{"name":"order","in":"query","required":false,"description":"The field on which to order the result set. Defaults to id. Must be one of: id.","type":"string"},{"name":"order_dir","in":"query","required":false,"description":"Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc.","type":"string"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object582"}}}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/custom/{id}/runs/{run_id}":{"get":{"summary":"Check status of a run","description":"View the status of a run. This endpoint may be polled to monitor the status of the run. When the 'state' field is no longer 'queued' or 'running' the run has reached its final state.","deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Custom job.","type":"integer"},{"name":"run_id","in":"path","required":true,"description":"The ID of the run.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object582"}}},"x-examples":null,"x-deprecation-warning":null},"delete":{"summary":"Cancel a run","description":"Cancel a currently active run.","deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Custom job.","type":"integer"},{"name":"run_id","in":"path","required":true,"description":"The ID of the run.","type":"integer"}],"responses":{"202":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/custom/{id}/runs/{run_id}/logs":{"get":{"summary":"Get the logs for a run","description":"Get the logs for a run.","deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Custom job.","type":"integer"},{"name":"run_id","in":"path","required":true,"description":"The ID of the run.","type":"integer"},{"name":"last_id","in":"query","required":false,"description":"The ID of the last log message received. Log entries with this ID value or lower will be omitted.Logs are sorted by ID if this value is provided, and are otherwise sorted by createdAt.","type":"integer"},{"name":"limit","in":"query","required":false,"description":"The maximum number of log messages to return. Default of 10000.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object116"}}}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/sql/{id}/runs/{run_id}/outputs":{"get":{"summary":"List the outputs for a run","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the sql script.","type":"integer"},{"name":"run_id","in":"path","required":true,"description":"The ID of the run.","type":"integer"},{"name":"limit","in":"query","required":false,"description":"Number of results to return. Defaults to its maximum of 50.","type":"integer"},{"name":"page_num","in":"query","required":false,"description":"Page number of the results to return. Defaults to the first page, 1.","type":"integer"},{"name":"order","in":"query","required":false,"description":"The field on which to order the result set. Defaults to created_at. Must be one of: created_at, id.","type":"string"},{"name":"order_dir","in":"query","required":false,"description":"Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc.","type":"string"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object583"}}}},"x-examples":[{"resource":"Scripts","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/scripts/sql/:job_with_run_id/runs/:job_run_id/outputs","description":"View a SQL Script's outputs","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/scripts/sql/2680/runs/254/outputs","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer lG6vUe8ioyXb9z4FO76lTaOROFvxRtQjt8Ky7TeXzn4","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"objectType\": \"File\",\n \"objectId\": 96,\n \"name\": \"my output file\",\n \"link\": \"api.civis.test/files/96\",\n \"value\": null\n },\n {\n \"objectType\": \"Report\",\n \"objectId\": 11,\n \"name\": \"my output report\",\n \"link\": \"api.civis.test/reports/11\",\n \"value\": null\n },\n {\n \"objectType\": \"Report\",\n \"objectId\": 12,\n \"name\": \"my output tableau report\",\n \"link\": \"api.civis.test/reports/12\",\n \"value\": null\n },\n {\n \"objectType\": \"Table\",\n \"objectId\": 129,\n \"name\": \"output.table\",\n \"link\": \"api.civis.test/tables/129\",\n \"value\": null\n },\n {\n \"objectType\": \"Project\",\n \"objectId\": 73,\n \"name\": \"my output project\",\n \"link\": \"api.civis.test/projects/73\",\n \"value\": null\n },\n {\n \"objectType\": \"Credential\",\n \"objectId\": 1088,\n \"name\": \"my output credential\",\n \"link\": \"api.civis.test/credentials/1088\",\n \"value\": null\n },\n {\n \"objectType\": \"JSONValue\",\n \"objectId\": 6,\n \"name\": \"my awesome JSON value\",\n \"link\": \"api.civis.test/json_values/6\",\n \"value\": {\n \"foo\": \"bar\"\n }\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","X-Pagination-Per-Page":"50","Access-Control-Expose-Headers":"X-Pagination-Per-Page, X-Pagination-Current-Page, X-Pagination-Total-Pages, X-Pagination-Total-Entries","X-Pagination-Current-Page":"1","X-Pagination-Total-Pages":"1","X-Pagination-Total-Entries":"7","Content-Type":"application/json; charset=utf-8","ETag":"W/\"4f233250402813384d29fe524a914cb3\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"90610251-5d89-4ef5-9857-7a9f9f6bf6d2","X-Runtime":"0.085389","Content-Length":"821"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/scripts/sql/2680/runs/254/outputs\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer lG6vUe8ioyXb9z4FO76lTaOROFvxRtQjt8Ky7TeXzn4\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/scripts/containers/{id}/runs/{run_id}/outputs":{"get":{"summary":"List the outputs for a run","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the container script.","type":"integer"},{"name":"run_id","in":"path","required":true,"description":"The ID of the run.","type":"integer"},{"name":"limit","in":"query","required":false,"description":"Number of results to return. Defaults to its maximum of 50.","type":"integer"},{"name":"page_num","in":"query","required":false,"description":"Page number of the results to return. Defaults to the first page, 1.","type":"integer"},{"name":"order","in":"query","required":false,"description":"The field on which to order the result set. Defaults to created_at. Must be one of: created_at, id.","type":"string"},{"name":"order_dir","in":"query","required":false,"description":"Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc.","type":"string"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object584"}}}},"x-examples":[{"resource":"Scripts","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/scripts/containers/:job_with_run_id/runs/:job_run_id/outputs","description":"View a Container script's outputs","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/scripts/containers/2709/runs/263/outputs","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer HoJI1sBTqWZHvfJOEkiXX5jX9E2sm__6sdQtGCAuF64","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"objectType\": \"File\",\n \"objectId\": 106,\n \"name\": \"my output file\",\n \"link\": \"api.civis.test/files/106\",\n \"value\": null\n },\n {\n \"objectType\": \"Report\",\n \"objectId\": 13,\n \"name\": \"my output report\",\n \"link\": \"api.civis.test/reports/13\",\n \"value\": null\n },\n {\n \"objectType\": \"Report\",\n \"objectId\": 14,\n \"name\": \"my output tableau report\",\n \"link\": \"api.civis.test/reports/14\",\n \"value\": null\n },\n {\n \"objectType\": \"Table\",\n \"objectId\": 130,\n \"name\": \"output.table\",\n \"link\": \"api.civis.test/tables/130\",\n \"value\": null\n },\n {\n \"objectType\": \"Project\",\n \"objectId\": 77,\n \"name\": \"my output project\",\n \"link\": \"api.civis.test/projects/77\",\n \"value\": null\n },\n {\n \"objectType\": \"Credential\",\n \"objectId\": 1119,\n \"name\": \"my output credential\",\n \"link\": \"api.civis.test/credentials/1119\",\n \"value\": null\n },\n {\n \"objectType\": \"JSONValue\",\n \"objectId\": 8,\n \"name\": \"my awesome JSON value\",\n \"link\": \"api.civis.test/json_values/8\",\n \"value\": {\n \"foo\": \"bar\"\n }\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","X-Pagination-Per-Page":"50","Access-Control-Expose-Headers":"X-Pagination-Per-Page, X-Pagination-Current-Page, X-Pagination-Total-Pages, X-Pagination-Total-Entries","X-Pagination-Current-Page":"1","X-Pagination-Total-Pages":"1","X-Pagination-Total-Entries":"7","Content-Type":"application/json; charset=utf-8","ETag":"W/\"309f37d0db812828fda4a489f2ea9704\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"2e02288e-0769-42cd-bdbe-2c3f1d030663","X-Runtime":"0.073609","Content-Length":"823"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/scripts/containers/2709/runs/263/outputs\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer HoJI1sBTqWZHvfJOEkiXX5jX9E2sm__6sdQtGCAuF64\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"post":{"summary":"Add an output for a run","description":"Publish the given object as an output of the run. If the script is running in author context, this will transfer ownership of the object to the job runner.","deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the container script.","type":"integer"},{"name":"run_id","in":"path","required":true,"description":"The ID of the run.","type":"integer"},{"name":"Object585","in":"body","schema":{"$ref":"#/definitions/Object585"},"required":true}],"responses":{"202":{"description":"success","schema":{"$ref":"#/definitions/Object584"}}},"x-examples":[{"resource":"Scripts","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/scripts/containers/:job_with_run_id/runs/:job_run_id/outputs","description":"Add an output to a Container script","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/scripts/containers/2691/runs/257/outputs","request_body":"{\n \"objectType\": \"File\",\n \"objectId\": 100\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer 9Y6JowBhAZ8YzylwO76OTRozo0jcMDndGWNlEvN97xc","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":202,"response_status_text":"Accepted","response_body":"{\n \"objectType\": \"File\",\n \"objectId\": 100,\n \"name\": \"My output file\",\n \"link\": \"api.civis.test/files/100\",\n \"value\": null\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"18a491fc-cba4-43a2-a3b4-568c3ef03a10","X-Runtime":"0.073109","Content-Length":"107"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/scripts/containers/2691/runs/257/outputs\" -d '{\"objectType\":\"File\",\"objectId\":100}' -X POST \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer 9Y6JowBhAZ8YzylwO76OTRozo0jcMDndGWNlEvN97xc\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Scripts","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/scripts/containers/:job_with_run_id/runs/:job_run_id/outputs","description":"Add a JSONValue output to a Container script","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/scripts/containers/2700/runs/260/outputs","request_body":"{\n \"objectType\": \"JSONValue\",\n \"objectId\": 7\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer 9udspgxWBUNnVygZ6vCdGXebPVYYPGLAZskTjd8uvxw","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":202,"response_status_text":"Accepted","response_body":"{\n \"objectType\": \"JSONValue\",\n \"objectId\": 7,\n \"name\": \"my awesome JSON Value\",\n \"link\": \"api.civis.test/json_values/7\",\n \"value\": {\n \"foo\": \"bar\"\n }\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"9f48760d-1e7d-466a-8a72-a693220dae20","X-Runtime":"0.039850","Content-Length":"130"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/scripts/containers/2700/runs/260/outputs\" -d '{\"objectType\":\"JSONValue\",\"objectId\":7}' -X POST \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer 9udspgxWBUNnVygZ6vCdGXebPVYYPGLAZskTjd8uvxw\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/scripts/python3/{id}/runs/{run_id}/outputs":{"get":{"summary":"List the outputs for a run","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the python script.","type":"integer"},{"name":"run_id","in":"path","required":true,"description":"The ID of the run.","type":"integer"},{"name":"limit","in":"query","required":false,"description":"Number of results to return. Defaults to its maximum of 50.","type":"integer"},{"name":"page_num","in":"query","required":false,"description":"Page number of the results to return. Defaults to the first page, 1.","type":"integer"},{"name":"order","in":"query","required":false,"description":"The field on which to order the result set. Defaults to created_at. Must be one of: created_at, id.","type":"string"},{"name":"order_dir","in":"query","required":false,"description":"Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc.","type":"string"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object586"}}}},"x-examples":[{"resource":"Scripts","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/scripts/python3/:job_with_run_id/runs/:job_run_id/outputs","description":"View a Python Script's outputs","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/scripts/python3/2738/runs/272/outputs","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer z2Pfzl26wyx9IAMmcxHCYgrLBFjyVXl7rScyGHTmUPI","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"objectType\": \"File\",\n \"objectId\": 116,\n \"name\": \"my output file\",\n \"link\": \"api.civis.test/files/116\",\n \"value\": null\n },\n {\n \"objectType\": \"Report\",\n \"objectId\": 15,\n \"name\": \"my output report\",\n \"link\": \"api.civis.test/reports/15\",\n \"value\": null\n },\n {\n \"objectType\": \"Report\",\n \"objectId\": 16,\n \"name\": \"my output tableau report\",\n \"link\": \"api.civis.test/reports/16\",\n \"value\": null\n },\n {\n \"objectType\": \"Table\",\n \"objectId\": 131,\n \"name\": \"output.table\",\n \"link\": \"api.civis.test/tables/131\",\n \"value\": null\n },\n {\n \"objectType\": \"Project\",\n \"objectId\": 81,\n \"name\": \"my output project\",\n \"link\": \"api.civis.test/projects/81\",\n \"value\": null\n },\n {\n \"objectType\": \"Credential\",\n \"objectId\": 1150,\n \"name\": \"my output credential\",\n \"link\": \"api.civis.test/credentials/1150\",\n \"value\": null\n },\n {\n \"objectType\": \"JSONValue\",\n \"objectId\": 10,\n \"name\": \"my awesome JSON value\",\n \"link\": \"api.civis.test/json_values/10\",\n \"value\": {\n \"foo\": \"bar\"\n }\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","X-Pagination-Per-Page":"50","Access-Control-Expose-Headers":"X-Pagination-Per-Page, X-Pagination-Current-Page, X-Pagination-Total-Pages, X-Pagination-Total-Entries","X-Pagination-Current-Page":"1","X-Pagination-Total-Pages":"1","X-Pagination-Total-Entries":"7","Content-Type":"application/json; charset=utf-8","ETag":"W/\"c36682b45cfe6a321780d14c42d9f386\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"52e2acb5-0f0e-4b06-a357-43b89fdaf1b0","X-Runtime":"0.081386","Content-Length":"825"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/scripts/python3/2738/runs/272/outputs\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer z2Pfzl26wyx9IAMmcxHCYgrLBFjyVXl7rScyGHTmUPI\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"post":{"summary":"Add an output for a run","description":"Publish the given object as an output of the run. If the script is running in author context, this will transfer ownership of the object to the job runner.","deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the python script.","type":"integer"},{"name":"run_id","in":"path","required":true,"description":"The ID of the run.","type":"integer"},{"name":"Object587","in":"body","schema":{"$ref":"#/definitions/Object587"},"required":true}],"responses":{"202":{"description":"success","schema":{"$ref":"#/definitions/Object586"}}},"x-examples":[{"resource":"Scripts","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/scripts/python3/:job_with_run_id/runs/:job_run_id/outputs","description":"Add an output to a Python Script","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/scripts/python3/2720/runs/266/outputs","request_body":"{\n \"objectType\": \"File\",\n \"objectId\": 110\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer bH_p6bJP42T55vW-4Ug2nkkvMH8uOwt8o_LFIQetr0Y","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":202,"response_status_text":"Accepted","response_body":"{\n \"objectType\": \"File\",\n \"objectId\": 110,\n \"name\": \"My output file\",\n \"link\": \"api.civis.test/files/110\",\n \"value\": null\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"ea4f03ac-3533-4f76-b640-34c9e7f0ab55","X-Runtime":"0.042757","Content-Length":"107"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/scripts/python3/2720/runs/266/outputs\" -d '{\"objectType\":\"File\",\"objectId\":110}' -X POST \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer bH_p6bJP42T55vW-4Ug2nkkvMH8uOwt8o_LFIQetr0Y\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Scripts","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/scripts/python3/:job_with_run_id/runs/:job_run_id/outputs","description":"Add a JSONValue output to a Python Script","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/scripts/python3/2729/runs/269/outputs","request_body":"{\n \"objectType\": \"JSONValue\",\n \"objectId\": 9\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer PmzcvjDHGUsPJxOfYl3ptWUkCkyeoah9nHlVsBx_jU0","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":202,"response_status_text":"Accepted","response_body":"{\n \"objectType\": \"JSONValue\",\n \"objectId\": 9,\n \"name\": \"my awesome JSON Value\",\n \"link\": \"api.civis.test/json_values/9\",\n \"value\": {\n \"foo\": \"bar\"\n }\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"6960a358-1ccc-4f8e-8cd9-127041d796f7","X-Runtime":"0.040194","Content-Length":"130"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/scripts/python3/2729/runs/269/outputs\" -d '{\"objectType\":\"JSONValue\",\"objectId\":9}' -X POST \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer PmzcvjDHGUsPJxOfYl3ptWUkCkyeoah9nHlVsBx_jU0\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/scripts/r/{id}/runs/{run_id}/outputs":{"get":{"summary":"List the outputs for a run","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the r script.","type":"integer"},{"name":"run_id","in":"path","required":true,"description":"The ID of the run.","type":"integer"},{"name":"limit","in":"query","required":false,"description":"Number of results to return. Defaults to its maximum of 50.","type":"integer"},{"name":"page_num","in":"query","required":false,"description":"Page number of the results to return. Defaults to the first page, 1.","type":"integer"},{"name":"order","in":"query","required":false,"description":"The field on which to order the result set. Defaults to created_at. Must be one of: created_at, id.","type":"string"},{"name":"order_dir","in":"query","required":false,"description":"Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc.","type":"string"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object588"}}}},"x-examples":[{"resource":"Scripts","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/scripts/r/:job_with_run_id/runs/:job_run_id/outputs","description":"View an R Script's outputs","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/scripts/r/2767/runs/281/outputs","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer 7Xa5PM4lm5JnQU3ncmMjZtPtiHFQXY9sw13jdL1cGdQ","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"objectType\": \"File\",\n \"objectId\": 126,\n \"name\": \"my output file\",\n \"link\": \"api.civis.test/files/126\",\n \"value\": null\n },\n {\n \"objectType\": \"Report\",\n \"objectId\": 17,\n \"name\": \"my output report\",\n \"link\": \"api.civis.test/reports/17\",\n \"value\": null\n },\n {\n \"objectType\": \"Report\",\n \"objectId\": 18,\n \"name\": \"my output tableau report\",\n \"link\": \"api.civis.test/reports/18\",\n \"value\": null\n },\n {\n \"objectType\": \"Table\",\n \"objectId\": 132,\n \"name\": \"output.table\",\n \"link\": \"api.civis.test/tables/132\",\n \"value\": null\n },\n {\n \"objectType\": \"Project\",\n \"objectId\": 85,\n \"name\": \"my output project\",\n \"link\": \"api.civis.test/projects/85\",\n \"value\": null\n },\n {\n \"objectType\": \"Credential\",\n \"objectId\": 1181,\n \"name\": \"my output credential\",\n \"link\": \"api.civis.test/credentials/1181\",\n \"value\": null\n },\n {\n \"objectType\": \"JSONValue\",\n \"objectId\": 12,\n \"name\": \"my awesome JSON value\",\n \"link\": \"api.civis.test/json_values/12\",\n \"value\": {\n \"foo\": \"bar\"\n }\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","X-Pagination-Per-Page":"50","Access-Control-Expose-Headers":"X-Pagination-Per-Page, X-Pagination-Current-Page, X-Pagination-Total-Pages, X-Pagination-Total-Entries","X-Pagination-Current-Page":"1","X-Pagination-Total-Pages":"1","X-Pagination-Total-Entries":"7","Content-Type":"application/json; charset=utf-8","ETag":"W/\"1b0d5849c0da74085c68fe0a3718aa59\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"668e0807-43e6-43ef-983d-57e8bb97d9fb","X-Runtime":"0.101572","Content-Length":"825"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/scripts/r/2767/runs/281/outputs\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer 7Xa5PM4lm5JnQU3ncmMjZtPtiHFQXY9sw13jdL1cGdQ\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"post":{"summary":"Add an output for a run","description":"Publish the given object as an output of the run. If the script is running in author context, this will transfer ownership of the object to the job runner.","deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the r script.","type":"integer"},{"name":"run_id","in":"path","required":true,"description":"The ID of the run.","type":"integer"},{"name":"Object589","in":"body","schema":{"$ref":"#/definitions/Object589"},"required":true}],"responses":{"202":{"description":"success","schema":{"$ref":"#/definitions/Object588"}}},"x-examples":[{"resource":"Scripts","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/scripts/r/:job_with_run_id/runs/:job_run_id/outputs","description":"Add an output to an R Script","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/scripts/r/2749/runs/275/outputs","request_body":"{\n \"objectType\": \"File\",\n \"objectId\": 120\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer gwxgIWGJ2I_JL6vbgHyZzle8KTt4mkeL0GuHswc7edM","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":202,"response_status_text":"Accepted","response_body":"{\n \"objectType\": \"File\",\n \"objectId\": 120,\n \"name\": \"My output file\",\n \"link\": \"api.civis.test/files/120\",\n \"value\": null\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"d1749ebb-9b59-46fa-8927-f8625f41a6c3","X-Runtime":"0.039823","Content-Length":"107"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/scripts/r/2749/runs/275/outputs\" -d '{\"objectType\":\"File\",\"objectId\":120}' -X POST \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer gwxgIWGJ2I_JL6vbgHyZzle8KTt4mkeL0GuHswc7edM\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Scripts","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/scripts/r/:job_with_run_id/runs/:job_run_id/outputs","description":"Add a JSONValue output to an R Script","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/scripts/r/2758/runs/278/outputs","request_body":"{\n \"objectType\": \"JSONValue\",\n \"objectId\": 11\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer -1aEeXJJUInCcn8f6Aam9PvCjMoJT1G_7QKeXep_dSM","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":202,"response_status_text":"Accepted","response_body":"{\n \"objectType\": \"JSONValue\",\n \"objectId\": 11,\n \"name\": \"my awesome JSON Value\",\n \"link\": \"api.civis.test/json_values/11\",\n \"value\": {\n \"foo\": \"bar\"\n }\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"432e2797-e0d2-4cef-a007-53513ede0c15","X-Runtime":"0.043603","Content-Length":"132"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/scripts/r/2758/runs/278/outputs\" -d '{\"objectType\":\"JSONValue\",\"objectId\":11}' -X POST \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer -1aEeXJJUInCcn8f6Aam9PvCjMoJT1G_7QKeXep_dSM\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/scripts/dbt/{id}/runs/{run_id}/outputs":{"get":{"summary":"List the outputs for a run","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the dbt script.","type":"integer"},{"name":"run_id","in":"path","required":true,"description":"The ID of the run.","type":"integer"},{"name":"limit","in":"query","required":false,"description":"Number of results to return. Defaults to its maximum of 50.","type":"integer"},{"name":"page_num","in":"query","required":false,"description":"Page number of the results to return. Defaults to the first page, 1.","type":"integer"},{"name":"order","in":"query","required":false,"description":"The field on which to order the result set. Defaults to created_at. Must be one of: created_at, id.","type":"string"},{"name":"order_dir","in":"query","required":false,"description":"Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc.","type":"string"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object590"}}}},"x-examples":null,"x-deprecation-warning":null},"post":{"summary":"Add an output for a run","description":"Publish the given object as an output of the run. If the script is running in author context, this will transfer ownership of the object to the job runner.","deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the dbt script.","type":"integer"},{"name":"run_id","in":"path","required":true,"description":"The ID of the run.","type":"integer"},{"name":"Object591","in":"body","schema":{"$ref":"#/definitions/Object591"},"required":true}],"responses":{"202":{"description":"success","schema":{"$ref":"#/definitions/Object590"}}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/javascript/{id}/runs/{run_id}/outputs":{"get":{"summary":"List the outputs for a run","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the javascript script.","type":"integer"},{"name":"run_id","in":"path","required":true,"description":"The ID of the run.","type":"integer"},{"name":"limit","in":"query","required":false,"description":"Number of results to return. Defaults to its maximum of 50.","type":"integer"},{"name":"page_num","in":"query","required":false,"description":"Page number of the results to return. Defaults to the first page, 1.","type":"integer"},{"name":"order","in":"query","required":false,"description":"The field on which to order the result set. Defaults to created_at. Must be one of: created_at, id.","type":"string"},{"name":"order_dir","in":"query","required":false,"description":"Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc.","type":"string"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object592"}}}},"x-examples":[{"resource":"Scripts","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/scripts/javascript/:job_with_run_id/runs/:job_run_id/outputs","description":"View a JavaScript Script's outputs","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/scripts/javascript/2793/runs/290/outputs","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer oT5hPWPQiaU9AIEWfgXdB4FhzIOsZUD6MdDwqG7zzic","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"objectType\": \"File\",\n \"objectId\": 136,\n \"name\": \"my output file\",\n \"link\": \"api.civis.test/files/136\",\n \"value\": null\n },\n {\n \"objectType\": \"Report\",\n \"objectId\": 19,\n \"name\": \"my output report\",\n \"link\": \"api.civis.test/reports/19\",\n \"value\": null\n },\n {\n \"objectType\": \"Report\",\n \"objectId\": 20,\n \"name\": \"my output tableau report\",\n \"link\": \"api.civis.test/reports/20\",\n \"value\": null\n },\n {\n \"objectType\": \"Table\",\n \"objectId\": 133,\n \"name\": \"output.table\",\n \"link\": \"api.civis.test/tables/133\",\n \"value\": null\n },\n {\n \"objectType\": \"Project\",\n \"objectId\": 89,\n \"name\": \"my output project\",\n \"link\": \"api.civis.test/projects/89\",\n \"value\": null\n },\n {\n \"objectType\": \"Credential\",\n \"objectId\": 1218,\n \"name\": \"my output credential\",\n \"link\": \"api.civis.test/credentials/1218\",\n \"value\": null\n },\n {\n \"objectType\": \"JSONValue\",\n \"objectId\": 14,\n \"name\": \"my awesome JSON value\",\n \"link\": \"api.civis.test/json_values/14\",\n \"value\": {\n \"foo\": \"bar\"\n }\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","X-Pagination-Per-Page":"50","Access-Control-Expose-Headers":"X-Pagination-Per-Page, X-Pagination-Current-Page, X-Pagination-Total-Pages, X-Pagination-Total-Entries","X-Pagination-Current-Page":"1","X-Pagination-Total-Pages":"1","X-Pagination-Total-Entries":"7","Content-Type":"application/json; charset=utf-8","ETag":"W/\"4a6a96da299607720fb5b917e2e61525\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"d75b1122-a9b4-4d26-ae8e-2c9a699c2556","X-Runtime":"0.076189","Content-Length":"825"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/scripts/javascript/2793/runs/290/outputs\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer oT5hPWPQiaU9AIEWfgXdB4FhzIOsZUD6MdDwqG7zzic\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"post":{"summary":"Add an output for a run","description":"Publish the given object as an output of the run. If the script is running in author context, this will transfer ownership of the object to the job runner.","deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the javascript script.","type":"integer"},{"name":"run_id","in":"path","required":true,"description":"The ID of the run.","type":"integer"},{"name":"Object593","in":"body","schema":{"$ref":"#/definitions/Object593"},"required":true}],"responses":{"202":{"description":"success","schema":{"$ref":"#/definitions/Object592"}}},"x-examples":[{"resource":"Scripts","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/scripts/javascript/:job_with_run_id/runs/:job_run_id/outputs","description":"Add an output to a JavaScript Script","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/scripts/javascript/2777/runs/284/outputs","request_body":"{\n \"objectType\": \"File\",\n \"objectId\": 130\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer Zh9h1QxHaJMuWhvnUUCY_UFBLP4HOO9bV-5WmklT7w0","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":202,"response_status_text":"Accepted","response_body":"{\n \"objectType\": \"File\",\n \"objectId\": 130,\n \"name\": \"My output file\",\n \"link\": \"api.civis.test/files/130\",\n \"value\": null\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"e34e7c32-2bc0-4e03-a5e7-e48195c4a326","X-Runtime":"0.039072","Content-Length":"107"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/scripts/javascript/2777/runs/284/outputs\" -d '{\"objectType\":\"File\",\"objectId\":130}' -X POST \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer Zh9h1QxHaJMuWhvnUUCY_UFBLP4HOO9bV-5WmklT7w0\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Scripts","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/scripts/javascript/:job_with_run_id/runs/:job_run_id/outputs","description":"Add a JSONValue output to a JavaScript Script","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/scripts/javascript/2785/runs/287/outputs","request_body":"{\n \"objectType\": \"JSONValue\",\n \"objectId\": 13\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer n9Jdc4avCMw9mKipZdjF-hpqjSVMC6v7BDiqlg0Jc34","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":202,"response_status_text":"Accepted","response_body":"{\n \"objectType\": \"JSONValue\",\n \"objectId\": 13,\n \"name\": \"my awesome JSON Value\",\n \"link\": \"api.civis.test/json_values/13\",\n \"value\": {\n \"foo\": \"bar\"\n }\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"7bef3491-f721-4f5b-86c7-bed89111112e","X-Runtime":"0.040510","Content-Length":"132"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/scripts/javascript/2785/runs/287/outputs\" -d '{\"objectType\":\"JSONValue\",\"objectId\":13}' -X POST \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer n9Jdc4avCMw9mKipZdjF-hpqjSVMC6v7BDiqlg0Jc34\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/scripts/custom/{id}/runs/{run_id}/outputs":{"get":{"summary":"List the outputs for a run","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the custom script.","type":"integer"},{"name":"run_id","in":"path","required":true,"description":"The ID of the run.","type":"integer"},{"name":"limit","in":"query","required":false,"description":"Number of results to return. Defaults to its maximum of 50.","type":"integer"},{"name":"page_num","in":"query","required":false,"description":"Page number of the results to return. Defaults to the first page, 1.","type":"integer"},{"name":"order","in":"query","required":false,"description":"The field on which to order the result set. Defaults to created_at. Must be one of: created_at, id.","type":"string"},{"name":"order_dir","in":"query","required":false,"description":"Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc.","type":"string"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object594"}}}},"x-examples":null,"x-deprecation-warning":null},"post":{"summary":"Add an output for a run","description":"Publish the given object as an output of the run. If the script is running in author context, this will transfer ownership of the object to the job runner.","deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the custom script.","type":"integer"},{"name":"run_id","in":"path","required":true,"description":"The ID of the run.","type":"integer"},{"name":"Object595","in":"body","schema":{"$ref":"#/definitions/Object595"},"required":true}],"responses":{"202":{"description":"success","schema":{"$ref":"#/definitions/Object594"}}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/container/{id}/runs/{run_id}":{"patch":{"summary":"Update the given run","description":"Update the run.","deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"ID of the Job","type":"integer"},{"name":"run_id","in":"path","required":true,"description":"ID of the Run","type":"integer"},{"name":"Object601","in":"body","schema":{"$ref":"#/definitions/Object601"},"required":false}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/sql/{id}/git":{"get":{"summary":"Get the git metadata attached to an item","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the item.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object402"}}},"x-examples":null,"x-deprecation-warning":null},"put":{"summary":"Attach an item to a file in a git repo","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the item.","type":"integer"},{"name":"Object403","in":"body","schema":{"$ref":"#/definitions/Object403"},"required":false}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object402"}}},"x-examples":null,"x-deprecation-warning":null},"patch":{"summary":"Update an attached git file","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the item.","type":"integer"},{"name":"Object403","in":"body","schema":{"$ref":"#/definitions/Object403"},"required":false}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object402"}}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/sql/{id}/git/commits":{"get":{"summary":"Get the git commits for an item on the current branch","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the item.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object404"}}},"x-examples":null,"x-deprecation-warning":null},"post":{"summary":"Commit and push a new version of the file","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the item.","type":"integer"},{"name":"Object405","in":"body","schema":{"$ref":"#/definitions/Object405"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object406"}}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/sql/{id}/git/commits/{commit_hash}":{"get":{"summary":"Get file contents at git ref","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the item.","type":"integer"},{"name":"commit_hash","in":"path","required":true,"description":"The SHA (full or shortened) of the desired git commit.","type":"string"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object406"}}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/sql/{id}/git/checkout-latest":{"post":{"summary":"Checkout latest commit on the current branch of a script or workflow","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the item.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object406"}}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/sql/{id}/git/checkout":{"post":{"summary":"Checkout content that the existing git_ref points to and save to the object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the item.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object406"}}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/javascript/{id}/git":{"get":{"summary":"Get the git metadata attached to an item","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the item.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object402"}}},"x-examples":null,"x-deprecation-warning":null},"put":{"summary":"Attach an item to a file in a git repo","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the item.","type":"integer"},{"name":"Object403","in":"body","schema":{"$ref":"#/definitions/Object403"},"required":false}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object402"}}},"x-examples":null,"x-deprecation-warning":null},"patch":{"summary":"Update an attached git file","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the item.","type":"integer"},{"name":"Object403","in":"body","schema":{"$ref":"#/definitions/Object403"},"required":false}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object402"}}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/javascript/{id}/git/commits":{"get":{"summary":"Get the git commits for an item on the current branch","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the item.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object404"}}},"x-examples":null,"x-deprecation-warning":null},"post":{"summary":"Commit and push a new version of the file","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the item.","type":"integer"},{"name":"Object405","in":"body","schema":{"$ref":"#/definitions/Object405"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object406"}}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/javascript/{id}/git/commits/{commit_hash}":{"get":{"summary":"Get file contents at git ref","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the item.","type":"integer"},{"name":"commit_hash","in":"path","required":true,"description":"The SHA (full or shortened) of the desired git commit.","type":"string"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object406"}}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/javascript/{id}/git/checkout-latest":{"post":{"summary":"Checkout latest commit on the current branch of a script or workflow","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the item.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object406"}}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/javascript/{id}/git/checkout":{"post":{"summary":"Checkout content that the existing git_ref points to and save to the object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the item.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object406"}}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/python3/{id}/git":{"get":{"summary":"Get the git metadata attached to an item","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the item.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object402"}}},"x-examples":null,"x-deprecation-warning":null},"put":{"summary":"Attach an item to a file in a git repo","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the item.","type":"integer"},{"name":"Object403","in":"body","schema":{"$ref":"#/definitions/Object403"},"required":false}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object402"}}},"x-examples":null,"x-deprecation-warning":null},"patch":{"summary":"Update an attached git file","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the item.","type":"integer"},{"name":"Object403","in":"body","schema":{"$ref":"#/definitions/Object403"},"required":false}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object402"}}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/python3/{id}/git/commits":{"get":{"summary":"Get the git commits for an item on the current branch","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the item.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object404"}}},"x-examples":null,"x-deprecation-warning":null},"post":{"summary":"Commit and push a new version of the file","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the item.","type":"integer"},{"name":"Object405","in":"body","schema":{"$ref":"#/definitions/Object405"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object406"}}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/python3/{id}/git/commits/{commit_hash}":{"get":{"summary":"Get file contents at git ref","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the item.","type":"integer"},{"name":"commit_hash","in":"path","required":true,"description":"The SHA (full or shortened) of the desired git commit.","type":"string"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object406"}}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/python3/{id}/git/checkout-latest":{"post":{"summary":"Checkout latest commit on the current branch of a script or workflow","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the item.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object406"}}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/python3/{id}/git/checkout":{"post":{"summary":"Checkout content that the existing git_ref points to and save to the object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the item.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object406"}}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/r/{id}/git":{"get":{"summary":"Get the git metadata attached to an item","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the item.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object402"}}},"x-examples":null,"x-deprecation-warning":null},"put":{"summary":"Attach an item to a file in a git repo","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the item.","type":"integer"},{"name":"Object403","in":"body","schema":{"$ref":"#/definitions/Object403"},"required":false}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object402"}}},"x-examples":null,"x-deprecation-warning":null},"patch":{"summary":"Update an attached git file","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the item.","type":"integer"},{"name":"Object403","in":"body","schema":{"$ref":"#/definitions/Object403"},"required":false}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object402"}}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/r/{id}/git/commits":{"get":{"summary":"Get the git commits for an item on the current branch","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the item.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object404"}}},"x-examples":null,"x-deprecation-warning":null},"post":{"summary":"Commit and push a new version of the file","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the item.","type":"integer"},{"name":"Object405","in":"body","schema":{"$ref":"#/definitions/Object405"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object406"}}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/r/{id}/git/commits/{commit_hash}":{"get":{"summary":"Get file contents at git ref","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the item.","type":"integer"},{"name":"commit_hash","in":"path","required":true,"description":"The SHA (full or shortened) of the desired git commit.","type":"string"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object406"}}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/r/{id}/git/checkout-latest":{"post":{"summary":"Checkout latest commit on the current branch of a script or workflow","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the item.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object406"}}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/r/{id}/git/checkout":{"post":{"summary":"Checkout content that the existing git_ref points to and save to the object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the item.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object406"}}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/sql/{id}/shares":{"get":{"summary":"List users and groups permissioned on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object9"}}}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/sql/{id}/shares/users":{"put":{"summary":"Set the permissions users have on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"Object602","in":"body","schema":{"$ref":"#/definitions/Object602"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object9"}}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/sql/{id}/shares/users/{user_id}":{"delete":{"summary":"Revoke the permissions a user has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"user_id","in":"path","required":true,"description":"The ID of the user.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/sql/{id}/shares/groups":{"put":{"summary":"Set the permissions groups has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"Object603","in":"body","schema":{"$ref":"#/definitions/Object603"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object9"}}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/sql/{id}/shares/groups/{group_id}":{"delete":{"summary":"Revoke the permissions a group has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"group_id","in":"path","required":true,"description":"The ID of the group.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/sql/{id}/dependencies":{"get":{"summary":"List dependent objects for this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"user_id","in":"query","required":false,"description":"ID of target user","type":"integer"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object15"}}}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/sql/{id}/transfer":{"put":{"summary":"Transfer ownership of this object to another user","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"Object604","in":"body","schema":{"$ref":"#/definitions/Object604"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object17"}}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/sql/{id}/projects":{"get":{"summary":"List the projects a SQL Script belongs to","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the SQL Script.","type":"integer"},{"name":"hidden","in":"query","required":false,"description":"If specified to be true, returns hidden items. Defaults to false, returning non-hidden items.","type":"boolean"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object84"}}}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/sql/{id}/projects/{project_id}":{"put":{"summary":"Add a SQL Script to a project","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the SQL Script.","type":"integer"},{"name":"project_id","in":"path","required":true,"description":"The ID of the project.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null},"delete":{"summary":"Remove a SQL Script from a project","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the SQL Script.","type":"integer"},{"name":"project_id","in":"path","required":true,"description":"The ID of the project.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/sql/{id}/archive":{"put":{"summary":"Update the archive status of this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the object.","type":"integer"},{"name":"Object605","in":"body","schema":{"$ref":"#/definitions/Object605"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object544"}}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/containers/{id}/shares":{"get":{"summary":"List users and groups permissioned on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object9"}}}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/containers/{id}/shares/users":{"put":{"summary":"Set the permissions users have on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"Object606","in":"body","schema":{"$ref":"#/definitions/Object606"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object9"}}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/containers/{id}/shares/users/{user_id}":{"delete":{"summary":"Revoke the permissions a user has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"user_id","in":"path","required":true,"description":"The ID of the user.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/containers/{id}/shares/groups":{"put":{"summary":"Set the permissions groups has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"Object607","in":"body","schema":{"$ref":"#/definitions/Object607"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object9"}}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/containers/{id}/shares/groups/{group_id}":{"delete":{"summary":"Revoke the permissions a group has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"group_id","in":"path","required":true,"description":"The ID of the group.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/containers/{id}/dependencies":{"get":{"summary":"List dependent objects for this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"user_id","in":"query","required":false,"description":"ID of target user","type":"integer"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object15"}}}},"x-examples":[{"resource":"Scripts","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/scripts/containers/:id/dependencies","description":"Get all container dependencies","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/scripts/containers/2844/dependencies","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer aVO77axANNLehy4wrRGSbK9cIMQP2gj2D6Doj4Efi44","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"objectType\": \"Credential\",\n \"fcoType\": \"credentials\",\n \"id\": 1273,\n \"name\": \"Custom\",\n \"permissionLevel\": null,\n \"description\": null,\n \"shareable\": true\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"8206155baeeff2084d873904e4929ed8\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"8b2a857e-eb0d-46c4-acf0-a06d549af162","X-Runtime":"0.039390","Content-Length":"138"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/scripts/containers/2844/dependencies\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer aVO77axANNLehy4wrRGSbK9cIMQP2gj2D6Doj4Efi44\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Scripts","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/scripts/containers/:id/dependencies","description":"Get all container dependencies using a target user","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/scripts/containers/2853/dependencies?userId=2950","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer kU0a9Ev6DiFULVV2KDCcKx1gGc9dWlLLJDjrDqImAH4","Host":"api.civis.test","Cookie":""},"request_query_parameters":{"userId":"2950"},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"objectType\": \"Credential\",\n \"fcoType\": \"credentials\",\n \"id\": 1283,\n \"name\": \"Custom\",\n \"permissionLevel\": \"manage\",\n \"description\": null,\n \"shareable\": true\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"5b398e4a126401fb914a152cde3dc6ac\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"51037b69-dcd9-405f-ae8a-71bcc3b9af96","X-Runtime":"0.053699","Content-Length":"142"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/scripts/containers/2853/dependencies?userId=2950\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer kU0a9Ev6DiFULVV2KDCcKx1gGc9dWlLLJDjrDqImAH4\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/scripts/containers/{id}/transfer":{"put":{"summary":"Transfer ownership of this object to another user","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"Object608","in":"body","schema":{"$ref":"#/definitions/Object608"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object17"}}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/containers/{id}/projects":{"get":{"summary":"List the projects a Container Script belongs to","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Container Script.","type":"integer"},{"name":"hidden","in":"query","required":false,"description":"If specified to be true, returns hidden items. Defaults to false, returning non-hidden items.","type":"boolean"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object84"}}}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/containers/{id}/projects/{project_id}":{"put":{"summary":"Add a Container Script to a project","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Container Script.","type":"integer"},{"name":"project_id","in":"path","required":true,"description":"The ID of the project.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null},"delete":{"summary":"Remove a Container Script from a project","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Container Script.","type":"integer"},{"name":"project_id","in":"path","required":true,"description":"The ID of the project.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/containers/{id}/archive":{"put":{"summary":"Update the archive status of this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the object.","type":"integer"},{"name":"Object609","in":"body","schema":{"$ref":"#/definitions/Object609"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object531"}}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/python3/{id}/shares":{"get":{"summary":"List users and groups permissioned on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object9"}}}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/python3/{id}/shares/users":{"put":{"summary":"Set the permissions users have on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"Object610","in":"body","schema":{"$ref":"#/definitions/Object610"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object9"}}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/python3/{id}/shares/users/{user_id}":{"delete":{"summary":"Revoke the permissions a user has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"user_id","in":"path","required":true,"description":"The ID of the user.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/python3/{id}/shares/groups":{"put":{"summary":"Set the permissions groups has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"Object611","in":"body","schema":{"$ref":"#/definitions/Object611"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object9"}}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/python3/{id}/shares/groups/{group_id}":{"delete":{"summary":"Revoke the permissions a group has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"group_id","in":"path","required":true,"description":"The ID of the group.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/python3/{id}/dependencies":{"get":{"summary":"List dependent objects for this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"user_id","in":"query","required":false,"description":"ID of target user","type":"integer"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object15"}}}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/python3/{id}/transfer":{"put":{"summary":"Transfer ownership of this object to another user","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"Object612","in":"body","schema":{"$ref":"#/definitions/Object612"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object17"}}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/python3/{id}/projects":{"get":{"summary":"List the projects a Python Script belongs to","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Python Script.","type":"integer"},{"name":"hidden","in":"query","required":false,"description":"If specified to be true, returns hidden items. Defaults to false, returning non-hidden items.","type":"boolean"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object84"}}}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/python3/{id}/projects/{project_id}":{"put":{"summary":"Add a Python Script to a project","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Python Script.","type":"integer"},{"name":"project_id","in":"path","required":true,"description":"The ID of the project.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null},"delete":{"summary":"Remove a Python Script from a project","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Python Script.","type":"integer"},{"name":"project_id","in":"path","required":true,"description":"The ID of the project.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/python3/{id}/archive":{"put":{"summary":"Update the archive status of this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the object.","type":"integer"},{"name":"Object613","in":"body","schema":{"$ref":"#/definitions/Object613"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object549"}}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/r/{id}/shares":{"get":{"summary":"List users and groups permissioned on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object9"}}}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/r/{id}/shares/users":{"put":{"summary":"Set the permissions users have on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"Object614","in":"body","schema":{"$ref":"#/definitions/Object614"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object9"}}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/r/{id}/shares/users/{user_id}":{"delete":{"summary":"Revoke the permissions a user has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"user_id","in":"path","required":true,"description":"The ID of the user.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/r/{id}/shares/groups":{"put":{"summary":"Set the permissions groups has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"Object615","in":"body","schema":{"$ref":"#/definitions/Object615"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object9"}}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/r/{id}/shares/groups/{group_id}":{"delete":{"summary":"Revoke the permissions a group has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"group_id","in":"path","required":true,"description":"The ID of the group.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/r/{id}/dependencies":{"get":{"summary":"List dependent objects for this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"user_id","in":"query","required":false,"description":"ID of target user","type":"integer"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object15"}}}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/r/{id}/transfer":{"put":{"summary":"Transfer ownership of this object to another user","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"Object616","in":"body","schema":{"$ref":"#/definitions/Object616"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object17"}}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/r/{id}/projects":{"get":{"summary":"List the projects an R Script belongs to","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the R Script.","type":"integer"},{"name":"hidden","in":"query","required":false,"description":"If specified to be true, returns hidden items. Defaults to false, returning non-hidden items.","type":"boolean"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object84"}}}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/r/{id}/projects/{project_id}":{"put":{"summary":"Add an R Script to a project","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the R Script.","type":"integer"},{"name":"project_id","in":"path","required":true,"description":"The ID of the project.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null},"delete":{"summary":"Remove an R Script from a project","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the R Script.","type":"integer"},{"name":"project_id","in":"path","required":true,"description":"The ID of the project.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/r/{id}/archive":{"put":{"summary":"Update the archive status of this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the object.","type":"integer"},{"name":"Object617","in":"body","schema":{"$ref":"#/definitions/Object617"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object553"}}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/dbt/{id}/shares":{"get":{"summary":"List users and groups permissioned on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object9"}}}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/dbt/{id}/shares/users":{"put":{"summary":"Set the permissions users have on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"Object618","in":"body","schema":{"$ref":"#/definitions/Object618"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object9"}}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/dbt/{id}/shares/users/{user_id}":{"delete":{"summary":"Revoke the permissions a user has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"user_id","in":"path","required":true,"description":"The ID of the user.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/dbt/{id}/shares/groups":{"put":{"summary":"Set the permissions groups has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"Object619","in":"body","schema":{"$ref":"#/definitions/Object619"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object9"}}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/dbt/{id}/shares/groups/{group_id}":{"delete":{"summary":"Revoke the permissions a group has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"group_id","in":"path","required":true,"description":"The ID of the group.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/dbt/{id}/dependencies":{"get":{"summary":"List dependent objects for this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"user_id","in":"query","required":false,"description":"ID of target user","type":"integer"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object15"}}}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/dbt/{id}/transfer":{"put":{"summary":"Transfer ownership of this object to another user","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"Object620","in":"body","schema":{"$ref":"#/definitions/Object620"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object17"}}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/dbt/{id}/projects":{"get":{"summary":"List the projects a dbt Script belongs to","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the dbt Script.","type":"integer"},{"name":"hidden","in":"query","required":false,"description":"If specified to be true, returns hidden items. Defaults to false, returning non-hidden items.","type":"boolean"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object84"}}}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/dbt/{id}/projects/{project_id}":{"put":{"summary":"Add a dbt Script to a project","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the dbt Script.","type":"integer"},{"name":"project_id","in":"path","required":true,"description":"The ID of the project.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null},"delete":{"summary":"Remove a dbt Script from a project","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the dbt Script.","type":"integer"},{"name":"project_id","in":"path","required":true,"description":"The ID of the project.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/dbt/{id}/archive":{"put":{"summary":"Update the archive status of this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the object.","type":"integer"},{"name":"Object621","in":"body","schema":{"$ref":"#/definitions/Object621"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object559"}}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/javascript/{id}/shares":{"get":{"summary":"List users and groups permissioned on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object9"}}}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/javascript/{id}/shares/users":{"put":{"summary":"Set the permissions users have on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"Object622","in":"body","schema":{"$ref":"#/definitions/Object622"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object9"}}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/javascript/{id}/shares/users/{user_id}":{"delete":{"summary":"Revoke the permissions a user has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"user_id","in":"path","required":true,"description":"The ID of the user.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/javascript/{id}/shares/groups":{"put":{"summary":"Set the permissions groups has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"Object623","in":"body","schema":{"$ref":"#/definitions/Object623"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object9"}}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/javascript/{id}/shares/groups/{group_id}":{"delete":{"summary":"Revoke the permissions a group has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"group_id","in":"path","required":true,"description":"The ID of the group.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/javascript/{id}/dependencies":{"get":{"summary":"List dependent objects for this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"user_id","in":"query","required":false,"description":"ID of target user","type":"integer"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object15"}}}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/javascript/{id}/transfer":{"put":{"summary":"Transfer ownership of this object to another user","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"Object624","in":"body","schema":{"$ref":"#/definitions/Object624"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object17"}}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/javascript/{id}/projects":{"get":{"summary":"List the projects a JavaScript Script belongs to","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the JavaScript Script.","type":"integer"},{"name":"hidden","in":"query","required":false,"description":"If specified to be true, returns hidden items. Defaults to false, returning non-hidden items.","type":"boolean"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object84"}}}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/javascript/{id}/projects/{project_id}":{"put":{"summary":"Add a JavaScript Script to a project","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the JavaScript Script.","type":"integer"},{"name":"project_id","in":"path","required":true,"description":"The ID of the project.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null},"delete":{"summary":"Remove a JavaScript Script from a project","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the JavaScript Script.","type":"integer"},{"name":"project_id","in":"path","required":true,"description":"The ID of the project.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/javascript/{id}/archive":{"put":{"summary":"Update the archive status of this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the object.","type":"integer"},{"name":"Object625","in":"body","schema":{"$ref":"#/definitions/Object625"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object566"}}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/custom/{id}/shares":{"get":{"summary":"List users and groups permissioned on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object9"}}}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/custom/{id}/shares/users":{"put":{"summary":"Set the permissions users have on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"Object626","in":"body","schema":{"$ref":"#/definitions/Object626"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object9"}}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/custom/{id}/shares/users/{user_id}":{"delete":{"summary":"Revoke the permissions a user has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"user_id","in":"path","required":true,"description":"The ID of the user.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/custom/{id}/shares/groups":{"put":{"summary":"Set the permissions groups has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"Object627","in":"body","schema":{"$ref":"#/definitions/Object627"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object9"}}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/custom/{id}/shares/groups/{group_id}":{"delete":{"summary":"Revoke the permissions a group has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"group_id","in":"path","required":true,"description":"The ID of the group.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/custom/{id}/dependencies":{"get":{"summary":"List dependent objects for this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"user_id","in":"query","required":false,"description":"ID of target user","type":"integer"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object15"}}}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/custom/{id}/transfer":{"put":{"summary":"Transfer ownership of this object to another user","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"Object628","in":"body","schema":{"$ref":"#/definitions/Object628"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object17"}}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/custom/{id}/projects":{"get":{"summary":"List the projects a Custom Script belongs to","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Custom Script.","type":"integer"},{"name":"hidden","in":"query","required":false,"description":"If specified to be true, returns hidden items. Defaults to false, returning non-hidden items.","type":"boolean"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object84"}}}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/custom/{id}/projects/{project_id}":{"put":{"summary":"Add a Custom Script to a project","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Custom Script.","type":"integer"},{"name":"project_id","in":"path","required":true,"description":"The ID of the project.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null},"delete":{"summary":"Remove a Custom Script from a project","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Custom Script.","type":"integer"},{"name":"project_id","in":"path","required":true,"description":"The ID of the project.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/custom/{id}/archive":{"put":{"summary":"Update the archive status of this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the object.","type":"integer"},{"name":"Object629","in":"body","schema":{"$ref":"#/definitions/Object629"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object572"}}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/sql/{id}/clone":{"post":{"summary":"Clone this SQL Script","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID for the script.","type":"integer"},{"name":"Object630","in":"body","schema":{"$ref":"#/definitions/Object630"},"required":false}],"responses":{"201":{"description":"success","schema":{"$ref":"#/definitions/Object544"}}},"x-examples":[{"resource":"Scripts","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/scripts/sql/:id/clone","description":"Clone a sql script","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/scripts/sql/2515/clone","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer yGn-uk325qI1cj6FWIVBUwNET2w6a-TEbl4k4vuPhF8","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":201,"response_status_text":"Created","response_body":"{\n \"id\": 2518,\n \"name\": \"Clone of Script 2515 Script #2515\",\n \"type\": \"SQL\",\n \"createdAt\": \"2024-12-03T19:46:13.000Z\",\n \"updatedAt\": \"2024-12-03T19:46:13.000Z\",\n \"author\": {\n \"id\": 2576,\n \"name\": \"User devuserfactory2090 2090\",\n \"username\": \"devuserfactory2090\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"state\": \"idle\",\n \"finishedAt\": null,\n \"category\": \"script\",\n \"projects\": [\n\n ],\n \"parentId\": null,\n \"userContext\": \"runner\",\n \"params\": [\n {\n \"name\": \"id\",\n \"label\": \"ID\",\n \"description\": null,\n \"type\": \"integer\",\n \"required\": true,\n \"value\": null,\n \"default\": null,\n \"allowedValues\": [\n\n ]\n },\n {\n \"name\": \"state\",\n \"label\": \"State\",\n \"description\": null,\n \"type\": \"string\",\n \"required\": true,\n \"value\": null,\n \"default\": null,\n \"allowedValues\": [\n\n ]\n },\n {\n \"name\": \"table\",\n \"label\": \"Table\",\n \"description\": null,\n \"type\": \"string\",\n \"required\": false,\n \"value\": null,\n \"default\": null,\n \"allowedValues\": [\n\n ]\n },\n {\n \"name\": \"abool\",\n \"label\": \"A Bool\",\n \"description\": null,\n \"type\": \"bool\",\n \"required\": false,\n \"value\": null,\n \"default\": false,\n \"allowedValues\": [\n\n ]\n },\n {\n \"name\": \"afloat\",\n \"label\": \"A Float\",\n \"description\": null,\n \"type\": \"float\",\n \"required\": false,\n \"value\": null,\n \"default\": null,\n \"allowedValues\": [\n\n ]\n },\n {\n \"name\": \"optionalstr\",\n \"label\": \"Optional String\",\n \"description\": null,\n \"type\": \"string\",\n \"required\": false,\n \"value\": null,\n \"default\": null,\n \"allowedValues\": [\n\n ]\n },\n {\n \"name\": \"cred\",\n \"label\": \"Cred\",\n \"description\": null,\n \"type\": \"credential_redshift\",\n \"required\": false,\n \"value\": null,\n \"default\": null,\n \"allowedValues\": [\n\n ]\n },\n {\n \"name\": \"cred2\",\n \"label\": \"Cred AWS\",\n \"description\": null,\n \"type\": \"credential_aws\",\n \"required\": false,\n \"value\": null,\n \"default\": null,\n \"allowedValues\": [\n\n ]\n }\n ],\n \"arguments\": {\n \"id\": 2,\n \"state\": \"IL\",\n \"table\": \"test.test\"\n },\n \"isTemplate\": false,\n \"publishedAsTemplateId\": null,\n \"fromTemplateId\": null,\n \"templateDependentsCount\": null,\n \"templateScriptName\": null,\n \"links\": {\n \"details\": \"api.civis.test/scripts/sql/2518\",\n \"runs\": \"api.civis.test/scripts/sql/2518/runs\"\n },\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n },\n \"notifications\": {\n \"urls\": [\n\n ],\n \"successEmailSubject\": null,\n \"successEmailBody\": null,\n \"successEmailAddresses\": [\n \"script_spec_user@civisanalytics.com\"\n ],\n \"successEmailFromName\": null,\n \"successEmailReplyTo\": null,\n \"failureEmailAddresses\": [\n \"script_spec_user@civisanalytics.com\"\n ],\n \"stallWarningMinutes\": null,\n \"successOn\": true,\n \"failureOn\": true\n },\n \"runningAs\": {\n \"id\": 2576,\n \"name\": \"User devuserfactory2090 2090\",\n \"username\": \"devuserfactory2090\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"nextRunAt\": null,\n \"timeZone\": \"America/Chicago\",\n \"lastRun\": null,\n \"myPermissionLevel\": \"manage\",\n \"hidden\": false,\n \"targetProjectId\": null,\n \"archived\": false,\n \"sql\": \"SELECT * FROM table LIMIT 10;\",\n \"expandedArguments\": {\n \"id\": 2,\n \"state\": \"IL\",\n \"state.literal\": \"'IL'\",\n \"state.identifier\": \"\\\"IL\\\"\",\n \"state.shell_escaped\": \"IL\",\n \"table\": \"test.test\",\n \"table.literal\": \"'test.test'\",\n \"table.identifier\": \"\\\"test.test\\\"\",\n \"table.shell_escaped\": \"test.test\",\n \"abool\": false,\n \"afloat\": 0,\n \"optionalstr\": \"\",\n \"optionalstr.literal\": \"''\",\n \"optionalstr.identifier\": \"\\\"\\\"\",\n \"optionalstr.shell_escaped\": \"''\",\n \"cred.id\": \"\",\n \"cred.username\": \"\",\n \"cred.password\": \"\",\n \"cred2.id\": \"\",\n \"cred2.access_key_id\": \"\",\n \"cred2.secret_access_key\": \"\"\n },\n \"remoteHostId\": 324,\n \"credentialId\": 900,\n \"codePreview\": \"SELECT * FROM table LIMIT 10;\",\n \"csvSettings\": {\n \"includeHeader\": true,\n \"compression\": \"gzip\",\n \"columnDelimiter\": \"comma\",\n \"unquoted\": false,\n \"forceMultifile\": false,\n \"filenamePrefix\": null,\n \"maxFileSize\": null\n },\n \"runningAsId\": 2576\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"843ac9897b58f493926f79924ce34642\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"17b140d6-94ce-43ad-93f0-579747f3dfc7","X-Runtime":"0.161162","Content-Length":"3288"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/scripts/sql/2515/clone\" -d '' -X POST \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer yGn-uk325qI1cj6FWIVBUwNET2w6a-TEbl4k4vuPhF8\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/scripts/javascript/{id}/clone":{"post":{"summary":"Clone this JavaScript Script","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID for the script.","type":"integer"},{"name":"Object630","in":"body","schema":{"$ref":"#/definitions/Object630"},"required":false}],"responses":{"201":{"description":"success","schema":{"$ref":"#/definitions/Object566"}}},"x-examples":[{"resource":"Scripts","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/scripts/javascript/:id/clone","description":"Clone a javascript script","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/scripts/javascript/2526/clone","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer oJOsn73xDYMsRGoiI7E-DbMnYnYR6y0Mmc27cdqrcpo","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":201,"response_status_text":"Created","response_body":"{\n \"id\": 2527,\n \"name\": \"Clone of Script 2526 Script #2526\",\n \"type\": \"JavaScript\",\n \"createdAt\": \"2024-12-03T19:46:15.000Z\",\n \"updatedAt\": \"2024-12-03T19:46:15.000Z\",\n \"author\": {\n \"id\": 2583,\n \"name\": \"User devuserfactory2096 2096\",\n \"username\": \"devuserfactory2096\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"state\": \"idle\",\n \"finishedAt\": null,\n \"category\": \"script\",\n \"projects\": [\n\n ],\n \"parentId\": null,\n \"userContext\": \"runner\",\n \"params\": [\n\n ],\n \"arguments\": {\n },\n \"isTemplate\": false,\n \"publishedAsTemplateId\": null,\n \"fromTemplateId\": null,\n \"templateDependentsCount\": null,\n \"templateScriptName\": null,\n \"links\": {\n \"details\": \"api.civis.test/scripts/javascript/2527\",\n \"runs\": \"api.civis.test/scripts/javascript/2527/runs\"\n },\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n },\n \"notifications\": {\n \"urls\": [\n\n ],\n \"successEmailSubject\": null,\n \"successEmailBody\": null,\n \"successEmailAddresses\": [\n \"script_spec_user@civisanalytics.com\"\n ],\n \"successEmailFromName\": null,\n \"successEmailReplyTo\": null,\n \"failureEmailAddresses\": [\n \"script_spec_user@civisanalytics.com\"\n ],\n \"stallWarningMinutes\": null,\n \"successOn\": true,\n \"failureOn\": true\n },\n \"runningAs\": {\n \"id\": 2583,\n \"name\": \"User devuserfactory2096 2096\",\n \"username\": \"devuserfactory2096\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"nextRunAt\": null,\n \"timeZone\": \"America/Chicago\",\n \"lastRun\": null,\n \"myPermissionLevel\": \"manage\",\n \"hidden\": false,\n \"targetProjectId\": null,\n \"archived\": false,\n \"source\": \"log('hello world')\",\n \"remoteHostId\": 329,\n \"credentialId\": 909,\n \"runningAsId\": 2583\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"36852e8bdd376b698a061d757eeac4bb\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"d2ab88c7-ea3d-4bd4-92f5-d26becc3d666","X-Runtime":"0.112563","Content-Length":"1471"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/scripts/javascript/2526/clone\" -d '' -X POST \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer oJOsn73xDYMsRGoiI7E-DbMnYnYR6y0Mmc27cdqrcpo\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/scripts/python3/{id}/clone":{"post":{"summary":"Clone this Python Script","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID for the script.","type":"integer"},{"name":"Object630","in":"body","schema":{"$ref":"#/definitions/Object630"},"required":false}],"responses":{"201":{"description":"success","schema":{"$ref":"#/definitions/Object549"}}},"x-examples":[{"resource":"Scripts","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/scripts/python3/:id/clone","description":"Clone a python script","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/scripts/python3/2536/clone","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer 6Se5Pta4H5eokN84P2-Vx080TmxG1nja8Jt0Jm0w3Cw","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":201,"response_status_text":"Created","response_body":"{\n \"id\": 2537,\n \"name\": \"Clone of Script 2536 Script #2536\",\n \"type\": \"Python\",\n \"createdAt\": \"2024-12-03T19:46:16.000Z\",\n \"updatedAt\": \"2024-12-03T19:46:16.000Z\",\n \"author\": {\n \"id\": 2591,\n \"name\": \"User devuserfactory2103 2103\",\n \"username\": \"devuserfactory2103\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"state\": \"idle\",\n \"finishedAt\": null,\n \"category\": \"script\",\n \"projects\": [\n\n ],\n \"parentId\": null,\n \"userContext\": \"runner\",\n \"params\": [\n\n ],\n \"arguments\": {\n },\n \"isTemplate\": false,\n \"publishedAsTemplateId\": null,\n \"fromTemplateId\": null,\n \"templateDependentsCount\": null,\n \"templateScriptName\": null,\n \"links\": {\n \"details\": \"api.civis.test/scripts/python3/2537\",\n \"runs\": \"api.civis.test/scripts/python3/2537/runs\"\n },\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n },\n \"notifications\": {\n \"urls\": [\n\n ],\n \"successEmailSubject\": null,\n \"successEmailBody\": null,\n \"successEmailAddresses\": [\n \"script_spec_user@civisanalytics.com\"\n ],\n \"successEmailFromName\": null,\n \"successEmailReplyTo\": null,\n \"failureEmailAddresses\": [\n \"script_spec_user@civisanalytics.com\"\n ],\n \"stallWarningMinutes\": null,\n \"successOn\": true,\n \"failureOn\": true\n },\n \"runningAs\": {\n \"id\": 2591,\n \"name\": \"User devuserfactory2103 2103\",\n \"username\": \"devuserfactory2103\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"nextRunAt\": null,\n \"timeZone\": \"America/Chicago\",\n \"lastRun\": null,\n \"myPermissionLevel\": \"manage\",\n \"hidden\": false,\n \"targetProjectId\": null,\n \"archived\": false,\n \"requiredResources\": {\n \"cpu\": null,\n \"memory\": null,\n \"diskSpace\": 1.0\n },\n \"instanceType\": null,\n \"cancelTimeout\": 0,\n \"dockerImageTag\": \"mock_latest_tag\",\n \"partitionLabel\": null,\n \"runningAsId\": 2591,\n \"source\": \"print 'Hello World'\"\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"054f4171861385f317448fce3fa36bbc\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"cf7f8d17-be3c-4201-af95-f2d3dc586198","X-Runtime":"0.117039","Content-Length":"1582"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/scripts/python3/2536/clone\" -d '' -X POST \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer 6Se5Pta4H5eokN84P2-Vx080TmxG1nja8Jt0Jm0w3Cw\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/scripts/r/{id}/clone":{"post":{"summary":"Clone this R Script","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID for the script.","type":"integer"},{"name":"Object630","in":"body","schema":{"$ref":"#/definitions/Object630"},"required":false}],"responses":{"201":{"description":"success","schema":{"$ref":"#/definitions/Object553"}}},"x-examples":[{"resource":"Scripts","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/scripts/r/:id/clone","description":"Clone an R script","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/scripts/r/2546/clone","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer OmCXfzuHY8lO9nRACTaAE3PQBw6IsKcjooSI4HPguRo","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":201,"response_status_text":"Created","response_body":"{\n \"id\": 2547,\n \"name\": \"Clone of Script 2546 Script #2546\",\n \"type\": \"R\",\n \"createdAt\": \"2024-12-03T19:46:17.000Z\",\n \"updatedAt\": \"2024-12-03T19:46:17.000Z\",\n \"author\": {\n \"id\": 2600,\n \"name\": \"User devuserfactory2111 2111\",\n \"username\": \"devuserfactory2111\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"state\": \"idle\",\n \"finishedAt\": null,\n \"category\": \"script\",\n \"projects\": [\n\n ],\n \"parentId\": null,\n \"userContext\": \"runner\",\n \"params\": [\n\n ],\n \"arguments\": {\n },\n \"isTemplate\": false,\n \"publishedAsTemplateId\": null,\n \"fromTemplateId\": null,\n \"templateDependentsCount\": null,\n \"templateScriptName\": null,\n \"links\": {\n \"details\": \"api.civis.test/scripts/r/2547\",\n \"runs\": \"api.civis.test/scripts/r/2547/runs\"\n },\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n },\n \"notifications\": {\n \"urls\": [\n\n ],\n \"successEmailSubject\": null,\n \"successEmailBody\": null,\n \"successEmailAddresses\": [\n \"script_spec_user@civisanalytics.com\"\n ],\n \"successEmailFromName\": null,\n \"successEmailReplyTo\": null,\n \"failureEmailAddresses\": [\n \"script_spec_user@civisanalytics.com\"\n ],\n \"stallWarningMinutes\": null,\n \"successOn\": true,\n \"failureOn\": true\n },\n \"runningAs\": {\n \"id\": 2600,\n \"name\": \"User devuserfactory2111 2111\",\n \"username\": \"devuserfactory2111\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"nextRunAt\": null,\n \"timeZone\": \"America/Chicago\",\n \"lastRun\": null,\n \"myPermissionLevel\": \"manage\",\n \"hidden\": false,\n \"targetProjectId\": null,\n \"archived\": false,\n \"requiredResources\": {\n \"cpu\": null,\n \"memory\": null,\n \"diskSpace\": 1.0\n },\n \"instanceType\": null,\n \"cancelTimeout\": 0,\n \"dockerImageTag\": \"mock_latest_tag\",\n \"partitionLabel\": null,\n \"runningAsId\": 2600,\n \"source\": \"cat('Hello World')\"\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"8a70eb854a497b3a95e71a6989724bc3\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"f9f6f4aa-023c-409a-911c-433b747ea9b4","X-Runtime":"0.103020","Content-Length":"1564"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/scripts/r/2546/clone\" -d '' -X POST \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer OmCXfzuHY8lO9nRACTaAE3PQBw6IsKcjooSI4HPguRo\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/scripts/containers/{id}/clone":{"post":{"summary":"Clone this Container Script","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID for the script.","type":"integer"},{"name":"Object630","in":"body","schema":{"$ref":"#/definitions/Object630"},"required":false}],"responses":{"201":{"description":"success","schema":{"$ref":"#/definitions/Object531"}}},"x-examples":[{"resource":"Scripts","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/scripts/containers/:id/clone","description":"Clone a container script","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/scripts/containers/2556/clone","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer 9VWfqjAJ1m_yb9YpouszWnjEv0HJ8zTSYQAr0pMavA4","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":201,"response_status_text":"Created","response_body":"{\n \"id\": 2557,\n \"fromTemplateAliases\": [\n\n ],\n \"name\": \"Clone of Script 2556 Script #2556\",\n \"type\": \"Container\",\n \"createdAt\": \"2024-12-03T19:46:18.000Z\",\n \"updatedAt\": \"2024-12-03T19:46:18.000Z\",\n \"author\": {\n \"id\": 2609,\n \"name\": \"User devuserfactory2119 2119\",\n \"username\": \"devuserfactory2119\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"state\": \"idle\",\n \"finishedAt\": null,\n \"category\": \"script\",\n \"projects\": [\n\n ],\n \"parentId\": null,\n \"userContext\": \"runner\",\n \"params\": [\n\n ],\n \"arguments\": {\n },\n \"isTemplate\": false,\n \"templateDependentsCount\": null,\n \"publishedAsTemplateId\": null,\n \"fromTemplateId\": null,\n \"templateScriptName\": null,\n \"links\": {\n \"details\": \"api.civis.test/scripts/containers/2557\",\n \"runs\": \"api.civis.test/scripts/containers/2557/runs\"\n },\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n },\n \"notifications\": {\n \"urls\": [\n\n ],\n \"successEmailSubject\": null,\n \"successEmailBody\": null,\n \"successEmailAddresses\": [\n \"script_spec_user@civisanalytics.com\"\n ],\n \"successEmailFromName\": null,\n \"successEmailReplyTo\": null,\n \"failureEmailAddresses\": [\n \"script_spec_user@civisanalytics.com\"\n ],\n \"stallWarningMinutes\": null,\n \"successOn\": true,\n \"failureOn\": true\n },\n \"runningAs\": {\n \"id\": 2609,\n \"name\": \"User devuserfactory2119 2119\",\n \"username\": \"devuserfactory2119\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"requiredResources\": {\n \"cpu\": null,\n \"memory\": null,\n \"diskSpace\": 1.0\n },\n \"repoHttpUri\": \"git_repo_url\",\n \"repoRef\": \"git_repo_ref\",\n \"remoteHostCredentialId\": null,\n \"gitCredentialId\": null,\n \"dockerCommand\": \"command\",\n \"dockerImageName\": \"docker_image_name\",\n \"dockerImageTag\": \"mock_latest_tag\",\n \"instanceType\": null,\n \"cancelTimeout\": 0,\n \"lastRun\": null,\n \"timeZone\": \"America/Chicago\",\n \"partitionLabel\": null,\n \"myPermissionLevel\": \"manage\",\n \"hidden\": false,\n \"archived\": false,\n \"targetProjectId\": null,\n \"runningAsId\": 2609\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"d98266b7dc11d0192e857ee7644ec045\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"eb245cb0-08dd-4c90-b9f9-354aa1616c9f","X-Runtime":"0.099041","Content-Length":"1739"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/scripts/containers/2556/clone\" -d '' -X POST \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer 9VWfqjAJ1m_yb9YpouszWnjEv0HJ8zTSYQAr0pMavA4\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/scripts/dbt/{id}/clone":{"post":{"summary":"Clone this dbt Script","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID for the script.","type":"integer"},{"name":"Object630","in":"body","schema":{"$ref":"#/definitions/Object630"},"required":false}],"responses":{"201":{"description":"success","schema":{"$ref":"#/definitions/Object559"}}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/custom/{id}/clone":{"post":{"summary":"Clone this Custom Script","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID for the script.","type":"integer"},{"name":"Object630","in":"body","schema":{"$ref":"#/definitions/Object630"},"required":false}],"responses":{"201":{"description":"success","schema":{"$ref":"#/definitions/Object572"}}},"x-examples":[{"resource":"Scripts","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/scripts/custom/:id/clone","description":"Clone a custom script","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/scripts/custom/2571/clone","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer eqd4UAgEWUqo9hQbNhfSjVELrUR3u4Lp2vG3cAVBfBw","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":201,"response_status_text":"Created","response_body":"{\n \"id\": 2572,\n \"fromTemplateAliases\": [\n\n ],\n \"name\": \"Clone of Script 2571 awesome sql template #2571\",\n \"type\": \"Custom\",\n \"backingScriptType\": \"SQL\",\n \"createdAt\": \"2024-12-03T19:46:19.000Z\",\n \"updatedAt\": \"2024-12-03T19:46:19.000Z\",\n \"author\": {\n \"id\": 2618,\n \"name\": \"User devuserfactory2127 2127\",\n \"username\": \"devuserfactory2127\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"state\": \"idle\",\n \"finishedAt\": null,\n \"category\": \"script\",\n \"projects\": [\n\n ],\n \"parentId\": null,\n \"params\": [\n {\n \"name\": \"id\",\n \"label\": \"ID\",\n \"description\": null,\n \"type\": \"integer\",\n \"required\": true,\n \"value\": null,\n \"default\": null,\n \"allowedValues\": [\n\n ]\n },\n {\n \"name\": \"state\",\n \"label\": \"State\",\n \"description\": null,\n \"type\": \"string\",\n \"required\": true,\n \"value\": null,\n \"default\": null,\n \"allowedValues\": [\n\n ]\n },\n {\n \"name\": \"table\",\n \"label\": \"Table\",\n \"description\": null,\n \"type\": \"string\",\n \"required\": false,\n \"value\": null,\n \"default\": null,\n \"allowedValues\": [\n\n ]\n }\n ],\n \"arguments\": {\n \"id\": 2,\n \"state\": \"IL\",\n \"table\": \"test.test\"\n },\n \"isTemplate\": false,\n \"publishedAsTemplateId\": null,\n \"fromTemplateId\": 171,\n \"uiReportUrl\": null,\n \"uiReportId\": null,\n \"uiReportProvideAPIKey\": null,\n \"templateScriptName\": \"Script #2568\",\n \"templateNote\": null,\n \"remoteHostId\": 342,\n \"credentialId\": 947,\n \"codePreview\": \"select * from test.test where id = 2 and state = 'IL'\",\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n },\n \"notifications\": {\n \"urls\": [\n\n ],\n \"successEmailSubject\": null,\n \"successEmailBody\": null,\n \"successEmailAddresses\": [\n \"script_spec_user@civisanalytics.com\"\n ],\n \"successEmailFromName\": null,\n \"successEmailReplyTo\": null,\n \"failureEmailAddresses\": [\n \"script_spec_user@civisanalytics.com\"\n ],\n \"stallWarningMinutes\": null,\n \"successOn\": true,\n \"failureOn\": true\n },\n \"runningAs\": {\n \"id\": 2618,\n \"name\": \"User devuserfactory2127 2127\",\n \"username\": \"devuserfactory2127\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"timeZone\": \"America/Chicago\",\n \"lastRun\": null,\n \"myPermissionLevel\": \"manage\",\n \"hidden\": false,\n \"archived\": false,\n \"targetProjectId\": null,\n \"lastSuccessfulRun\": null,\n \"requiredResources\": null,\n \"partitionLabel\": null,\n \"runningAsId\": 2618\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"b1a73ce5dbb7d796ef9a5ae7ae057299\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"2d31ef98-c410-486f-b030-fc13048c32f7","X-Runtime":"0.154233","Content-Length":"1981"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/scripts/custom/2571/clone\" -d '' -X POST \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer eqd4UAgEWUqo9hQbNhfSjVELrUR3u4Lp2vG3cAVBfBw\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/search/":{"get":{"summary":"Perform a search","description":null,"deprecated":false,"parameters":[{"name":"query","in":"query","required":false,"description":"The search query.","type":"string"},{"name":"type","in":"query","required":false,"description":"The type for the search. It accepts a comma-separated list. Valid arguments are listed on the \"GET /search/types\" endpoint.","type":"string"},{"name":"offset","in":"query","required":false,"description":"The offset for the search results.","type":"integer"},{"name":"order","in":"query","required":false,"description":"The field on which to order the result set.","type":"string"},{"name":"owner","in":"query","required":false,"description":"The owner for the search.","type":"string"},{"name":"limit","in":"query","required":false,"description":"Defaults to 10. Maximum allowed is 1000.","type":"integer"},{"name":"archived","in":"query","required":false,"description":"If specified, return only results with the chosen archived status; either 'true', 'false', or 'all'. Defaults to 'false'.","type":"string"},{"name":"last_run_state","in":"query","required":false,"description":"The last run state of the job being searched for; either: 'queued', 'running', 'succeeded', 'failed', or 'cancelled'.","type":"string"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object631"}}}},"x-examples":[{"resource":"Search","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/search?query=import","description":"Lists matching objects","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/search?query=import","request_body":null,"request_headers":{"Content-Type":"application/json","Authorization":"Bearer I2Hadh1gSKV7aBO4DaizFxOrWnJA9GDl4dLFvd3Hy_k","Host":"api.civis.test","Cookie":""},"request_query_parameters":{"query":"import"},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"totalResults\": 3,\n \"aggregations\": {\n \"owner\": {\n \"mine\": 3,\n \"all\": 3\n },\n \"archived\": {\n \"true\": 0,\n \"false\": 3\n },\n \"type\": {\n \"python_script\": 1,\n \"sql_script\": 2\n }\n },\n \"results\": [\n {\n \"score\": 0.36407673,\n \"type\": \"python_script\",\n \"id\": \"3239\",\n \"name\": \"Run Import\",\n \"typeName\": \"Python Script\",\n \"updatedAt\": \"2023-07-18T18:46:13.000Z\",\n \"owner\": \"User devuserfactory3025 3023\",\n \"useCount\": null,\n \"lastRunId\": null,\n \"lastRunState\": null,\n \"lastRunStart\": null,\n \"lastRunFinish\": null,\n \"public\": false,\n \"lastRunException\": null,\n \"autoShare\": null\n },\n {\n \"score\": 0.211529091,\n \"type\": \"sql_script\",\n \"id\": \"3241\",\n \"name\": \"Important Successful Script\",\n \"typeName\": \"SQL Runner\",\n \"updatedAt\": \"2023-07-18T18:46:13.000Z\",\n \"owner\": \"User devuserfactory3025 3023\",\n \"useCount\": null,\n \"lastRunId\": 448,\n \"lastRunState\": \"succeeded\",\n \"lastRunStart\": null,\n \"lastRunFinish\": null,\n \"public\": false,\n \"lastRunException\": null,\n \"autoShare\": null\n },\n {\n \"score\": 0.234571346,\n \"type\": \"sql_script\",\n \"id\": \"3243\",\n \"name\": \"Important Failed Script\",\n \"typeName\": \"SQL Runner\",\n \"updatedAt\": \"2023-07-18T18:46:13.000Z\",\n \"owner\": \"User devuserfactory3025 3023\",\n \"useCount\": null,\n \"lastRunId\": 449,\n \"lastRunState\": \"failed\",\n \"lastRunStart\": null,\n \"lastRunFinish\": null,\n \"public\": false,\n \"lastRunException\": \"Job::UserError: Error!\",\n \"autoShare\": null\n }\n ]\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"2f1536d38190e35439f25f22d5f1239b\"","X-Request-Id":"2f530326-bbda-448c-ac83-17f80c9e0a02","X-Runtime":"0.015210","Content-Length":"1190"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/search?query=import\" -X GET \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer I2Hadh1gSKV7aBO4DaizFxOrWnJA9GDl4dLFvd3Hy_k\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/search/types":{"get":{"summary":"List available search types","description":null,"deprecated":false,"parameters":[],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object633"}}}},"x-examples":[{"resource":"Search","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/search/types","description":"Lists search types","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/search/types","request_body":null,"request_headers":{"Content-Type":"application/json","Authorization":"Bearer wBVV5B6Uv9RlAN65GaVqCWU76LnoY09heEhW_K_uE_M","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"type\": \"column\"\n },\n {\n \"type\": \"csv_import\"\n },\n {\n \"type\": \"database_import\"\n },\n {\n \"type\": \"database_export\"\n },\n {\n \"type\": \"gdoc_import\"\n },\n {\n \"type\": \"salesforce_import\"\n },\n {\n \"type\": \"custom_import\"\n },\n {\n \"type\": \"template_import\"\n },\n {\n \"type\": \"gdoc_export\"\n },\n {\n \"type\": \"template_export\"\n },\n {\n \"type\": \"custom_export\"\n },\n {\n \"type\": \"custom_enhancement\"\n },\n {\n \"type\": \"template_enhancement\"\n },\n {\n \"type\": \"table\"\n },\n {\n \"type\": \"job\"\n },\n {\n \"type\": \"remote_host\"\n },\n {\n \"type\": \"cass_ncoa\"\n },\n {\n \"type\": \"container_script\"\n },\n {\n \"type\": \"geocode\"\n },\n {\n \"type\": \"python_script\"\n },\n {\n \"type\": \"r_script\"\n },\n {\n \"type\": \"javascript_script\"\n },\n {\n \"type\": \"sql_script\"\n },\n {\n \"type\": \"project\"\n },\n {\n \"type\": \"notebook\"\n },\n {\n \"type\": \"workflow\"\n },\n {\n \"type\": \"template_script\"\n },\n {\n \"type\": \"template_report\"\n },\n {\n \"type\": \"service\"\n },\n {\n \"type\": \"report\"\n },\n {\n \"type\": \"tableau\"\n },\n {\n \"type\": \"service_report\"\n },\n {\n \"type\": \"salesforce_export\"\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"5029da1ed6f5e83acd4e4b351aaca78c\"","X-Request-Id":"e07ae174-d0f6-4da7-aa8d-55be0ace74a8","X-Runtime":"0.008567","Content-Length":"779"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/search/types\" -X GET \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer wBVV5B6Uv9RlAN65GaVqCWU76LnoY09heEhW_K_uE_M\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/search/queries":{"get":{"summary":"Search queries that are not hidden","description":null,"deprecated":false,"parameters":[{"name":"search_string","in":"query","required":false,"description":"Space delimited search terms for searching queries by their SQL. Supports wild card characters \"?\" for any single character, and \"*\" for zero or more characters.","type":"string"},{"name":"database_id","in":"query","required":false,"description":"The database ID.","type":"integer"},{"name":"credential_id","in":"query","required":false,"description":"The credential ID.","type":"integer"},{"name":"author_id","in":"query","required":false,"description":"The author of the query.","type":"integer"},{"name":"archived","in":"query","required":false,"description":"The archival status of the requested item(s). Defaults to false.","type":"boolean"},{"name":"state","in":"query","required":false,"description":"The state of the last run. One or more of queued, running, succeeded, failed, and cancelled.","type":"array","items":{"type":"string"}},{"name":"started_before","in":"query","required":false,"description":"An upper bound for the start date of the last run.","type":"string","format":"time"},{"name":"started_after","in":"query","required":false,"description":"A lower bound for the start date of the last run.","type":"string","format":"time"},{"name":"limit","in":"query","required":false,"description":"Number of results to return. Defaults to 10. Maximum allowed is 50.","type":"integer"},{"name":"page_num","in":"query","required":false,"description":"Page number of the results to return. Defaults to the first page, 1.","type":"integer"},{"name":"order","in":"query","required":false,"description":"The field on which to order the result set. Defaults to last_run_started_at. Must be one of: last_run_started_at.","type":"string"},{"name":"order_dir","in":"query","required":false,"description":"Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc.","type":"string"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object634"}}}},"x-examples":[{"resource":"Search","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/search/queries","description":"Lists queries","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/search/queries?search_string=count+foo+bar","request_body":null,"request_headers":{"Content-Type":"application/json","Authorization":"Bearer pghRRVt2bneG9h9ZvvdovahKqllDPq_Naxivkx-n91I","Host":"api.civis.test","Cookie":""},"request_query_parameters":{"search_string":"count foo bar"},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 3244,\n \"database\": 1004,\n \"credential\": 2226,\n \"sql\": \"SELECT * FROM table LIMIT 10;\",\n \"authorId\": 4477,\n \"archived\": false,\n \"createdAt\": \"2023-07-18T18:46:13.000Z\",\n \"updatedAt\": \"2023-07-18T18:46:13.000Z\",\n \"lastRun\": {\n \"id\": 450,\n \"state\": \"succeeded\",\n \"startedAt\": \"2023-07-18T18:46:13.000Z\",\n \"finishedAt\": null,\n \"error\": null\n }\n },\n {\n \"id\": 3245,\n \"database\": 1005,\n \"credential\": 2228,\n \"sql\": \"SELECT * FROM table LIMIT 10;\",\n \"authorId\": 4477,\n \"archived\": false,\n \"createdAt\": \"2023-07-18T18:46:13.000Z\",\n \"updatedAt\": \"2023-07-18T18:46:13.000Z\",\n \"lastRun\": {\n \"id\": 451,\n \"state\": \"cancelled\",\n \"startedAt\": \"2023-07-18T18:46:08.000Z\",\n \"finishedAt\": null,\n \"error\": null\n }\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","X-Pagination-Current-Page":1,"Access-Control-Expose-Headers":"X-Pagination-Current-Page, X-Pagination-Per-Page, X-Pagination-Total-Pages, X-Pagination-Total-Entries","X-Pagination-Per-Page":"10","X-Pagination-Total-Pages":"1","X-Pagination-Total-Entries":"2","Content-Type":"application/json; charset=utf-8","ETag":"W/\"e8672285e2114b8c8d404d2c5eb2b4ef\"","X-Request-Id":"f9ced4a6-f859-4e3a-9502-3b58478ca1e5","X-Runtime":"0.011693","Content-Length":"613"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/search/queries?search_string=count+foo+bar\" -X GET \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer pghRRVt2bneG9h9ZvvdovahKqllDPq_Naxivkx-n91I\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/services/":{"get":{"summary":"List Services","description":null,"deprecated":false,"parameters":[{"name":"hidden","in":"query","required":false,"description":"If specified to be true, returns hidden items. Defaults to false, returning non-hidden items.","type":"boolean"},{"name":"archived","in":"query","required":false,"description":"The archival status of the requested item(s).","type":"string"},{"name":"author","in":"query","required":false,"description":"If specified, return items from any of these authors. It accepts a comma-separated list of user IDs.","type":"string"},{"name":"status","in":"query","required":false,"description":"If specified, returns Services with one of these statuses. It accepts a comma-separated list, possible values are 'running', 'idle'.","type":"string"},{"name":"limit","in":"query","required":false,"description":"Number of results to return. Defaults to 20. Maximum allowed is 50.","type":"integer"},{"name":"page_num","in":"query","required":false,"description":"Page number of the results to return. Defaults to the first page, 1.","type":"integer"},{"name":"order","in":"query","required":false,"description":"The field on which to order the result set. Defaults to updated_at. Must be one of: updated_at, name, created_at.","type":"string"},{"name":"order_dir","in":"query","required":false,"description":"Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc.","type":"string"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object636"}}}},"x-examples":[{"resource":"Services","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/services","description":"List all services","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/services","request_body":null,"request_headers":{"Content-Type":"application/json","Authorization":"Bearer 6cbNig9hL-3Qr3ygIAJMIcc-h5JE9HugZ_LzOaVeXlI","Accept":"application/vnd.civis-platform.v1","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 16,\n \"name\": \"Service #16\",\n \"description\": null,\n \"user\": {\n \"id\": 4480,\n \"name\": \"User devuserfactory3034 3032\",\n \"username\": \"devuserfactory3034\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"type\": \"App\",\n \"createdAt\": \"2023-07-18T18:46:14.000Z\",\n \"updatedAt\": \"2023-07-18T18:46:14.000Z\",\n \"gitRepoUrl\": \"https://github.com/acme_co/my_shiny_code.git\",\n \"gitRepoRef\": null,\n \"gitPathDir\": null,\n \"currentDeployment\": null,\n \"archived\": false\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","X-Pagination-Per-Page":"20","Access-Control-Expose-Headers":"X-Pagination-Per-Page, X-Pagination-Current-Page, X-Pagination-Total-Pages, X-Pagination-Total-Entries","X-Pagination-Current-Page":"1","X-Pagination-Total-Pages":"1","X-Pagination-Total-Entries":"1","Content-Type":"application/json; charset=utf-8","ETag":"W/\"d286d08b2b52dd5bc86887245a58d811\"","X-Request-Id":"104cbd1a-7516-4182-b3b4-69ac7783ca2d","X-Runtime":"0.023683","Content-Length":"399"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/services\" -X GET \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer 6cbNig9hL-3Qr3ygIAJMIcc-h5JE9HugZ_LzOaVeXlI\" \\\n\t-H \"Accept: application/vnd.civis-platform.v1\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"post":{"summary":"Create a Service","description":null,"deprecated":false,"parameters":[{"name":"Object638","in":"body","schema":{"$ref":"#/definitions/Object638"},"required":false}],"responses":{"201":{"description":"success","schema":{"$ref":"#/definitions/Object642"}}},"x-examples":[{"resource":"Services","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/services","description":"Create a service","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/services","request_body":null,"request_headers":{"Content-Type":"application/json","Authorization":"Bearer MAw6puYPXeaL8c2bjK_kuyx2A0T_8yhPqjz7gpeKiUs","Accept":"application/vnd.civis-platform.v1","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":201,"response_status_text":"Created","response_body":"{\n \"id\": 20,\n \"name\": \"Service #20\",\n \"description\": null,\n \"user\": {\n \"id\": 4484,\n \"name\": \"User devuserfactory3038 3036\",\n \"username\": \"devuserfactory3038\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"type\": \"App\",\n \"dockerImageName\": \"civisanalytics/civis-services-shiny\",\n \"dockerImageTag\": \"mock_latest_tag\",\n \"schedule\": {\n \"runtimePlan\": \"on_demand\",\n \"recurrences\": [\n\n ]\n },\n \"timeZone\": \"America/Chicago\",\n \"replicas\": 1,\n \"maxReplicas\": null,\n \"instanceType\": null,\n \"memory\": 3000,\n \"cpu\": 800,\n \"createdAt\": \"2023-07-18T18:46:14.000Z\",\n \"updatedAt\": \"2023-07-18T18:46:14.000Z\",\n \"credentials\": [\n\n ],\n \"permissionSetId\": null,\n \"gitRepoUrl\": null,\n \"gitRepoRef\": null,\n \"gitPathDir\": null,\n \"reportId\": null,\n \"currentDeployment\": null,\n \"currentUrl\": null,\n \"environmentVariables\": {\n },\n \"notifications\": {\n \"failureEmailAddresses\": [\n \"devuserfactory30382900user@localhost.test\"\n ],\n \"failureOn\": true\n },\n \"partitionLabel\": null,\n \"myPermissionLevel\": \"manage\",\n \"archived\": false,\n \"hidden\": false\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"f55b743cda8c58d2827b2b7ddd79bcf7\"","X-Request-Id":"3029b9d6-8ef1-4299-bc10-09c8e8930734","X-Runtime":"0.088780","Content-Length":"878"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/services\" -d '' -X POST \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer MAw6puYPXeaL8c2bjK_kuyx2A0T_8yhPqjz7gpeKiUs\" \\\n\t-H \"Accept: application/vnd.civis-platform.v1\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Services","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/services","description":"Create a service with non-default values","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/services","request_body":"{\n \"name\": \"Custom Name\",\n \"memory\": 3000,\n \"cpu\": 600,\n \"dockerImageName\": \"my_image\",\n \"dockerImageTag\": \"my_tag\",\n \"gitRepoUrl\": \"https://github.com/my_repository.git\",\n \"gitRepoRef\": \"my_ref\",\n \"gitPathDir\": \"path/to/app\",\n \"type\": \"App\",\n \"credentials\": [\n 2229\n ]\n}","request_headers":{"Content-Type":"application/json","Authorization":"Bearer JTG4zPEorVpdKk4XSKUJVMha9m_79TY7ztT_Rac_l3E","Accept":"application/vnd.civis-platform.v1","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":201,"response_status_text":"Created","response_body":"{\n \"id\": 22,\n \"name\": \"Custom Name\",\n \"description\": null,\n \"user\": {\n \"id\": 4485,\n \"name\": \"User devuserfactory3039 3037\",\n \"username\": \"devuserfactory3039\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"type\": \"App\",\n \"dockerImageName\": \"my_image\",\n \"dockerImageTag\": \"my_tag\",\n \"schedule\": {\n \"runtimePlan\": \"on_demand\",\n \"recurrences\": [\n\n ]\n },\n \"timeZone\": \"America/Chicago\",\n \"replicas\": 1,\n \"maxReplicas\": null,\n \"instanceType\": null,\n \"memory\": 3000,\n \"cpu\": 600,\n \"createdAt\": \"2023-07-18T18:46:14.000Z\",\n \"updatedAt\": \"2023-07-18T18:46:14.000Z\",\n \"credentials\": [\n {\n \"id\": 2229,\n \"name\": \"api-key-28\"\n }\n ],\n \"permissionSetId\": null,\n \"gitRepoUrl\": \"https://github.com/my_repository.git\",\n \"gitRepoRef\": \"my_ref\",\n \"gitPathDir\": \"path/to/app\",\n \"reportId\": null,\n \"currentDeployment\": null,\n \"currentUrl\": null,\n \"environmentVariables\": {\n },\n \"notifications\": {\n \"failureEmailAddresses\": [\n \"devuserfactory30392901user@localhost.test\"\n ],\n \"failureOn\": true\n },\n \"partitionLabel\": null,\n \"myPermissionLevel\": \"manage\",\n \"archived\": false,\n \"hidden\": false\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"0986afc20bd9463f45b9430545e81981\"","X-Request-Id":"efe8376b-77fb-48e9-8043-c686f698f474","X-Runtime":"0.093590","Content-Length":"920"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/services\" -d '{\"name\":\"Custom Name\",\"memory\":3000,\"cpu\":600,\"dockerImageName\":\"my_image\",\"dockerImageTag\":\"my_tag\",\"gitRepoUrl\":\"https://github.com/my_repository.git\",\"gitRepoRef\":\"my_ref\",\"gitPathDir\":\"path/to/app\",\"type\":\"App\",\"credentials\":[2229]}' -X POST \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer JTG4zPEorVpdKk4XSKUJVMha9m_79TY7ztT_Rac_l3E\" \\\n\t-H \"Accept: application/vnd.civis-platform.v1\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/services/{id}":{"get":{"summary":"Get a Service","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object642"}}},"x-examples":[{"resource":"Services","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/services/:id","description":"View a service's details","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/services/17","request_body":null,"request_headers":{"Content-Type":"application/json","Authorization":"Bearer 3jvbLGCcuNkQ20Dx6ViDRI2_svDuO4-Z-d9RhpXxVCo","Accept":"application/vnd.civis-platform.v1","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 17,\n \"name\": \"Service #17\",\n \"description\": null,\n \"user\": {\n \"id\": 4481,\n \"name\": \"User devuserfactory3035 3033\",\n \"username\": \"devuserfactory3035\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"type\": \"App\",\n \"dockerImageName\": \"civisanalytics/civis-services-shiny\",\n \"dockerImageTag\": \"mock_latest_tag\",\n \"schedule\": {\n \"runtimePlan\": \"on_demand\",\n \"recurrences\": [\n\n ]\n },\n \"timeZone\": \"America/Chicago\",\n \"replicas\": 1,\n \"maxReplicas\": null,\n \"instanceType\": null,\n \"memory\": 3000,\n \"cpu\": 800,\n \"createdAt\": \"2023-07-18T18:46:14.000Z\",\n \"updatedAt\": \"2023-07-18T18:46:14.000Z\",\n \"credentials\": [\n\n ],\n \"permissionSetId\": null,\n \"gitRepoUrl\": \"https://github.com/acme_co/my_shiny_code.git\",\n \"gitRepoRef\": null,\n \"gitPathDir\": null,\n \"reportId\": null,\n \"currentDeployment\": null,\n \"currentUrl\": null,\n \"environmentVariables\": {\n },\n \"notifications\": {\n \"failureEmailAddresses\": [\n \"devuserfactory30352897user@localhost.test\"\n ],\n \"failureOn\": true\n },\n \"partitionLabel\": null,\n \"myPermissionLevel\": \"manage\",\n \"archived\": false,\n \"hidden\": false\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"6a172f0fc37cf7e3567bfc4cfd548493\"","X-Request-Id":"457815bb-d26a-4e19-b896-d1e321a0eb7c","X-Runtime":"0.029845","Content-Length":"920"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/services/17\" -X GET \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer 3jvbLGCcuNkQ20Dx6ViDRI2_svDuO4-Z-d9RhpXxVCo\" \\\n\t-H \"Accept: application/vnd.civis-platform.v1\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Services","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/services/:id","description":"View details of a service including an active deployment","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/services/18","request_body":null,"request_headers":{"Content-Type":"application/json","Authorization":"Bearer c22V3jdPMnqIp6BXl8Q5qZ7yKQEgNY7IAfefgue1mrk","Accept":"application/vnd.civis-platform.v1","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 18,\n \"name\": \"Service #18\",\n \"description\": null,\n \"user\": {\n \"id\": 4482,\n \"name\": \"User devuserfactory3036 3034\",\n \"username\": \"devuserfactory3036\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"type\": \"App\",\n \"dockerImageName\": \"civisanalytics/civis-services-shiny\",\n \"dockerImageTag\": \"mock_latest_tag\",\n \"schedule\": {\n \"runtimePlan\": \"on_demand\",\n \"recurrences\": [\n\n ]\n },\n \"timeZone\": \"America/Chicago\",\n \"replicas\": 1,\n \"maxReplicas\": null,\n \"instanceType\": null,\n \"memory\": 3000,\n \"cpu\": 800,\n \"createdAt\": \"2023-07-18T18:46:14.000Z\",\n \"updatedAt\": \"2023-07-18T18:46:14.000Z\",\n \"credentials\": [\n\n ],\n \"permissionSetId\": null,\n \"gitRepoUrl\": \"https://github.com/acme_co/my_shiny_code.git\",\n \"gitRepoRef\": null,\n \"gitPathDir\": null,\n \"reportId\": null,\n \"currentDeployment\": {\n \"deploymentId\": 25,\n \"userId\": 4483,\n \"host\": \"deployment.foo.com\",\n \"name\": \"deployment\",\n \"dockerImageName\": \"civis-custom-image\",\n \"dockerImageTag\": \"1.1\",\n \"displayUrl\": \"https://deployment.foo.com/civis-platform-auth?token=bm9uY2UyMTNfWFhYWFhYXzI0X2J5dGVzS4wxkhRxPPl7gzQgJbX8ecYNx7-wIV72DLax9hUdZVwX_M0mfH6_BM9AgRtWBjzoyqAz3AxJRXM9EULOjaW_oix8yG9FlTjtJsaFgQXq4jp-V7aI3vq5CA4Som8yG2YMTecPPmLTN3JLZF6v15PtWcjSs7_K3SoTDtBzZXs7p3GbEzL9qgXAqE1b0AyoivnZp8kjmLG3CeYCKVNZHZoKtyotfj-gzJumlBS9K0to7Q_DkwujUU67p52I_EINU4owDqeO6Ca6nMrc9ZrvMMGpMR9ndmmIZrN0IUArciJSgUYpkn0_7_eXfj0P7ZrkeTsiVU_jr2nnttAQHpI_1LYjnhdaTH5xGW7300JYcGy34BuO3Wf-jOH33v0Ly4Sq2uWfu1VpvXm9vvpgdo48CnhUI4pxr_-05NycuDA=\",\n \"instanceType\": \"m4.xlarge\",\n \"memory\": 2008,\n \"cpu\": 500,\n \"state\": \"running\",\n \"stateMessage\": null,\n \"maxMemoryUsage\": null,\n \"maxCpuUsage\": null,\n \"createdAt\": \"2023-07-18T18:46:14.000Z\",\n \"updatedAt\": \"2023-07-18T18:46:14.000Z\",\n \"serviceId\": 18\n },\n \"currentUrl\": \"https://services--18--29e9a9449b2c--default.services.civis.test\",\n \"environmentVariables\": {\n },\n \"notifications\": {\n \"failureEmailAddresses\": [\n \"devuserfactory30362898user@localhost.test\"\n ],\n \"failureOn\": true\n },\n \"partitionLabel\": null,\n \"myPermissionLevel\": \"manage\",\n \"archived\": false,\n \"hidden\": false\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"30be119acef147bcf915c19905bd14d4\"","X-Request-Id":"3517ecad-d790-4db9-b71f-6c48401be2fa","X-Runtime":"0.032356","Content-Length":"1864"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/services/18\" -X GET \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer c22V3jdPMnqIp6BXl8Q5qZ7yKQEgNY7IAfefgue1mrk\" \\\n\t-H \"Accept: application/vnd.civis-platform.v1\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"put":{"summary":"Replace all attributes of this Service","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID for this Service.","type":"integer"},{"name":"Object647","in":"body","schema":{"$ref":"#/definitions/Object647"},"required":false}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object642"}}},"x-examples":null,"x-deprecation-warning":null},"patch":{"summary":"Update some attributes of this Service","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID for this Service.","type":"integer"},{"name":"Object647","in":"body","schema":{"$ref":"#/definitions/Object647"},"required":false}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object642"}}},"x-examples":null,"x-deprecation-warning":null},"delete":{"summary":"Archive a Service (deprecated, use archiving endpoints instead)","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/services/{id}/shares":{"get":{"summary":"List users and groups permissioned on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object9"}}}},"x-examples":null,"x-deprecation-warning":null}},"/services/{id}/shares/users":{"put":{"summary":"Set the permissions users have on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"Object648","in":"body","schema":{"$ref":"#/definitions/Object648"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object9"}}},"x-examples":null,"x-deprecation-warning":null}},"/services/{id}/shares/users/{user_id}":{"delete":{"summary":"Revoke the permissions a user has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"user_id","in":"path","required":true,"description":"The ID of the user.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/services/{id}/shares/groups":{"put":{"summary":"Set the permissions groups has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"Object649","in":"body","schema":{"$ref":"#/definitions/Object649"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object9"}}},"x-examples":null,"x-deprecation-warning":null}},"/services/{id}/shares/groups/{group_id}":{"delete":{"summary":"Revoke the permissions a group has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"group_id","in":"path","required":true,"description":"The ID of the group.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/services/{id}/dependencies":{"get":{"summary":"List dependent objects for this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"user_id","in":"query","required":false,"description":"ID of target user","type":"integer"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object15"}}}},"x-examples":null,"x-deprecation-warning":null}},"/services/{id}/transfer":{"put":{"summary":"Transfer ownership of this object to another user","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"Object650","in":"body","schema":{"$ref":"#/definitions/Object650"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object17"}}},"x-examples":null,"x-deprecation-warning":null}},"/services/{id}/archive":{"put":{"summary":"Update the archive status of this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the object.","type":"integer"},{"name":"Object651","in":"body","schema":{"$ref":"#/definitions/Object651"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object642"}}},"x-examples":null,"x-deprecation-warning":null}},"/services/{id}/projects":{"get":{"summary":"List the projects a Service belongs to","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Service.","type":"integer"},{"name":"hidden","in":"query","required":false,"description":"If specified to be true, returns hidden items. Defaults to false, returning non-hidden items.","type":"boolean"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object84"}}}},"x-examples":null,"x-deprecation-warning":null}},"/services/{id}/projects/{project_id}":{"put":{"summary":"Add a Service to a project","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Service.","type":"integer"},{"name":"project_id","in":"path","required":true,"description":"The ID of the project.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null},"delete":{"summary":"Remove a Service from a project","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Service.","type":"integer"},{"name":"project_id","in":"path","required":true,"description":"The ID of the project.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/services/{service_id}/deployments":{"get":{"summary":"List deployments for a Service","description":null,"deprecated":false,"parameters":[{"name":"service_id","in":"path","required":true,"description":"The ID of the owning Service","type":"integer"},{"name":"deployment_id","in":"query","required":false,"description":"The ID for this deployment","type":"integer"},{"name":"limit","in":"query","required":false,"description":"Number of results to return. Defaults to 20. Maximum allowed is 50.","type":"integer"},{"name":"page_num","in":"query","required":false,"description":"Page number of the results to return. Defaults to the first page, 1.","type":"integer"},{"name":"order","in":"query","required":false,"description":"The field on which to order the result set. Defaults to created_at. Must be one of: created_at.","type":"string"},{"name":"order_dir","in":"query","required":false,"description":"Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc.","type":"string"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object637"}}}},"x-examples":[{"resource":"Services","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/services/:service_id/deployments","description":"List all Deployments for a service","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/services/25/deployments","request_body":null,"request_headers":{"Content-Type":"application/json","Authorization":"Bearer SDmdnhF1nR8DGgY9vMrTEeAPZQ7bN5kwIwFiljS6Tmc","Accept":"application/vnd.civis-platform.v1","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"deploymentId\": 26,\n \"userId\": 4487,\n \"host\": \"deployment.foo.com\",\n \"name\": \"deployment\",\n \"dockerImageName\": \"civis-custom-image\",\n \"dockerImageTag\": \"1.1\",\n \"instanceType\": \"m4.xlarge\",\n \"memory\": 2008,\n \"cpu\": 500,\n \"state\": null,\n \"stateMessage\": null,\n \"maxMemoryUsage\": null,\n \"maxCpuUsage\": null,\n \"createdAt\": \"2023-07-18T18:46:15.000Z\",\n \"updatedAt\": \"2023-07-18T18:46:15.000Z\",\n \"serviceId\": 25\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","X-Pagination-Per-Page":"20","Access-Control-Expose-Headers":"X-Pagination-Per-Page, X-Pagination-Current-Page, X-Pagination-Total-Pages, X-Pagination-Total-Entries","X-Pagination-Current-Page":"1","X-Pagination-Total-Pages":"1","X-Pagination-Total-Entries":"1","Content-Type":"application/json; charset=utf-8","ETag":"W/\"480dc7984029d65de84c848b90c4c67d\"","X-Request-Id":"3af97aa0-bce8-4012-985d-1b9a2326dbf3","X-Runtime":"0.016759","Content-Length":"363"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/services/25/deployments\" -X GET \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer SDmdnhF1nR8DGgY9vMrTEeAPZQ7bN5kwIwFiljS6Tmc\" \\\n\t-H \"Accept: application/vnd.civis-platform.v1\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"post":{"summary":"Deploy a Service","description":null,"deprecated":false,"parameters":[{"name":"service_id","in":"path","required":true,"description":"The ID of the owning Service","type":"integer"},{"name":"Object652","in":"body","schema":{"$ref":"#/definitions/Object652"},"required":false}],"responses":{"201":{"description":"success","schema":{"$ref":"#/definitions/Object645"}}},"x-examples":[{"resource":"Services","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/services/:service_id/deployments","description":"Create a deployment for a service","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/services/28/deployments","request_body":null,"request_headers":{"Content-Type":"application/json","Authorization":"Bearer iAb7p9r8ewWD2l6pIpMreiOXRpDHU6WGqOpAzDkJw3I","Accept":"application/vnd.civis-platform.v1","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":201,"response_status_text":"Created","response_body":"{\n \"deploymentId\": 29,\n \"userId\": 4491,\n \"host\": \"deployment.foo.com\",\n \"name\": \"deployment\",\n \"dockerImageName\": \"civis-custom-image\",\n \"dockerImageTag\": \"1.1\",\n \"displayUrl\": \"https://deployment.foo.com/civis-platform-auth?token=bm9uY2UyMTNfWFhYWFhYXzI0X2J5dGVzOpnKM-p-OejO9Es9CVSjqtkFyum_3w9QmbwsABVVWAwKWb1kSqOa1ZWppf4iuhvpjx40bDQuyWEjKGCHDOiDtwZ1qgZs7vavMM4s-QhdPOZHMir1Grf7RAZ8M2WedUns_Xxa8ixQ0NiI3SHTOy7Laa01SmsdRWE7xhfVU8OLSvEa13HN_zn0iGW5Y2onSIU_vPSSZuj6jDfhQmjJL60AyIz0OOcwvubdyvyyx4MOqIlR-KrSuacfmQHk7Q8kmoeLIZ2uUS3yAt5I__yHH90Ae33sP4tRqST1dMveIhjzPpONHqTFGFgPVGBUHhqT0N3n62w7uIMVSQ4da7sEJFkVvj-TkXqnOTDXz6TafI-tK4xNQUELBRujhRO74VdugnGp5ZcqnoWo7ZnWsyae4KHixA68vZ4mt_aqMjI=\",\n \"instanceType\": \"m4.xlarge\",\n \"memory\": 2008,\n \"cpu\": 500,\n \"state\": null,\n \"stateMessage\": null,\n \"maxMemoryUsage\": null,\n \"maxCpuUsage\": null,\n \"createdAt\": \"2023-07-18T18:46:15.000Z\",\n \"updatedAt\": \"2023-07-18T18:46:15.000Z\",\n \"serviceId\": 28\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"9c37a3098370cab9d74f2742281de8ed\"","X-Request-Id":"0265ac34-f1c7-42b6-8aaa-fcb180782003","X-Runtime":"0.023747","Content-Length":"882"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/services/28/deployments\" -d '' -X POST \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer iAb7p9r8ewWD2l6pIpMreiOXRpDHU6WGqOpAzDkJw3I\" \\\n\t-H \"Accept: application/vnd.civis-platform.v1\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/services/{service_id}/deployments/{deployment_id}":{"get":{"summary":"Get details about a Service deployment","description":null,"deprecated":false,"parameters":[{"name":"service_id","in":"path","required":true,"description":"The ID of the owning Service","type":"integer"},{"name":"deployment_id","in":"path","required":true,"description":"The ID for this deployment","type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object645"}}},"x-examples":[{"resource":"Services","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/services/:service_id/deployments/:deployment_id","description":"View a service deployment's details","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/services/26/deployments/27","request_body":null,"request_headers":{"Content-Type":"application/json","Authorization":"Bearer Vo0p7XTBg7jd0b2avnSXsX63wTY6FfwAzZVjjHR54sE","Accept":"application/vnd.civis-platform.v1","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"deploymentId\": 27,\n \"userId\": 4489,\n \"host\": \"deployment.foo.com\",\n \"name\": \"deployment\",\n \"dockerImageName\": \"civis-custom-image\",\n \"dockerImageTag\": \"1.1\",\n \"displayUrl\": \"https://deployment.foo.com/civis-platform-auth?token=bm9uY2UyMTNfWFhYWFhYXzI0X2J5dGVzkKoxeWi-BQAa_BXSqo6kTu3Nsj0ip_wO2mBesFI_vJRTp10Y8SVh1WyiGPjhnW4Vfnkq423B35l_j2H2-TELUc--rOOUMM37D_Gutvogq2iz1pFA1_GhJdhSLP3V8Nx2ws_Ma2a5fZRyVJAcmOk81RK8PAV2B7An2X-hHg_kwovtOkTSsoDIaUdsLoiRrXw-K8CV9umd2vvvDZ37cvfqtkJbGCTR3F5pM68nuKpGPZRVZYcecs29ZWKGGpgA_P2N40njXcD0Luc31uN8edquhinggjw5iQ4rmHW2RSGla5G0dUDrjKkDDlLLVDOlUONMNIFVFDp5pXJUVlMGNfPUEgsWEiNUcZ06bsYy5_DwmfHL0AtPYhEten9y2PyFaVkIVxIenXsIR_K0XmvouDvmAqsM4pw6NEuhsNw=\",\n \"instanceType\": \"m4.xlarge\",\n \"memory\": 2008,\n \"cpu\": 500,\n \"state\": null,\n \"stateMessage\": null,\n \"maxMemoryUsage\": null,\n \"maxCpuUsage\": null,\n \"createdAt\": \"2023-07-18T18:46:15.000Z\",\n \"updatedAt\": \"2023-07-18T18:46:15.000Z\",\n \"serviceId\": 26\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"f1a503742f3cf25ea779ae60ab49c948\"","X-Request-Id":"54954672-5cc8-4cfd-9685-5f4686c39575","X-Runtime":"0.021562","Content-Length":"882"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/services/26/deployments/27\" -X GET \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer Vo0p7XTBg7jd0b2avnSXsX63wTY6FfwAzZVjjHR54sE\" \\\n\t-H \"Accept: application/vnd.civis-platform.v1\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"delete":{"summary":"Delete a Service deployment","description":null,"deprecated":false,"parameters":[{"name":"service_id","in":"path","required":true,"description":"The ID of the owning Service","type":"integer"},{"name":"deployment_id","in":"path","required":true,"description":"The ID for this deployment","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":[{"resource":"Services","resource_explanation":null,"http_method":"DELETE","route":"http://api.civis.test/services/:service_id/deployments/:deployment_id","description":"Delete a deployment for a service","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"DELETE","request_path":"http://api.civis.test/services/29/deployments/30","request_body":null,"request_headers":{"Content-Type":"application/json","Authorization":"Bearer 2MI8B3I9k-qPWwburffWJ6yHAMByEALEmgT1cJ1mwMg","Accept":"application/vnd.civis-platform.v1","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":204,"response_status_text":"No Content","response_body":null,"response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","X-Request-Id":"d299c580-9094-479a-81f2-8c4e943293ae","X-Runtime":"0.017120"},"response_content_type":null,"curl":"curl \"api.civis.testhttp://api.civis.test/services/29/deployments/30\" -d '' -X DELETE \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer 2MI8B3I9k-qPWwburffWJ6yHAMByEALEmgT1cJ1mwMg\" \\\n\t-H \"Accept: application/vnd.civis-platform.v1\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/services/{service_id}/redeploy":{"post":{"summary":"Redeploy a Service","description":null,"deprecated":false,"parameters":[{"name":"service_id","in":"path","required":true,"description":"The ID of the owning Service","type":"integer"},{"name":"Object652","in":"body","schema":{"$ref":"#/definitions/Object652"},"required":false}],"responses":{"201":{"description":"success","schema":{"$ref":"#/definitions/Object645"}}},"x-examples":null,"x-deprecation-warning":null}},"/services/{id}/deployments/{deployment_id}/logs":{"get":{"summary":"Get the logs for a Service deployment","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the owning Service.","type":"integer"},{"name":"deployment_id","in":"path","required":true,"description":"The ID for this deployment.","type":"integer"},{"name":"start_at","in":"query","required":false,"description":"Log entries with a lower timestamp will be omitted.","type":"string","format":"date-time"},{"name":"end_at","in":"query","required":false,"description":"Log entries with a higher timestamp will be omitted.","type":"string","format":"date-time"},{"name":"limit","in":"query","required":false,"description":"The maximum number of log messages to return. Default of 10000.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object57"}}}},"x-examples":null,"x-deprecation-warning":null}},"/services/{id}/clone":{"post":{"summary":"Clone this Service","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"type":"integer"}],"responses":{"201":{"description":"success","schema":{"$ref":"#/definitions/Object642"}}},"x-examples":[{"resource":"Services","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/services/:id/clone","description":"Make a clone of an existing service","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/services/23/clone","request_body":null,"request_headers":{"Content-Type":"application/json","Authorization":"Bearer lWh8Bb2-zQnlBKpZyY9nrH2ogc7SCaG3JFS2iIvA3SY","Accept":"application/vnd.civis-platform.v1","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":201,"response_status_text":"Created","response_body":"{\n \"id\": 24,\n \"name\": \"Clone of Service #23\",\n \"description\": null,\n \"user\": {\n \"id\": 4486,\n \"name\": \"User devuserfactory3040 3038\",\n \"username\": \"devuserfactory3040\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"type\": \"App\",\n \"dockerImageName\": \"civisanalytics/civis-services-shiny\",\n \"dockerImageTag\": \"mock_latest_tag\",\n \"schedule\": {\n \"runtimePlan\": \"on_demand\",\n \"recurrences\": [\n\n ]\n },\n \"timeZone\": \"America/Chicago\",\n \"replicas\": 1,\n \"maxReplicas\": null,\n \"instanceType\": null,\n \"memory\": 3000,\n \"cpu\": 800,\n \"createdAt\": \"2023-07-18T18:46:15.000Z\",\n \"updatedAt\": \"2023-07-18T18:46:15.000Z\",\n \"credentials\": [\n\n ],\n \"permissionSetId\": null,\n \"gitRepoUrl\": \"https://github.com/acme_co/my_shiny_code.git\",\n \"gitRepoRef\": null,\n \"gitPathDir\": null,\n \"reportId\": null,\n \"currentDeployment\": null,\n \"currentUrl\": null,\n \"environmentVariables\": {\n },\n \"notifications\": {\n \"failureEmailAddresses\": [\n \"devuserfactory30402902user@localhost.test\"\n ],\n \"failureOn\": true\n },\n \"partitionLabel\": null,\n \"myPermissionLevel\": \"manage\",\n \"archived\": false,\n \"hidden\": false\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"60af4428f2ac4969f5795224ccf4f5e2\"","X-Request-Id":"da7d2088-8178-4003-be3f-47a0d1cfe7c2","X-Runtime":"0.049360","Content-Length":"929"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/services/23/clone\" -d '' -X POST \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer lWh8Bb2-zQnlBKpZyY9nrH2ogc7SCaG3JFS2iIvA3SY\" \\\n\t-H \"Accept: application/vnd.civis-platform.v1\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/services/{id}/tokens":{"post":{"summary":"Create a new long-lived service token","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the service.","type":"integer"},{"name":"Object655","in":"body","schema":{"$ref":"#/definitions/Object655"},"required":true}],"responses":{"201":{"description":"success","schema":{"$ref":"#/definitions/Object656"}}},"x-examples":[{"resource":"Services","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/services/:service_id/tokens","description":"Create a token for a service","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/services/30/tokens","request_body":"{\n \"name\": \"new_token\"\n}","request_headers":{"Content-Type":"application/json","Authorization":"Bearer DGLuA7Z7y5UWqJ1cpBf3jwG_SacfEqETdmaBJcWaUAY","Accept":"application/vnd.civis-platform.v1","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":201,"response_status_text":"Created","response_body":"{\n \"id\": 1,\n \"name\": \"new_token\",\n \"user\": {\n \"id\": 4495,\n \"name\": \"User devuserfactory3049 3047\",\n \"username\": \"devuserfactory3049\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"machineToken\": false,\n \"expiresAt\": \"2023-07-19T18:46:15.000Z\",\n \"createdAt\": \"2023-07-18T18:46:15.000Z\",\n \"token\": \"bm9uY2UyMTNfWFhYWFhYXzI0X2J5dGVzf8IPlrsdLWkoEqLsa7iVE_Eb9izqn9vcproMb99azqC_IdU27Dt5A1hxVo3mPDI-Bo5p4fNvZhUuyF8cMhkgpPiBZJnRWtmbfHGonlxhBRFQ0GSvPT00wX0vPtUMcFHAu9EpsARF8jIGuyfKmQO8Z8ykvkuTnNulyqX_7_F_GGHYA2q3twu2myaF4Q2Evnup1iFsrY0e8GlESuhz-bKY1Ub60tFhV9egiFahYIpZL41SzIBLOgwFWxgRbx1zlgneAudHqz0Jh6PTgSLK3z1FcGuzXmTVt3r66jP8yEuT-YM0ofez5z-EeZMdxRyzOk7cz8oBh-HreF17g0yWpmC_X9sDrCe6bQnVlssk0rdOGq3GAZogLv0oIfXf1gK1Ec3jQ_zUplrrgVPxZ88yGllk4m45FOgR1qoktcQ=\"\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"14c96f5cba4b2f2d6fae7e7d11113a01\"","X-Request-Id":"4c1440ea-8a29-4e3e-b591-a1d3021933d5","X-Runtime":"0.038957","Content-Length":"708"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/services/30/tokens\" -d '{\"name\":\"new_token\"}' -X POST \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer DGLuA7Z7y5UWqJ1cpBf3jwG_SacfEqETdmaBJcWaUAY\" \\\n\t-H \"Accept: application/vnd.civis-platform.v1\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"get":{"summary":"List tokens","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the service.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object657"}}}},"x-examples":[{"resource":"Services","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/services/:service_id/tokens","description":"List tokens for a service","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/services/31/tokens","request_body":null,"request_headers":{"Content-Type":"application/json","Authorization":"Bearer jkc0h0IMJwbLy9qsE2DWD3S4OIaIcdmQ8z8fp7Haer0","Accept":"application/vnd.civis-platform.v1","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 2,\n \"name\": \"My Happy Token\",\n \"user\": {\n \"id\": 4499,\n \"name\": \"User devuserfactory3053 3051\",\n \"username\": \"devuserfactory3053\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"machineToken\": true,\n \"expiresAt\": \"2023-07-19T18:46:16.000Z\",\n \"createdAt\": \"2023-07-18T18:46:16.000Z\"\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"8b683d6fec5d380d6dface217e618005\"","X-Request-Id":"28707410-d977-49a4-a5bb-25a7689c5aa0","X-Runtime":"0.018048","Content-Length":"251"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/services/31/tokens\" -X GET \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer jkc0h0IMJwbLy9qsE2DWD3S4OIaIcdmQ8z8fp7Haer0\" \\\n\t-H \"Accept: application/vnd.civis-platform.v1\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/services/{id}/tokens/{token_id}":{"delete":{"summary":"Revoke a token by id","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the service.","type":"integer"},{"name":"token_id","in":"path","required":true,"description":"The ID of the token.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":[{"resource":"Services","resource_explanation":null,"http_method":"DELETE","route":"http://api.civis.test/services/:service_id/tokens/:token_id","description":"Revoke a service token","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"DELETE","request_path":"http://api.civis.test/services/32/tokens/3","request_body":null,"request_headers":{"Content-Type":"application/json","Authorization":"Bearer 9QVCV0zQFNWlNtyeZBVaHWrNuKnKXGg1jEJFq0VUxrQ","Accept":"application/vnd.civis-platform.v1","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":204,"response_status_text":"No Content","response_body":null,"response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","X-Request-Id":"fef9d5ad-a4d7-458c-bead-af9bcdb3bf42","X-Runtime":"0.021474"},"response_content_type":null,"curl":"curl \"api.civis.testhttp://api.civis.test/services/32/tokens/3\" -d '' -X DELETE \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer 9QVCV0zQFNWlNtyeZBVaHWrNuKnKXGg1jEJFq0VUxrQ\" \\\n\t-H \"Accept: application/vnd.civis-platform.v1\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/storage_hosts/":{"get":{"summary":"List the storage hosts","description":null,"deprecated":false,"parameters":[],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object658"}}}},"x-examples":[{"resource":"StorageHosts","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/storage_hosts","description":"List all cloud storage hosts for a user","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/storage_hosts","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer H61XfzpzDvLqjKxRBKejZbsEYtbvfOzo-uPkLIYvGDg","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 260,\n \"owner\": {\n \"id\": 527,\n \"name\": \"User devuserfactory344 344\",\n \"username\": \"devuserfactory344\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"name\": \"S3Storage\",\n \"provider\": \"s3\",\n \"bucket\": \"mybucket\",\n \"s3Options\": {\n \"region\": \"us-east-1\"\n }\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"a7cf18843f153c4f91e5cfb14a5bf66d\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"8571d33d-d632-4d0a-b63a-bf90d6d379fd","X-Runtime":"0.032331","Content-Length":"218"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/storage_hosts\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer H61XfzpzDvLqjKxRBKejZbsEYtbvfOzo-uPkLIYvGDg\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"post":{"summary":"Create a new storage host","description":null,"deprecated":false,"parameters":[{"name":"Object660","in":"body","schema":{"$ref":"#/definitions/Object660"},"required":true}],"responses":{"201":{"description":"success","schema":{"$ref":"#/definitions/Object658"}}},"x-examples":[{"resource":"StorageHosts","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/storage_hosts","description":"Create a cloud storage host","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/storage_hosts","request_body":"{\n \"name\": \"S3 Host\",\n \"provider\": \"s3\",\n \"bucket\": \"theres-a-hole-in-the-bucket\"\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer bsZebIoEAYP-sESVAXd_AmXdOPfXflKQg1cqJrA2yTM","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":201,"response_status_text":"Created","response_body":"{\n \"id\": 266,\n \"owner\": {\n \"id\": 529,\n \"name\": \"User devuserfactory346 346\",\n \"username\": \"devuserfactory346\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"name\": \"S3 Host\",\n \"provider\": \"s3\",\n \"bucket\": \"theres-a-hole-in-the-bucket\",\n \"s3Options\": {\n \"region\": \"us-east-1\"\n }\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"4b8dccfa62c5a30d9cef34a42cd88589\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"41199457-243e-4670-a14d-c24bf38a067d","X-Runtime":"0.057801","Content-Length":"233"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/storage_hosts\" -d '{\"name\":\"S3 Host\",\"provider\":\"s3\",\"bucket\":\"theres-a-hole-in-the-bucket\"}' -X POST \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer bsZebIoEAYP-sESVAXd_AmXdOPfXflKQg1cqJrA2yTM\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/storage_hosts/{id}":{"get":{"summary":"Get a storage host","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the storage host.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object658"}}},"x-examples":[{"resource":"StorageHosts","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/storage_hosts/:id","description":"View details for a cloud storage host","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/storage_hosts/262","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer V25hbRbBG-4_K3A-hMw-f9t6QLXmICaQNjZqT_-EYzY","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 262,\n \"owner\": {\n \"id\": 528,\n \"name\": \"User devuserfactory345 345\",\n \"username\": \"devuserfactory345\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"name\": \"S3Storage\",\n \"provider\": \"s3\",\n \"bucket\": \"mybucket\",\n \"s3Options\": {\n \"region\": \"us-east-1\"\n }\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"c3f69a825f3e6743844b46ba5f75e47a\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"886aa5e5-7f1e-4b34-b5f9-13102a980dd0","X-Runtime":"0.033787","Content-Length":"216"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/storage_hosts/262\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer V25hbRbBG-4_K3A-hMw-f9t6QLXmICaQNjZqT_-EYzY\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"put":{"summary":"Replace all attributes of this storage host","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the storage host.","type":"integer"},{"name":"Object662","in":"body","schema":{"$ref":"#/definitions/Object662"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object658"}}},"x-examples":[{"resource":"StorageHosts","resource_explanation":null,"http_method":"PUT","route":"http://api.civis.test/storage_hosts/:id","description":"Update a cloud storage host via PUT","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"PUT","request_path":"http://api.civis.test/storage_hosts/271","request_body":"{\n \"name\": \"Different S3 Host\",\n \"provider\": \"s3\",\n \"bucket\": \"theres-still-a-hole-in-the-bucket\"\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer 1l7myO--d8Hw3R2BXt-EP6yOOfaKb2uFT8Omp_fK3Nw","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 271,\n \"owner\": {\n \"id\": 532,\n \"name\": \"User devuserfactory349 349\",\n \"username\": \"devuserfactory349\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"name\": \"Different S3 Host\",\n \"provider\": \"s3\",\n \"bucket\": \"theres-still-a-hole-in-the-bucket\",\n \"s3Options\": {\n \"region\": \"us-east-1\"\n }\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"77ae135c94f22754faa94933c0c1f79f\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"2bb21bc9-07f3-45ad-891a-2a2eb513fc04","X-Runtime":"0.066749","Content-Length":"249"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/storage_hosts/271\" -d '{\"name\":\"Different S3 Host\",\"provider\":\"s3\",\"bucket\":\"theres-still-a-hole-in-the-bucket\"}' -X PUT \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer 1l7myO--d8Hw3R2BXt-EP6yOOfaKb2uFT8Omp_fK3Nw\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"patch":{"summary":"Update some attributes of this storage host","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the storage host.","type":"integer"},{"name":"Object663","in":"body","schema":{"$ref":"#/definitions/Object663"},"required":false}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object658"}}},"x-examples":[{"resource":"StorageHosts","resource_explanation":null,"http_method":"PATCH","route":"http://api.civis.test/storage_hosts/:id","description":"Update a cloud storage host via PATCH","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"PATCH","request_path":"http://api.civis.test/storage_hosts/267","request_body":"{\n \"name\": \"Renamed S3 Host\"\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer wSO5eg09Rbv6WpbuhYF4-2jrRhADPKppRUgLAbf22Bg","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 267,\n \"owner\": {\n \"id\": 530,\n \"name\": \"User devuserfactory347 347\",\n \"username\": \"devuserfactory347\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"name\": \"Renamed S3 Host\",\n \"provider\": \"s3\",\n \"bucket\": \"mybucket\",\n \"s3Options\": {\n \"region\": \"us-east-1\"\n }\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"5e72373144ed7991aef1360d57d137e7\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"019e6154-4000-4c91-9f47-d9755ab53337","X-Runtime":"0.058362","Content-Length":"222"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/storage_hosts/267\" -d '{\"name\":\"Renamed S3 Host\"}' -X PATCH \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer wSO5eg09Rbv6WpbuhYF4-2jrRhADPKppRUgLAbf22Bg\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"StorageHosts","resource_explanation":null,"http_method":"PATCH","route":"http://api.civis.test/storage_hosts/:id","description":"Update a cloud storage host connection attributes via PATCH","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"PATCH","request_path":"http://api.civis.test/storage_hosts/269","request_body":"{\n \"bucket\": \"theres-still-a-hole-in-the-bucket\"\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer 1YSuTVgvVWoNKM3lJ4WcfEcUV6klvamADidIAi6cIOw","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 269,\n \"owner\": {\n \"id\": 531,\n \"name\": \"User devuserfactory348 348\",\n \"username\": \"devuserfactory348\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"name\": \"S3Storage\",\n \"provider\": \"s3\",\n \"bucket\": \"theres-still-a-hole-in-the-bucket\",\n \"s3Options\": {\n \"region\": \"us-east-1\"\n }\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"226ce7dee4163e6d834fbe63de6fd6bb\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"c777adfe-a4cb-4b89-89ec-f3e2297eb998","X-Runtime":"0.044300","Content-Length":"241"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/storage_hosts/269\" -d '{\"bucket\":\"theres-still-a-hole-in-the-bucket\"}' -X PATCH \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer 1YSuTVgvVWoNKM3lJ4WcfEcUV6klvamADidIAi6cIOw\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"delete":{"summary":"Delete a storage host (deprecated)","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the storage host.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":[{"resource":"StorageHosts","resource_explanation":null,"http_method":"DELETE","route":"http://api.civis.test/storage_hosts/:id","description":"Delete a cloud storage host","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"DELETE","request_path":"http://api.civis.test/storage_hosts/273","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer hiyAxqsnKewsixoGOVzPNt1ChSzXPDE1Oz8EQ9dsaIc","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":204,"response_status_text":"No Content","response_body":null,"response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"530adeea-945a-44ee-86d3-39fe30ee5e12","X-Runtime":"0.039972"},"response_content_type":null,"curl":"curl \"api.civis.testhttp://api.civis.test/storage_hosts/273\" -d '' -X DELETE \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer hiyAxqsnKewsixoGOVzPNt1ChSzXPDE1Oz8EQ9dsaIc\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/storage_hosts/{id}/shares":{"get":{"summary":"List users and groups permissioned on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object9"}}}},"x-examples":null,"x-deprecation-warning":null}},"/storage_hosts/{id}/shares/users":{"put":{"summary":"Set the permissions users have on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"Object664","in":"body","schema":{"$ref":"#/definitions/Object664"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object9"}}},"x-examples":null,"x-deprecation-warning":null}},"/storage_hosts/{id}/shares/users/{user_id}":{"delete":{"summary":"Revoke the permissions a user has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"user_id","in":"path","required":true,"description":"The ID of the user.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/storage_hosts/{id}/shares/groups":{"put":{"summary":"Set the permissions groups has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"Object665","in":"body","schema":{"$ref":"#/definitions/Object665"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object9"}}},"x-examples":null,"x-deprecation-warning":null}},"/storage_hosts/{id}/shares/groups/{group_id}":{"delete":{"summary":"Revoke the permissions a group has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"group_id","in":"path","required":true,"description":"The ID of the group.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/storage_hosts/{id}/dependencies":{"get":{"summary":"List dependent objects for this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"user_id","in":"query","required":false,"description":"ID of target user","type":"integer"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object15"}}}},"x-examples":null,"x-deprecation-warning":null}},"/storage_hosts/{id}/transfer":{"put":{"summary":"Transfer ownership of this object to another user","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"Object666","in":"body","schema":{"$ref":"#/definitions/Object666"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object17"}}},"x-examples":null,"x-deprecation-warning":null}},"/table_tags/":{"get":{"summary":"List Table Tags","description":null,"deprecated":false,"parameters":[{"name":"name","in":"query","required":false,"description":"Name of the tag. If it is provided, the results will be filtered by name","type":"string"},{"name":"limit","in":"query","required":false,"description":"Number of results to return. Defaults to 50. Maximum allowed is 1000.","type":"integer"},{"name":"page_num","in":"query","required":false,"description":"Page number of the results to return. Defaults to the first page, 1.","type":"integer"},{"name":"order","in":"query","required":false,"description":"The field on which to order the result set. Defaults to name. Must be one of: name, user, table_count.","type":"string"},{"name":"order_dir","in":"query","required":false,"description":"Direction in which to sort, either asc (ascending) or desc (descending) defaulting to asc.","type":"string"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object667"}}}},"x-examples":[{"resource":"Table Tags","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/table_tags","description":"List table tags","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/table_tags","request_body":null,"request_headers":{"Content-Type":"application/json","Authorization":"Bearer svqoVQKyuTBh2Iovl1F4UTKeIsOtkjMIyFGzBgdjOmM","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 6,\n \"name\": \"Table Tag 5\",\n \"tableCount\": 0,\n \"user\": {\n \"id\": 4512,\n \"name\": \"User devuserfactory3066 3064\",\n \"username\": \"devuserfactory3066\",\n \"initials\": \"UD\",\n \"online\": null\n }\n },\n {\n \"id\": 7,\n \"name\": \"Table Tag 6\",\n \"tableCount\": 0,\n \"user\": {\n \"id\": 4512,\n \"name\": \"User devuserfactory3066 3064\",\n \"username\": \"devuserfactory3066\",\n \"initials\": \"UD\",\n \"online\": null\n }\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","X-Pagination-Per-Page":"50","Access-Control-Expose-Headers":"X-Pagination-Per-Page, X-Pagination-Current-Page, X-Pagination-Total-Pages, X-Pagination-Total-Entries","X-Pagination-Current-Page":"1","X-Pagination-Total-Pages":"1","X-Pagination-Total-Entries":"2","Content-Type":"application/json; charset=utf-8","ETag":"W/\"eb466ea4ef9eb3b7b58d8df490d4ba41\"","X-Request-Id":"4801856d-9756-4c31-a830-e6531e46c363","X-Runtime":"0.017729","Content-Length":"329"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/table_tags\" -X GET \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer svqoVQKyuTBh2Iovl1F4UTKeIsOtkjMIyFGzBgdjOmM\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Table Tags","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/table_tags","description":"List table tags and filter by name","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/table_tags?name=Table+Tag+7","request_body":null,"request_headers":{"Content-Type":"application/json","Authorization":"Bearer qfFxAfpD-D3S0fVdyX11ywaK29ljWfFn_IokM2W1jvk","Host":"api.civis.test","Cookie":""},"request_query_parameters":{"name":"Table Tag 7"},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 8,\n \"name\": \"Table Tag 7\",\n \"tableCount\": 0,\n \"user\": {\n \"id\": 4513,\n \"name\": \"User devuserfactory3067 3065\",\n \"username\": \"devuserfactory3067\",\n \"initials\": \"UD\",\n \"online\": null\n }\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","X-Pagination-Per-Page":"50","Access-Control-Expose-Headers":"X-Pagination-Per-Page, X-Pagination-Current-Page, X-Pagination-Total-Pages, X-Pagination-Total-Entries","X-Pagination-Current-Page":"1","X-Pagination-Total-Pages":"1","X-Pagination-Total-Entries":"1","Content-Type":"application/json; charset=utf-8","ETag":"W/\"ea9c57ce9f68b466ecace91a28f52d50\"","X-Request-Id":"62f9a31a-546b-4d6d-b8ae-9177e2218f5b","X-Runtime":"0.016589","Content-Length":"165"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/table_tags?name=Table+Tag+7\" -X GET \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer qfFxAfpD-D3S0fVdyX11ywaK29ljWfFn_IokM2W1jvk\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"post":{"summary":"Create a Table Tag","description":null,"deprecated":false,"parameters":[{"name":"Object668","in":"body","schema":{"$ref":"#/definitions/Object668"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object669"}}},"x-examples":null,"x-deprecation-warning":null}},"/table_tags/{id}":{"get":{"summary":"Get a Table Tag","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object669"}}},"x-examples":[{"resource":"Table Tags","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/table_tags/:id","description":"Get a table tag","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/table_tags/4","request_body":null,"request_headers":{"Content-Type":"application/json","Authorization":"Bearer _FYI4EMtyJgY3g63MqHpDGqQLqWXMkBfkR5q4e0ZiBY","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 4,\n \"name\": \"Table Tag 3\",\n \"createdAt\": \"2023-07-18T18:46:17.000Z\",\n \"updatedAt\": \"2023-07-18T18:46:17.000Z\",\n \"tableCount\": 0,\n \"user\": {\n \"id\": 4511,\n \"name\": \"User devuserfactory3065 3063\",\n \"username\": \"devuserfactory3065\",\n \"initials\": \"UD\",\n \"online\": null\n }\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"40440b81e816abeb5d5257ba718c33cb\"","X-Request-Id":"c1cdc3b0-e2f8-48eb-a608-52a2e1eae0b6","X-Runtime":"0.019004","Content-Length":"241"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/table_tags/4\" -X GET \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer _FYI4EMtyJgY3g63MqHpDGqQLqWXMkBfkR5q4e0ZiBY\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"delete":{"summary":"Delete a Table Tag","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":[{"resource":"Table Tags","resource_explanation":null,"http_method":"DELETE","route":"http://api.civis.test/table_tags/:id","description":"delete a table tag","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"DELETE","request_path":"http://api.civis.test/table_tags/10","request_body":null,"request_headers":{"Content-Type":"application/json","Authorization":"Bearer jquDV3uxSYIAFlliQKvVEUY-EYTg4NFwWIHiyzlHthg","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":204,"response_status_text":"No Content","response_body":null,"response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","X-Request-Id":"cd091a86-39c0-402b-8436-29f01620457b","X-Runtime":"0.068481"},"response_content_type":null,"curl":"curl \"api.civis.testhttp://api.civis.test/table_tags/10\" -d '' -X DELETE \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer jquDV3uxSYIAFlliQKvVEUY-EYTg4NFwWIHiyzlHthg\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/tables/{source_table_id}/enhancements/geocodings":{"post":{"summary":"Geocode a table","description":"Create a new table with additional census and geographic boundary information. The source table should either contain addresses, which will be geocoded into latitude/longitude coordinates in the output table, or latitude/longitude coordinates.Before using this endpoint, the source table must be provided with a mapping declaring either which columns in the table act as address columns or which columns in the table act as latitude/longitude coordinates. See the PATCH tables/:id endpoint for supplying this mapping.","deprecated":true,"parameters":[{"name":"source_table_id","in":"path","required":true,"description":"The ID of the table to be enhanced.","type":"integer"}],"responses":{"201":{"description":"success","schema":{"$ref":"#/definitions/Object670"}}},"x-examples":[{"resource":"Tables","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/tables/:id/enhancements/geocodings","description":"No column mapping present","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/tables/212/enhancements/geocodings","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer 8mpF9Z9gf-BeH7wZY2P9MEtajv_bxokZIKkogOZNEd0","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":409,"response_status_text":"Conflict","response_body":"{\n \"error\": \"conflict\",\n \"errorDescription\": \"Ontology must be mapped first for table 212. Please use the tables/:id endpoints to set an ontology mapping.\",\n \"code\": 409\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","X-Request-Id":"582017c3-532e-4ff5-a73c-6160086272f3","X-Runtime":"0.057870","Content-Length":"161"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/tables/212/enhancements/geocodings\" -d '' -X POST \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer 8mpF9Z9gf-BeH7wZY2P9MEtajv_bxokZIKkogOZNEd0\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Tables","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/tables/:id/enhancements/geocodings","description":"Create a geocoding enhancement","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/tables/213/enhancements/geocodings","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer A5c2J3z-BHqdBxLZolpmX4hzAgw8bbD9cS-3KCux2Z4","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":201,"response_status_text":"Created","response_body":"{\n \"id\": 2180,\n \"sourceTableId\": 213,\n \"state\": \"queued\",\n \"enhancedTableSchema\": \"schema_name\",\n \"enhancedTableName\": \"table_name236_geocoded_208\"\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"ec7bd18e30584ee2e1a428e241328705\"","X-Request-Id":"9695a2f7-3f2c-4a1c-bd65-5fb9a5c29885","X-Runtime":"0.339779","Content-Length":"133"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/tables/213/enhancements/geocodings\" -d '' -X POST \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer A5c2J3z-BHqdBxLZolpmX4hzAgw8bbD9cS-3KCux2Z4\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":"Warning: The tables/:source_table_id/enhancements/geocodings endpoint is deprecated and will be removed after January 1, 2021."}},"/tables/{source_table_id}/enhancements/cass-ncoa":{"post":{"summary":"Standardize addresses in a table","description":"Create a new table with USPS CASS-certified address standardization and (optionally) update addresses for records matching the National Change of Address (NCOA) database. Before using this endpoint, the source table must be provided with a mapping declaring which columns in the table act as address columns. See the PATCH tables/:id endpoint for supplying this mapping.","deprecated":true,"parameters":[{"name":"source_table_id","in":"path","required":true,"description":"The ID of the table to be enhanced.","type":"integer"},{"name":"Object671","in":"body","schema":{"$ref":"#/definitions/Object671"},"required":false}],"responses":{"201":{"description":"success","schema":{"$ref":"#/definitions/Object672"}}},"x-examples":[{"resource":"Tables","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/tables/:id/enhancements/cass-ncoa","description":"Create a CASS enhancement without NCOA","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/tables/223/enhancements/cass-ncoa","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer uDz5ERSPS-99iZpnWeJAVmq_V9yfiQGrZI0LQ3Umvt8","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":201,"response_status_text":"Created","response_body":"{\n \"id\": 2183,\n \"sourceTableId\": 223,\n \"state\": \"queued\",\n \"enhancedTableSchema\": \"schema_name\",\n \"enhancedTableName\": \"table_name247_cass_210\",\n \"performNcoa\": false,\n \"ncoaCredentialId\": null,\n \"outputLevel\": \"all\",\n \"batchSize\": 250000\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"99718231c8df7cbf8c38393889d881b2\"","X-Request-Id":"5db44689-1dd9-4063-95d6-69158c88bafc","X-Runtime":"0.321052","Content-Length":"212"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/tables/223/enhancements/cass-ncoa\" -d '' -X POST \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer uDz5ERSPS-99iZpnWeJAVmq_V9yfiQGrZI0LQ3Umvt8\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Tables","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/tables/:id/enhancements/cass-ncoa","description":"Create a CASS enhancement with NCOA","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/tables/230/enhancements/cass-ncoa","request_body":"{\n \"performNcoa\": true,\n \"batchSize\": 100000,\n \"ncoaCredentialId\": 539\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer i8zd-zc5ykLU0a90Wuv_1VQj0X8_a7xrSFMj2mb1hkQ","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":201,"response_status_text":"Created","response_body":"{\n \"id\": 2184,\n \"sourceTableId\": 230,\n \"state\": \"queued\",\n \"enhancedTableSchema\": \"schema_name\",\n \"enhancedTableName\": \"table_name254_cass_211\",\n \"performNcoa\": true,\n \"ncoaCredentialId\": 539,\n \"outputLevel\": \"all\",\n \"batchSize\": 100000\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"7e3a358cc498c4ff2b0bc13e3b3fc584\"","X-Request-Id":"c245058b-38fa-455d-8283-75d88184b8ef","X-Runtime":"0.334971","Content-Length":"210"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/tables/230/enhancements/cass-ncoa\" -d '{\"performNcoa\":true,\"batchSize\":100000,\"ncoaCredentialId\":539}' -X POST \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer i8zd-zc5ykLU0a90Wuv_1VQj0X8_a7xrSFMj2mb1hkQ\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":"Warning: The tables/:source_table_id/enhancements/cass-ncoa endpoint is deprecated and will be removed after January 1, 2021."}},"/tables/{source_table_id}/enhancements/geocodings/{id}":{"get":{"summary":"View the status of a geocoding table enhancement","description":"This endpoint may be polled to monitor the status of the geocoding table enhancement. When the 'state' field is no longer 'queued' or 'running' the geocoding table enhancement has reached its final state.","deprecated":true,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the enhancement.","type":"integer"},{"name":"source_table_id","in":"path","required":true,"description":"The ID of the table that was enhanced.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object670"}}},"x-examples":[{"resource":"Tables","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/tables/:id/enhancements/geocodings/:geo_id","description":"View a geocoding enhancement","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/tables/217/enhancements/geocodings/2182","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer uk73QBZjUdG3k-UA2IzbUZMONIjFySbTNIxCHCwDNxw","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 2182,\n \"sourceTableId\": 217,\n \"state\": \"queued\",\n \"enhancedTableSchema\": \"schema_name\",\n \"enhancedTableName\": \"table_name240_geocoded_209\"\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"f3e36571d298ff5aa3e4699cf0f795ac\"","X-Request-Id":"7f532d43-2fa4-42b9-af0d-1fb6641e3154","X-Runtime":"0.046586","Content-Length":"133"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/tables/217/enhancements/geocodings/2182\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer uk73QBZjUdG3k-UA2IzbUZMONIjFySbTNIxCHCwDNxw\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":"Warning: The tables/:source_table_id/enhancements/geocodings/:id endpoint is deprecated and will be removed after January 1, 2021."}},"/tables/{source_table_id}/enhancements/cass-ncoa/{id}":{"get":{"summary":"View the status of a CASS / NCOA table enhancement","description":"This endpoint may be polled to monitor the status of the cass-ncoa table enhancement. When the 'state' field is no longer 'queued' or 'running' the cass-ncoa table enhancement has reached its final state.","deprecated":true,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the enhancement.","type":"integer"},{"name":"source_table_id","in":"path","required":true,"description":"The ID of the table that was enhanced.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object672"}}},"x-examples":[{"resource":"Tables","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/tables/:id/enhancements/cass-ncoa/:cass_ncoa_id","description":"View a cass-ncoa enhancement","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/tables/237/enhancements/cass-ncoa/2185","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer C-5lot_RoMAYrzijXwZyBHEINq18v8qC0NTKFn72YVk","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 2185,\n \"sourceTableId\": 237,\n \"state\": \"queued\",\n \"enhancedTableSchema\": \"my_schema\",\n \"enhancedTableName\": \"my_table\",\n \"performNcoa\": true,\n \"ncoaCredentialId\": 549,\n \"outputLevel\": \"all\",\n \"batchSize\": 250000\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"083cbf4fd4d07da888c5b6e7ccd95e9d\"","X-Request-Id":"64da3088-4cc7-483b-aa1d-6cfe80293cc1","X-Runtime":"0.043069","Content-Length":"194"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/tables/237/enhancements/cass-ncoa/2185\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer C-5lot_RoMAYrzijXwZyBHEINq18v8qC0NTKFn72YVk\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":"Warning: The tables/:source_table_id/enhancements/cass-ncoa/:id endpoint is deprecated and will be removed after January 1, 2021."}},"/tables/scan":{"post":{"summary":"Creates and enqueues a single table scanner job on a new table","description":null,"deprecated":false,"parameters":[{"name":"Object673","in":"body","schema":{"$ref":"#/definitions/Object673"},"required":true}],"responses":{"201":{"description":"success","schema":{"$ref":"#/definitions/Object674"}}},"x-examples":[{"resource":"Tables","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/tables/scan","description":"Scan a table","explanation":null,"parameters":[{"required":true,"name":"databaseId","description":"The ID of the database."},{"required":true,"name":"schema","description":"The name of the schema containing the table."},{"required":true,"name":"tableName","description":"The name of the table."},{"required":false,"name":"statsPriority","description":"When to sync table statistics. Valid Options are the following. Option: 'flag' means to flag stats for the next scheduled run of a full table scan on the database. Option: 'block' means to block this job on stats syncing. Option: 'queue' means to queue a separate job for syncing stats and do not block this job on the queued job. Defaults to 'flag'"}],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/tables/scan","request_body":"{\n \"schema\": \"test_20240329145653263557656\",\n \"database_id\": 5,\n \"table_name\": \"table_name233\",\n \"stats_priority\": \"flag\"\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer Az9VbRRo-X2dLG5lxeV5rbvSGLyhobWLp3OL6LSSIJg","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":201,"response_status_text":"Created","response_body":"{\n \"jobId\": 2178,\n \"runId\": 206\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"68e84ff14c8ed9f7f889569c13e082a8\"","X-Request-Id":"02d5d944-e068-4cd8-942e-ce04095a3e9d","X-Runtime":"0.296324","Content-Length":"26"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/tables/scan\" -d '{\"schema\":\"test_20240329145653263557656\",\"database_id\":5,\"table_name\":\"table_name233\",\"stats_priority\":\"flag\"}' -X POST \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer Az9VbRRo-X2dLG5lxeV5rbvSGLyhobWLp3OL6LSSIJg\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/tables/{id}/refresh":{"post":{"summary":"Request a refresh for column and table statistics","description":null,"deprecated":true,"parameters":[{"name":"id","in":"path","required":true,"type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object73"}}},"x-examples":[{"resource":"Tables","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/tables/:id/refresh","description":"Refresh a table","explanation":null,"parameters":[{"required":true,"name":"id","description":"id"}],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/tables/211/refresh","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer tGeD3TvzxvzKQ0t4YO0Q4QK81U3KTP8Cv6W85vrixNk","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 211,\n \"databaseId\": 5,\n \"schema\": \"schema_name\",\n \"name\": \"table_name234\",\n \"description\": null,\n \"isView\": false,\n \"rowCount\": 1,\n \"columnCount\": 0,\n \"sizeMb\": null,\n \"owner\": \"dbadmin\",\n \"distkey\": null,\n \"sortkeys\": null,\n \"refreshStatus\": \"refreshing\",\n \"lastRefresh\": null,\n \"dataUpdatedAt\": \"2020-04-16T16:31:00.000Z\",\n \"schemaUpdatedAt\": \"2020-05-01T16:38:00.000Z\",\n \"refreshId\": 2179,\n \"lastRun\": {\n \"id\": 207,\n \"state\": \"queued\",\n \"createdAt\": \"2024-03-29T15:01:00.000Z\",\n \"startedAt\": null,\n \"finishedAt\": null,\n \"error\": null\n },\n \"primaryKeys\": [\n\n ],\n \"lastModifiedKeys\": [\n\n ],\n \"tableTags\": [\n {\n \"id\": 11,\n \"name\": \"Table Tag 11\"\n }\n ],\n \"ontologyMapping\": {\n },\n \"columns\": [\n\n ],\n \"joins\": [\n\n ],\n \"multipartKey\": [\n \"address_id\"\n ],\n \"enhancements\": [\n\n ],\n \"viewDef\": null,\n \"tableDef\": \"CREATE TABLE \\\"schema_name\\\".\\\"table_name234\\\" (\\n \\n)\\nDISTSTYLE AUTO;\\n\",\n \"outgoingTableMatches\": [\n\n ]\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"868f056bc5f58351d95ba76495940dfe\"","X-Request-Id":"fcf1ac65-b43f-45dd-b493-80dc5469dffe","X-Runtime":"0.390098","Content-Length":"784"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/tables/211/refresh\" -d '' -X POST \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer tGeD3TvzxvzKQ0t4YO0Q4QK81U3KTP8Cv6W85vrixNk\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""},{"request_method":"POST","request_path":"http://api.civis.test/tables/211/refresh","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer tGeD3TvzxvzKQ0t4YO0Q4QK81U3KTP8Cv6W85vrixNk","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":409,"response_status_text":"Conflict","response_body":"{\n \"error\": \"conflict\",\n \"errorDescription\": \"Already running\",\n \"code\": 409\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","X-Request-Id":"e0d9e678-1aea-4ec1-ac98-1c82b4a16020","X-Runtime":"0.175623","Content-Length":"68"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/tables/211/refresh\" -d '' -X POST \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer tGeD3TvzxvzKQ0t4YO0Q4QK81U3KTP8Cv6W85vrixNk\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":"Warning: The tables/:id/refresh endpoint is deprecated. Please use tables/scan from now on."}},"/tables/":{"get":{"summary":"List tables","description":null,"deprecated":false,"parameters":[{"name":"database_id","in":"query","required":false,"description":"The ID of the database.","type":"integer"},{"name":"schema","in":"query","required":false,"description":"If specified, will be used to filter the tables returned. Substring matching is supported with \"%\" and \"*\" wildcards (e.g., \"schema=%census%\" will return both \"client_census.table\" and \"census_2010.table\").","type":"string"},{"name":"name","in":"query","required":false,"description":"If specified, will be used to filter the tables returned. Substring matching is supported with \"%\" and \"*\" wildcards (e.g., \"name=%table%\" will return both \"table1\" and \"my table\").","type":"string"},{"name":"search","in":"query","required":false,"description":"If specified, will be used to filter the tables returned. Will search across schema and name (in the full form schema.name) and will return any full name containing the search string.","type":"string"},{"name":"table_tag_ids","in":"query","required":false,"description":"If specified, will be used to filter the tables returned. Will search across Table Tags and will return any tables that have one of the matching Table Tags.","type":"array","items":{"type":"integer"}},{"name":"credential_id","in":"query","required":false,"description":"If specified, will be used instead of the default credential to filter the tables returned.","type":"integer"},{"name":"limit","in":"query","required":false,"description":"Number of results to return. Defaults to 50. Maximum allowed is 1000.","type":"integer"},{"name":"page_num","in":"query","required":false,"description":"Page number of the results to return. Defaults to the first page, 1.","type":"integer"},{"name":"order","in":"query","required":false,"description":"The field on which to order the result set. Defaults to schema. Must be one of: schema, name, search, table_tag_ids, credential_id.","type":"string"},{"name":"order_dir","in":"query","required":false,"description":"Direction in which to sort, either asc (ascending) or desc (descending) defaulting to asc.","type":"string"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object87"}}}},"x-examples":[{"resource":"Tables","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/tables","description":"list tables","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/tables","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer Z84BSWpRGwlp8cd5AQhQXvM1WrbusaO0GUOsmLPRuXM","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 190,\n \"databaseId\": 5,\n \"schema\": \"schema_name\",\n \"name\": \"table_name195\",\n \"description\": null,\n \"isView\": false,\n \"rowCount\": 1,\n \"columnCount\": 0,\n \"sizeMb\": null,\n \"owner\": \"dbadmin\",\n \"distkey\": null,\n \"sortkeys\": null,\n \"refreshStatus\": \"stale\",\n \"lastRefresh\": null,\n \"refreshId\": null,\n \"lastRun\": null,\n \"tableTags\": [\n\n ]\n },\n {\n \"id\": 191,\n \"databaseId\": 5,\n \"schema\": \"schema_name\",\n \"name\": \"table_name196\",\n \"description\": null,\n \"isView\": false,\n \"rowCount\": 7,\n \"columnCount\": 2,\n \"sizeMb\": null,\n \"owner\": \"dbadmin\",\n \"distkey\": null,\n \"sortkeys\": null,\n \"refreshStatus\": \"stale\",\n \"lastRefresh\": null,\n \"refreshId\": null,\n \"lastRun\": null,\n \"tableTags\": [\n {\n \"id\": 1,\n \"name\": \"Table Tag 1\"\n }\n ]\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","X-Pagination-Per-Page":"50","Access-Control-Expose-Headers":"X-Pagination-Per-Page, X-Pagination-Current-Page, X-Pagination-Total-Pages, X-Pagination-Total-Entries","X-Pagination-Current-Page":"1","X-Pagination-Total-Pages":"1","X-Pagination-Total-Entries":"2","Content-Type":"application/json; charset=utf-8","ETag":"W/\"2e10419d45fb773ca661e0ddc204049b\"","X-Request-Id":"e5426f39-3aac-4882-b11d-b17b0b8e59bc","X-Runtime":"0.100209","Content-Length":"606"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/tables\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer Z84BSWpRGwlp8cd5AQhQXvM1WrbusaO0GUOsmLPRuXM\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Tables","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/tables?name=find_this%25","description":"filter tables by name with a \"%\" wildcard","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/tables?name=find_this%25","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer wT8EqcgYGG-_7jyXrL_NHiI2SBIBCN5x1NDWgs7BqSM","Host":"api.civis.test","Cookie":""},"request_query_parameters":{"name":"find_this%"},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 192,\n \"databaseId\": 5,\n \"schema\": \"schema_name\",\n \"name\": \"find_this_table\",\n \"description\": null,\n \"isView\": false,\n \"rowCount\": 1,\n \"columnCount\": 0,\n \"sizeMb\": null,\n \"owner\": \"dbadmin\",\n \"distkey\": null,\n \"sortkeys\": null,\n \"refreshStatus\": \"stale\",\n \"lastRefresh\": null,\n \"refreshId\": null,\n \"lastRun\": null,\n \"tableTags\": [\n\n ]\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","X-Pagination-Per-Page":"50","Access-Control-Expose-Headers":"X-Pagination-Per-Page, X-Pagination-Current-Page, X-Pagination-Total-Pages, X-Pagination-Total-Entries","X-Pagination-Current-Page":"1","X-Pagination-Total-Pages":"1","X-Pagination-Total-Entries":"1","Content-Type":"application/json; charset=utf-8","ETag":"W/\"29a336858989c32332cbf2a70466f3c9\"","X-Request-Id":"a21eaa26-d738-4b83-8166-09bcf71887ba","X-Runtime":"0.069924","Content-Length":"291"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/tables?name=find_this%25\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer wT8EqcgYGG-_7jyXrL_NHiI2SBIBCN5x1NDWgs7BqSM\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Tables","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/tables?name=find_this%2a","description":"filter tables by name with a \"*\" wildcard","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/tables?name=find_this%2a","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer aW-DxCYQR5ON_rmapIUfHxU9OnbogE-WPnbgz-3g0l8","Host":"api.civis.test","Cookie":""},"request_query_parameters":{"name":"find_this*"},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 194,\n \"databaseId\": 5,\n \"schema\": \"schema_name\",\n \"name\": \"find_this_table\",\n \"description\": null,\n \"isView\": false,\n \"rowCount\": 1,\n \"columnCount\": 0,\n \"sizeMb\": null,\n \"owner\": \"dbadmin\",\n \"distkey\": null,\n \"sortkeys\": null,\n \"refreshStatus\": \"stale\",\n \"lastRefresh\": null,\n \"refreshId\": null,\n \"lastRun\": null,\n \"tableTags\": [\n\n ]\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","X-Pagination-Per-Page":"50","Access-Control-Expose-Headers":"X-Pagination-Per-Page, X-Pagination-Current-Page, X-Pagination-Total-Pages, X-Pagination-Total-Entries","X-Pagination-Current-Page":"1","X-Pagination-Total-Pages":"1","X-Pagination-Total-Entries":"1","Content-Type":"application/json; charset=utf-8","ETag":"W/\"a7971ab2ca0c00f12bf63f6cac26206a\"","X-Request-Id":"24a566a1-60dd-4b81-aebb-d1c4a6a0cb31","X-Runtime":"0.064310","Content-Length":"291"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/tables?name=find_this%2a\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer aW-DxCYQR5ON_rmapIUfHxU9OnbogE-WPnbgz-3g0l8\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Tables","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/tables?name=find_this_table","description":"filter tables by exact name","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/tables?name=find_this_table","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer jU8DHVQ9u9iVY4AuRZkRNUIBUNPRn2r3aotpOoKki9A","Host":"api.civis.test","Cookie":""},"request_query_parameters":{"name":"find_this_table"},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 197,\n \"databaseId\": 5,\n \"schema\": \"schema_name\",\n \"name\": \"find_this_table\",\n \"description\": null,\n \"isView\": false,\n \"rowCount\": 7,\n \"columnCount\": 2,\n \"sizeMb\": null,\n \"owner\": \"dbadmin\",\n \"distkey\": null,\n \"sortkeys\": null,\n \"refreshStatus\": \"stale\",\n \"lastRefresh\": null,\n \"refreshId\": null,\n \"lastRun\": null,\n \"tableTags\": [\n {\n \"id\": 4,\n \"name\": \"Table Tag 4\"\n }\n ]\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","X-Pagination-Per-Page":"50","Access-Control-Expose-Headers":"X-Pagination-Per-Page, X-Pagination-Current-Page, X-Pagination-Total-Pages, X-Pagination-Total-Entries","X-Pagination-Current-Page":"1","X-Pagination-Total-Pages":"1","X-Pagination-Total-Entries":"1","Content-Type":"application/json; charset=utf-8","ETag":"W/\"87b62d143d83f41cba1cdbfbc1b31ad5\"","X-Request-Id":"8b961567-9e01-43e1-895d-2c8f8a144fc1","X-Runtime":"0.093006","Content-Length":"320"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/tables?name=find_this_table\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer jU8DHVQ9u9iVY4AuRZkRNUIBUNPRn2r3aotpOoKki9A\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Tables","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/tables?schema=%25census%25","description":"filter tables by schema","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/tables?schema=%25census%25","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer vo8RbEl1ot6bVJXpG0vbsiPAezwsy5YbLyHC8JxN4Xo","Host":"api.civis.test","Cookie":""},"request_query_parameters":{"schema":"%census%"},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 198,\n \"databaseId\": 5,\n \"schema\": \"census_2010\",\n \"name\": \"table_name211\",\n \"description\": null,\n \"isView\": false,\n \"rowCount\": 1,\n \"columnCount\": 0,\n \"sizeMb\": null,\n \"owner\": \"dbadmin\",\n \"distkey\": null,\n \"sortkeys\": null,\n \"refreshStatus\": \"stale\",\n \"lastRefresh\": null,\n \"refreshId\": null,\n \"lastRun\": null,\n \"tableTags\": [\n\n ]\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","X-Pagination-Per-Page":"50","Access-Control-Expose-Headers":"X-Pagination-Per-Page, X-Pagination-Current-Page, X-Pagination-Total-Pages, X-Pagination-Total-Entries","X-Pagination-Current-Page":"1","X-Pagination-Total-Pages":"1","X-Pagination-Total-Entries":"1","Content-Type":"application/json; charset=utf-8","ETag":"W/\"730b757127525b841e11f1a86f80a5a1\"","X-Request-Id":"9bb86d97-4444-4cee-bc1f-2ae5b26b7b14","X-Runtime":"0.065590","Content-Length":"289"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/tables?schema=%25census%25\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer vo8RbEl1ot6bVJXpG0vbsiPAezwsy5YbLyHC8JxN4Xo\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Tables","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/tables","description":"filter tables by database","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/tables?database_id=5","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer Ec4A-_rSC8tkzRSczijfxzJM08ZlNOdHPVBd34Wep3c","Host":"api.civis.test","Cookie":""},"request_query_parameters":{"database_id":"5"},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 200,\n \"databaseId\": 5,\n \"schema\": \"schema_name\",\n \"name\": \"table_name215\",\n \"description\": null,\n \"isView\": false,\n \"rowCount\": 1,\n \"columnCount\": 0,\n \"sizeMb\": null,\n \"owner\": \"dbadmin\",\n \"distkey\": null,\n \"sortkeys\": null,\n \"refreshStatus\": \"stale\",\n \"lastRefresh\": null,\n \"refreshId\": null,\n \"lastRun\": null,\n \"tableTags\": [\n\n ]\n },\n {\n \"id\": 201,\n \"databaseId\": 5,\n \"schema\": \"schema_name\",\n \"name\": \"table_name216\",\n \"description\": null,\n \"isView\": false,\n \"rowCount\": 7,\n \"columnCount\": 2,\n \"sizeMb\": null,\n \"owner\": \"dbadmin\",\n \"distkey\": null,\n \"sortkeys\": null,\n \"refreshStatus\": \"stale\",\n \"lastRefresh\": null,\n \"refreshId\": null,\n \"lastRun\": null,\n \"tableTags\": [\n {\n \"id\": 6,\n \"name\": \"Table Tag 6\"\n }\n ]\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","X-Pagination-Per-Page":"50","Access-Control-Expose-Headers":"X-Pagination-Per-Page, X-Pagination-Current-Page, X-Pagination-Total-Pages, X-Pagination-Total-Entries","X-Pagination-Current-Page":"1","X-Pagination-Total-Pages":"1","X-Pagination-Total-Entries":"2","Content-Type":"application/json; charset=utf-8","ETag":"W/\"e0dac9594fd85e56ae008af2955a6698\"","X-Request-Id":"97268a70-b22f-4605-93a3-f101d3921cfb","X-Runtime":"0.068956","Content-Length":"606"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/tables?database_id=5\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer Ec4A-_rSC8tkzRSczijfxzJM08ZlNOdHPVBd34Wep3c\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/tables/{id}":{"get":{"summary":"Show basic table info","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object73"}}},"x-examples":[{"resource":"Tables","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/tables/:id","description":"View a table","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/tables/203","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer GPdK3RrDWkysMRTR0m_O71ehYqz5rxs3_y15Xq7OU94","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 203,\n \"databaseId\": 5,\n \"schema\": \"schema_name\",\n \"name\": \"table_name220\",\n \"description\": null,\n \"isView\": false,\n \"rowCount\": 7,\n \"columnCount\": 2,\n \"sizeMb\": null,\n \"owner\": \"dbadmin\",\n \"distkey\": null,\n \"sortkeys\": null,\n \"refreshStatus\": \"stale\",\n \"lastRefresh\": null,\n \"dataUpdatedAt\": \"2020-04-16T16:31:00.000Z\",\n \"schemaUpdatedAt\": \"2020-05-01T16:38:00.000Z\",\n \"refreshId\": null,\n \"lastRun\": null,\n \"primaryKeys\": [\n\n ],\n \"lastModifiedKeys\": [\n\n ],\n \"tableTags\": [\n {\n \"id\": 7,\n \"name\": \"Table Tag 7\"\n }\n ],\n \"ontologyMapping\": {\n },\n \"columns\": [\n {\n \"name\": \"snakes\",\n \"civisDataType\": \"string\",\n \"sqlType\": \"character varying(256)\",\n \"sampleValues\": [\n\n ],\n \"encoding\": null,\n \"description\": \"this is not a pipe\",\n \"order\": 1,\n \"minValue\": \"apple\",\n \"maxValue\": \"banana\",\n \"avgValue\": null,\n \"stddev\": null,\n \"valueDistributionPercent\": {\n \"apple\": 28.57142857142857,\n \"banana\": 57.14285714285714,\n \"null\": 14.285714285714285\n },\n \"coverageCount\": 7,\n \"nullCount\": 0,\n \"possibleDependentVariableTypes\": [\n \"multinomial\",\n \"ordinal\"\n ],\n \"useableAsIndependentVariable\": true,\n \"useableAsPrimaryKey\": false,\n \"valueDistribution\": {\n \"apple\": 2,\n \"banana\": 4,\n \"null\": 1\n },\n \"distinctCount\": 3\n },\n {\n \"name\": \"ladders\",\n \"civisDataType\": \"string\",\n \"sqlType\": \"character varying(256)\",\n \"sampleValues\": [\n\n ],\n \"encoding\": null,\n \"description\": \"this is not a pipe\",\n \"order\": 2,\n \"minValue\": null,\n \"maxValue\": null,\n \"avgValue\": null,\n \"stddev\": null,\n \"valueDistributionPercent\": {\n },\n \"coverageCount\": null,\n \"nullCount\": null,\n \"possibleDependentVariableTypes\": [\n\n ],\n \"useableAsIndependentVariable\": false,\n \"useableAsPrimaryKey\": false,\n \"valueDistribution\": {\n },\n \"distinctCount\": 0\n }\n ],\n \"joins\": [\n\n ],\n \"multipartKey\": [\n \"address_id\"\n ],\n \"enhancements\": [\n\n ],\n \"viewDef\": null,\n \"tableDef\": \"CREATE TABLE \\\"schema_name\\\".\\\"table_name220\\\" (\\n \\\"snakes\\\" CHARACTER VARYING(256) NULL,\\n \\\"ladders\\\" CHARACTER VARYING(256) NULL\\n)\\nDISTSTYLE AUTO;\\n\",\n \"outgoingTableMatches\": [\n\n ]\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"5e0347b8071ab250bb1d0ec7c521b31f\"","X-Request-Id":"e0fd33e2-32af-40f2-acae-bbd82d4e7dc7","X-Runtime":"0.062746","Content-Length":"1739"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/tables/203\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer GPdK3RrDWkysMRTR0m_O71ehYqz5rxs3_y15Xq7OU94\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"patch":{"summary":"Update a table","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the table.","type":"integer"},{"name":"Object675","in":"body","schema":{"$ref":"#/definitions/Object675"},"required":false}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object676"}}},"x-examples":[{"resource":"Tables","resource_explanation":null,"http_method":"PATCH","route":"http://api.civis.test/tables/:id","description":"Update a table via PATCH","explanation":null,"parameters":[{"required":false,"name":"ontologyMapping","description":"The ontology-key to column-name mapping. See /ontology for the list of valid ontology keys."},{"required":true,"name":"id","description":"The ID of the table."},{"required":false,"name":"description","description":"The user-defined description of the table."},{"required":false,"name":"primaryKeys","description":"A list of column(s) which together uniquely identify a row in the data.These columns must not contain NULL values."},{"required":false,"name":"lastModifiedKeys","description":"The columns indicating when a row was last modified."}],"response_fields":[],"requests":[{"request_method":"PATCH","request_path":"http://api.civis.test/tables/208","request_body":"{\n \"ontology_mapping\": {\n \"primary_key\": \"MyString\"\n },\n \"primary_keys\": [\n \"MyString\"\n ],\n \"last_modified_keys\": [\n \"MyString\"\n ],\n \"description\": \"Custom table description text.\"\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer owg_tN08VIg5bbSL7FdoE_2uJ66vyiR5hb9SZYydwmg","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 208,\n \"databaseId\": 285,\n \"schema\": \"schema_name\",\n \"name\": \"table_name231\",\n \"description\": \"Custom table description text.\",\n \"isView\": false,\n \"rowCount\": 1,\n \"columnCount\": 1,\n \"sizeMb\": null,\n \"owner\": \"dbadmin\",\n \"distkey\": null,\n \"sortkeys\": null,\n \"refreshStatus\": \"current\",\n \"lastRefresh\": null,\n \"dataUpdatedAt\": null,\n \"schemaUpdatedAt\": null,\n \"refreshId\": null,\n \"lastRun\": null,\n \"primaryKeys\": [\n \"MyString\"\n ],\n \"lastModifiedKeys\": [\n \"MyString\"\n ],\n \"tableTags\": [\n\n ],\n \"ontologyMapping\": {\n \"primary_key\": \"MyString\"\n }\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"3fec011eb8951ee45d5a4a9b62762cf2\"","X-Request-Id":"bd5e8d6e-43ec-4a9a-9b52-d01116469bc8","X-Runtime":"0.036777","Content-Length":"467"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/tables/208\" -d '{\"ontology_mapping\":{\"primary_key\":\"MyString\"},\"primary_keys\":[\"MyString\"],\"last_modified_keys\":[\"MyString\"],\"description\":\"Custom table description text.\"}' -X PATCH \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer owg_tN08VIg5bbSL7FdoE_2uJ66vyiR5hb9SZYydwmg\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Tables","resource_explanation":null,"http_method":"PATCH","route":"http://api.civis.test/tables/:id","description":"Map a column to multiple ontologies","explanation":null,"parameters":[{"required":false,"name":"ontologyMapping","description":"The ontology-key to column-name mapping. See /ontology for the list of valid ontology keys."},{"required":true,"name":"id","description":"The ID of the table."},{"required":false,"name":"description","description":"The user-defined description of the table."},{"required":false,"name":"primaryKeys","description":"A list of column(s) which together uniquely identify a row in the data.These columns must not contain NULL values."},{"required":false,"name":"lastModifiedKeys","description":"The columns indicating when a row was last modified."}],"response_fields":[],"requests":[{"request_method":"PATCH","request_path":"http://api.civis.test/tables/209","request_body":"{\n \"ontology_mapping\": {\n \"primary_key\": \"MyString\",\n \"first_name\": \"MyString\"\n }\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer J7lTGoRcBUY_ICZbPVeDTUYq4okNvsQSHntguvrFWS4","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 209,\n \"databaseId\": 286,\n \"schema\": \"schema_name\",\n \"name\": \"table_name232\",\n \"description\": null,\n \"isView\": false,\n \"rowCount\": 1,\n \"columnCount\": 1,\n \"sizeMb\": null,\n \"owner\": \"dbadmin\",\n \"distkey\": null,\n \"sortkeys\": null,\n \"refreshStatus\": \"current\",\n \"lastRefresh\": null,\n \"dataUpdatedAt\": null,\n \"schemaUpdatedAt\": null,\n \"refreshId\": null,\n \"lastRun\": null,\n \"primaryKeys\": [\n\n ],\n \"lastModifiedKeys\": [\n\n ],\n \"tableTags\": [\n\n ],\n \"ontologyMapping\": {\n \"primary_key\": \"MyString\",\n \"first_name\": \"MyString\"\n }\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"506e51ba45bf9e3002d80fedab0ea797\"","X-Request-Id":"5845d18f-5ba0-467d-aeb0-6699c8bfb3cd","X-Runtime":"0.033189","Content-Length":"443"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/tables/209\" -d '{\"ontology_mapping\":{\"primary_key\":\"MyString\",\"first_name\":\"MyString\"}}' -X PATCH \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer J7lTGoRcBUY_ICZbPVeDTUYq4okNvsQSHntguvrFWS4\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/tables/{id}/columns":{"get":{"summary":"List columns in the specified table","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"type":"integer"},{"name":"name","in":"query","required":false,"description":"Search for columns with the given name, within the specified table.","type":"string"},{"name":"limit","in":"query","required":false,"description":"Number of results to return. Defaults to its maximum of 50.","type":"integer"},{"name":"page_num","in":"query","required":false,"description":"Page number of the results to return. Defaults to the first page, 1.","type":"integer"},{"name":"order","in":"query","required":false,"description":"The field on which to order the result set. Defaults to name. Must be one of: name, order.","type":"string"},{"name":"order_dir","in":"query","required":false,"description":"Direction in which to sort, either asc (ascending) or desc (descending) defaulting to asc.","type":"string"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object76"}}}},"x-examples":[{"resource":"Tables","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/tables/:id/columns","description":"List columns","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/tables/205/columns","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer s6Ops-F_C4-hsJqareQw0OYxIILV4rL_DvHEF_pd9_o","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"name\": \"snakes\",\n \"civisDataType\": \"string\",\n \"sqlType\": \"character varying(256)\",\n \"sampleValues\": [\n\n ],\n \"encoding\": null,\n \"description\": \"this is not a pipe\",\n \"order\": 1,\n \"minValue\": \"apple\",\n \"maxValue\": \"banana\",\n \"avgValue\": null,\n \"stddev\": null,\n \"valueDistributionPercent\": {\n \"apple\": 28.57142857142857,\n \"banana\": 57.14285714285714,\n \"null\": 14.285714285714285\n },\n \"coverageCount\": 7,\n \"nullCount\": 0,\n \"possibleDependentVariableTypes\": [\n \"multinomial\",\n \"ordinal\"\n ],\n \"useableAsIndependentVariable\": true,\n \"useableAsPrimaryKey\": false,\n \"valueDistribution\": {\n \"apple\": 2,\n \"banana\": 4,\n \"null\": 1\n },\n \"distinctCount\": 3\n },\n {\n \"name\": \"ladders\",\n \"civisDataType\": \"string\",\n \"sqlType\": \"character varying(256)\",\n \"sampleValues\": [\n\n ],\n \"encoding\": null,\n \"description\": \"this is not a pipe\",\n \"order\": 2,\n \"minValue\": null,\n \"maxValue\": null,\n \"avgValue\": null,\n \"stddev\": null,\n \"valueDistributionPercent\": {\n },\n \"coverageCount\": null,\n \"nullCount\": null,\n \"possibleDependentVariableTypes\": [\n\n ],\n \"useableAsIndependentVariable\": false,\n \"useableAsPrimaryKey\": false,\n \"valueDistribution\": {\n },\n \"distinctCount\": 0\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","X-Pagination-Per-Page":"50","Access-Control-Expose-Headers":"X-Pagination-Per-Page, X-Pagination-Current-Page, X-Pagination-Total-Pages, X-Pagination-Total-Entries","X-Pagination-Current-Page":"1","X-Pagination-Total-Pages":"1","X-Pagination-Total-Entries":"2","Content-Type":"application/json; charset=utf-8","ETag":"W/\"c0a0e503fccc7c7d6f2cbf4ddf9a1c71\"","X-Request-Id":"51f544bd-f010-482f-a753-e17b17747659","X-Runtime":"0.037745","Content-Length":"990"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/tables/205/columns\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer s6Ops-F_C4-hsJqareQw0OYxIILV4rL_DvHEF_pd9_o\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Tables","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/tables/:id/columns?name=ladders","description":"Filter columns","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/tables/207/columns?name=ladders","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer wwVGRodYSSs3mT8Mies_MmUbHQB0Zer6vikllEfjFLk","Host":"api.civis.test","Cookie":""},"request_query_parameters":{"name":"ladders"},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"name\": \"ladders\",\n \"civisDataType\": \"string\",\n \"sqlType\": \"character varying(256)\",\n \"sampleValues\": [\n\n ],\n \"encoding\": null,\n \"description\": \"this is not a pipe\",\n \"order\": 2,\n \"minValue\": null,\n \"maxValue\": null,\n \"avgValue\": null,\n \"stddev\": null,\n \"valueDistributionPercent\": {\n },\n \"coverageCount\": null,\n \"nullCount\": null,\n \"possibleDependentVariableTypes\": [\n\n ],\n \"useableAsIndependentVariable\": false,\n \"useableAsPrimaryKey\": false,\n \"valueDistribution\": {\n },\n \"distinctCount\": 0\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","X-Pagination-Per-Page":"50","Access-Control-Expose-Headers":"X-Pagination-Per-Page, X-Pagination-Current-Page, X-Pagination-Total-Pages, X-Pagination-Total-Entries","X-Pagination-Current-Page":"1","X-Pagination-Total-Pages":"1","X-Pagination-Total-Entries":"1","Content-Type":"application/json; charset=utf-8","ETag":"W/\"f9fac11c115beeeb2477dc0c62a677ab\"","X-Request-Id":"1e0a8079-9cd7-4398-8461-ed5aff43f1fd","X-Runtime":"0.030280","Content-Length":"431"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/tables/207/columns?name=ladders\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer wwVGRodYSSs3mT8Mies_MmUbHQB0Zer6vikllEfjFLk\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/tables/{id}/tags/{table_tag_id}":{"put":{"summary":"Add a tag to a table","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the table.","type":"integer"},{"name":"table_tag_id","in":"path","required":true,"description":"The ID of the tag.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object677"}}},"x-examples":[{"resource":"Tables","resource_explanation":null,"http_method":"PUT","route":"http://api.civis.test/tables/:id/tags/:table_tag_id","description":"Add a tag to a table","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"PUT","request_path":"http://api.civis.test/tables/221/tags/16","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer GI1fRnOteX6zdBYrvCfJ9ZgPLjIUIkuMk3dJl4IiOPw","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 221,\n \"tableTagId\": 16\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"fe6dcf164d11b3a6f9f5aaccff1e457f\"","X-Request-Id":"b4bb9b35-4052-460e-a7c7-729064f31edb","X-Runtime":"0.043556","Content-Length":"26"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/tables/221/tags/16\" -d '' -X PUT \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer GI1fRnOteX6zdBYrvCfJ9ZgPLjIUIkuMk3dJl4IiOPw\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"delete":{"summary":"Add a tag to a table","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the table.","type":"integer"},{"name":"table_tag_id","in":"path","required":true,"description":"The ID of the tag.","type":"integer"}],"responses":{"200":{"description":"success"}},"x-examples":[{"resource":"Tables","resource_explanation":null,"http_method":"DELETE","route":"http://api.civis.test/tables/:id/tags/:table_tag_id","description":"Remove a tag from a table","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"DELETE","request_path":"http://api.civis.test/tables/222/tags/18","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer ImlYbEc2vqFA4ophrEgrQ-v9cZKpFiHCMGc6JyZPyak","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":null,"response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"text/plain; charset=utf-8","X-Request-Id":"3e03f43f-a325-40b3-aa69-17ae51d87939","X-Runtime":"0.036939","Content-Length":"0"},"response_content_type":"text/plain; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/tables/222/tags/18\" -d '' -X DELETE \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer ImlYbEc2vqFA4ophrEgrQ-v9cZKpFiHCMGc6JyZPyak\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/tables/{id}/projects":{"get":{"summary":"List the projects a Table belongs to","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Table.","type":"integer"},{"name":"hidden","in":"query","required":false,"description":"If specified to be true, returns hidden items. Defaults to false, returning non-hidden items.","type":"boolean"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object84"}}}},"x-examples":null,"x-deprecation-warning":null}},"/tables/{id}/projects/{project_id}":{"put":{"summary":"Add a Table to a project","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Table.","type":"integer"},{"name":"project_id","in":"path","required":true,"description":"The ID of the project.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null},"delete":{"summary":"Remove a Table from a project","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Table.","type":"integer"},{"name":"project_id","in":"path","required":true,"description":"The ID of the project.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/templates/reports/{id}/shares":{"get":{"summary":"List users and groups permissioned on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object9"}}}},"x-examples":null,"x-deprecation-warning":null}},"/templates/reports/{id}/shares/users":{"put":{"summary":"Set the permissions users have on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"Object678","in":"body","schema":{"$ref":"#/definitions/Object678"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object9"}}},"x-examples":null,"x-deprecation-warning":null}},"/templates/reports/{id}/shares/users/{user_id}":{"delete":{"summary":"Revoke the permissions a user has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"user_id","in":"path","required":true,"description":"The ID of the user.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/templates/reports/{id}/shares/groups":{"put":{"summary":"Set the permissions groups has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"Object679","in":"body","schema":{"$ref":"#/definitions/Object679"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object9"}}},"x-examples":null,"x-deprecation-warning":null}},"/templates/reports/{id}/shares/groups/{group_id}":{"delete":{"summary":"Revoke the permissions a group has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"group_id","in":"path","required":true,"description":"The ID of the group.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/templates/reports/{id}/dependencies":{"get":{"summary":"List dependent objects for this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"user_id","in":"query","required":false,"description":"ID of target user","type":"integer"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object15"}}}},"x-examples":null,"x-deprecation-warning":null}},"/templates/reports/{id}/transfer":{"put":{"summary":"Transfer ownership of this object to another user","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"Object680","in":"body","schema":{"$ref":"#/definitions/Object680"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object17"}}},"x-examples":null,"x-deprecation-warning":null}},"/templates/reports/":{"get":{"summary":"List Report Templates","description":null,"deprecated":false,"parameters":[{"name":"hidden","in":"query","required":false,"description":"If specified to be true, returns hidden items. Defaults to false, returning non-hidden items.","type":"boolean"},{"name":"author","in":"query","required":false,"description":"If specified, return items from any of these authors. It accepts a comma-separated list of user IDs.","type":"string"},{"name":"category","in":"query","required":false,"description":"A category to filter results by, one of: dataset-viz","type":"string"},{"name":"limit","in":"query","required":false,"description":"Number of results to return. Defaults to 50. Maximum allowed is 1000.","type":"integer"},{"name":"page_num","in":"query","required":false,"description":"Page number of the results to return. Defaults to the first page, 1.","type":"integer"},{"name":"order","in":"query","required":false,"description":"The field on which to order the result set. Defaults to name. Must be one of: name, updated_at, created_at.","type":"string"},{"name":"order_dir","in":"query","required":false,"description":"Direction in which to sort, either asc (ascending) or desc (descending) defaulting to asc.","type":"string"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object681"}}}},"x-examples":[{"resource":"Template::Report","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/templates/reports","description":"List all templates","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/templates/reports","request_body":null,"request_headers":{"Content-Type":"application/json","Authorization":"Bearer XYCNnLSK_dJ5m1EAXU26j7hoUQZU9PyPTwuWCAsIHuo","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 167,\n \"name\": \"awesome HTML template\",\n \"category\": null,\n \"createdAt\": \"2016-01-01T00:00:00.000Z\",\n \"updatedAt\": \"2023-07-18T18:46:26.000Z\",\n \"useCount\": 0,\n \"archived\": false,\n \"techReviewed\": false,\n \"author\": {\n \"id\": 4584,\n \"name\": \"Manager devmanagerfactory1 1\",\n \"username\": \"devmanagerfactory1\",\n \"initials\": \"MD\",\n \"online\": null\n }\n },\n {\n \"id\": 168,\n \"name\": \"awesome HTML template\",\n \"category\": \"dataset-viz\",\n \"createdAt\": \"2016-02-01T00:00:00.000Z\",\n \"updatedAt\": \"2023-07-18T18:46:26.000Z\",\n \"useCount\": 0,\n \"archived\": false,\n \"techReviewed\": false,\n \"author\": {\n \"id\": 4584,\n \"name\": \"Manager devmanagerfactory1 1\",\n \"username\": \"devmanagerfactory1\",\n \"initials\": \"MD\",\n \"online\": null\n }\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","X-Pagination-Per-Page":"50","Access-Control-Expose-Headers":"X-Pagination-Per-Page, X-Pagination-Current-Page, X-Pagination-Total-Pages, X-Pagination-Total-Entries","X-Pagination-Current-Page":"1","X-Pagination-Total-Pages":"1","X-Pagination-Total-Entries":"2","Content-Type":"application/json; charset=utf-8","ETag":"W/\"c7b5d7634e7307c1d6acd75e1b447840\"","X-Request-Id":"df8fd844-b6d4-4552-adc1-423799c4344c","X-Runtime":"0.019160","Content-Length":"626"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/templates/reports\" -X GET \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer XYCNnLSK_dJ5m1EAXU26j7hoUQZU9PyPTwuWCAsIHuo\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Template::Report","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/templates/reports?category=dataset-viz","description":"List all dataset-viz templates","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/templates/reports?category=dataset-viz","request_body":null,"request_headers":{"Content-Type":"application/json","Authorization":"Bearer Xk_jHKBTegbrEjg0Pu3myS9YJDO4HBWKDMokdaz2aB4","Host":"api.civis.test","Cookie":""},"request_query_parameters":{"category":"dataset-viz"},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 169,\n \"name\": \"awesome HTML template\",\n \"category\": \"dataset-viz\",\n \"createdAt\": \"2016-02-01T00:00:00.000Z\",\n \"updatedAt\": \"2023-07-18T18:46:26.000Z\",\n \"useCount\": 0,\n \"archived\": false,\n \"techReviewed\": false,\n \"author\": {\n \"id\": 4585,\n \"name\": \"Manager devmanagerfactory2 2\",\n \"username\": \"devmanagerfactory2\",\n \"initials\": \"MD\",\n \"online\": null\n }\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","X-Pagination-Per-Page":"50","Access-Control-Expose-Headers":"X-Pagination-Per-Page, X-Pagination-Current-Page, X-Pagination-Total-Pages, X-Pagination-Total-Entries","X-Pagination-Current-Page":"1","X-Pagination-Total-Pages":"1","X-Pagination-Total-Entries":"1","Content-Type":"application/json; charset=utf-8","ETag":"W/\"154c6afd59a2d1c12ba68bacbfa6ed1d\"","X-Request-Id":"a2ed4578-7821-489f-ae4b-15a5c5d0bd2d","X-Runtime":"0.015982","Content-Length":"318"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/templates/reports?category=dataset-viz\" -X GET \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer Xk_jHKBTegbrEjg0Pu3myS9YJDO4HBWKDMokdaz2aB4\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"post":{"summary":"Create a Report Template","description":null,"deprecated":false,"parameters":[{"name":"Object682","in":"body","schema":{"$ref":"#/definitions/Object682"},"required":true}],"responses":{"201":{"description":"success","schema":{"$ref":"#/definitions/Object683"}}},"x-examples":[{"resource":"Template::Report","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/templates/reports","description":"Create a report template","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/templates/reports","request_body":"{\n \"code_body\": \"Report HTML\",\n \"name\": \"My new Report Template\"\n}","request_headers":{"Content-Type":"application/json","Authorization":"Bearer 4BVYAYHKsAhqub8Qx_IVsnxPjrAOrvEWTzOJnbRh_II","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":201,"response_status_text":"Created","response_body":"{\n \"id\": 170,\n \"name\": \"My new Report Template\",\n \"category\": null,\n \"createdAt\": \"2023-07-18T18:46:26.000Z\",\n \"updatedAt\": \"2023-07-18T18:46:26.000Z\",\n \"useCount\": 0,\n \"archived\": false,\n \"techReviewed\": false,\n \"author\": {\n \"id\": 4586,\n \"name\": \"Manager devmanagerfactory3 3\",\n \"username\": \"devmanagerfactory3\",\n \"initials\": \"MD\",\n \"online\": null\n },\n \"authCodeUrl\": \"auth_code_url\",\n \"provideAPIKey\": null,\n \"hidden\": false\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"5bee4f780214066ce954173b44690872\"","X-Request-Id":"3d2c7678-4448-47a9-b6b7-ed960140500e","X-Runtime":"0.281233","Content-Length":"374"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/templates/reports\" -d '{\"code_body\":\"\\u003cbody\\u003eReport HTML\\u003c/body\\u003e\",\"name\":\"My new Report Template\"}' -X POST \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer 4BVYAYHKsAhqub8Qx_IVsnxPjrAOrvEWTzOJnbRh_II\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/templates/reports/{id}":{"get":{"summary":"Get a Report Template","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object683"}}},"x-examples":[{"resource":"Template::Report","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/templates/reports/:id","description":"Show details of a report","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/templates/reports/175","request_body":null,"request_headers":{"Content-Type":"application/json","Authorization":"Bearer QUAbYLDdDkbyYINkH3lhrYakiElMlv7SKtKynFHTZmU","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 175,\n \"name\": \"awesome HTML template\",\n \"category\": null,\n \"createdAt\": \"2016-01-01T00:00:00.000Z\",\n \"updatedAt\": \"2023-07-18T18:46:28.000Z\",\n \"useCount\": 0,\n \"archived\": false,\n \"techReviewed\": false,\n \"author\": {\n \"id\": 4591,\n \"name\": \"Manager devmanagerfactory8 8\",\n \"username\": \"devmanagerfactory8\",\n \"initials\": \"MD\",\n \"online\": null\n },\n \"authCodeUrl\": \"auth_code_url\",\n \"provideAPIKey\": null,\n \"hidden\": false\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"ba9737618562644ca0d87bf7435400af\"","X-Request-Id":"2c2f017b-e3d1-425c-8e93-190e801cfd11","X-Runtime":"0.015639","Content-Length":"373"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/templates/reports/175\" -X GET \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer QUAbYLDdDkbyYINkH3lhrYakiElMlv7SKtKynFHTZmU\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"put":{"summary":"Replace all attributes of this Report Template","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"type":"integer"},{"name":"Object684","in":"body","schema":{"$ref":"#/definitions/Object684"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object683"}}},"x-examples":null,"x-deprecation-warning":null},"patch":{"summary":"Update some attributes of this Report Template","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"type":"integer"},{"name":"Object685","in":"body","schema":{"$ref":"#/definitions/Object685"},"required":false}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object683"}}},"x-examples":[{"resource":"Template::Report","resource_explanation":null,"http_method":"PATCH","route":"http://api.civis.test/templates/reports/:id","description":"Update a report template","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"PATCH","request_path":"http://api.civis.test/templates/reports/171","request_body":"{\n \"code_body\": \"Updated Report template body\",\n \"name\": \"My updated Report Template\"\n}","request_headers":{"Content-Type":"application/json","Authorization":"Bearer lrN34GNLaph2HtHTshT8oLHvQJuXeepXanVi09GhFXg","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 171,\n \"name\": \"My updated Report Template\",\n \"category\": null,\n \"createdAt\": \"2016-01-01T00:00:00.000Z\",\n \"updatedAt\": \"2023-07-18T18:46:27.000Z\",\n \"useCount\": 0,\n \"archived\": false,\n \"techReviewed\": false,\n \"author\": {\n \"id\": 4587,\n \"name\": \"Manager devmanagerfactory4 4\",\n \"username\": \"devmanagerfactory4\",\n \"initials\": \"MD\",\n \"online\": null\n },\n \"authCodeUrl\": \"auth_code_url\",\n \"provideAPIKey\": null,\n \"hidden\": false\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"1774fce90e110b2f807b3e8dcf9aafe2\"","X-Request-Id":"c49a5b14-8a56-48fe-9ad4-fc2630693330","X-Runtime":"0.099149","Content-Length":"378"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/templates/reports/171\" -d '{\"code_body\":\"\\u003cbody\\u003eUpdated Report template body\\u003c/body\\u003e\",\"name\":\"My updated Report Template\"}' -X PATCH \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer lrN34GNLaph2HtHTshT8oLHvQJuXeepXanVi09GhFXg\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Template::Report","resource_explanation":null,"http_method":"PATCH","route":"http://api.civis.test/templates/reports/:id","description":"Update a report template with invalid category","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"PATCH","request_path":"http://api.civis.test/templates/reports/172","request_body":"{\n \"code_body\": \"Updated Report template body\",\n \"name\": \"My updated Report Template\",\n \"category\": \"invalid\"\n}","request_headers":{"Content-Type":"application/json","Authorization":"Bearer TA-vjrhXEbhxO1kDiABXkE76zEhin1wuK3Rvii2cxHU","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":400,"response_status_text":"Bad Request","response_body":"{\n \"error\": \"bad_request\",\n \"errorDescription\": \"The given request was not as expected: Validation failed: Category is not included in the list\",\n \"code\": 400\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","X-Request-Id":"50457196-8e6d-429b-8a96-8c0467952ccd","X-Runtime":"0.015771","Content-Length":"150"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/templates/reports/172\" -d '{\"code_body\":\"\\u003cbody\\u003eUpdated Report template body\\u003c/body\\u003e\",\"name\":\"My updated Report Template\",\"category\":\"invalid\"}' -X PATCH \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer TA-vjrhXEbhxO1kDiABXkE76zEhin1wuK3Rvii2cxHU\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Template::Report","resource_explanation":null,"http_method":"PATCH","route":"http://api.civis.test/templates/reports/:id","description":"Archive a report template","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"PATCH","request_path":"http://api.civis.test/templates/reports/173","request_body":"{\n \"archived\": true\n}","request_headers":{"Content-Type":"application/json","Authorization":"Bearer x0bbidOO4HhemYiw8R2SKQgJbBxudTFoFVSatJSwLVY","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 173,\n \"name\": \"awesome HTML template\",\n \"category\": null,\n \"createdAt\": \"2016-01-01T00:00:00.000Z\",\n \"updatedAt\": \"2023-07-18T18:46:27.000Z\",\n \"useCount\": 0,\n \"archived\": true,\n \"techReviewed\": false,\n \"author\": {\n \"id\": 4589,\n \"name\": \"Manager devmanagerfactory6 6\",\n \"username\": \"devmanagerfactory6\",\n \"initials\": \"MD\",\n \"online\": null\n },\n \"authCodeUrl\": \"auth_code_url\",\n \"provideAPIKey\": null,\n \"hidden\": false\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"4e8f6867085f9b60fe2acf1bbd3c2168\"","X-Request-Id":"85cbdec2-0e86-423a-8813-4d0036e5e009","X-Runtime":"0.026794","Content-Length":"372"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/templates/reports/173\" -d '{\"archived\":true}' -X PATCH \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer x0bbidOO4HhemYiw8R2SKQgJbBxudTFoFVSatJSwLVY\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Template::Report","resource_explanation":null,"http_method":"PATCH","route":"http://api.civis.test/templates/reports/:id","description":"Unarchive a report template","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"PATCH","request_path":"http://api.civis.test/templates/reports/174","request_body":"{\n \"archived\": false\n}","request_headers":{"Content-Type":"application/json","Authorization":"Bearer LgvtT63TVIhamIBMycXAA1AqMXpx7DA7D7hm3m9KsSc","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 174,\n \"name\": \"awesome HTML template\",\n \"category\": null,\n \"createdAt\": \"2016-01-01T00:00:00.000Z\",\n \"updatedAt\": \"2023-07-18T18:46:27.000Z\",\n \"useCount\": 0,\n \"archived\": false,\n \"techReviewed\": false,\n \"author\": {\n \"id\": 4590,\n \"name\": \"Manager devmanagerfactory7 7\",\n \"username\": \"devmanagerfactory7\",\n \"initials\": \"MD\",\n \"online\": null\n },\n \"authCodeUrl\": \"auth_code_url\",\n \"provideAPIKey\": null,\n \"hidden\": false\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"24c74d86bca400fd0d47037737133deb\"","X-Request-Id":"96042f19-7275-404e-9c94-f1d63670d77c","X-Runtime":"0.026899","Content-Length":"373"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/templates/reports/174\" -d '{\"archived\":false}' -X PATCH \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer LgvtT63TVIhamIBMycXAA1AqMXpx7DA7D7hm3m9KsSc\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"delete":{"summary":"Archive a Report Template (deprecated, use archiving endpoints instead)","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/templates/scripts/{id}/shares":{"get":{"summary":"List users and groups permissioned on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object9"}}}},"x-examples":null,"x-deprecation-warning":null}},"/templates/scripts/{id}/shares/users":{"put":{"summary":"Set the permissions users have on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"Object687","in":"body","schema":{"$ref":"#/definitions/Object687"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object9"}}},"x-examples":null,"x-deprecation-warning":null}},"/templates/scripts/{id}/shares/users/{user_id}":{"delete":{"summary":"Revoke the permissions a user has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"user_id","in":"path","required":true,"description":"The ID of the user.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/templates/scripts/{id}/shares/groups":{"put":{"summary":"Set the permissions groups has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"Object688","in":"body","schema":{"$ref":"#/definitions/Object688"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object9"}}},"x-examples":null,"x-deprecation-warning":null}},"/templates/scripts/{id}/shares/groups/{group_id}":{"delete":{"summary":"Revoke the permissions a group has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"group_id","in":"path","required":true,"description":"The ID of the group.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/templates/scripts/{id}/dependencies":{"get":{"summary":"List dependent objects for this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"user_id","in":"query","required":false,"description":"ID of target user","type":"integer"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object15"}}}},"x-examples":null,"x-deprecation-warning":null}},"/templates/scripts/{id}/transfer":{"put":{"summary":"Transfer ownership of this object to another user","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"Object689","in":"body","schema":{"$ref":"#/definitions/Object689"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object17"}}},"x-examples":null,"x-deprecation-warning":null}},"/templates/scripts/{id}/projects":{"get":{"summary":"List the projects a Script Template belongs to","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Script Template.","type":"integer"},{"name":"hidden","in":"query","required":false,"description":"If specified to be true, returns hidden items. Defaults to false, returning non-hidden items.","type":"boolean"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object84"}}}},"x-examples":null,"x-deprecation-warning":null}},"/templates/scripts/{id}/projects/{project_id}":{"put":{"summary":"Add a Script Template to a project","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Script Template.","type":"integer"},{"name":"project_id","in":"path","required":true,"description":"The ID of the project.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null},"delete":{"summary":"Remove a Script Template from a project","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Script Template.","type":"integer"},{"name":"project_id","in":"path","required":true,"description":"The ID of the project.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/templates/scripts/":{"get":{"summary":"List Script Templates","description":null,"deprecated":false,"parameters":[{"name":"hidden","in":"query","required":false,"description":"If specified to be true, returns hidden items. Defaults to false, returning non-hidden items.","type":"boolean"},{"name":"author","in":"query","required":false,"description":"If specified, return items from any of these authors. It accepts a comma-separated list of user IDs.","type":"string"},{"name":"category","in":"query","required":false,"description":"A category to filter results by, one of: import, export, enhancement, model, and script","type":"string"},{"name":"limit","in":"query","required":false,"description":"Number of results to return. Defaults to 50. Maximum allowed is 1000.","type":"integer"},{"name":"page_num","in":"query","required":false,"description":"Page number of the results to return. Defaults to the first page, 1.","type":"integer"},{"name":"order","in":"query","required":false,"description":"The field on which to order the result set. Defaults to name. Must be one of: name, updated_at, created_at.","type":"string"},{"name":"order_dir","in":"query","required":false,"description":"Direction in which to sort, either asc (ascending) or desc (descending) defaulting to asc.","type":"string"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object690"}}}},"x-examples":[{"resource":"Template::Script","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/templates/scripts","description":"List all templates","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/templates/scripts","request_body":null,"request_headers":{"Content-Type":"application/json","Authorization":"Bearer RR4qrANSa0iTABK5HQLJr0fLyhpdh7ULtFWoSxeQkdw","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 177,\n \"public\": false,\n \"scriptId\": 3256,\n \"userContext\": \"runner\",\n \"name\": \"awesome sql template\",\n \"category\": \"script\",\n \"createdAt\": \"2023-07-18T18:46:29.000Z\",\n \"updatedAt\": \"2023-07-18T18:46:29.000Z\",\n \"useCount\": 0,\n \"uiReportId\": null,\n \"techReviewed\": false,\n \"archived\": false,\n \"author\": {\n \"id\": 4594,\n \"name\": \"User devuserfactory3091 3089\",\n \"username\": \"devuserfactory3091\",\n \"initials\": \"UD\",\n \"online\": null\n }\n },\n {\n \"id\": 179,\n \"public\": false,\n \"scriptId\": 3272,\n \"userContext\": \"runner\",\n \"name\": \"awesome sql template\",\n \"category\": \"import\",\n \"createdAt\": \"2023-07-18T18:46:30.000Z\",\n \"updatedAt\": \"2023-07-18T18:46:30.000Z\",\n \"useCount\": 0,\n \"uiReportId\": null,\n \"techReviewed\": false,\n \"archived\": false,\n \"author\": {\n \"id\": 4594,\n \"name\": \"User devuserfactory3091 3089\",\n \"username\": \"devuserfactory3091\",\n \"initials\": \"UD\",\n \"online\": null\n }\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","X-Pagination-Per-Page":"50","Access-Control-Expose-Headers":"X-Pagination-Per-Page, X-Pagination-Current-Page, X-Pagination-Total-Pages, X-Pagination-Total-Entries","X-Pagination-Current-Page":"1","X-Pagination-Total-Pages":"1","X-Pagination-Total-Entries":"2","Content-Type":"application/json; charset=utf-8","ETag":"W/\"cd816299653e31dc239bc225762d37a6\"","X-Request-Id":"34b14964-ae4c-4284-a31f-12051d785c81","X-Runtime":"0.023030","Content-Length":"767"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/templates/scripts\" -X GET \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer RR4qrANSa0iTABK5HQLJr0fLyhpdh7ULtFWoSxeQkdw\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Template::Script","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/templates/scripts","description":"Filter templates by category","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/templates/scripts?category=import","request_body":null,"request_headers":{"Content-Type":"application/json","Authorization":"Bearer b7n8iXZFKHgLdQRizyEAd8D3912FHHqBXY3W5Exy138","Host":"api.civis.test","Cookie":""},"request_query_parameters":{"category":"import"},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 182,\n \"public\": false,\n \"scriptId\": 3295,\n \"userContext\": \"runner\",\n \"name\": \"awesome sql template\",\n \"category\": \"import\",\n \"createdAt\": \"2023-07-18T18:46:32.000Z\",\n \"updatedAt\": \"2023-07-18T18:46:32.000Z\",\n \"useCount\": 0,\n \"uiReportId\": null,\n \"techReviewed\": false,\n \"archived\": false,\n \"author\": {\n \"id\": 4616,\n \"name\": \"User devuserfactory3106 3104\",\n \"username\": \"devuserfactory3106\",\n \"initials\": \"UD\",\n \"online\": null\n }\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","X-Pagination-Per-Page":"50","Access-Control-Expose-Headers":"X-Pagination-Per-Page, X-Pagination-Current-Page, X-Pagination-Total-Pages, X-Pagination-Total-Entries","X-Pagination-Current-Page":"1","X-Pagination-Total-Pages":"1","X-Pagination-Total-Entries":"1","Content-Type":"application/json; charset=utf-8","ETag":"W/\"b63f1005ff9112312696d2ce5711bcd9\"","X-Request-Id":"762522de-e2b2-44c7-8c05-e00f193ab9f7","X-Runtime":"0.019328","Content-Length":"384"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/templates/scripts?category=import\" -X GET \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer b7n8iXZFKHgLdQRizyEAd8D3912FHHqBXY3W5Exy138\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"post":{"summary":"Create a Script Template","description":null,"deprecated":false,"parameters":[{"name":"Object691","in":"body","schema":{"$ref":"#/definitions/Object691"},"required":true}],"responses":{"201":{"description":"success","schema":{"$ref":"#/definitions/Object692"}}},"x-examples":[{"resource":"Template::Script","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/templates/scripts","description":"Create a script template","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/templates/scripts","request_body":"{\n \"script_id\": 3315,\n \"name\": \"Script #3315\"\n}","request_headers":{"Content-Type":"application/json","Authorization":"Bearer d8K_u-QaG7nKWyihMvPe7I9Vcq3lNbKvdvUAAVxIlUI","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":201,"response_status_text":"Created","response_body":"{\n \"id\": 185,\n \"public\": false,\n \"scriptId\": 3315,\n \"scriptType\": \"R\",\n \"userContext\": \"runner\",\n \"params\": [\n {\n \"name\": \"id\",\n \"label\": \"ID\",\n \"description\": null,\n \"type\": \"integer\",\n \"required\": true,\n \"value\": null,\n \"default\": null,\n \"allowedValues\": [\n\n ]\n },\n {\n \"name\": \"state\",\n \"label\": \"State\",\n \"description\": null,\n \"type\": \"string\",\n \"required\": true,\n \"value\": null,\n \"default\": null,\n \"allowedValues\": [\n\n ]\n },\n {\n \"name\": \"a_multi_line_string\",\n \"label\": \"A Multi-line String\",\n \"description\": null,\n \"type\": \"multi_line_string\",\n \"required\": false,\n \"value\": null,\n \"default\": null,\n \"allowedValues\": [\n\n ]\n },\n {\n \"name\": \"abool\",\n \"label\": \"A Bool\",\n \"description\": null,\n \"type\": \"bool\",\n \"required\": false,\n \"value\": null,\n \"default\": false,\n \"allowedValues\": [\n\n ]\n },\n {\n \"name\": \"afloat\",\n \"label\": \"A Float\",\n \"description\": null,\n \"type\": \"float\",\n \"required\": false,\n \"value\": null,\n \"default\": null,\n \"allowedValues\": [\n\n ]\n },\n {\n \"name\": \"optionalstr\",\n \"label\": \"Optional String\",\n \"description\": null,\n \"type\": \"string\",\n \"required\": false,\n \"value\": null,\n \"default\": null,\n \"allowedValues\": [\n\n ]\n },\n {\n \"name\": \"cred\",\n \"label\": \"Cred\",\n \"description\": null,\n \"type\": \"credential_redshift\",\n \"required\": false,\n \"value\": null,\n \"default\": null,\n \"allowedValues\": [\n\n ]\n }\n ],\n \"name\": \"Script #3315\",\n \"category\": \"script\",\n \"note\": null,\n \"createdAt\": \"2023-07-18T18:46:33.000Z\",\n \"updatedAt\": \"2023-07-18T18:46:33.000Z\",\n \"useCount\": 0,\n \"uiReportId\": null,\n \"techReviewed\": false,\n \"archived\": false,\n \"hidden\": false,\n \"author\": {\n \"id\": 4638,\n \"name\": \"User devuserfactory3121 3119\",\n \"username\": \"devuserfactory3121\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"myPermissionLevel\": \"manage\"\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"4da20f0f61a283543cf2f263a031bf88\"","X-Request-Id":"68eb6b15-eb49-4d1e-a194-60107f719e71","X-Runtime":"0.038655","Content-Length":"1443"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/templates/scripts\" -d '{\"script_id\":3315,\"name\":\"Script #3315\"}' -X POST \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer d8K_u-QaG7nKWyihMvPe7I9Vcq3lNbKvdvUAAVxIlUI\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/templates/scripts/{id}":{"get":{"summary":"Get a Script Template","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object692"}}},"x-examples":null,"x-deprecation-warning":null},"put":{"summary":"Replace all attributes of this Script Template","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"type":"integer"},{"name":"Object693","in":"body","schema":{"$ref":"#/definitions/Object693"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object692"}}},"x-examples":null,"x-deprecation-warning":null},"patch":{"summary":"Update some attributes of this Script Template","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"type":"integer"},{"name":"Object694","in":"body","schema":{"$ref":"#/definitions/Object694"},"required":false}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object692"}}},"x-examples":[{"resource":"Template::Script","resource_explanation":null,"http_method":"PATCH","route":"http://api.civis.test/templates/scripts/:id","description":"Archive a script template","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"PATCH","request_path":"http://api.civis.test/templates/scripts/186","request_body":"{\n \"archived\": true\n}","request_headers":{"Content-Type":"application/json","Authorization":"Bearer yJs2SbKkQVsm-L0SjBIc4MVhS6ts1Dn0SpploC0syTg","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 186,\n \"public\": false,\n \"scriptId\": 3318,\n \"scriptType\": \"Python\",\n \"userContext\": \"runner\",\n \"params\": [\n {\n \"name\": \"id\",\n \"label\": \"ID\",\n \"description\": null,\n \"type\": \"integer\",\n \"required\": true,\n \"value\": null,\n \"default\": null,\n \"allowedValues\": [\n\n ]\n },\n {\n \"name\": \"state\",\n \"label\": \"State\",\n \"description\": null,\n \"type\": \"string\",\n \"required\": true,\n \"value\": null,\n \"default\": null,\n \"allowedValues\": [\n\n ]\n },\n {\n \"name\": \"a_multi_line_string\",\n \"label\": \"A Multi-line String\",\n \"description\": null,\n \"type\": \"multi_line_string\",\n \"required\": false,\n \"value\": null,\n \"default\": null,\n \"allowedValues\": [\n\n ]\n },\n {\n \"name\": \"abool\",\n \"label\": \"A Bool\",\n \"description\": null,\n \"type\": \"bool\",\n \"required\": false,\n \"value\": null,\n \"default\": false,\n \"allowedValues\": [\n\n ]\n },\n {\n \"name\": \"afloat\",\n \"label\": \"A Float\",\n \"description\": null,\n \"type\": \"float\",\n \"required\": false,\n \"value\": null,\n \"default\": null,\n \"allowedValues\": [\n\n ]\n },\n {\n \"name\": \"optionalstr\",\n \"label\": \"Optional String\",\n \"description\": null,\n \"type\": \"string\",\n \"required\": false,\n \"value\": null,\n \"default\": null,\n \"allowedValues\": [\n\n ]\n },\n {\n \"name\": \"cred\",\n \"label\": \"Cred\",\n \"description\": null,\n \"type\": \"credential_redshift\",\n \"required\": false,\n \"value\": null,\n \"default\": null,\n \"allowedValues\": [\n\n ]\n }\n ],\n \"name\": \"awesome sql template\",\n \"category\": \"script\",\n \"note\": null,\n \"createdAt\": \"2023-07-18T18:46:34.000Z\",\n \"updatedAt\": \"2023-07-18T18:46:34.000Z\",\n \"useCount\": 0,\n \"uiReportId\": null,\n \"techReviewed\": false,\n \"archived\": true,\n \"hidden\": false,\n \"author\": {\n \"id\": 4653,\n \"name\": \"User devuserfactory3132 3130\",\n \"username\": \"devuserfactory3132\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"myPermissionLevel\": \"manage\"\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"91656128b9ffc3d9374997f7a1583a37\"","X-Request-Id":"d61f7e6d-fb53-44bc-8a59-ed93e4f9b4e0","X-Runtime":"0.043112","Content-Length":"1455"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/templates/scripts/186\" -d '{\"archived\":true}' -X PATCH \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer yJs2SbKkQVsm-L0SjBIc4MVhS6ts1Dn0SpploC0syTg\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Template::Script","resource_explanation":null,"http_method":"PATCH","route":"http://api.civis.test/templates/scripts/:id","description":"Unarchive a script template","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"PATCH","request_path":"http://api.civis.test/templates/scripts/189","request_body":"{\n \"archived\": false\n}","request_headers":{"Content-Type":"application/json","Authorization":"Bearer fuEuAu-WvCJGp9QJAKGIE5RjC2QjXcAM5RJ6f9PSfDQ","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 189,\n \"public\": false,\n \"scriptId\": 3344,\n \"scriptType\": \"Python\",\n \"userContext\": \"runner\",\n \"params\": [\n {\n \"name\": \"id\",\n \"label\": \"ID\",\n \"description\": null,\n \"type\": \"integer\",\n \"required\": true,\n \"value\": null,\n \"default\": null,\n \"allowedValues\": [\n\n ]\n },\n {\n \"name\": \"state\",\n \"label\": \"State\",\n \"description\": null,\n \"type\": \"string\",\n \"required\": true,\n \"value\": null,\n \"default\": null,\n \"allowedValues\": [\n\n ]\n },\n {\n \"name\": \"abool\",\n \"label\": \"A Bool\",\n \"description\": null,\n \"type\": \"bool\",\n \"required\": false,\n \"value\": null,\n \"default\": false,\n \"allowedValues\": [\n\n ]\n },\n {\n \"name\": \"optionalstr\",\n \"label\": \"Optional String\",\n \"description\": null,\n \"type\": \"string\",\n \"required\": false,\n \"value\": null,\n \"default\": null,\n \"allowedValues\": [\n\n ]\n },\n {\n \"name\": \"table\",\n \"label\": \"Table\",\n \"description\": null,\n \"type\": \"string\",\n \"required\": false,\n \"value\": null,\n \"default\": null,\n \"allowedValues\": [\n\n ]\n },\n {\n \"name\": \"cred\",\n \"label\": \"Cred\",\n \"description\": null,\n \"type\": \"credential_redshift\",\n \"required\": false,\n \"value\": null,\n \"default\": null,\n \"allowedValues\": [\n\n ]\n },\n {\n \"name\": \"AWS\",\n \"label\": \"AWS Cred\",\n \"description\": null,\n \"type\": \"credential_aws\",\n \"required\": false,\n \"value\": null,\n \"default\": null,\n \"allowedValues\": [\n\n ]\n }\n ],\n \"name\": \"awesome python template\",\n \"category\": \"script\",\n \"note\": null,\n \"createdAt\": \"2023-07-18T18:46:36.000Z\",\n \"updatedAt\": \"2023-07-18T18:46:36.000Z\",\n \"useCount\": 0,\n \"uiReportId\": null,\n \"techReviewed\": false,\n \"archived\": false,\n \"hidden\": false,\n \"author\": {\n \"id\": 4668,\n \"name\": \"User devuserfactory3143 3141\",\n \"username\": \"devuserfactory3143\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"myPermissionLevel\": \"manage\"\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"9aa4be64d7aa9cc45415391a366cdd34\"","X-Request-Id":"c132791e-5839-4bbb-8004-91d1835483c1","X-Runtime":"0.034526","Content-Length":"1427"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/templates/scripts/189\" -d '{\"archived\":false}' -X PATCH \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer fuEuAu-WvCJGp9QJAKGIE5RjC2QjXcAM5RJ6f9PSfDQ\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"delete":{"summary":"Archive a Script Template (deprecated, use archiving endpoints instead)","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/usage/matching":{"get":{"summary":"Get usage statistics for a given organization","description":null,"deprecated":false,"parameters":[{"name":"org_id","in":"query","required":false,"description":"The ID of the organization to get usage statistics for.","type":"integer"},{"name":"task","in":"query","required":false,"description":"The type of matching job contributing to this usage. One of [\"IDR\", \"CDM\"].","type":"string"},{"name":"start_date","in":"query","required":false,"description":"The start date of the range to get usage statistics for.","type":"string","format":"date-time"},{"name":"end_date","in":"query","required":false,"description":"The end date of the range to get usage statistics for.","type":"string","format":"date-time"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object695"}}}},"x-examples":null,"x-deprecation-warning":null}},"/usage/llm":{"get":{"summary":"Get a list of usage statistics for a given organization","description":null,"deprecated":false,"parameters":[{"name":"org_id","in":"query","required":false,"description":"The ID of the organization to get usage statistics for.","type":"integer"},{"name":"start_date","in":"query","required":false,"description":"The start date of the range to get usage statistics for.\"\\\n \"Defaults to the start of the current month if neither start_date nor end_date is specified.","type":"string","format":"date-time"},{"name":"end_date","in":"query","required":false,"description":"The end date of the range to get usage statistics for.\"\\\n \"Defaults to the end of the current day if neither start_date nor end_date is specified.","type":"string","format":"date-time"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object698"}}}},"x-examples":null,"x-deprecation-warning":null}},"/usage/llm/{id}":{"get":{"summary":"Get an individual usage statistic for a given organization","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the usage statistic to get.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object698"}}},"x-examples":null,"x-deprecation-warning":null}},"/usage/llm/organization/{org_id}/summary":{"get":{"summary":"Get summarized usage statistics for a given organization","description":null,"deprecated":false,"parameters":[{"name":"org_id","in":"path","required":true,"description":"The ID of the organization to get usage statistics for.","type":"integer"},{"name":"start_date","in":"query","required":false,"description":"The start date of the range to get usage statistics for.\"\\\n \"Defaults to the start of the current month if neither start_date nor end_date is specified.","type":"string","format":"date-time"},{"name":"end_date","in":"query","required":false,"description":"The end date of the range to get usage statistics for.\"\\\n \"Defaults to the end of the current day if neither start_date nor end_date is specified.","type":"string","format":"date-time"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object701"}}},"x-examples":null,"x-deprecation-warning":null}},"/usage_limits/matching":{"get":{"summary":"List Matching Usage Limits","description":null,"deprecated":false,"parameters":[{"name":"task","in":"query","required":false,"description":"If specified, return limits for this task type only. One of 'IDR' or 'CDM'.","type":"string"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object702"}}}},"x-examples":null,"x-deprecation-warning":null}},"/usage_limits/matching/{id}":{"get":{"summary":"Get a Matching Usage Limit","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID for the limit.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object702"}}},"x-examples":null,"x-deprecation-warning":null}},"/usage_limits/llm":{"get":{"summary":"List LLM Usage Limits","description":null,"deprecated":false,"parameters":[{"name":"organization_id","in":"query","required":false,"description":"If specified, return limits for this organization only.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object705"}}}},"x-examples":null,"x-deprecation-warning":null}},"/usage_limits/llm/{id}":{"get":{"summary":"Get a LLM Usage Limit","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID for the limit.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object705"}}},"x-examples":null,"x-deprecation-warning":null}},"/users/":{"get":{"summary":"List users","description":null,"deprecated":false,"parameters":[{"name":"feature_flag","in":"query","required":false,"description":"Return users that have a feature flag enabled.","type":"string"},{"name":"account_status","in":"query","required":false,"description":"The account status by which to filter users. May be one of \"active\", \"inactive\", or \"all\". Defaults to active.","type":"string"},{"name":"query","in":"query","required":false,"description":"Return users who match the given query, based on name, user, email, and id.","type":"string"},{"name":"group_id","in":"query","required":false,"description":"The ID of the group by which to filter users. Cannot be present if group_ids is.","type":"integer"},{"name":"group_ids","in":"query","required":false,"description":"The IDs of the groups by which to filter users. Cannot be present if group_id is.","type":"array","items":{"type":"integer"}},{"name":"organization_id","in":"query","required":false,"description":"The ID of the organization by which to filter users.","type":"integer"},{"name":"exclude_groups","in":"query","required":false,"description":"Whether or to exclude users' groups. Default: false.","type":"boolean"},{"name":"limit","in":"query","required":false,"description":"Number of results to return. Defaults to 20. Maximum allowed is 10000.","type":"integer"},{"name":"page_num","in":"query","required":false,"description":"Page number of the results to return. Defaults to the first page, 1.","type":"integer"},{"name":"order","in":"query","required":false,"description":"The field on which to order the result set. Defaults to name. Must be one of: name, user.","type":"string"},{"name":"order_dir","in":"query","required":false,"description":"Direction in which to sort, either asc (ascending) or desc (descending) defaulting to asc.","type":"string"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object707"}}}},"x-examples":[{"resource":"User","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/users","description":"List users","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/users","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer FnL3lg1m_pHGCpHZZIfut9vPdQYk7f9Al1kATBcqBDM","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 9,\n \"user\": \"devuserfactory2\",\n \"name\": \"User devuserfactory2 2\",\n \"email\": \"devuserfactory22user@localhost.test\",\n \"active\": true,\n \"primaryGroupId\": 58,\n \"groups\": [\n {\n \"id\": 58,\n \"name\": \"Group 3\",\n \"slug\": \"group_d\",\n \"organizationId\": 8,\n \"organizationName\": \"Organization 3\"\n }\n ],\n \"createdAt\": \"2025-01-28T16:52:56.000Z\",\n \"currentSignInAt\": \"2025-01-28T16:52:56.000Z\",\n \"updatedAt\": \"2025-01-28T16:52:56.000Z\",\n \"lastSeenAt\": null,\n \"suspended\": false,\n \"createdById\": null,\n \"lastUpdatedById\": null\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","X-Pagination-Per-Page":"20","Access-Control-Expose-Headers":"X-Pagination-Per-Page, X-Pagination-Current-Page, X-Pagination-Total-Pages, X-Pagination-Total-Entries","X-Pagination-Current-Page":"1","X-Pagination-Total-Pages":"1","X-Pagination-Total-Entries":"1","Content-Type":"application/json; charset=utf-8","ETag":"W/\"4ba352a173e32a0ed46aebab146738e7\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"e2eb92d7-f1d7-42e3-9971-2c24a66f8f1d","X-Runtime":"0.054013","Content-Length":"458"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/users\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer FnL3lg1m_pHGCpHZZIfut9vPdQYk7f9Al1kATBcqBDM\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"User","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/users?exclude_groups=true","description":"List users, excluding group information","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/users?exclude_groups=true","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer 0It0kENu-ZdeIHBpi0Pwr-1M1DhapY5L-NBTk_B1eeY","Host":"api.civis.test","Cookie":""},"request_query_parameters":{"exclude_groups":"true"},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 10,\n \"user\": \"devuserfactory3\",\n \"name\": \"User devuserfactory3 3\",\n \"email\": \"devuserfactory33user@localhost.test\",\n \"active\": true,\n \"primaryGroupId\": 65,\n \"groups\": [\n\n ],\n \"createdAt\": \"2025-01-28T16:52:56.000Z\",\n \"currentSignInAt\": \"2025-01-28T16:52:56.000Z\",\n \"updatedAt\": \"2025-01-28T16:52:56.000Z\",\n \"lastSeenAt\": null,\n \"suspended\": false,\n \"createdById\": null,\n \"lastUpdatedById\": null\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","X-Pagination-Per-Page":"20","Access-Control-Expose-Headers":"X-Pagination-Per-Page, X-Pagination-Current-Page, X-Pagination-Total-Pages, X-Pagination-Total-Entries","X-Pagination-Current-Page":"1","X-Pagination-Total-Pages":"1","X-Pagination-Total-Entries":"1","Content-Type":"application/json; charset=utf-8","ETag":"W/\"5534e78ff293ef9b32fae2d4c9cfab5f\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"c75abf85-be17-4e51-a754-fe1dcd6f7056","X-Runtime":"0.040110","Content-Length":"361"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/users?exclude_groups=true\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer 0It0kENu-ZdeIHBpi0Pwr-1M1DhapY5L-NBTk_B1eeY\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"User","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/users?feature_flag=add_table_to_project_ui","description":"List users that have a feature flag enabled","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/users?feature_flag=add_table_to_project_ui","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer et8nn3VYSkXBm3us3i0TdyKlWVWCqK9d8Ki6d0Lrl6I","Host":"api.civis.test","Cookie":""},"request_query_parameters":{"feature_flag":"add_table_to_project_ui"},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 11,\n \"user\": \"devuserfactory4\",\n \"name\": \"User devuserfactory4 4\",\n \"email\": \"devuserfactory44user@localhost.test\",\n \"active\": true,\n \"primaryGroupId\": 72,\n \"groups\": [\n {\n \"id\": 72,\n \"name\": \"Group 5\",\n \"slug\": \"group_f\",\n \"organizationId\": 10,\n \"organizationName\": \"Organization 5\"\n }\n ],\n \"createdAt\": \"2025-01-28T16:52:56.000Z\",\n \"currentSignInAt\": \"2025-01-28T16:52:56.000Z\",\n \"updatedAt\": \"2025-01-28T16:52:56.000Z\",\n \"lastSeenAt\": null,\n \"suspended\": false,\n \"createdById\": null,\n \"lastUpdatedById\": null\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","X-Pagination-Per-Page":"20","Access-Control-Expose-Headers":"X-Pagination-Per-Page, X-Pagination-Current-Page, X-Pagination-Total-Pages, X-Pagination-Total-Entries","X-Pagination-Current-Page":"1","X-Pagination-Total-Pages":"1","X-Pagination-Total-Entries":"1","Content-Type":"application/json; charset=utf-8","ETag":"W/\"ec6554a13674ef3ab932ac771f0573a6\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"293ab5c1-f3ba-45f5-b676-b3bd4ff34d8e","X-Runtime":"0.037339","Content-Length":"460"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/users?feature_flag=add_table_to_project_ui\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer et8nn3VYSkXBm3us3i0TdyKlWVWCqK9d8Ki6d0Lrl6I\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"post":{"summary":"Create a new user (must be a team or org admin)","description":null,"deprecated":false,"parameters":[{"name":"Object709","in":"body","schema":{"$ref":"#/definitions/Object709"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object710"}}},"x-examples":[{"resource":"User","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/users","description":"create a new user via POST","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/users","request_body":"{\n \"user\": \"createst\",\n \"name\": \"Test Create\",\n \"email\": \"create@localhost.test\",\n \"primary_group_id\": 44,\n \"send_email\": false,\n \"active\": true\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer VLfCNPTwjVP0vgsZLAeMNgoa2HVNPn63tP5hCcbN1U4","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 7,\n \"user\": \"createst\",\n \"name\": \"Test Create\",\n \"email\": \"create@localhost.test\",\n \"active\": true,\n \"primaryGroupId\": 44,\n \"groups\": [\n {\n \"id\": 44,\n \"name\": \"Group 1\",\n \"slug\": \"group_b\",\n \"organizationId\": 6,\n \"organizationName\": \"Organization 1\"\n }\n ],\n \"city\": null,\n \"state\": null,\n \"timeZone\": \"America/Chicago\",\n \"initials\": \"TC\",\n \"department\": null,\n \"title\": null,\n \"githubUsername\": null,\n \"prefersSmsOtp\": true,\n \"vpnEnabled\": null,\n \"ssoDisabled\": null,\n \"otpRequiredForLogin\": null,\n \"exemptFromOrgSmsOtpDisabled\": null,\n \"smsOtpAllowed\": true,\n \"robot\": false,\n \"phone\": null,\n \"organizationSlug\": \"organization_b\",\n \"organizationSSODisableCapable\": false,\n \"organizationLoginType\": \"password\",\n \"organizationSmsOtpDisabled\": false,\n \"myPermissionLevel\": \"manage\",\n \"createdAt\": \"2025-01-28T16:52:55.000Z\",\n \"updatedAt\": \"2025-01-28T16:52:55.000Z\",\n \"lastSeenAt\": null,\n \"suspended\": false,\n \"createdById\": 6,\n \"lastUpdatedById\": 6,\n \"unconfirmedEmail\": null,\n \"accountStatus\": \"Active\"\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"ec1a982911edd18d0cf1e441857f25bc\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"aafb1ba3-e6c2-4d26-9ac5-7a8cf2879efd","X-Runtime":"0.259716","Content-Length":"886"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/users\" -d '{\"user\":\"createst\",\"name\":\"Test Create\",\"email\":\"create@localhost.test\",\"primary_group_id\":44,\"send_email\":false,\"active\":true}' -X POST \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer VLfCNPTwjVP0vgsZLAeMNgoa2HVNPn63tP5hCcbN1U4\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/users/me":{"get":{"summary":"Show info about the logged-in user","description":null,"deprecated":false,"parameters":[],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object711"}}},"x-examples":[{"resource":"User","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/users/me","description":"Shows information about the logged-in user","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/users/me","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer FM3XW8lhCxVKr-4pMfLZKkrPj16jXZ1Irm6y-cCGRkA","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 12,\n \"name\": \"User devuserfactory5 5\",\n \"email\": \"devuserfactory55user@localhost.test\",\n \"username\": \"devuserfactory5\",\n \"initials\": \"UD\",\n \"lastCheckedAnnouncements\": \"2025-01-28T16:52:56.000Z\",\n \"featureFlags\": {\n \"add_table_to_project_ui\": false,\n \"ai_generation_table_metadata\": false,\n \"ai_query_completion\": false,\n \"ai_query_generation\": false,\n \"ai_support_agent\": false,\n \"cass_ncoa_configure_chunk_size\": false,\n \"cdm_usage_overview\": false,\n \"civis_ai_popsicle_top_nav\": false,\n \"enable_legacy_enhancements\": false,\n \"millenium_keys\": false,\n \"model_allow_unscanned\": false,\n \"model_thumbnails\": false,\n \"organization_favorites\": false,\n \"pendo_resource_center\": false,\n \"project_breadcrumbs\": false,\n \"salesforce_41\": false,\n \"service_report_links\": false,\n \"success_email_advanced_options\": false,\n \"sumologic_compute_metrics\": false,\n \"table_param\": false,\n \"themes_api\": false\n },\n \"roles\": [\n \"sdm\"\n ],\n \"preferences\": {\n \"default_success_notifications_on\": true,\n \"default_failure_notifications_on\": true,\n \"query_preview_rows\": 50\n },\n \"customBranding\": null,\n \"primaryGroupId\": 79,\n \"groups\": [\n {\n \"id\": 79,\n \"name\": \"Group 6\",\n \"slug\": \"group_g\",\n \"organizationId\": 11,\n \"organizationName\": \"Organization 6\"\n }\n ],\n \"organizationName\": \"Organization 6\",\n \"organizationSlug\": \"organization_g\",\n \"organizationDefaultThemeId\": null,\n \"createdAt\": \"2025-01-28T16:52:56.000Z\",\n \"signInCount\": 0,\n \"assumingRole\": false,\n \"assumingAdmin\": false,\n \"assumingAdminExpiration\": null,\n \"superadminModeExpiration\": null,\n \"disableNonCompliantFedrampFeatures\": false,\n \"personaRole\": null,\n \"createdById\": null,\n \"lastUpdatedById\": null\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"27ee62812f53b3ba011abd92ee7cf89f\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"fdb11aee-ec8d-426c-80f9-084aa88128a7","X-Runtime":"0.039910","Content-Length":"1478"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/users/me\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer FM3XW8lhCxVKr-4pMfLZKkrPj16jXZ1Irm6y-cCGRkA\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"patch":{"summary":"Update info about the logged-in user","description":null,"deprecated":false,"parameters":[{"name":"Object724","in":"body","schema":{"$ref":"#/definitions/Object724"},"required":false}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object711"}}},"x-examples":null,"x-deprecation-warning":null}},"/users/me/activity":{"get":{"summary":"Get recent activity for logged-in user","description":null,"deprecated":false,"parameters":[{"name":"status","in":"query","required":false,"description":"The status to filter objects by. One of \"all\", \"succeeded\", \"failed\", or \"running\".","type":"string"},{"name":"author","in":"query","required":false,"description":"A comma separated list of author IDs to filter objects by.","type":"string"},{"name":"order","in":"query","required":false,"description":"The order of the jobs. If set to \"name\", the order is DESC alphabetically. If set to \"newest\", the order is DESC by most recently updated.","type":"string"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object714"}}}},"x-examples":null,"x-deprecation-warning":null}},"/users/me/organization_admins":{"get":{"summary":"Get list of organization admins for logged-in user","description":null,"deprecated":false,"parameters":[],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object715"}}}},"x-examples":[{"resource":"User","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/users/me/organization_admins","description":"Shows organization admins for the logged-in user","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/users/me/organization_admins","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer B3KQTPUkCpCjcqq_jhwlCjkuUVunYoqxGbsu5i-NDKQ","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 14,\n \"name\": \"User devuserfactory7 7\",\n \"username\": \"devuserfactory7\",\n \"initials\": \"UD\",\n \"online\": null,\n \"email\": \"devuserfactory77user@localhost.test\"\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"d22d62f7ea6d83e708bb0d553491fba4\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"98d294a4-1e6e-4a45-a920-5a6e37318867","X-Runtime":"0.040005","Content-Length":"148"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/users/me/organization_admins\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer B3KQTPUkCpCjcqq_jhwlCjkuUVunYoqxGbsu5i-NDKQ\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/users/me/themes":{"get":{"summary":"List themes","description":null,"deprecated":false,"parameters":[],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object716"}}}},"x-examples":null,"x-deprecation-warning":null}},"/users/me/themes/{id}":{"get":{"summary":"Show a theme","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of this theme.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object4"}}},"x-examples":null,"x-deprecation-warning":null}},"/users/{id}":{"get":{"summary":"Show info about a user","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of this user.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object710"}}},"x-examples":[{"resource":"User","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/users/:id","description":"Shows information about another user","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/users/16","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer lwmjhWoC7j-Qp27eHt-q4-duXL1vrbz_Rh6x69kxO18","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 16,\n \"user\": \"devuserfactory9\",\n \"name\": \"User devuserfactory9 9\",\n \"email\": \"devuserfactory99user@localhost.test\",\n \"active\": true,\n \"primaryGroupId\": 94,\n \"groups\": [\n {\n \"id\": 94,\n \"name\": \"Group 8\",\n \"slug\": \"group_i\",\n \"organizationId\": 13,\n \"organizationName\": \"Organization 8\"\n }\n ],\n \"city\": null,\n \"state\": null,\n \"timeZone\": \"America/Chicago\",\n \"initials\": \"UD\",\n \"department\": null,\n \"title\": null,\n \"githubUsername\": null,\n \"prefersSmsOtp\": true,\n \"vpnEnabled\": null,\n \"ssoDisabled\": false,\n \"otpRequiredForLogin\": false,\n \"exemptFromOrgSmsOtpDisabled\": null,\n \"smsOtpAllowed\": true,\n \"robot\": false,\n \"phone\": null,\n \"organizationSlug\": \"organization_i\",\n \"organizationSSODisableCapable\": false,\n \"organizationLoginType\": \"password\",\n \"organizationSmsOtpDisabled\": null,\n \"myPermissionLevel\": \"manage\",\n \"createdAt\": \"2025-01-28T16:52:57.000Z\",\n \"updatedAt\": \"2025-01-28T16:52:57.000Z\",\n \"lastSeenAt\": null,\n \"suspended\": false,\n \"createdById\": null,\n \"lastUpdatedById\": null,\n \"unconfirmedEmail\": null,\n \"accountStatus\": \"Active\"\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"b5c8dacfee3151cd9204e0e07dbc175b\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"35a652fd-94bb-4cd8-8608-3e8322d635e8","X-Runtime":"0.051482","Content-Length":"927"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/users/16\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer lwmjhWoC7j-Qp27eHt-q4-duXL1vrbz_Rh6x69kxO18\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"patch":{"summary":"Update info about a user (must be a team or org admin)","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of this user.","type":"integer"},{"name":"Object726","in":"body","schema":{"$ref":"#/definitions/Object726"},"required":false}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object710"}}},"x-examples":[{"resource":"User","resource_explanation":null,"http_method":"PATCH","route":"http://api.civis.test/users/:id","description":"updates a user via PATCH","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"PATCH","request_path":"http://api.civis.test/users/8","request_body":"{\n \"name\": \"name updated\"\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer yrIbaMhc7nriEImpWmjdXfnhtCXyR8OFFjqG82-i90s","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 8,\n \"user\": \"devuserfactory1\",\n \"name\": \"name updated\",\n \"email\": \"devuserfactory11user@localhost.test\",\n \"active\": true,\n \"primaryGroupId\": 51,\n \"groups\": [\n {\n \"id\": 51,\n \"name\": \"Group 2\",\n \"slug\": \"group_c\",\n \"organizationId\": 7,\n \"organizationName\": \"Organization 2\"\n }\n ],\n \"city\": null,\n \"state\": null,\n \"timeZone\": \"America/Chicago\",\n \"initials\": \"NU\",\n \"department\": null,\n \"title\": null,\n \"githubUsername\": null,\n \"prefersSmsOtp\": true,\n \"vpnEnabled\": null,\n \"ssoDisabled\": false,\n \"otpRequiredForLogin\": false,\n \"exemptFromOrgSmsOtpDisabled\": null,\n \"smsOtpAllowed\": true,\n \"robot\": false,\n \"phone\": null,\n \"organizationSlug\": \"organization_c\",\n \"organizationSSODisableCapable\": false,\n \"organizationLoginType\": \"password\",\n \"organizationSmsOtpDisabled\": null,\n \"myPermissionLevel\": \"write\",\n \"createdAt\": \"2025-01-28T16:52:55.000Z\",\n \"updatedAt\": \"2025-01-28T16:52:55.000Z\",\n \"lastSeenAt\": null,\n \"suspended\": false,\n \"createdById\": null,\n \"lastUpdatedById\": 8,\n \"unconfirmedEmail\": null,\n \"accountStatus\": \"Active\"\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"8e4d97af4fa6e386adaabd503f5ce886\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"4dae3f01-fa34-469f-92b9-33e259e9dad5","X-Runtime":"0.093850","Content-Length":"911"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/users/8\" -d '{\"name\":\"name updated\"}' -X PATCH \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer yrIbaMhc7nriEImpWmjdXfnhtCXyR8OFFjqG82-i90s\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/users/{id}/api_keys":{"get":{"summary":"Show API keys belonging to the specified user","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the user or 'me'.","type":"string"},{"name":"limit","in":"query","required":false,"description":"Number of results to return. Defaults to its maximum of 50.","type":"integer"},{"name":"page_num","in":"query","required":false,"description":"Page number of the results to return. Defaults to the first page, 1.","type":"integer"},{"name":"order","in":"query","required":false,"description":"The field on which to order the result set. Defaults to id. Must be one of: id.","type":"string"},{"name":"order_dir","in":"query","required":false,"description":"Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc.","type":"string"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object717"}}}},"x-examples":[{"resource":"User","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/users/:id/api_keys","description":"Show API keys for the specified user","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/users/18/api_keys","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer xmsdCqfFAGIza5WCiQpGvnDAry_7djCvF9Z3L3k_7NY","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 10,\n \"name\": \"test_key\",\n \"expiresAt\": \"2025-01-28T17:01:17.000Z\",\n \"createdAt\": \"2025-01-28T16:52:57.000Z\",\n \"revokedAt\": null,\n \"lastUsedAt\": null,\n \"scopes\": [\n \"public\"\n ],\n \"useCount\": 0,\n \"expired\": false,\n \"active\": true,\n \"constraintCount\": 0\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","X-Pagination-Per-Page":"50","Access-Control-Expose-Headers":"X-Pagination-Per-Page, X-Pagination-Current-Page, X-Pagination-Total-Pages, X-Pagination-Total-Entries","X-Pagination-Current-Page":"1","X-Pagination-Total-Pages":"1","X-Pagination-Total-Entries":"1","Content-Type":"application/json; charset=utf-8","ETag":"W/\"d94465bee13e309053c4ce71a4d8039a\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"4ad62dd2-cea2-415e-a5ac-ac4d577c16bf","X-Runtime":"0.041420","Content-Length":"225"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/users/18/api_keys\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer xmsdCqfFAGIza5WCiQpGvnDAry_7djCvF9Z3L3k_7NY\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"User","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/users/:id/api_keys","description":"Show API keys for the logged-in user","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/users/me/api_keys","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer uT5Gg9E_LfhObmMgSUlG07hGp-r1tissp8rFDCvB5Qg","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 12,\n \"name\": \"test_key\",\n \"expiresAt\": \"2025-01-28T17:01:17.000Z\",\n \"createdAt\": \"2025-01-28T16:52:57.000Z\",\n \"revokedAt\": null,\n \"lastUsedAt\": null,\n \"scopes\": [\n \"public\"\n ],\n \"useCount\": 0,\n \"expired\": false,\n \"active\": true,\n \"constraintCount\": 1\n },\n {\n \"id\": 11,\n \"name\": \"test\",\n \"expiresAt\": \"2025-01-29T16:52:57.000Z\",\n \"createdAt\": \"2025-01-28T16:52:57.000Z\",\n \"revokedAt\": null,\n \"lastUsedAt\": \"2025-01-28T16:52:57.000Z\",\n \"scopes\": [\n \"public\"\n ],\n \"useCount\": 1,\n \"expired\": false,\n \"active\": true,\n \"constraintCount\": 0\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","X-Pagination-Per-Page":"50","Access-Control-Expose-Headers":"X-Pagination-Per-Page, X-Pagination-Current-Page, X-Pagination-Total-Pages, X-Pagination-Total-Entries","X-Pagination-Current-Page":"1","X-Pagination-Total-Pages":"1","X-Pagination-Total-Entries":"2","Content-Type":"application/json; charset=utf-8","ETag":"W/\"926837cb4df94105ebe06d1390e85d5f\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"9e13c1e3-eec7-4f36-a4a0-6b1d37de732f","X-Runtime":"0.025328","Content-Length":"467"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/users/me/api_keys\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer uT5Gg9E_LfhObmMgSUlG07hGp-r1tissp8rFDCvB5Qg\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"post":{"summary":"Create a new API key belonging to the logged-in user","description":"Constraint verb \"allowed\" parameters default to false if not specified. At least one verb must be specified. If constraintType is \"verb\", the constraint parameter must not be specified. A constraint parameter must be specified for all other constraintType values.","deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the user or 'me'.","type":"string"},{"name":"Object718","in":"body","schema":{"$ref":"#/definitions/Object718"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object720"}}},"x-examples":[{"resource":"User","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/users/:id/api_keys","description":"Create an API key for the current user","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/users/me/api_keys","request_body":"{\n \"name\": \"friendlyapp\",\n \"expires_in\": 1000\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer _vgRplm_sBc5BV_PunAOk5aEmvLutVCLbCRtItnSTsE","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 14,\n \"name\": \"friendlyapp\",\n \"expiresAt\": \"2025-01-28T17:09:38.000Z\",\n \"createdAt\": \"2025-01-28T16:52:58.000Z\",\n \"revokedAt\": null,\n \"lastUsedAt\": null,\n \"scopes\": [\n \"public\"\n ],\n \"useCount\": 0,\n \"expired\": false,\n \"active\": true,\n \"constraints\": [\n\n ],\n \"token\": \"mMWsCDTg0glpJj1n7zXniW0PKPotlTkxPhYhzIRtc0U\"\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"69e2b9c4344d94d810e655ab3d741b7a\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"bfea1590-ed7f-4381-8831-4f8f444483fd","X-Runtime":"0.044194","Content-Length":"277"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/users/me/api_keys\" -d '{\"name\":\"friendlyapp\",\"expires_in\":1000}' -X POST \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer _vgRplm_sBc5BV_PunAOk5aEmvLutVCLbCRtItnSTsE\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"User","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/users/:id/api_keys","description":"Creates an API key with constraints","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/users/21/api_keys","request_body":"{\n \"name\": \"friendlyapp\",\n \"expires_in\": 1000,\n \"constraints\": [\n {\n \"constraint\": \"reports/33\",\n \"constraint_type\": \"exact\",\n \"get_allowed\": true\n }\n ]\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer pPMMBtKDIK5cmJW-RUR7anDOcTuroULHvijzAHvBKuM","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 16,\n \"name\": \"friendlyapp\",\n \"expiresAt\": \"2025-01-28T17:09:38.000Z\",\n \"createdAt\": \"2025-01-28T16:52:58.000Z\",\n \"revokedAt\": null,\n \"lastUsedAt\": null,\n \"scopes\": [\n \"public\"\n ],\n \"useCount\": 0,\n \"expired\": false,\n \"active\": true,\n \"constraints\": [\n {\n \"constraint\": \"reports/33\",\n \"constraintType\": \"exact\",\n \"getAllowed\": true,\n \"headAllowed\": false,\n \"postAllowed\": false,\n \"putAllowed\": false,\n \"patchAllowed\": false,\n \"deleteAllowed\": false\n }\n ],\n \"token\": \"zI-D7iATYIsnmStGuBtS0bAoj3Lrgr7kpcSmI6XvsRM\"\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"7c1e6254f153de6716ac85d686ca9ef3\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"a31ab37e-7572-41d9-81bd-a3d9eaf99686","X-Runtime":"0.114690","Content-Length":"449"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/users/21/api_keys\" -d '{\"name\":\"friendlyapp\",\"expires_in\":1000,\"constraints\":[{\"constraint\":\"reports/33\",\"constraint_type\":\"exact\",\"get_allowed\":true}]}' -X POST \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer pPMMBtKDIK5cmJW-RUR7anDOcTuroULHvijzAHvBKuM\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"User","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/users/:id/api_keys","description":"Does not create an API key with different constraints if the call uses an API key with constraints","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/users/22/api_keys","request_body":"{\n \"name\": \"friendlyapp\",\n \"expires_in\": 1000,\n \"constraints\": [\n {\n \"constraint\": \"reports/33\",\n \"constraint_type\": \"exact\",\n \"get_allowed\": true\n }\n ]\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer FJPi2060YUCCWsz9tLdxAATu_pOBUoABfNtZwo0qWDM","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":400,"response_status_text":"Bad Request","response_body":"{\n \"error\": \"bad_request\",\n \"errorDescription\": \"Cannot create API Key with different constraints.\",\n \"code\": 400\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"1af0c1f8-8e80-4cd1-bee8-41139e6e154b","X-Runtime":"0.065131","Content-Length":"105"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/users/22/api_keys\" -d '{\"name\":\"friendlyapp\",\"expires_in\":1000,\"constraints\":[{\"constraint\":\"reports/33\",\"constraint_type\":\"exact\",\"get_allowed\":true}]}' -X POST \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer FJPi2060YUCCWsz9tLdxAATu_pOBUoABfNtZwo0qWDM\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/users/{id}/api_keys/{key_id}":{"get":{"summary":"Show the specified API key","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the user or 'me'.","type":"string"},{"name":"key_id","in":"path","required":true,"description":"The ID of the API key.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object723"}}},"x-examples":[{"resource":"User","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/users/:id/api_keys/:key_id","description":"Show details for an API key","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/users/me/api_keys/19","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer eD8sIuApf3Qe8JRLpNvbrXuD1EnpPpePDWOGLxwMW5k","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 19,\n \"name\": \"with_constraint\",\n \"expiresAt\": \"2025-01-28T16:56:18.000Z\",\n \"createdAt\": \"2025-01-28T16:52:58.000Z\",\n \"revokedAt\": null,\n \"lastUsedAt\": null,\n \"scopes\": [\n \"public\"\n ],\n \"useCount\": 0,\n \"expired\": false,\n \"active\": true,\n \"constraints\": [\n {\n \"constraint\": \"path\",\n \"constraintType\": \"exact\",\n \"getAllowed\": false,\n \"headAllowed\": false,\n \"postAllowed\": true,\n \"putAllowed\": false,\n \"patchAllowed\": false,\n \"deleteAllowed\": false\n }\n ]\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"93864a749bcf74f2f6439bc848fafe02\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"7ef9b772-fd5b-4496-aa0d-557fccd6df31","X-Runtime":"0.028142","Content-Length":"393"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/users/me/api_keys/19\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer eD8sIuApf3Qe8JRLpNvbrXuD1EnpPpePDWOGLxwMW5k\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"delete":{"summary":"Revoke the specified API key","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the user or 'me'.","type":"string"},{"name":"key_id","in":"path","required":true,"description":"The ID of the API key.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object723"}}},"x-examples":[{"resource":"User","resource_explanation":null,"http_method":"DELETE","route":"http://api.civis.test/users/:id/api_keys/:key_id","description":"Delete an API key","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"DELETE","request_path":"http://api.civis.test/users/me/api_keys/21","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer 1xgnNXaGd5K5dVSJ758QWCujy2Rh1EgFU7dMvz9TbGg","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 21,\n \"name\": \"test_key\",\n \"expiresAt\": \"2025-01-28T17:09:39.000Z\",\n \"createdAt\": \"2025-01-28T16:52:59.000Z\",\n \"revokedAt\": \"2025-01-28T16:52:59.000Z\",\n \"lastUsedAt\": null,\n \"scopes\": [\n \"public\"\n ],\n \"useCount\": 0,\n \"expired\": false,\n \"active\": false,\n \"constraints\": [\n\n ]\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"312b7c3c4e55286bb69926eec46d8719\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"bb3e9181-13a3-4eb5-9049-b7d395e23050","X-Runtime":"0.029934","Content-Length":"243"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/users/me/api_keys/21\" -d '' -X DELETE \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer 1xgnNXaGd5K5dVSJ758QWCujy2Rh1EgFU7dMvz9TbGg\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/users/{id}/sessions":{"delete":{"summary":"Terminate all of the user's active sessions (must be a team or org admin)","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of this user.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object710"}}},"x-examples":null,"x-deprecation-warning":null}},"/users/me/favorites":{"get":{"summary":"List Favorites","description":null,"deprecated":false,"parameters":[{"name":"object_id","in":"query","required":false,"description":"The id of the object. If specified as a query parameter, must also specify object_type parameter.","type":"integer"},{"name":"object_type","in":"query","required":false,"description":"The type of the object that is favorited. Valid options: Container Script, Identity Resolution, Import, Python Script, R Script, dbt Script, JavaScript Script, SQL Script, Template Script, Project, Workflow, Tableau Report, Service Report, HTML Report, SQL Report","type":"string"},{"name":"limit","in":"query","required":false,"description":"Number of results to return. Defaults to 50. Maximum allowed is 1000.","type":"integer"},{"name":"page_num","in":"query","required":false,"description":"Page number of the results to return. Defaults to the first page, 1.","type":"integer"},{"name":"order","in":"query","required":false,"description":"The field on which to order the result set. Defaults to position. Must be one of: position, created_at.","type":"string"},{"name":"order_dir","in":"query","required":false,"description":"Direction in which to sort, either asc (ascending) or desc (descending) defaulting to asc.","type":"string"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object412"}}}},"x-examples":null,"x-deprecation-warning":null},"post":{"summary":"Favorite an item","description":null,"deprecated":false,"parameters":[{"name":"Object413","in":"body","schema":{"$ref":"#/definitions/Object413"},"required":true}],"responses":{"201":{"description":"success","schema":{"$ref":"#/definitions/Object414"}}},"x-examples":null,"x-deprecation-warning":null}},"/users/me/favorites/{id}":{"delete":{"summary":"Unfavorite an item","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The id of the favorite.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/users/me/favorites/{id}/ranking/top":{"patch":{"summary":"Move a favorite to the top of the list","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The id of the favorite.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":[{"resource":"Favorites","resource_explanation":null,"http_method":"PATCH","route":"http://api.civis.test/users/me/favorites/:id/ranking/top","description":"Move a favorite to the top of the list via PATCH","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"PATCH","request_path":"http://api.civis.test/users/me/favorites/3/ranking/top","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer ETkWTQ407Xseoo64hwKj4sIbB7XtAvv2PlNhlg_0dPg","Accept":"application/vnd.civis-platform.v1","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":204,"response_status_text":"No Content","response_body":null,"response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","X-Request-Id":"e990c29e-ce41-4c55-9e34-7c2bf1e84dbf","X-Runtime":"0.541901"},"response_content_type":null,"curl":"curl \"api.civis.testhttp://api.civis.test/users/me/favorites/3/ranking/top\" -d '' -X PATCH \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer ETkWTQ407Xseoo64hwKj4sIbB7XtAvv2PlNhlg_0dPg\" \\\n\t-H \"Accept: application/vnd.civis-platform.v1\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/users/me/favorites/{id}/ranking/bottom":{"patch":{"summary":"Move a favorite to the bottom of the list","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The id of the favorite.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":[{"resource":"Favorites","resource_explanation":null,"http_method":"PATCH","route":"http://api.civis.test/users/me/favorites/:id/ranking/bottom","description":"Move a favorite to the bottom of the list via PATCH","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"PATCH","request_path":"http://api.civis.test/users/me/favorites/4/ranking/bottom","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer 95JhXu6SYqd8RsAuUQ3b0OfmAggde4obJXVeXh7CIxM","Accept":"application/vnd.civis-platform.v1","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":204,"response_status_text":"No Content","response_body":null,"response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","X-Request-Id":"43ab04d0-94ee-4068-92c1-57b1d8a4106e","X-Runtime":"0.086730"},"response_content_type":null,"curl":"curl \"api.civis.testhttp://api.civis.test/users/me/favorites/4/ranking/bottom\" -d '' -X PATCH \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer 95JhXu6SYqd8RsAuUQ3b0OfmAggde4obJXVeXh7CIxM\" \\\n\t-H \"Accept: application/vnd.civis-platform.v1\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/users/me/favorites/{id}/ranking/higher":{"patch":{"summary":"Move a favorite one position closer to the top of the list","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The id of the favorite.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":[{"resource":"Favorites","resource_explanation":null,"http_method":"PATCH","route":"http://api.civis.test/users/me/favorites/:id/ranking/higher","description":"Move a favorite up one position in the list via PATCH","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"PATCH","request_path":"http://api.civis.test/users/me/favorites/9/ranking/higher","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer 4rd7ZE8qrW7kKuxHXOdbd3rMWqm8eQcmpkxlAIQwTTI","Accept":"application/vnd.civis-platform.v1","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":204,"response_status_text":"No Content","response_body":null,"response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","X-Request-Id":"15260583-7abf-4ca7-9fda-d05c5152e31d","X-Runtime":"0.137856"},"response_content_type":null,"curl":"curl \"api.civis.testhttp://api.civis.test/users/me/favorites/9/ranking/higher\" -d '' -X PATCH \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer 4rd7ZE8qrW7kKuxHXOdbd3rMWqm8eQcmpkxlAIQwTTI\" \\\n\t-H \"Accept: application/vnd.civis-platform.v1\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/users/me/favorites/{id}/ranking/lower":{"patch":{"summary":"Move a favorite one position closer to the bottom of the list","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The id of the favorite.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":[{"resource":"Favorites","resource_explanation":null,"http_method":"PATCH","route":"http://api.civis.test/users/me/favorites/:id/ranking/lower","description":"Move a favorite down one position in the list via PATCH","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"PATCH","request_path":"http://api.civis.test/users/me/favorites/10/ranking/lower","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer WFFdVK7JyfTzuIZHbjdqS1a0abr5ylqmOEs6JEJQJe8","Accept":"application/vnd.civis-platform.v1","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":204,"response_status_text":"No Content","response_body":null,"response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","X-Request-Id":"7c573d5e-db45-4385-88b1-77e58b34c677","X-Runtime":"0.073916"},"response_content_type":null,"curl":"curl \"api.civis.testhttp://api.civis.test/users/me/favorites/10/ranking/lower\" -d '' -X PATCH \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer WFFdVK7JyfTzuIZHbjdqS1a0abr5ylqmOEs6JEJQJe8\" \\\n\t-H \"Accept: application/vnd.civis-platform.v1\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/users/{id}/unsuspend":{"post":{"summary":"Unsuspends user","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of this user.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object727"}}},"x-examples":null,"x-deprecation-warning":null}},"/users/{id}/2fa":{"delete":{"summary":"Wipes the user's current 2FA settings so that they must reset them upon next login","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of this user.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object710"}}},"x-examples":null,"x-deprecation-warning":null}},"/users/{id}/access_email":{"post":{"summary":"Sends the target user a 'Reset Password' or 'Welcome to Platform' email depending on the their status - Only available to Org and Team Admins","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of this user.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/workflows/":{"get":{"summary":"List Workflows","description":null,"deprecated":false,"parameters":[{"name":"hidden","in":"query","required":false,"description":"If specified to be true, returns hidden items. Defaults to false, returning non-hidden items.","type":"boolean"},{"name":"archived","in":"query","required":false,"description":"The archival status of the requested item(s).","type":"string"},{"name":"author","in":"query","required":false,"description":"If specified, return items from any of these authors. It accepts a comma-separated list of user IDs.","type":"string"},{"name":"state","in":"query","required":false,"description":"State of the most recent execution. One or more of queued, running, succeeded, failed, cancelled, idle, and scheduled. Note that the \"scheduled\" state applies only to scheduled workflows which have never been run. If you want to see all scheduled workflows, please use the \"scheduled\" filter instead.","type":"array","items":{"type":"string"}},{"name":"scheduled","in":"query","required":false,"description":"If the workflow is scheduled.","type":"boolean"},{"name":"limit","in":"query","required":false,"description":"Number of results to return. Defaults to 20. Maximum allowed is 50.","type":"integer"},{"name":"page_num","in":"query","required":false,"description":"Page number of the results to return. Defaults to the first page, 1.","type":"integer"},{"name":"order","in":"query","required":false,"description":"The field on which to order the result set. Defaults to updated_at. Must be one of: updated_at, name, created_at.","type":"string"},{"name":"order_dir","in":"query","required":false,"description":"Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc.","type":"string"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object324"}}}},"x-examples":[{"resource":"Workflows","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/workflows","description":"List all workflows","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/workflows","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer Zt1F4Dz-VFK7LxmpdggiVJv_6ysgRfqh1TIaHNkHUYU","Accept":"application/vnd.civis-platform.v1","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 3,\n \"name\": \"Test Workflow\",\n \"description\": null,\n \"valid\": true,\n \"fileId\": 3,\n \"user\": {\n \"id\": 6,\n \"name\": \"User devuserfactory1 1\",\n \"username\": \"devuserfactory1\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"state\": \"scheduled\",\n \"schedule\": {\n \"scheduled\": true,\n \"scheduledDays\": [\n 1\n ],\n \"scheduledHours\": [\n 2\n ],\n \"scheduledMinutes\": [\n 0\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n },\n \"allowConcurrentExecutions\": true,\n \"timeZone\": \"America/Chicago\",\n \"nextExecutionAt\": \"2024-05-27T07:00:00.000Z\",\n \"archived\": false,\n \"createdAt\": \"2024-05-22T22:51:30.000Z\",\n \"updatedAt\": \"2024-05-22T22:51:30.000Z\"\n },\n {\n \"id\": 2,\n \"name\": \"Test Workflow\",\n \"description\": null,\n \"valid\": true,\n \"fileId\": 2,\n \"user\": {\n \"id\": 6,\n \"name\": \"User devuserfactory1 1\",\n \"username\": \"devuserfactory1\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"state\": \"running\",\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n },\n \"allowConcurrentExecutions\": true,\n \"timeZone\": \"America/Chicago\",\n \"nextExecutionAt\": null,\n \"archived\": false,\n \"createdAt\": \"2024-05-22T22:51:29.000Z\",\n \"updatedAt\": \"2024-05-22T22:51:29.000Z\"\n },\n {\n \"id\": 1,\n \"name\": \"Test Workflow\",\n \"description\": null,\n \"valid\": true,\n \"fileId\": 1,\n \"user\": {\n \"id\": 6,\n \"name\": \"User devuserfactory1 1\",\n \"username\": \"devuserfactory1\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"state\": \"idle\",\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n },\n \"allowConcurrentExecutions\": true,\n \"timeZone\": \"America/Chicago\",\n \"nextExecutionAt\": null,\n \"archived\": false,\n \"createdAt\": \"2024-05-22T22:51:28.000Z\",\n \"updatedAt\": \"2024-05-22T22:51:28.000Z\"\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","X-Pagination-Per-Page":"20","Access-Control-Expose-Headers":"X-Pagination-Per-Page, X-Pagination-Current-Page, X-Pagination-Total-Pages, X-Pagination-Total-Entries","X-Pagination-Current-Page":"1","X-Pagination-Total-Pages":"1","X-Pagination-Total-Entries":"3","Content-Type":"application/json; charset=utf-8","ETag":"W/\"4533bf78e19596368d3029005fa6b5c9\"","X-Request-Id":"a30dd413-10d9-48c7-ac9f-e6314eef5e65","X-Runtime":"0.190029","Content-Length":"1600"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/workflows\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer Zt1F4Dz-VFK7LxmpdggiVJv_6ysgRfqh1TIaHNkHUYU\" \\\n\t-H \"Accept: application/vnd.civis-platform.v1\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Workflows","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/workflows","description":"List scheduled workflows","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/workflows?scheduled=true","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer gHbebBOMX8qB8aU1e5KUYsOa0uFx4RvmB0krEUmrEyg","Accept":"application/vnd.civis-platform.v1","Host":"api.civis.test","Cookie":""},"request_query_parameters":{"scheduled":"true"},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 6,\n \"name\": \"Test Workflow\",\n \"description\": null,\n \"valid\": true,\n \"fileId\": 6,\n \"user\": {\n \"id\": 7,\n \"name\": \"User devuserfactory2 2\",\n \"username\": \"devuserfactory2\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"state\": \"scheduled\",\n \"schedule\": {\n \"scheduled\": true,\n \"scheduledDays\": [\n 1\n ],\n \"scheduledHours\": [\n 2\n ],\n \"scheduledMinutes\": [\n 0\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n },\n \"allowConcurrentExecutions\": true,\n \"timeZone\": \"America/Chicago\",\n \"nextExecutionAt\": \"2024-05-27T07:00:00.000Z\",\n \"archived\": false,\n \"createdAt\": \"2024-05-22T22:51:30.000Z\",\n \"updatedAt\": \"2024-05-22T22:51:30.000Z\"\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","X-Pagination-Per-Page":"20","Access-Control-Expose-Headers":"X-Pagination-Per-Page, X-Pagination-Current-Page, X-Pagination-Total-Pages, X-Pagination-Total-Entries","X-Pagination-Current-Page":"1","X-Pagination-Total-Pages":"1","X-Pagination-Total-Entries":"1","Content-Type":"application/json; charset=utf-8","ETag":"W/\"a51aac1700e164fef3c9b04c52f11415\"","X-Request-Id":"c4ce36df-8d2a-46d4-82cb-396951b2d9b5","X-Runtime":"0.029855","Content-Length":"553"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/workflows?scheduled=true\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer gHbebBOMX8qB8aU1e5KUYsOa0uFx4RvmB0krEUmrEyg\" \\\n\t-H \"Accept: application/vnd.civis-platform.v1\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Workflows","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/workflows","description":"List workflows where the most recent execution is running","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/workflows?state[]=running","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer xwDV75DTa0KzHUgh78AYSa2V18YoPn_SR21QJHYXisE","Accept":"application/vnd.civis-platform.v1","Host":"api.civis.test","Cookie":""},"request_query_parameters":{"state":["running"]},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 8,\n \"name\": \"Test Workflow\",\n \"description\": null,\n \"valid\": true,\n \"fileId\": 8,\n \"user\": {\n \"id\": 8,\n \"name\": \"User devuserfactory3 3\",\n \"username\": \"devuserfactory3\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"state\": \"running\",\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n },\n \"allowConcurrentExecutions\": true,\n \"timeZone\": \"America/Chicago\",\n \"nextExecutionAt\": null,\n \"archived\": false,\n \"createdAt\": \"2024-05-22T22:51:29.000Z\",\n \"updatedAt\": \"2024-05-22T22:51:29.000Z\"\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","X-Pagination-Per-Page":"20","Access-Control-Expose-Headers":"X-Pagination-Per-Page, X-Pagination-Current-Page, X-Pagination-Total-Pages, X-Pagination-Total-Entries","X-Pagination-Current-Page":"1","X-Pagination-Total-Pages":"1","X-Pagination-Total-Entries":"1","Content-Type":"application/json; charset=utf-8","ETag":"W/\"5d1215b30433385509ecaee1db741939\"","X-Request-Id":"5b81aa6e-3a49-423e-9ea2-c160cb312988","X-Runtime":"0.028595","Content-Length":"526"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/workflows?state[]=running\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer xwDV75DTa0KzHUgh78AYSa2V18YoPn_SR21QJHYXisE\" \\\n\t-H \"Accept: application/vnd.civis-platform.v1\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"post":{"summary":"Create a Workflow","description":null,"deprecated":false,"parameters":[{"name":"Object728","in":"body","schema":{"$ref":"#/definitions/Object728"},"required":true}],"responses":{"201":{"description":"success","schema":{"$ref":"#/definitions/Object730"}}},"x-examples":[{"resource":"Workflows","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/workflows","description":"create a workflow from a definition","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/workflows","request_body":"{\n \"name\": \"wf\",\n \"definition\": \"---\\nversion: 2\\n\\nmy_workflow:\\n type: direct\\n tasks:\\n task_1: &run\\n action: civis.run_job\\n task_2:\\n <<: *run\\n\",\n \"description\": \"This workflow takes Obama campaign data and does things\"\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer CjAFvJ49PIPb97p1JFyJZrLvCFyDqbwGAP7paKL25b0","Accept":"application/vnd.civis-platform.v1","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":201,"response_status_text":"Created","response_body":"{\n \"id\": 16,\n \"name\": \"wf\",\n \"description\": \"This workflow takes Obama campaign data and does things\",\n \"definition\": \"---\\nversion: 2\\n\\nmy_workflow:\\n type: direct\\n tasks:\\n task_1: &run\\n action: civis.run_job\\n task_2:\\n <<: *run\\n\",\n \"valid\": true,\n \"validationErrors\": null,\n \"fileId\": 16,\n \"user\": {\n \"id\": 10,\n \"name\": \"User devuserfactory5 5\",\n \"username\": \"devuserfactory5\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"state\": \"idle\",\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n },\n \"allowConcurrentExecutions\": true,\n \"timeZone\": \"America/Chicago\",\n \"nextExecutionAt\": null,\n \"notifications\": {\n \"urls\": [\n\n ],\n \"successEmailSubject\": null,\n \"successEmailBody\": null,\n \"successEmailAddresses\": [\n\n ],\n \"failureEmailAddresses\": [\n\n ],\n \"stallWarningMinutes\": null,\n \"successOn\": true,\n \"failureOn\": true\n },\n \"archived\": false,\n \"hidden\": false,\n \"myPermissionLevel\": \"manage\",\n \"createdAt\": \"2024-05-22T22:51:29.000Z\",\n \"updatedAt\": \"2024-05-22T22:51:29.000Z\"\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"e5e0fcfb0d5ef5e1c6a1fab2cfca1eaf\"","X-Request-Id":"fc09e6cd-a162-4eb1-8cbc-28d528f2d73d","X-Runtime":"0.176015","Content-Length":"994"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/workflows\" -d '{\"name\":\"wf\",\"definition\":\"---\\nversion: 2\\n\\nmy_workflow:\\n type: direct\\n tasks:\\n task_1: \\u0026run\\n action: civis.run_job\\n task_2:\\n \\u003c\\u003c: *run\\n\",\"description\":\"This workflow takes Obama campaign data and does things\"}' -X POST \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer CjAFvJ49PIPb97p1JFyJZrLvCFyDqbwGAP7paKL25b0\" \\\n\t-H \"Accept: application/vnd.civis-platform.v1\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Workflows","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/workflows","description":"create a workflow from an existing job chain","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/workflows","request_body":"{\n \"name\": \"wf\",\n \"from_job_chain\": 1\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer OmVr97xtCmcCR2oqlLIztHNRYK8dFulSXbjdZPRHaZY","Accept":"application/vnd.civis-platform.v1","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":201,"response_status_text":"Created","response_body":"{\n \"id\": 20,\n \"name\": \"wf\",\n \"description\": null,\n \"definition\": \"---\\nversion: '2.0'\\nworkflow:\\n type: direct\\n tasks:\\n 0_seconds_1:\\n action: civis.run_job\\n input:\\n job_id: 1\\n\",\n \"valid\": true,\n \"validationErrors\": null,\n \"fileId\": 20,\n \"user\": {\n \"id\": 11,\n \"name\": \"User devuserfactory6 6\",\n \"username\": \"devuserfactory6\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"state\": \"idle\",\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n },\n \"allowConcurrentExecutions\": true,\n \"timeZone\": \"America/Chicago\",\n \"nextExecutionAt\": null,\n \"notifications\": {\n \"urls\": [\n\n ],\n \"successEmailSubject\": null,\n \"successEmailBody\": null,\n \"successEmailAddresses\": [\n\n ],\n \"failureEmailAddresses\": [\n\n ],\n \"stallWarningMinutes\": null,\n \"successOn\": true,\n \"failureOn\": true\n },\n \"archived\": false,\n \"hidden\": false,\n \"myPermissionLevel\": \"manage\",\n \"createdAt\": \"2024-05-22T22:51:30.000Z\",\n \"updatedAt\": \"2024-05-22T22:51:30.000Z\"\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"b9947b8a45d31b4f417fe86cd92713a4\"","X-Request-Id":"f668d07d-10c4-4201-9e78-09199f1a1341","X-Runtime":"0.134885","Content-Length":"929"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/workflows\" -d '{\"name\":\"wf\",\"from_job_chain\":1}' -X POST \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer OmVr97xtCmcCR2oqlLIztHNRYK8dFulSXbjdZPRHaZY\" \\\n\t-H \"Accept: application/vnd.civis-platform.v1\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Workflows","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/workflows","description":"create an invalid workflow","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/workflows","request_body":"{\n \"name\": \"wf\",\n \"definition\": \"---\\nversion: 2\\n\\nmy_workflow:\\n type: direct\\n tasks:\\n task_1: &run\\n action: civis.run_job\\n task_2:\\n <<: *run\\n\"\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer Y2bZR6lhgZJw3uMw1qogKc6xZOGaW5l8-ttxDedctgY","Accept":"application/vnd.civis-platform.v1","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":201,"response_status_text":"Created","response_body":"{\n \"id\": 24,\n \"name\": \"wf\",\n \"description\": null,\n \"definition\": \"---\\nversion: 2\\n\\nmy_workflow:\\n type: direct\\n tasks:\\n task_1: &run\\n action: civis.run_job\\n task_2:\\n <<: *run\\n\",\n \"valid\": true,\n \"validationErrors\": null,\n \"fileId\": 24,\n \"user\": {\n \"id\": 12,\n \"name\": \"User devuserfactory7 7\",\n \"username\": \"devuserfactory7\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"state\": \"idle\",\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n },\n \"allowConcurrentExecutions\": true,\n \"timeZone\": \"America/Chicago\",\n \"nextExecutionAt\": null,\n \"notifications\": {\n \"urls\": [\n\n ],\n \"successEmailSubject\": null,\n \"successEmailBody\": null,\n \"successEmailAddresses\": [\n\n ],\n \"failureEmailAddresses\": [\n\n ],\n \"stallWarningMinutes\": null,\n \"successOn\": true,\n \"failureOn\": true\n },\n \"archived\": false,\n \"hidden\": false,\n \"myPermissionLevel\": \"manage\",\n \"createdAt\": \"2024-05-22T22:51:30.000Z\",\n \"updatedAt\": \"2024-05-22T22:51:30.000Z\"\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"36c99af84741b55473ee3bd463823308\"","X-Request-Id":"0027adef-9942-4143-a1df-35316ed5af9f","X-Runtime":"0.113178","Content-Length":"941"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/workflows\" -d '{\"name\":\"wf\",\"definition\":\"---\\nversion: 2\\n\\nmy_workflow:\\n type: direct\\n tasks:\\n task_1: \\u0026run\\n action: civis.run_job\\n task_2:\\n \\u003c\\u003c: *run\\n\"}' -X POST \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer Y2bZR6lhgZJw3uMw1qogKc6xZOGaW5l8-ttxDedctgY\" \\\n\t-H \"Accept: application/vnd.civis-platform.v1\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/workflows/{id}":{"get":{"summary":"Get a Workflow","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object730"}}},"x-examples":[{"resource":"Workflows","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/workflows/:id","description":"View a workflow's details","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/workflows/10","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer GQNnU4-e8NmRdkcX5by3EbAh-grMd22nzy41QOd-ttg","Accept":"application/vnd.civis-platform.v1","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 10,\n \"name\": \"Test Workflow\",\n \"description\": null,\n \"definition\": \"---\\nversion: 2\\n\\nmy_workflow:\\n type: direct\\n tasks:\\n task_1: &run\\n action: civis.run_job\\n task_2:\\n <<: *run\\n\",\n \"valid\": true,\n \"validationErrors\": null,\n \"fileId\": 10,\n \"user\": {\n \"id\": 9,\n \"name\": \"User devuserfactory4 4\",\n \"username\": \"devuserfactory4\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"state\": \"idle\",\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n },\n \"allowConcurrentExecutions\": true,\n \"timeZone\": \"America/Chicago\",\n \"nextExecutionAt\": null,\n \"notifications\": {\n \"urls\": [\n\n ],\n \"successEmailSubject\": null,\n \"successEmailBody\": null,\n \"successEmailAddresses\": [\n\n ],\n \"failureEmailAddresses\": [\n\n ],\n \"stallWarningMinutes\": null,\n \"successOn\": true,\n \"failureOn\": true\n },\n \"archived\": false,\n \"hidden\": false,\n \"myPermissionLevel\": \"manage\",\n \"createdAt\": \"2024-05-22T22:51:29.000Z\",\n \"updatedAt\": \"2024-05-22T22:51:29.000Z\"\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"f1e9c8c16ca08a86bace76aade4b3f1c\"","X-Request-Id":"7f2447b3-e6ca-4495-8ba5-aa357a52de10","X-Runtime":"0.034994","Content-Length":"951"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/workflows/10\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer GQNnU4-e8NmRdkcX5by3EbAh-grMd22nzy41QOd-ttg\" \\\n\t-H \"Accept: application/vnd.civis-platform.v1\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"put":{"summary":"Replace all attributes of this Workflow","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID for this workflow.","type":"integer"},{"name":"Object732","in":"body","schema":{"$ref":"#/definitions/Object732"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object730"}}},"x-examples":null,"x-deprecation-warning":null},"patch":{"summary":"Update some attributes of this Workflow","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID for this workflow.","type":"integer"},{"name":"Object733","in":"body","schema":{"$ref":"#/definitions/Object733"},"required":false}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object730"}}},"x-examples":null,"x-deprecation-warning":null}},"/workflows/{id}/shares":{"get":{"summary":"List users and groups permissioned on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object9"}}}},"x-examples":null,"x-deprecation-warning":null}},"/workflows/{id}/shares/users":{"put":{"summary":"Set the permissions users have on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"Object734","in":"body","schema":{"$ref":"#/definitions/Object734"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object9"}}},"x-examples":null,"x-deprecation-warning":null}},"/workflows/{id}/shares/users/{user_id}":{"delete":{"summary":"Revoke the permissions a user has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"user_id","in":"path","required":true,"description":"The ID of the user.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/workflows/{id}/shares/groups":{"put":{"summary":"Set the permissions groups has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"Object735","in":"body","schema":{"$ref":"#/definitions/Object735"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object9"}}},"x-examples":null,"x-deprecation-warning":null}},"/workflows/{id}/shares/groups/{group_id}":{"delete":{"summary":"Revoke the permissions a group has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"group_id","in":"path","required":true,"description":"The ID of the group.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/workflows/{id}/dependencies":{"get":{"summary":"List dependent objects for this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"user_id","in":"query","required":false,"description":"ID of target user","type":"integer"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object15"}}}},"x-examples":[{"resource":"Workflows","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/workflows/:id/dependencies","description":"Get all workflow dependencies","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/workflows/32/dependencies","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer GejPR1MlITDj1pddk_FjXaN1uCk49S7hpcR-bwTEU-s","Accept":"application/vnd.civis-platform.v1","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"objectType\": \"JobTypes::PythonDocker\",\n \"fcoType\": \"scripts/python3\",\n \"id\": 4,\n \"name\": \"Script #4\",\n \"permissionLevel\": null,\n \"description\": null,\n \"shareable\": true\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"ec324f877544ba95e18f9b1c59590096\"","X-Request-Id":"f8b66b94-d2ba-4902-b8b3-1f13e9e78f92","X-Runtime":"0.042823","Content-Length":"154"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/workflows/32/dependencies\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer GejPR1MlITDj1pddk_FjXaN1uCk49S7hpcR-bwTEU-s\" \\\n\t-H \"Accept: application/vnd.civis-platform.v1\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Workflows","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/workflows/:id/dependencies","description":"Get all workflow dependencies using a target user","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/workflows/36/dependencies?user_id=18","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer kOUs9VRMxk9UdaOMq2OpLV6x1WnGq9QJKQgQkZseAvM","Accept":"application/vnd.civis-platform.v1","Host":"api.civis.test","Cookie":""},"request_query_parameters":{"user_id":"18"},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"objectType\": \"JobTypes::PythonDocker\",\n \"fcoType\": \"scripts/python3\",\n \"id\": 7,\n \"name\": \"Script #7\",\n \"permissionLevel\": \"write\",\n \"description\": null,\n \"shareable\": true\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"c6af09ea9769478cbc76e42f557bf86a\"","X-Request-Id":"fa26d2bf-9027-4cd8-8b80-a7899ab94fdd","X-Runtime":"0.048351","Content-Length":"157"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/workflows/36/dependencies?user_id=18\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer kOUs9VRMxk9UdaOMq2OpLV6x1WnGq9QJKQgQkZseAvM\" \\\n\t-H \"Accept: application/vnd.civis-platform.v1\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/workflows/{id}/transfer":{"put":{"summary":"Transfer ownership of this object to another user","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"Object736","in":"body","schema":{"$ref":"#/definitions/Object736"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object17"}}},"x-examples":[{"resource":"Workflows","resource_explanation":null,"http_method":"PUT","route":"http://api.civis.test/workflows/:id/transfer","description":"Transfer object to another user, without transfering dependencies","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"PUT","request_path":"http://api.civis.test/workflows/40/transfer","request_body":"{\n \"user_id\": 24,\n \"include_dependencies\": false\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer oHZwZD1PiV2NH3EqWPTJKkl_wSgYH5aCfcBswJyjzyY","Accept":"application/vnd.civis-platform.v1","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"dependencies\": [\n\n ]\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"81059fe6210ccee4e3349c0f34c12d18\"","X-Request-Id":"4de92ce1-2985-4d18-a1ea-565888da3194","X-Runtime":"0.251599","Content-Length":"19"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/workflows/40/transfer\" -d '{\"user_id\":24,\"include_dependencies\":false}' -X PUT \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer oHZwZD1PiV2NH3EqWPTJKkl_wSgYH5aCfcBswJyjzyY\" \\\n\t-H \"Accept: application/vnd.civis-platform.v1\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Workflows","resource_explanation":null,"http_method":"PUT","route":"http://api.civis.test/workflows/:id/transfer","description":"Transfer object to another user, including dependencies","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"PUT","request_path":"http://api.civis.test/workflows/44/transfer","request_body":"{\n \"user_id\": 28,\n \"include_dependencies\": true\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer ewHziGa4NqP4KBJJjqoBDbnpP05zqz0U_Qc1dw6BDDk","Accept":"application/vnd.civis-platform.v1","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"dependencies\": [\n {\n \"objectType\": \"JobTypes::PythonDocker\",\n \"fcoType\": \"scripts/python3\",\n \"id\": 13,\n \"name\": \"Script #13\",\n \"permissionLevel\": \"manage\",\n \"description\": null,\n \"shared\": true\n }\n ]\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"b19a6595337e726ea5632e5f999ebed9\"","X-Request-Id":"e46a197c-d539-48b7-8c8a-1325ba587f12","X-Runtime":"0.229748","Content-Length":"174"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/workflows/44/transfer\" -d '{\"user_id\":28,\"include_dependencies\":true}' -X PUT \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer ewHziGa4NqP4KBJJjqoBDbnpP05zqz0U_Qc1dw6BDDk\" \\\n\t-H \"Accept: application/vnd.civis-platform.v1\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/workflows/{id}/archive":{"put":{"summary":"Update the archive status of this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the object.","type":"integer"},{"name":"Object737","in":"body","schema":{"$ref":"#/definitions/Object737"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object730"}}},"x-examples":null,"x-deprecation-warning":null}},"/workflows/{id}/projects":{"get":{"summary":"List the projects a Workflow belongs to","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Workflow.","type":"integer"},{"name":"hidden","in":"query","required":false,"description":"If specified to be true, returns hidden items. Defaults to false, returning non-hidden items.","type":"boolean"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object84"}}}},"x-examples":null,"x-deprecation-warning":null}},"/workflows/{id}/projects/{project_id}":{"put":{"summary":"Add a Workflow to a project","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Workflow.","type":"integer"},{"name":"project_id","in":"path","required":true,"description":"The ID of the project.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null},"delete":{"summary":"Remove a Workflow from a project","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Workflow.","type":"integer"},{"name":"project_id","in":"path","required":true,"description":"The ID of the project.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/workflows/{id}/git":{"get":{"summary":"Get the git metadata attached to an item","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the item.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object402"}}},"x-examples":null,"x-deprecation-warning":null},"put":{"summary":"Attach an item to a file in a git repo","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the item.","type":"integer"},{"name":"Object403","in":"body","schema":{"$ref":"#/definitions/Object403"},"required":false}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object402"}}},"x-examples":null,"x-deprecation-warning":null},"patch":{"summary":"Update an attached git file","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the item.","type":"integer"},{"name":"Object403","in":"body","schema":{"$ref":"#/definitions/Object403"},"required":false}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object402"}}},"x-examples":null,"x-deprecation-warning":null}},"/workflows/{id}/git/commits":{"get":{"summary":"Get the git commits for an item on the current branch","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the item.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object404"}}},"x-examples":null,"x-deprecation-warning":null},"post":{"summary":"Commit and push a new version of the file","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the item.","type":"integer"},{"name":"Object405","in":"body","schema":{"$ref":"#/definitions/Object405"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object406"}}},"x-examples":null,"x-deprecation-warning":null}},"/workflows/{id}/git/commits/{commit_hash}":{"get":{"summary":"Get file contents at git ref","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the item.","type":"integer"},{"name":"commit_hash","in":"path","required":true,"description":"The SHA (full or shortened) of the desired git commit.","type":"string"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object406"}}},"x-examples":null,"x-deprecation-warning":null}},"/workflows/{id}/git/checkout-latest":{"post":{"summary":"Checkout latest commit on the current branch of a script or workflow","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the item.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object406"}}},"x-examples":null,"x-deprecation-warning":null}},"/workflows/{id}/clone":{"post":{"summary":"Clone this Workflow","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID for the workflow.","type":"integer"},{"name":"Object738","in":"body","schema":{"$ref":"#/definitions/Object738"},"required":false}],"responses":{"201":{"description":"success","schema":{"$ref":"#/definitions/Object730"}}},"x-examples":[{"resource":"Workflows","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/workflows/:id/clone","description":"clone a workflow","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/workflows/25/clone","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer 2k57MsTZfCGXKYnA2FOsBuO9dG9oKxpWTCD_whFT2Q0","Accept":"application/vnd.civis-platform.v1","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":201,"response_status_text":"Created","response_body":"{\n \"id\": 28,\n \"name\": \"Clone of Workflow 25 Test Workflow\",\n \"description\": null,\n \"definition\": \"---\\nversion: 2\\n\\nmy_workflow:\\n type: direct\\n tasks:\\n task_1: &run\\n action: civis.run_job\\n task_2:\\n <<: *run\\n\",\n \"valid\": true,\n \"validationErrors\": null,\n \"fileId\": 28,\n \"user\": {\n \"id\": 13,\n \"name\": \"User devuserfactory8 8\",\n \"username\": \"devuserfactory8\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"state\": \"idle\",\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n },\n \"allowConcurrentExecutions\": true,\n \"timeZone\": \"America/Chicago\",\n \"nextExecutionAt\": null,\n \"notifications\": {\n \"urls\": [\n\n ],\n \"successEmailSubject\": null,\n \"successEmailBody\": null,\n \"successEmailAddresses\": [\n \"devuserfactory88user@localhost.test\"\n ],\n \"failureEmailAddresses\": [\n \"devuserfactory88user@localhost.test\"\n ],\n \"stallWarningMinutes\": null,\n \"successOn\": true,\n \"failureOn\": true\n },\n \"archived\": false,\n \"hidden\": false,\n \"myPermissionLevel\": \"manage\",\n \"createdAt\": \"2024-05-22T22:51:31.000Z\",\n \"updatedAt\": \"2024-05-22T22:51:31.000Z\"\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"fded054f9a569b67aa9e142e103fcf9e\"","X-Request-Id":"ff7668ee-df96-42c3-8894-0a273a70912e","X-Runtime":"0.115785","Content-Length":"1047"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/workflows/25/clone\" -d '' -X POST \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer 2k57MsTZfCGXKYnA2FOsBuO9dG9oKxpWTCD_whFT2Q0\" \\\n\t-H \"Accept: application/vnd.civis-platform.v1\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/workflows/{id}/executions":{"get":{"summary":"List workflow executions","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID for this workflow.","type":"integer"},{"name":"limit","in":"query","required":false,"description":"Number of results to return. Defaults to 20. Maximum allowed is 50.","type":"integer"},{"name":"page_num","in":"query","required":false,"description":"Page number of the results to return. Defaults to the first page, 1.","type":"integer"},{"name":"order","in":"query","required":false,"description":"The field on which to order the result set. Defaults to id. Must be one of: id, updated_at, created_at.","type":"string"},{"name":"order_dir","in":"query","required":false,"description":"Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc.","type":"string"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object739"}}}},"x-examples":[{"resource":"Workflows","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/workflows/:id/executions","description":"list workflow executions","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/workflows/48/executions","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer P7bjt9bkgOtv0Y8cK11wlvyS9lE0AzGlnWR51FC9EJc","Accept":"application/vnd.civis-platform.v1","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 3,\n \"state\": \"running\",\n \"mistralState\": \"running\",\n \"mistralStateInfo\": \"Execution is running\",\n \"user\": {\n \"id\": 30,\n \"name\": \"User devuserfactory25 25\",\n \"username\": \"devuserfactory25\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"startedAt\": \"2024-05-22T22:51:34.000Z\",\n \"finishedAt\": null,\n \"createdAt\": \"2024-05-22T22:51:35.000Z\",\n \"updatedAt\": \"2024-05-22T22:51:35.000Z\"\n },\n {\n \"id\": 2,\n \"state\": \"running\",\n \"mistralState\": \"running\",\n \"mistralStateInfo\": \"Execution is running\",\n \"user\": {\n \"id\": 30,\n \"name\": \"User devuserfactory25 25\",\n \"username\": \"devuserfactory25\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"startedAt\": \"2024-05-22T22:51:34.000Z\",\n \"finishedAt\": null,\n \"createdAt\": \"2024-05-22T22:51:34.000Z\",\n \"updatedAt\": \"2024-05-22T22:51:35.000Z\"\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","X-Pagination-Per-Page":"20","Access-Control-Expose-Headers":"X-Pagination-Per-Page, X-Pagination-Current-Page, X-Pagination-Total-Pages, X-Pagination-Total-Entries","X-Pagination-Current-Page":"1","X-Pagination-Total-Pages":"1","X-Pagination-Total-Entries":"2","Content-Type":"application/json; charset=utf-8","ETag":"W/\"4a1da96cfa849abc81045e11284bcd92\"","X-Request-Id":"39f9d9da-b612-4603-a440-73635e022fee","X-Runtime":"0.040623","Content-Length":"681"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/workflows/48/executions\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer P7bjt9bkgOtv0Y8cK11wlvyS9lE0AzGlnWR51FC9EJc\" \\\n\t-H \"Accept: application/vnd.civis-platform.v1\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"post":{"summary":"Execute a workflow","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID for the workflow.","type":"integer"},{"name":"Object744","in":"body","schema":{"$ref":"#/definitions/Object744"},"required":false}],"responses":{"201":{"description":"success","schema":{"$ref":"#/definitions/Object740"}}},"x-examples":[{"resource":"Workflows","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/workflows/:id/executions","description":"execute a workflow","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/workflows/45/executions","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer RmJmy4nVIQlPqGtz5-jUp12hMpvuwTT7BhILLwl5dak","Accept":"application/vnd.civis-platform.v1","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":201,"response_status_text":"Created","response_body":"{\n \"id\": 1,\n \"state\": \"running\",\n \"mistralState\": \"running\",\n \"mistralStateInfo\": \"Execution is running\",\n \"user\": {\n \"id\": 29,\n \"name\": \"User devuserfactory24 24\",\n \"username\": \"devuserfactory24\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"definition\": \"---\\nversion: 2\\nmy_workflow:\\n type: direct\\n tasks:\\n task_1:\\n action: civis.run_job\\n task_2:\\n action: civis.run_job\\n\",\n \"input\": {\n },\n \"includedTasks\": [\n\n ],\n \"tasks\": [\n\n ],\n \"startedAt\": \"2024-05-22T22:51:34.000Z\",\n \"finishedAt\": null,\n \"createdAt\": \"2024-05-22T22:51:34.000Z\",\n \"updatedAt\": \"2024-05-22T22:51:34.000Z\"\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"5d510e2db043744b95a0d7954ab24925\"","X-Request-Id":"9020dc3d-9934-48fb-a3cb-07365001a68a","X-Runtime":"0.122870","Content-Length":"537"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/workflows/45/executions\" -d '' -X POST \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer RmJmy4nVIQlPqGtz5-jUp12hMpvuwTT7BhILLwl5dak\" \\\n\t-H \"Accept: application/vnd.civis-platform.v1\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/workflows/{id}/executions/{execution_id}":{"get":{"summary":"Get a workflow execution","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID for the workflow.","type":"integer"},{"name":"execution_id","in":"path","required":true,"description":"The ID for the workflow execution.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object740"}}},"x-examples":[{"resource":"Workflows","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/workflows/:id/executions/:execution_id","description":"get workflow execution","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/workflows/51/executions/4","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer P8xtiPH3qjHsNIoeLvh14KRGM04vsv0MjPDc9V1Jrq0","Accept":"application/vnd.civis-platform.v1","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 4,\n \"state\": \"running\",\n \"mistralState\": \"running\",\n \"mistralStateInfo\": \"Execution is running\",\n \"user\": {\n \"id\": 31,\n \"name\": \"User devuserfactory26 26\",\n \"username\": \"devuserfactory26\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"definition\": \"---\\nversion: 2\\nmy_workflow:\\n type: direct\\n tasks:\\n task_1:\\n action: civis.run_job\\n task_2:\\n action: civis.run_job\\n\",\n \"input\": {\n },\n \"includedTasks\": [\n\n ],\n \"tasks\": [\n {\n \"name\": \"load\",\n \"mistralState\": \"running\",\n \"mistralStateInfo\": null,\n \"runs\": [\n\n ],\n \"executions\": [\n\n ]\n }\n ],\n \"startedAt\": \"2024-05-22T22:51:35.000Z\",\n \"finishedAt\": null,\n \"createdAt\": \"2024-05-22T22:51:35.000Z\",\n \"updatedAt\": \"2024-05-22T22:51:35.000Z\"\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"6fa89a29ef9ea9ff52d6248c5cda36a7\"","X-Request-Id":"70cee414-1f5a-4e37-8e12-f690a8589c74","X-Runtime":"0.049116","Content-Length":"627"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/workflows/51/executions/4\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer P8xtiPH3qjHsNIoeLvh14KRGM04vsv0MjPDc9V1Jrq0\" \\\n\t-H \"Accept: application/vnd.civis-platform.v1\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/workflows/{id}/executions/{execution_id}/cancel":{"post":{"summary":"Cancel a workflow execution","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID for the workflow.","type":"integer"},{"name":"execution_id","in":"path","required":true,"description":"The ID for the workflow execution.","type":"integer"}],"responses":{"202":{"description":"success","schema":{"$ref":"#/definitions/Object740"}}},"x-examples":[{"resource":"Workflows","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/workflows/:id/executions/:execution_id/cancel","description":"cancel the workflow execution","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/workflows/57/executions/6/cancel","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer NRZOZ_HOFNynEe670P7Ft21RUWgmUy-Lj6Y2NC0jQT8","Accept":"application/vnd.civis-platform.v1","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":202,"response_status_text":"Accepted","response_body":"{\n \"id\": 6,\n \"state\": \"running\",\n \"mistralState\": \"running\",\n \"mistralStateInfo\": \"Execution is running\",\n \"user\": {\n \"id\": 35,\n \"name\": \"User devuserfactory30 30\",\n \"username\": \"devuserfactory30\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"definition\": \"---\\nversion: 2\\nmy_workflow:\\n type: direct\\n tasks:\\n task_1:\\n action: civis.run_job\\n task_2:\\n action: civis.run_job\\n\",\n \"input\": {\n },\n \"includedTasks\": [\n\n ],\n \"tasks\": [\n\n ],\n \"startedAt\": \"2024-05-22T22:51:36.000Z\",\n \"finishedAt\": null,\n \"createdAt\": \"2024-05-22T22:51:36.000Z\",\n \"updatedAt\": \"2024-05-22T22:51:36.000Z\"\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","X-Request-Id":"03fd7c5d-1bb7-4898-88db-3c800c5b1a46","X-Runtime":"0.057933","Content-Length":"537"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/workflows/57/executions/6/cancel\" -d '' -X POST \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer NRZOZ_HOFNynEe670P7Ft21RUWgmUy-Lj6Y2NC0jQT8\" \\\n\t-H \"Accept: application/vnd.civis-platform.v1\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/workflows/{id}/executions/{execution_id}/resume":{"post":{"summary":"Resume a paused workflow execution","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID for the workflow.","type":"integer"},{"name":"execution_id","in":"path","required":true,"description":"The ID for the workflow execution.","type":"integer"}],"responses":{"202":{"description":"success","schema":{"$ref":"#/definitions/Object740"}}},"x-examples":[{"resource":"Workflows","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/workflows/:id/executions/:execution_id/resume","description":"resume a paused workflow execution","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/workflows/60/executions/7/resume","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer 4Xr36FnrHDlRLeyrF5aZ1TLrE-J2jGlr6vtsoLCC3ic","Accept":"application/vnd.civis-platform.v1","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":202,"response_status_text":"Accepted","response_body":"{\n \"id\": 7,\n \"state\": \"running\",\n \"mistralState\": \"running\",\n \"mistralStateInfo\": \"Execution is running\",\n \"user\": {\n \"id\": 36,\n \"name\": \"User devuserfactory31 31\",\n \"username\": \"devuserfactory31\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"definition\": \"---\\nversion: 2\\nmy_workflow:\\n type: direct\\n tasks:\\n task_1:\\n action: civis.run_job\\n task_2:\\n action: civis.run_job\\n\",\n \"input\": {\n },\n \"includedTasks\": [\n\n ],\n \"tasks\": [\n\n ],\n \"startedAt\": \"2024-05-22T22:51:36.000Z\",\n \"finishedAt\": null,\n \"createdAt\": \"2024-05-22T22:51:36.000Z\",\n \"updatedAt\": \"2024-05-22T22:51:36.000Z\"\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","X-Request-Id":"39a57502-7ec5-40a5-aeff-b22b153b0031","X-Runtime":"0.060767","Content-Length":"537"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/workflows/60/executions/7/resume\" -d '' -X POST \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer 4Xr36FnrHDlRLeyrF5aZ1TLrE-J2jGlr6vtsoLCC3ic\" \\\n\t-H \"Accept: application/vnd.civis-platform.v1\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/workflows/{id}/executions/{execution_id}/retry":{"post":{"summary":"Retry a failed task, or all failed tasks in an execution","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID for the workflow.","type":"integer"},{"name":"execution_id","in":"path","required":true,"description":"The ID for the workflow execution.","type":"integer"},{"name":"Object746","in":"body","schema":{"$ref":"#/definitions/Object746"},"required":false}],"responses":{"202":{"description":"success","schema":{"$ref":"#/definitions/Object740"}}},"x-examples":[{"resource":"Workflows","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/workflows/:id/executions/:execution_id/retry","description":"retry all failed tasks in a workflow execution","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/workflows/63/executions/8/retry","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer X1BnSwJQRs8qSygJ7waYtwZ8IUy2wQXXLeYSmxnkaZQ","Accept":"application/vnd.civis-platform.v1","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":202,"response_status_text":"Accepted","response_body":"{\n \"id\": 8,\n \"state\": \"running\",\n \"mistralState\": \"running\",\n \"mistralStateInfo\": \"Execution is running\",\n \"user\": {\n \"id\": 37,\n \"name\": \"User devuserfactory32 32\",\n \"username\": \"devuserfactory32\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"definition\": \"---\\nversion: 2\\nmy_workflow:\\n type: direct\\n tasks:\\n task_1:\\n action: civis.run_job\\n task_2:\\n action: civis.run_job\\n\",\n \"input\": {\n },\n \"includedTasks\": [\n\n ],\n \"tasks\": [\n {\n \"name\": \"load\",\n \"mistralState\": \"running\",\n \"mistralStateInfo\": null,\n \"runs\": [\n\n ],\n \"executions\": [\n\n ]\n }\n ],\n \"startedAt\": \"2024-05-22T22:51:36.000Z\",\n \"finishedAt\": null,\n \"createdAt\": \"2024-05-22T22:51:36.000Z\",\n \"updatedAt\": \"2024-05-22T22:51:36.000Z\"\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","X-Request-Id":"bb31e148-0ecc-4b83-b405-64f298d34dc8","X-Runtime":"0.050723","Content-Length":"627"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/workflows/63/executions/8/retry\" -d '' -X POST \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer X1BnSwJQRs8qSygJ7waYtwZ8IUy2wQXXLeYSmxnkaZQ\" \\\n\t-H \"Accept: application/vnd.civis-platform.v1\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Workflows","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/workflows/:id/executions/:execution_id/retry","description":"retry one failed task in a workflow execution","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/workflows/66/executions/9/retry","request_body":"{\n \"task_name\": \"load\"\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer XbPzJsExyJI6CQpUIjs_B-1aZds6SXYZ9fCYE2-TBM8","Accept":"application/vnd.civis-platform.v1","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":202,"response_status_text":"Accepted","response_body":"{\n \"id\": 9,\n \"state\": \"running\",\n \"mistralState\": \"running\",\n \"mistralStateInfo\": \"Execution is running\",\n \"user\": {\n \"id\": 38,\n \"name\": \"User devuserfactory33 33\",\n \"username\": \"devuserfactory33\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"definition\": \"---\\nversion: 2\\nmy_workflow:\\n type: direct\\n tasks:\\n task_1:\\n action: civis.run_job\\n task_2:\\n action: civis.run_job\\n\",\n \"input\": {\n },\n \"includedTasks\": [\n\n ],\n \"tasks\": [\n {\n \"name\": \"load\",\n \"mistralState\": \"running\",\n \"mistralStateInfo\": null,\n \"runs\": [\n\n ],\n \"executions\": [\n\n ]\n }\n ],\n \"startedAt\": \"2024-05-22T22:51:37.000Z\",\n \"finishedAt\": null,\n \"createdAt\": \"2024-05-22T22:51:37.000Z\",\n \"updatedAt\": \"2024-05-22T22:51:37.000Z\"\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","X-Request-Id":"58e327a0-d7f6-4b4f-b21c-8d795a1dfa54","X-Runtime":"0.048342","Content-Length":"627"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/workflows/66/executions/9/retry\" -d '{\"task_name\":\"load\"}' -X POST \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer XbPzJsExyJI6CQpUIjs_B-1aZds6SXYZ9fCYE2-TBM8\" \\\n\t-H \"Accept: application/vnd.civis-platform.v1\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/workflows/{id}/executions/{execution_id}/tasks/{task_name}":{"get":{"summary":"Get a task of a workflow execution","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID for the workflow.","type":"integer"},{"name":"execution_id","in":"path","required":true,"description":"The ID for the workflow execution.","type":"integer"},{"name":"task_name","in":"path","required":true,"description":"The URL-encoded name of the task.","type":"string"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object747"}}},"x-examples":[{"resource":"Workflows","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/workflows/:id/executions/:execution_id/tasks/:task_name","description":"get details for a task in a workflow execution","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/workflows/54/executions/5/tasks/load","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer 6nzBTLbMFt6OMioBGBu3_UynvMJ2Q5aEPZ8qqhe27QY","Accept":"application/vnd.civis-platform.v1","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"name\": \"load\",\n \"mistralState\": \"running\",\n \"mistralStateInfo\": null,\n \"runs\": [\n\n ],\n \"executions\": [\n\n ]\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"2238f441f0272f023c85ea5e6ce5f8ca\"","X-Request-Id":"7f679911-22eb-4fa3-950b-0436ed070aae","X-Runtime":"0.036737","Content-Length":"90"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/workflows/54/executions/5/tasks/load\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer 6nzBTLbMFt6OMioBGBu3_UynvMJ2Q5aEPZ8qqhe27QY\" \\\n\t-H \"Accept: application/vnd.civis-platform.v1\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}}},"definitions":{"Object0":{"type":"object","properties":{"id":{"description":"The ID of this announcement","type":"integer"},"subject":{"description":"The subject of this announcement.","type":"string"},"body":{"description":"The body of this announcement.","type":"string"},"releasedAt":{"description":"The date and time this announcement was released.","type":"string","format":"date-time"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}}},"Object5":{"type":"object","properties":{"id":{"description":"The ID of the logo image file.","type":"integer"},"downloadUrl":{"description":"The URL of the logo image file.","type":"string"}}},"Object4":{"type":"object","properties":{"id":{"description":"The ID of this theme.","type":"integer"},"name":{"description":"The name of this theme.","type":"string"},"organizationIds":{"description":"List of organization ID's allowed to use this theme.","type":"array","items":{"type":"integer"}},"settings":{"description":"The theme configuration object.","type":"string"},"logoFile":{"description":"The logo image file.","$ref":"#/definitions/Object5"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}}},"Object8":{"type":"object","properties":{"dedicatedDjPoolEnabled":{"description":"If true, the Organization has a dedicated delayed jobs pool. Defaults to false.","type":"boolean"}}},"Object7":{"type":"object","properties":{"id":{"description":"The ID of this organization.","type":"integer"},"name":{"description":"The name of this organization.","type":"string"},"slug":{"description":"The slug of this organization.","type":"string"},"accountManagerId":{"description":"The user ID of the Account Manager.","type":"integer"},"csSpecialistId":{"description":"The user ID of the Client Success Specialist.","type":"integer"},"status":{"description":"The status of the organization (active/trial/inactive).","type":"string"},"orgType":{"description":"The organization type (platform/ads/survey_vendor/other).","type":"string"},"customBranding":{"description":"The custom branding settings.","type":"string"},"contractSize":{"description":"The monthly contract size.","type":"integer"},"maxAnalystUsers":{"description":"The max number of full platform users for the org.","type":"integer"},"maxReportUsers":{"description":"The max number of report-only platform users for the org.","type":"integer"},"vertical":{"description":"The business vertical that the organization belongs to.","type":"string"},"csMetadata":{"description":"Additional metadata about the organization in JSON format.","type":"string"},"removeFooterInEmails":{"description":"If true, emails sent by platform will not include Civis text.","type":"boolean"},"salesforceAccountId":{"description":"The Salesforce Account ID for this organization.","type":"string"},"tableauSiteId":{"description":"The Tableau Site ID for this organization.","type":"string"},"fedrampEnabled":{"description":"Flag denoting whether this organization is FedRAMP compliant.","type":"boolean"},"createdById":{"description":"The ID of the user who created this organization","type":"integer"},"lastUpdatedById":{"description":"The ID of the user who last updated this organization","type":"integer"},"advancedSettings":{"description":"The advanced settings for this organization.","$ref":"#/definitions/Object8"},"tableauRefreshHistory":{"description":"The number of tableau refreshes used this month.","type":"array","items":{"type":"object"}}}},"Object11":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"}}},"Object12":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"}}},"Object10":{"type":"object","properties":{"users":{"type":"array","items":{"$ref":"#/definitions/Object11"}},"groups":{"type":"array","items":{"$ref":"#/definitions/Object12"}}}},"Object9":{"type":"object","properties":{"readers":{"$ref":"#/definitions/Object10"},"writers":{"$ref":"#/definitions/Object10"},"owners":{"$ref":"#/definitions/Object10"},"totalUserShares":{"description":"For owners, the number of total users shared. For writers and readers, the number of visible users shared.","type":"integer"},"totalGroupShares":{"description":"For owners, the number of total groups shared. For writers and readers, the number of visible groups shared.","type":"integer"}}},"Object13":{"type":"object","properties":{"userIds":{"description":"An array of one or more user IDs.","type":"array","items":{"type":"integer"}},"permissionLevel":{"description":"Options are: \"read\", \"write\", or \"manage\".","type":"string"},"shareEmailBody":{"description":"Custom body text for e-mail sent on a share.","type":"string"},"sendSharedEmail":{"description":"Send email to the recipients of a share.","type":"boolean"}},"required":["userIds","permissionLevel"]},"Object14":{"type":"object","properties":{"groupIds":{"description":"An array of one or more group IDs.","type":"array","items":{"type":"integer"}},"permissionLevel":{"description":"Options are: \"read\", \"write\", or \"manage\".","type":"string"},"shareEmailBody":{"description":"Custom body text for e-mail sent on a share.","type":"string"},"sendSharedEmail":{"description":"Send email to the recipients of a share.","type":"boolean"}},"required":["groupIds","permissionLevel"]},"Object15":{"type":"object","properties":{"objectType":{"description":"Dependent object type","type":"string"},"fcoType":{"description":"Human readable dependent object type","type":"string"},"id":{"description":"Dependent object ID","type":"integer"},"name":{"description":"Dependent object name, or nil if the requesting user cannot read this object","type":"string"},"permissionLevel":{"description":"Permission level of target user (not user's groups) for dependent object. Null if no target user or not shareable (e.g. a database table).","type":"string"},"description":{"description":"Additional information about the dependency, if relevant","type":"string"},"shareable":{"description":"Whether or not the requesting user can share this object.","type":"boolean"}}},"Object16":{"type":"object","properties":{"userId":{"description":"ID of target user","type":"integer"},"includeDependencies":{"description":"Whether or not to give manage permissions on all dependencies","type":"boolean"},"emailBody":{"description":"Custom body text for e-mail sent on transfer.","type":"string"},"sendEmail":{"description":"Send email to the target user of the transfer?","type":"boolean"}},"required":["userId","includeDependencies"]},"Object18":{"type":"object","properties":{"objectType":{"description":"Dependent object type","type":"string"},"fcoType":{"description":"Human readable dependent object type","type":"string"},"id":{"description":"Dependent object ID","type":"integer"},"name":{"description":"Dependent object name, or nil if the requesting user cannot read this object","type":"string"},"permissionLevel":{"description":"Permission level of target user (not user's groups) for dependent object. Null if no target user or not shareable (e.g. a database table).","type":"string"},"description":{"description":"Additional information about the dependency, if relevant","type":"string"},"shared":{"description":"Whether dependent object was successfully shared with target user","type":"boolean"}}},"Object17":{"type":"object","properties":{"dependencies":{"description":"Dependent objects for this object","type":"array","items":{"$ref":"#/definitions/Object18"}}}},"Object19":{"type":"object","properties":{"id":{"description":"The id of the Alias object.","type":"integer"},"objectId":{"description":"The id of the object","type":"integer"},"objectType":{"description":"The type of the object. Valid types include: cass_ncoa, container_script, geocode, identity_resolution, dbt_script, python_script, r_script, javascript_script, sql_script, project, notebook, workflow, template_script, template_report, service, report, tableau and service_report.","type":"string"},"alias":{"description":"The alias of the object","type":"string"},"userId":{"description":"The id of the user who created the alias","type":"integer"},"displayName":{"description":"The display name of the Alias object. Defaults to object name if not provided.","type":"string"}}},"Object20":{"type":"object","properties":{"objectId":{"description":"The id of the object","type":"integer"},"objectType":{"description":"The type of the object. Valid types include: cass_ncoa, container_script, geocode, identity_resolution, dbt_script, python_script, r_script, javascript_script, sql_script, project, notebook, workflow, template_script, template_report, service, report, tableau and service_report.","type":"string"},"alias":{"description":"The alias of the object","type":"string"},"displayName":{"description":"The display name of the Alias object. Defaults to object name if not provided.","type":"string"}},"required":["objectId","objectType","alias"]},"Object21":{"type":"object","properties":{"objectId":{"description":"The id of the object","type":"integer"},"objectType":{"description":"The type of the object. Valid types include: cass_ncoa, container_script, geocode, identity_resolution, dbt_script, python_script, r_script, javascript_script, sql_script, project, notebook, workflow, template_script, template_report, service, report, tableau and service_report.","type":"string"},"alias":{"description":"The alias of the object","type":"string"},"displayName":{"description":"The display name of the Alias object. Defaults to object name if not provided.","type":"string"}},"required":["objectId","objectType","alias"]},"Object22":{"type":"object","properties":{"objectId":{"description":"The id of the object","type":"integer"},"objectType":{"description":"The type of the object. Valid types include: cass_ncoa, container_script, geocode, identity_resolution, dbt_script, python_script, r_script, javascript_script, sql_script, project, notebook, workflow, template_script, template_report, service, report, tableau and service_report.","type":"string"},"alias":{"description":"The alias of the object","type":"string"},"displayName":{"description":"The display name of the Alias object. Defaults to object name if not provided.","type":"string"}}},"Object27":{"type":"object","properties":{"pendingMemoryRequested":{"description":"The sum of memory requests (in MB) for pending deployments in this instance config.","type":"integer"},"pendingCpuRequested":{"description":"The sum of cpu requests (in millicores) for pending deployments in this instance config.","type":"integer"},"runningMemoryRequested":{"description":"The sum of memory requests (in MB) for running deployments in this instance config.","type":"integer"},"runningCpuRequested":{"description":"The sum of cpu requests (in millicores) for running deployments in this instance config.","type":"integer"},"pendingDeployments":{"description":"The number of pending deployments in this instance config.","type":"integer"},"runningDeployments":{"description":"The number of running deployments in this instance config.","type":"integer"}}},"Object26":{"type":"object","properties":{"instanceConfigId":{"description":"The ID of this InstanceConfig.","type":"integer"},"instanceType":{"description":"An EC2 instance type. Possible values include t2.large, m4.xlarge, m4.2xlarge, m4.4xlarge, m5.12xlarge, c5.18xlarge, and g6.2xlarge.","type":"string"},"minInstances":{"description":"The minimum number of instances of that type in this cluster.","type":"integer"},"maxInstances":{"description":"The maximum number of instances of that type in this cluster.","type":"integer"},"instanceMaxMemory":{"description":"The amount of memory (RAM) available to a single instance of that type in megabytes.","type":"integer"},"instanceMaxCpu":{"description":"The number of processor shares available to a single instance of that type in millicores.","type":"integer"},"instanceMaxDisk":{"description":"The amount of disk available to a single instance of that type in gigabytes.","type":"integer"},"usageStats":{"description":"Usage statistics for this instance config","$ref":"#/definitions/Object27"}}},"Object25":{"type":"object","properties":{"clusterPartitionId":{"description":"The ID of this cluster partition.","type":"integer"},"name":{"description":"The name of the cluster partition.","type":"string"},"labels":{"description":"Labels associated with this partition.","type":"array","items":{"type":"string"}},"instanceConfigs":{"description":"The instances configured for this cluster partition.","type":"array","items":{"$ref":"#/definitions/Object26"}},"defaultInstanceConfigId":{"description":"The id of the InstanceConfig that is the default for this partition.","type":"integer"}}},"Object24":{"type":"object","properties":{"id":{"description":"The ID of this cluster.","type":"integer"},"organizationId":{"description":"The id of this cluster's organization.","type":"string"},"organizationName":{"description":"The name of this cluster's organization.","type":"string"},"organizationSlug":{"description":"The slug of this cluster's organization.","type":"string"},"rawClusterSlug":{"description":"The slug of this cluster's raw configuration.","type":"string"},"customPartitions":{"description":"Whether this cluster has a custom partition configuration.","type":"boolean"},"clusterPartitions":{"description":"List of cluster partitions associated with this cluster.","type":"array","items":{"$ref":"#/definitions/Object25"}},"isNatEnabled":{"description":"Whether this cluster needs a NAT gateway or not.","type":"boolean"}}},"Object29":{"type":"object","properties":{"id":{"description":"The ID of this cluster.","type":"integer"},"organizationId":{"description":"The id of this cluster's organization.","type":"string"},"organizationName":{"description":"The name of this cluster's organization.","type":"string"},"organizationSlug":{"description":"The slug of this cluster's organization.","type":"string"},"rawClusterSlug":{"description":"The slug of this cluster's raw configuration.","type":"string"},"customPartitions":{"description":"Whether this cluster has a custom partition configuration.","type":"boolean"},"clusterPartitions":{"description":"List of cluster partitions associated with this cluster.","type":"array","items":{"$ref":"#/definitions/Object25"}},"isNatEnabled":{"description":"Whether this cluster needs a NAT gateway or not.","type":"boolean"},"hours":{"description":"The number of hours used this month for this cluster.","type":"number","format":"float"}}},"Object30":{"type":"object","properties":{"totalNormalizedHours":{"description":"The total number of normalized hours used by this cluster.","type":"integer"},"normalizedHoursByInstanceType":{"description":"Denotes the instance type the normalized hours are attributed to.","type":"string"},"updatedAt":{"type":"string","format":"time"},"monthAndYear":{"description":"The month and year the normalized hours are attributed to.","type":"string"}}},"Object33":{"type":"object","properties":{"id":{"description":"The ID of this user.","type":"integer"},"name":{"description":"This user's name.","type":"string"},"username":{"description":"This user's username.","type":"string"},"initials":{"description":"This user's initials.","type":"string"},"online":{"description":"Whether this user is online.","type":"boolean"}}},"Object32":{"type":"object","properties":{"id":{"description":"The id of this deployment.","type":"integer"},"name":{"description":"The name of the deployment.","type":"string"},"baseId":{"description":"The id of the base object associated with the deployment.","type":"integer"},"baseType":{"description":"The base type of this deployment.","type":"string"},"state":{"description":"The state of the deployment.","type":"string"},"cpu":{"description":"The CPU in millicores required by the deployment.","type":"integer"},"memory":{"description":"The memory in MB required by the deployment.","type":"integer"},"diskSpace":{"description":"The disk space in GB required by the deployment.","type":"integer"},"instanceType":{"description":"The EC2 instance type requested for the deployment.","type":"string"},"author":{"description":"The author/owner of the item.","$ref":"#/definitions/Object33"},"maxMemoryUsage":{"description":"If the deployment has finished, the maximum amount of memory used during the deployment, in MB.","type":"number","format":"float"},"maxCpuUsage":{"description":"If the deployment has finished, the maximum amount of cpu used during the deployment, in millicores.","type":"number","format":"float"},"createdAt":{"type":"string","format":"time"},"updatedAt":{"type":"string","format":"time"}}},"Object34":{"type":"object","properties":{"baseType":{"description":"The base type of this deployment","type":"string"},"state":{"description":"State of the deployment","type":"string"},"count":{"description":"Number of deployments of base type and state","type":"integer"},"totalCpu":{"description":"Total amount of CPU in millicores for deployments of base type and state","type":"integer"},"totalMemory":{"description":"Total amount of Memory in megabytes for deployments of base type and state","type":"integer"}}},"Object36":{"type":"object","properties":{"instanceType":{"description":"An EC2 instance type. Possible values include t2.large, m4.xlarge, m4.2xlarge, m4.4xlarge, m5.12xlarge, c5.18xlarge, and g6.2xlarge.","type":"string"},"minInstances":{"description":"The minimum number of instances of that type in this cluster.","type":"integer"},"maxInstances":{"description":"The maximum number of instances of that type in this cluster.","type":"integer"}},"required":["instanceType","minInstances","maxInstances"]},"Object35":{"type":"object","properties":{"instanceConfigs":{"description":"The instances configured for this cluster partition.","type":"array","items":{"$ref":"#/definitions/Object36"}},"name":{"description":"The name of the cluster partition.","type":"string"},"labels":{"description":"Labels associated with this partition.","type":"array","items":{"type":"string"}}},"required":["instanceConfigs","name","labels"]},"Object38":{"type":"object","properties":{"instanceType":{"description":"An EC2 instance type. Possible values include t2.large, m4.xlarge, m4.2xlarge, m4.4xlarge, m5.12xlarge, c5.18xlarge, and g6.2xlarge.","type":"string"},"minInstances":{"description":"The minimum number of instances of that type in this cluster.","type":"integer"},"maxInstances":{"description":"The maximum number of instances of that type in this cluster.","type":"integer"}}},"Object37":{"type":"object","properties":{"instanceConfigs":{"description":"The instances configured for this cluster partition.","type":"array","items":{"$ref":"#/definitions/Object38"}},"name":{"description":"The name of the cluster partition.","type":"string"},"labels":{"description":"Labels associated with this partition.","type":"array","items":{"type":"string"}}}},"Object39":{"type":"object","properties":{"instanceConfigId":{"description":"The ID of this InstanceConfig.","type":"integer"},"instanceType":{"description":"An EC2 instance type. Possible values include t2.large, m4.xlarge, m4.2xlarge, m4.4xlarge, m5.12xlarge, c5.18xlarge, and g6.2xlarge.","type":"string"},"minInstances":{"description":"The minimum number of instances of that type in this cluster.","type":"integer"},"maxInstances":{"description":"The maximum number of instances of that type in this cluster.","type":"integer"},"instanceMaxMemory":{"description":"The amount of memory (RAM) available to a single instance of that type in megabytes.","type":"integer"},"instanceMaxCpu":{"description":"The number of processor shares available to a single instance of that type in millicores.","type":"integer"},"instanceMaxDisk":{"description":"The amount of disk available to a single instance of that type in gigabytes.","type":"integer"},"usageStats":{"description":"Usage statistics for this instance config","$ref":"#/definitions/Object27"},"clusterPartitionId":{"description":"The ID of this InstanceConfig's cluster partition","type":"integer"},"clusterPartitionName":{"description":"The name of this InstanceConfig's cluster partition","type":"string"}}},"Object40":{"type":"object","properties":{"id":{"description":"The id of this deployment.","type":"integer"},"baseType":{"description":"The base type of this deployment.","type":"string"},"baseId":{"description":"The id of the base object associated with this deployment.","type":"integer"},"baseObjectName":{"description":"The name of the base object associated with this deployment. Null if you do not have permission to read the object.","type":"string"},"jobType":{"description":"If the base object is a job run you have permission to read, the type of the job. One of \"python_script\", \"r_script\", \"container_script\", or \"custom_script\".","type":"string"},"jobId":{"description":"If the base object is a job run you have permission to read, the id of the job.","type":"integer"},"jobCancelRequestedAt":{"description":"If the base object is a job run you have permission to read, and it was requested to be cancelled, the timestamp of that request.","type":"string","format":"time"},"state":{"description":"The state of this deployment.","type":"string"},"cpu":{"description":"The CPU in millicores requested by this deployment.","type":"integer"},"memory":{"description":"The memory in MB requested by this deployment.","type":"integer"},"diskSpace":{"description":"The disk space in GB requested by this deployment.","type":"integer"},"user":{"description":"The user who ran this deployment.","$ref":"#/definitions/Object33"},"createdAt":{"description":"The timestamp of when the deployment began.","type":"string","format":"time"},"cancellable":{"description":"True if you have permission to cancel this deployment.","type":"boolean"}}},"Object41":{"type":"object","properties":{"userId":{"description":"The owning user's ID","type":"string"},"userName":{"description":"The owning user's name","type":"string"},"pendingDeployments":{"description":"The number of deployments belonging to the owning user in \"pending\" state","type":"integer"},"pendingMemoryRequested":{"description":"The sum of memory requests (in MB) for deployments belonging to the owning user in \"pending\" state","type":"integer"},"pendingCpuRequested":{"description":"The sum of CPU requests (in millicores) for deployments belonging to the owning user in \"pending\" state","type":"integer"},"runningDeployments":{"description":"The number of deployments belonging to the owning user in \"running\" state","type":"integer"},"runningMemoryRequested":{"description":"The sum of memory requests (in MB) for deployments belonging to the owning user in \"running\" state","type":"integer"},"runningCpuRequested":{"description":"The sum of CPU requests (in millicores) for deployments belonging to the owning user in \"running\" state","type":"integer"}}},"Object42":{"type":"object","properties":{"cpuGraphUrl":{"description":"URL for the graph of historical CPU usage in this instance config.","type":"string"},"memGraphUrl":{"description":"URL for the graph of historical memory usage in this instance config.","type":"string"}}},"Object45":{"type":"object","properties":{"times":{"description":"The times associated with data points, in seconds since epoch.","type":"array","items":{"type":"integer"}},"values":{"description":"The values of the data points.","type":"array","items":{"type":"number","format":"float"}}}},"Object44":{"type":"object","properties":{"used":{"description":"The amount of a resource actually used.","$ref":"#/definitions/Object45"},"requested":{"description":"The amount of a resource requested.","$ref":"#/definitions/Object45"},"capacity":{"description":"The amount of a resource available.","$ref":"#/definitions/Object45"}}},"Object43":{"type":"object","properties":{"instanceConfigId":{"description":"The ID of this instance config.","type":"integer"},"metric":{"description":"URL for the graph of historical CPU usage in this instance config.","type":"string"},"timeframe":{"description":"The span of time that the graphs cover. Must be one of 1_day, 1_week.","type":"string"},"unit":{"description":"The unit of the values.","type":"string"},"metrics":{"description":"Metric times and values.","$ref":"#/definitions/Object44"}}},"Object57":{"type":"object","properties":{"message":{"description":"The log message.","type":"string"},"stream":{"description":"The stream of the log. One of \"stdout\", \"stderr\".","type":"string"},"createdAt":{"description":"The time the log was created.","type":"string","format":"date-time"},"source":{"description":"The source of the log. One of \"system\", \"user\".","type":"string"}}},"Object58":{"type":"object","properties":{"types":{"description":"list of acceptable credential types","type":"array","items":{"type":"string"}}}},"Object59":{"type":"object","properties":{"id":{"description":"The ID of the credential.","type":"integer"},"name":{"description":"The name identifying the credential","type":"string"},"type":{"description":"The credential's type.","type":"string"},"username":{"description":"The username for the credential.","type":"string"},"description":{"description":"A long description of the credential.","type":"string"},"owner":{"description":"The username of the user who this credential belongs to. Using user.username is preferred.","type":"string"},"user":{"description":"The user who this credential belongs to.","$ref":"#/definitions/Object33"},"remoteHostId":{"description":"The ID of the remote host associated with this credential.","type":"integer"},"remoteHostName":{"description":"The name of the remote host associated with this credential.","type":"string"},"state":{"description":"The U.S. state for the credential. Only for VAN credentials.","type":"string"},"createdAt":{"description":"The creation time for this credential.","type":"string","format":"time"},"updatedAt":{"description":"The last modification time for this credential.","type":"string","format":"time"},"default":{"description":"Whether or not the credential is a default. Only for Database credentials.","type":"boolean"},"oauth":{"description":"Whether or not the credential is an OAuth credential.","type":"boolean"}}},"Object60":{"type":"object","properties":{"name":{"description":"The name identifying the credential.","type":"string"},"type":{"description":"The type of credential. Note: only these credentials can be created or edited via this API [\"Amazon Web Services S3\", \"CASS/NCOA PAF\", \"Certificate\", \"Civis Platform\", \"Custom\", \"Database\", \"Google\", \"Salesforce User\", \"Salesforce Client\", \"TableauUser\"]","type":"string"},"description":{"description":"A long description of the credential.","type":"string"},"username":{"description":"The username for the credential.","type":"string"},"password":{"description":"The password for the credential.","type":"string"},"remoteHostId":{"description":"The ID of the remote host associated with the credential.","type":"integer"},"userId":{"description":"The ID of the user the credential is created for. Note: This attribute is only accepted if you are a Civis Admin User.","type":"integer"},"state":{"description":"The U.S. state for the credential. Only for VAN credentials.","type":"string"},"systemCredential":{"description":"Boolean flag that sets a credential to be a system credential. System credentials can only be created by Civis Admins and will create a credential owned by the Civis Robot user.","type":"boolean"},"default":{"description":"Whether or not the credential is a default. Only for Database credentials.","type":"boolean"},"oauth":{"description":"Whether or not the credential is an OAuth credential.","type":"boolean"}},"required":["type","username","password"]},"Object61":{"type":"object","properties":{"name":{"description":"The name identifying the credential.","type":"string"},"type":{"description":"The type of credential. Note: only these credentials can be created or edited via this API [\"Amazon Web Services S3\", \"CASS/NCOA PAF\", \"Certificate\", \"Civis Platform\", \"Custom\", \"Database\", \"Google\", \"Salesforce User\", \"Salesforce Client\", \"TableauUser\"]","type":"string"},"description":{"description":"A long description of the credential.","type":"string"},"username":{"description":"The username for the credential.","type":"string"},"password":{"description":"The password for the credential.","type":"string"},"remoteHostId":{"description":"The ID of the remote host associated with the credential.","type":"integer"},"userId":{"description":"The ID of the user the credential is created for. Note: This attribute is only accepted if you are a Civis Admin User.","type":"integer"},"state":{"description":"The U.S. state for the credential. Only for VAN credentials.","type":"string"},"systemCredential":{"description":"Boolean flag that sets a credential to be a system credential. System credentials can only be created by Civis Admins and will create a credential owned by the Civis Robot user.","type":"boolean"},"default":{"description":"Whether or not the credential is a default. Only for Database credentials.","type":"boolean"},"oauth":{"description":"Whether or not the credential is an OAuth credential.","type":"boolean"}},"required":["type","username","password"]},"Object62":{"type":"object","properties":{"name":{"description":"The name identifying the credential.","type":"string"},"type":{"description":"The type of credential. Note: only these credentials can be created or edited via this API [\"Amazon Web Services S3\", \"CASS/NCOA PAF\", \"Certificate\", \"Civis Platform\", \"Custom\", \"Database\", \"Google\", \"Salesforce User\", \"Salesforce Client\", \"TableauUser\"]","type":"string"},"description":{"description":"A long description of the credential.","type":"string"},"username":{"description":"The username for the credential.","type":"string"},"password":{"description":"The password for the credential.","type":"string"},"remoteHostId":{"description":"The ID of the remote host associated with the credential.","type":"integer"},"userId":{"description":"The ID of the user the credential is created for. Note: This attribute is only accepted if you are a Civis Admin User.","type":"integer"},"state":{"description":"The U.S. state for the credential. Only for VAN credentials.","type":"string"},"systemCredential":{"description":"Boolean flag that sets a credential to be a system credential. System credentials can only be created by Civis Admins and will create a credential owned by the Civis Robot user.","type":"boolean"},"default":{"description":"Whether or not the credential is a default. Only for Database credentials.","type":"boolean"},"oauth":{"description":"Whether or not the credential is an OAuth credential.","type":"boolean"}}},"Object63":{"type":"object","properties":{"url":{"description":"The URL to your host.","type":"string"},"remoteHostType":{"description":"The type of remote host. One of: RemoteHostTypes::Bigquery, RemoteHostTypes::Bitbucket, RemoteHostTypes::GitSSH, RemoteHostTypes::Github, RemoteHostTypes::GoogleDoc, RemoteHostTypes::JDBC, RemoteHostTypes::Postgres, RemoteHostTypes::Redshift, RemoteHostTypes::S3Storage, and RemoteHostTypes::Salesforce","type":"string"},"username":{"description":"The username for the credential.","type":"string"},"password":{"description":"The password for the credential.","type":"string"}},"required":["url","remoteHostType","username","password"]},"Object65":{"type":"object","properties":{"duration":{"description":"The number of seconds the temporary credential should be valid. Defaults to 15 minutes. Must not be less than 15 minutes or greater than 36 hours.","type":"integer"}}},"Object66":{"type":"object","properties":{"accessKey":{"description":"The identifier of the credential.","type":"string"},"secretAccessKey":{"description":"The secret part of the credential.","type":"string"},"sessionToken":{"description":"The session token identifier.","type":"string"}}},"Object67":{"type":"object","properties":{"userIds":{"description":"An array of one or more user IDs.","type":"array","items":{"type":"integer"}},"permissionLevel":{"description":"Options are: \"read\", \"write\", or \"manage\".","type":"string"},"shareEmailBody":{"description":"Custom body text for e-mail sent on a share.","type":"string"},"sendSharedEmail":{"description":"Send email to the recipients of a share.","type":"boolean"}},"required":["userIds","permissionLevel"]},"Object68":{"type":"object","properties":{"groupIds":{"description":"An array of one or more group IDs.","type":"array","items":{"type":"integer"}},"permissionLevel":{"description":"Options are: \"read\", \"write\", or \"manage\".","type":"string"},"shareEmailBody":{"description":"Custom body text for e-mail sent on a share.","type":"string"},"sendSharedEmail":{"description":"Send email to the recipients of a share.","type":"boolean"}},"required":["groupIds","permissionLevel"]},"Object69":{"type":"object","properties":{"userId":{"description":"ID of target user","type":"integer"},"includeDependencies":{"description":"Whether or not to give manage permissions on all dependencies","type":"boolean"},"emailBody":{"description":"Custom body text for e-mail sent on transfer.","type":"string"},"sendEmail":{"description":"Send email to the target user of the transfer?","type":"boolean"}},"required":["userId","includeDependencies"]},"Object70":{"type":"object","properties":{"id":{"description":"The ID for the database.","type":"integer"},"name":{"description":"The name of the database in Platform.","type":"string"},"adapter":{"description":"The type of the database.","type":"string"},"clusterIdentifier":{"description":"The cluster identifier of the database.","type":"string"},"host":{"description":"The host of the database server.","type":"string"},"port":{"description":"The port of the database.","type":"integer"},"databaseName":{"description":"The internal name of the database.","type":"string"},"managed":{"description":"True if the database is Civis-managed. False otherwise.","type":"boolean"}}},"Object71":{"type":"object","properties":{"schema":{"description":"The name of a schema.","type":"string"}}},"Object72":{"type":"object","properties":{"name":{"description":"The name of the table.","type":"string"},"schema":{"description":"The name of the schema containing the table.","type":"string"},"isView":{"description":"True if this table represents a view. False if it represents a regular table.","type":"boolean"},"databaseId":{"description":"The ID of the database server.","type":"integer"}}},"Object74":{"type":"object","properties":{"id":{"type":"integer"},"state":{"type":"string"},"createdAt":{"description":"The time that the run was queued.","type":"string","format":"time"},"startedAt":{"description":"The time that the run started.","type":"string","format":"time"},"finishedAt":{"description":"The time that the run completed.","type":"string","format":"time"},"error":{"description":"The error message for this run, if present.","type":"string"}}},"Object75":{"type":"object","properties":{"id":{"description":"Table Tag ID","type":"integer"},"name":{"description":"Table Tag Name","type":"string"}}},"Object76":{"type":"object","properties":{"name":{"description":"Name of the column.","type":"string"},"civisDataType":{"description":"The generic data type of the column (ex. \"string\"). Since this is database-agnostic, it may be helpful when loading data to R/Python.","type":"string"},"sqlType":{"description":"The database-specific SQL type of the column (ex. \"varchar(30)\").","type":"string"},"sampleValues":{"description":"A sample of values from the column.","type":"array","items":{"type":"string"}},"encoding":{"description":"The compression encoding for this columnSee: http://docs.aws.amazon.com/redshift/latest/dg/c_Compression_encodings.html","type":"string"},"description":{"description":"The description of the column, as specified by the table owner","type":"string"},"order":{"description":"Relative position of the column in the table.","type":"integer"},"minValue":{"description":"Smallest value in the column.","type":"string"},"maxValue":{"description":"Largest value in the column.","type":"string"},"avgValue":{"description":"This parameter is deprecated.","type":"number","format":"float"},"stddev":{"description":"This parameter is deprecated.","type":"number","format":"float"},"valueDistributionPercent":{"description":"A mapping between each value in the column and the percentage of rows with that value.Only present for tables with fewer than approximately 25,000,000 rows and for columns with fewer than twenty distinct values.","type":"object","additionalProperties":{"type":"number","format":"float"}},"coverageCount":{"description":"Number of non-null values in the column.","type":"integer"},"nullCount":{"description":"Number of null values in the column.","type":"integer"},"possibleDependentVariableTypes":{"description":"Possible dependent variable types the column may be used to model. Null if it may not be used as a dependent variable.","type":"array","items":{"type":"string"}},"useableAsIndependentVariable":{"description":"Whether the column may be used as an independent variable to train a model.","type":"boolean"},"useableAsPrimaryKey":{"description":"Whether the column may be used as an primary key to identify table rows.","type":"boolean"},"valueDistribution":{"description":"An object mapping distinct values in the column to the number of times they appear in the column","type":"object","additionalProperties":{"type":"integer"}},"distinctCount":{"description":"Number of distinct values in the column. NULL values are counted and treated as a single distinct value.","type":"integer"}}},"Object77":{"type":"object","properties":{"id":{"type":"integer"},"leftTableId":{"type":"integer"},"leftIdentifier":{"type":"string"},"rightTableId":{"type":"integer"},"rightIdentifier":{"type":"string"},"on":{"type":"string"},"leftJoin":{"type":"boolean"},"createdAt":{"type":"string","format":"time"},"updatedAt":{"type":"string","format":"time"}}},"Object78":{"type":"object","properties":{"type":{"type":"string"},"createdAt":{"type":"string","format":"time"},"updatedAt":{"type":"string","format":"time"},"joinId":{"type":"integer"}}},"Object80":{"type":"object","properties":{"name":{"type":"string"}}},"Object82":{"type":"object","properties":{"maxMatches":{"type":"integer"},"threshold":{"type":"string"}}},"Object81":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"type":{"type":"string"},"fromTemplateId":{"type":"integer"},"state":{"description":"Whether the job is idle, queued, running, cancelled, or failed.","type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"runs":{"description":"Information about the most recent runs of the job.","type":"array","items":{"$ref":"#/definitions/Object74"}},"lastRun":{"$ref":"#/definitions/Object74"},"hidden":{"description":"The hidden status of the item.","type":"boolean"},"matchOptions":{"$ref":"#/definitions/Object82"}}},"Object79":{"type":"object","properties":{"sourceTableId":{"description":"Source table","type":"integer"},"targetType":{"description":"Target type","type":"string"},"targetId":{"description":"Target ID","type":"integer"},"target":{"$ref":"#/definitions/Object80"},"job":{"description":"Matching job","$ref":"#/definitions/Object81"}}},"Object73":{"type":"object","properties":{"id":{"description":"The ID of the table.","type":"integer"},"databaseId":{"description":"The ID of the database.","type":"integer"},"schema":{"description":"The name of the schema containing the table.","type":"string"},"name":{"description":"Name of the table.","type":"string"},"description":{"description":"The description of the table, as specified by the table owner","type":"string"},"isView":{"description":"True if this table represents a view. False if it represents a regular table.","type":"boolean"},"rowCount":{"description":"The number of rows in the table.","type":"integer"},"columnCount":{"description":"The number of columns in the table.","type":"integer"},"sizeMb":{"description":"The size of the table in megabytes.","type":"number","format":"float"},"owner":{"description":"The database username of the table's owner.","type":"string"},"distkey":{"description":"The column used as the Amazon Redshift distkey.","type":"string"},"sortkeys":{"description":"The column used as the Amazon Redshift sortkey.","type":"string"},"refreshStatus":{"description":"How up-to-date the table's statistics on row counts, null counts, distinct counts, and values distributions are. One of: refreshing, stale, or current.","type":"string"},"lastRefresh":{"description":"The time of the last statistics refresh.","type":"string","format":"date-time"},"dataUpdatedAt":{"description":"The last time that Civis Platform captured a change in this table.Only applicable for Redshift tables; please see the Civis help desk for more info.","type":"string","format":"date-time"},"schemaUpdatedAt":{"description":"The last time that Civis Platform captured a change to the table attributes/structure.Only applicable for Redshift tables; please see the Civis help desk for more info.","type":"string","format":"date-time"},"refreshId":{"description":"The ID of the most recent statistics refresh.","type":"string"},"lastRun":{"description":"The last run of a refresh on this table.","$ref":"#/definitions/Object74"},"primaryKeys":{"description":"The primary keys for this table.","type":"array","items":{"type":"string"}},"lastModifiedKeys":{"description":"The columns indicating an entry's modification status for this table.","type":"array","items":{"type":"string"}},"tableTags":{"description":"The table tags associated with this table.","type":"array","items":{"$ref":"#/definitions/Object75"}},"ontologyMapping":{"description":"The ontology-key to column-name mapping. See /ontology for the list of valid ontology keys.","type":"object","additionalProperties":{"type":"string"}},"columns":{"type":"array","items":{"$ref":"#/definitions/Object76"}},"joins":{"type":"array","items":{"$ref":"#/definitions/Object77"}},"multipartKey":{"type":"array","items":{"type":"string"}},"enhancements":{"type":"array","items":{"$ref":"#/definitions/Object78"}},"viewDef":{"type":"string"},"tableDef":{"type":"string"},"outgoingTableMatches":{"type":"array","items":{"$ref":"#/definitions/Object79"}}}},"Object83":{"type":"object","properties":{"credentialId":{"description":"If provided, schemas will be filtered based on the given credential.","type":"integer"},"description":{"description":"The user-defined description of the table.","type":"string"}}},"Object84":{"type":"object","properties":{"id":{"description":"The ID for this project.","type":"integer"},"author":{"description":"The author/owner of the item.","$ref":"#/definitions/Object33"},"name":{"description":"The name of this project.","type":"string"},"description":{"description":"A description of the project.","type":"string"},"users":{"description":"Users who can see the project.","type":"array","items":{"$ref":"#/definitions/Object33"}},"autoShare":{"type":"boolean"},"createdAt":{"type":"string","format":"time"},"updatedAt":{"type":"string","format":"time"},"archived":{"description":"The archival status of the requested item(s).","type":"string"}}},"Object85":{"type":"object","properties":{"schema":{"description":"The name of the schema.","type":"string"},"statsPriority":{"description":"When to sync table statistics for every table in the schema. Valid options are the following. Option: 'flag' means to flag stats for the next scheduled run of a full table scan on the database. Option: 'block' means to block this job on stats syncing. Option: 'queue' means to queue a separate job for syncing stats and do not block this job on the queued job. Defaults to 'flag'","type":"string"}},"required":["schema"]},"Object86":{"type":"object","properties":{"jobId":{"description":"The ID of the job created.","type":"integer"},"runId":{"description":"The ID of the run created.","type":"integer"}}},"Object87":{"type":"object","properties":{"id":{"description":"The ID of the table.","type":"integer"},"databaseId":{"description":"The ID of the database.","type":"integer"},"schema":{"description":"The name of the schema containing the table.","type":"string"},"name":{"description":"Name of the table.","type":"string"},"description":{"description":"The description of the table, as specified by the table owner","type":"string"},"isView":{"description":"True if this table represents a view. False if it represents a regular table.","type":"boolean"},"rowCount":{"description":"The number of rows in the table.","type":"integer"},"columnCount":{"description":"The number of columns in the table.","type":"integer"},"sizeMb":{"description":"The size of the table in megabytes.","type":"number","format":"float"},"owner":{"description":"The database username of the table's owner.","type":"string"},"distkey":{"description":"The column used as the Amazon Redshift distkey.","type":"string"},"sortkeys":{"description":"The column used as the Amazon Redshift sortkey.","type":"string"},"refreshStatus":{"description":"How up-to-date the table's statistics on row counts, null counts, distinct counts, and values distributions are. One of: refreshing, stale, or current.","type":"string"},"lastRefresh":{"description":"The time of the last statistics refresh.","type":"string","format":"date-time"},"refreshId":{"description":"The ID of the most recent statistics refresh.","type":"string"},"lastRun":{"description":"The last run of a refresh on this table.","$ref":"#/definitions/Object74"},"tableTags":{"description":"The table tags associated with this table.","type":"array","items":{"$ref":"#/definitions/Object75"}}}},"Object88":{"type":"object","properties":{"id":{"description":"The ID of the table.","type":"integer"},"databaseId":{"description":"The ID of the database.","type":"integer"},"schema":{"description":"The name of the schema containing the table.","type":"string"},"name":{"description":"Name of the table.","type":"string"},"description":{"description":"The description of the table, as specified by the table owner","type":"string"},"isView":{"description":"True if this table represents a view. False if it represents a regular table.","type":"boolean"},"rowCount":{"description":"The number of rows in the table.","type":"integer"},"columnCount":{"description":"The number of columns in the table.","type":"integer"},"sizeMb":{"description":"The size of the table in megabytes.","type":"number","format":"float"},"owner":{"description":"The database username of the table's owner.","type":"string"},"distkey":{"description":"The column used as the Amazon Redshift distkey.","type":"string"},"sortkeys":{"description":"The column used as the Amazon Redshift sortkey.","type":"string"},"refreshStatus":{"description":"How up-to-date the table's statistics on row counts, null counts, distinct counts, and values distributions are. One of: refreshing, stale, or current.","type":"string"},"lastRefresh":{"description":"The time of the last statistics refresh.","type":"string","format":"date-time"},"refreshId":{"description":"The ID of the most recent statistics refresh.","type":"string"},"lastRun":{"description":"The last run of a refresh on this table.","$ref":"#/definitions/Object74"},"tableTags":{"description":"The table tags associated with this table.","type":"array","items":{"$ref":"#/definitions/Object75"}},"columnNames":{"description":"The names of each column in the table.","type":"array","items":{"type":"string"}}}},"Object89":{"type":"object","properties":{"grantee":{"description":"Name of the granted user or group","type":"string"},"granteeType":{"description":"User or group","type":"string"},"privileges":{"description":"Privileges that the grantee has on this resource","type":"array","items":{"type":"string"}},"grantablePrivileges":{"description":"Privileges that the grantee can grant to others for this resource","type":"array","items":{"type":"string"}}}},"Object90":{"type":"object","properties":{"username":{"description":"Username","type":"string"},"active":{"description":"Whether the user is active or deactivated","type":"boolean"}}},"Object91":{"type":"object","properties":{"groupName":{"description":"The name of the group.","type":"string"},"members":{"description":"The members of the group.","type":"array","items":{"type":"string"}}}},"Object92":{"type":"object","properties":{"id":{"description":"The ID of this whitelisted IP address.","type":"integer"},"remoteHostId":{"description":"The ID of the database this rule is applied to.","type":"integer"},"securityGroupId":{"description":"The ID of the security group this rule is applied to.","type":"string"},"subnetMask":{"description":"The subnet mask that is allowed by this rule.","type":"string"},"createdAt":{"description":"The time this rule was created.","type":"string","format":"time"},"updatedAt":{"description":"The time this rule was last updated.","type":"string","format":"time"}}},"Object93":{"type":"object","properties":{"id":{"description":"The ID of this whitelisted IP address.","type":"integer"},"remoteHostId":{"description":"The ID of the database this rule is applied to.","type":"integer"},"securityGroupId":{"description":"The ID of the security group this rule is applied to.","type":"string"},"subnetMask":{"description":"The subnet mask that is allowed by this rule.","type":"string"},"authorizedBy":{"description":"The user who authorized this rule.","type":"string"},"isActive":{"description":"True if the rule is applied, false if it has been revoked.","type":"boolean"},"createdAt":{"description":"The time this rule was created.","type":"string","format":"time"},"updatedAt":{"description":"The time this rule was last updated.","type":"string","format":"time"}}},"Object94":{"type":"object","properties":{"exportCachingEnabled":{"description":"Whether or not caching is enabled for export jobs run on this database server.","type":"boolean"}}},"Object95":{"type":"object","properties":{"exportCachingEnabled":{"description":"Whether or not caching is enabled for export jobs run on this database server.","type":"boolean"}}},"Object96":{"type":"object","properties":{"exportCachingEnabled":{"description":"Whether or not caching is enabled for export jobs run on this database server.","type":"boolean"}},"required":["exportCachingEnabled"]},"Object97":{"type":"object","properties":{"cpuGraphUrl":{"description":"URL for the aws redshift cpu utliization graph.","type":"string"},"diskGraphUrl":{"description":"URL for the aws redshift disk usage graph.","type":"string"},"queueLengthGraphUrl":{"description":"URL for the aws redshift queue length graph.","type":"string"},"statusGraphUrl":{"description":"URL for the aws redshift status graph.","type":"string"},"maintenanceGraphUrl":{"description":"URL for the aws redshift maintenance graph.","type":"string"},"queryDurationGraphUrl":{"description":"URL for the aws redshift table count graph.","type":"string"}}},"Object101":{"type":"object","properties":{"scheduled":{"description":"If the item is scheduled.","type":"boolean"},"scheduledDays":{"description":"Days of the week, based on numeric value starting at 0 for Sunday. Mutually exclusive with scheduledDaysOfMonth","type":"array","items":{"type":"integer"}},"scheduledHours":{"description":"Hours of the day it is scheduled on.","type":"array","items":{"type":"integer"}},"scheduledMinutes":{"description":"Minutes of the day it is scheduled on.","type":"array","items":{"type":"integer"}},"scheduledRunsPerHour":{"description":"Deprecated in favor of scheduled minutes.","type":"integer"},"scheduledDaysOfMonth":{"description":"Days of the month it is scheduled on, mutually exclusive with scheduledDays.","type":"array","items":{"type":"integer"}}}},"Object102":{"type":"object","properties":{"urls":{"description":"URLs to receive a POST request at job completion","type":"array","items":{"type":"string"}},"successEmailSubject":{"description":"Custom subject line for success e-mail.","type":"string"},"successEmailBody":{"description":"Custom body text for success e-mail, written in Markdown.","type":"string"},"successEmailAddresses":{"description":"Addresses to notify by e-mail when the job completes successfully.","type":"array","items":{"type":"string"}},"successEmailFromName":{"description":"Name from which success emails are sent; defaults to \"Civis.\"","type":"string"},"successEmailReplyTo":{"description":"Address for replies to success emails; defaults to the author of the job.","type":"string"},"failureEmailAddresses":{"description":"Addresses to notify by e-mail when the job fails.","type":"array","items":{"type":"string"}},"stallWarningMinutes":{"description":"Stall warning emails will be sent after this amount of minutes.","type":"integer"},"successOn":{"description":"If success email notifications are on. Defaults to user's preferences.","type":"boolean"},"failureOn":{"description":"If failure email notifications are on. Defaults to user's preferences.","type":"boolean"}}},"Object103":{"type":"object","properties":{"databaseName":{"description":"The Redshift database name for the table.","type":"string"},"schema":{"description":"The schema name for the table.","type":"string"},"table":{"description":"The table name.","type":"string"}},"required":["databaseName","schema","table"]},"Object104":{"type":"object","properties":{"databaseName":{"description":"The Redshift database name for the table.","type":"string"},"schema":{"description":"The schema name for the table.","type":"string"},"table":{"description":"The table name.","type":"string"}},"required":["databaseName","schema","table"]},"Object100":{"type":"object","properties":{"name":{"description":"The name of the enhancement job.","type":"string"},"schedule":{"description":"The schedule of when this enhancement will be run.","$ref":"#/definitions/Object101"},"notifications":{"description":"The notifications to send after the enhancement is run.","$ref":"#/definitions/Object102"},"inputFieldMapping":{"description":"The field (i.e., column) mapping for the input table. See https://api.civisanalytics.com/enhancements/field-mapping for a list of valid field types and descriptions. Each field type should be mapped to a string specifying a column name in the input table. For field types that support multiple values (e.g., the \"phone\" field), a list of column names can be provided (e.g., {\"phone\": [\"home_phone\", \"mobile_phone\"], ...}).","type":"object"},"inputTable":{"description":"The input table.","$ref":"#/definitions/Object103"},"matchTargetId":{"description":"The ID of the Civis Data match target. See /match_targets for IDs.","type":"integer"},"outputTable":{"description":"The output table.","$ref":"#/definitions/Object104"},"maxMatches":{"description":"The maximum number of matches per record in the input table to return. Must be between 0 and 10. 0 returns all matches.","type":"integer"},"threshold":{"description":"The score threshold (between 0 and 1). Matches below this threshold will not be returned. The default value is 0.5.","type":"number","format":"float"},"archived":{"description":"Whether the Civis Data Match Job has been archived.","type":"boolean"},"parentId":{"description":"Parent ID that triggers this enhancement.","type":"integer"}},"required":["name","inputFieldMapping","inputTable","matchTargetId","outputTable"]},"Object106":{"type":"object","properties":{"scheduled":{"description":"If the item is scheduled.","type":"boolean"},"scheduledDays":{"description":"Days of the week, based on numeric value starting at 0 for Sunday. Mutually exclusive with scheduledDaysOfMonth","type":"array","items":{"type":"integer"}},"scheduledHours":{"description":"Hours of the day it is scheduled on.","type":"array","items":{"type":"integer"}},"scheduledMinutes":{"description":"Minutes of the day it is scheduled on.","type":"array","items":{"type":"integer"}},"scheduledRunsPerHour":{"description":"Deprecated in favor of scheduled minutes.","type":"integer"},"scheduledDaysOfMonth":{"description":"Days of the month it is scheduled on, mutually exclusive with scheduledDays.","type":"array","items":{"type":"integer"}}}},"Object107":{"type":"object","properties":{"urls":{"description":"URLs to receive a POST request at job completion","type":"array","items":{"type":"string"}},"successEmailSubject":{"description":"Custom subject line for success e-mail.","type":"string"},"successEmailBody":{"description":"Custom body text for success e-mail, written in Markdown.","type":"string"},"successEmailAddresses":{"description":"Addresses to notify by e-mail when the job completes successfully.","type":"array","items":{"type":"string"}},"successEmailFromName":{"description":"Name from which success emails are sent; defaults to \"Civis.\"","type":"string"},"successEmailReplyTo":{"description":"Address for replies to success emails; defaults to the author of the job.","type":"string"},"failureEmailAddresses":{"description":"Addresses to notify by e-mail when the job fails.","type":"array","items":{"type":"string"}},"stallWarningMinutes":{"description":"Stall warning emails will be sent after this amount of minutes.","type":"integer"},"successOn":{"description":"If success email notifications are on. Defaults to user's preferences.","type":"boolean"},"failureOn":{"description":"If failure email notifications are on. Defaults to user's preferences.","type":"boolean"}}},"Object108":{"type":"object","properties":{"databaseName":{"description":"The Redshift database name for the table.","type":"string"},"schema":{"description":"The schema name for the table.","type":"string"},"table":{"description":"The table name.","type":"string"}}},"Object109":{"type":"object","properties":{"databaseName":{"description":"The Redshift database name for the table.","type":"string"},"schema":{"description":"The schema name for the table.","type":"string"},"table":{"description":"The table name.","type":"string"}}},"Object105":{"type":"object","properties":{"id":{"description":"The ID for the enhancement.","type":"integer"},"name":{"description":"The name of the enhancement job.","type":"string"},"type":{"description":"The type of the enhancement (e.g CASS-NCOA)","type":"string"},"createdAt":{"description":"The time this enhancement was created.","type":"string","format":"time"},"updatedAt":{"description":"The time the enhancement was last updated.","type":"string","format":"time"},"author":{"description":"The author/owner of the item.","$ref":"#/definitions/Object33"},"state":{"description":"The status of the enhancement's last run","type":"string"},"schedule":{"description":"The schedule of when this enhancement will be run.","$ref":"#/definitions/Object106"},"notifications":{"description":"The notifications to send after the enhancement is run.","$ref":"#/definitions/Object107"},"runningAs":{"description":"The user this enhancement will run as, defaults to the author of the enhancement.","$ref":"#/definitions/Object33"},"myPermissionLevel":{"description":"Your permission level on the object. One of \"read\", \"write\", or \"manage\".","type":"string"},"inputFieldMapping":{"description":"The field (i.e., column) mapping for the input table. See https://api.civisanalytics.com/enhancements/field-mapping for a list of valid field types and descriptions. Each field type should be mapped to a string specifying a column name in the input table. For field types that support multiple values (e.g., the \"phone\" field), a list of column names can be provided (e.g., {\"phone\": [\"home_phone\", \"mobile_phone\"], ...}).","type":"object"},"inputTable":{"description":"The input table.","$ref":"#/definitions/Object108"},"matchTargetId":{"description":"The ID of the Civis Data match target. See /match_targets for IDs.","type":"integer"},"outputTable":{"description":"The output table.","$ref":"#/definitions/Object109"},"maxMatches":{"description":"The maximum number of matches per record in the input table to return. Must be between 0 and 10. 0 returns all matches.","type":"integer"},"threshold":{"description":"The score threshold (between 0 and 1). Matches below this threshold will not be returned. The default value is 0.5.","type":"number","format":"float"},"archived":{"description":"Whether the Civis Data Match Job has been archived.","type":"boolean"},"lastRun":{"description":"The last run of this enhancement.","$ref":"#/definitions/Object74"},"parentId":{"description":"Parent ID that triggers this enhancement.","type":"integer"}}},"Object110":{"type":"object","properties":{"name":{"description":"The name of the enhancement job.","type":"string"},"schedule":{"description":"The schedule of when this enhancement will be run.","$ref":"#/definitions/Object101"},"notifications":{"description":"The notifications to send after the enhancement is run.","$ref":"#/definitions/Object102"},"inputFieldMapping":{"description":"The field (i.e., column) mapping for the input table. See https://api.civisanalytics.com/enhancements/field-mapping for a list of valid field types and descriptions. Each field type should be mapped to a string specifying a column name in the input table. For field types that support multiple values (e.g., the \"phone\" field), a list of column names can be provided (e.g., {\"phone\": [\"home_phone\", \"mobile_phone\"], ...}).","type":"object"},"inputTable":{"description":"The input table.","$ref":"#/definitions/Object103"},"matchTargetId":{"description":"The ID of the Civis Data match target. See /match_targets for IDs.","type":"integer"},"outputTable":{"description":"The output table.","$ref":"#/definitions/Object104"},"maxMatches":{"description":"The maximum number of matches per record in the input table to return. Must be between 0 and 10. 0 returns all matches.","type":"integer"},"threshold":{"description":"The score threshold (between 0 and 1). Matches below this threshold will not be returned. The default value is 0.5.","type":"number","format":"float"},"archived":{"description":"Whether the Civis Data Match Job has been archived.","type":"boolean"},"parentId":{"description":"Parent ID that triggers this enhancement.","type":"integer"}},"required":["name","inputFieldMapping","inputTable","matchTargetId","outputTable"]},"Object112":{"type":"object","properties":{"databaseName":{"description":"The Redshift database name for the table.","type":"string"},"schema":{"description":"The schema name for the table.","type":"string"},"table":{"description":"The table name.","type":"string"}}},"Object113":{"type":"object","properties":{"databaseName":{"description":"The Redshift database name for the table.","type":"string"},"schema":{"description":"The schema name for the table.","type":"string"},"table":{"description":"The table name.","type":"string"}}},"Object111":{"type":"object","properties":{"name":{"description":"The name of the enhancement job.","type":"string"},"schedule":{"description":"The schedule of when this enhancement will be run.","$ref":"#/definitions/Object101"},"notifications":{"description":"The notifications to send after the enhancement is run.","$ref":"#/definitions/Object102"},"inputFieldMapping":{"description":"The field (i.e., column) mapping for the input table. See https://api.civisanalytics.com/enhancements/field-mapping for a list of valid field types and descriptions. Each field type should be mapped to a string specifying a column name in the input table. For field types that support multiple values (e.g., the \"phone\" field), a list of column names can be provided (e.g., {\"phone\": [\"home_phone\", \"mobile_phone\"], ...}).","type":"object"},"inputTable":{"description":"The input table.","$ref":"#/definitions/Object112"},"matchTargetId":{"description":"The ID of the Civis Data match target. See /match_targets for IDs.","type":"integer"},"outputTable":{"description":"The output table.","$ref":"#/definitions/Object113"},"maxMatches":{"description":"The maximum number of matches per record in the input table to return. Must be between 0 and 10. 0 returns all matches.","type":"integer"},"threshold":{"description":"The score threshold (between 0 and 1). Matches below this threshold will not be returned. The default value is 0.5.","type":"number","format":"float"},"archived":{"description":"Whether the Civis Data Match Job has been archived.","type":"boolean"},"parentId":{"description":"Parent ID that triggers this enhancement.","type":"integer"}}},"Object114":{"type":"object","properties":{"cloneSchedule":{"description":"If true, also copy the schedule to the new enhancement.","type":"boolean"},"cloneTriggers":{"description":"If true, also copy the triggers to the new enhancement.","type":"boolean"},"cloneNotifications":{"description":"If true, also copy the notifications to the new enhancement.","type":"boolean"}}},"Object115":{"type":"object","properties":{"id":{"description":"The ID of the run.","type":"integer"},"civisDataMatchId":{"description":"The ID of the Civis Data Match job.","type":"integer"},"state":{"description":"The state of the run, one of 'queued' 'running' 'succeeded' 'failed' or 'cancelled'.","type":"string"},"isCancelRequested":{"description":"True if run cancel requested, else false.","type":"boolean"},"createdAt":{"description":"The time the run was created.","type":"string","format":"time"},"startedAt":{"description":"The time the run started at.","type":"string","format":"time"},"finishedAt":{"description":"The time the run completed.","type":"string","format":"time"},"error":{"description":"The error, if any, returned by the run.","type":"string"}}},"Object116":{"type":"object","properties":{"id":{"description":"The ID of the log.","type":"integer"},"createdAt":{"description":"The time the log was created.","type":"string","format":"date-time"},"message":{"description":"The log message.","type":"string"},"level":{"description":"The level of the log. One of unknown,fatal,error,warn,info,debug.","type":"string"}}},"Object117":{"type":"object","properties":{"id":{"description":"The ID of the run.","type":"integer"},"state":{"description":"The state of the run, one of 'queued', 'running' or 'cancelled'.","type":"string"},"isCancelRequested":{"description":"True if run cancel requested, else false.","type":"boolean"}}},"Object118":{"type":"object","properties":{"objectType":{"description":"The type of the output. Valid values are File, Table, Report, Project, Credential, or JSONValue","type":"string"},"objectId":{"description":"The ID of the output.","type":"integer"},"name":{"description":"The name of the output.","type":"string"},"link":{"description":"The hypermedia link to the output.","type":"string"},"value":{"type":"string"}}},"Object119":{"type":"object","properties":{"userIds":{"description":"An array of one or more user IDs.","type":"array","items":{"type":"integer"}},"permissionLevel":{"description":"Options are: \"read\", \"write\", or \"manage\".","type":"string"},"shareEmailBody":{"description":"Custom body text for e-mail sent on a share.","type":"string"},"sendSharedEmail":{"description":"Send email to the recipients of a share.","type":"boolean"}},"required":["userIds","permissionLevel"]},"Object120":{"type":"object","properties":{"groupIds":{"description":"An array of one or more group IDs.","type":"array","items":{"type":"integer"}},"permissionLevel":{"description":"Options are: \"read\", \"write\", or \"manage\".","type":"string"},"shareEmailBody":{"description":"Custom body text for e-mail sent on a share.","type":"string"},"sendSharedEmail":{"description":"Send email to the recipients of a share.","type":"boolean"}},"required":["groupIds","permissionLevel"]},"Object121":{"type":"object","properties":{"userId":{"description":"ID of target user","type":"integer"},"includeDependencies":{"description":"Whether or not to give manage permissions on all dependencies","type":"boolean"},"emailBody":{"description":"Custom body text for e-mail sent on transfer.","type":"string"},"sendEmail":{"description":"Send email to the target user of the transfer?","type":"boolean"}},"required":["userId","includeDependencies"]},"Object122":{"type":"object","properties":{"status":{"description":"The desired archived status of the object.","type":"boolean"}},"required":["status"]},"Object124":{"type":"object","properties":{"name":{"description":"A user-specified name for the source.","type":"string"}}},"Object126":{"type":"object","properties":{"numRecords":{"description":"The number of input records for this run.","type":"integer"},"uniqueIds":{"description":"The number of distinct unique IDs in the input records for this run.","type":"integer"},"uniqueDeduplicatedIds":{"description":"The number of resolved IDs associated with more than one unique ID in the input.","type":"integer"},"maxClusterSize":{"description":"The number of records in the largest cluster of resolved IDs.","type":"integer"},"avgClusterSize":{"description":"The average number of records with the same resolved ID.","type":"number","format":"float"},"clusterSizeFrequencies":{"description":"A mapping from numbers of records with the same resolved ID (i.e., sizes of clusters) to numbers of such clusters. For example, if there were 10 clusters with 2 records each, 2 would be a key in the mapping, and 10 would be its value.","type":"object"}}},"Object125":{"type":"object","properties":{"id":{"type":"integer"},"state":{"type":"string"},"createdAt":{"description":"The time that the run was queued.","type":"string","format":"time"},"startedAt":{"description":"The time that the run started.","type":"string","format":"time"},"finishedAt":{"description":"The time that the run completed.","type":"string","format":"time"},"error":{"description":"The error message for this run, if present.","type":"string"},"sampleRecordsQuery":{"description":"A SQL query to produce a sample of records to inspect.","type":"string"},"expandClusterQuery":{"description":"A customizable query to view PII associated with resolved ids.","type":"string"},"runMetrics":{"description":"Metrics from this run of the Identity Resolution job.","$ref":"#/definitions/Object126"}}},"Object123":{"type":"object","properties":{"id":{"description":"The ID for the enhancement.","type":"integer"},"name":{"description":"The name of the enhancement job.","type":"string"},"type":{"description":"The type of the enhancement (e.g CASS-NCOA)","type":"string"},"createdAt":{"description":"The time this enhancement was created.","type":"string","format":"time"},"updatedAt":{"description":"The time the enhancement was last updated.","type":"string","format":"time"},"author":{"description":"The author/owner of the item.","$ref":"#/definitions/Object33"},"state":{"description":"The status of the enhancement's last run","type":"string"},"archived":{"description":"The archival status of the requested item(s).","type":"string"},"sources":{"description":"The source(s) to resolve via a run of this job.","type":"array","items":{"$ref":"#/definitions/Object124"}},"lastRun":{"description":"The last run of this enhancement.","$ref":"#/definitions/Object125"}}},"Object128":{"type":"object","properties":{"name":{"description":"A user-specified name for the source.","type":"string"},"description":{"description":"A description of the source.","type":"string"},"databaseName":{"description":"The name of the source database.","type":"string"},"schemaName":{"description":"The name of the source schema.","type":"string"},"tableName":{"description":"The name of the source table.","type":"string"},"fieldMapping":{"description":"A mapping of PII fields to columns in this table. Valid keys are primary_key, first_name, middle_name, last_name, gender, phone, email, birth_date, birth_year, birth_month, birth_day, house_number, street, unit, full_address, city, state, state_code, zip, lat, lon, and name_suffix","type":"object"}},"required":["name","databaseName","schemaName","tableName","fieldMapping"]},"Object129":{"type":"object","properties":{"source1":{"description":"Name of the first source. Must be defined in Sources list.","type":"string"},"source1JoinCol":{"description":"Column from the first source to join on.","type":"string"},"source2":{"description":"Name of the second source. Must be defined in Sources list","type":"string"},"source2JoinCol":{"description":"Column from the second source to join on.","type":"string"}},"required":["source1","source1JoinCol","source2","source2JoinCol"]},"Object130":{"type":"object","properties":{"databaseName":{"description":"The name of the destination database.","type":"string"},"schemaName":{"description":"The name of the destination schema.","type":"string"},"tableName":{"description":"The name of the destination table.","type":"string"}},"required":["databaseName","schemaName","tableName"]},"Object133":{"type":"object","properties":{"sourceName":{"description":"The name of the source.","type":"string"},"ranking":{"description":"How preferred this source is for the given field. Rankings are zero-indexed and lower rank values are preferred to higher ones.","type":"integer"}},"required":["sourceName","ranking"]},"Object132":{"type":"object","properties":{"fieldName":{"description":"The name of the field. Must be one of: first_name, middle_name, last_name, name_suffix, email, phone, birth_month, birth_day, birth_year, gender, address, house_number, street, unit, city, state_code, and zip.","type":"string"},"ruleType":{"description":"One of [\"automatic\", \"preferred_source\"]. Determines how the system will choose the value for a record. \"automatic\" will use the most frequent well-formatted value. \"preferred_source\" allows the user to prioritize values from particular sources over others.","type":"string"},"sourcePreferences":{"description":"Rank order for sources, when rule_type is \"preferred_source\".","type":"array","items":{"$ref":"#/definitions/Object133"}}},"required":["fieldName","ruleType"]},"Object131":{"type":"object","properties":{"databaseName":{"description":"The name of the destination database.","type":"string"},"schemaName":{"description":"The name of the destination schema.","type":"string"},"tableName":{"description":"The name of the destination table.","type":"string"},"fields":{"type":"array","items":{"$ref":"#/definitions/Object132"}}},"required":["databaseName","schemaName","tableName"]},"Object127":{"type":"object","properties":{"name":{"description":"The name of the enhancement job.","type":"string"},"schedule":{"description":"The schedule of when this enhancement will be run.","$ref":"#/definitions/Object101"},"notifications":{"description":"The notifications to send after the enhancement is run.","$ref":"#/definitions/Object102"},"threshold":{"description":"A value that determines the extent to which similar records get assigned the same resolved ID. Must be within 0.5 and 1, inclusive. Defaults to 0.8 if unspecified.Higher values may result in fewer cases where records about different individuals erroneously receive the same resolved ID, but also more more cases where records about the same individual receive different resolved IDs.","type":"number","format":"float"},"sources":{"description":"The source(s) to resolve via a run of this job.","type":"array","items":{"$ref":"#/definitions/Object128"}},"matchTargetId":{"description":"The ID of the Civis Data (Custom) match target. See /match_targets for IDs.","type":"integer"},"enforcedLinks":{"description":"A specification of related columns in different sources. The IDR tool will ensure that records with the same values in the specified columns receive the same Resolved ID.","type":"array","items":{"$ref":"#/definitions/Object129"}},"customerGraph":{"description":"Definition of the destination table for Customer Graph information.","$ref":"#/definitions/Object130"},"goldenTable":{"description":"Definition of the destination table for Golden Table information. Requires Customer Graph to be generated.","$ref":"#/definitions/Object131"},"linkScores":{"description":"Definition of the destination table for Link Scores information.","$ref":"#/definitions/Object130"},"legacyId":{"description":"ID of this pipeline in the legacy IDR service application.","type":"integer"}},"required":["name","sources"]},"Object135":{"type":"object","properties":{"name":{"description":"A user-specified name for the source.","type":"string"},"description":{"description":"A description of the source.","type":"string"},"databaseName":{"description":"The name of the source database.","type":"string"},"schemaName":{"description":"The name of the source schema.","type":"string"},"tableName":{"description":"The name of the source table.","type":"string"},"fieldMapping":{"description":"A mapping of PII fields to columns in this table. Valid keys are primary_key, first_name, middle_name, last_name, gender, phone, email, birth_date, birth_year, birth_month, birth_day, house_number, street, unit, full_address, city, state, state_code, zip, lat, lon, and name_suffix","type":"object"}}},"Object136":{"type":"object","properties":{"source1":{"description":"Name of the first source. Must be defined in Sources list.","type":"string"},"source1JoinCol":{"description":"Column from the first source to join on.","type":"string"},"source2":{"description":"Name of the second source. Must be defined in Sources list","type":"string"},"source2JoinCol":{"description":"Column from the second source to join on.","type":"string"}}},"Object137":{"type":"object","properties":{"databaseName":{"description":"The name of the destination database.","type":"string"},"schemaName":{"description":"The name of the destination schema.","type":"string"},"tableName":{"description":"The name of the destination table.","type":"string"}}},"Object140":{"type":"object","properties":{"sourceName":{"description":"The name of the source.","type":"string"},"ranking":{"description":"How preferred this source is for the given field. Rankings are zero-indexed and lower rank values are preferred to higher ones.","type":"integer"}}},"Object139":{"type":"object","properties":{"fieldName":{"description":"The name of the field. Must be one of: first_name, middle_name, last_name, name_suffix, email, phone, birth_month, birth_day, birth_year, gender, address, house_number, street, unit, city, state_code, and zip.","type":"string"},"ruleType":{"description":"One of [\"automatic\", \"preferred_source\"]. Determines how the system will choose the value for a record. \"automatic\" will use the most frequent well-formatted value. \"preferred_source\" allows the user to prioritize values from particular sources over others.","type":"string"},"sourcePreferences":{"description":"Rank order for sources, when rule_type is \"preferred_source\".","type":"array","items":{"$ref":"#/definitions/Object140"}}}},"Object138":{"type":"object","properties":{"databaseName":{"description":"The name of the destination database.","type":"string"},"schemaName":{"description":"The name of the destination schema.","type":"string"},"tableName":{"description":"The name of the destination table.","type":"string"},"fields":{"type":"array","items":{"$ref":"#/definitions/Object139"}}}},"Object141":{"type":"object","properties":{"id":{"type":"integer"},"state":{"type":"string"},"createdAt":{"description":"The time that the run was queued.","type":"string","format":"time"},"startedAt":{"description":"The time that the run started.","type":"string","format":"time"},"finishedAt":{"description":"The time that the run completed.","type":"string","format":"time"},"error":{"description":"The error message for this run, if present.","type":"string"},"config":{"description":"How the Identity Resolution job was configured for this run.","type":"string"},"sampleRecordsQuery":{"description":"A SQL query to produce a sample of records to inspect.","type":"string"},"expandClusterQuery":{"description":"A customizable query to view PII associated with resolved ids.","type":"string"},"runMetrics":{"description":"Metrics from this run of the Identity Resolution job.","$ref":"#/definitions/Object126"},"errorSection":{"description":"If there was a failure, this will denote which section of the Identity Resolution job failed. One of: data_preparation, compute_setup or data_processing.","type":"string"}}},"Object134":{"type":"object","properties":{"id":{"description":"The ID for the enhancement.","type":"integer"},"name":{"description":"The name of the enhancement job.","type":"string"},"type":{"description":"The type of the enhancement (e.g CASS-NCOA)","type":"string"},"createdAt":{"description":"The time this enhancement was created.","type":"string","format":"time"},"updatedAt":{"description":"The time the enhancement was last updated.","type":"string","format":"time"},"author":{"description":"The author/owner of the item.","$ref":"#/definitions/Object33"},"state":{"description":"The status of the enhancement's last run","type":"string"},"schedule":{"description":"The schedule of when this enhancement will be run.","$ref":"#/definitions/Object106"},"notifications":{"description":"The notifications to send after the enhancement is run.","$ref":"#/definitions/Object107"},"runningAs":{"description":"The user this enhancement will run as, defaults to the author of the enhancement.","$ref":"#/definitions/Object33"},"myPermissionLevel":{"description":"Your permission level on the object. One of \"read\", \"write\", or \"manage\".","type":"string"},"archived":{"description":"The archival status of the requested item(s).","type":"string"},"threshold":{"description":"A value that determines the extent to which similar records get assigned the same resolved ID. Must be within 0.5 and 1, inclusive. Defaults to 0.8 if unspecified.Higher values may result in fewer cases where records about different individuals erroneously receive the same resolved ID, but also more more cases where records about the same individual receive different resolved IDs.","type":"number","format":"float"},"sources":{"description":"The source(s) to resolve via a run of this job.","type":"array","items":{"$ref":"#/definitions/Object135"}},"matchTargetId":{"description":"The ID of the Civis Data (Custom) match target. See /match_targets for IDs.","type":"integer"},"enforcedLinks":{"description":"A specification of related columns in different sources. The IDR tool will ensure that records with the same values in the specified columns receive the same Resolved ID.","type":"array","items":{"$ref":"#/definitions/Object136"}},"customerGraph":{"description":"Definition of the destination table for Customer Graph information.","$ref":"#/definitions/Object137"},"goldenTable":{"description":"Definition of the destination table for Golden Table information. Requires Customer Graph to be generated.","$ref":"#/definitions/Object138"},"linkScores":{"description":"Definition of the destination table for Link Scores information.","$ref":"#/definitions/Object137"},"legacyId":{"description":"ID of this pipeline in the legacy IDR service application.","type":"integer"},"lastRun":{"description":"The last run of this enhancement.","$ref":"#/definitions/Object141"}}},"Object142":{"type":"object","properties":{"name":{"description":"The name of the enhancement job.","type":"string"},"schedule":{"description":"The schedule of when this enhancement will be run.","$ref":"#/definitions/Object101"},"notifications":{"description":"The notifications to send after the enhancement is run.","$ref":"#/definitions/Object102"},"threshold":{"description":"A value that determines the extent to which similar records get assigned the same resolved ID. Must be within 0.5 and 1, inclusive. Defaults to 0.8 if unspecified.Higher values may result in fewer cases where records about different individuals erroneously receive the same resolved ID, but also more more cases where records about the same individual receive different resolved IDs.","type":"number","format":"float"},"sources":{"description":"The source(s) to resolve via a run of this job.","type":"array","items":{"$ref":"#/definitions/Object128"}},"matchTargetId":{"description":"The ID of the Civis Data (Custom) match target. See /match_targets for IDs.","type":"integer"},"enforcedLinks":{"description":"A specification of related columns in different sources. The IDR tool will ensure that records with the same values in the specified columns receive the same Resolved ID.","type":"array","items":{"$ref":"#/definitions/Object129"}},"customerGraph":{"description":"Definition of the destination table for Customer Graph information.","$ref":"#/definitions/Object130"},"goldenTable":{"description":"Definition of the destination table for Golden Table information. Requires Customer Graph to be generated.","$ref":"#/definitions/Object131"},"linkScores":{"description":"Definition of the destination table for Link Scores information.","$ref":"#/definitions/Object130"}},"required":["name","sources"]},"Object144":{"type":"object","properties":{"name":{"description":"A user-specified name for the source.","type":"string"},"description":{"description":"A description of the source.","type":"string"},"databaseName":{"description":"The name of the source database.","type":"string"},"schemaName":{"description":"The name of the source schema.","type":"string"},"tableName":{"description":"The name of the source table.","type":"string"},"fieldMapping":{"description":"A mapping of PII fields to columns in this table. Valid keys are primary_key, first_name, middle_name, last_name, gender, phone, email, birth_date, birth_year, birth_month, birth_day, house_number, street, unit, full_address, city, state, state_code, zip, lat, lon, and name_suffix","type":"object"}}},"Object145":{"type":"object","properties":{"source1":{"description":"Name of the first source. Must be defined in Sources list.","type":"string"},"source1JoinCol":{"description":"Column from the first source to join on.","type":"string"},"source2":{"description":"Name of the second source. Must be defined in Sources list","type":"string"},"source2JoinCol":{"description":"Column from the second source to join on.","type":"string"}}},"Object146":{"type":"object","properties":{"databaseName":{"description":"The name of the destination database.","type":"string"},"schemaName":{"description":"The name of the destination schema.","type":"string"},"tableName":{"description":"The name of the destination table.","type":"string"}}},"Object149":{"type":"object","properties":{"sourceName":{"description":"The name of the source.","type":"string"},"ranking":{"description":"How preferred this source is for the given field. Rankings are zero-indexed and lower rank values are preferred to higher ones.","type":"integer"}}},"Object148":{"type":"object","properties":{"fieldName":{"description":"The name of the field. Must be one of: first_name, middle_name, last_name, name_suffix, email, phone, birth_month, birth_day, birth_year, gender, address, house_number, street, unit, city, state_code, and zip.","type":"string"},"ruleType":{"description":"One of [\"automatic\", \"preferred_source\"]. Determines how the system will choose the value for a record. \"automatic\" will use the most frequent well-formatted value. \"preferred_source\" allows the user to prioritize values from particular sources over others.","type":"string"},"sourcePreferences":{"description":"Rank order for sources, when rule_type is \"preferred_source\".","type":"array","items":{"$ref":"#/definitions/Object149"}}}},"Object147":{"type":"object","properties":{"databaseName":{"description":"The name of the destination database.","type":"string"},"schemaName":{"description":"The name of the destination schema.","type":"string"},"tableName":{"description":"The name of the destination table.","type":"string"},"fields":{"type":"array","items":{"$ref":"#/definitions/Object148"}}}},"Object143":{"type":"object","properties":{"name":{"description":"The name of the enhancement job.","type":"string"},"schedule":{"description":"The schedule of when this enhancement will be run.","$ref":"#/definitions/Object101"},"notifications":{"description":"The notifications to send after the enhancement is run.","$ref":"#/definitions/Object102"},"threshold":{"description":"A value that determines the extent to which similar records get assigned the same resolved ID. Must be within 0.5 and 1, inclusive. Defaults to 0.8 if unspecified.Higher values may result in fewer cases where records about different individuals erroneously receive the same resolved ID, but also more more cases where records about the same individual receive different resolved IDs.","type":"number","format":"float"},"sources":{"description":"The source(s) to resolve via a run of this job.","type":"array","items":{"$ref":"#/definitions/Object144"}},"matchTargetId":{"description":"The ID of the Civis Data (Custom) match target. See /match_targets for IDs.","type":"integer"},"enforcedLinks":{"description":"A specification of related columns in different sources. The IDR tool will ensure that records with the same values in the specified columns receive the same Resolved ID.","type":"array","items":{"$ref":"#/definitions/Object145"}},"customerGraph":{"description":"Definition of the destination table for Customer Graph information.","$ref":"#/definitions/Object146"},"goldenTable":{"description":"Definition of the destination table for Golden Table information. Requires Customer Graph to be generated.","$ref":"#/definitions/Object147"},"linkScores":{"description":"Definition of the destination table for Link Scores information.","$ref":"#/definitions/Object146"}}},"Object150":{"type":"object","properties":{"id":{"description":"The ID of the run.","type":"integer"},"identityResolutionId":{"description":"The ID of the Identity Resolution job.","type":"integer"},"state":{"description":"The state of the run, one of 'queued' 'running' 'succeeded' 'failed' or 'cancelled'.","type":"string"},"isCancelRequested":{"description":"True if run cancel requested, else false.","type":"boolean"},"createdAt":{"description":"The time the run was created.","type":"string","format":"time"},"startedAt":{"description":"The time the run started at.","type":"string","format":"time"},"finishedAt":{"description":"The time the run completed.","type":"string","format":"time"},"error":{"description":"The error, if any, returned by the run.","type":"string"},"config":{"description":"How the Identity Resolution job was configured for this run.","type":"string"},"sampleRecordsQuery":{"description":"A SQL query to produce a sample of records to inspect.","type":"string"},"expandClusterQuery":{"description":"A customizable query to view PII associated with resolved ids.","type":"string"},"runMetrics":{"description":"Metrics from this run of the Identity Resolution job.","$ref":"#/definitions/Object126"},"errorSection":{"description":"If there was a failure, this will denote which section of the Identity Resolution job failed. One of: data_preparation, compute_setup or data_processing.","type":"string"}}},"Object151":{"type":"object","properties":{"id":{"description":"The ID of the run.","type":"integer"},"identityResolutionId":{"description":"The ID of the Identity Resolution job.","type":"integer"},"state":{"description":"The state of the run, one of 'queued' 'running' 'succeeded' 'failed' or 'cancelled'.","type":"string"},"isCancelRequested":{"description":"True if run cancel requested, else false.","type":"boolean"},"createdAt":{"description":"The time the run was created.","type":"string","format":"time"},"startedAt":{"description":"The time the run started at.","type":"string","format":"time"},"finishedAt":{"description":"The time the run completed.","type":"string","format":"time"},"error":{"description":"The error, if any, returned by the run.","type":"string"},"sampleRecordsQuery":{"description":"A SQL query to produce a sample of records to inspect.","type":"string"},"expandClusterQuery":{"description":"A customizable query to view PII associated with resolved ids.","type":"string"},"runMetrics":{"description":"Metrics from this run of the Identity Resolution job.","$ref":"#/definitions/Object126"}}},"Object152":{"type":"object","properties":{"id":{"description":"The ID of the run.","type":"integer"},"state":{"description":"The state of the run, one of 'queued', 'running' or 'cancelled'.","type":"string"},"isCancelRequested":{"description":"True if run cancel requested, else false.","type":"boolean"}}},"Object154":{"type":"object","properties":{"name":{"description":"The name of the type.","type":"string"}}},"Object155":{"type":"object","properties":{"field":{"description":"The name of the field.","type":"string"},"description":{"description":"The description of the field.","type":"string"}}},"Object156":{"type":"object","properties":{"id":{"description":"The ID for the enhancement.","type":"integer"},"name":{"description":"The name of the enhancement job.","type":"string"},"type":{"description":"The type of the enhancement (e.g CASS-NCOA)","type":"string"},"createdAt":{"description":"The time this enhancement was created.","type":"string","format":"time"},"updatedAt":{"description":"The time the enhancement was last updated.","type":"string","format":"time"},"author":{"description":"The author/owner of the item.","$ref":"#/definitions/Object33"},"state":{"description":"The status of the enhancement's last run","type":"string"},"archived":{"description":"The archival status of the requested item(s).","type":"string"}}},"Object159":{"type":"object","properties":{"schema":{"description":"The schema name of the source table.","type":"string"},"table":{"description":"The name of the source table.","type":"string"},"remoteHostId":{"description":"The ID of the database host for the table.","type":"integer"},"credentialId":{"description":"The id of the credentials to be used when performing the enhancement.","type":"integer"},"multipartKey":{"description":"The source table primary key.","type":"array","items":{"type":"string"}}},"required":["schema","table","remoteHostId","credentialId"]},"Object158":{"type":"object","properties":{"databaseTable":{"description":"The information about the source database table.","$ref":"#/definitions/Object159"}}},"Object161":{"type":"object","properties":{"schema":{"description":"The schema name for the output data.","type":"string"},"table":{"description":"The table name for the output data.","type":"string"}}},"Object160":{"type":"object","properties":{"databaseTable":{"description":"The information about the output database table.","$ref":"#/definitions/Object161"}}},"Object162":{"type":"object","properties":{"address1":{"description":"The first address line.","type":"string"},"address2":{"description":"The second address line.","type":"string"},"city":{"description":"The city of an address.","type":"string"},"state":{"description":"The state of an address.","type":"string"},"zip":{"description":"The zip code of an address.","type":"string"},"name":{"description":"The full name of the resident at this address. If needed, separate multiple columns with `+`, e.g. `first_name+last_name`","type":"string"},"company":{"description":"The name of the company located at this address.","type":"string"}}},"Object157":{"type":"object","properties":{"name":{"description":"The name of the enhancement job.","type":"string"},"schedule":{"description":"The schedule of when this enhancement will be run.","$ref":"#/definitions/Object101"},"notifications":{"description":"The notifications to send after the enhancement is run.","$ref":"#/definitions/Object102"},"source":{"description":"The information about the source data that will be enhanced. Specify exactly one source.","$ref":"#/definitions/Object158"},"destination":{"description":"The information about how to output the results of this enhancement. Specify exactly one destination.","$ref":"#/definitions/Object160"},"columnMapping":{"description":"A mapping of what columns in the source correspond to the required columns for a CASS/NCOA enhancement.","$ref":"#/definitions/Object162"},"useDefaultColumnMapping":{"description":"Defaults to true, where the existing column mapping on the input table will be used. If false, a custom column mapping must be provided.","type":"boolean"},"performNcoa":{"description":"Whether to update addresses for records matching the National Change of Address (NCOA) database.","type":"boolean"},"ncoaCredentialId":{"description":"Credential to use when performing NCOA updates. Required if 'performNcoa' is true.","type":"integer"},"outputLevel":{"description":"The set of fields persisted by a CASS or NCOA enhancement.For CASS enhancements, one of 'cass' or 'all.'For NCOA enhancements, one of 'cass', 'ncoa' , 'coalesced' or 'all'.By default, all fields will be returned.","type":"string"},"limitingSQL":{"description":"The limiting SQL for the source table. \"WHERE\" should be omitted (e.g. state='IL').","type":"string"},"batchSize":{"description":"The maximum number of records processed at a time. Note that this parameter is not available to all users.","type":"integer"},"parentId":{"description":"Parent ID that triggers this enhancement.","type":"integer"}},"required":["name","source"]},"Object165":{"type":"object","properties":{"schema":{"description":"The schema name of the source table.","type":"string"},"table":{"description":"The name of the source table.","type":"string"},"remoteHostId":{"description":"The ID of the database host for the table.","type":"integer"},"credentialId":{"description":"The id of the credentials to be used when performing the enhancement.","type":"integer"},"multipartKey":{"description":"The source table primary key.","type":"array","items":{"type":"string"}}}},"Object164":{"type":"object","properties":{"databaseTable":{"description":"The information about the source database table.","$ref":"#/definitions/Object165"}}},"Object167":{"type":"object","properties":{"schema":{"description":"The schema name for the output data.","type":"string"},"table":{"description":"The table name for the output data.","type":"string"}}},"Object166":{"type":"object","properties":{"databaseTable":{"description":"The information about the output database table.","$ref":"#/definitions/Object167"}}},"Object168":{"type":"object","properties":{"address1":{"description":"The first address line.","type":"string"},"address2":{"description":"The second address line.","type":"string"},"city":{"description":"The city of an address.","type":"string"},"state":{"description":"The state of an address.","type":"string"},"zip":{"description":"The zip code of an address.","type":"string"},"name":{"description":"The full name of the resident at this address. If needed, separate multiple columns with `+`, e.g. `first_name+last_name`","type":"string"},"company":{"description":"The name of the company located at this address.","type":"string"}}},"Object163":{"type":"object","properties":{"id":{"description":"The ID for the enhancement.","type":"integer"},"name":{"description":"The name of the enhancement job.","type":"string"},"type":{"description":"The type of the enhancement (e.g CASS-NCOA)","type":"string"},"createdAt":{"description":"The time this enhancement was created.","type":"string","format":"time"},"updatedAt":{"description":"The time the enhancement was last updated.","type":"string","format":"time"},"author":{"description":"The author/owner of the item.","$ref":"#/definitions/Object33"},"state":{"description":"The status of the enhancement's last run","type":"string"},"schedule":{"description":"The schedule of when this enhancement will be run.","$ref":"#/definitions/Object106"},"notifications":{"description":"The notifications to send after the enhancement is run.","$ref":"#/definitions/Object107"},"runningAs":{"description":"The user this enhancement will run as, defaults to the author of the enhancement.","$ref":"#/definitions/Object33"},"myPermissionLevel":{"description":"Your permission level on the object. One of \"read\", \"write\", or \"manage\".","type":"string"},"source":{"description":"The information about the source data that will be enhanced. Specify exactly one source.","$ref":"#/definitions/Object164"},"destination":{"description":"The information about how to output the results of this enhancement. Specify exactly one destination.","$ref":"#/definitions/Object166"},"columnMapping":{"description":"A mapping of what columns in the source correspond to the required columns for a CASS/NCOA enhancement.","$ref":"#/definitions/Object168"},"useDefaultColumnMapping":{"description":"Defaults to true, where the existing column mapping on the input table will be used. If false, a custom column mapping must be provided.","type":"boolean"},"performNcoa":{"description":"Whether to update addresses for records matching the National Change of Address (NCOA) database.","type":"boolean"},"ncoaCredentialId":{"description":"Credential to use when performing NCOA updates. Required if 'performNcoa' is true.","type":"integer"},"outputLevel":{"description":"The set of fields persisted by a CASS or NCOA enhancement.For CASS enhancements, one of 'cass' or 'all.'For NCOA enhancements, one of 'cass', 'ncoa' , 'coalesced' or 'all'.By default, all fields will be returned.","type":"string"},"limitingSQL":{"description":"The limiting SQL for the source table. \"WHERE\" should be omitted (e.g. state='IL').","type":"string"},"batchSize":{"description":"The maximum number of records processed at a time. Note that this parameter is not available to all users.","type":"integer"},"archived":{"description":"The archival status of the requested item(s).","type":"string"},"parentId":{"description":"Parent ID that triggers this enhancement.","type":"integer"}}},"Object169":{"type":"object","properties":{"name":{"description":"The name of the enhancement job.","type":"string"},"schedule":{"description":"The schedule of when this enhancement will be run.","$ref":"#/definitions/Object101"},"notifications":{"description":"The notifications to send after the enhancement is run.","$ref":"#/definitions/Object102"},"source":{"description":"The information about the source data that will be enhanced. Specify exactly one source.","$ref":"#/definitions/Object158"},"destination":{"description":"The information about how to output the results of this enhancement. Specify exactly one destination.","$ref":"#/definitions/Object160"},"columnMapping":{"description":"A mapping of what columns in the source correspond to the required columns for a CASS/NCOA enhancement.","$ref":"#/definitions/Object162"},"useDefaultColumnMapping":{"description":"Defaults to true, where the existing column mapping on the input table will be used. If false, a custom column mapping must be provided.","type":"boolean"},"performNcoa":{"description":"Whether to update addresses for records matching the National Change of Address (NCOA) database.","type":"boolean"},"ncoaCredentialId":{"description":"Credential to use when performing NCOA updates. Required if 'performNcoa' is true.","type":"integer"},"outputLevel":{"description":"The set of fields persisted by a CASS or NCOA enhancement.For CASS enhancements, one of 'cass' or 'all.'For NCOA enhancements, one of 'cass', 'ncoa' , 'coalesced' or 'all'.By default, all fields will be returned.","type":"string"},"limitingSQL":{"description":"The limiting SQL for the source table. \"WHERE\" should be omitted (e.g. state='IL').","type":"string"},"batchSize":{"description":"The maximum number of records processed at a time. Note that this parameter is not available to all users.","type":"integer"},"parentId":{"description":"Parent ID that triggers this enhancement.","type":"integer"}},"required":["name","source"]},"Object170":{"type":"object","properties":{"name":{"description":"The name of the enhancement job.","type":"string"},"schedule":{"description":"The schedule of when this enhancement will be run.","$ref":"#/definitions/Object101"},"notifications":{"description":"The notifications to send after the enhancement is run.","$ref":"#/definitions/Object102"},"source":{"description":"The information about the source data that will be enhanced. Specify exactly one source.","$ref":"#/definitions/Object158"},"destination":{"description":"The information about how to output the results of this enhancement. Specify exactly one destination.","$ref":"#/definitions/Object160"},"columnMapping":{"description":"A mapping of what columns in the source correspond to the required columns for a CASS/NCOA enhancement.","$ref":"#/definitions/Object162"},"useDefaultColumnMapping":{"description":"Defaults to true, where the existing column mapping on the input table will be used. If false, a custom column mapping must be provided.","type":"boolean"},"performNcoa":{"description":"Whether to update addresses for records matching the National Change of Address (NCOA) database.","type":"boolean"},"ncoaCredentialId":{"description":"Credential to use when performing NCOA updates. Required if 'performNcoa' is true.","type":"integer"},"outputLevel":{"description":"The set of fields persisted by a CASS or NCOA enhancement.For CASS enhancements, one of 'cass' or 'all.'For NCOA enhancements, one of 'cass', 'ncoa' , 'coalesced' or 'all'.By default, all fields will be returned.","type":"string"},"limitingSQL":{"description":"The limiting SQL for the source table. \"WHERE\" should be omitted (e.g. state='IL').","type":"string"},"batchSize":{"description":"The maximum number of records processed at a time. Note that this parameter is not available to all users.","type":"integer"},"parentId":{"description":"Parent ID that triggers this enhancement.","type":"integer"}}},"Object171":{"type":"object","properties":{"id":{"description":"The ID of the run.","type":"integer"},"cassNcoaId":{"description":"The ID of the CASS NCOA job.","type":"integer"},"state":{"description":"The state of the run, one of 'queued' 'running' 'succeeded' 'failed' or 'cancelled'.","type":"string"},"isCancelRequested":{"description":"True if run cancel requested, else false.","type":"boolean"},"createdAt":{"description":"The time the run was created.","type":"string","format":"time"},"startedAt":{"description":"The time the run started at.","type":"string","format":"time"},"finishedAt":{"description":"The time the run completed.","type":"string","format":"time"},"error":{"description":"The error, if any, returned by the run.","type":"string"}}},"Object172":{"type":"object","properties":{"id":{"description":"The ID of the run.","type":"integer"},"state":{"description":"The state of the run, one of 'queued', 'running' or 'cancelled'.","type":"string"},"isCancelRequested":{"description":"True if run cancel requested, else false.","type":"boolean"}}},"Object173":{"type":"object","properties":{"objectType":{"description":"The type of the output. Valid values are File, Table, Report, Project, Credential, or JSONValue","type":"string"},"objectId":{"description":"The ID of the output.","type":"integer"},"name":{"description":"The name of the output.","type":"string"},"link":{"description":"The hypermedia link to the output.","type":"string"},"value":{"type":"string"}}},"Object174":{"type":"object","properties":{"name":{"description":"The name of the enhancement job.","type":"string"},"schedule":{"description":"The schedule of when this enhancement will be run.","$ref":"#/definitions/Object101"},"notifications":{"description":"The notifications to send after the enhancement is run.","$ref":"#/definitions/Object102"},"remoteHostId":{"description":"The ID of the remote host.","type":"integer"},"credentialId":{"description":"The ID of the remote host credential.","type":"integer"},"sourceSchemaAndTable":{"description":"The source database schema and table.","type":"string"},"multipartKey":{"description":"The source table primary key.","type":"array","items":{"type":"string"}},"limitingSQL":{"description":"The limiting SQL for the source table. \"WHERE\" should be omitted (e.g. state='IL').","type":"string"},"targetSchema":{"description":"The output table schema.","type":"string"},"targetTable":{"description":"The output table name.","type":"string"},"country":{"description":"The country of the addresses to be geocoded; either 'us' or 'ca'.","type":"string"},"provider":{"description":"The geocoding provider; one of postgis and geocoder_ca.","type":"string"},"outputAddress":{"description":"Whether to output the parsed address. Only guaranteed for the 'postgis' provider.","type":"boolean"},"parentId":{"description":"Parent ID that triggers this enhancement.","type":"integer"}},"required":["name","remoteHostId","credentialId","sourceSchemaAndTable"]},"Object175":{"type":"object","properties":{"id":{"description":"The ID for the enhancement.","type":"integer"},"name":{"description":"The name of the enhancement job.","type":"string"},"type":{"description":"The type of the enhancement (e.g CASS-NCOA)","type":"string"},"createdAt":{"description":"The time this enhancement was created.","type":"string","format":"time"},"updatedAt":{"description":"The time the enhancement was last updated.","type":"string","format":"time"},"author":{"description":"The author/owner of the item.","$ref":"#/definitions/Object33"},"state":{"description":"The status of the enhancement's last run","type":"string"},"schedule":{"description":"The schedule of when this enhancement will be run.","$ref":"#/definitions/Object106"},"notifications":{"description":"The notifications to send after the enhancement is run.","$ref":"#/definitions/Object107"},"runningAs":{"description":"The user this enhancement will run as, defaults to the author of the enhancement.","$ref":"#/definitions/Object33"},"myPermissionLevel":{"description":"Your permission level on the object. One of \"read\", \"write\", or \"manage\".","type":"string"},"remoteHostId":{"description":"The ID of the remote host.","type":"integer"},"credentialId":{"description":"The ID of the remote host credential.","type":"integer"},"sourceSchemaAndTable":{"description":"The source database schema and table.","type":"string"},"multipartKey":{"description":"The source table primary key.","type":"array","items":{"type":"string"}},"limitingSQL":{"description":"The limiting SQL for the source table. \"WHERE\" should be omitted (e.g. state='IL').","type":"string"},"targetSchema":{"description":"The output table schema.","type":"string"},"targetTable":{"description":"The output table name.","type":"string"},"country":{"description":"The country of the addresses to be geocoded; either 'us' or 'ca'.","type":"string"},"provider":{"description":"The geocoding provider; one of postgis and geocoder_ca.","type":"string"},"outputAddress":{"description":"Whether to output the parsed address. Only guaranteed for the 'postgis' provider.","type":"boolean"},"archived":{"description":"The archival status of the requested item(s).","type":"string"},"parentId":{"description":"Parent ID that triggers this enhancement.","type":"integer"}}},"Object176":{"type":"object","properties":{"name":{"description":"The name of the enhancement job.","type":"string"},"schedule":{"description":"The schedule of when this enhancement will be run.","$ref":"#/definitions/Object101"},"notifications":{"description":"The notifications to send after the enhancement is run.","$ref":"#/definitions/Object102"},"remoteHostId":{"description":"The ID of the remote host.","type":"integer"},"credentialId":{"description":"The ID of the remote host credential.","type":"integer"},"sourceSchemaAndTable":{"description":"The source database schema and table.","type":"string"},"multipartKey":{"description":"The source table primary key.","type":"array","items":{"type":"string"}},"limitingSQL":{"description":"The limiting SQL for the source table. \"WHERE\" should be omitted (e.g. state='IL').","type":"string"},"targetSchema":{"description":"The output table schema.","type":"string"},"targetTable":{"description":"The output table name.","type":"string"},"country":{"description":"The country of the addresses to be geocoded; either 'us' or 'ca'.","type":"string"},"provider":{"description":"The geocoding provider; one of postgis and geocoder_ca.","type":"string"},"outputAddress":{"description":"Whether to output the parsed address. Only guaranteed for the 'postgis' provider.","type":"boolean"},"parentId":{"description":"Parent ID that triggers this enhancement.","type":"integer"}},"required":["name","remoteHostId","credentialId","sourceSchemaAndTable"]},"Object177":{"type":"object","properties":{"name":{"description":"The name of the enhancement job.","type":"string"},"schedule":{"description":"The schedule of when this enhancement will be run.","$ref":"#/definitions/Object101"},"notifications":{"description":"The notifications to send after the enhancement is run.","$ref":"#/definitions/Object102"},"remoteHostId":{"description":"The ID of the remote host.","type":"integer"},"credentialId":{"description":"The ID of the remote host credential.","type":"integer"},"sourceSchemaAndTable":{"description":"The source database schema and table.","type":"string"},"multipartKey":{"description":"The source table primary key.","type":"array","items":{"type":"string"}},"limitingSQL":{"description":"The limiting SQL for the source table. \"WHERE\" should be omitted (e.g. state='IL').","type":"string"},"targetSchema":{"description":"The output table schema.","type":"string"},"targetTable":{"description":"The output table name.","type":"string"},"country":{"description":"The country of the addresses to be geocoded; either 'us' or 'ca'.","type":"string"},"provider":{"description":"The geocoding provider; one of postgis and geocoder_ca.","type":"string"},"outputAddress":{"description":"Whether to output the parsed address. Only guaranteed for the 'postgis' provider.","type":"boolean"},"parentId":{"description":"Parent ID that triggers this enhancement.","type":"integer"}}},"Object178":{"type":"object","properties":{"id":{"description":"The ID of the run.","type":"integer"},"geocodeId":{"description":"The ID of the Geocode job.","type":"integer"},"state":{"description":"The state of the run, one of 'queued' 'running' 'succeeded' 'failed' or 'cancelled'.","type":"string"},"isCancelRequested":{"description":"True if run cancel requested, else false.","type":"boolean"},"createdAt":{"description":"The time the run was created.","type":"string","format":"time"},"startedAt":{"description":"The time the run started at.","type":"string","format":"time"},"finishedAt":{"description":"The time the run completed.","type":"string","format":"time"},"error":{"description":"The error, if any, returned by the run.","type":"string"}}},"Object179":{"type":"object","properties":{"id":{"description":"The ID of the run.","type":"integer"},"state":{"description":"The state of the run, one of 'queued', 'running' or 'cancelled'.","type":"string"},"isCancelRequested":{"description":"True if run cancel requested, else false.","type":"boolean"}}},"Object180":{"type":"object","properties":{"objectType":{"description":"The type of the output. Valid values are File, Table, Report, Project, Credential, or JSONValue","type":"string"},"objectId":{"description":"The ID of the output.","type":"integer"},"name":{"description":"The name of the output.","type":"string"},"link":{"description":"The hypermedia link to the output.","type":"string"},"value":{"type":"string"}}},"Object198":{"type":"object","properties":{"userIds":{"description":"An array of one or more user IDs.","type":"array","items":{"type":"integer"}},"permissionLevel":{"description":"Options are: \"read\", \"write\", or \"manage\".","type":"string"},"shareEmailBody":{"description":"Custom body text for e-mail sent on a share.","type":"string"},"sendSharedEmail":{"description":"Send email to the recipients of a share.","type":"boolean"}},"required":["userIds","permissionLevel"]},"Object199":{"type":"object","properties":{"groupIds":{"description":"An array of one or more group IDs.","type":"array","items":{"type":"integer"}},"permissionLevel":{"description":"Options are: \"read\", \"write\", or \"manage\".","type":"string"},"shareEmailBody":{"description":"Custom body text for e-mail sent on a share.","type":"string"},"sendSharedEmail":{"description":"Send email to the recipients of a share.","type":"boolean"}},"required":["groupIds","permissionLevel"]},"Object200":{"type":"object","properties":{"userId":{"description":"ID of target user","type":"integer"},"includeDependencies":{"description":"Whether or not to give manage permissions on all dependencies","type":"boolean"},"emailBody":{"description":"Custom body text for e-mail sent on transfer.","type":"string"},"sendEmail":{"description":"Send email to the target user of the transfer?","type":"boolean"}},"required":["userId","includeDependencies"]},"Object201":{"type":"object","properties":{"status":{"description":"The desired archived status of the object.","type":"boolean"}},"required":["status"]},"Object202":{"type":"object","properties":{"userIds":{"description":"An array of one or more user IDs.","type":"array","items":{"type":"integer"}},"permissionLevel":{"description":"Options are: \"read\", \"write\", or \"manage\".","type":"string"},"shareEmailBody":{"description":"Custom body text for e-mail sent on a share.","type":"string"},"sendSharedEmail":{"description":"Send email to the recipients of a share.","type":"boolean"}},"required":["userIds","permissionLevel"]},"Object203":{"type":"object","properties":{"groupIds":{"description":"An array of one or more group IDs.","type":"array","items":{"type":"integer"}},"permissionLevel":{"description":"Options are: \"read\", \"write\", or \"manage\".","type":"string"},"shareEmailBody":{"description":"Custom body text for e-mail sent on a share.","type":"string"},"sendSharedEmail":{"description":"Send email to the recipients of a share.","type":"boolean"}},"required":["groupIds","permissionLevel"]},"Object204":{"type":"object","properties":{"userId":{"description":"ID of target user","type":"integer"},"includeDependencies":{"description":"Whether or not to give manage permissions on all dependencies","type":"boolean"},"emailBody":{"description":"Custom body text for e-mail sent on transfer.","type":"string"},"sendEmail":{"description":"Send email to the target user of the transfer?","type":"boolean"}},"required":["userId","includeDependencies"]},"Object205":{"type":"object","properties":{"status":{"description":"The desired archived status of the object.","type":"boolean"}},"required":["status"]},"Object206":{"type":"object","properties":{"userIds":{"description":"An array of one or more user IDs.","type":"array","items":{"type":"integer"}},"permissionLevel":{"description":"Options are: \"read\", \"write\", or \"manage\".","type":"string"},"shareEmailBody":{"description":"Custom body text for e-mail sent on a share.","type":"string"},"sendSharedEmail":{"description":"Send email to the recipients of a share.","type":"boolean"}},"required":["userIds","permissionLevel"]},"Object207":{"type":"object","properties":{"groupIds":{"description":"An array of one or more group IDs.","type":"array","items":{"type":"integer"}},"permissionLevel":{"description":"Options are: \"read\", \"write\", or \"manage\".","type":"string"},"shareEmailBody":{"description":"Custom body text for e-mail sent on a share.","type":"string"},"sendSharedEmail":{"description":"Send email to the recipients of a share.","type":"boolean"}},"required":["groupIds","permissionLevel"]},"Object208":{"type":"object","properties":{"userId":{"description":"ID of target user","type":"integer"},"includeDependencies":{"description":"Whether or not to give manage permissions on all dependencies","type":"boolean"},"emailBody":{"description":"Custom body text for e-mail sent on transfer.","type":"string"},"sendEmail":{"description":"Send email to the target user of the transfer?","type":"boolean"}},"required":["userId","includeDependencies"]},"Object209":{"type":"object","properties":{"status":{"description":"The desired archived status of the object.","type":"boolean"}},"required":["status"]},"Object210":{"type":"object","properties":{"id":{"description":"The ID for this export.","type":"integer"},"name":{"description":"The name of this export.","type":"string"},"type":{"description":"The type of export.","type":"string"},"createdAt":{"description":"The creation time for this export.","type":"string","format":"time"},"updatedAt":{"description":"The last modification time for this export.","type":"string","format":"time"},"state":{"type":"string"},"lastRun":{"description":"The last run of this export.","$ref":"#/definitions/Object74"},"author":{"description":"The author/owner of the item.","$ref":"#/definitions/Object33"}}},"Object211":{"type":"object","properties":{"id":{"type":"integer"},"state":{"type":"string"},"createdAt":{"description":"The time that the run was queued.","type":"string","format":"time"},"startedAt":{"description":"The time that the run started.","type":"string","format":"time"},"finishedAt":{"description":"The time that the run completed.","type":"string","format":"time"},"error":{"description":"The error message for this run, if present.","type":"string"},"outputCachedOn":{"description":"The time that the output was originally exported, if a cache entry was used by the run.","type":"string","format":"time"}}},"Object212":{"type":"object","properties":{"id":{"type":"integer"},"state":{"type":"string"},"createdAt":{"description":"The time that the run was queued.","type":"string","format":"time"},"startedAt":{"description":"The time that the run started.","type":"string","format":"time"},"finishedAt":{"description":"The time that the run completed.","type":"string","format":"time"},"error":{"description":"The error message for this run, if present.","type":"string"}}},"Object213":{"type":"object","properties":{"objectType":{"description":"The type of the output. Valid values are File, Table, Report, Project, Credential, or JSONValue","type":"string"},"objectId":{"description":"The ID of the output.","type":"integer"},"name":{"description":"The name of the output.","type":"string"},"link":{"description":"The hypermedia link to the output.","type":"string"},"value":{"type":"string"}}},"Object215":{"type":"object","properties":{"sql":{"description":"The SQL query for this Csv Export job","type":"string"},"remoteHostId":{"description":"The ID of the destination database host.","type":"integer"},"credentialId":{"description":"The ID of the credentials for the destination database.","type":"integer"}},"required":["sql","remoteHostId","credentialId"]},"Object217":{"type":"object","properties":{"filePath":{"description":"The path within the bucket where the exported file will be saved. E.g. the file_path for \"s3://mybucket/files/all/\" would be \"/files/all/\"","type":"string"},"storageHostId":{"description":"The ID of the destination storage host.","type":"integer"},"credentialId":{"description":"The ID of the credentials for the destination storage host.","type":"integer"},"existingFiles":{"description":"Notifies the job of what to do in the case that the exported file already exists at the provided path.One of: fail, append, overwrite. Default: fail. If \"append\" is specified,the new file will always be added to the provided path. If \"overwrite\" is specifiedall existing files at the provided path will be deleted and the new file will be added.By default, or if \"fail\" is specified, the export will fail if a file exists at the provided path.","type":"string"}},"required":["filePath","storageHostId","credentialId"]},"Object216":{"type":"object","properties":{"filenamePrefix":{"description":"The prefix of the name of the file returned to the user.","type":"string"},"storagePath":{"description":"A user-provided storage path.","$ref":"#/definitions/Object217"}}},"Object214":{"type":"object","properties":{"name":{"description":"The name of this Csv Export job.","type":"string"},"source":{"$ref":"#/definitions/Object215"},"destination":{"$ref":"#/definitions/Object216"},"includeHeader":{"description":"A boolean value indicating whether or not the header should be included. Defaults to true.","type":"boolean"},"compression":{"description":"The compression of the output file. Valid arguments are \"gzip\" and \"none\". Defaults to \"gzip\".","type":"string"},"columnDelimiter":{"description":"The column delimiter for the output file. Valid arguments are \"comma\", \"tab\", and \"pipe\". Defaults to \"comma\".","type":"string"},"hidden":{"description":"A boolean value indicating whether or not this request should be hidden. Defaults to false.","type":"boolean"},"forceMultifile":{"description":"Whether or not the csv should be split into multiple files. Default: false","type":"boolean"},"maxFileSize":{"description":"The max file size, in MB, created files will be. Only available when force_multifile is true. ","type":"integer"}},"required":["source","destination"]},"Object219":{"type":"object","properties":{"sql":{"description":"The SQL query for this Csv Export job","type":"string"},"remoteHostId":{"description":"The ID of the destination database host.","type":"integer"},"credentialId":{"description":"The ID of the credentials for the destination database.","type":"integer"}}},"Object221":{"type":"object","properties":{"filePath":{"description":"The path within the bucket where the exported file will be saved. E.g. the file_path for \"s3://mybucket/files/all/\" would be \"/files/all/\"","type":"string"},"storageHostId":{"description":"The ID of the destination storage host.","type":"integer"},"credentialId":{"description":"The ID of the credentials for the destination storage host.","type":"integer"},"existingFiles":{"description":"Notifies the job of what to do in the case that the exported file already exists at the provided path.One of: fail, append, overwrite. Default: fail. If \"append\" is specified,the new file will always be added to the provided path. If \"overwrite\" is specifiedall existing files at the provided path will be deleted and the new file will be added.By default, or if \"fail\" is specified, the export will fail if a file exists at the provided path.","type":"string"}}},"Object220":{"type":"object","properties":{"filenamePrefix":{"description":"The prefix of the name of the file returned to the user.","type":"string"},"storagePath":{"description":"A user-provided storage path.","$ref":"#/definitions/Object221"}}},"Object218":{"type":"object","properties":{"id":{"description":"The ID of this Csv Export job.","type":"integer"},"name":{"description":"The name of this Csv Export job.","type":"string"},"source":{"$ref":"#/definitions/Object219"},"destination":{"$ref":"#/definitions/Object220"},"includeHeader":{"description":"A boolean value indicating whether or not the header should be included. Defaults to true.","type":"boolean"},"compression":{"description":"The compression of the output file. Valid arguments are \"gzip\" and \"none\". Defaults to \"gzip\".","type":"string"},"columnDelimiter":{"description":"The column delimiter for the output file. Valid arguments are \"comma\", \"tab\", and \"pipe\". Defaults to \"comma\".","type":"string"},"hidden":{"description":"A boolean value indicating whether or not this request should be hidden. Defaults to false.","type":"boolean"},"forceMultifile":{"description":"Whether or not the csv should be split into multiple files. Default: false","type":"boolean"},"maxFileSize":{"description":"The max file size, in MB, created files will be. Only available when force_multifile is true. ","type":"integer"},"myPermissionLevel":{"description":"Your permission level on the object. One of \"read\", \"write\", or \"manage\".","type":"string"}}},"Object222":{"type":"object","properties":{"name":{"description":"The name of this Csv Export job.","type":"string"},"source":{"$ref":"#/definitions/Object215"},"destination":{"$ref":"#/definitions/Object216"},"includeHeader":{"description":"A boolean value indicating whether or not the header should be included. Defaults to true.","type":"boolean"},"compression":{"description":"The compression of the output file. Valid arguments are \"gzip\" and \"none\". Defaults to \"gzip\".","type":"string"},"columnDelimiter":{"description":"The column delimiter for the output file. Valid arguments are \"comma\", \"tab\", and \"pipe\". Defaults to \"comma\".","type":"string"},"hidden":{"description":"A boolean value indicating whether or not this request should be hidden. Defaults to false.","type":"boolean"},"forceMultifile":{"description":"Whether or not the csv should be split into multiple files. Default: false","type":"boolean"},"maxFileSize":{"description":"The max file size, in MB, created files will be. Only available when force_multifile is true. ","type":"integer"}},"required":["source","destination"]},"Object224":{"type":"object","properties":{"sql":{"description":"The SQL query for this Csv Export job","type":"string"},"remoteHostId":{"description":"The ID of the destination database host.","type":"integer"},"credentialId":{"description":"The ID of the credentials for the destination database.","type":"integer"}}},"Object223":{"type":"object","properties":{"name":{"description":"The name of this Csv Export job.","type":"string"},"source":{"$ref":"#/definitions/Object224"},"destination":{"$ref":"#/definitions/Object216"},"includeHeader":{"description":"A boolean value indicating whether or not the header should be included. Defaults to true.","type":"boolean"},"compression":{"description":"The compression of the output file. Valid arguments are \"gzip\" and \"none\". Defaults to \"gzip\".","type":"string"},"columnDelimiter":{"description":"The column delimiter for the output file. Valid arguments are \"comma\", \"tab\", and \"pipe\". Defaults to \"comma\".","type":"string"},"hidden":{"description":"A boolean value indicating whether or not this request should be hidden. Defaults to false.","type":"boolean"},"forceMultifile":{"description":"Whether or not the csv should be split into multiple files. Default: false","type":"boolean"},"maxFileSize":{"description":"The max file size, in MB, created files will be. Only available when force_multifile is true. ","type":"integer"}}},"Object225":{"type":"object","properties":{"status":{"description":"The desired archived status of the object.","type":"boolean"}},"required":["status"]},"Object231":{"type":"object","properties":{"userIds":{"description":"An array of one or more user IDs.","type":"array","items":{"type":"integer"}},"permissionLevel":{"description":"Options are: \"read\", \"write\", or \"manage\".","type":"string"},"shareEmailBody":{"description":"Custom body text for e-mail sent on a share.","type":"string"},"sendSharedEmail":{"description":"Send email to the recipients of a share.","type":"boolean"}},"required":["userIds","permissionLevel"]},"Object232":{"type":"object","properties":{"groupIds":{"description":"An array of one or more group IDs.","type":"array","items":{"type":"integer"}},"permissionLevel":{"description":"Options are: \"read\", \"write\", or \"manage\".","type":"string"},"shareEmailBody":{"description":"Custom body text for e-mail sent on a share.","type":"string"},"sendSharedEmail":{"description":"Send email to the recipients of a share.","type":"boolean"}},"required":["groupIds","permissionLevel"]},"Object233":{"type":"object","properties":{"userId":{"description":"ID of target user","type":"integer"},"includeDependencies":{"description":"Whether or not to give manage permissions on all dependencies","type":"boolean"},"emailBody":{"description":"Custom body text for e-mail sent on transfer.","type":"string"},"sendEmail":{"description":"Send email to the target user of the transfer?","type":"boolean"}},"required":["userId","includeDependencies"]},"Object234":{"type":"object","properties":{"name":{"description":"The file name.","type":"string"},"expiresAt":{"description":"The date and time the file will expire. If not specified, the file will expire in 30 days. To keep a file indefinitely, specify null.","type":"string","format":"date-time"},"description":{"description":"The user-defined description of the file.","type":"string"}},"required":["name"]},"Object235":{"type":"object","properties":{"id":{"description":"The ID of the file.","type":"integer"},"name":{"description":"The file name.","type":"string"},"createdAt":{"description":"The date and time the file was created.","type":"string","format":"date-time"},"fileSize":{"description":"The file size.","type":"integer"},"expiresAt":{"description":"The date and time the file will expire. If not specified, the file will expire in 30 days. To keep a file indefinitely, specify null.","type":"string","format":"date-time"},"description":{"description":"The user-defined description of the file.","type":"string"},"uploadUrl":{"description":"The URL that may be used to upload a file. To use the upload URL, initiate a POST request to the given URL with the file you wish to import as the \"file\" form field.","type":"string"},"uploadFields":{"description":"A hash containing the form fields to be included with the POST request.","type":"object"},"myPermissionLevel":{"description":"Your permission level on the object. One of \"read\", \"write\", or \"manage\".","type":"string"}}},"Object236":{"type":"object","properties":{"name":{"description":"The file name.","type":"string"},"expiresAt":{"description":"The date and time the file will expire. If not specified, the file will expire in 30 days. To keep a file indefinitely, specify null.","type":"string","format":"date-time"},"description":{"description":"The user-defined description of the file.","type":"string"},"numParts":{"description":"The number of parts in which the file will be uploaded. This parameter determines the number of presigned URLs that are returned.","type":"integer"}},"required":["name","numParts"]},"Object237":{"type":"object","properties":{"id":{"description":"The ID of the file.","type":"integer"},"name":{"description":"The file name.","type":"string"},"createdAt":{"description":"The date and time the file was created.","type":"string","format":"date-time"},"fileSize":{"description":"The file size.","type":"integer"},"expiresAt":{"description":"The date and time the file will expire. If not specified, the file will expire in 30 days. To keep a file indefinitely, specify null.","type":"string","format":"date-time"},"description":{"description":"The user-defined description of the file.","type":"string"},"uploadUrls":{"description":"An array of URLs that may be used to upload file parts. Use separate PUT requests to complete the part uploads. Links expire after 12 hours.","type":"array","items":{"type":"string"}}}},"Object240":{"type":"object","properties":{"name":{"description":"The column name.","type":"string"},"sqlType":{"description":"The SQL type of the column.","type":"string"}}},"Object239":{"type":"object","properties":{"includeHeader":{"description":"A boolean value indicating whether or not the first row of the file is a header row.","type":"boolean"},"columnDelimiter":{"description":"The column delimiter for the file. One of \"comma\", \"tab\", or \"pipe\".","type":"string"},"compression":{"description":"The type of compression of the file. One of \"gzip\", or \"none\".","type":"string"},"tableColumns":{"description":"An array of hashes corresponding to the columns in the file. Each hash should have keys for column \"name\" and \"sql_type\"","type":"array","items":{"$ref":"#/definitions/Object240"}}}},"Object238":{"type":"object","properties":{"id":{"description":"The ID of the file.","type":"integer"},"name":{"description":"The file name.","type":"string"},"createdAt":{"description":"The date and time the file was created.","type":"string","format":"date-time"},"fileSize":{"description":"The file size.","type":"integer"},"expiresAt":{"description":"The date and time the file will expire. If not specified, the file will expire in 30 days. To keep a file indefinitely, specify null.","type":"string","format":"date-time"},"description":{"description":"The user-defined description of the file.","type":"string"},"author":{"description":"The author/owner of the item.","$ref":"#/definitions/Object33"},"downloadUrl":{"description":"A JSON string containing information about the URL of the file.","type":"string"},"fileUrl":{"description":"The URL that may be used to download the file.","type":"string"},"detectedInfo":{"description":"A hash corresponding to the information detected if the file was preprocessed by the \"/files/preprocess/csv\" endpoint.","$ref":"#/definitions/Object239"},"myPermissionLevel":{"description":"Your permission level on the object. One of \"read\", \"write\", or \"manage\".","type":"string"}}},"Object241":{"type":"object","properties":{"name":{"description":"The file name. The extension must match the previous extension.","type":"string"},"expiresAt":{"description":"The date and time the file will expire. ","type":"string","format":"date-time"},"description":{"description":"The user-defined description of the file.","type":"string"}},"required":["name","expiresAt"]},"Object242":{"type":"object","properties":{"name":{"description":"The file name. The extension must match the previous extension.","type":"string"},"expiresAt":{"description":"The date and time the file will expire. ","type":"string","format":"date-time"},"description":{"description":"The user-defined description of the file.","type":"string"}}},"Object243":{"type":"object","properties":{"fileId":{"description":"The ID of the file.","type":"integer"},"inPlace":{"description":"If true, the file is cleaned in place. If false, a new file ID is created. Defaults to true.","type":"boolean"},"detectTableColumns":{"description":"If true, detect the table columns in the file including the sql types. If false, skip table column detection.Defaults to false.","type":"boolean"},"forceCharacterSetConversion":{"description":"If true, the file will always be converted to UTF-8 and any character that cannot be converted will be discarded. If false, the character set conversion will only run if the detected character set is not compatible with UTF-8 (e.g., UTF-8, ASCII).","type":"boolean"},"includeHeader":{"description":"A boolean value indicating whether or not the first row of the file is a header row. If not provided, will attempt to auto-detect whether a header row is present.","type":"boolean"},"columnDelimiter":{"description":"The column delimiter for the file. One of \"comma\", \"tab\", or \"pipe\". If not provided, the column delimiter will be auto-detected.","type":"string"},"hidden":{"description":"The hidden status of the item.","type":"boolean"}},"required":["fileId"]},"Object244":{"type":"object","properties":{"id":{"description":"The ID of the job created.","type":"integer"},"fileId":{"description":"The ID of the file.","type":"integer"},"inPlace":{"description":"If true, the file is cleaned in place. If false, a new file ID is created. Defaults to true.","type":"boolean"},"detectTableColumns":{"description":"If true, detect the table columns in the file including the sql types. If false, skip table column detection.Defaults to false.","type":"boolean"},"forceCharacterSetConversion":{"description":"If true, the file will always be converted to UTF-8 and any character that cannot be converted will be discarded. If false, the character set conversion will only run if the detected character set is not compatible with UTF-8 (e.g., UTF-8, ASCII).","type":"boolean"},"includeHeader":{"description":"A boolean value indicating whether or not the first row of the file is a header row. If not provided, will attempt to auto-detect whether a header row is present.","type":"boolean"},"columnDelimiter":{"description":"The column delimiter for the file. One of \"comma\", \"tab\", or \"pipe\". If not provided, the column delimiter will be auto-detected.","type":"string"},"hidden":{"description":"The hidden status of the item.","type":"boolean"}}},"Object245":{"type":"object","properties":{"fileId":{"description":"The ID of the file.","type":"integer"},"inPlace":{"description":"If true, the file is cleaned in place. If false, a new file ID is created. Defaults to true.","type":"boolean"},"detectTableColumns":{"description":"If true, detect the table columns in the file including the sql types. If false, skip table column detection.Defaults to false.","type":"boolean"},"forceCharacterSetConversion":{"description":"If true, the file will always be converted to UTF-8 and any character that cannot be converted will be discarded. If false, the character set conversion will only run if the detected character set is not compatible with UTF-8 (e.g., UTF-8, ASCII).","type":"boolean"},"includeHeader":{"description":"A boolean value indicating whether or not the first row of the file is a header row. If not provided, will attempt to auto-detect whether a header row is present.","type":"boolean"},"columnDelimiter":{"description":"The column delimiter for the file. One of \"comma\", \"tab\", or \"pipe\". If not provided, the column delimiter will be auto-detected.","type":"string"}},"required":["fileId"]},"Object246":{"type":"object","properties":{"fileId":{"description":"The ID of the file.","type":"integer"},"inPlace":{"description":"If true, the file is cleaned in place. If false, a new file ID is created. Defaults to true.","type":"boolean"},"detectTableColumns":{"description":"If true, detect the table columns in the file including the sql types. If false, skip table column detection.Defaults to false.","type":"boolean"},"forceCharacterSetConversion":{"description":"If true, the file will always be converted to UTF-8 and any character that cannot be converted will be discarded. If false, the character set conversion will only run if the detected character set is not compatible with UTF-8 (e.g., UTF-8, ASCII).","type":"boolean"},"includeHeader":{"description":"A boolean value indicating whether or not the first row of the file is a header row. If not provided, will attempt to auto-detect whether a header row is present.","type":"boolean"},"columnDelimiter":{"description":"The column delimiter for the file. One of \"comma\", \"tab\", or \"pipe\". If not provided, the column delimiter will be auto-detected.","type":"string"}}},"Object247":{"type":"object","properties":{"status":{"description":"The desired archived status of the object.","type":"boolean"}},"required":["status"]},"Object248":{"type":"object","properties":{"id":{"description":"The ID for this git repository.","type":"integer"},"repoUrl":{"description":"The URL for this git repository.","type":"string"},"createdAt":{"type":"string","format":"time"},"updatedAt":{"type":"string","format":"time"}}},"Object249":{"type":"object","properties":{"repoUrl":{"description":"The URL for this git repository.","type":"string"}},"required":["repoUrl"]},"Object250":{"type":"object","properties":{"branches":{"description":"List of branch names of this git repository.","type":"array","items":{"type":"string"}},"tags":{"description":"List of tag names of this git repository.","type":"array","items":{"type":"string"}}}},"Object251":{"type":"object","properties":{"id":{"description":"The ID of this group.","type":"integer"},"name":{"description":"This group's name.","type":"string"},"createdAt":{"description":"The date and time when this group was created.","type":"string","format":"time"},"updatedAt":{"description":"The date and time when this group was last updated.","type":"string","format":"time"},"description":{"description":"The description of the group.","type":"string"},"slug":{"description":"The slug for this group.","type":"string"},"organizationId":{"description":"The ID of the organization this group belongs to.","type":"integer"},"organizationName":{"description":"The name of the organization this group belongs to.","type":"string"},"memberCount":{"description":"The number of active members in this group.","type":"integer"},"totalMemberCount":{"description":"The total number of members in this group.","type":"integer"},"lastUpdatedById":{"description":"The ID of the user who last updated this group.","type":"integer"},"createdById":{"description":"The ID of the user who created this group.","type":"integer"},"members":{"description":"The members of this group.","type":"array","items":{"$ref":"#/definitions/Object33"}}}},"Object252":{"type":"object","properties":{"name":{"description":"This group's name.","type":"string"},"description":{"description":"The description of the group.","type":"string"},"slug":{"description":"The slug for this group.","type":"string"},"organizationId":{"description":"The ID of the organization this group belongs to.","type":"integer"},"defaultOtpRequiredForLogin":{"description":"The two factor authentication requirement for this group.","type":"boolean"},"roleIds":{"description":"An array of ids of all the roles this group has.","type":"array","items":{"type":"integer"}},"defaultTimeZone":{"description":"The default time zone of this group.","type":"string"},"defaultJobsLabel":{"description":"The default partition label for jobs of this group.","type":"string"},"defaultNotebooksLabel":{"description":"The default partition label for notebooks of this group.","type":"string"},"defaultServicesLabel":{"description":"The default partition label for services of this group.","type":"string"}},"required":["name"]},"Object254":{"type":"object","properties":{"id":{"description":"The ID of this user.","type":"integer"},"name":{"description":"This user's name.","type":"string"},"username":{"description":"This user's username.","type":"string"},"initials":{"description":"This user's initials.","type":"string"},"online":{"description":"Whether this user is online.","type":"boolean"},"email":{"description":"This user's email address.","type":"string"},"primaryGroupId":{"description":"The ID of the primary group of this user.","type":"integer"},"active":{"description":"Whether this user account is active or deactivated.","type":"boolean"}}},"Object253":{"type":"object","properties":{"id":{"description":"The ID of this group.","type":"integer"},"name":{"description":"This group's name.","type":"string"},"createdAt":{"description":"The date and time when this group was created.","type":"string","format":"time"},"updatedAt":{"description":"The date and time when this group was last updated.","type":"string","format":"time"},"description":{"description":"The description of the group.","type":"string"},"slug":{"description":"The slug for this group.","type":"string"},"organizationId":{"description":"The ID of the organization this group belongs to.","type":"integer"},"organizationName":{"description":"The name of the organization this group belongs to.","type":"string"},"memberCount":{"description":"The number of active members in this group.","type":"integer"},"totalMemberCount":{"description":"The total number of members in this group.","type":"integer"},"defaultOtpRequiredForLogin":{"description":"The two factor authentication requirement for this group.","type":"boolean"},"roleIds":{"description":"An array of ids of all the roles this group has.","type":"array","items":{"type":"integer"}},"defaultTimeZone":{"description":"The default time zone of this group.","type":"string"},"defaultJobsLabel":{"description":"The default partition label for jobs of this group.","type":"string"},"defaultNotebooksLabel":{"description":"The default partition label for notebooks of this group.","type":"string"},"defaultServicesLabel":{"description":"The default partition label for services of this group.","type":"string"},"lastUpdatedById":{"description":"The ID of the user who last updated this group.","type":"integer"},"createdById":{"description":"The ID of the user who created this group.","type":"integer"},"members":{"description":"The members of this group.","type":"array","items":{"$ref":"#/definitions/Object254"}}}},"Object255":{"type":"object","properties":{"name":{"description":"This group's name.","type":"string"},"description":{"description":"The description of the group.","type":"string"},"slug":{"description":"The slug for this group.","type":"string"},"organizationId":{"description":"The ID of the organization this group belongs to.","type":"integer"},"defaultOtpRequiredForLogin":{"description":"The two factor authentication requirement for this group.","type":"boolean"},"roleIds":{"description":"An array of ids of all the roles this group has.","type":"array","items":{"type":"integer"}},"defaultTimeZone":{"description":"The default time zone of this group.","type":"string"},"defaultJobsLabel":{"description":"The default partition label for jobs of this group.","type":"string"},"defaultNotebooksLabel":{"description":"The default partition label for notebooks of this group.","type":"string"},"defaultServicesLabel":{"description":"The default partition label for services of this group.","type":"string"}},"required":["name"]},"Object256":{"type":"object","properties":{"name":{"description":"This group's name.","type":"string"},"description":{"description":"The description of the group.","type":"string"},"slug":{"description":"The slug for this group.","type":"string"},"organizationId":{"description":"The ID of the organization this group belongs to.","type":"integer"},"defaultOtpRequiredForLogin":{"description":"The two factor authentication requirement for this group.","type":"boolean"},"roleIds":{"description":"An array of ids of all the roles this group has.","type":"array","items":{"type":"integer"}},"defaultTimeZone":{"description":"The default time zone of this group.","type":"string"},"defaultJobsLabel":{"description":"The default partition label for jobs of this group.","type":"string"},"defaultNotebooksLabel":{"description":"The default partition label for notebooks of this group.","type":"string"},"defaultServicesLabel":{"description":"The default partition label for services of this group.","type":"string"}}},"Object257":{"type":"object","properties":{"userIds":{"description":"An array of one or more user IDs.","type":"array","items":{"type":"integer"}},"permissionLevel":{"description":"Options are: \"read\", \"write\", or \"manage\".","type":"string"},"shareEmailBody":{"description":"Custom body text for e-mail sent on a share.","type":"string"},"sendSharedEmail":{"description":"Send email to the recipients of a share.","type":"boolean"}},"required":["userIds","permissionLevel"]},"Object258":{"type":"object","properties":{"groupIds":{"description":"An array of one or more group IDs.","type":"array","items":{"type":"integer"}},"permissionLevel":{"description":"Options are: \"read\", \"write\", or \"manage\".","type":"string"},"shareEmailBody":{"description":"Custom body text for e-mail sent on a share.","type":"string"},"sendSharedEmail":{"description":"Send email to the recipients of a share.","type":"boolean"}},"required":["groupIds","permissionLevel"]},"Object260":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"}}},"Object259":{"type":"object","properties":{"manageable":{"type":"array","items":{"$ref":"#/definitions/Object260"}},"writeable":{"type":"array","items":{"$ref":"#/definitions/Object260"}},"readable":{"type":"array","items":{"$ref":"#/definitions/Object260"}}}},"Object261":{"type":"object","properties":{"userIds":{"description":"An array of one or more user IDs.","type":"array","items":{"type":"integer"}},"permissionLevel":{"description":"Options are: \"read\", \"write\", or \"manage\".","type":"string"},"shareEmailBody":{"description":"Custom body text for e-mail sent on a share.","type":"string"},"sendSharedEmail":{"description":"Send email to the recipients of a share.","type":"boolean"}},"required":["userIds","permissionLevel"]},"Object262":{"type":"object","properties":{"groupIds":{"description":"An array of one or more group IDs.","type":"array","items":{"type":"integer"}},"permissionLevel":{"description":"Options are: \"read\", \"write\", or \"manage\".","type":"string"},"shareEmailBody":{"description":"Custom body text for e-mail sent on a share.","type":"string"},"sendSharedEmail":{"description":"Send email to the recipients of a share.","type":"boolean"}},"required":["groupIds","permissionLevel"]},"Object263":{"type":"object","properties":{"userId":{"description":"ID of target user","type":"integer"},"includeDependencies":{"description":"Whether or not to give manage permissions on all dependencies","type":"boolean"},"emailBody":{"description":"Custom body text for e-mail sent on transfer.","type":"string"},"sendEmail":{"description":"Send email to the target user of the transfer?","type":"boolean"}},"required":["userId","includeDependencies"]},"Object264":{"type":"object","properties":{"status":{"description":"The desired archived status of the object.","type":"boolean"}},"required":["status"]},"Object266":{"type":"object","properties":{"remoteHostId":{"type":"integer"},"credentialId":{"type":"integer"},"additionalCredentials":{"description":"Array that holds additional credentials used for specific imports. For DB Syncs, the first element is an SSL private key credential id, and the second element is the corresponding public key credential id.","type":"array","items":{"type":"integer"}},"name":{"type":"string"}}},"Object269":{"type":"object","properties":{"schema":{"description":"The database schema name.","type":"string"},"table":{"description":"The database table name.","type":"string"},"useWithoutSchema":{"description":"This attribute is no longer available; defaults to false but cannot be used.","type":"boolean"}}},"Object270":{"type":"object","properties":{"id":{"description":"The file id.","type":"integer"}}},"Object271":{"type":"object","properties":{"spreadsheet":{"description":"The spreadsheet document name.","type":"string"},"spreadsheetId":{"description":"The spreadsheet document id.","type":"string"},"worksheet":{"description":"The worksheet tab name.","type":"string"},"worksheetId":{"description":"The worksheet tab id.","type":"integer"}}},"Object272":{"type":"object","properties":{"objectName":{"description":"This parameter is deprecated","type":"string"}}},"Object268":{"type":"object","properties":{"id":{"description":"The ID of the table or file, if available.","type":"integer"},"path":{"description":"The path of the dataset to sync from; for a database source, schema.tablename. If you are doing a Google Sheet export, this can be blank. This is a legacy parameter, it is recommended you use one of the following: databaseTable, file, googleWorksheet","type":"string"},"databaseTable":{"description":"The sync source is a database table.","$ref":"#/definitions/Object269"},"file":{"description":"The sync source is a file.","$ref":"#/definitions/Object270"},"googleWorksheet":{"description":"The sync source is a Google worksheet.","$ref":"#/definitions/Object271"},"salesforce":{"description":"The sync source is Salesforce. Deprecated. Please use the new version instead, see https://support.civisanalytics.com/hc/en-us/articles/8774034069261-Salesforce-Import for details.","$ref":"#/definitions/Object272"}}},"Object273":{"type":"object","properties":{"path":{"description":"The schema.tablename to sync to. If you are doing a Google Sheet export, this is the spreadsheet and sheet name separated by a period. i.e. if you have a spreadsheet named \"MySpreadsheet\" and a sheet called \"Sheet1\" this field would be \"MySpreadsheet.Sheet1\". This is a legacy parameter, it is recommended you use one of the following: databaseTable, googleWorksheet","type":"string"},"databaseTable":{"description":"The sync destination is a database table.","$ref":"#/definitions/Object269"},"googleWorksheet":{"description":"The sync destination is a Google worksheet.","$ref":"#/definitions/Object271"}}},"Object275":{"type":"object","properties":{"name":{"description":"The column name that will override the auto-detected name.","type":"string"},"type":{"description":"Declaration of SQL type that will override the auto-detected SQL type, including necessary properties such as length, precision, etc.","type":"string"}}},"Object274":{"type":"object","properties":{"maxErrors":{"description":"For Google Doc and Auto Imports. The maximum number of errors that can occur without the job failing.","type":"integer"},"existingTableRows":{"description":"For Google Doc and Auto Imports. The behavior if a table with the requested name already exists. One of \"fail\", \"truncate\", \"append\", or \"drop\". Defaults to \"fail\".","type":"string"},"firstRowIsHeader":{"description":"For Google Doc and Auto Imports. A boolean value indicating whether or not the first row is a header row.","type":"boolean"},"diststyle":{"description":"For Auto Imports. The diststyle to use for a Redshift table.","type":"string"},"distkey":{"description":"For Auto Imports. The distkey to use for a Redshift table.","type":"string"},"sortkey1":{"description":"For Auto Imports. The first sortkey to use for a Redshift table.","type":"string"},"sortkey2":{"description":"For Auto Imports. The second sortkey to use for a Redshift table.","type":"string"},"columnDelimiter":{"description":"For Auto Imports. The column delimiter for the file. Valid arguments are \"comma\", \"tab\", and \"pipe\". If column_delimiter is null or omitted, it will be auto-detected.","type":"string"},"columnOverrides":{"description":"For Auto Imports. Hash used for overriding auto-detected names and types, with keys being the index of the column being overridden.","type":"object","additionalProperties":{"$ref":"#/definitions/Object275"}},"escaped":{"description":"For Auto Imports. If true, escape quotes with a backslash; otherwise, escape quotes by double-quoting. Defaults to false.","type":"boolean"},"identityColumn":{"description":"For DB Syncs. The column or columns to use as primary key for incremental syncs. Should be a unique identifier. If blank, primary key columns will be auto-detected. If more than one identity column is specified, an identity column must be specified for each table. We recommend the primary key be a sequential data type such as an integer, double, timestamp, date, or float. If using a primary key that is a string data type, we recommend having a last_modified_column to ensure all data is synced to the destination table.","type":"string"},"lastModifiedColumn":{"description":"For DB Syncs. The column to use to detect recently modified data for incremental syncs. Defaults to \"Auto-Detect\", which will use the first column it finds containing either \"modif\" or \"update\" in the name. When specified, only rows where last_modified_column in the source >= last_modified_column in the destination will be synced.","type":"string"},"rowChunkSize":{"description":"For DB Syncs. If specified, will split the sync into chunks of this size.","type":"integer"},"wipeDestinationTable":{"description":"For DB Syncs. If true, will perform a full table refresh.","type":"boolean"},"truncateLongLines":{"description":"For DB Syncs to Redshift. When true, truncates column data to fit the column specification.","type":"boolean"},"invalidCharReplacement":{"description":"For DB Syncs to Redshift. If specified, will replace each invalid UTF-8 character with this character. Must be a single ASCII character.","type":"string"},"verifyTableRowCounts":{"description":"For DB Syncs. When true, an error will be raised if the destination table does not have the same number of rows as the source table after the sync.","type":"boolean"},"partitionColumnName":{"description":"This parameter is deprecated","type":"string"},"partitionSchemaName":{"description":"This parameter is deprecated","type":"string"},"partitionTableName":{"description":"This parameter is deprecated","type":"string"},"partitionTablePartitionColumnMinName":{"description":"This parameter is deprecated","type":"string"},"partitionTablePartitionColumnMaxName":{"description":"This parameter is deprecated","type":"string"},"mysqlCatalogMatchesSchema":{"description":"This attribute is no longer available; defaults to true but cannot be used.","type":"boolean"},"chunkingMethod":{"description":"This parameter is deprecated","type":"string"},"exportAction":{"description":"For Google Doc Exports. The kind of export action you want to have the export execute. Set to \"newsprsht\" if you want a new worksheet inside a new spreadsheet. Set to \"newwksht\" if you want a new worksheet inside an existing spreadsheet. Set to \"updatewksht\" if you want to overwrite an existing worksheet inside an existing spreadsheet. Set to \"appendwksht\" if you want to append to the end of an existing worksheet inside an existing spreadsheet. Default is set to \"newsprsht\"","type":"string"},"sqlQuery":{"description":"For Google Doc Exports. The SQL query for the export.","type":"string"},"contactLists":{"description":"This parameter is deprecated","type":"string"},"soqlQuery":{"description":"This parameter is deprecated","type":"string"},"includeDeletedRecords":{"description":"This parameter is deprecated","type":"boolean"}}},"Object267":{"type":"object","properties":{"id":{"type":"integer"},"source":{"$ref":"#/definitions/Object268"},"destination":{"$ref":"#/definitions/Object273"},"advancedOptions":{"description":"Additional sync configuration parameters. For examples of sync-specific parameters, see the Examples section of the API documentation.","$ref":"#/definitions/Object274"}}},"Object265":{"type":"object","properties":{"name":{"description":"The name of the import.","type":"string"},"syncType":{"description":"The type of sync to perform; one of Dbsync, AutoImport, GdocImport, and GdocExport.","type":"string"},"source":{"description":"The data source from which to import.","$ref":"#/definitions/Object266"},"destination":{"description":"The database into which to import.","$ref":"#/definitions/Object266"},"schedule":{"description":"The schedule when the import will run.","$ref":"#/definitions/Object106"},"notifications":{"description":"The notifications to send after the script is run.","$ref":"#/definitions/Object107"},"parentId":{"description":"Parent id to trigger this import from","type":"integer"},"id":{"description":"The ID for the import.","type":"integer"},"isOutbound":{"type":"boolean"},"jobType":{"description":"The job type of this import.","type":"string"},"syncs":{"description":"List of syncs.","type":"array","items":{"$ref":"#/definitions/Object267"}},"state":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"lastRun":{"description":"The last run of this import.","$ref":"#/definitions/Object74"},"user":{"$ref":"#/definitions/Object33"},"runningAs":{"description":"The user this job will run as, defaults to the author of the job.","$ref":"#/definitions/Object33"},"nextRunAt":{"description":"The time of the next scheduled run.","type":"string","format":"time"},"timeZone":{"description":"The time zone of this import.","type":"string"},"hidden":{"description":"The hidden status of the item.","type":"boolean"},"archived":{"description":"The archival status of the requested item(s).","type":"string"},"myPermissionLevel":{"description":"Your permission level on the object. One of \"read\", \"write\", or \"manage\".","type":"string"}}},"Object276":{"type":"object","properties":{"name":{"description":"The name of the import.","type":"string"},"syncType":{"description":"The type of sync to perform; one of Dbsync, AutoImport, GdocImport, and GdocExport.","type":"string"},"source":{"description":"The data source from which to import.","$ref":"#/definitions/Object266"},"destination":{"description":"The database into which to import.","$ref":"#/definitions/Object266"},"schedule":{"description":"The schedule when the import will run.","$ref":"#/definitions/Object106"},"id":{"description":"The ID for the import.","type":"integer"},"isOutbound":{"type":"boolean"},"jobType":{"description":"The job type of this import.","type":"string"},"state":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"lastRun":{"description":"The last run of this import.","$ref":"#/definitions/Object74"},"user":{"$ref":"#/definitions/Object33"},"timeZone":{"description":"The time zone of this import.","type":"string"},"archived":{"description":"The archival status of the requested item(s).","type":"string"}}},"Object278":{"type":"object","properties":{"remoteHostId":{"type":"integer"},"credentialId":{"type":"integer"},"additionalCredentials":{"description":"Array that holds additional credentials used for specific imports. For DB Syncs, the first element is an SSL private key credential id, and the second element is the corresponding public key credential id.","type":"array","items":{"type":"integer"}}},"required":["remoteHostId","credentialId"]},"Object277":{"type":"object","properties":{"name":{"description":"The name of the import.","type":"string"},"syncType":{"description":"The type of sync to perform; one of Dbsync, AutoImport, GdocImport, and GdocExport.","type":"string"},"source":{"description":"The data source from which to import.","$ref":"#/definitions/Object278"},"destination":{"description":"The database into which to import.","$ref":"#/definitions/Object278"},"schedule":{"description":"The schedule when the import will run.","$ref":"#/definitions/Object101"},"notifications":{"description":"The notifications to send after the script is run.","$ref":"#/definitions/Object102"},"parentId":{"description":"Parent id to trigger this import from","type":"integer"},"isOutbound":{"type":"boolean"},"nextRunAt":{"description":"The time of the next scheduled run.","type":"string","format":"time"},"timeZone":{"description":"The time zone of this import.","type":"string"},"hidden":{"description":"The hidden status of the item.","type":"boolean"}},"required":["name","syncType","isOutbound"]},"Object279":{"type":"object","properties":{"schema":{"description":"The schema of the destination table.","type":"string"},"name":{"description":"The name of the destination table.","type":"string"},"remoteHostId":{"description":"The id of the destination database host.","type":"integer"},"credentialId":{"description":"The id of the credentials to be used when performing the database import.","type":"integer"},"maxErrors":{"description":"The maximum number of rows with errors to remove from the import before failing.","type":"integer"},"existingTableRows":{"description":"The behaviour if a table with the requested name already exists. One of \"fail\", \"truncate\", \"append\", or \"drop\".Defaults to \"fail\".","type":"string"},"diststyle":{"description":"The diststyle to use for the table. One of \"even\", \"all\", or \"key\".","type":"string"},"distkey":{"description":"The column to use as the distkey for the table.","type":"string"},"sortkey1":{"description":"The column to use as the sort key for the table.","type":"string"},"sortkey2":{"description":"The second column in a compound sortkey for the table.","type":"string"},"columnDelimiter":{"description":"The column delimiter of the file. If column_delimiter is null or omitted, it will be auto-detected. Valid arguments are \"comma\", \"tab\", and \"pipe\".","type":"string"},"firstRowIsHeader":{"description":"A boolean value indicating whether or not the first row is a header row. If first_row_is_header is null or omitted, it will be auto-detected.","type":"boolean"},"multipart":{"description":"If true, the upload URI will require a `multipart/form-data` POST request. Defaults to false.","type":"boolean"},"escaped":{"description":"If true, escape quotes with a backslash; otherwise, escape quotes by double-quoting. Defaults to false.","type":"boolean"},"hidden":{"description":"The hidden status of the item.","type":"boolean"}},"required":["schema","name","remoteHostId","credentialId"]},"Object280":{"type":"object","properties":{"id":{"description":"The id of the import.","type":"integer"},"uploadUri":{"description":"The URI which may be used to upload a tabular file for import. You must use this URI to upload the file you wish imported and then inform the Civis API when your upload is complete using the URI given by the runUri field of this response.","type":"string"},"runUri":{"description":"The URI to POST to once the file upload is complete. After uploading the file using the URI given in the uploadUri attribute of the response, POST to this URI to initiate the import of your uploaded file into the platform.","type":"string"},"uploadFields":{"description":"If multipart was set to true, these fields should be included in the multipart upload.","type":"object","additionalProperties":{"type":"string"}}}},"Object281":{"type":"object","properties":{"id":{"description":"The ID of the run.","type":"integer"},"importId":{"description":"The ID of the Import job.","type":"integer"},"state":{"description":"The state of the run, one of 'queued' 'running' 'succeeded' 'failed' or 'cancelled'.","type":"string"},"isCancelRequested":{"description":"True if run cancel requested, else false.","type":"boolean"},"createdAt":{"description":"The time the run was created.","type":"string","format":"time"},"startedAt":{"description":"The time the run started at.","type":"string","format":"time"},"finishedAt":{"description":"The time the run completed.","type":"string","format":"time"},"error":{"description":"The error, if any, returned by the run.","type":"string"}}},"Object284":{"type":"object","properties":{"storageHostId":{"description":"The ID of the source storage host.","type":"integer"},"credentialId":{"description":"The ID of the credentials for the source storage host.","type":"integer"},"filePaths":{"description":"The file or directory path(s) within the bucket from which to import. E.g. the file_path for \"s3://mybucket/files/all/\" would be \"/files/all/\"If specifying a directory path, the job will import every file found under that path. All files must have the same column layout and file format (e.g., compression, columnDelimiter, etc.).","type":"array","items":{"type":"string"}}},"required":["storageHostId","credentialId","filePaths"]},"Object283":{"type":"object","properties":{"fileIds":{"description":"The file ID(s) to import, if importing Civis file(s).","type":"array","items":{"type":"integer"}},"storagePath":{"description":"The storage host file path to import, if importing files from an external storage provider (ex. S3).","$ref":"#/definitions/Object284"}}},"Object285":{"type":"object","properties":{"schema":{"description":"The destination schema name.","type":"string"},"table":{"description":"The destination table name.","type":"string"},"remoteHostId":{"description":"The ID of the destination database host.","type":"integer"},"credentialId":{"description":"The ID of the credentials for the destination database.","type":"integer"},"primaryKeys":{"description":"A list of column(s) which together uniquely identify a row in the destination table.These columns must not contain NULL values. If the import mode is \"upsert\", this field is required;see the Civis Helpdesk article on \"Advanced CSV Imports via the Civis API\" for more information.","type":"array","items":{"type":"string"}},"lastModifiedKeys":{"description":"A list of the columns indicating a record has been updated.If the destination table does not exist, and the import mode is \"upsert\", this field is required.","type":"array","items":{"type":"string"}}},"required":["schema","table","remoteHostId","credentialId"]},"Object286":{"type":"object","properties":{"name":{"description":"The column name.","type":"string"},"sqlType":{"description":"The SQL type of the column.","type":"string"}},"required":["name"]},"Object287":{"type":"object","properties":{"diststyle":{"description":"The diststyle to use for the table. One of \"even\", \"all\", or \"key\".","type":"string"},"distkey":{"description":"Distkey for this table in Redshift","type":"string"},"sortkeys":{"description":"Sortkeys for this table in Redshift. Please provide a maximum of two.","type":"array","items":{"type":"string"}}}},"Object282":{"type":"object","properties":{"name":{"description":"The name of the import.","type":"string"},"source":{"description":"The source file(s). Provide either an array of Civis file_ids or a storage path hash with an array of one or more file_paths.","$ref":"#/definitions/Object283"},"destination":{"description":"The destination table.","$ref":"#/definitions/Object285"},"firstRowIsHeader":{"description":"A boolean value indicating whether or not the first row of the source file is a header row.","type":"boolean"},"columnDelimiter":{"description":"The column delimiter for the file. Valid arguments are \"comma\", \"tab\", and \"pipe\". Defaults to \"comma\".","type":"string"},"escaped":{"description":"A boolean value indicating whether or not the source file has quotes escaped with a backslash.Defaults to false.","type":"boolean"},"compression":{"description":"The type of compression of the source file. Valid arguments are \"gzip\" and \"none\". Defaults to \"none\".","type":"string"},"existingTableRows":{"description":"The behavior if a destination table with the requested name already exists. One of \"fail\", \"truncate\", \"append\", \"drop\", or \"upsert\".Defaults to \"fail\".","type":"string"},"maxErrors":{"description":"The maximum number of rows with errors to ignore before failing. This option is not supported for Postgres databases.","type":"integer"},"tableColumns":{"description":"An array of hashes corresponding to the columns in the order they appear in the source file. Each hash should have keys for database column \"name\" and \"sqlType\".This parameter is required if the table does not exist, the table is being dropped, or the columns in the source file do not appear in the same order as in the destination table.The \"sqlType\" key is not required when appending to an existing table. ","type":"array","items":{"$ref":"#/definitions/Object286"}},"loosenTypes":{"description":"If true, SQL types with precisions/lengths will have these values increased to accommodate data growth in future loads. Type loosening only occurs on table creation. Defaults to false.","type":"boolean"},"execution":{"description":"In upsert mode, controls the movement of data in upsert mode. If set to \"delayed\", the data will be moved after a brief delay. If set to \"immediate\", the data will be moved immediately. In non-upsert modes, controls the speed at which detailed column stats appear in the data catalogue. Defaults to \"delayed\", to accommodate concurrent upserts to the same table and speedier non-upsert imports.","type":"string"},"redshiftDestinationOptions":{"description":"Additional options for imports whose destination is a Redshift table.","$ref":"#/definitions/Object287"},"hidden":{"description":"The hidden status of the item.","type":"boolean"}},"required":["source","destination","firstRowIsHeader"]},"Object290":{"type":"object","properties":{"storageHostId":{"description":"The ID of the source storage host.","type":"integer"},"credentialId":{"description":"The ID of the credentials for the source storage host.","type":"integer"},"filePaths":{"description":"The file or directory path(s) within the bucket from which to import. E.g. the file_path for \"s3://mybucket/files/all/\" would be \"/files/all/\"If specifying a directory path, the job will import every file found under that path. All files must have the same column layout and file format (e.g., compression, columnDelimiter, etc.).","type":"array","items":{"type":"string"}}}},"Object289":{"type":"object","properties":{"fileIds":{"description":"The file ID(s) to import, if importing Civis file(s).","type":"array","items":{"type":"integer"}},"storagePath":{"description":"The storage host file path to import, if importing files from an external storage provider (ex. S3).","$ref":"#/definitions/Object290"}}},"Object291":{"type":"object","properties":{"schema":{"description":"The destination schema name.","type":"string"},"table":{"description":"The destination table name.","type":"string"},"remoteHostId":{"description":"The ID of the destination database host.","type":"integer"},"credentialId":{"description":"The ID of the credentials for the destination database.","type":"integer"},"primaryKeys":{"description":"A list of column(s) which together uniquely identify a row in the destination table.These columns must not contain NULL values. If the import mode is \"upsert\", this field is required;see the Civis Helpdesk article on \"Advanced CSV Imports via the Civis API\" for more information.","type":"array","items":{"type":"string"}},"lastModifiedKeys":{"description":"A list of the columns indicating a record has been updated.If the destination table does not exist, and the import mode is \"upsert\", this field is required.","type":"array","items":{"type":"string"}}}},"Object292":{"type":"object","properties":{"name":{"description":"The column name.","type":"string"},"sqlType":{"description":"The SQL type of the column.","type":"string"}}},"Object293":{"type":"object","properties":{"diststyle":{"description":"The diststyle to use for the table. One of \"even\", \"all\", or \"key\".","type":"string"},"distkey":{"description":"Distkey for this table in Redshift","type":"string"},"sortkeys":{"description":"Sortkeys for this table in Redshift. Please provide a maximum of two.","type":"array","items":{"type":"string"}}}},"Object288":{"type":"object","properties":{"id":{"description":"The ID for the import.","type":"integer"},"name":{"description":"The name of the import.","type":"string"},"source":{"description":"The source file(s). Provide either an array of Civis file_ids or a storage path hash with an array of one or more file_paths.","$ref":"#/definitions/Object289"},"destination":{"description":"The destination table.","$ref":"#/definitions/Object291"},"firstRowIsHeader":{"description":"A boolean value indicating whether or not the first row of the source file is a header row.","type":"boolean"},"columnDelimiter":{"description":"The column delimiter for the file. Valid arguments are \"comma\", \"tab\", and \"pipe\". Defaults to \"comma\".","type":"string"},"escaped":{"description":"A boolean value indicating whether or not the source file has quotes escaped with a backslash.Defaults to false.","type":"boolean"},"compression":{"description":"The type of compression of the source file. Valid arguments are \"gzip\" and \"none\". Defaults to \"none\".","type":"string"},"existingTableRows":{"description":"The behavior if a destination table with the requested name already exists. One of \"fail\", \"truncate\", \"append\", \"drop\", or \"upsert\".Defaults to \"fail\".","type":"string"},"maxErrors":{"description":"The maximum number of rows with errors to ignore before failing. This option is not supported for Postgres databases.","type":"integer"},"tableColumns":{"description":"An array of hashes corresponding to the columns in the order they appear in the source file. Each hash should have keys for database column \"name\" and \"sqlType\".This parameter is required if the table does not exist, the table is being dropped, or the columns in the source file do not appear in the same order as in the destination table.The \"sqlType\" key is not required when appending to an existing table. ","type":"array","items":{"$ref":"#/definitions/Object292"}},"loosenTypes":{"description":"If true, SQL types with precisions/lengths will have these values increased to accommodate data growth in future loads. Type loosening only occurs on table creation. Defaults to false.","type":"boolean"},"execution":{"description":"In upsert mode, controls the movement of data in upsert mode. If set to \"delayed\", the data will be moved after a brief delay. If set to \"immediate\", the data will be moved immediately. In non-upsert modes, controls the speed at which detailed column stats appear in the data catalogue. Defaults to \"delayed\", to accommodate concurrent upserts to the same table and speedier non-upsert imports.","type":"string"},"redshiftDestinationOptions":{"description":"Additional options for imports whose destination is a Redshift table.","$ref":"#/definitions/Object293"},"hidden":{"description":"The hidden status of the item.","type":"boolean"},"myPermissionLevel":{"description":"Your permission level on the object. One of \"read\", \"write\", or \"manage\".","type":"string"}}},"Object294":{"type":"object","properties":{"name":{"description":"The name of the import.","type":"string"},"source":{"description":"The source file(s). Provide either an array of Civis file_ids or a storage path hash with an array of one or more file_paths.","$ref":"#/definitions/Object283"},"destination":{"description":"The destination table.","$ref":"#/definitions/Object285"},"firstRowIsHeader":{"description":"A boolean value indicating whether or not the first row of the source file is a header row.","type":"boolean"},"columnDelimiter":{"description":"The column delimiter for the file. Valid arguments are \"comma\", \"tab\", and \"pipe\". Defaults to \"comma\".","type":"string"},"escaped":{"description":"A boolean value indicating whether or not the source file has quotes escaped with a backslash.Defaults to false.","type":"boolean"},"compression":{"description":"The type of compression of the source file. Valid arguments are \"gzip\" and \"none\". Defaults to \"none\".","type":"string"},"existingTableRows":{"description":"The behavior if a destination table with the requested name already exists. One of \"fail\", \"truncate\", \"append\", \"drop\", or \"upsert\".Defaults to \"fail\".","type":"string"},"maxErrors":{"description":"The maximum number of rows with errors to ignore before failing. This option is not supported for Postgres databases.","type":"integer"},"tableColumns":{"description":"An array of hashes corresponding to the columns in the order they appear in the source file. Each hash should have keys for database column \"name\" and \"sqlType\".This parameter is required if the table does not exist, the table is being dropped, or the columns in the source file do not appear in the same order as in the destination table.The \"sqlType\" key is not required when appending to an existing table. ","type":"array","items":{"$ref":"#/definitions/Object286"}},"loosenTypes":{"description":"If true, SQL types with precisions/lengths will have these values increased to accommodate data growth in future loads. Type loosening only occurs on table creation. Defaults to false.","type":"boolean"},"execution":{"description":"In upsert mode, controls the movement of data in upsert mode. If set to \"delayed\", the data will be moved after a brief delay. If set to \"immediate\", the data will be moved immediately. In non-upsert modes, controls the speed at which detailed column stats appear in the data catalogue. Defaults to \"delayed\", to accommodate concurrent upserts to the same table and speedier non-upsert imports.","type":"string"},"redshiftDestinationOptions":{"description":"Additional options for imports whose destination is a Redshift table.","$ref":"#/definitions/Object287"}},"required":["source","destination","firstRowIsHeader"]},"Object296":{"type":"object","properties":{"schema":{"description":"The destination schema name.","type":"string"},"table":{"description":"The destination table name.","type":"string"},"remoteHostId":{"description":"The ID of the destination database host.","type":"integer"},"credentialId":{"description":"The ID of the credentials for the destination database.","type":"integer"},"primaryKeys":{"description":"A list of column(s) which together uniquely identify a row in the destination table.These columns must not contain NULL values. If the import mode is \"upsert\", this field is required;see the Civis Helpdesk article on \"Advanced CSV Imports via the Civis API\" for more information.","type":"array","items":{"type":"string"}},"lastModifiedKeys":{"description":"A list of the columns indicating a record has been updated.If the destination table does not exist, and the import mode is \"upsert\", this field is required.","type":"array","items":{"type":"string"}}}},"Object297":{"type":"object","properties":{"name":{"description":"The column name.","type":"string"},"sqlType":{"description":"The SQL type of the column.","type":"string"}}},"Object295":{"type":"object","properties":{"name":{"description":"The name of the import.","type":"string"},"source":{"description":"The source file(s). Provide either an array of Civis file_ids or a storage path hash with an array of one or more file_paths.","$ref":"#/definitions/Object283"},"destination":{"description":"The destination table.","$ref":"#/definitions/Object296"},"firstRowIsHeader":{"description":"A boolean value indicating whether or not the first row of the source file is a header row.","type":"boolean"},"columnDelimiter":{"description":"The column delimiter for the file. Valid arguments are \"comma\", \"tab\", and \"pipe\". Defaults to \"comma\".","type":"string"},"escaped":{"description":"A boolean value indicating whether or not the source file has quotes escaped with a backslash.Defaults to false.","type":"boolean"},"compression":{"description":"The type of compression of the source file. Valid arguments are \"gzip\" and \"none\". Defaults to \"none\".","type":"string"},"existingTableRows":{"description":"The behavior if a destination table with the requested name already exists. One of \"fail\", \"truncate\", \"append\", \"drop\", or \"upsert\".Defaults to \"fail\".","type":"string"},"maxErrors":{"description":"The maximum number of rows with errors to ignore before failing. This option is not supported for Postgres databases.","type":"integer"},"tableColumns":{"description":"An array of hashes corresponding to the columns in the order they appear in the source file. Each hash should have keys for database column \"name\" and \"sqlType\".This parameter is required if the table does not exist, the table is being dropped, or the columns in the source file do not appear in the same order as in the destination table.The \"sqlType\" key is not required when appending to an existing table. ","type":"array","items":{"$ref":"#/definitions/Object297"}},"loosenTypes":{"description":"If true, SQL types with precisions/lengths will have these values increased to accommodate data growth in future loads. Type loosening only occurs on table creation. Defaults to false.","type":"boolean"},"execution":{"description":"In upsert mode, controls the movement of data in upsert mode. If set to \"delayed\", the data will be moved after a brief delay. If set to \"immediate\", the data will be moved immediately. In non-upsert modes, controls the speed at which detailed column stats appear in the data catalogue. Defaults to \"delayed\", to accommodate concurrent upserts to the same table and speedier non-upsert imports.","type":"string"},"redshiftDestinationOptions":{"description":"Additional options for imports whose destination is a Redshift table.","$ref":"#/definitions/Object287"}}},"Object298":{"type":"object","properties":{"status":{"description":"The desired archived status of the object.","type":"boolean"}},"required":["status"]},"Object299":{"type":"object","properties":{"id":{"description":"The ID of the run.","type":"integer"},"csvImportId":{"description":"The ID of the CSV Import job.","type":"integer"},"state":{"description":"The state of the run, one of 'queued' 'running' 'succeeded' 'failed' or 'cancelled'.","type":"string"},"isCancelRequested":{"description":"True if run cancel requested, else false.","type":"boolean"},"createdAt":{"description":"The time the run was created.","type":"string","format":"time"},"startedAt":{"description":"The time the run started at.","type":"string","format":"time"},"finishedAt":{"description":"The time the run completed.","type":"string","format":"time"},"error":{"description":"The error, if any, returned by the run.","type":"string"}}},"Object300":{"type":"object","properties":{"id":{"description":"The ID for the import.","type":"integer"},"schema":{"description":"The destination schema name. This schema must already exist in Redshift.","type":"string"},"table":{"description":"The destination table name, without the schema prefix. This table must already exist in Redshift.","type":"string"},"remoteHostId":{"description":"The ID of the destination database host.","type":"integer"},"state":{"description":"The state of the run; one of \"queued\", \"running\", \"succeeded\", \"failed\", or \"cancelled\".","type":"string"},"startedAt":{"description":"The time the last run started at.","type":"string","format":"time"},"finishedAt":{"description":"The time the last run completed.","type":"string","format":"time"},"error":{"description":"The error returned by the run, if any.","type":"string"}}},"Object301":{"type":"object","properties":{"id":{"description":"The ID for the import.","type":"integer"},"schema":{"description":"The destination schema name. This schema must already exist in Redshift.","type":"string"},"table":{"description":"The destination table name, without the schema prefix. This table must already exist in Redshift.","type":"string"},"remoteHostId":{"description":"The ID of the destination database host.","type":"integer"},"state":{"description":"The state of the run; one of \"queued\", \"running\", \"succeeded\", \"failed\", or \"cancelled\".","type":"string"},"startedAt":{"description":"The time the last run started at.","type":"string","format":"time"},"finishedAt":{"description":"The time the last run completed.","type":"string","format":"time"},"error":{"description":"The error returned by the run, if any.","type":"string"},"hidden":{"description":"The hidden status of the item.","type":"boolean"}}},"Object302":{"type":"object","properties":{"fileIds":{"description":"The file IDs for the import.","type":"array","items":{"type":"integer"}},"schema":{"description":"The destination schema name. This schema must already exist in Redshift.","type":"string"},"table":{"description":"The destination table name, without the schema prefix. This table must already exist in Redshift.","type":"string"},"remoteHostId":{"description":"The ID of the destination database host.","type":"integer"},"credentialId":{"description":"The ID of the credentials to be used when performing the database import.","type":"integer"},"columnDelimiter":{"description":"The column delimiter for the file. Valid arguments are \"comma\", \"tab\", and \"pipe\". If unspecified, defaults to \"comma\".","type":"string"},"firstRowIsHeader":{"description":"A boolean value indicating whether or not the first row is a header row. If unspecified, defaults to false.","type":"boolean"},"compression":{"description":"The type of compression. Valid arguments are \"gzip\", \"zip\", and \"none\". If unspecified, defaults to \"gzip\".","type":"string"},"hidden":{"description":"The hidden status of the item.","type":"boolean"}},"required":["fileIds","schema","table","remoteHostId","credentialId"]},"Object303":{"type":"object","properties":{"name":{"description":"The name of the import.","type":"string"},"syncType":{"description":"The type of sync to perform; one of Dbsync, AutoImport, GdocImport, and GdocExport.","type":"string"},"source":{"description":"The data source from which to import.","$ref":"#/definitions/Object278"},"destination":{"description":"The database into which to import.","$ref":"#/definitions/Object278"},"schedule":{"description":"The schedule when the import will run.","$ref":"#/definitions/Object101"},"notifications":{"description":"The notifications to send after the script is run.","$ref":"#/definitions/Object102"},"parentId":{"description":"Parent id to trigger this import from","type":"integer"},"isOutbound":{"type":"boolean"},"nextRunAt":{"description":"The time of the next scheduled run.","type":"string","format":"time"},"timeZone":{"description":"The time zone of this import.","type":"string"}},"required":["name","syncType","isOutbound"]},"Object304":{"type":"object","properties":{"runId":{"description":"The ID of the new run triggered.","type":"integer"}}},"Object305":{"type":"object","properties":{"id":{"description":"The ID of the run.","type":"integer"},"state":{"description":"The state of the run, one of 'queued', 'running' or 'cancelled'.","type":"string"},"isCancelRequested":{"description":"True if run cancel requested, else false.","type":"boolean"}}},"Object308":{"type":"object","properties":{"schema":{"description":"The database schema name.","type":"string"},"table":{"description":"The database table name.","type":"string"},"useWithoutSchema":{"description":"This attribute is no longer available; defaults to false but cannot be used.","type":"boolean"}},"required":["schema","table"]},"Object309":{"type":"object","properties":{}},"Object310":{"type":"object","properties":{"spreadsheet":{"description":"The spreadsheet document name.","type":"string"},"spreadsheetId":{"description":"The spreadsheet document id.","type":"string"},"worksheet":{"description":"The worksheet tab name.","type":"string"},"worksheetId":{"description":"The worksheet tab id.","type":"integer"}},"required":["spreadsheet","worksheet"]},"Object311":{"type":"object","properties":{"objectName":{"description":"This parameter is deprecated","type":"string"}},"required":["objectName"]},"Object307":{"type":"object","properties":{"path":{"description":"The path of the dataset to sync from; for a database source, schema.tablename. If you are doing a Google Sheet export, this can be blank. This is a legacy parameter, it is recommended you use one of the following: databaseTable, file, googleWorksheet","type":"string"},"databaseTable":{"description":"The sync source is a database table.","$ref":"#/definitions/Object308"},"file":{"description":"The sync source is a file.","$ref":"#/definitions/Object309"},"googleWorksheet":{"description":"The sync source is a Google worksheet.","$ref":"#/definitions/Object310"},"salesforce":{"description":"The sync source is Salesforce. Deprecated. Please use the new version instead, see https://support.civisanalytics.com/hc/en-us/articles/8774034069261-Salesforce-Import for details.","$ref":"#/definitions/Object311"}}},"Object312":{"type":"object","properties":{"path":{"description":"The schema.tablename to sync to. If you are doing a Google Sheet export, this is the spreadsheet and sheet name separated by a period. i.e. if you have a spreadsheet named \"MySpreadsheet\" and a sheet called \"Sheet1\" this field would be \"MySpreadsheet.Sheet1\". This is a legacy parameter, it is recommended you use one of the following: databaseTable, googleWorksheet","type":"string"},"databaseTable":{"description":"The sync destination is a database table.","$ref":"#/definitions/Object308"},"googleWorksheet":{"description":"The sync destination is a Google worksheet.","$ref":"#/definitions/Object310"}}},"Object314":{"type":"object","properties":{"name":{"description":"The column name that will override the auto-detected name.","type":"string"},"type":{"description":"Declaration of SQL type that will override the auto-detected SQL type, including necessary properties such as length, precision, etc.","type":"string"}}},"Object313":{"type":"object","properties":{"maxErrors":{"description":"For Google Doc and Auto Imports. The maximum number of errors that can occur without the job failing.","type":"integer"},"existingTableRows":{"description":"For Google Doc and Auto Imports. The behavior if a table with the requested name already exists. One of \"fail\", \"truncate\", \"append\", or \"drop\". Defaults to \"fail\".","type":"string"},"firstRowIsHeader":{"description":"For Google Doc and Auto Imports. A boolean value indicating whether or not the first row is a header row.","type":"boolean"},"diststyle":{"description":"For Auto Imports. The diststyle to use for a Redshift table.","type":"string"},"distkey":{"description":"For Auto Imports. The distkey to use for a Redshift table.","type":"string"},"sortkey1":{"description":"For Auto Imports. The first sortkey to use for a Redshift table.","type":"string"},"sortkey2":{"description":"For Auto Imports. The second sortkey to use for a Redshift table.","type":"string"},"columnDelimiter":{"description":"For Auto Imports. The column delimiter for the file. Valid arguments are \"comma\", \"tab\", and \"pipe\". If column_delimiter is null or omitted, it will be auto-detected.","type":"string"},"columnOverrides":{"description":"For Auto Imports. Hash used for overriding auto-detected names and types, with keys being the index of the column being overridden.","type":"object","additionalProperties":{"$ref":"#/definitions/Object314"}},"escaped":{"description":"For Auto Imports. If true, escape quotes with a backslash; otherwise, escape quotes by double-quoting. Defaults to false.","type":"boolean"},"identityColumn":{"description":"For DB Syncs. The column or columns to use as primary key for incremental syncs. Should be a unique identifier. If blank, primary key columns will be auto-detected. If more than one identity column is specified, an identity column must be specified for each table. We recommend the primary key be a sequential data type such as an integer, double, timestamp, date, or float. If using a primary key that is a string data type, we recommend having a last_modified_column to ensure all data is synced to the destination table.","type":"string"},"lastModifiedColumn":{"description":"For DB Syncs. The column to use to detect recently modified data for incremental syncs. Defaults to \"Auto-Detect\", which will use the first column it finds containing either \"modif\" or \"update\" in the name. When specified, only rows where last_modified_column in the source >= last_modified_column in the destination will be synced.","type":"string"},"rowChunkSize":{"description":"For DB Syncs. If specified, will split the sync into chunks of this size.","type":"integer"},"wipeDestinationTable":{"description":"For DB Syncs. If true, will perform a full table refresh.","type":"boolean"},"truncateLongLines":{"description":"For DB Syncs to Redshift. When true, truncates column data to fit the column specification.","type":"boolean"},"invalidCharReplacement":{"description":"For DB Syncs to Redshift. If specified, will replace each invalid UTF-8 character with this character. Must be a single ASCII character.","type":"string"},"verifyTableRowCounts":{"description":"For DB Syncs. When true, an error will be raised if the destination table does not have the same number of rows as the source table after the sync.","type":"boolean"},"partitionColumnName":{"description":"This parameter is deprecated","type":"string"},"partitionSchemaName":{"description":"This parameter is deprecated","type":"string"},"partitionTableName":{"description":"This parameter is deprecated","type":"string"},"partitionTablePartitionColumnMinName":{"description":"This parameter is deprecated","type":"string"},"partitionTablePartitionColumnMaxName":{"description":"This parameter is deprecated","type":"string"},"mysqlCatalogMatchesSchema":{"description":"This attribute is no longer available; defaults to true but cannot be used.","type":"boolean"},"chunkingMethod":{"description":"This parameter is deprecated","type":"string"},"exportAction":{"description":"For Google Doc Exports. The kind of export action you want to have the export execute. Set to \"newsprsht\" if you want a new worksheet inside a new spreadsheet. Set to \"newwksht\" if you want a new worksheet inside an existing spreadsheet. Set to \"updatewksht\" if you want to overwrite an existing worksheet inside an existing spreadsheet. Set to \"appendwksht\" if you want to append to the end of an existing worksheet inside an existing spreadsheet. Default is set to \"newsprsht\"","type":"string"},"sqlQuery":{"description":"For Google Doc Exports. The SQL query for the export.","type":"string"},"contactLists":{"description":"This parameter is deprecated","type":"string"},"soqlQuery":{"description":"This parameter is deprecated","type":"string"},"includeDeletedRecords":{"description":"This parameter is deprecated","type":"boolean"}}},"Object306":{"type":"object","properties":{"source":{"$ref":"#/definitions/Object307"},"destination":{"$ref":"#/definitions/Object312"},"advancedOptions":{"description":"Additional sync configuration parameters. For examples of sync-specific parameters, see the Examples section of the API documentation.","$ref":"#/definitions/Object313"}},"required":["source","destination"]},"Object315":{"type":"object","properties":{"source":{"description":"The sync source. Should contain only one of the following objects:","$ref":"#/definitions/Object307"},"destination":{"description":"The sync destination. Should contain only one of the following objects:","$ref":"#/definitions/Object312"},"advancedOptions":{"$ref":"#/definitions/Object313"}},"required":["source","destination"]},"Object316":{"type":"object","properties":{"status":{"description":"The desired archived status of the sync.","type":"boolean"}}},"Object317":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"type":{"type":"string"},"fromTemplateId":{"type":"integer"},"state":{"description":"Whether the job is idle, queued, running, cancelled, or failed.","type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"lastRun":{"$ref":"#/definitions/Object74"},"archived":{"description":"The archival status of the requested item(s).","type":"string"},"author":{"description":"The author/owner of the item.","$ref":"#/definitions/Object33"},"schedule":{"description":"The schedule when the job will run.","$ref":"#/definitions/Object106"}}},"Object318":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"type":{"type":"string"},"fromTemplateId":{"type":"integer"},"state":{"description":"Whether the job is idle, queued, running, cancelled, or failed.","type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"runs":{"description":"Information about the most recent runs of the job.","type":"array","items":{"$ref":"#/definitions/Object74"}},"lastRun":{"$ref":"#/definitions/Object74"},"hidden":{"description":"The hidden status of the item.","type":"boolean"},"archived":{"description":"The archival status of the requested item(s).","type":"string"},"author":{"description":"The author/owner of the item.","$ref":"#/definitions/Object33"},"myPermissionLevel":{"description":"Your permission level on the object. One of \"read\", \"write\", or \"manage\".","type":"string"},"successEmailSubject":{"type":"string"},"successEmailBody":{"type":"string"},"runningAsUser":{"type":"string"},"runByUser":{"type":"string"},"schedule":{"description":"The schedule when the job will run.","$ref":"#/definitions/Object106"}}},"Object319":{"type":"object","properties":{"triggerEmail":{"description":"Email address which may be used to trigger this job to run.","type":"string"}}},"Object320":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"type":{"type":"string"},"fromTemplateId":{"type":"integer"},"state":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"runs":{"type":"array","items":{"$ref":"#/definitions/Object74"}},"lastRun":{"$ref":"#/definitions/Object74"},"children":{"type":"array","items":{"$ref":"#/definitions/Object320"}}}},"Object323":{"type":"object","properties":{"objectType":{"description":"The type of the output. Valid values are File, Table, Report, Project, Credential, or JSONValue","type":"string"},"objectId":{"description":"The ID of the output.","type":"integer"},"name":{"description":"The name of the output.","type":"string"},"link":{"description":"The hypermedia link to the output.","type":"string"},"value":{"type":"string"}}},"Object324":{"type":"object","properties":{"id":{"description":"The ID for this workflow.","type":"integer"},"name":{"description":"The name of this workflow.","type":"string"},"description":{"description":"A description of the workflow.","type":"string"},"valid":{"description":"The validity of the workflow definition.","type":"boolean"},"fileId":{"description":"The file id for the s3 file containing the workflow configuration.","type":"string"},"user":{"description":"The author of this workflow.","$ref":"#/definitions/Object33"},"state":{"description":"The state of the workflow. State is \"running\" if any execution is running, otherwise reflects most recent execution state.","type":"string"},"schedule":{"description":"The schedule of when this workflow will be run. Must not be specified if `fromJobChain` is specified.","$ref":"#/definitions/Object106"},"allowConcurrentExecutions":{"description":"Whether the workflow can execute when already running.","type":"boolean"},"timeZone":{"description":"The time zone of this workflow.","type":"string"},"nextExecutionAt":{"description":"The time of the next scheduled execution.","type":"string","format":"time"},"archived":{"description":"The archival status of the requested item(s).","type":"string"},"createdAt":{"type":"string","format":"time"},"updatedAt":{"type":"string","format":"time"}}},"Object328":{"type":"object","properties":{"userIds":{"description":"An array of one or more user IDs.","type":"array","items":{"type":"integer"}},"permissionLevel":{"description":"Options are: \"read\", \"write\", or \"manage\".","type":"string"},"shareEmailBody":{"description":"Custom body text for e-mail sent on a share.","type":"string"},"sendSharedEmail":{"description":"Send email to the recipients of a share.","type":"boolean"}},"required":["userIds","permissionLevel"]},"Object329":{"type":"object","properties":{"groupIds":{"description":"An array of one or more group IDs.","type":"array","items":{"type":"integer"}},"permissionLevel":{"description":"Options are: \"read\", \"write\", or \"manage\".","type":"string"},"shareEmailBody":{"description":"Custom body text for e-mail sent on a share.","type":"string"},"sendSharedEmail":{"description":"Send email to the recipients of a share.","type":"boolean"}},"required":["groupIds","permissionLevel"]},"Object330":{"type":"object","properties":{"userId":{"description":"ID of target user","type":"integer"},"includeDependencies":{"description":"Whether or not to give manage permissions on all dependencies","type":"boolean"},"emailBody":{"description":"Custom body text for e-mail sent on transfer.","type":"string"},"sendEmail":{"description":"Send email to the target user of the transfer?","type":"boolean"}},"required":["userId","includeDependencies"]},"Object331":{"type":"object","properties":{"status":{"description":"The desired archived status of the object.","type":"boolean"}},"required":["status"]},"Object332":{"type":"object","properties":{"name":{"description":"The name of the JSON Value.","type":"string"},"valueStr":{"description":"The JSON value to store. Should be a serialized JSON string. Limited to 1000000 bytes.","type":"string"}},"required":["valueStr"]},"Object333":{"type":"object","properties":{"id":{"description":"The ID of the JSON Value.","type":"integer"},"name":{"description":"The name of the JSON Value.","type":"string"},"value":{"description":"The deserialized JSON value.","type":"string"}}},"Object334":{"type":"object","properties":{"name":{"description":"The name of the JSON Value.","type":"string"},"valueStr":{"description":"The JSON value to store. Should be a serialized JSON string. Limited to 1000000 bytes.","type":"string"}}},"Object335":{"type":"object","properties":{"userIds":{"description":"An array of one or more user IDs.","type":"array","items":{"type":"integer"}},"permissionLevel":{"description":"Options are: \"read\", \"write\", or \"manage\".","type":"string"},"shareEmailBody":{"description":"Custom body text for e-mail sent on a share.","type":"string"},"sendSharedEmail":{"description":"Send email to the recipients of a share.","type":"boolean"}},"required":["userIds","permissionLevel"]},"Object336":{"type":"object","properties":{"groupIds":{"description":"An array of one or more group IDs.","type":"array","items":{"type":"integer"}},"permissionLevel":{"description":"Options are: \"read\", \"write\", or \"manage\".","type":"string"},"shareEmailBody":{"description":"Custom body text for e-mail sent on a share.","type":"string"},"sendSharedEmail":{"description":"Send email to the recipients of a share.","type":"boolean"}},"required":["groupIds","permissionLevel"]},"Object337":{"type":"object","properties":{"userId":{"description":"ID of target user","type":"integer"},"includeDependencies":{"description":"Whether or not to give manage permissions on all dependencies","type":"boolean"},"emailBody":{"description":"Custom body text for e-mail sent on transfer.","type":"string"},"sendEmail":{"description":"Send email to the target user of the transfer?","type":"boolean"}},"required":["userId","includeDependencies"]},"Object341":{"type":"object","properties":{"userIds":{"description":"An array of one or more user IDs.","type":"array","items":{"type":"integer"}},"permissionLevel":{"description":"Options are: \"read\", \"write\", or \"manage\".","type":"string"},"shareEmailBody":{"description":"Custom body text for e-mail sent on a share.","type":"string"},"sendSharedEmail":{"description":"Send email to the recipients of a share.","type":"boolean"}},"required":["userIds","permissionLevel"]},"Object342":{"type":"object","properties":{"groupIds":{"description":"An array of one or more group IDs.","type":"array","items":{"type":"integer"}},"permissionLevel":{"description":"Options are: \"read\", \"write\", or \"manage\".","type":"string"},"shareEmailBody":{"description":"Custom body text for e-mail sent on a share.","type":"string"},"sendSharedEmail":{"description":"Send email to the recipients of a share.","type":"boolean"}},"required":["groupIds","permissionLevel"]},"Object343":{"type":"object","properties":{"status":{"description":"The desired archived status of the object.","type":"boolean"}},"required":["status"]},"Object344":{"type":"object","properties":{"id":{"description":"The ID of the match target","type":"integer"},"name":{"description":"The name of the match target","type":"string"},"targetFileName":{"description":"The name of the target file","type":"string"},"createdAt":{"type":"string","format":"time"},"updatedAt":{"type":"string","format":"time"},"archived":{"description":"Whether the match target has been archived.","type":"boolean"}}},"Object345":{"type":"object","properties":{"name":{"description":"The name of the match target","type":"string"},"targetFileName":{"description":"The name of the target file","type":"string"},"archived":{"description":"Whether the match target has been archived.","type":"boolean"}},"required":["name"]},"Object346":{"type":"object","properties":{"name":{"description":"The name of the match target","type":"string"},"targetFileName":{"description":"The name of the target file","type":"string"},"archived":{"description":"Whether the match target has been archived.","type":"boolean"}}},"Object347":{"type":"object","properties":{"userIds":{"description":"An array of one or more user IDs.","type":"array","items":{"type":"integer"}},"permissionLevel":{"description":"Options are: \"read\", \"write\", or \"manage\".","type":"string"},"shareEmailBody":{"description":"Custom body text for e-mail sent on a share.","type":"string"},"sendSharedEmail":{"description":"Send email to the recipients of a share.","type":"boolean"}},"required":["userIds","permissionLevel"]},"Object348":{"type":"object","properties":{"groupIds":{"description":"An array of one or more group IDs.","type":"array","items":{"type":"integer"}},"permissionLevel":{"description":"Options are: \"read\", \"write\", or \"manage\".","type":"string"},"shareEmailBody":{"description":"Custom body text for e-mail sent on a share.","type":"string"},"sendSharedEmail":{"description":"Send email to the recipients of a share.","type":"boolean"}},"required":["groupIds","permissionLevel"]},"Object349":{"type":"object","properties":{"status":{"description":"The desired archived status of the object.","type":"boolean"}},"required":["status"]},"Object350":{"type":"object","properties":{"id":{"description":"The ID for the spot order.","type":"integer"},"archived":{"description":"The archival status of the requested item(s).","type":"string"},"csvS3Uri":{"description":"S3 URI for the spot order CSV file.","type":"string"},"jsonS3Uri":{"description":"S3 URI for the spot order JSON file.","type":"string"},"xmlArchiveS3Uri":{"description":"S3 URI for the spot order XML archive.","type":"string"},"lastTransformJobId":{"description":"ID of the spot order transformation job.","type":"integer"}}},"Object351":{"type":"object","properties":{"userIds":{"description":"An array of one or more user IDs.","type":"array","items":{"type":"integer"}},"permissionLevel":{"description":"Options are: \"read\", \"write\", or \"manage\".","type":"string"},"shareEmailBody":{"description":"Custom body text for e-mail sent on a share.","type":"string"},"sendSharedEmail":{"description":"Send email to the recipients of a share.","type":"boolean"}},"required":["userIds","permissionLevel"]},"Object352":{"type":"object","properties":{"groupIds":{"description":"An array of one or more group IDs.","type":"array","items":{"type":"integer"}},"permissionLevel":{"description":"Options are: \"read\", \"write\", or \"manage\".","type":"string"},"shareEmailBody":{"description":"Custom body text for e-mail sent on a share.","type":"string"},"sendSharedEmail":{"description":"Send email to the recipients of a share.","type":"boolean"}},"required":["groupIds","permissionLevel"]},"Object353":{"type":"object","properties":{"status":{"description":"The desired archived status of the object.","type":"boolean"}},"required":["status"]},"Object356":{"type":"object","properties":{"targets":{"description":"The targets to constrain.","type":"array","items":{"type":"string"}},"budget":{"description":"The maximum budget for these targets.","type":"number","format":"float"},"frequency":{"description":"The maximum frequency for these targets.","type":"number","format":"float"}}},"Object355":{"type":"object","properties":{"marketId":{"description":"The market ID.","type":"integer"},"startDate":{"description":"The start date for the media run.","type":"string","format":"date"},"endDate":{"description":"The end date for the media run.","type":"string","format":"date"},"forceCpm":{"description":"Whether to force optimization to use CPM data even if partition data is available.","type":"boolean"},"reachAlpha":{"description":"A tuning parameter used to adjust RF.","type":"number","format":"float"},"syscodes":{"description":"The syscodes for the media run.","type":"array","items":{"type":"integer"}},"rateCards":{"description":"The ratecards for the media run.","type":"array","items":{"type":"string"}},"constraints":{"description":"The constraints for the media run.","type":"array","items":{"$ref":"#/definitions/Object356"}}}},"Object354":{"type":"object","properties":{"id":{"description":"The optimization ID.","type":"integer"},"author":{"description":"The author/owner of the item.","$ref":"#/definitions/Object33"},"name":{"description":"The name of the optimization.","type":"string"},"createdAt":{"type":"string","format":"time"},"updatedAt":{"type":"string","format":"time"},"finishedAt":{"description":"The end time of the last run.","type":"string","format":"date-time"},"state":{"description":"The state of the last run.","type":"string"},"lastRunId":{"description":"The ID of the last run.","type":"integer"},"spotOrderId":{"description":"The ID for the spot order produced by the optimization.","type":"integer"},"archived":{"description":"The archival status of the requested item(s).","type":"string"},"reportLink":{"description":"A link to the visual report for the optimization.","type":"string"},"spotOrderLink":{"description":"A link to the json version of the spot order.","type":"string"},"fileLinks":{"description":"Links to the csv and xml versions of the spot order.","type":"array","items":{"type":"string"}},"runs":{"description":"The runs of the optimization.","type":"array","items":{"$ref":"#/definitions/Object355"}},"programs":{"description":"An array of programs that the Civis Media Optimizer either exclude or limit to.An error will be thrown if exclude_programs is not also set.","type":"array","items":{"type":"string"}},"networks":{"description":"An array of networks that the Civis Media Optimizer either exclude or limit to.An error will be thrown if exclude_networks is not also set.","type":"array","items":{"type":"string"}},"excludePrograms":{"description":"If Civis Media Optimizer should exclude the programs in the programs parameter.If this value is set to false, it will make the optimization limit itself to the programs supplied through the programs parameter.An error will be thrown if programs is not also set.","type":"boolean"},"excludeNetworks":{"description":"If Civis Media Optimizer should exclude the networks in the networks parameter.If this value is set to false, it will make the optimization limit itself to the networks supplied through the networks.An error will be thrown if networks is not also set.","type":"boolean"},"timeSlotPercentages":{"description":"The maximum amount of the budget spent on that particular day of the week, daypart, or specific time slot for broadcast and cable.","type":"object"}}},"Object357":{"type":"object","properties":{"userIds":{"description":"An array of one or more user IDs.","type":"array","items":{"type":"integer"}},"permissionLevel":{"description":"Options are: \"read\", \"write\", or \"manage\".","type":"string"},"shareEmailBody":{"description":"Custom body text for e-mail sent on a share.","type":"string"},"sendSharedEmail":{"description":"Send email to the recipients of a share.","type":"boolean"}},"required":["userIds","permissionLevel"]},"Object358":{"type":"object","properties":{"groupIds":{"description":"An array of one or more group IDs.","type":"array","items":{"type":"integer"}},"permissionLevel":{"description":"Options are: \"read\", \"write\", or \"manage\".","type":"string"},"shareEmailBody":{"description":"Custom body text for e-mail sent on a share.","type":"string"},"sendSharedEmail":{"description":"Send email to the recipients of a share.","type":"boolean"}},"required":["groupIds","permissionLevel"]},"Object359":{"type":"object","properties":{"status":{"description":"The desired archived status of the object.","type":"boolean"}},"required":["status"]},"Object360":{"type":"object","properties":{"id":{"description":"The ratecard ID.","type":"integer"},"filename":{"description":"Name of the ratecard file.","type":"string"},"startOn":{"description":"First day to which the ratecard applies.","type":"string","format":"date"},"endOn":{"description":"Last day to which the ratecard applies.","type":"string","format":"date"},"dmaNumber":{"description":"Number of the DMA associated with the ratecard.","type":"integer"},"archived":{"description":"The archival status of the requested item(s).","type":"string"}}},"Object361":{"type":"object","properties":{"id":{"description":"The optimization ID.","type":"integer"},"author":{"description":"The author/owner of the item.","$ref":"#/definitions/Object33"},"name":{"description":"The name of the optimization.","type":"string"},"createdAt":{"type":"string","format":"time"},"updatedAt":{"type":"string","format":"time"},"finishedAt":{"description":"The end time of the last run.","type":"string","format":"date-time"},"state":{"description":"The state of the last run.","type":"string"},"lastRunId":{"description":"The ID of the last run.","type":"integer"},"spotOrderId":{"description":"The ID for the spot order produced by the optimization.","type":"integer"},"archived":{"description":"The archival status of the requested item(s).","type":"string"}}},"Object364":{"type":"object","properties":{"targets":{"description":"The targets to constrain.","type":"array","items":{"type":"string"}},"budget":{"description":"The maximum budget for these targets.","type":"number","format":"float"},"frequency":{"description":"The maximum frequency for these targets.","type":"number","format":"float"}},"required":["targets"]},"Object363":{"type":"object","properties":{"marketId":{"description":"The market ID.","type":"integer"},"startDate":{"description":"The start date for the media run.","type":"string","format":"date"},"endDate":{"description":"The end date for the media run.","type":"string","format":"date"},"forceCpm":{"description":"Whether to force optimization to use CPM data even if partition data is available.","type":"boolean"},"reachAlpha":{"description":"A tuning parameter used to adjust RF.","type":"number","format":"float"},"syscodes":{"description":"The syscodes for the media run.","type":"array","items":{"type":"integer"}},"rateCards":{"description":"The ratecards for the media run.","type":"array","items":{"type":"string"}},"constraints":{"description":"The constraints for the media run.","type":"array","items":{"$ref":"#/definitions/Object364"}}},"required":["marketId","startDate","endDate","syscodes","rateCards","constraints"]},"Object362":{"type":"object","properties":{"name":{"description":"The name of the optimization.","type":"string"},"runs":{"description":"The runs of the optimization.","type":"array","items":{"$ref":"#/definitions/Object363"}},"programs":{"description":"An array of programs that the Civis Media Optimizer either exclude or limit to.An error will be thrown if exclude_programs is not also set.","type":"array","items":{"type":"string"}},"networks":{"description":"An array of networks that the Civis Media Optimizer either exclude or limit to.An error will be thrown if exclude_networks is not also set.","type":"array","items":{"type":"string"}},"excludePrograms":{"description":"If Civis Media Optimizer should exclude the programs in the programs parameter.If this value is set to false, it will make the optimization limit itself to the programs supplied through the programs parameter.An error will be thrown if programs is not also set.","type":"boolean"},"excludeNetworks":{"description":"If Civis Media Optimizer should exclude the networks in the networks parameter.If this value is set to false, it will make the optimization limit itself to the networks supplied through the networks.An error will be thrown if networks is not also set.","type":"boolean"},"timeSlotPercentages":{"description":"The maximum amount of the budget spent on that particular day of the week, daypart, or specific time slot for broadcast and cable.","type":"object"}},"required":["runs"]},"Object365":{"type":"object","properties":{"id":{"description":"The ID of the run.","type":"integer"},"optimizationId":{"description":"The ID of the Optimization job.","type":"integer"},"state":{"description":"The state of the run, one of 'queued' 'running' 'succeeded' 'failed' or 'cancelled'.","type":"string"},"isCancelRequested":{"description":"True if run cancel requested, else false.","type":"boolean"},"createdAt":{"description":"The time the run was created.","type":"string","format":"time"},"startedAt":{"description":"The time the run started at.","type":"string","format":"time"},"finishedAt":{"description":"The time the run completed.","type":"string","format":"time"},"error":{"description":"The error, if any, returned by the run.","type":"string"}}},"Object368":{"type":"object","properties":{"targets":{"description":"The targets to constrain.","type":"array","items":{"type":"string"}},"budget":{"description":"The maximum budget for these targets.","type":"number","format":"float"},"frequency":{"description":"The maximum frequency for these targets.","type":"number","format":"float"}}},"Object367":{"type":"object","properties":{"marketId":{"description":"The market ID.","type":"integer"},"startDate":{"description":"The start date for the media run.","type":"string","format":"date"},"endDate":{"description":"The end date for the media run.","type":"string","format":"date"},"forceCpm":{"description":"Whether to force optimization to use CPM data even if partition data is available.","type":"boolean"},"reachAlpha":{"description":"A tuning parameter used to adjust RF.","type":"number","format":"float"},"syscodes":{"description":"The syscodes for the media run.","type":"array","items":{"type":"integer"}},"rateCards":{"description":"The ratecards for the media run.","type":"array","items":{"type":"string"}},"constraints":{"description":"The constraints for the media run.","type":"array","items":{"$ref":"#/definitions/Object368"}}}},"Object366":{"type":"object","properties":{"name":{"description":"The name of the optimization.","type":"string"},"runs":{"description":"The runs of the optimization.","type":"array","items":{"$ref":"#/definitions/Object367"}},"programs":{"description":"An array of programs that the Civis Media Optimizer either exclude or limit to.An error will be thrown if exclude_programs is not also set.","type":"array","items":{"type":"string"}},"networks":{"description":"An array of networks that the Civis Media Optimizer either exclude or limit to.An error will be thrown if exclude_networks is not also set.","type":"array","items":{"type":"string"}},"excludePrograms":{"description":"If Civis Media Optimizer should exclude the programs in the programs parameter.If this value is set to false, it will make the optimization limit itself to the programs supplied through the programs parameter.An error will be thrown if programs is not also set.","type":"boolean"},"excludeNetworks":{"description":"If Civis Media Optimizer should exclude the networks in the networks parameter.If this value is set to false, it will make the optimization limit itself to the networks supplied through the networks.An error will be thrown if networks is not also set.","type":"boolean"},"timeSlotPercentages":{"description":"The maximum amount of the budget spent on that particular day of the week, daypart, or specific time slot for broadcast and cable.","type":"object"}}},"Object369":{"type":"object","properties":{"id":{"description":"The ID for the spot order.","type":"integer"},"archived":{"description":"The archival status of the requested item(s).","type":"string"}}},"Object370":{"type":"object","properties":{"body":{"description":"CSV body of a spot order.","type":"string"}}},"Object371":{"type":"object","properties":{"body":{"description":"CSV body of a spot order.","type":"string"}}},"Object372":{"type":"object","properties":{"filename":{"description":"Name of the ratecard file.","type":"string"},"startOn":{"description":"First day to which the ratecard applies.","type":"string","format":"date"},"endOn":{"description":"Last day to which the ratecard applies.","type":"string","format":"date"},"dmaNumber":{"description":"Number of the DMA associated with the ratecard.","type":"integer"}},"required":["filename","startOn","endOn","dmaNumber"]},"Object373":{"type":"object","properties":{"filename":{"description":"Name of the ratecard file.","type":"string"},"startOn":{"description":"First day to which the ratecard applies.","type":"string","format":"date"},"endOn":{"description":"Last day to which the ratecard applies.","type":"string","format":"date"},"dmaNumber":{"description":"Number of the DMA associated with the ratecard.","type":"integer"}},"required":["filename","startOn","endOn","dmaNumber"]},"Object374":{"type":"object","properties":{"filename":{"description":"Name of the ratecard file.","type":"string"},"startOn":{"description":"First day to which the ratecard applies.","type":"string","format":"date"},"endOn":{"description":"Last day to which the ratecard applies.","type":"string","format":"date"},"dmaNumber":{"description":"Number of the DMA associated with the ratecard.","type":"integer"}}},"Object375":{"type":"object","properties":{"name":{"description":"Name for the DMA region.","type":"string"},"number":{"description":"Identifier number for a DMA.","type":"integer"}}},"Object376":{"type":"object","properties":{"name":{"description":"The name of the target.","type":"string"},"identifier":{"description":"A unique identifier for this target.","type":"string"},"dataSource":{"description":"The source of viewership data for this target.","type":"string"}}},"Object377":{"type":"object","properties":{"id":{"description":"The ID of the model type.","type":"integer"},"algorithm":{"description":"The name of the algorithm used to train the model.","type":"string"},"dvType":{"description":"The type of dependent variable predicted by the model.","type":"string"},"fintAllowed":{"description":"Whether this model type supports searching for interaction terms.","type":"boolean"}}},"Object379":{"type":"object","properties":{"id":{"description":"The ID of the model build.","type":"integer"},"name":{"description":"The name of the model build.","type":"string"},"createdAt":{"description":"The time the model build was created.","type":"string"},"description":{"description":"A description of the model build.","type":"string"},"rootMeanSquaredError":{"description":"A key metric for continuous models. Nil for other model types.","type":"number","format":"float"},"rSquaredError":{"description":"A key metric for continuous models. Nil for other model types.","type":"number","format":"float"},"rocAuc":{"description":"A key metric for binary, multinomial, and ordinal models. Nil for other model types.","type":"number","format":"float"}}},"Object380":{"type":"object","properties":{"id":{"description":"The ID of the model to which to apply the prediction.","type":"integer"},"tableName":{"description":"The qualified name of the table on which to apply the predictive model.","type":"string"},"primaryKey":{"description":"The primary key or composite keys of the table being predicted.","type":"array","items":{"type":"string"}},"limitingSQL":{"description":"A SQL WHERE clause used to scope the rows to be predicted.","type":"string"},"outputTable":{"description":"The qualified name of the table to be created which will contain the model's predictions.","type":"string"},"state":{"description":"The status of the prediction. One of: \"succeeded\", \"failed\", \"queued\", or \"running,\"or \"idle\", if no build has been attempted.","type":"string"}}},"Object378":{"type":"object","properties":{"id":{"description":"The ID of the model.","type":"integer"},"tableName":{"description":"The qualified name of the table containing the training set from which to build the model.","type":"string"},"databaseId":{"description":"The ID of the database holding the training set table used to build the model.","type":"integer"},"credentialId":{"description":"The ID of the credential used to read the target table. Defaults to the user's default credential.","type":"integer"},"modelName":{"description":"The name of the model.","type":"string"},"description":{"description":"A description of the model.","type":"string"},"interactionTerms":{"description":"Whether to search for interaction terms.","type":"boolean"},"boxCoxTransformation":{"description":"Whether to transform data so that it assumes a normal distribution. Valid only with continuous models.","type":"boolean"},"modelTypeId":{"description":"The ID of the model's type.","type":"integer"},"primaryKey":{"description":"The unique ID (primary key) of the training dataset.","type":"string"},"dependentVariable":{"description":"The dependent variable of the training dataset.","type":"string"},"dependentVariableOrder":{"description":"The order of dependent variables, especially useful for Ordinal Modeling.","type":"array","items":{"type":"string"}},"excludedColumns":{"description":"A list of columns which will be considered ineligible to be independent variables.","type":"array","items":{"type":"string"}},"limitingSQL":{"description":"A custom SQL WHERE clause used to filter the rows used to build the model. (e.g., \"id > 105\").","type":"string"},"crossValidationParameters":{"description":"Cross validation parameter grid for tree methods, e.g. {\"n_estimators\": [100, 200, 500], \"learning_rate\": [0.01, 0.1], \"max_depth\": [2, 3]}.","type":"object"},"numberOfFolds":{"description":"Number of folds for cross validation. Default value is 5.","type":"integer"},"schedule":{"description":"The schedule when the model will be built.","$ref":"#/definitions/Object106"},"parentId":{"description":"The ID of the parent job that will trigger this model.","type":"integer"},"timeZone":{"description":"The time zone of this model.","type":"string"},"lastRun":{"description":"The last run of this model build.","$ref":"#/definitions/Object74"},"user":{"$ref":"#/definitions/Object33"},"createdAt":{"description":"The time the model was created.","type":"string","format":"date-time"},"updatedAt":{"description":"The time the model was updated.","type":"string","format":"date-time"},"currentBuildState":{"description":"The status of the current model build. One of \"succeeded\", \"failed\", \"queued\", or \"running,\"or \"idle\", if no build has been attempted.","type":"string"},"currentBuildException":{"description":"Exception message, if applicable, of the current model build.","type":"string"},"builds":{"description":"A list of trained models available for making predictions.","type":"array","items":{"$ref":"#/definitions/Object379"}},"predictions":{"description":"The tables upon which the model will be applied.","type":"array","items":{"$ref":"#/definitions/Object380"}},"lastOutputLocation":{"description":"The output JSON for the last build.","type":"string"},"archived":{"description":"The archival status of the requested item(s).","type":"string"}}},"Object382":{"type":"object","properties":{"id":{"description":"The ID of the model to which to apply the prediction.","type":"integer"},"tableName":{"description":"The qualified name of the table on which to apply the predictive model.","type":"string"},"primaryKey":{"description":"The primary key or composite keys of the table being predicted.","type":"array","items":{"type":"string"}},"limitingSQL":{"description":"A SQL WHERE clause used to scope the rows to be predicted.","type":"string"},"outputTable":{"description":"The qualified name of the table to be created which will contain the model's predictions.","type":"string"},"schedule":{"description":"The schedule of when the prediction will run.","$ref":"#/definitions/Object106"},"state":{"description":"The status of the prediction. One of: \"succeeded\", \"failed\", \"queued\", or \"running,\"or \"idle\", if no build has been attempted.","type":"string"}}},"Object381":{"type":"object","properties":{"id":{"description":"The ID of the model.","type":"integer"},"tableName":{"description":"The qualified name of the table containing the training set from which to build the model.","type":"string"},"databaseId":{"description":"The ID of the database holding the training set table used to build the model.","type":"integer"},"credentialId":{"description":"The ID of the credential used to read the target table. Defaults to the user's default credential.","type":"integer"},"modelName":{"description":"The name of the model.","type":"string"},"description":{"description":"A description of the model.","type":"string"},"interactionTerms":{"description":"Whether to search for interaction terms.","type":"boolean"},"boxCoxTransformation":{"description":"Whether to transform data so that it assumes a normal distribution. Valid only with continuous models.","type":"boolean"},"modelTypeId":{"description":"The ID of the model's type.","type":"integer"},"primaryKey":{"description":"The unique ID (primary key) of the training dataset.","type":"string"},"dependentVariable":{"description":"The dependent variable of the training dataset.","type":"string"},"dependentVariableOrder":{"description":"The order of dependent variables, especially useful for Ordinal Modeling.","type":"array","items":{"type":"string"}},"excludedColumns":{"description":"A list of columns which will be considered ineligible to be independent variables.","type":"array","items":{"type":"string"}},"limitingSQL":{"description":"A custom SQL WHERE clause used to filter the rows used to build the model. (e.g., \"id > 105\").","type":"string"},"activeBuildId":{"description":"The ID of the current active build, the build used to score predictions.","type":"integer"},"crossValidationParameters":{"description":"Cross validation parameter grid for tree methods, e.g. {\"n_estimators\": [100, 200, 500], \"learning_rate\": [0.01, 0.1], \"max_depth\": [2, 3]}.","type":"object"},"numberOfFolds":{"description":"Number of folds for cross validation. Default value is 5.","type":"integer"},"notifications":{"description":"The notifications to send after the script is run.","$ref":"#/definitions/Object107"},"schedule":{"description":"The schedule when the model will be built.","$ref":"#/definitions/Object106"},"parentId":{"description":"The ID of the parent job that will trigger this model.","type":"integer"},"runningAs":{"description":"The user this job will run as, defaults to the author of the job.","$ref":"#/definitions/Object33"},"timeZone":{"description":"The time zone of this model.","type":"string"},"lastRun":{"description":"The last run of this model build.","$ref":"#/definitions/Object74"},"hidden":{"description":"The hidden status of the item.","type":"boolean"},"user":{"$ref":"#/definitions/Object33"},"createdAt":{"description":"The time the model was created.","type":"string","format":"date-time"},"updatedAt":{"description":"The time the model was updated.","type":"string","format":"date-time"},"currentBuildState":{"description":"The status of the current model build. One of \"succeeded\", \"failed\", \"queued\", or \"running,\"or \"idle\", if no build has been attempted.","type":"string"},"currentBuildException":{"description":"Exception message, if applicable, of the current model build.","type":"string"},"builds":{"description":"A list of trained models available for making predictions.","type":"array","items":{"$ref":"#/definitions/Object379"}},"predictions":{"description":"The tables upon which the model will be applied.","type":"array","items":{"$ref":"#/definitions/Object382"}},"lastOutputLocation":{"description":"The output JSON for the last build.","type":"string"},"archived":{"description":"The archival status of the requested item(s).","type":"string"}}},"Object383":{"type":"object","properties":{"id":{"description":"The ID of the model build.","type":"integer"},"state":{"description":"The state of the model build.one of 'queued' 'running' 'succeeded' 'failed' or 'cancelled'.","type":"string"},"error":{"description":"The error, if any, returned by the build.","type":"string"},"name":{"description":"The name of the model build.","type":"string"},"createdAt":{"description":"The time the model build was created.","type":"string"},"description":{"description":"A description of the model build.","type":"string"},"rootMeanSquaredError":{"description":"A key metric for continuous models. Nil for other model types.","type":"number","format":"float"},"rSquaredError":{"description":"A key metric for continuous models. Nil for other model types.","type":"number","format":"float"},"rocAuc":{"description":"A key metric for binary, multinomial, and ordinal models. Nil for other model types.","type":"number","format":"float"},"transformationMetadata":{"description":"A string representing the full JSON output of the metadata for transformation of column names","type":"string"},"output":{"description":"A string representing the JSON output for the specified build. Only present when smaller than 10KB in size.","type":"string"},"outputLocation":{"description":"A URL representing the location of the full JSON output for the specified build.The URL link will be valid for 5 minutes.","type":"string"}}},"Object384":{"type":"object","properties":{"userIds":{"description":"An array of one or more user IDs.","type":"array","items":{"type":"integer"}},"permissionLevel":{"description":"Options are: \"read\", \"write\", or \"manage\".","type":"string"},"shareEmailBody":{"description":"Custom body text for e-mail sent on a share.","type":"string"},"sendSharedEmail":{"description":"Send email to the recipients of a share.","type":"boolean"}},"required":["userIds","permissionLevel"]},"Object385":{"type":"object","properties":{"groupIds":{"description":"An array of one or more group IDs.","type":"array","items":{"type":"integer"}},"permissionLevel":{"description":"Options are: \"read\", \"write\", or \"manage\".","type":"string"},"shareEmailBody":{"description":"Custom body text for e-mail sent on a share.","type":"string"},"sendSharedEmail":{"description":"Send email to the recipients of a share.","type":"boolean"}},"required":["groupIds","permissionLevel"]},"Object386":{"type":"object","properties":{"userId":{"description":"ID of target user","type":"integer"},"includeDependencies":{"description":"Whether or not to give manage permissions on all dependencies","type":"boolean"},"emailBody":{"description":"Custom body text for e-mail sent on transfer.","type":"string"},"sendEmail":{"description":"Send email to the target user of the transfer?","type":"boolean"}},"required":["userId","includeDependencies"]},"Object387":{"type":"object","properties":{"status":{"description":"The desired archived status of the object.","type":"boolean"}},"required":["status"]},"Object388":{"type":"object","properties":{"id":{"description":"The ID of the model associated with this schedule.","type":"integer"},"schedule":{"description":"The schedule of when the model will run.","$ref":"#/definitions/Object106"}}},"Object390":{"type":"object","properties":{"deploymentId":{"description":"The ID for this deployment.","type":"integer"},"userId":{"description":"The ID of the owner.","type":"integer"},"host":{"description":"Domain of the deployment.","type":"string"},"name":{"description":"Name of the deployment.","type":"string"},"dockerImageName":{"description":"The name of the docker image to pull from DockerHub.","type":"string"},"dockerImageTag":{"description":"The tag of the docker image to pull from DockerHub (default: latest).","type":"string"},"instanceType":{"description":"The EC2 instance type requested for the deployment.","type":"string"},"memory":{"description":"The memory allocated to the deployment, in MB.","type":"integer"},"cpu":{"description":"The cpu allocated to the deployment, in millicores.","type":"integer"},"state":{"description":"The state of the deployment.","type":"string"},"stateMessage":{"description":"A detailed description of the state.","type":"string"},"maxMemoryUsage":{"description":"If the deployment has finished, the maximum amount of memory used during the deployment, in MB.","type":"number","format":"float"},"maxCpuUsage":{"description":"If the deployment has finished, the maximum amount of cpu used during the deployment, in millicores.","type":"number","format":"float"},"createdAt":{"type":"string","format":"time"},"updatedAt":{"type":"string","format":"time"},"notebookId":{"description":"The ID of the owning Notebook","type":"integer"}}},"Object389":{"type":"object","properties":{"id":{"description":"The ID for this notebook.","type":"integer"},"name":{"description":"The name of this notebook.","type":"string"},"language":{"description":"The kernel language of this notebook (\"python3\" or \"r\"). Defaults to \"python3\".","type":"string"},"description":{"description":"The description of this notebook.","type":"string"},"user":{"description":"The author of this notebook.","$ref":"#/definitions/Object33"},"createdAt":{"type":"string","format":"time"},"updatedAt":{"type":"string","format":"time"},"mostRecentDeployment":{"$ref":"#/definitions/Object390"},"archived":{"description":"The archival status of the requested item(s).","type":"string"}}},"Object391":{"type":"object","properties":{"name":{"description":"The name of this notebook.","type":"string"},"language":{"description":"The kernel language of this notebook (\"python3\" or \"r\"). Defaults to \"python3\".","type":"string"},"description":{"description":"The description of this notebook.","type":"string"},"fileId":{"description":"The file ID for the S3 file containing the .ipynb file.","type":"string"},"requirementsFileId":{"description":"The file ID for the S3 file containing the requirements.txt file.","type":"string"},"requirements":{"description":"The requirements txt file.","type":"string"},"dockerImageName":{"description":"The name of the docker image to pull from DockerHub.","type":"string"},"dockerImageTag":{"description":"The tag of the docker image to pull from DockerHub (default: latest).","type":"string"},"instanceType":{"description":"The EC2 instance type to deploy to.","type":"string"},"memory":{"description":"The amount of memory allocated to the notebook.","type":"integer"},"cpu":{"description":"The amount of cpu allocated to the the notebook.","type":"integer"},"credentials":{"description":"A list of credential IDs to pass to the notebook.","type":"array","items":{"type":"integer"}},"environmentVariables":{"description":"Environment variables to be passed into the Notebook.","type":"object","additionalProperties":{"type":"string"}},"idleTimeout":{"description":"How long the notebook will stay alive without any kernel activity.","type":"integer"},"partitionLabel":{"description":"The partition label used to run this object.","type":"string"},"gitRepoUrl":{"description":"The URL of the git repository (e.g., https://github.com/organization/repo_name.git).","type":"string"},"gitRef":{"description":"The git reference if git repo is specified","type":"string"},"gitPath":{"description":"The path to the .ipynb file in the git repo that will be started up on notebook launch","type":"string"},"hidden":{"description":"The hidden status of the item.","type":"boolean"}}},"Object393":{"type":"object","properties":{"deploymentId":{"description":"The ID for this deployment.","type":"integer"},"userId":{"description":"The ID of the owner.","type":"integer"},"host":{"description":"Domain of the deployment.","type":"string"},"name":{"description":"Name of the deployment.","type":"string"},"dockerImageName":{"description":"The name of the docker image to pull from DockerHub.","type":"string"},"dockerImageTag":{"description":"The tag of the docker image to pull from DockerHub (default: latest).","type":"string"},"displayUrl":{"description":"A signed URL for viewing the deployed item.","type":"string"},"instanceType":{"description":"The EC2 instance type requested for the deployment.","type":"string"},"memory":{"description":"The memory allocated to the deployment, in MB.","type":"integer"},"cpu":{"description":"The cpu allocated to the deployment, in millicores.","type":"integer"},"state":{"description":"The state of the deployment.","type":"string"},"stateMessage":{"description":"A detailed description of the state.","type":"string"},"maxMemoryUsage":{"description":"If the deployment has finished, the maximum amount of memory used during the deployment, in MB.","type":"number","format":"float"},"maxCpuUsage":{"description":"If the deployment has finished, the maximum amount of cpu used during the deployment, in millicores.","type":"number","format":"float"},"createdAt":{"type":"string","format":"time"},"updatedAt":{"type":"string","format":"time"},"notebookId":{"description":"The ID of the owning Notebook","type":"integer"}}},"Object392":{"type":"object","properties":{"id":{"description":"The ID for this notebook.","type":"integer"},"name":{"description":"The name of this notebook.","type":"string"},"language":{"description":"The kernel language of this notebook (\"python3\" or \"r\"). Defaults to \"python3\".","type":"string"},"description":{"description":"The description of this notebook.","type":"string"},"notebookUrl":{"description":"Time-limited URL to get the .ipynb file for this notebook.","type":"string"},"notebookPreviewUrl":{"description":"Time-limited URL to get the .htm preview file for this notebook.","type":"string"},"requirementsUrl":{"description":"Time-limited URL to get the requirements.txt file for this notebook.","type":"string"},"fileId":{"description":"The file ID for the S3 file containing the .ipynb file.","type":"string"},"requirementsFileId":{"description":"The file ID for the S3 file containing the requirements.txt file.","type":"string"},"user":{"description":"The author of this notebook.","$ref":"#/definitions/Object33"},"dockerImageName":{"description":"The name of the docker image to pull from DockerHub.","type":"string"},"dockerImageTag":{"description":"The tag of the docker image to pull from DockerHub (default: latest).","type":"string"},"instanceType":{"description":"The EC2 instance type to deploy to.","type":"string"},"memory":{"description":"The amount of memory allocated to the notebook.","type":"integer"},"cpu":{"description":"The amount of cpu allocated to the the notebook.","type":"integer"},"createdAt":{"type":"string","format":"time"},"updatedAt":{"type":"string","format":"time"},"mostRecentDeployment":{"$ref":"#/definitions/Object393"},"credentials":{"description":"A list of credential IDs to pass to the notebook.","type":"array","items":{"type":"integer"}},"environmentVariables":{"description":"Environment variables to be passed into the Notebook.","type":"object","additionalProperties":{"type":"string"}},"idleTimeout":{"description":"How long the notebook will stay alive without any kernel activity.","type":"integer"},"partitionLabel":{"description":"The partition label used to run this object.","type":"string"},"gitRepoId":{"description":"The ID of the git repository.","type":"integer"},"gitRepoUrl":{"description":"The URL of the git repository (e.g., https://github.com/organization/repo_name.git).","type":"string"},"gitRef":{"description":"The git reference if git repo is specified","type":"string"},"gitPath":{"description":"The path to the .ipynb file in the git repo that will be started up on notebook launch","type":"string"},"myPermissionLevel":{"description":"Your permission level on the object. One of \"read\", \"write\", or \"manage\".","type":"string"},"archived":{"description":"The archival status of the requested item(s).","type":"string"},"hidden":{"description":"The hidden status of the item.","type":"boolean"}}},"Object394":{"type":"object","properties":{"name":{"description":"The name of this notebook.","type":"string"},"language":{"description":"The kernel language of this notebook (\"python3\" or \"r\"). Defaults to \"python3\".","type":"string"},"description":{"description":"The description of this notebook.","type":"string"},"fileId":{"description":"The file ID for the S3 file containing the .ipynb file.","type":"string"},"requirementsFileId":{"description":"The file ID for the S3 file containing the requirements.txt file.","type":"string"},"requirements":{"description":"The requirements txt file.","type":"string"},"dockerImageName":{"description":"The name of the docker image to pull from DockerHub.","type":"string"},"dockerImageTag":{"description":"The tag of the docker image to pull from DockerHub (default: latest).","type":"string"},"instanceType":{"description":"The EC2 instance type to deploy to.","type":"string"},"memory":{"description":"The amount of memory allocated to the notebook.","type":"integer"},"cpu":{"description":"The amount of cpu allocated to the the notebook.","type":"integer"},"credentials":{"description":"A list of credential IDs to pass to the notebook.","type":"array","items":{"type":"integer"}},"environmentVariables":{"description":"Environment variables to be passed into the Notebook.","type":"object","additionalProperties":{"type":"string"}},"idleTimeout":{"description":"How long the notebook will stay alive without any kernel activity.","type":"integer"},"partitionLabel":{"description":"The partition label used to run this object.","type":"string"},"gitRepoUrl":{"description":"The URL of the git repository (e.g., https://github.com/organization/repo_name.git).","type":"string"},"gitRef":{"description":"The git reference if git repo is specified","type":"string"},"gitPath":{"description":"The path to the .ipynb file in the git repo that will be started up on notebook launch","type":"string"}}},"Object395":{"type":"object","properties":{"updateUrl":{"description":"Time-limited URL to PUT new contents of the .ipynb file for this notebook.","type":"string"},"updatePreviewUrl":{"description":"Time-limited URL to PUT new contents of the .htm preview file for this notebook.","type":"string"}}},"Object396":{"type":"object","properties":{"userIds":{"description":"An array of one or more user IDs.","type":"array","items":{"type":"integer"}},"permissionLevel":{"description":"Options are: \"read\", \"write\", or \"manage\".","type":"string"},"shareEmailBody":{"description":"Custom body text for e-mail sent on a share.","type":"string"},"sendSharedEmail":{"description":"Send email to the recipients of a share.","type":"boolean"}},"required":["userIds","permissionLevel"]},"Object397":{"type":"object","properties":{"groupIds":{"description":"An array of one or more group IDs.","type":"array","items":{"type":"integer"}},"permissionLevel":{"description":"Options are: \"read\", \"write\", or \"manage\".","type":"string"},"shareEmailBody":{"description":"Custom body text for e-mail sent on a share.","type":"string"},"sendSharedEmail":{"description":"Send email to the recipients of a share.","type":"boolean"}},"required":["groupIds","permissionLevel"]},"Object398":{"type":"object","properties":{"userId":{"description":"ID of target user","type":"integer"},"includeDependencies":{"description":"Whether or not to give manage permissions on all dependencies","type":"boolean"},"emailBody":{"description":"Custom body text for e-mail sent on transfer.","type":"string"},"sendEmail":{"description":"Send email to the target user of the transfer?","type":"boolean"}},"required":["userId","includeDependencies"]},"Object399":{"type":"object","properties":{"status":{"description":"The desired archived status of the object.","type":"boolean"}},"required":["status"]},"Object400":{"type":"object","properties":{"deploymentId":{"description":"The ID for this deployment","type":"integer"}}},"Object402":{"type":"object","properties":{"gitRef":{"description":"A git reference specifying an unambiguous version of the file. Can be a branch name, tag or the full or shortened SHA of a commit.","type":"string"},"gitBranch":{"description":"The git branch that the file is on.","type":"string"},"gitPath":{"description":"The path of the file in the repository.","type":"string"},"gitRepo":{"$ref":"#/definitions/Object248"},"gitRefType":{"description":"Specifies if the file is versioned by branch or tag.","type":"string"},"pullFromGit":{"description":"Automatically pull latest commit from git. Only works for scripts and workflows (assuming you have the feature enabled)","type":"boolean"}}},"Object403":{"type":"object","properties":{"gitRef":{"description":"A git reference specifying an unambiguous version of the file. Can be a branch name, or the full or shortened SHA of a commit.","type":"string"},"gitBranch":{"description":"The git branch that the file is on.","type":"string"},"gitPath":{"description":"The path of the file in the repository.","type":"string"},"gitRepoUrl":{"description":"The URL of the git repository (e.g., https://github.com/organization/repo_name.git).","type":"string"},"gitRefType":{"description":"Specifies if the file is versioned by branch or tag.","type":"string"},"pullFromGit":{"description":"Automatically pull latest commit from git. Only works for scripts.","type":"boolean"}}},"Object404":{"type":"object","properties":{"commitHash":{"description":"The SHA of the commit.","type":"string"},"authorName":{"description":"The name of the commit's author.","type":"string"},"date":{"description":"The commit's timestamp.","type":"string","format":"time"},"message":{"description":"The commit message.","type":"string"}}},"Object405":{"type":"object","properties":{"content":{"description":"The contents to commit to the file.","type":"string"},"message":{"description":"A commit message describing the changes being made.","type":"string"},"fileHash":{"description":"The full SHA of the file being replaced.","type":"string"}},"required":["content","message","fileHash"]},"Object406":{"type":"object","properties":{"content":{"description":"The file's contents.","type":"string"},"type":{"description":"The file's type.","type":"string"},"size":{"description":"The file's size.","type":"integer"},"fileHash":{"description":"The SHA of the file.","type":"string"}}},"Object411":{"type":"object","properties":{"key":{"type":"string"},"title":{"type":"string"},"desc":{"description":"A description of this field.","type":"string"},"aliases":{"type":"array","items":{"type":"string"}}}},"Object412":{"type":"object","properties":{"id":{"description":"The id of the favorite.","type":"integer"},"objectId":{"description":"The id of the object. If specified as a query parameter, must also specify object_type parameter.","type":"integer"},"objectType":{"description":"The type of the object that is favorited. Valid options: Container Script, Identity Resolution, Import, Python Script, R Script, dbt Script, JavaScript Script, SQL Script, Template Script, Project, Workflow, Tableau Report, Service Report, HTML Report, SQL Report","type":"string"},"objectName":{"description":"The name of the object that is favorited.","type":"string"},"createdAt":{"description":"The time this favorite was created.","type":"string","format":"time"},"objectUpdatedAt":{"description":"The time the object that is favorited was last updated","type":"string","format":"time"},"objectAuthor":{"description":"The author/owner of the object that is favorited.","$ref":"#/definitions/Object33"},"position":{"description":"The rank position of this favorite. Use the patch users/me/favorites/:id/ranking/ endpoints to update.","type":"integer"}}},"Object413":{"type":"object","properties":{"objectId":{"description":"The id of the object. If specified as a query parameter, must also specify object_type parameter.","type":"integer"},"objectType":{"description":"The type of the object that is favorited. Valid options: Container Script, Identity Resolution, Import, Python Script, R Script, dbt Script, JavaScript Script, SQL Script, Template Script, Project, Workflow, Tableau Report, Service Report, HTML Report, SQL Report","type":"string"}},"required":["objectId","objectType"]},"Object414":{"type":"object","properties":{"id":{"description":"The id of the favorite.","type":"integer"},"objectId":{"description":"The id of the object. If specified as a query parameter, must also specify object_type parameter.","type":"integer"},"objectType":{"description":"The type of the object that is favorited. Valid options: Container Script, Identity Resolution, Import, Python Script, R Script, dbt Script, JavaScript Script, SQL Script, Template Script, Project, Workflow, Tableau Report, Service Report, HTML Report, SQL Report","type":"string"},"objectName":{"description":"The name of the object that is favorited.","type":"string"},"createdAt":{"description":"The time this favorite was created.","type":"string","format":"time"},"objectUpdatedAt":{"description":"The time the object that is favorited was last updated","type":"string","format":"time"},"objectAuthor":{"description":"The author/owner of the object that is favorited.","$ref":"#/definitions/Object33"}}},"Object415":{"type":"object","properties":{"id":{"description":"The ID for this permission set.","type":"integer"},"name":{"description":"The name of this permission set.","type":"string"},"description":{"description":"A description of this permission set.","type":"string"},"author":{"description":"The author/owner of the item.","$ref":"#/definitions/Object33"},"createdAt":{"type":"string","format":"time"},"updatedAt":{"type":"string","format":"time"},"archived":{"description":"The archival status of the requested item(s).","type":"string"}}},"Object416":{"type":"object","properties":{"name":{"description":"The name of this permission set.","type":"string"},"description":{"description":"A description of this permission set.","type":"string"}},"required":["name"]},"Object417":{"type":"object","properties":{"name":{"description":"The name of this permission set.","type":"string"},"description":{"description":"A description of this permission set.","type":"string"}},"required":["name"]},"Object418":{"type":"object","properties":{"name":{"description":"The name of this permission set.","type":"string"},"description":{"description":"A description of this permission set.","type":"string"}}},"Object419":{"type":"object","properties":{"userIds":{"description":"An array of one or more user IDs.","type":"array","items":{"type":"integer"}},"permissionLevel":{"description":"Options are: \"read\", \"write\", or \"manage\".","type":"string"},"shareEmailBody":{"description":"Custom body text for e-mail sent on a share.","type":"string"},"sendSharedEmail":{"description":"Send email to the recipients of a share.","type":"boolean"}},"required":["userIds","permissionLevel"]},"Object420":{"type":"object","properties":{"groupIds":{"description":"An array of one or more group IDs.","type":"array","items":{"type":"integer"}},"permissionLevel":{"description":"Options are: \"read\", \"write\", or \"manage\".","type":"string"},"shareEmailBody":{"description":"Custom body text for e-mail sent on a share.","type":"string"},"sendSharedEmail":{"description":"Send email to the recipients of a share.","type":"boolean"}},"required":["groupIds","permissionLevel"]},"Object421":{"type":"object","properties":{"userId":{"description":"ID of target user","type":"integer"},"includeDependencies":{"description":"Whether or not to give manage permissions on all dependencies","type":"boolean"},"emailBody":{"description":"Custom body text for e-mail sent on transfer.","type":"string"},"sendEmail":{"description":"Send email to the target user of the transfer?","type":"boolean"}},"required":["userId","includeDependencies"]},"Object422":{"type":"object","properties":{"status":{"description":"The desired archived status of the object.","type":"boolean"}},"required":["status"]},"Object423":{"type":"object","properties":{"resourceName":{"description":"The name of the resource.","type":"string"},"read":{"description":"If true, the user has read permission on this resource.","type":"boolean"},"write":{"description":"If true, the user has write permission on this resource.","type":"boolean"},"manage":{"description":"If true, the user has manage permission on this resource.","type":"boolean"}}},"Object424":{"type":"object","properties":{"permissionSetId":{"description":"The ID for the permission set this resource belongs to.","type":"integer"},"name":{"description":"The name of this resource.","type":"string"},"description":{"description":"A description of this resource.","type":"string"},"createdAt":{"type":"string","format":"time"},"updatedAt":{"type":"string","format":"time"}}},"Object425":{"type":"object","properties":{"name":{"description":"The name of this resource.","type":"string"},"description":{"description":"A description of this resource.","type":"string"}},"required":["name"]},"Object426":{"type":"object","properties":{"description":{"description":"A description of this resource.","type":"string"}}},"Object427":{"type":"object","properties":{"userIds":{"description":"An array of one or more user IDs.","type":"array","items":{"type":"integer"}},"permissionLevel":{"description":"Options are: \"read\", \"write\", or \"manage\".","type":"string"},"shareEmailBody":{"description":"Custom body text for e-mail sent on a share.","type":"string"},"sendSharedEmail":{"description":"Send email to the recipients of a share.","type":"boolean"}},"required":["userIds","permissionLevel"]},"Object428":{"type":"object","properties":{"groupIds":{"description":"An array of one or more group IDs.","type":"array","items":{"type":"integer"}},"permissionLevel":{"description":"Options are: \"read\", \"write\", or \"manage\".","type":"string"},"shareEmailBody":{"description":"Custom body text for e-mail sent on a share.","type":"string"},"sendSharedEmail":{"description":"Send email to the recipients of a share.","type":"boolean"}},"required":["groupIds","permissionLevel"]},"Object429":{"type":"object","properties":{"id":{"description":"The ID of the prediction.","type":"integer"},"modelId":{"description":"The ID of the model used for this prediction.","type":"integer"},"scoredTableId":{"description":"The ID of the source table for this prediction.","type":"integer"},"scoredTableName":{"description":"The name of the source table for this prediction.","type":"string"},"outputTableName":{"description":"The name of the output table for this prediction.","type":"string"},"state":{"description":"The state of the last run of this prediction.","type":"string"},"error":{"description":"The error, if any, of the last run of this prediction.","type":"string"},"startedAt":{"description":"The start time of the last run of this prediction.","type":"string","format":"date-time"},"finishedAt":{"description":"The end time of the last run of this prediction.","type":"string","format":"date-time"},"lastRun":{"description":"The last run of this prediction.","$ref":"#/definitions/Object74"}}},"Object432":{"type":"object","properties":{"scoreName":{"description":"The name of the score.","type":"string"},"histogram":{"description":"The histogram of the distribution of scores.","type":"array","items":{"type":"integer"}},"avgScore":{"description":"The average score.","type":"number","format":"float"},"minScore":{"description":"The minimum score.","type":"number","format":"float"},"maxScore":{"description":"The maximum score.","type":"number","format":"float"}}},"Object431":{"type":"object","properties":{"id":{"description":"The ID of the table with created predictions.","type":"integer"},"schema":{"description":"The schema of table with created predictions.","type":"string"},"name":{"description":"The name of table with created predictions.","type":"string"},"createdAt":{"description":"The time when the table with created predictions was created.","type":"string","format":"date-time"},"scoreStats":{"description":"An array of metrics on the created predictions.","type":"array","items":{"$ref":"#/definitions/Object432"}}}},"Object430":{"type":"object","properties":{"id":{"description":"The ID of the prediction.","type":"integer"},"modelId":{"description":"The ID of the model used for this prediction.","type":"integer"},"scoredTableId":{"description":"The ID of the source table for this prediction.","type":"integer"},"scoredTableName":{"description":"The name of the source table for this prediction.","type":"string"},"outputTableName":{"description":"The name of the output table for this prediction.","type":"string"},"state":{"description":"The state of the last run of this prediction.","type":"string"},"error":{"description":"The error, if any, of the last run of this prediction.","type":"string"},"startedAt":{"description":"The start time of the last run of this prediction.","type":"string","format":"date-time"},"finishedAt":{"description":"The end time of the last run of this prediction.","type":"string","format":"date-time"},"lastRun":{"description":"The last run of this prediction.","$ref":"#/definitions/Object74"},"scoredTables":{"description":"An array of created prediction tables.","type":"array","items":{"$ref":"#/definitions/Object431"}},"schedule":{"description":"The schedule when the prediction will be built.","$ref":"#/definitions/Object106"},"limitingSQL":{"description":"A SQL WHERE clause used to scope the rows to be predicted.","type":"string"},"primaryKey":{"description":"The primary key or composite keys of the table being predicted.","type":"array","items":{"type":"string"}}}},"Object433":{"type":"object","properties":{"id":{"description":"ID of the prediction associated with this schedule.","type":"integer"},"schedule":{"description":"Schedule when the prediction will run.","$ref":"#/definitions/Object106"},"scoreOnModelBuild":{"description":"Whether the prediction will run after a rebuild of the associated model.","type":"boolean"}}},"Object434":{"type":"object","properties":{"name":{"description":"The name of this project.","type":"string"},"description":{"description":"A description of the project.","type":"string"},"note":{"description":"Notes for the project.","type":"string"},"autoShare":{"description":"If true, objects within the project will be automatically shared when the project is shared or objects are added.","type":"boolean"},"hidden":{"description":"The hidden status of the item.","type":"boolean"}},"required":["name","description"]},"Object436":{"type":"object","properties":{"schema":{"type":"string"},"name":{"type":"string"},"rowCount":{"type":"integer"},"columnCount":{"type":"integer"},"createdAt":{"type":"string","format":"time"},"updatedAt":{"type":"string","format":"time"}}},"Object437":{"type":"object","properties":{"id":{"description":"The item's ID.","type":"integer"},"createdAt":{"type":"string","format":"time"},"updatedAt":{"type":"string","format":"time"}}},"Object439":{"type":"object","properties":{"state":{"type":"string"},"updatedAt":{"type":"string","format":"time"}}},"Object438":{"type":"object","properties":{"id":{"description":"The item's ID.","type":"integer"},"createdAt":{"type":"string","format":"time"},"updatedAt":{"type":"string","format":"time"},"name":{"type":"string"},"type":{"type":"string"},"finishedAt":{"type":"string","format":"time"},"state":{"type":"string"},"lastRun":{"$ref":"#/definitions/Object439"}}},"Object440":{"type":"object","properties":{"id":{"description":"The item's ID.","type":"integer"},"createdAt":{"type":"string","format":"time"},"updatedAt":{"type":"string","format":"time"},"name":{"type":"string"},"type":{"type":"string"},"finishedAt":{"type":"string","format":"time"},"state":{"type":"string"},"lastRun":{"$ref":"#/definitions/Object439"}}},"Object441":{"type":"object","properties":{"id":{"description":"The item's ID.","type":"integer"},"createdAt":{"type":"string","format":"time"},"updatedAt":{"type":"string","format":"time"},"name":{"type":"string"},"state":{"type":"string"}}},"Object442":{"type":"object","properties":{"id":{"description":"The item's ID.","type":"integer"},"createdAt":{"type":"string","format":"time"},"updatedAt":{"type":"string","format":"time"},"name":{"type":"string"},"currentDeploymentId":{"type":"integer"},"lastDeploy":{"$ref":"#/definitions/Object439"}}},"Object443":{"type":"object","properties":{"id":{"description":"The item's ID.","type":"integer"},"createdAt":{"type":"string","format":"time"},"updatedAt":{"type":"string","format":"time"},"name":{"type":"string"},"currentDeploymentId":{"type":"integer"},"lastDeploy":{"$ref":"#/definitions/Object439"}}},"Object444":{"type":"object","properties":{"id":{"description":"The item's ID.","type":"integer"},"createdAt":{"type":"string","format":"time"},"updatedAt":{"type":"string","format":"time"},"name":{"type":"string"},"state":{"type":"string"},"lastExecution":{"$ref":"#/definitions/Object439"}}},"Object445":{"type":"object","properties":{"id":{"description":"The item's ID.","type":"integer"},"createdAt":{"type":"string","format":"time"},"updatedAt":{"type":"string","format":"time"},"name":{"type":"string"},"state":{"type":"string"}}},"Object446":{"type":"object","properties":{"id":{"description":"The item's ID.","type":"integer"},"createdAt":{"type":"string","format":"time"},"updatedAt":{"type":"string","format":"time"},"name":{"type":"string"}}},"Object447":{"type":"object","properties":{"id":{"description":"The item's ID.","type":"integer"},"createdAt":{"type":"string","format":"time"},"updatedAt":{"type":"string","format":"time"},"fileName":{"type":"string"},"fileSize":{"type":"integer"},"expired":{"type":"boolean"}}},"Object448":{"type":"object","properties":{"id":{"description":"The item's ID.","type":"integer"},"createdAt":{"type":"string","format":"time"},"updatedAt":{"type":"string","format":"time"},"name":{"type":"string"},"lastRun":{"$ref":"#/definitions/Object439"}}},"Object449":{"type":"object","properties":{"id":{"description":"The item's ID.","type":"integer"},"createdAt":{"type":"string","format":"time"},"updatedAt":{"type":"string","format":"time"},"name":{"type":"string"},"description":{"type":"string"}}},"Object450":{"type":"object","properties":{"projectId":{"type":"integer"},"objectId":{"type":"integer"},"objectType":{"type":"string"},"fcoType":{"type":"string"},"subType":{"type":"string"},"name":{"type":"string"},"icon":{"type":"string"},"author":{"type":"string"},"updatedAt":{"type":"string","format":"time"},"autoShare":{"type":"boolean"},"archived":{"description":"The archival status of the requested item(s).","type":"string"},"hidden":{"description":"The hidden status of the item.","type":"boolean"},"myPermissionLevel":{"description":"Your permission level on the object. One of \"read\", \"write\", or \"manage\".","type":"string"}}},"Object451":{"type":"object","properties":{"id":{"description":"The parent project's ID.","type":"integer"},"name":{"description":"The parent project's name.","type":"integer"}}},"Object435":{"type":"object","properties":{"id":{"description":"The ID for this project.","type":"integer"},"author":{"description":"The author/owner of the item.","$ref":"#/definitions/Object33"},"name":{"description":"The name of this project.","type":"string"},"description":{"description":"A description of the project.","type":"string"},"users":{"description":"Users who can see the project.","type":"array","items":{"$ref":"#/definitions/Object33"}},"autoShare":{"type":"boolean"},"createdAt":{"type":"string","format":"time"},"updatedAt":{"type":"string","format":"time"},"tables":{"type":"array","items":{"$ref":"#/definitions/Object436"}},"surveys":{"type":"array","items":{"$ref":"#/definitions/Object437"}},"scripts":{"type":"array","items":{"$ref":"#/definitions/Object438"}},"imports":{"type":"array","items":{"$ref":"#/definitions/Object440"}},"exports":{"type":"array","items":{"$ref":"#/definitions/Object440"}},"models":{"type":"array","items":{"$ref":"#/definitions/Object441"}},"notebooks":{"type":"array","items":{"$ref":"#/definitions/Object442"}},"services":{"type":"array","items":{"$ref":"#/definitions/Object443"}},"workflows":{"type":"array","items":{"$ref":"#/definitions/Object444"}},"reports":{"type":"array","items":{"$ref":"#/definitions/Object445"}},"scriptTemplates":{"type":"array","items":{"$ref":"#/definitions/Object446"}},"files":{"type":"array","items":{"$ref":"#/definitions/Object447"}},"enhancements":{"type":"array","items":{"$ref":"#/definitions/Object448"}},"projects":{"type":"array","items":{"$ref":"#/definitions/Object449"}},"allObjects":{"type":"array","items":{"$ref":"#/definitions/Object450"}},"note":{"type":"string"},"canCurrentUserEnableAutoShare":{"description":"A flag for if the current user can enable auto-sharing mode for this project.","type":"boolean"},"hidden":{"description":"The hidden status of the item.","type":"boolean"},"archived":{"description":"The archival status of the requested item(s).","type":"string"},"parentProject":{"description":"The project that this project is a part of, if any. To add a project to another project, use the PUT /projects/:id/parent_projects endpoint","$ref":"#/definitions/Object451"},"myPermissionLevel":{"description":"Your permission level on the object. One of \"read\", \"write\", or \"manage\".","type":"string"}}},"Object452":{"type":"object","properties":{"cloneSchedule":{"description":"If true, also copy the schedule for all applicable project objects.","type":"boolean"},"cloneNotifications":{"description":"If true, also copy the notifications for all applicable project objects.","type":"boolean"}}},"Object453":{"type":"object","properties":{"name":{"description":"The name of this project.","type":"string"},"description":{"description":"A description of the project.","type":"string"},"note":{"description":"Notes for the project.","type":"string"}}},"Object454":{"type":"object","properties":{"autoShare":{"description":"A toggle for sharing the objects within the project when the project is shared or objects are added.","type":"boolean"}},"required":["autoShare"]},"Object455":{"type":"object","properties":{"userIds":{"description":"An array of one or more user IDs.","type":"array","items":{"type":"integer"}},"permissionLevel":{"description":"Options are: \"read\", \"write\", or \"manage\".","type":"string"},"shareEmailBody":{"description":"Custom body text for e-mail sent on a share.","type":"string"},"sendSharedEmail":{"description":"Send email to the recipients of a share.","type":"boolean"}},"required":["userIds","permissionLevel"]},"Object456":{"type":"object","properties":{"groupIds":{"description":"An array of one or more group IDs.","type":"array","items":{"type":"integer"}},"permissionLevel":{"description":"Options are: \"read\", \"write\", or \"manage\".","type":"string"},"shareEmailBody":{"description":"Custom body text for e-mail sent on a share.","type":"string"},"sendSharedEmail":{"description":"Send email to the recipients of a share.","type":"boolean"}},"required":["groupIds","permissionLevel"]},"Object457":{"type":"object","properties":{"userId":{"description":"ID of target user","type":"integer"},"includeDependencies":{"description":"Whether or not to give manage permissions on all dependencies","type":"boolean"},"emailBody":{"description":"Custom body text for e-mail sent on transfer.","type":"string"},"sendEmail":{"description":"Send email to the target user of the transfer?","type":"boolean"}},"required":["userId","includeDependencies"]},"Object458":{"type":"object","properties":{"status":{"description":"The desired archived status of the object.","type":"boolean"}},"required":["status"]},"Object459":{"type":"object","properties":{"id":{"description":"The query ID.","type":"integer"},"database":{"description":"The database ID.","type":"integer"},"sql":{"description":"The SQL to execute.","type":"string"},"credential":{"description":"The credential ID.","type":"integer"},"resultRows":{"description":"A preview of rows returned by the query.","type":"array","items":{"type":"array","items":{"type":"string"}}},"resultColumns":{"description":"A preview of columns returned by the query.","type":"array","items":{"type":"string"}},"error":{"description":"The error message for this run, if present.","type":"string"},"startedAt":{"description":"The start time of the last run.","type":"string","format":"date-time"},"finishedAt":{"description":"The end time of the last run.","type":"string","format":"date-time"},"state":{"description":"The state of the last run. One of queued, running, succeeded, failed, and cancelled.","type":"string"},"scriptId":{"description":"The ID of the script associated with this query.","type":"integer"},"exception":{"description":"Deprecated and not used.","type":"string"},"createdAt":{"type":"string","format":"time"},"updatedAt":{"type":"string","format":"time"},"lastRunId":{"description":"The ID of the last run.","type":"integer"},"archived":{"description":"The archival status of the requested item(s).","type":"string"},"previewRows":{"description":"The number of rows to save from the query's result (maximum: 1000).","type":"integer"},"reportId":{"description":"The ID of the report associated with this query.","type":"integer"}}},"Object460":{"type":"object","properties":{"id":{"description":"The ID of the run.","type":"integer"},"queryId":{"description":"The ID of the Query job.","type":"integer"},"state":{"description":"The state of the run, one of 'queued' 'running' 'succeeded' 'failed' or 'cancelled'.","type":"string"},"isCancelRequested":{"description":"True if run cancel requested, else false.","type":"boolean"},"createdAt":{"description":"The time the run was created.","type":"string","format":"time"},"startedAt":{"description":"The time the run started at.","type":"string","format":"time"},"finishedAt":{"description":"The time the run completed.","type":"string","format":"time"},"error":{"description":"The error, if any, returned by the run.","type":"string"}}},"Object461":{"type":"object","properties":{"database":{"description":"The database ID.","type":"integer"},"sql":{"description":"The SQL to execute.","type":"string"},"credential":{"description":"The credential ID.","type":"integer"},"hidden":{"description":"The hidden status of the item.","type":"boolean"},"interactive":{"description":"Deprecated and not used.","type":"boolean"},"previewRows":{"description":"The number of rows to save from the query's result (maximum: 1000).","type":"integer"},"includeHeader":{"description":"Whether the CSV output should include a header row [default: true].","type":"boolean"},"compression":{"description":"The type of compression. One of gzip or zip, or none [default: gzip].","type":"string"},"columnDelimiter":{"description":"The delimiter to use. One of comma or tab, or pipe [default: comma].","type":"string"},"unquoted":{"description":"If true, will not quote fields.","type":"boolean"},"filenamePrefix":{"description":"The output filename prefix.","type":"string"}},"required":["database","sql","previewRows"]},"Object462":{"type":"object","properties":{"id":{"description":"The query ID.","type":"integer"},"database":{"description":"The database ID.","type":"integer"},"sql":{"description":"The SQL to execute.","type":"string"},"credential":{"description":"The credential ID.","type":"integer"},"resultRows":{"description":"A preview of rows returned by the query.","type":"array","items":{"type":"array","items":{"type":"string"}}},"resultColumns":{"description":"A preview of columns returned by the query.","type":"array","items":{"type":"string"}},"error":{"description":"The error message for this run, if present.","type":"string"},"startedAt":{"description":"The start time of the last run.","type":"string","format":"date-time"},"finishedAt":{"description":"The end time of the last run.","type":"string","format":"date-time"},"state":{"description":"The state of the last run. One of queued, running, succeeded, failed, and cancelled.","type":"string"},"scriptId":{"description":"The ID of the script associated with this query.","type":"integer"},"exception":{"description":"Deprecated and not used.","type":"string"},"createdAt":{"type":"string","format":"time"},"updatedAt":{"type":"string","format":"time"},"lastRunId":{"description":"The ID of the last run.","type":"integer"},"hidden":{"description":"The hidden status of the item.","type":"boolean"},"archived":{"description":"The archival status of the requested item(s).","type":"string"},"myPermissionLevel":{"description":"Your permission level on the object. One of \"read\", \"write\", or \"manage\".","type":"string"},"interactive":{"description":"Deprecated and not used.","type":"boolean"},"previewRows":{"description":"The number of rows to save from the query's result (maximum: 1000).","type":"integer"},"includeHeader":{"description":"Whether the CSV output should include a header row [default: true].","type":"boolean"},"compression":{"description":"The type of compression. One of gzip or zip, or none [default: gzip].","type":"string"},"columnDelimiter":{"description":"The delimiter to use. One of comma or tab, or pipe [default: comma].","type":"string"},"unquoted":{"description":"If true, will not quote fields.","type":"boolean"},"filenamePrefix":{"description":"The output filename prefix.","type":"string"},"reportId":{"description":"The ID of the report associated with this query.","type":"integer"}}},"Object463":{"type":"object","properties":{"id":{"description":"The query ID.","type":"integer"},"database":{"description":"The database ID.","type":"integer"},"sql":{"description":"The SQL to execute.","type":"string"},"credential":{"description":"The credential ID.","type":"integer"},"resultRows":{"description":"A preview of rows returned by the query.","type":"array","items":{"type":"array","items":{"type":"string"}}},"resultColumns":{"description":"A preview of columns returned by the query.","type":"array","items":{"type":"string"}},"error":{"description":"The error message for this run, if present.","type":"string"},"startedAt":{"description":"The start time of the last run.","type":"string","format":"date-time"},"finishedAt":{"description":"The end time of the last run.","type":"string","format":"date-time"},"state":{"description":"The state of the last run. One of queued, running, succeeded, failed, and cancelled.","type":"string"},"scriptId":{"description":"The ID of the script associated with this query.","type":"integer"},"exception":{"description":"Deprecated and not used.","type":"string"},"createdAt":{"type":"string","format":"time"},"updatedAt":{"type":"string","format":"time"},"lastRunId":{"description":"The ID of the last run.","type":"integer"},"hidden":{"description":"The hidden status of the item.","type":"boolean"},"archived":{"description":"The archival status of the requested item(s).","type":"string"},"name":{"description":"The name of the query.","type":"string"},"author":{"description":"The author/owner of the item.","$ref":"#/definitions/Object33"},"reportId":{"description":"The ID of the report associated with this query.","type":"integer"}}},"Object464":{"type":"object","properties":{"id":{"description":"The ID of the remote host.","type":"integer"},"name":{"description":"The human readable name for the remote host.","type":"string"},"type":{"description":"The type of remote host. One of: RemoteHostTypes::Bigquery, RemoteHostTypes::Bitbucket, RemoteHostTypes::GitSSH, RemoteHostTypes::Github, RemoteHostTypes::GoogleDoc, RemoteHostTypes::JDBC, RemoteHostTypes::Postgres, RemoteHostTypes::Redshift, RemoteHostTypes::S3Storage, and RemoteHostTypes::Salesforce","type":"string"},"url":{"description":"The URL for the remote host.","type":"string"}}},"Object465":{"type":"object","properties":{"name":{"description":"The human readable name for the remote host.","type":"string"},"url":{"description":"The URL for the remote host.","type":"string"},"type":{"description":"The type of remote host. One of: RemoteHostTypes::Bigquery, RemoteHostTypes::Bitbucket, RemoteHostTypes::GitSSH, RemoteHostTypes::Github, RemoteHostTypes::GoogleDoc, RemoteHostTypes::JDBC, RemoteHostTypes::Postgres, RemoteHostTypes::Redshift, RemoteHostTypes::S3Storage, and RemoteHostTypes::Salesforce","type":"string"}},"required":["name","url","type"]},"Object466":{"type":"object","properties":{"id":{"description":"The ID of the remote host.","type":"integer"},"name":{"description":"The human readable name for the remote host.","type":"string"},"type":{"description":"The type of remote host. One of: RemoteHostTypes::Bigquery, RemoteHostTypes::Bitbucket, RemoteHostTypes::GitSSH, RemoteHostTypes::Github, RemoteHostTypes::GoogleDoc, RemoteHostTypes::JDBC, RemoteHostTypes::Postgres, RemoteHostTypes::Redshift, RemoteHostTypes::S3Storage, and RemoteHostTypes::Salesforce","type":"string"},"url":{"description":"The URL for the remote host.","type":"string"},"description":{"description":"The description of the remote host.","type":"string"},"myPermissionLevel":{"description":"Your permission level on the object. One of \"read\", \"write\", or \"manage\".","type":"string"},"user":{"description":"The owner of the remote host.","$ref":"#/definitions/Object33"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}}},"Object467":{"type":"object","properties":{"name":{"description":"The human readable name for the remote host.","type":"string"},"type":{"description":"The type of remote host. One of: RemoteHostTypes::Bigquery, RemoteHostTypes::Bitbucket, RemoteHostTypes::GitSSH, RemoteHostTypes::Github, RemoteHostTypes::GoogleDoc, RemoteHostTypes::JDBC, RemoteHostTypes::Postgres, RemoteHostTypes::Redshift, RemoteHostTypes::S3Storage, and RemoteHostTypes::Salesforce","type":"string"},"url":{"description":"The URL for the remote host.","type":"string"},"description":{"description":"The description of the remote host.","type":"string"}},"required":["name","type","url","description"]},"Object468":{"type":"object","properties":{"name":{"description":"The human readable name for the remote host.","type":"string"},"type":{"description":"The type of remote host. One of: RemoteHostTypes::Bigquery, RemoteHostTypes::Bitbucket, RemoteHostTypes::GitSSH, RemoteHostTypes::Github, RemoteHostTypes::GoogleDoc, RemoteHostTypes::JDBC, RemoteHostTypes::Postgres, RemoteHostTypes::Redshift, RemoteHostTypes::S3Storage, and RemoteHostTypes::Salesforce","type":"string"},"url":{"description":"The URL for the remote host.","type":"string"},"description":{"description":"The description of the remote host.","type":"string"}}},"Object469":{"type":"object","properties":{"userIds":{"description":"An array of one or more user IDs.","type":"array","items":{"type":"integer"}},"permissionLevel":{"description":"Options are: \"read\", \"write\", or \"manage\".","type":"string"},"shareEmailBody":{"description":"Custom body text for e-mail sent on a share.","type":"string"},"sendSharedEmail":{"description":"Send email to the recipients of a share.","type":"boolean"}},"required":["userIds","permissionLevel"]},"Object470":{"type":"object","properties":{"groupIds":{"description":"An array of one or more group IDs.","type":"array","items":{"type":"integer"}},"permissionLevel":{"description":"Options are: \"read\", \"write\", or \"manage\".","type":"string"},"shareEmailBody":{"description":"Custom body text for e-mail sent on a share.","type":"string"},"sendSharedEmail":{"description":"Send email to the recipients of a share.","type":"boolean"}},"required":["groupIds","permissionLevel"]},"Object471":{"type":"object","properties":{"credentialId":{"description":"The credential ID.","type":"integer"},"username":{"description":"The user name for remote host.","type":"string"},"password":{"description":"The password for remote host.","type":"string"}}},"Object472":{"type":"object","properties":{"name":{"description":"The path to a data_set.","type":"string"},"fullPath":{"description":"Boolean that indicates whether further querying needs to be done before the table can be selected.","type":"boolean"}}},"Object474":{"type":"object","properties":{"id":{"description":"The ID for the project.","type":"integer"},"name":{"description":"The name of the project.","type":"string"}}},"Object475":{"type":"object","properties":{"id":{"description":"The ID for the script.","type":"integer"},"name":{"description":"The name of the script.","type":"string"},"sql":{"description":"The raw SQL query for the script, if applicable.","type":"string"}}},"Object473":{"type":"object","properties":{"id":{"description":"The ID of this report.","type":"integer"},"name":{"description":"The name of the report.","type":"string"},"user":{"description":"The name of the author of this report.","$ref":"#/definitions/Object33"},"createdAt":{"description":"The creation time for this report.","type":"string","format":"time"},"updatedAt":{"description":"The last updated at time for this report.","type":"string","format":"time"},"type":{"description":"The type of the report. One of: ReportTypes::HTML, ReportTypes::Tableau, ReportTypes::ShinyApp, ReportTypes::SQL","type":"string"},"archived":{"description":"The archival status of the requested item(s).","type":"string"},"projects":{"description":"A list of projects containing the report.","type":"array","items":{"$ref":"#/definitions/Object474"}},"state":{"description":"The status of the report's last run.","type":"string"},"finishedAt":{"description":"The time that the report's last run finished.","type":"string","format":"time"},"vizUpdatedAt":{"description":"The time that the report's visualization was last updated.","type":"string","format":"time"},"script":{"description":"The ID, name, and raw SQL of the job (a script or a query) that backs this report.","$ref":"#/definitions/Object475"},"jobPath":{"description":"The link to details of the job that backs this report.","type":"string"},"tableauId":{"type":"integer"},"templateId":{"description":"The ID of the template used for this report.","type":"integer"},"authThumbnailUrl":{"description":"URL for a thumbnail of the report.","type":"string"},"lastRun":{"description":"The last run of the job backing this report.","$ref":"#/definitions/Object74"}}},"Object476":{"type":"object","properties":{"id":{"description":"The ID of this report.","type":"integer"},"name":{"description":"The name of the report.","type":"string"},"user":{"description":"The name of the author of this report.","$ref":"#/definitions/Object33"},"createdAt":{"description":"The creation time for this report.","type":"string","format":"time"},"updatedAt":{"description":"The last updated at time for this report.","type":"string","format":"time"},"type":{"description":"The type of the report. One of: ReportTypes::HTML, ReportTypes::Tableau, ReportTypes::ShinyApp, ReportTypes::SQL","type":"string"},"description":{"description":"The user-defined description of the report.","type":"string"},"myPermissionLevel":{"description":"Your permission level on the object. One of \"read\", \"write\", or \"manage\".","type":"string"},"archived":{"description":"The archival status of the requested item(s).","type":"string"},"projects":{"description":"A list of projects containing the report.","type":"array","items":{"$ref":"#/definitions/Object474"}},"state":{"description":"The status of the report's last run.","type":"string"},"finishedAt":{"description":"The time that the report's last run finished.","type":"string","format":"time"},"vizUpdatedAt":{"description":"The time that the report's visualization was last updated.","type":"string","format":"time"},"script":{"description":"The ID, name, and raw SQL of the job (a script or a query) that backs this report.","$ref":"#/definitions/Object475"},"jobPath":{"description":"The link to details of the job that backs this report.","type":"string"},"tableauId":{"type":"integer"},"templateId":{"description":"The ID of the template used for this report.","type":"integer"},"authThumbnailUrl":{"description":"URL for a thumbnail of the report.","type":"string"},"lastRun":{"description":"The last run of the job backing this report.","$ref":"#/definitions/Object74"},"hidden":{"description":"The hidden status of the item.","type":"boolean"},"authDataUrl":{"description":"DEPRECATED: For legacy reports","type":"string"},"authCodeUrl":{"description":"Link to code to render in the report.","type":"string"},"config":{"description":"Any configuration metadata for this report.","type":"string"},"validOutputFile":{"description":"Whether the job (a script or a query) that backs the report currently has a valid output file.","type":"boolean"},"provideAPIKey":{"description":"Whether the report requests an API Key from the report viewer.","type":"boolean"},"apiKey":{"description":"A Civis API key that can be used by this report.","type":"string"},"apiKeyId":{"description":"The ID of the API key. Can be used for auditing API use by this report.","type":"integer"},"appState":{"description":"Any application state blob for this report.","type":"object","additionalProperties":{"type":"string"}},"useViewersTableauUsername":{"description":"Apply user level filtering on Tableau reports.","type":"boolean"}}},"Object477":{"type":"object","properties":{"scriptId":{"description":"The ID of the job (a script or a query) used to create this report.","type":"integer"},"name":{"description":"The name of the report.","type":"string"},"codeBody":{"description":"The code for the report visualization.","type":"string"},"appState":{"description":"Any application state blob for this report.","type":"object","additionalProperties":{"type":"string"}},"provideAPIKey":{"description":"Allow the report to provide an API key to front-end code.","type":"boolean"},"templateId":{"description":"The ID of the template used for this report.","type":"integer"},"description":{"description":"The user-defined description of the report.","type":"string"},"hidden":{"description":"The hidden status of the item.","type":"boolean"}}},"Object478":{"type":"object","properties":{"name":{"description":"The name of the report.","type":"string"},"scriptId":{"description":"The ID of the job (a script or a query) used to create this report.","type":"integer"},"codeBody":{"description":"The code for the report visualization.","type":"string"},"config":{"type":"string"},"appState":{"description":"The application state blob for this report.","type":"object","additionalProperties":{"type":"string"}},"provideAPIKey":{"description":"Allow the report to provide an API key to front-end code.","type":"boolean"},"templateId":{"description":"The ID of the template used for this report. If null is passed, no template will back this report. Changes to the backing template will reset the report appState.","type":"integer"},"useViewersTableauUsername":{"description":"Apply user level filtering on Tableau reports.","type":"boolean"},"description":{"description":"The user-defined description of the report.","type":"string"}}},"Object479":{"type":"object","properties":{"userIds":{"description":"An array of one or more user IDs.","type":"array","items":{"type":"integer"}},"permissionLevel":{"description":"Options are: \"read\", \"write\", or \"manage\".","type":"string"},"shareEmailBody":{"description":"Custom body text for e-mail sent on a share.","type":"string"},"sendSharedEmail":{"description":"Send email to the recipients of a share.","type":"boolean"}},"required":["userIds","permissionLevel"]},"Object480":{"type":"object","properties":{"groupIds":{"description":"An array of one or more group IDs.","type":"array","items":{"type":"integer"}},"permissionLevel":{"description":"Options are: \"read\", \"write\", or \"manage\".","type":"string"},"shareEmailBody":{"description":"Custom body text for e-mail sent on a share.","type":"string"},"sendSharedEmail":{"description":"Send email to the recipients of a share.","type":"boolean"}},"required":["groupIds","permissionLevel"]},"Object481":{"type":"object","properties":{"userId":{"description":"ID of target user","type":"integer"},"includeDependencies":{"description":"Whether or not to give manage permissions on all dependencies","type":"boolean"},"emailBody":{"description":"Custom body text for e-mail sent on transfer.","type":"string"},"sendEmail":{"description":"Send email to the target user of the transfer?","type":"boolean"}},"required":["userId","includeDependencies"]},"Object482":{"type":"object","properties":{"status":{"description":"The desired archived status of the object.","type":"boolean"}},"required":["status"]},"Object483":{"type":"object","properties":{"id":{"description":"The ID of this report.","type":"integer"},"name":{"description":"The name of the report.","type":"string"},"user":{"description":"The name of the author of this report.","$ref":"#/definitions/Object33"},"createdAt":{"description":"The creation time for this report.","type":"string","format":"time"},"updatedAt":{"description":"The last updated at time for this report.","type":"string","format":"time"},"type":{"description":"The type of the report. One of: ReportTypes::HTML, ReportTypes::Tableau, ReportTypes::ShinyApp, ReportTypes::SQL","type":"string"},"description":{"description":"The user-defined description of the report.","type":"string"},"myPermissionLevel":{"description":"Your permission level on the object. One of \"read\", \"write\", or \"manage\".","type":"string"},"archived":{"description":"The archival status of the requested item(s).","type":"string"},"host":{"description":"The host for the service report","type":"string"},"displayUrl":{"description":"The URL to display the service report.","type":"string"},"serviceId":{"description":"The id of the backing service","type":"integer"},"provideAPIKey":{"description":"Whether the report requests an API Key from the report viewer.","type":"boolean"},"apiKey":{"description":"A Civis API key that can be used by this report.","type":"string"},"apiKeyId":{"description":"The ID of the API key. Can be used for auditing API use by this report.","type":"integer"}}},"Object484":{"type":"object","properties":{"serviceId":{"description":"The id of the backing service","type":"integer"},"provideAPIKey":{"description":"Whether the report requests an API Key from the report viewer.","type":"boolean"}},"required":["serviceId"]},"Object485":{"type":"object","properties":{"name":{"description":"The name of the service report.","type":"string"},"provideAPIKey":{"description":"Whether the report requests an API Key from the report viewer.","type":"boolean"}}},"Object486":{"type":"object","properties":{"userIds":{"description":"An array of one or more user IDs.","type":"array","items":{"type":"integer"}},"permissionLevel":{"description":"Options are: \"read\", \"write\", or \"manage\".","type":"string"},"shareEmailBody":{"description":"Custom body text for e-mail sent on a share.","type":"string"},"sendSharedEmail":{"description":"Send email to the recipients of a share.","type":"boolean"}},"required":["userIds","permissionLevel"]},"Object487":{"type":"object","properties":{"groupIds":{"description":"An array of one or more group IDs.","type":"array","items":{"type":"integer"}},"permissionLevel":{"description":"Options are: \"read\", \"write\", or \"manage\".","type":"string"},"shareEmailBody":{"description":"Custom body text for e-mail sent on a share.","type":"string"},"sendSharedEmail":{"description":"Send email to the recipients of a share.","type":"boolean"}},"required":["groupIds","permissionLevel"]},"Object488":{"type":"object","properties":{"userId":{"description":"ID of target user","type":"integer"},"includeDependencies":{"description":"Whether or not to give manage permissions on all dependencies","type":"boolean"},"emailBody":{"description":"Custom body text for e-mail sent on transfer.","type":"string"},"sendEmail":{"description":"Send email to the target user of the transfer?","type":"boolean"}},"required":["userId","includeDependencies"]},"Object489":{"type":"object","properties":{"status":{"description":"The desired archived status of the object.","type":"boolean"}},"required":["status"]},"Object491":{"type":"object","properties":{"id":{"description":"The ID of this organization.","type":"integer"},"tableauRefreshUsage":{"description":"The number of tableau refreshes used this month.","type":"integer"},"tableauRefreshLimit":{"description":"The number of monthly tableau refreshes permitted to this organization.","type":"integer"},"tableauRefreshHistory":{"description":"The number of tableau refreshes used this month.","type":"array","items":{"type":"object"}}}},"Object490":{"type":"object","properties":{"id":{"description":"The ID of this report.","type":"integer"},"organization":{"description":"Details for the organization of the user who owns this report","$ref":"#/definitions/Object491"}}},"Object492":{"type":"object","properties":{"queryId":{"description":"The ID of the query used to create this report.","type":"integer"},"name":{"description":"The name of the report.","type":"string"},"config":{"description":"The configuration of the report visualization.","type":"string"},"description":{"description":"The user-defined description of the report.","type":"string"}},"required":["queryId","name","config"]},"Object494":{"type":"object","properties":{"id":{"description":"The query ID.","type":"integer"},"database":{"description":"The database ID.","type":"integer"},"sql":{"description":"The SQL to execute.","type":"string"},"credential":{"description":"The credential ID.","type":"integer"},"resultRows":{"description":"A preview of rows returned by the query.","type":"array","items":{"type":"array","items":{"type":"string"}}},"resultColumns":{"description":"A preview of columns returned by the query.","type":"array","items":{"type":"string"}},"error":{"description":"The error message for this run, if present.","type":"string"},"startedAt":{"description":"The start time of the last run.","type":"string","format":"date-time"},"finishedAt":{"description":"The end time of the last run.","type":"string","format":"date-time"},"state":{"description":"The state of the last run. One of queued, running, succeeded, failed, and cancelled.","type":"string"},"runningAs":{"description":"The user this query will run as.","$ref":"#/definitions/Object33"}}},"Object493":{"type":"object","properties":{"id":{"description":"The ID of this report.","type":"integer"},"name":{"description":"The name of the report.","type":"string"},"user":{"description":"The name of the author of this report.","$ref":"#/definitions/Object33"},"createdAt":{"description":"The creation time for this report.","type":"string","format":"time"},"updatedAt":{"description":"The last updated at time for this report.","type":"string","format":"time"},"type":{"description":"The type of the report. One of: ReportTypes::HTML, ReportTypes::Tableau, ReportTypes::ShinyApp, ReportTypes::SQL","type":"string"},"description":{"description":"The user-defined description of the report.","type":"string"},"myPermissionLevel":{"description":"Your permission level on the object. One of \"read\", \"write\", or \"manage\".","type":"string"},"archived":{"description":"The archival status of the requested item(s).","type":"string"},"config":{"description":"The configuration of the report visualization.","type":"string"},"query":{"description":"The current query associated with this report.","$ref":"#/definitions/Object494"}}},"Object495":{"type":"object","properties":{"queryId":{"description":"The ID of the query used to create this report.","type":"integer"},"name":{"description":"The name of the report.","type":"string"},"config":{"description":"The configuration of the report visualization.","type":"string"},"description":{"description":"The user-defined description of the report.","type":"string"}}},"Object496":{"type":"object","properties":{"userIds":{"description":"An array of one or more user IDs.","type":"array","items":{"type":"integer"}},"permissionLevel":{"description":"Options are: \"read\", \"write\", or \"manage\".","type":"string"},"shareEmailBody":{"description":"Custom body text for e-mail sent on a share.","type":"string"},"sendSharedEmail":{"description":"Send email to the recipients of a share.","type":"boolean"}},"required":["userIds","permissionLevel"]},"Object497":{"type":"object","properties":{"groupIds":{"description":"An array of one or more group IDs.","type":"array","items":{"type":"integer"}},"permissionLevel":{"description":"Options are: \"read\", \"write\", or \"manage\".","type":"string"},"shareEmailBody":{"description":"Custom body text for e-mail sent on a share.","type":"string"},"sendSharedEmail":{"description":"Send email to the recipients of a share.","type":"boolean"}},"required":["groupIds","permissionLevel"]},"Object498":{"type":"object","properties":{"userId":{"description":"ID of target user","type":"integer"},"includeDependencies":{"description":"Whether or not to give manage permissions on all dependencies","type":"boolean"},"emailBody":{"description":"Custom body text for e-mail sent on transfer.","type":"string"},"sendEmail":{"description":"Send email to the target user of the transfer?","type":"boolean"}},"required":["userId","includeDependencies"]},"Object499":{"type":"object","properties":{"status":{"description":"The desired archived status of the object.","type":"boolean"}},"required":["status"]},"Object500":{"type":"object","properties":{"id":{"description":"ID of the Role.","type":"integer"},"name":{"description":"The name of the Role.","type":"string"},"slug":{"description":"The slug.","type":"string"},"description":{"description":"The description of the Role.","type":"string"}}},"Object519":{"type":"object","properties":{"name":{"description":"The name of the type.","type":"string"}}},"Object521":{"type":"object","properties":{"outputName":{"description":"The name of the output file.","type":"string"},"fileId":{"description":"The unique ID of the output file.","type":"integer"},"path":{"description":"The temporary link to download this output file, valid for 36 hours.","type":"string"}}},"Object520":{"type":"object","properties":{"id":{"description":"The ID of this run.","type":"integer"},"sqlId":{"description":"The ID of this sql.","type":"integer"},"state":{"description":"The state of this run.","type":"string"},"isCancelRequested":{"description":"True if run cancel requested, else false.","type":"boolean"},"finishedAt":{"description":"The time that this run finished.","type":"string","format":"time"},"error":{"description":"The error message for this run, if present.","type":"string"},"output":{"description":"A list of the outputs of this script.","type":"array","items":{"$ref":"#/definitions/Object521"}}}},"Object523":{"type":"object","properties":{"name":{"description":"The variable's name as used within your code.","type":"string"},"label":{"description":"The label to present to users when asking them for the value.","type":"string"},"description":{"description":"A short sentence or fragment describing this parameter to the end user.","type":"string"},"type":{"description":"The type of parameter. Valid options: string, multi_line_string, integer, float, bool, file, table, database, credential_aws, credential_redshift, or credential_custom","type":"string"},"required":{"description":"Whether this param is required.","type":"boolean"},"value":{"description":"The value you would like to set this param to. Setting this value makes this parameter a fixed param.","type":"string"},"default":{"description":"If an argument for this parameter is not defined, it will use this default value. Use true, True, t, y, yes, or 1 for true bool's or false, False, f, n, no, or 0 for false bool's. Cannot be used for parameters that are required or a credential type.","type":"string"},"allowedValues":{"description":"The possible values this parameter can take, effectively making this an enumerable parameter. Allowed values is an array of hashes of the following format: `{label: 'Import', 'value': 'import'}`","type":"array","items":{"type":"object"}}},"required":["name","type"]},"Object522":{"type":"object","properties":{"name":{"description":"The name of the script.","type":"string"},"remoteHostId":{"description":"The database ID.","type":"integer"},"credentialId":{"description":"The credential ID.","type":"integer"},"sql":{"description":"The raw SQL query for the script.","type":"string"},"params":{"description":"A definition of the parameters this script accepts in the arguments field. Cannot be set if this script uses a template script.","type":"array","items":{"$ref":"#/definitions/Object523"}},"arguments":{"description":"Parameter-value pairs to use when running this script. Only settable if this script has defined parameters.","type":"object"},"templateScriptId":{"description":"The ID of the template script, if any. A script cannot both have a template script and be a template for other scripts.","type":"integer"},"notifications":{"description":"The notifications to send after the script is run.","$ref":"#/definitions/Object102"},"hidden":{"description":"The hidden status of the item.","type":"boolean"}},"required":["name","remoteHostId","credentialId","sql"]},"Object525":{"type":"object","properties":{"id":{"description":"The ID for the project.","type":"integer"},"name":{"description":"The name of the project.","type":"string"}}},"Object526":{"type":"object","properties":{"name":{"description":"The variable's name as used within your code.","type":"string"},"label":{"description":"The label to present to users when asking them for the value.","type":"string"},"description":{"description":"A short sentence or fragment describing this parameter to the end user.","type":"string"},"type":{"description":"The type of parameter. Valid options: string, multi_line_string, integer, float, bool, file, table, database, credential_aws, credential_redshift, or credential_custom","type":"string"},"required":{"description":"Whether this param is required.","type":"boolean"},"value":{"description":"The value you would like to set this param to. Setting this value makes this parameter a fixed param.","type":"string"},"default":{"description":"If an argument for this parameter is not defined, it will use this default value. Use true, True, t, y, yes, or 1 for true bool's or false, False, f, n, no, or 0 for false bool's. Cannot be used for parameters that are required or a credential type.","type":"string"},"allowedValues":{"description":"The possible values this parameter can take, effectively making this an enumerable parameter. Allowed values is an array of hashes of the following format: `{label: 'Import', 'value': 'import'}`","type":"array","items":{"type":"object"}}}},"Object527":{"type":"object","properties":{"details":{"description":"The details link to get more information about the script.","type":"string"},"runs":{"description":"The runs link to get the run information list for this script.","type":"string"}}},"Object524":{"type":"object","properties":{"id":{"description":"The ID for the script.","type":"integer"},"name":{"description":"The name of the script.","type":"string"},"type":{"description":"The type of the script (e.g SQL, Container, Python, R, JavaScript, dbt)","type":"string"},"createdAt":{"description":"The time this script was created.","type":"string","format":"time"},"updatedAt":{"description":"The time the script was last updated.","type":"string","format":"time"},"author":{"description":"The author/owner of the item.","$ref":"#/definitions/Object33"},"state":{"description":"The status of the script's last run.","type":"string"},"finishedAt":{"description":"The time that the script's last run finished.","type":"string","format":"time"},"category":{"description":"The category of the script.","type":"string"},"projects":{"description":"A list of projects containing the script.","type":"array","items":{"$ref":"#/definitions/Object525"}},"parentId":{"description":"The ID of the parent job that will trigger this script","type":"integer"},"userContext":{"description":"\"runner\" or \"author\", who to execute the script as when run as a template.","type":"string"},"params":{"description":"A definition of the parameters this script accepts in the arguments field.","type":"array","items":{"$ref":"#/definitions/Object526"}},"arguments":{"description":"Parameter-value pairs to use when running this script. Only settable if this script has defined parameters.","type":"object"},"isTemplate":{"description":"Whether others scripts use this one as a template.","type":"boolean"},"publishedAsTemplateId":{"description":"The ID of the template that this script is backing.","type":"integer"},"fromTemplateId":{"description":"The ID of the template this script uses, if any.","type":"integer"},"templateDependentsCount":{"description":"How many other scripts use this one as a template.","type":"integer"},"templateScriptName":{"description":"The name of the template script.","type":"string"},"links":{"description":"Useful links for this script.","$ref":"#/definitions/Object527"},"schedule":{"description":"The schedule of when this script will be run.","$ref":"#/definitions/Object106"},"notifications":{"description":"The notifications to send after the script is run.","$ref":"#/definitions/Object107"},"runningAs":{"description":"The user this job will run as, defaults to the author of the job.","$ref":"#/definitions/Object33"},"nextRunAt":{"description":"The time of the next scheduled run.","type":"string","format":"time"},"timeZone":{"description":"The time zone of this script.","type":"string"},"lastRun":{"description":"The last run of this script.","$ref":"#/definitions/Object74"},"myPermissionLevel":{"description":"Your permission level on the object. One of \"read\", \"write\", or \"manage\".","type":"string"},"hidden":{"description":"The hidden status of the item.","type":"boolean"},"targetProjectId":{"description":"Target project to which script outputs will be added.","type":"integer"},"archived":{"description":"The archival status of the requested item(s).","type":"string"},"templateScriptId":{"description":"The ID of the template script, if any.","type":"integer"}}},"Object528":{"type":"object","properties":{"id":{"description":"The ID of the run.","type":"integer"},"state":{"description":"The state of the run, one of 'queued', 'running' or 'cancelled'.","type":"string"},"isCancelRequested":{"description":"True if run cancel requested, else false.","type":"boolean"}}},"Object530":{"type":"object","properties":{"cpu":{"description":"The number of CPU shares to allocate for the container. Each core has 1000 shares. Must be at least 2 shares.","type":"integer"},"memory":{"description":"The amount of RAM to allocate for the container (in MB). Must be at least 4 MB.","type":"integer"},"diskSpace":{"description":"The amount of disk space, in GB, to allocate for the container. This space will be used to hold the git repo configured for the container and anything your container writes to /tmp or /data. Fractional values (e.g. 0.25) are supported.","type":"number","format":"float"}},"required":["cpu","memory"]},"Object529":{"type":"object","properties":{"name":{"description":"The name of the container.","type":"string"},"parentId":{"description":"The ID of the parent job that will trigger this script","type":"integer"},"userContext":{"description":"\"runner\" or \"author\", who to execute the script as when run as a template.","type":"string"},"params":{"description":"A definition of the parameters this script accepts in the arguments field.","type":"array","items":{"$ref":"#/definitions/Object523"}},"arguments":{"description":"Parameter-value pairs to use when running this script. Only settable if this script has defined parameters.","type":"object"},"schedule":{"description":"The schedule of when this script will be run.","$ref":"#/definitions/Object101"},"notifications":{"description":"The notifications to send after the script is run.","$ref":"#/definitions/Object102"},"requiredResources":{"description":"Resources to allocate for the container.","$ref":"#/definitions/Object530"},"repoHttpUri":{"description":"The location of a github repo to clone into the container, e.g. github.com/my-user/my-repo.git.","type":"string"},"repoRef":{"description":"The tag or branch of the github repo to clone into the container.","type":"string"},"remoteHostCredentialId":{"description":"The id of the database credentials to pass into the environment of the container.","type":"integer"},"gitCredentialId":{"description":"The id of the git credential to be used when checking out the specified git repo. If not supplied, the first git credential you've submitted will be used. Unnecessary if no git repo is specified or the git repo is public.","type":"integer"},"dockerCommand":{"description":"The command to run on the container. Will be run via sh as: [\"sh\", \"-c\", dockerCommand]. Defaults to the Docker image's ENTRYPOINT/CMD.","type":"string"},"dockerImageName":{"description":"The name of the docker image to pull from DockerHub.","type":"string"},"dockerImageTag":{"description":"The tag of the docker image to pull from DockerHub.","type":"string"},"instanceType":{"description":"The EC2 instance type to deploy to. Only available for jobs running on kubernetes.","type":"string"},"cancelTimeout":{"description":"The amount of time (in seconds) to wait before forcibly terminating the script. When the script is cancelled, it is first sent a TERM signal. If the script is still running after the timeout, it is sent a KILL signal. Defaults to 0.","type":"integer"},"timeZone":{"description":"The time zone of this script.","type":"string"},"partitionLabel":{"description":"The partition label used to run this object. ","type":"string"},"hidden":{"description":"The hidden status of the item.","type":"boolean"},"targetProjectId":{"description":"Target project to which script outputs will be added.","type":"integer"},"runningAsId":{"description":"The ID of the runner of this script.","type":"integer"}},"required":["requiredResources"]},"Object532":{"type":"object","properties":{"id":{"description":"The id of the Alias object.","type":"integer"},"objectId":{"description":"The id of the object","type":"integer"},"alias":{"description":"The alias of the object","type":"string"}}},"Object533":{"type":"object","properties":{"cpu":{"description":"The number of CPU shares to allocate for the container. Each core has 1000 shares. Must be at least 2 shares.","type":"integer"},"memory":{"description":"The amount of RAM to allocate for the container (in MB). Must be at least 4 MB.","type":"integer"},"diskSpace":{"description":"The amount of disk space, in GB, to allocate for the container. This space will be used to hold the git repo configured for the container and anything your container writes to /tmp or /data. Fractional values (e.g. 0.25) are supported.","type":"number","format":"float"}}},"Object531":{"type":"object","properties":{"id":{"description":"The ID for the script.","type":"integer"},"fromTemplateAliases":{"description":"An array of the aliases of the template script.","type":"array","items":{"$ref":"#/definitions/Object532"}},"name":{"description":"The name of the container.","type":"string"},"type":{"description":"The type of the script (e.g Container)","type":"string"},"createdAt":{"description":"The time this script was created.","type":"string","format":"time"},"updatedAt":{"description":"The time the script was last updated.","type":"string","format":"time"},"author":{"description":"The author/owner of the item.","$ref":"#/definitions/Object33"},"state":{"description":"The status of the script's last run.","type":"string"},"finishedAt":{"description":"The time that the script's last run finished.","type":"string","format":"time"},"category":{"description":"The category of the script.","type":"string"},"projects":{"description":"A list of projects containing the script.","type":"array","items":{"$ref":"#/definitions/Object525"}},"parentId":{"description":"The ID of the parent job that will trigger this script","type":"integer"},"userContext":{"description":"\"runner\" or \"author\", who to execute the script as when run as a template.","type":"string"},"params":{"description":"A definition of the parameters this script accepts in the arguments field.","type":"array","items":{"$ref":"#/definitions/Object526"}},"arguments":{"description":"Parameter-value pairs to use when running this script. Only settable if this script has defined parameters.","type":"object"},"isTemplate":{"description":"Whether others scripts use this one as a template.","type":"boolean"},"templateDependentsCount":{"description":"How many other scripts use this one as a template.","type":"integer"},"publishedAsTemplateId":{"description":"The ID of the template that this script is backing.","type":"integer"},"fromTemplateId":{"description":"The ID of the template script.","type":"integer"},"templateScriptName":{"description":"The name of the template script.","type":"string"},"links":{"description":"Useful links for this script.","$ref":"#/definitions/Object527"},"schedule":{"description":"The schedule of when this script will be run.","$ref":"#/definitions/Object106"},"notifications":{"description":"The notifications to send after the script is run.","$ref":"#/definitions/Object107"},"runningAs":{"description":"The user this job will run as, defaults to the author of the job.","$ref":"#/definitions/Object33"},"requiredResources":{"description":"Resources to allocate for the container.","$ref":"#/definitions/Object533"},"repoHttpUri":{"description":"The location of a github repo to clone into the container, e.g. github.com/my-user/my-repo.git.","type":"string"},"repoRef":{"description":"The tag or branch of the github repo to clone into the container.","type":"string"},"remoteHostCredentialId":{"description":"The id of the database credentials to pass into the environment of the container.","type":"integer"},"gitCredentialId":{"description":"The id of the git credential to be used when checking out the specified git repo. If not supplied, the first git credential you've submitted will be used. Unnecessary if no git repo is specified or the git repo is public.","type":"integer"},"dockerCommand":{"description":"The command to run on the container. Will be run via sh as: [\"sh\", \"-c\", dockerCommand]. Defaults to the Docker image's ENTRYPOINT/CMD.","type":"string"},"dockerImageName":{"description":"The name of the docker image to pull from DockerHub.","type":"string"},"dockerImageTag":{"description":"The tag of the docker image to pull from DockerHub.","type":"string"},"instanceType":{"description":"The EC2 instance type to deploy to. Only available for jobs running on kubernetes.","type":"string"},"cancelTimeout":{"description":"The amount of time (in seconds) to wait before forcibly terminating the script. When the script is cancelled, it is first sent a TERM signal. If the script is still running after the timeout, it is sent a KILL signal. Defaults to 0.","type":"integer"},"lastRun":{"description":"The last run of this script.","$ref":"#/definitions/Object74"},"timeZone":{"description":"The time zone of this script.","type":"string"},"partitionLabel":{"description":"The partition label used to run this object. ","type":"string"},"myPermissionLevel":{"description":"Your permission level on the object. One of \"read\", \"write\", or \"manage\".","type":"string"},"hidden":{"description":"The hidden status of the item.","type":"boolean"},"archived":{"description":"The archival status of the requested item(s).","type":"string"},"targetProjectId":{"description":"Target project to which script outputs will be added.","type":"integer"},"runningAsId":{"description":"The ID of the runner of this script.","type":"integer"}}},"Object534":{"type":"object","properties":{"name":{"description":"The name of the container.","type":"string"},"parentId":{"description":"The ID of the parent job that will trigger this script","type":"integer"},"userContext":{"description":"\"runner\" or \"author\", who to execute the script as when run as a template.","type":"string"},"params":{"description":"A definition of the parameters this script accepts in the arguments field.","type":"array","items":{"$ref":"#/definitions/Object523"}},"arguments":{"description":"Parameter-value pairs to use when running this script. Only settable if this script has defined parameters.","type":"object"},"schedule":{"description":"The schedule of when this script will be run.","$ref":"#/definitions/Object101"},"notifications":{"description":"The notifications to send after the script is run.","$ref":"#/definitions/Object102"},"requiredResources":{"description":"Resources to allocate for the container.","$ref":"#/definitions/Object530"},"repoHttpUri":{"description":"The location of a github repo to clone into the container, e.g. github.com/my-user/my-repo.git.","type":"string"},"repoRef":{"description":"The tag or branch of the github repo to clone into the container.","type":"string"},"remoteHostCredentialId":{"description":"The id of the database credentials to pass into the environment of the container.","type":"integer"},"gitCredentialId":{"description":"The id of the git credential to be used when checking out the specified git repo. If not supplied, the first git credential you've submitted will be used. Unnecessary if no git repo is specified or the git repo is public.","type":"integer"},"dockerCommand":{"description":"The command to run on the container. Will be run via sh as: [\"sh\", \"-c\", dockerCommand]. Defaults to the Docker image's ENTRYPOINT/CMD.","type":"string"},"dockerImageName":{"description":"The name of the docker image to pull from DockerHub.","type":"string"},"dockerImageTag":{"description":"The tag of the docker image to pull from DockerHub.","type":"string"},"instanceType":{"description":"The EC2 instance type to deploy to. Only available for jobs running on kubernetes.","type":"string"},"cancelTimeout":{"description":"The amount of time (in seconds) to wait before forcibly terminating the script. When the script is cancelled, it is first sent a TERM signal. If the script is still running after the timeout, it is sent a KILL signal. Defaults to 0.","type":"integer"},"timeZone":{"description":"The time zone of this script.","type":"string"},"partitionLabel":{"description":"The partition label used to run this object. ","type":"string"},"targetProjectId":{"description":"Target project to which script outputs will be added.","type":"integer"},"runningAsId":{"description":"The ID of the runner of this script.","type":"integer"}},"required":["requiredResources"]},"Object536":{"type":"object","properties":{"name":{"description":"The variable's name as used within your code.","type":"string"},"label":{"description":"The label to present to users when asking them for the value.","type":"string"},"description":{"description":"A short sentence or fragment describing this parameter to the end user.","type":"string"},"type":{"description":"The type of parameter. Valid options: string, multi_line_string, integer, float, bool, file, table, database, credential_aws, credential_redshift, or credential_custom","type":"string"},"required":{"description":"Whether this param is required.","type":"boolean"},"value":{"description":"The value you would like to set this param to. Setting this value makes this parameter a fixed param.","type":"string"},"default":{"description":"If an argument for this parameter is not defined, it will use this default value. Use true, True, t, y, yes, or 1 for true bool's or false, False, f, n, no, or 0 for false bool's. Cannot be used for parameters that are required or a credential type.","type":"string"},"allowedValues":{"description":"The possible values this parameter can take, effectively making this an enumerable parameter. Allowed values is an array of hashes of the following format: `{label: 'Import', 'value': 'import'}`","type":"array","items":{"type":"object"}}}},"Object537":{"type":"object","properties":{"cpu":{"description":"The number of CPU shares to allocate for the container. Each core has 1000 shares. Must be at least 2 shares.","type":"integer"},"memory":{"description":"The amount of RAM to allocate for the container (in MB). Must be at least 4 MB.","type":"integer"},"diskSpace":{"description":"The amount of disk space, in GB, to allocate for the container. This space will be used to hold the git repo configured for the container and anything your container writes to /tmp or /data. Fractional values (e.g. 0.25) are supported.","type":"number","format":"float"}}},"Object535":{"type":"object","properties":{"name":{"description":"The name of the container.","type":"string"},"parentId":{"description":"The ID of the parent job that will trigger this script","type":"integer"},"userContext":{"description":"\"runner\" or \"author\", who to execute the script as when run as a template.","type":"string"},"params":{"description":"A definition of the parameters this script accepts in the arguments field.","type":"array","items":{"$ref":"#/definitions/Object536"}},"arguments":{"description":"Parameter-value pairs to use when running this script. Only settable if this script has defined parameters.","type":"object"},"schedule":{"description":"The schedule of when this script will be run.","$ref":"#/definitions/Object101"},"notifications":{"description":"The notifications to send after the script is run.","$ref":"#/definitions/Object102"},"requiredResources":{"description":"Resources to allocate for the container.","$ref":"#/definitions/Object537"},"repoHttpUri":{"description":"The location of a github repo to clone into the container, e.g. github.com/my-user/my-repo.git.","type":"string"},"repoRef":{"description":"The tag or branch of the github repo to clone into the container.","type":"string"},"remoteHostCredentialId":{"description":"The id of the database credentials to pass into the environment of the container.","type":"integer"},"gitCredentialId":{"description":"The id of the git credential to be used when checking out the specified git repo. If not supplied, the first git credential you've submitted will be used. Unnecessary if no git repo is specified or the git repo is public.","type":"integer"},"dockerCommand":{"description":"The command to run on the container. Will be run via sh as: [\"sh\", \"-c\", dockerCommand]. Defaults to the Docker image's ENTRYPOINT/CMD.","type":"string"},"dockerImageName":{"description":"The name of the docker image to pull from DockerHub.","type":"string"},"dockerImageTag":{"description":"The tag of the docker image to pull from DockerHub.","type":"string"},"instanceType":{"description":"The EC2 instance type to deploy to. Only available for jobs running on kubernetes.","type":"string"},"cancelTimeout":{"description":"The amount of time (in seconds) to wait before forcibly terminating the script. When the script is cancelled, it is first sent a TERM signal. If the script is still running after the timeout, it is sent a KILL signal. Defaults to 0.","type":"integer"},"timeZone":{"description":"The time zone of this script.","type":"string"},"partitionLabel":{"description":"The partition label used to run this object. ","type":"string"},"targetProjectId":{"description":"Target project to which script outputs will be added.","type":"integer"},"runningAsId":{"description":"The ID of the runner of this script.","type":"integer"}}},"Object540":{"type":"object","properties":{"message":{"description":"The log message to store.","type":"string"},"level":{"description":"The log level of this message [default: info]","type":"string"},"createdAt":{"description":"The timestamp of this message in ISO 8601 format. This is what logs are ordered by, so it is recommended to use timestamps with nanosecond precision. If absent, defaults to the time that the log was received by the API.","type":"string","format":"date-time"}},"required":["message"]},"Object539":{"type":"object","properties":{"message":{"description":"The log message to store.","type":"string"},"level":{"description":"The log level of this message [default: info]","type":"string"},"messages":{"description":"If specified, a batch of logs to store. If createdAt timestamps for the logs are supplied, the ordering of this list is not preserved, and the timestamps are used to sort the logs.If createdAt timestamps are not supplied, the ordering of this list is preserved and the logs are given the timestamp of when they were received.","type":"array","items":{"$ref":"#/definitions/Object540"}},"childJobId":{"description":"The ID of the child job the message came from.","type":"integer"}}},"Object541":{"type":"object","properties":{"id":{"description":"The ID for the script.","type":"integer"},"name":{"description":"The name of the script.","type":"string"},"type":{"description":"The type of the script (e.g SQL, Container, Python, R, JavaScript, dbt)","type":"string"},"createdAt":{"description":"The time this script was created.","type":"string","format":"time"},"updatedAt":{"description":"The time the script was last updated.","type":"string","format":"time"},"author":{"description":"The author/owner of the item.","$ref":"#/definitions/Object33"},"state":{"description":"The status of the script's last run.","type":"string"},"finishedAt":{"description":"The time that the script's last run finished.","type":"string","format":"time"},"projects":{"description":"A list of projects containing the script.","type":"array","items":{"$ref":"#/definitions/Object525"}},"parentId":{"description":"The ID of the parent job that will trigger this script","type":"integer"},"isTemplate":{"description":"Whether others scripts use this one as a template.","type":"boolean"},"fromTemplateId":{"description":"The ID of the template this script uses, if any.","type":"integer"},"links":{"description":"Useful links for this script.","$ref":"#/definitions/Object527"},"timeZone":{"description":"The time zone of this script.","type":"string"},"lastRun":{"description":"The last run of this script.","$ref":"#/definitions/Object74"},"archived":{"description":"The archival status of the requested item(s).","type":"string"},"templateScriptId":{"description":"The ID of the template script, if any.","type":"integer"}}},"Object543":{"type":"object","properties":{"includeHeader":{"description":"Whether or not to include headers in the output data. Default: true","type":"boolean"},"compression":{"description":"The type of compression to use, if any, one of \"none\", \"zip\", or \"gzip\". Default: gzip","type":"string"},"columnDelimiter":{"description":"Which delimiter to use, one of \"comma\", \"tab\", or \"pipe\". Default: comma","type":"string"},"unquoted":{"description":"Whether or not to quote fields. Default: false","type":"boolean"},"forceMultifile":{"description":"Whether or not the csv should be split into multiple files. Default: false","type":"boolean"},"filenamePrefix":{"description":"A user specified filename prefix for the output file to have. Default: null","type":"string"},"maxFileSize":{"description":"The max file size, in MB, created files will be. Only available when force_multifile is true. ","type":"integer"}}},"Object542":{"type":"object","properties":{"name":{"description":"The name of the script.","type":"string"},"parentId":{"description":"The ID of the parent job that will trigger this script","type":"integer"},"userContext":{"description":"\"runner\" or \"author\", who to execute the script as when run as a template.","type":"string"},"params":{"description":"A definition of the parameters this script accepts in the arguments field.","type":"array","items":{"$ref":"#/definitions/Object523"}},"arguments":{"description":"Parameter-value pairs to use when running this script. Only settable if this script has defined parameters.","type":"object"},"schedule":{"description":"The schedule of when this script will be run.","$ref":"#/definitions/Object101"},"notifications":{"description":"The notifications to send after the script is run.","$ref":"#/definitions/Object102"},"nextRunAt":{"description":"The time of the next scheduled run.","type":"string","format":"time"},"timeZone":{"description":"The time zone of this script.","type":"string"},"hidden":{"description":"The hidden status of the item.","type":"boolean"},"targetProjectId":{"description":"Target project to which script outputs will be added.","type":"integer"},"sql":{"description":"The raw SQL query for the script.","type":"string"},"remoteHostId":{"description":"The remote host ID that this script will connect to.","type":"integer"},"credentialId":{"description":"The credential that this script will use.","type":"integer"},"csvSettings":{"description":"Parameters that determine the format of the generated file.","$ref":"#/definitions/Object543"},"runningAsId":{"description":"The ID of the runner of this script.","type":"integer"}},"required":["name","sql","remoteHostId","credentialId"]},"Object545":{"type":"object","properties":{"includeHeader":{"description":"Whether or not to include headers in the output data. Default: true","type":"boolean"},"compression":{"description":"The type of compression to use, if any, one of \"none\", \"zip\", or \"gzip\". Default: gzip","type":"string"},"columnDelimiter":{"description":"Which delimiter to use, one of \"comma\", \"tab\", or \"pipe\". Default: comma","type":"string"},"unquoted":{"description":"Whether or not to quote fields. Default: false","type":"boolean"},"forceMultifile":{"description":"Whether or not the csv should be split into multiple files. Default: false","type":"boolean"},"filenamePrefix":{"description":"A user specified filename prefix for the output file to have. Default: null","type":"string"},"maxFileSize":{"description":"The max file size, in MB, created files will be. Only available when force_multifile is true. ","type":"integer"}}},"Object544":{"type":"object","properties":{"id":{"description":"The ID for the script.","type":"integer"},"name":{"description":"The name of the script.","type":"string"},"type":{"description":"The type of the script (e.g SQL, Container, Python, R, JavaScript, dbt)","type":"string"},"createdAt":{"description":"The time this script was created.","type":"string","format":"time"},"updatedAt":{"description":"The time the script was last updated.","type":"string","format":"time"},"author":{"description":"The author/owner of the item.","$ref":"#/definitions/Object33"},"state":{"description":"The status of the script's last run.","type":"string"},"finishedAt":{"description":"The time that the script's last run finished.","type":"string","format":"time"},"category":{"description":"The category of the script.","type":"string"},"projects":{"description":"A list of projects containing the script.","type":"array","items":{"$ref":"#/definitions/Object525"}},"parentId":{"description":"The ID of the parent job that will trigger this script","type":"integer"},"userContext":{"description":"\"runner\" or \"author\", who to execute the script as when run as a template.","type":"string"},"params":{"description":"A definition of the parameters this script accepts in the arguments field.","type":"array","items":{"$ref":"#/definitions/Object526"}},"arguments":{"description":"Parameter-value pairs to use when running this script. Only settable if this script has defined parameters.","type":"object"},"isTemplate":{"description":"Whether others scripts use this one as a template.","type":"boolean"},"publishedAsTemplateId":{"description":"The ID of the template that this script is backing.","type":"integer"},"fromTemplateId":{"description":"The ID of the template this script uses, if any.","type":"integer"},"templateDependentsCount":{"description":"How many other scripts use this one as a template.","type":"integer"},"templateScriptName":{"description":"The name of the template script.","type":"string"},"links":{"description":"Useful links for this script.","$ref":"#/definitions/Object527"},"schedule":{"description":"The schedule of when this script will be run.","$ref":"#/definitions/Object106"},"notifications":{"description":"The notifications to send after the script is run.","$ref":"#/definitions/Object107"},"runningAs":{"description":"The user this job will run as, defaults to the author of the job.","$ref":"#/definitions/Object33"},"nextRunAt":{"description":"The time of the next scheduled run.","type":"string","format":"time"},"timeZone":{"description":"The time zone of this script.","type":"string"},"lastRun":{"description":"The last run of this script.","$ref":"#/definitions/Object74"},"myPermissionLevel":{"description":"Your permission level on the object. One of \"read\", \"write\", or \"manage\".","type":"string"},"hidden":{"description":"The hidden status of the item.","type":"boolean"},"targetProjectId":{"description":"Target project to which script outputs will be added.","type":"integer"},"archived":{"description":"The archival status of the requested item(s).","type":"string"},"sql":{"description":"The raw SQL query for the script.","type":"string"},"expandedArguments":{"description":"Expanded arguments for use in injecting into different environments.","type":"object"},"remoteHostId":{"description":"The remote host ID that this script will connect to.","type":"integer"},"credentialId":{"description":"The credential that this script will use.","type":"integer"},"codePreview":{"description":"The code that this script will run with arguments inserted.","type":"string"},"csvSettings":{"description":"Parameters that determine the format of the generated file.","$ref":"#/definitions/Object545"},"runningAsId":{"description":"The ID of the runner of this script.","type":"integer"}}},"Object546":{"type":"object","properties":{"name":{"description":"The name of the script.","type":"string"},"parentId":{"description":"The ID of the parent job that will trigger this script","type":"integer"},"userContext":{"description":"\"runner\" or \"author\", who to execute the script as when run as a template.","type":"string"},"params":{"description":"A definition of the parameters this script accepts in the arguments field.","type":"array","items":{"$ref":"#/definitions/Object523"}},"arguments":{"description":"Parameter-value pairs to use when running this script. Only settable if this script has defined parameters.","type":"object"},"schedule":{"description":"The schedule of when this script will be run.","$ref":"#/definitions/Object101"},"notifications":{"description":"The notifications to send after the script is run.","$ref":"#/definitions/Object102"},"nextRunAt":{"description":"The time of the next scheduled run.","type":"string","format":"time"},"timeZone":{"description":"The time zone of this script.","type":"string"},"targetProjectId":{"description":"Target project to which script outputs will be added.","type":"integer"},"sql":{"description":"The raw SQL query for the script.","type":"string"},"remoteHostId":{"description":"The remote host ID that this script will connect to.","type":"integer"},"credentialId":{"description":"The credential that this script will use.","type":"integer"},"csvSettings":{"description":"Parameters that determine the format of the generated file.","$ref":"#/definitions/Object543"},"runningAsId":{"description":"The ID of the runner of this script.","type":"integer"}},"required":["name","sql","remoteHostId","credentialId"]},"Object547":{"type":"object","properties":{"name":{"description":"The name of the script.","type":"string"},"parentId":{"description":"The ID of the parent job that will trigger this script","type":"integer"},"userContext":{"description":"\"runner\" or \"author\", who to execute the script as when run as a template.","type":"string"},"params":{"description":"A definition of the parameters this script accepts in the arguments field.","type":"array","items":{"$ref":"#/definitions/Object536"}},"arguments":{"description":"Parameter-value pairs to use when running this script. Only settable if this script has defined parameters.","type":"object"},"schedule":{"description":"The schedule of when this script will be run.","$ref":"#/definitions/Object101"},"notifications":{"description":"The notifications to send after the script is run.","$ref":"#/definitions/Object102"},"nextRunAt":{"description":"The time of the next scheduled run.","type":"string","format":"time"},"timeZone":{"description":"The time zone of this script.","type":"string"},"targetProjectId":{"description":"Target project to which script outputs will be added.","type":"integer"},"sql":{"description":"The raw SQL query for the script.","type":"string"},"remoteHostId":{"description":"The remote host ID that this script will connect to.","type":"integer"},"credentialId":{"description":"The credential that this script will use.","type":"integer"},"csvSettings":{"description":"Parameters that determine the format of the generated file.","$ref":"#/definitions/Object543"},"runningAsId":{"description":"The ID of the runner of this script.","type":"integer"}}},"Object548":{"type":"object","properties":{"name":{"description":"The name of the script.","type":"string"},"parentId":{"description":"The ID of the parent job that will trigger this script","type":"integer"},"userContext":{"description":"\"runner\" or \"author\", who to execute the script as when run as a template.","type":"string"},"params":{"description":"A definition of the parameters this script accepts in the arguments field.","type":"array","items":{"$ref":"#/definitions/Object523"}},"arguments":{"description":"Parameter-value pairs to use when running this script. Only settable if this script has defined parameters.","type":"object"},"schedule":{"description":"The schedule of when this script will be run.","$ref":"#/definitions/Object101"},"notifications":{"description":"The notifications to send after the script is run.","$ref":"#/definitions/Object102"},"nextRunAt":{"description":"The time of the next scheduled run.","type":"string","format":"time"},"timeZone":{"description":"The time zone of this script.","type":"string"},"hidden":{"description":"The hidden status of the item.","type":"boolean"},"targetProjectId":{"description":"Target project to which script outputs will be added.","type":"integer"},"requiredResources":{"description":"Resources to allocate for the container.","$ref":"#/definitions/Object530"},"instanceType":{"description":"The EC2 instance type to deploy to. Only available for jobs running on kubernetes.","type":"string"},"cancelTimeout":{"description":"The amount of time (in seconds) to wait before forcibly terminating the script. When the script is cancelled, it is first sent a TERM signal. If the script is still running after the timeout, it is sent a KILL signal. Defaults to 0.","type":"integer"},"dockerImageTag":{"description":"The tag of the docker image to pull from DockerHub.","type":"string"},"partitionLabel":{"description":"The partition label used to run this object. ","type":"string"},"runningAsId":{"description":"The ID of the runner of this script.","type":"integer"},"source":{"description":"The body/text of the script.","type":"string"}},"required":["name","source"]},"Object549":{"type":"object","properties":{"id":{"description":"The ID for the script.","type":"integer"},"name":{"description":"The name of the script.","type":"string"},"type":{"description":"The type of the script (e.g SQL, Container, Python, R, JavaScript, dbt)","type":"string"},"createdAt":{"description":"The time this script was created.","type":"string","format":"time"},"updatedAt":{"description":"The time the script was last updated.","type":"string","format":"time"},"author":{"description":"The author/owner of the item.","$ref":"#/definitions/Object33"},"state":{"description":"The status of the script's last run.","type":"string"},"finishedAt":{"description":"The time that the script's last run finished.","type":"string","format":"time"},"category":{"description":"The category of the script.","type":"string"},"projects":{"description":"A list of projects containing the script.","type":"array","items":{"$ref":"#/definitions/Object525"}},"parentId":{"description":"The ID of the parent job that will trigger this script","type":"integer"},"userContext":{"description":"\"runner\" or \"author\", who to execute the script as when run as a template.","type":"string"},"params":{"description":"A definition of the parameters this script accepts in the arguments field.","type":"array","items":{"$ref":"#/definitions/Object526"}},"arguments":{"description":"Parameter-value pairs to use when running this script. Only settable if this script has defined parameters.","type":"object"},"isTemplate":{"description":"Whether others scripts use this one as a template.","type":"boolean"},"publishedAsTemplateId":{"description":"The ID of the template that this script is backing.","type":"integer"},"fromTemplateId":{"description":"The ID of the template this script uses, if any.","type":"integer"},"templateDependentsCount":{"description":"How many other scripts use this one as a template.","type":"integer"},"templateScriptName":{"description":"The name of the template script.","type":"string"},"links":{"description":"Useful links for this script.","$ref":"#/definitions/Object527"},"schedule":{"description":"The schedule of when this script will be run.","$ref":"#/definitions/Object106"},"notifications":{"description":"The notifications to send after the script is run.","$ref":"#/definitions/Object107"},"runningAs":{"description":"The user this job will run as, defaults to the author of the job.","$ref":"#/definitions/Object33"},"nextRunAt":{"description":"The time of the next scheduled run.","type":"string","format":"time"},"timeZone":{"description":"The time zone of this script.","type":"string"},"lastRun":{"description":"The last run of this script.","$ref":"#/definitions/Object74"},"myPermissionLevel":{"description":"Your permission level on the object. One of \"read\", \"write\", or \"manage\".","type":"string"},"hidden":{"description":"The hidden status of the item.","type":"boolean"},"targetProjectId":{"description":"Target project to which script outputs will be added.","type":"integer"},"archived":{"description":"The archival status of the requested item(s).","type":"string"},"requiredResources":{"description":"Resources to allocate for the container.","$ref":"#/definitions/Object533"},"instanceType":{"description":"The EC2 instance type to deploy to. Only available for jobs running on kubernetes.","type":"string"},"cancelTimeout":{"description":"The amount of time (in seconds) to wait before forcibly terminating the script. When the script is cancelled, it is first sent a TERM signal. If the script is still running after the timeout, it is sent a KILL signal. Defaults to 0.","type":"integer"},"dockerImageTag":{"description":"The tag of the docker image to pull from DockerHub.","type":"string"},"partitionLabel":{"description":"The partition label used to run this object. ","type":"string"},"runningAsId":{"description":"The ID of the runner of this script.","type":"integer"},"source":{"description":"The body/text of the script.","type":"string"}}},"Object550":{"type":"object","properties":{"name":{"description":"The name of the script.","type":"string"},"parentId":{"description":"The ID of the parent job that will trigger this script","type":"integer"},"userContext":{"description":"\"runner\" or \"author\", who to execute the script as when run as a template.","type":"string"},"params":{"description":"A definition of the parameters this script accepts in the arguments field.","type":"array","items":{"$ref":"#/definitions/Object523"}},"arguments":{"description":"Parameter-value pairs to use when running this script. Only settable if this script has defined parameters.","type":"object"},"schedule":{"description":"The schedule of when this script will be run.","$ref":"#/definitions/Object101"},"notifications":{"description":"The notifications to send after the script is run.","$ref":"#/definitions/Object102"},"nextRunAt":{"description":"The time of the next scheduled run.","type":"string","format":"time"},"timeZone":{"description":"The time zone of this script.","type":"string"},"targetProjectId":{"description":"Target project to which script outputs will be added.","type":"integer"},"requiredResources":{"description":"Resources to allocate for the container.","$ref":"#/definitions/Object530"},"instanceType":{"description":"The EC2 instance type to deploy to. Only available for jobs running on kubernetes.","type":"string"},"cancelTimeout":{"description":"The amount of time (in seconds) to wait before forcibly terminating the script. When the script is cancelled, it is first sent a TERM signal. If the script is still running after the timeout, it is sent a KILL signal. Defaults to 0.","type":"integer"},"dockerImageTag":{"description":"The tag of the docker image to pull from DockerHub.","type":"string"},"partitionLabel":{"description":"The partition label used to run this object. ","type":"string"},"runningAsId":{"description":"The ID of the runner of this script.","type":"integer"},"source":{"description":"The body/text of the script.","type":"string"}},"required":["name","source"]},"Object551":{"type":"object","properties":{"name":{"description":"The name of the script.","type":"string"},"parentId":{"description":"The ID of the parent job that will trigger this script","type":"integer"},"userContext":{"description":"\"runner\" or \"author\", who to execute the script as when run as a template.","type":"string"},"params":{"description":"A definition of the parameters this script accepts in the arguments field.","type":"array","items":{"$ref":"#/definitions/Object536"}},"arguments":{"description":"Parameter-value pairs to use when running this script. Only settable if this script has defined parameters.","type":"object"},"schedule":{"description":"The schedule of when this script will be run.","$ref":"#/definitions/Object101"},"notifications":{"description":"The notifications to send after the script is run.","$ref":"#/definitions/Object102"},"nextRunAt":{"description":"The time of the next scheduled run.","type":"string","format":"time"},"timeZone":{"description":"The time zone of this script.","type":"string"},"targetProjectId":{"description":"Target project to which script outputs will be added.","type":"integer"},"requiredResources":{"description":"Resources to allocate for the container.","$ref":"#/definitions/Object537"},"instanceType":{"description":"The EC2 instance type to deploy to. Only available for jobs running on kubernetes.","type":"string"},"cancelTimeout":{"description":"The amount of time (in seconds) to wait before forcibly terminating the script. When the script is cancelled, it is first sent a TERM signal. If the script is still running after the timeout, it is sent a KILL signal. Defaults to 0.","type":"integer"},"dockerImageTag":{"description":"The tag of the docker image to pull from DockerHub.","type":"string"},"partitionLabel":{"description":"The partition label used to run this object. ","type":"string"},"runningAsId":{"description":"The ID of the runner of this script.","type":"integer"},"source":{"description":"The body/text of the script.","type":"string"}}},"Object552":{"type":"object","properties":{"name":{"description":"The name of the script.","type":"string"},"parentId":{"description":"The ID of the parent job that will trigger this script","type":"integer"},"userContext":{"description":"\"runner\" or \"author\", who to execute the script as when run as a template.","type":"string"},"params":{"description":"A definition of the parameters this script accepts in the arguments field.","type":"array","items":{"$ref":"#/definitions/Object523"}},"arguments":{"description":"Parameter-value pairs to use when running this script. Only settable if this script has defined parameters.","type":"object"},"schedule":{"description":"The schedule of when this script will be run.","$ref":"#/definitions/Object101"},"notifications":{"description":"The notifications to send after the script is run.","$ref":"#/definitions/Object102"},"nextRunAt":{"description":"The time of the next scheduled run.","type":"string","format":"time"},"timeZone":{"description":"The time zone of this script.","type":"string"},"hidden":{"description":"The hidden status of the item.","type":"boolean"},"targetProjectId":{"description":"Target project to which script outputs will be added.","type":"integer"},"requiredResources":{"description":"Resources to allocate for the container.","$ref":"#/definitions/Object530"},"instanceType":{"description":"The EC2 instance type to deploy to. Only available for jobs running on kubernetes.","type":"string"},"cancelTimeout":{"description":"The amount of time (in seconds) to wait before forcibly terminating the script. When the script is cancelled, it is first sent a TERM signal. If the script is still running after the timeout, it is sent a KILL signal. Defaults to 0.","type":"integer"},"dockerImageTag":{"description":"The tag of the docker image to pull from DockerHub.","type":"string"},"partitionLabel":{"description":"The partition label used to run this object. ","type":"string"},"runningAsId":{"description":"The ID of the runner of this script.","type":"integer"},"source":{"description":"The body/text of the script.","type":"string"}},"required":["name","source"]},"Object553":{"type":"object","properties":{"id":{"description":"The ID for the script.","type":"integer"},"name":{"description":"The name of the script.","type":"string"},"type":{"description":"The type of the script (e.g SQL, Container, Python, R, JavaScript, dbt)","type":"string"},"createdAt":{"description":"The time this script was created.","type":"string","format":"time"},"updatedAt":{"description":"The time the script was last updated.","type":"string","format":"time"},"author":{"description":"The author/owner of the item.","$ref":"#/definitions/Object33"},"state":{"description":"The status of the script's last run.","type":"string"},"finishedAt":{"description":"The time that the script's last run finished.","type":"string","format":"time"},"category":{"description":"The category of the script.","type":"string"},"projects":{"description":"A list of projects containing the script.","type":"array","items":{"$ref":"#/definitions/Object525"}},"parentId":{"description":"The ID of the parent job that will trigger this script","type":"integer"},"userContext":{"description":"\"runner\" or \"author\", who to execute the script as when run as a template.","type":"string"},"params":{"description":"A definition of the parameters this script accepts in the arguments field.","type":"array","items":{"$ref":"#/definitions/Object526"}},"arguments":{"description":"Parameter-value pairs to use when running this script. Only settable if this script has defined parameters.","type":"object"},"isTemplate":{"description":"Whether others scripts use this one as a template.","type":"boolean"},"publishedAsTemplateId":{"description":"The ID of the template that this script is backing.","type":"integer"},"fromTemplateId":{"description":"The ID of the template this script uses, if any.","type":"integer"},"templateDependentsCount":{"description":"How many other scripts use this one as a template.","type":"integer"},"templateScriptName":{"description":"The name of the template script.","type":"string"},"links":{"description":"Useful links for this script.","$ref":"#/definitions/Object527"},"schedule":{"description":"The schedule of when this script will be run.","$ref":"#/definitions/Object106"},"notifications":{"description":"The notifications to send after the script is run.","$ref":"#/definitions/Object107"},"runningAs":{"description":"The user this job will run as, defaults to the author of the job.","$ref":"#/definitions/Object33"},"nextRunAt":{"description":"The time of the next scheduled run.","type":"string","format":"time"},"timeZone":{"description":"The time zone of this script.","type":"string"},"lastRun":{"description":"The last run of this script.","$ref":"#/definitions/Object74"},"myPermissionLevel":{"description":"Your permission level on the object. One of \"read\", \"write\", or \"manage\".","type":"string"},"hidden":{"description":"The hidden status of the item.","type":"boolean"},"targetProjectId":{"description":"Target project to which script outputs will be added.","type":"integer"},"archived":{"description":"The archival status of the requested item(s).","type":"string"},"requiredResources":{"description":"Resources to allocate for the container.","$ref":"#/definitions/Object533"},"instanceType":{"description":"The EC2 instance type to deploy to. Only available for jobs running on kubernetes.","type":"string"},"cancelTimeout":{"description":"The amount of time (in seconds) to wait before forcibly terminating the script. When the script is cancelled, it is first sent a TERM signal. If the script is still running after the timeout, it is sent a KILL signal. Defaults to 0.","type":"integer"},"dockerImageTag":{"description":"The tag of the docker image to pull from DockerHub.","type":"string"},"partitionLabel":{"description":"The partition label used to run this object. ","type":"string"},"runningAsId":{"description":"The ID of the runner of this script.","type":"integer"},"source":{"description":"The body/text of the script.","type":"string"}}},"Object554":{"type":"object","properties":{"name":{"description":"The name of the script.","type":"string"},"parentId":{"description":"The ID of the parent job that will trigger this script","type":"integer"},"userContext":{"description":"\"runner\" or \"author\", who to execute the script as when run as a template.","type":"string"},"params":{"description":"A definition of the parameters this script accepts in the arguments field.","type":"array","items":{"$ref":"#/definitions/Object523"}},"arguments":{"description":"Parameter-value pairs to use when running this script. Only settable if this script has defined parameters.","type":"object"},"schedule":{"description":"The schedule of when this script will be run.","$ref":"#/definitions/Object101"},"notifications":{"description":"The notifications to send after the script is run.","$ref":"#/definitions/Object102"},"nextRunAt":{"description":"The time of the next scheduled run.","type":"string","format":"time"},"timeZone":{"description":"The time zone of this script.","type":"string"},"targetProjectId":{"description":"Target project to which script outputs will be added.","type":"integer"},"requiredResources":{"description":"Resources to allocate for the container.","$ref":"#/definitions/Object530"},"instanceType":{"description":"The EC2 instance type to deploy to. Only available for jobs running on kubernetes.","type":"string"},"cancelTimeout":{"description":"The amount of time (in seconds) to wait before forcibly terminating the script. When the script is cancelled, it is first sent a TERM signal. If the script is still running after the timeout, it is sent a KILL signal. Defaults to 0.","type":"integer"},"dockerImageTag":{"description":"The tag of the docker image to pull from DockerHub.","type":"string"},"partitionLabel":{"description":"The partition label used to run this object. ","type":"string"},"runningAsId":{"description":"The ID of the runner of this script.","type":"integer"},"source":{"description":"The body/text of the script.","type":"string"}},"required":["name","source"]},"Object555":{"type":"object","properties":{"name":{"description":"The name of the script.","type":"string"},"parentId":{"description":"The ID of the parent job that will trigger this script","type":"integer"},"userContext":{"description":"\"runner\" or \"author\", who to execute the script as when run as a template.","type":"string"},"params":{"description":"A definition of the parameters this script accepts in the arguments field.","type":"array","items":{"$ref":"#/definitions/Object536"}},"arguments":{"description":"Parameter-value pairs to use when running this script. Only settable if this script has defined parameters.","type":"object"},"schedule":{"description":"The schedule of when this script will be run.","$ref":"#/definitions/Object101"},"notifications":{"description":"The notifications to send after the script is run.","$ref":"#/definitions/Object102"},"nextRunAt":{"description":"The time of the next scheduled run.","type":"string","format":"time"},"timeZone":{"description":"The time zone of this script.","type":"string"},"targetProjectId":{"description":"Target project to which script outputs will be added.","type":"integer"},"requiredResources":{"description":"Resources to allocate for the container.","$ref":"#/definitions/Object537"},"instanceType":{"description":"The EC2 instance type to deploy to. Only available for jobs running on kubernetes.","type":"string"},"cancelTimeout":{"description":"The amount of time (in seconds) to wait before forcibly terminating the script. When the script is cancelled, it is first sent a TERM signal. If the script is still running after the timeout, it is sent a KILL signal. Defaults to 0.","type":"integer"},"dockerImageTag":{"description":"The tag of the docker image to pull from DockerHub.","type":"string"},"partitionLabel":{"description":"The partition label used to run this object. ","type":"string"},"runningAsId":{"description":"The ID of the runner of this script.","type":"integer"},"source":{"description":"The body/text of the script.","type":"string"}}},"Object557":{"type":"object","properties":{"target":{"description":"Which profile target to use. Ignored when used in conjunction with generate_profiles.","type":"string"},"schema":{"description":"The output schema for dbt to use.","type":"string"},"projectDir":{"description":"The path to dbt_project.yml. Defaults to the root of the repository. Generates 'DBT_PROJECT_DIR' environment variable.","type":"string"},"profilesDir":{"description":"The path to the profiles.yml file to be used by dbt. Ignored when used in conjunction with generate_profiles. Generates 'DBT_PROFILES_DIR' environment variable.","type":"string"},"dbtVersion":{"description":"The version of dbt to use. Generates 'DBT_VERSION' environment variable.","type":"string"},"dbtCommand":{"description":"The primary dbt command to run. Valid commands are build, run, test, compile, and retry.","type":"string"},"dbtCommandLineArgs":{"description":"Additional command line arguments to pass to dbt. Ignored when dbt retry command is selected.","type":"string"},"docsReportId":{"description":"The ID of the HTML report hosting the static dbt docs for this job. Updates every time a run succeeds. This report will be automatically shared with all users who are shared on the job.","type":"string"},"skipDocsGeneration":{"description":"Whether to skip dbt docs generation. If true, the linked docs report will not be updated when the script runs. Defaults to false.","type":"boolean"},"generateProfiles":{"description":"Whether to generate the profiles.yml file when running the script. Defaults to false.","type":"boolean"}}},"Object558":{"type":"object","properties":{"remoteHostId":{"description":"The remote host ID that this script will connect to.","type":"integer"},"credentialId":{"description":"The credential that this script will use.","type":"integer"}},"required":["remoteHostId","credentialId"]},"Object556":{"type":"object","properties":{"name":{"description":"The name of the script.","type":"string"},"parentId":{"description":"The ID of the parent job that will trigger this script","type":"integer"},"userContext":{"description":"\"runner\" or \"author\", who to execute the script as when run as a template.","type":"string"},"params":{"description":"A definition of the parameters this script accepts in the arguments field.","type":"array","items":{"$ref":"#/definitions/Object523"}},"arguments":{"description":"Parameter-value pairs to use when running this script. Only settable if this script has defined parameters.","type":"object"},"schedule":{"description":"The schedule of when this script will be run.","$ref":"#/definitions/Object101"},"notifications":{"description":"The notifications to send after the script is run.","$ref":"#/definitions/Object102"},"nextRunAt":{"description":"The time of the next scheduled run.","type":"string","format":"time"},"timeZone":{"description":"The time zone of this script.","type":"string"},"hidden":{"description":"The hidden status of the item.","type":"boolean"},"targetProjectId":{"description":"Target project to which script outputs will be added.","type":"integer"},"requiredResources":{"description":"Resources to allocate for the container.","$ref":"#/definitions/Object530"},"instanceType":{"description":"The EC2 instance type to deploy to. Only available for jobs running on kubernetes.","type":"string"},"cancelTimeout":{"description":"The amount of time (in seconds) to wait before forcibly terminating the script. When the script is cancelled, it is first sent a TERM signal. If the script is still running after the timeout, it is sent a KILL signal. Defaults to 0.","type":"integer"},"dockerImageTag":{"description":"The tag of the docker image to pull from DockerHub.","type":"string"},"partitionLabel":{"description":"The partition label used to run this object. ","type":"string"},"runningAsId":{"description":"The ID of the runner of this script.","type":"integer"},"dbtProject":{"description":"Configuration for this dbt script.","$ref":"#/definitions/Object557"},"repoHttpUri":{"description":"The URL of the git repository (e.g., https://github.com/organization/repo_name.git).","type":"string"},"repoRef":{"description":"A git reference specifying an unambiguous version of the file. Can be a branch name, a tag, or the full or shortened SHA of a commit. Defaults to 'main'.","type":"string"},"targetDatabase":{"description":"The database to connect to.","$ref":"#/definitions/Object558"}},"required":["name","repoHttpUri"]},"Object560":{"type":"object","properties":{"target":{"description":"Which profile target to use. Ignored when used in conjunction with generate_profiles.","type":"string"},"schema":{"description":"The output schema for dbt to use.","type":"string"},"projectDir":{"description":"The path to dbt_project.yml. Defaults to the root of the repository. Generates 'DBT_PROJECT_DIR' environment variable.","type":"string"},"profilesDir":{"description":"The path to the profiles.yml file to be used by dbt. Ignored when used in conjunction with generate_profiles. Generates 'DBT_PROFILES_DIR' environment variable.","type":"string"},"dbtVersion":{"description":"The version of dbt to use. Generates 'DBT_VERSION' environment variable.","type":"string"},"dbtCommand":{"description":"The primary dbt command to run. Valid commands are build, run, test, compile, and retry.","type":"string"},"dbtCommandLineArgs":{"description":"Additional command line arguments to pass to dbt. Ignored when dbt retry command is selected.","type":"string"},"docsReportId":{"description":"The ID of the HTML report hosting the static dbt docs for this job. Updates every time a run succeeds. This report will be automatically shared with all users who are shared on the job.","type":"string"},"skipDocsGeneration":{"description":"Whether to skip dbt docs generation. If true, the linked docs report will not be updated when the script runs. Defaults to false.","type":"boolean"},"generateProfiles":{"description":"Whether to generate the profiles.yml file when running the script. Defaults to false.","type":"boolean"}}},"Object561":{"type":"object","properties":{"remoteHostId":{"description":"The remote host ID that this script will connect to.","type":"integer"},"credentialId":{"description":"The credential that this script will use.","type":"integer"}}},"Object559":{"type":"object","properties":{"id":{"description":"The ID for the script.","type":"integer"},"name":{"description":"The name of the script.","type":"string"},"type":{"description":"The type of the script (e.g SQL, Container, Python, R, JavaScript, dbt)","type":"string"},"createdAt":{"description":"The time this script was created.","type":"string","format":"time"},"updatedAt":{"description":"The time the script was last updated.","type":"string","format":"time"},"author":{"description":"The author/owner of the item.","$ref":"#/definitions/Object33"},"state":{"description":"The status of the script's last run.","type":"string"},"finishedAt":{"description":"The time that the script's last run finished.","type":"string","format":"time"},"category":{"description":"The category of the script.","type":"string"},"projects":{"description":"A list of projects containing the script.","type":"array","items":{"$ref":"#/definitions/Object525"}},"parentId":{"description":"The ID of the parent job that will trigger this script","type":"integer"},"userContext":{"description":"\"runner\" or \"author\", who to execute the script as when run as a template.","type":"string"},"params":{"description":"A definition of the parameters this script accepts in the arguments field.","type":"array","items":{"$ref":"#/definitions/Object526"}},"arguments":{"description":"Parameter-value pairs to use when running this script. Only settable if this script has defined parameters.","type":"object"},"isTemplate":{"description":"Whether others scripts use this one as a template.","type":"boolean"},"publishedAsTemplateId":{"description":"The ID of the template that this script is backing.","type":"integer"},"fromTemplateId":{"description":"The ID of the template this script uses, if any.","type":"integer"},"templateDependentsCount":{"description":"How many other scripts use this one as a template.","type":"integer"},"templateScriptName":{"description":"The name of the template script.","type":"string"},"links":{"description":"Useful links for this script.","$ref":"#/definitions/Object527"},"schedule":{"description":"The schedule of when this script will be run.","$ref":"#/definitions/Object106"},"notifications":{"description":"The notifications to send after the script is run.","$ref":"#/definitions/Object107"},"runningAs":{"description":"The user this job will run as, defaults to the author of the job.","$ref":"#/definitions/Object33"},"nextRunAt":{"description":"The time of the next scheduled run.","type":"string","format":"time"},"timeZone":{"description":"The time zone of this script.","type":"string"},"lastRun":{"description":"The last run of this script.","$ref":"#/definitions/Object74"},"myPermissionLevel":{"description":"Your permission level on the object. One of \"read\", \"write\", or \"manage\".","type":"string"},"hidden":{"description":"The hidden status of the item.","type":"boolean"},"targetProjectId":{"description":"Target project to which script outputs will be added.","type":"integer"},"archived":{"description":"The archival status of the requested item(s).","type":"string"},"requiredResources":{"description":"Resources to allocate for the container.","$ref":"#/definitions/Object533"},"instanceType":{"description":"The EC2 instance type to deploy to. Only available for jobs running on kubernetes.","type":"string"},"cancelTimeout":{"description":"The amount of time (in seconds) to wait before forcibly terminating the script. When the script is cancelled, it is first sent a TERM signal. If the script is still running after the timeout, it is sent a KILL signal. Defaults to 0.","type":"integer"},"dockerImageTag":{"description":"The tag of the docker image to pull from DockerHub.","type":"string"},"partitionLabel":{"description":"The partition label used to run this object. ","type":"string"},"runningAsId":{"description":"The ID of the runner of this script.","type":"integer"},"dbtProject":{"description":"Configuration for this dbt script.","$ref":"#/definitions/Object560"},"repoHttpUri":{"description":"The URL of the git repository (e.g., https://github.com/organization/repo_name.git).","type":"string"},"repoRef":{"description":"A git reference specifying an unambiguous version of the file. Can be a branch name, a tag, or the full or shortened SHA of a commit. Defaults to 'main'.","type":"string"},"targetDatabase":{"description":"The database to connect to.","$ref":"#/definitions/Object561"}}},"Object562":{"type":"object","properties":{"name":{"description":"The name of the script.","type":"string"},"parentId":{"description":"The ID of the parent job that will trigger this script","type":"integer"},"userContext":{"description":"\"runner\" or \"author\", who to execute the script as when run as a template.","type":"string"},"params":{"description":"A definition of the parameters this script accepts in the arguments field.","type":"array","items":{"$ref":"#/definitions/Object523"}},"arguments":{"description":"Parameter-value pairs to use when running this script. Only settable if this script has defined parameters.","type":"object"},"schedule":{"description":"The schedule of when this script will be run.","$ref":"#/definitions/Object101"},"notifications":{"description":"The notifications to send after the script is run.","$ref":"#/definitions/Object102"},"nextRunAt":{"description":"The time of the next scheduled run.","type":"string","format":"time"},"timeZone":{"description":"The time zone of this script.","type":"string"},"targetProjectId":{"description":"Target project to which script outputs will be added.","type":"integer"},"requiredResources":{"description":"Resources to allocate for the container.","$ref":"#/definitions/Object530"},"instanceType":{"description":"The EC2 instance type to deploy to. Only available for jobs running on kubernetes.","type":"string"},"cancelTimeout":{"description":"The amount of time (in seconds) to wait before forcibly terminating the script. When the script is cancelled, it is first sent a TERM signal. If the script is still running after the timeout, it is sent a KILL signal. Defaults to 0.","type":"integer"},"dockerImageTag":{"description":"The tag of the docker image to pull from DockerHub.","type":"string"},"partitionLabel":{"description":"The partition label used to run this object. ","type":"string"},"runningAsId":{"description":"The ID of the runner of this script.","type":"integer"},"dbtProject":{"description":"Configuration for this dbt script.","$ref":"#/definitions/Object557"},"repoHttpUri":{"description":"The URL of the git repository (e.g., https://github.com/organization/repo_name.git).","type":"string"},"repoRef":{"description":"A git reference specifying an unambiguous version of the file. Can be a branch name, a tag, or the full or shortened SHA of a commit. Defaults to 'main'.","type":"string"},"targetDatabase":{"description":"The database to connect to.","$ref":"#/definitions/Object558"}},"required":["name","repoHttpUri"]},"Object564":{"type":"object","properties":{"remoteHostId":{"description":"The remote host ID that this script will connect to.","type":"integer"},"credentialId":{"description":"The credential that this script will use.","type":"integer"}}},"Object563":{"type":"object","properties":{"name":{"description":"The name of the script.","type":"string"},"parentId":{"description":"The ID of the parent job that will trigger this script","type":"integer"},"userContext":{"description":"\"runner\" or \"author\", who to execute the script as when run as a template.","type":"string"},"params":{"description":"A definition of the parameters this script accepts in the arguments field.","type":"array","items":{"$ref":"#/definitions/Object536"}},"arguments":{"description":"Parameter-value pairs to use when running this script. Only settable if this script has defined parameters.","type":"object"},"schedule":{"description":"The schedule of when this script will be run.","$ref":"#/definitions/Object101"},"notifications":{"description":"The notifications to send after the script is run.","$ref":"#/definitions/Object102"},"nextRunAt":{"description":"The time of the next scheduled run.","type":"string","format":"time"},"timeZone":{"description":"The time zone of this script.","type":"string"},"targetProjectId":{"description":"Target project to which script outputs will be added.","type":"integer"},"requiredResources":{"description":"Resources to allocate for the container.","$ref":"#/definitions/Object537"},"instanceType":{"description":"The EC2 instance type to deploy to. Only available for jobs running on kubernetes.","type":"string"},"cancelTimeout":{"description":"The amount of time (in seconds) to wait before forcibly terminating the script. When the script is cancelled, it is first sent a TERM signal. If the script is still running after the timeout, it is sent a KILL signal. Defaults to 0.","type":"integer"},"dockerImageTag":{"description":"The tag of the docker image to pull from DockerHub.","type":"string"},"partitionLabel":{"description":"The partition label used to run this object. ","type":"string"},"runningAsId":{"description":"The ID of the runner of this script.","type":"integer"},"dbtProject":{"description":"Configuration for this dbt script.","$ref":"#/definitions/Object557"},"repoHttpUri":{"description":"The URL of the git repository (e.g., https://github.com/organization/repo_name.git).","type":"string"},"repoRef":{"description":"A git reference specifying an unambiguous version of the file. Can be a branch name, a tag, or the full or shortened SHA of a commit. Defaults to 'main'.","type":"string"},"targetDatabase":{"description":"The database to connect to.","$ref":"#/definitions/Object564"}}},"Object565":{"type":"object","properties":{"name":{"description":"The name of the script.","type":"string"},"parentId":{"description":"The ID of the parent job that will trigger this script","type":"integer"},"userContext":{"description":"\"runner\" or \"author\", who to execute the script as when run as a template.","type":"string"},"params":{"description":"A definition of the parameters this script accepts in the arguments field.","type":"array","items":{"$ref":"#/definitions/Object523"}},"arguments":{"description":"Parameter-value pairs to use when running this script. Only settable if this script has defined parameters.","type":"object"},"schedule":{"description":"The schedule of when this script will be run.","$ref":"#/definitions/Object101"},"notifications":{"description":"The notifications to send after the script is run.","$ref":"#/definitions/Object102"},"nextRunAt":{"description":"The time of the next scheduled run.","type":"string","format":"time"},"timeZone":{"description":"The time zone of this script.","type":"string"},"hidden":{"description":"The hidden status of the item.","type":"boolean"},"targetProjectId":{"description":"Target project to which script outputs will be added.","type":"integer"},"source":{"description":"The body/text of the script.","type":"string"},"remoteHostId":{"description":"The remote host ID that this script will connect to.","type":"integer"},"credentialId":{"description":"The credential that this script will use.","type":"integer"},"runningAsId":{"description":"The ID of the runner of this script.","type":"integer"}},"required":["name","source","remoteHostId","credentialId"]},"Object566":{"type":"object","properties":{"id":{"description":"The ID for the script.","type":"integer"},"name":{"description":"The name of the script.","type":"string"},"type":{"description":"The type of the script (e.g SQL, Container, Python, R, JavaScript, dbt)","type":"string"},"createdAt":{"description":"The time this script was created.","type":"string","format":"time"},"updatedAt":{"description":"The time the script was last updated.","type":"string","format":"time"},"author":{"description":"The author/owner of the item.","$ref":"#/definitions/Object33"},"state":{"description":"The status of the script's last run.","type":"string"},"finishedAt":{"description":"The time that the script's last run finished.","type":"string","format":"time"},"category":{"description":"The category of the script.","type":"string"},"projects":{"description":"A list of projects containing the script.","type":"array","items":{"$ref":"#/definitions/Object525"}},"parentId":{"description":"The ID of the parent job that will trigger this script","type":"integer"},"userContext":{"description":"\"runner\" or \"author\", who to execute the script as when run as a template.","type":"string"},"params":{"description":"A definition of the parameters this script accepts in the arguments field.","type":"array","items":{"$ref":"#/definitions/Object526"}},"arguments":{"description":"Parameter-value pairs to use when running this script. Only settable if this script has defined parameters.","type":"object"},"isTemplate":{"description":"Whether others scripts use this one as a template.","type":"boolean"},"publishedAsTemplateId":{"description":"The ID of the template that this script is backing.","type":"integer"},"fromTemplateId":{"description":"The ID of the template this script uses, if any.","type":"integer"},"templateDependentsCount":{"description":"How many other scripts use this one as a template.","type":"integer"},"templateScriptName":{"description":"The name of the template script.","type":"string"},"links":{"description":"Useful links for this script.","$ref":"#/definitions/Object527"},"schedule":{"description":"The schedule of when this script will be run.","$ref":"#/definitions/Object106"},"notifications":{"description":"The notifications to send after the script is run.","$ref":"#/definitions/Object107"},"runningAs":{"description":"The user this job will run as, defaults to the author of the job.","$ref":"#/definitions/Object33"},"nextRunAt":{"description":"The time of the next scheduled run.","type":"string","format":"time"},"timeZone":{"description":"The time zone of this script.","type":"string"},"lastRun":{"description":"The last run of this script.","$ref":"#/definitions/Object74"},"myPermissionLevel":{"description":"Your permission level on the object. One of \"read\", \"write\", or \"manage\".","type":"string"},"hidden":{"description":"The hidden status of the item.","type":"boolean"},"targetProjectId":{"description":"Target project to which script outputs will be added.","type":"integer"},"archived":{"description":"The archival status of the requested item(s).","type":"string"},"source":{"description":"The body/text of the script.","type":"string"},"remoteHostId":{"description":"The remote host ID that this script will connect to.","type":"integer"},"credentialId":{"description":"The credential that this script will use.","type":"integer"},"runningAsId":{"description":"The ID of the runner of this script.","type":"integer"}}},"Object567":{"type":"object","properties":{"name":{"description":"The name of the script.","type":"string"},"parentId":{"description":"The ID of the parent job that will trigger this script","type":"integer"},"userContext":{"description":"\"runner\" or \"author\", who to execute the script as when run as a template.","type":"string"},"params":{"description":"A definition of the parameters this script accepts in the arguments field.","type":"array","items":{"$ref":"#/definitions/Object523"}},"arguments":{"description":"Parameter-value pairs to use when running this script. Only settable if this script has defined parameters.","type":"object"},"schedule":{"description":"The schedule of when this script will be run.","$ref":"#/definitions/Object101"},"notifications":{"description":"The notifications to send after the script is run.","$ref":"#/definitions/Object102"},"nextRunAt":{"description":"The time of the next scheduled run.","type":"string","format":"time"},"timeZone":{"description":"The time zone of this script.","type":"string"},"targetProjectId":{"description":"Target project to which script outputs will be added.","type":"integer"},"source":{"description":"The body/text of the script.","type":"string"},"remoteHostId":{"description":"The remote host ID that this script will connect to.","type":"integer"},"credentialId":{"description":"The credential that this script will use.","type":"integer"},"runningAsId":{"description":"The ID of the runner of this script.","type":"integer"}},"required":["name","source","remoteHostId","credentialId"]},"Object568":{"type":"object","properties":{"name":{"description":"The name of the script.","type":"string"},"parentId":{"description":"The ID of the parent job that will trigger this script","type":"integer"},"userContext":{"description":"\"runner\" or \"author\", who to execute the script as when run as a template.","type":"string"},"params":{"description":"A definition of the parameters this script accepts in the arguments field.","type":"array","items":{"$ref":"#/definitions/Object536"}},"arguments":{"description":"Parameter-value pairs to use when running this script. Only settable if this script has defined parameters.","type":"object"},"schedule":{"description":"The schedule of when this script will be run.","$ref":"#/definitions/Object101"},"notifications":{"description":"The notifications to send after the script is run.","$ref":"#/definitions/Object102"},"nextRunAt":{"description":"The time of the next scheduled run.","type":"string","format":"time"},"timeZone":{"description":"The time zone of this script.","type":"string"},"targetProjectId":{"description":"Target project to which script outputs will be added.","type":"integer"},"source":{"description":"The body/text of the script.","type":"string"},"remoteHostId":{"description":"The remote host ID that this script will connect to.","type":"integer"},"credentialId":{"description":"The credential that this script will use.","type":"integer"},"runningAsId":{"description":"The ID of the runner of this script.","type":"integer"}}},"Object569":{"type":"object","properties":{"id":{"description":"The ID for the script.","type":"integer"},"name":{"description":"The name of the script.","type":"string"},"type":{"description":"The type of the script (e.g Custom)","type":"string"},"backingScriptType":{"description":"The type of the script backing this template (e.g Python)","type":"string"},"createdAt":{"description":"The time this script was created.","type":"string","format":"time"},"updatedAt":{"description":"The time the script was last updated.","type":"string","format":"time"},"author":{"description":"The author/owner of the item.","$ref":"#/definitions/Object33"},"state":{"description":"The status of the script's last run.","type":"string"},"finishedAt":{"description":"The time that the script's last run finished.","type":"string","format":"time"},"projects":{"description":"A list of projects containing the script.","type":"array","items":{"$ref":"#/definitions/Object525"}},"parentId":{"description":"The ID of the parent job that will trigger this script","type":"integer"},"fromTemplateId":{"description":"The ID of the template script.","type":"integer"},"timeZone":{"description":"The time zone of this script.","type":"string"},"lastRun":{"description":"The last run of this script.","$ref":"#/definitions/Object74"},"archived":{"description":"The archival status of the requested item(s).","type":"string"},"lastSuccessfulRun":{"description":"The last successful run of this script.","$ref":"#/definitions/Object74"}}},"Object571":{"type":"object","properties":{"cpu":{"description":"The number of CPU shares to allocate for the container. Each core has 1000 shares.","type":"integer"},"memory":{"description":"The amount of RAM to allocate for the container (in MB).","type":"integer"},"diskSpace":{"description":"The amount of disk space, in GB, to allocate for the container. This space will be used to hold the git repo configured for the container and anything your container writes to /tmp or /data. Fractional values (e.g. 0.25) are supported.","type":"number","format":"float"}}},"Object570":{"type":"object","properties":{"name":{"description":"The name of the script.","type":"string"},"parentId":{"description":"The ID of the parent job that will trigger this script","type":"integer"},"arguments":{"description":"Parameter-value pairs to use when running this script. Only settable if this script has defined parameters.","type":"object"},"fromTemplateId":{"description":"The ID of the template script.","type":"integer"},"remoteHostId":{"description":"The remote host ID that this script will connect to.","type":"integer"},"credentialId":{"description":"The credential that this script will use.","type":"integer"},"schedule":{"description":"The schedule of when this script will be run.","$ref":"#/definitions/Object101"},"notifications":{"description":"The notifications to send after the script is run.","$ref":"#/definitions/Object102"},"timeZone":{"description":"The time zone of this script.","type":"string"},"hidden":{"description":"The hidden status of the item.","type":"boolean"},"targetProjectId":{"description":"Target project to which script outputs will be added.","type":"integer"},"requiredResources":{"description":"Resources to allocate for the container.If set, overrides the required resources on the template backing script.Only applicable for jobs using Docker.","$ref":"#/definitions/Object571"},"partitionLabel":{"description":"The partition label used to run this object. Only applicable for jobs using Docker.","type":"string"},"runningAsId":{"description":"The ID of the runner of this script.","type":"integer"}},"required":["fromTemplateId"]},"Object573":{"type":"object","properties":{"cpu":{"description":"The number of CPU shares to allocate for the container. Each core has 1000 shares.","type":"integer"},"memory":{"description":"The amount of RAM to allocate for the container (in MB).","type":"integer"},"diskSpace":{"description":"The amount of disk space, in GB, to allocate for the container. This space will be used to hold the git repo configured for the container and anything your container writes to /tmp or /data. Fractional values (e.g. 0.25) are supported.","type":"number","format":"float"}}},"Object572":{"type":"object","properties":{"id":{"description":"The ID for the script.","type":"integer"},"fromTemplateAliases":{"description":"An array of the aliases of the template script.","type":"array","items":{"$ref":"#/definitions/Object532"}},"name":{"description":"The name of the script.","type":"string"},"type":{"description":"The type of the script (e.g Custom)","type":"string"},"backingScriptType":{"description":"The type of the script backing this template (e.g Python)","type":"string"},"createdAt":{"description":"The time this script was created.","type":"string","format":"time"},"updatedAt":{"description":"The time the script was last updated.","type":"string","format":"time"},"author":{"description":"The author/owner of the item.","$ref":"#/definitions/Object33"},"state":{"description":"The status of the script's last run.","type":"string"},"finishedAt":{"description":"The time that the script's last run finished.","type":"string","format":"time"},"category":{"type":"string"},"projects":{"description":"A list of projects containing the script.","type":"array","items":{"$ref":"#/definitions/Object525"}},"parentId":{"description":"The ID of the parent job that will trigger this script","type":"integer"},"params":{"description":"A definition of the parameters this script accepts in the arguments field.","type":"array","items":{"$ref":"#/definitions/Object526"}},"arguments":{"description":"Parameter-value pairs to use when running this script. Only settable if this script has defined parameters.","type":"object"},"isTemplate":{"description":"Whether others scripts use this one as a template.","type":"boolean"},"publishedAsTemplateId":{"description":"The ID of the template that this script is backing.","type":"integer"},"fromTemplateId":{"description":"The ID of the template script.","type":"integer"},"uiReportUrl":{"description":"The url of the custom HTML.","type":"integer"},"uiReportId":{"description":"The id of the report with the custom HTML.","type":"integer"},"uiReportProvideAPIKey":{"description":"Whether the ui report requests an API Key from the report viewer.","type":"boolean"},"templateScriptName":{"description":"The name of the template script.","type":"string"},"templateNote":{"description":"The template's note.","type":"string"},"remoteHostId":{"description":"The remote host ID that this script will connect to.","type":"integer"},"credentialId":{"description":"The credential that this script will use.","type":"integer"},"codePreview":{"description":"The code that this script will run with arguments inserted.","type":"string"},"schedule":{"description":"The schedule of when this script will be run.","$ref":"#/definitions/Object106"},"notifications":{"description":"The notifications to send after the script is run.","$ref":"#/definitions/Object107"},"runningAs":{"description":"The user this job will run as, defaults to the author of the job.","$ref":"#/definitions/Object33"},"timeZone":{"description":"The time zone of this script.","type":"string"},"lastRun":{"description":"The last run of this script.","$ref":"#/definitions/Object74"},"myPermissionLevel":{"description":"Your permission level on the object. One of \"read\", \"write\", or \"manage\".","type":"string"},"hidden":{"description":"The hidden status of the item.","type":"boolean"},"archived":{"description":"The archival status of the requested item(s).","type":"string"},"targetProjectId":{"description":"Target project to which script outputs will be added.","type":"integer"},"lastSuccessfulRun":{"description":"The last successful run of this script.","$ref":"#/definitions/Object74"},"requiredResources":{"description":"Resources to allocate for the container.If set, overrides the required resources on the template backing script.Only applicable for jobs using Docker.","$ref":"#/definitions/Object573"},"partitionLabel":{"description":"The partition label used to run this object. Only applicable for jobs using Docker.","type":"string"},"runningAsId":{"description":"The ID of the runner of this script.","type":"integer"}}},"Object574":{"type":"object","properties":{"name":{"description":"The name of the script.","type":"string"},"parentId":{"description":"The ID of the parent job that will trigger this script","type":"integer"},"arguments":{"description":"Parameter-value pairs to use when running this script. Only settable if this script has defined parameters.","type":"object"},"remoteHostId":{"description":"The remote host ID that this script will connect to.","type":"integer"},"credentialId":{"description":"The credential that this script will use.","type":"integer"},"schedule":{"description":"The schedule of when this script will be run.","$ref":"#/definitions/Object101"},"notifications":{"description":"The notifications to send after the script is run.","$ref":"#/definitions/Object102"},"timeZone":{"description":"The time zone of this script.","type":"string"},"targetProjectId":{"description":"Target project to which script outputs will be added.","type":"integer"},"requiredResources":{"description":"Resources to allocate for the container.If set, overrides the required resources on the template backing script.Only applicable for jobs using Docker.","$ref":"#/definitions/Object571"},"partitionLabel":{"description":"The partition label used to run this object. Only applicable for jobs using Docker.","type":"string"},"runningAsId":{"description":"The ID of the runner of this script.","type":"integer"}}},"Object575":{"type":"object","properties":{"id":{"description":"The ID for the script.","type":"integer"},"name":{"description":"The name of the script.","type":"string"},"type":{"description":"The type of script.","type":"string"},"createdAt":{"description":"The time this script was created.","type":"string","format":"time"},"updatedAt":{"description":"The time this script was last updated.","type":"string","format":"time"},"author":{"description":"The author/owner of the item.","$ref":"#/definitions/Object33"},"state":{"description":"The status of the script's last run.","type":"string"},"finishedAt":{"description":"The time that the script's last run finished.","type":"string","format":"time"},"category":{"description":"The category of the script.","type":"string"},"projects":{"description":"A list of projects containing the script.","type":"array","items":{"$ref":"#/definitions/Object525"}},"parentId":{"description":"The ID of the parent job that will trigger this script","type":"integer"},"userContext":{"description":"\"runner\" or \"author\", who to execute the script as when run as a template.","type":"string"},"params":{"description":"A definition of the parameters this script accepts in the arguments field.","type":"array","items":{"$ref":"#/definitions/Object526"}},"arguments":{"description":"Parameter-value pairs to use when running this script. Only settable if this script has defined parameters.","type":"object"},"isTemplate":{"description":"Whether others scripts use this one as a template.","type":"boolean"},"publishedAsTemplateId":{"description":"The ID of the template that this script is backing.","type":"integer"},"fromTemplateId":{"description":"The ID of the template this script uses, if any.","type":"integer"},"templateDependentsCount":{"description":"How many other scripts use this one as a template.","type":"integer"},"templateScriptName":{"description":"The name of the template script.","type":"string"},"links":{"description":"Useful links for this script.","$ref":"#/definitions/Object527"},"schedule":{"description":"The schedule of when this script will be run.","$ref":"#/definitions/Object106"},"notifications":{"description":"The notifications to send after the script is run.","$ref":"#/definitions/Object107"},"runningAs":{"description":"The user this job will run as, defaults to the author of the job.","$ref":"#/definitions/Object33"},"nextRunAt":{"description":"The time of the next scheduled run.","type":"string","format":"time"},"timeZone":{"description":"The time zone of this script.","type":"string"},"lastRun":{"description":"The last run of this script.","$ref":"#/definitions/Object74"},"myPermissionLevel":{"description":"Your permission level on the object. One of \"read\", \"write\", or \"manage\".","type":"string"},"hidden":{"description":"The hidden status of the item.","type":"boolean"},"targetProjectId":{"description":"Target project to which script outputs will be added.","type":"integer"},"archived":{"description":"The archival status of the requested item(s).","type":"string"},"sql":{"description":"The raw SQL query for the script.","type":"string"},"expandedArguments":{"description":"Expanded arguments for use in injecting into different environments.","type":"object"},"templateScriptId":{"description":"The ID of the template script, if any.","type":"integer"}}},"Object576":{"type":"object","properties":{"id":{"description":"The ID of the run.","type":"integer"},"sqlId":{"description":"The ID of the SQL job.","type":"integer"},"state":{"description":"The state of the run, one of 'queued' 'running' 'succeeded' 'failed' or 'cancelled'.","type":"string"},"isCancelRequested":{"description":"True if run cancel requested, else false.","type":"boolean"},"createdAt":{"description":"The time the run was created.","type":"string","format":"time"},"startedAt":{"description":"The time the run started at.","type":"string","format":"time"},"finishedAt":{"description":"The time the run completed.","type":"string","format":"time"},"error":{"description":"The error, if any, returned by the run.","type":"string"},"output":{"description":"A list of the outputs of this script.","type":"array","items":{"$ref":"#/definitions/Object521"}},"outputCachedOn":{"description":"The time that the output was originally exported, if a cache entry was used by the run.","type":"string","format":"time"}}},"Object577":{"type":"object","properties":{"id":{"description":"The ID of the run.","type":"integer"},"containerId":{"description":"The ID of the Container job.","type":"integer"},"state":{"description":"The state of the run, one of 'queued' 'running' 'succeeded' 'failed' or 'cancelled'.","type":"string"},"isCancelRequested":{"description":"True if run cancel requested, else false.","type":"boolean"},"createdAt":{"description":"The time the run was created.","type":"string","format":"time"},"startedAt":{"description":"The time the run started at.","type":"string","format":"time"},"finishedAt":{"description":"The time the run completed.","type":"string","format":"time"},"error":{"description":"The error, if any, returned by the run.","type":"string"},"maxMemoryUsage":{"description":"If the run has finished, the maximum amount of memory used during the run, in MB.","type":"number","format":"float"},"maxCpuUsage":{"description":"If the run has finished, the maximum amount of cpu used during the run, in millicores.","type":"number","format":"float"}}},"Object578":{"type":"object","properties":{"id":{"description":"The ID of the run.","type":"integer"},"pythonId":{"description":"The ID of the Python job.","type":"integer"},"state":{"description":"The state of the run, one of 'queued' 'running' 'succeeded' 'failed' or 'cancelled'.","type":"string"},"isCancelRequested":{"description":"True if run cancel requested, else false.","type":"boolean"},"createdAt":{"description":"The time the run was created.","type":"string","format":"time"},"startedAt":{"description":"The time the run started at.","type":"string","format":"time"},"finishedAt":{"description":"The time the run completed.","type":"string","format":"time"},"error":{"description":"The error, if any, returned by the run.","type":"string"},"maxMemoryUsage":{"description":"If the run has finished, the maximum amount of memory used during the run, in MB.","type":"number","format":"float"},"maxCpuUsage":{"description":"If the run has finished, the maximum amount of cpu used during the run, in millicores.","type":"number","format":"float"}}},"Object579":{"type":"object","properties":{"id":{"description":"The ID of the run.","type":"integer"},"rId":{"description":"The ID of the R job.","type":"integer"},"state":{"description":"The state of the run, one of 'queued' 'running' 'succeeded' 'failed' or 'cancelled'.","type":"string"},"isCancelRequested":{"description":"True if run cancel requested, else false.","type":"boolean"},"createdAt":{"description":"The time the run was created.","type":"string","format":"time"},"startedAt":{"description":"The time the run started at.","type":"string","format":"time"},"finishedAt":{"description":"The time the run completed.","type":"string","format":"time"},"error":{"description":"The error, if any, returned by the run.","type":"string"},"maxMemoryUsage":{"description":"If the run has finished, the maximum amount of memory used during the run, in MB.","type":"number","format":"float"},"maxCpuUsage":{"description":"If the run has finished, the maximum amount of cpu used during the run, in millicores.","type":"number","format":"float"}}},"Object580":{"type":"object","properties":{"id":{"description":"The ID of the run.","type":"integer"},"dbtId":{"description":"The ID of the dbt job.","type":"integer"},"state":{"description":"The state of the run, one of 'queued' 'running' 'succeeded' 'failed' or 'cancelled'.","type":"string"},"isCancelRequested":{"description":"True if run cancel requested, else false.","type":"boolean"},"createdAt":{"description":"The time the run was created.","type":"string","format":"time"},"startedAt":{"description":"The time the run started at.","type":"string","format":"time"},"finishedAt":{"description":"The time the run completed.","type":"string","format":"time"},"error":{"description":"The error, if any, returned by the run.","type":"string"},"maxMemoryUsage":{"description":"If the run has finished, the maximum amount of memory used during the run, in MB.","type":"number","format":"float"},"maxCpuUsage":{"description":"If the run has finished, the maximum amount of cpu used during the run, in millicores.","type":"number","format":"float"}}},"Object581":{"type":"object","properties":{"id":{"description":"The ID of the run.","type":"integer"},"javascriptId":{"description":"The ID of the Javascript job.","type":"integer"},"state":{"description":"The state of the run, one of 'queued' 'running' 'succeeded' 'failed' or 'cancelled'.","type":"string"},"isCancelRequested":{"description":"True if run cancel requested, else false.","type":"boolean"},"createdAt":{"description":"The time the run was created.","type":"string","format":"time"},"startedAt":{"description":"The time the run started at.","type":"string","format":"time"},"finishedAt":{"description":"The time the run completed.","type":"string","format":"time"},"error":{"description":"The error, if any, returned by the run.","type":"string"}}},"Object582":{"type":"object","properties":{"id":{"description":"The ID of the run.","type":"integer"},"customId":{"description":"The ID of the Custom job.","type":"integer"},"state":{"description":"The state of the run, one of 'queued' 'running' 'succeeded' 'failed' or 'cancelled'.","type":"string"},"isCancelRequested":{"description":"True if run cancel requested, else false.","type":"boolean"},"createdAt":{"description":"The time the run was created.","type":"string","format":"time"},"startedAt":{"description":"The time the run started at.","type":"string","format":"time"},"finishedAt":{"description":"The time the run completed.","type":"string","format":"time"},"error":{"description":"The error, if any, returned by the run.","type":"string"},"maxMemoryUsage":{"description":"If the run has finished, the maximum amount of memory used during the run, in MB. Only available if the backing script is a Python, R, or container script.","type":"number","format":"float"},"maxCpuUsage":{"description":"If the run has finished, the maximum amount of cpu used during the run, in millicores. Only available if the backing script is a Python, R, or container script.","type":"number","format":"float"}}},"Object583":{"type":"object","properties":{"objectType":{"description":"The type of the output. Valid values are File, Table, Report, Project, Credential, or JSONValue","type":"string"},"objectId":{"description":"The ID of the output.","type":"integer"},"name":{"description":"The name of the output.","type":"string"},"link":{"description":"The hypermedia link to the output.","type":"string"},"value":{"type":"string"}}},"Object584":{"type":"object","properties":{"objectType":{"description":"The type of the output. Valid values are File, Table, Report, Project, Credential, or JSONValue","type":"string"},"objectId":{"description":"The ID of the output.","type":"integer"},"name":{"description":"The name of the output.","type":"string"},"link":{"description":"The hypermedia link to the output.","type":"string"},"value":{"type":"string"}}},"Object585":{"type":"object","properties":{"objectType":{"description":"The type of the output. Valid values are File, Table, Report, Project, Credential, or JSONValue","type":"string"},"objectId":{"description":"The ID of the output.","type":"integer"}},"required":["objectType","objectId"]},"Object586":{"type":"object","properties":{"objectType":{"description":"The type of the output. Valid values are File, Table, Report, Project, Credential, or JSONValue","type":"string"},"objectId":{"description":"The ID of the output.","type":"integer"},"name":{"description":"The name of the output.","type":"string"},"link":{"description":"The hypermedia link to the output.","type":"string"},"value":{"type":"string"}}},"Object587":{"type":"object","properties":{"objectType":{"description":"The type of the output. Valid values are File, Table, Report, Project, Credential, or JSONValue","type":"string"},"objectId":{"description":"The ID of the output.","type":"integer"}},"required":["objectType","objectId"]},"Object588":{"type":"object","properties":{"objectType":{"description":"The type of the output. Valid values are File, Table, Report, Project, Credential, or JSONValue","type":"string"},"objectId":{"description":"The ID of the output.","type":"integer"},"name":{"description":"The name of the output.","type":"string"},"link":{"description":"The hypermedia link to the output.","type":"string"},"value":{"type":"string"}}},"Object589":{"type":"object","properties":{"objectType":{"description":"The type of the output. Valid values are File, Table, Report, Project, Credential, or JSONValue","type":"string"},"objectId":{"description":"The ID of the output.","type":"integer"}},"required":["objectType","objectId"]},"Object590":{"type":"object","properties":{"objectType":{"description":"The type of the output. Valid values are File, Table, Report, Project, Credential, or JSONValue","type":"string"},"objectId":{"description":"The ID of the output.","type":"integer"},"name":{"description":"The name of the output.","type":"string"},"link":{"description":"The hypermedia link to the output.","type":"string"},"value":{"type":"string"}}},"Object591":{"type":"object","properties":{"objectType":{"description":"The type of the output. Valid values are File, Table, Report, Project, Credential, or JSONValue","type":"string"},"objectId":{"description":"The ID of the output.","type":"integer"}},"required":["objectType","objectId"]},"Object592":{"type":"object","properties":{"objectType":{"description":"The type of the output. Valid values are File, Table, Report, Project, Credential, or JSONValue","type":"string"},"objectId":{"description":"The ID of the output.","type":"integer"},"name":{"description":"The name of the output.","type":"string"},"link":{"description":"The hypermedia link to the output.","type":"string"},"value":{"type":"string"}}},"Object593":{"type":"object","properties":{"objectType":{"description":"The type of the output. Valid values are File, Table, Report, Project, Credential, or JSONValue","type":"string"},"objectId":{"description":"The ID of the output.","type":"integer"}},"required":["objectType","objectId"]},"Object594":{"type":"object","properties":{"objectType":{"description":"The type of the output. Valid values are File, Table, Report, Project, Credential, or JSONValue","type":"string"},"objectId":{"description":"The ID of the output.","type":"integer"},"name":{"description":"The name of the output.","type":"string"},"link":{"description":"The hypermedia link to the output.","type":"string"},"value":{"type":"string"}}},"Object595":{"type":"object","properties":{"objectType":{"description":"The type of the output. Valid values are File, Table, Report, Project, Credential, or JSONValue","type":"string"},"objectId":{"description":"The ID of the output.","type":"integer"}},"required":["objectType","objectId"]},"Object596":{"type":"object","properties":{"error":{"description":"The error message to update","type":"string"}}},"Object597":{"type":"object","properties":{"error":{"description":"The error message to update","type":"string"}}},"Object598":{"type":"object","properties":{"error":{"description":"The error message to update","type":"string"}}},"Object599":{"type":"object","properties":{"error":{"description":"The error message to update","type":"string"}}},"Object600":{"type":"object","properties":{"error":{"description":"The error message to update","type":"string"}}},"Object601":{"type":"object","properties":{"error":{"description":"The error message to update","type":"string"}}},"Object602":{"type":"object","properties":{"userIds":{"description":"An array of one or more user IDs.","type":"array","items":{"type":"integer"}},"permissionLevel":{"description":"Options are: \"read\", \"write\", or \"manage\".","type":"string"},"shareEmailBody":{"description":"Custom body text for e-mail sent on a share.","type":"string"},"sendSharedEmail":{"description":"Send email to the recipients of a share.","type":"boolean"}},"required":["userIds","permissionLevel"]},"Object603":{"type":"object","properties":{"groupIds":{"description":"An array of one or more group IDs.","type":"array","items":{"type":"integer"}},"permissionLevel":{"description":"Options are: \"read\", \"write\", or \"manage\".","type":"string"},"shareEmailBody":{"description":"Custom body text for e-mail sent on a share.","type":"string"},"sendSharedEmail":{"description":"Send email to the recipients of a share.","type":"boolean"}},"required":["groupIds","permissionLevel"]},"Object604":{"type":"object","properties":{"userId":{"description":"ID of target user","type":"integer"},"includeDependencies":{"description":"Whether or not to give manage permissions on all dependencies","type":"boolean"},"emailBody":{"description":"Custom body text for e-mail sent on transfer.","type":"string"},"sendEmail":{"description":"Send email to the target user of the transfer?","type":"boolean"}},"required":["userId","includeDependencies"]},"Object605":{"type":"object","properties":{"status":{"description":"The desired archived status of the object.","type":"boolean"}},"required":["status"]},"Object606":{"type":"object","properties":{"userIds":{"description":"An array of one or more user IDs.","type":"array","items":{"type":"integer"}},"permissionLevel":{"description":"Options are: \"read\", \"write\", or \"manage\".","type":"string"},"shareEmailBody":{"description":"Custom body text for e-mail sent on a share.","type":"string"},"sendSharedEmail":{"description":"Send email to the recipients of a share.","type":"boolean"}},"required":["userIds","permissionLevel"]},"Object607":{"type":"object","properties":{"groupIds":{"description":"An array of one or more group IDs.","type":"array","items":{"type":"integer"}},"permissionLevel":{"description":"Options are: \"read\", \"write\", or \"manage\".","type":"string"},"shareEmailBody":{"description":"Custom body text for e-mail sent on a share.","type":"string"},"sendSharedEmail":{"description":"Send email to the recipients of a share.","type":"boolean"}},"required":["groupIds","permissionLevel"]},"Object608":{"type":"object","properties":{"userId":{"description":"ID of target user","type":"integer"},"includeDependencies":{"description":"Whether or not to give manage permissions on all dependencies","type":"boolean"},"emailBody":{"description":"Custom body text for e-mail sent on transfer.","type":"string"},"sendEmail":{"description":"Send email to the target user of the transfer?","type":"boolean"}},"required":["userId","includeDependencies"]},"Object609":{"type":"object","properties":{"status":{"description":"The desired archived status of the object.","type":"boolean"}},"required":["status"]},"Object610":{"type":"object","properties":{"userIds":{"description":"An array of one or more user IDs.","type":"array","items":{"type":"integer"}},"permissionLevel":{"description":"Options are: \"read\", \"write\", or \"manage\".","type":"string"},"shareEmailBody":{"description":"Custom body text for e-mail sent on a share.","type":"string"},"sendSharedEmail":{"description":"Send email to the recipients of a share.","type":"boolean"}},"required":["userIds","permissionLevel"]},"Object611":{"type":"object","properties":{"groupIds":{"description":"An array of one or more group IDs.","type":"array","items":{"type":"integer"}},"permissionLevel":{"description":"Options are: \"read\", \"write\", or \"manage\".","type":"string"},"shareEmailBody":{"description":"Custom body text for e-mail sent on a share.","type":"string"},"sendSharedEmail":{"description":"Send email to the recipients of a share.","type":"boolean"}},"required":["groupIds","permissionLevel"]},"Object612":{"type":"object","properties":{"userId":{"description":"ID of target user","type":"integer"},"includeDependencies":{"description":"Whether or not to give manage permissions on all dependencies","type":"boolean"},"emailBody":{"description":"Custom body text for e-mail sent on transfer.","type":"string"},"sendEmail":{"description":"Send email to the target user of the transfer?","type":"boolean"}},"required":["userId","includeDependencies"]},"Object613":{"type":"object","properties":{"status":{"description":"The desired archived status of the object.","type":"boolean"}},"required":["status"]},"Object614":{"type":"object","properties":{"userIds":{"description":"An array of one or more user IDs.","type":"array","items":{"type":"integer"}},"permissionLevel":{"description":"Options are: \"read\", \"write\", or \"manage\".","type":"string"},"shareEmailBody":{"description":"Custom body text for e-mail sent on a share.","type":"string"},"sendSharedEmail":{"description":"Send email to the recipients of a share.","type":"boolean"}},"required":["userIds","permissionLevel"]},"Object615":{"type":"object","properties":{"groupIds":{"description":"An array of one or more group IDs.","type":"array","items":{"type":"integer"}},"permissionLevel":{"description":"Options are: \"read\", \"write\", or \"manage\".","type":"string"},"shareEmailBody":{"description":"Custom body text for e-mail sent on a share.","type":"string"},"sendSharedEmail":{"description":"Send email to the recipients of a share.","type":"boolean"}},"required":["groupIds","permissionLevel"]},"Object616":{"type":"object","properties":{"userId":{"description":"ID of target user","type":"integer"},"includeDependencies":{"description":"Whether or not to give manage permissions on all dependencies","type":"boolean"},"emailBody":{"description":"Custom body text for e-mail sent on transfer.","type":"string"},"sendEmail":{"description":"Send email to the target user of the transfer?","type":"boolean"}},"required":["userId","includeDependencies"]},"Object617":{"type":"object","properties":{"status":{"description":"The desired archived status of the object.","type":"boolean"}},"required":["status"]},"Object618":{"type":"object","properties":{"userIds":{"description":"An array of one or more user IDs.","type":"array","items":{"type":"integer"}},"permissionLevel":{"description":"Options are: \"read\", \"write\", or \"manage\".","type":"string"},"shareEmailBody":{"description":"Custom body text for e-mail sent on a share.","type":"string"},"sendSharedEmail":{"description":"Send email to the recipients of a share.","type":"boolean"}},"required":["userIds","permissionLevel"]},"Object619":{"type":"object","properties":{"groupIds":{"description":"An array of one or more group IDs.","type":"array","items":{"type":"integer"}},"permissionLevel":{"description":"Options are: \"read\", \"write\", or \"manage\".","type":"string"},"shareEmailBody":{"description":"Custom body text for e-mail sent on a share.","type":"string"},"sendSharedEmail":{"description":"Send email to the recipients of a share.","type":"boolean"}},"required":["groupIds","permissionLevel"]},"Object620":{"type":"object","properties":{"userId":{"description":"ID of target user","type":"integer"},"includeDependencies":{"description":"Whether or not to give manage permissions on all dependencies","type":"boolean"},"emailBody":{"description":"Custom body text for e-mail sent on transfer.","type":"string"},"sendEmail":{"description":"Send email to the target user of the transfer?","type":"boolean"}},"required":["userId","includeDependencies"]},"Object621":{"type":"object","properties":{"status":{"description":"The desired archived status of the object.","type":"boolean"}},"required":["status"]},"Object622":{"type":"object","properties":{"userIds":{"description":"An array of one or more user IDs.","type":"array","items":{"type":"integer"}},"permissionLevel":{"description":"Options are: \"read\", \"write\", or \"manage\".","type":"string"},"shareEmailBody":{"description":"Custom body text for e-mail sent on a share.","type":"string"},"sendSharedEmail":{"description":"Send email to the recipients of a share.","type":"boolean"}},"required":["userIds","permissionLevel"]},"Object623":{"type":"object","properties":{"groupIds":{"description":"An array of one or more group IDs.","type":"array","items":{"type":"integer"}},"permissionLevel":{"description":"Options are: \"read\", \"write\", or \"manage\".","type":"string"},"shareEmailBody":{"description":"Custom body text for e-mail sent on a share.","type":"string"},"sendSharedEmail":{"description":"Send email to the recipients of a share.","type":"boolean"}},"required":["groupIds","permissionLevel"]},"Object624":{"type":"object","properties":{"userId":{"description":"ID of target user","type":"integer"},"includeDependencies":{"description":"Whether or not to give manage permissions on all dependencies","type":"boolean"},"emailBody":{"description":"Custom body text for e-mail sent on transfer.","type":"string"},"sendEmail":{"description":"Send email to the target user of the transfer?","type":"boolean"}},"required":["userId","includeDependencies"]},"Object625":{"type":"object","properties":{"status":{"description":"The desired archived status of the object.","type":"boolean"}},"required":["status"]},"Object626":{"type":"object","properties":{"userIds":{"description":"An array of one or more user IDs.","type":"array","items":{"type":"integer"}},"permissionLevel":{"description":"Options are: \"read\", \"write\", or \"manage\".","type":"string"},"shareEmailBody":{"description":"Custom body text for e-mail sent on a share.","type":"string"},"sendSharedEmail":{"description":"Send email to the recipients of a share.","type":"boolean"}},"required":["userIds","permissionLevel"]},"Object627":{"type":"object","properties":{"groupIds":{"description":"An array of one or more group IDs.","type":"array","items":{"type":"integer"}},"permissionLevel":{"description":"Options are: \"read\", \"write\", or \"manage\".","type":"string"},"shareEmailBody":{"description":"Custom body text for e-mail sent on a share.","type":"string"},"sendSharedEmail":{"description":"Send email to the recipients of a share.","type":"boolean"}},"required":["groupIds","permissionLevel"]},"Object628":{"type":"object","properties":{"userId":{"description":"ID of target user","type":"integer"},"includeDependencies":{"description":"Whether or not to give manage permissions on all dependencies","type":"boolean"},"emailBody":{"description":"Custom body text for e-mail sent on transfer.","type":"string"},"sendEmail":{"description":"Send email to the target user of the transfer?","type":"boolean"}},"required":["userId","includeDependencies"]},"Object629":{"type":"object","properties":{"status":{"description":"The desired archived status of the object.","type":"boolean"}},"required":["status"]},"Object630":{"type":"object","properties":{"cloneSchedule":{"description":"If true, also copy the schedule to the new script.","type":"boolean"},"cloneTriggers":{"description":"If true, also copy the triggers to the new script.","type":"boolean"},"cloneNotifications":{"description":"If true, also copy the notifications to the new script.","type":"boolean"}}},"Object632":{"type":"object","properties":{"score":{"description":"The relevance score from the search request.","type":"number","format":"float"},"type":{"description":"The type of the item.","type":"string"},"id":{"description":"The ID of the item.","type":"integer"},"name":{"description":"The name of the item.","type":"string"},"typeName":{"description":"The verbose name of the type.","type":"string"},"updatedAt":{"description":"The time the item was last updated.","type":"string","format":"time"},"owner":{"description":"The owner of the item.","type":"string"},"useCount":{"description":"The use count of the item, if the item is a template.","type":"integer"},"lastRunId":{"description":"The last run id of the item, if the item is a job.","type":"integer"},"lastRunState":{"description":"The last run state of the item, if the item is a job.","type":"string"},"lastRunStart":{"description":"The last run start time of the item, if the item is a job.","type":"string","format":"time"},"lastRunFinish":{"description":"The last run finish time of the item, if the item is a job.","type":"string","format":"time"},"public":{"description":"The flag that indicates a template is available to all users.","type":"boolean"},"lastRunException":{"description":"The exception of the item after the last run, if the item is a job.","type":"string"},"autoShare":{"description":"The flag that indicates if a project has Auto-Share enabled.","type":"boolean"}}},"Object631":{"type":"object","properties":{"totalResults":{"description":"The number of items matching the search query.","type":"integer"},"aggregations":{"description":"Aggregations by owner and type for the search results.","type":"object"},"results":{"description":"The items returned by the search.","type":"array","items":{"$ref":"#/definitions/Object632"}}}},"Object633":{"type":"object","properties":{"type":{"description":"The name of the item type.","type":"string"}}},"Object635":{"type":"object","properties":{"id":{"type":"integer"},"state":{"description":"The state of the run. One of queued, running, succeeded, failed, and cancelled.","type":"string"},"startedAt":{"description":"The time that the run started.","type":"string","format":"time"},"finishedAt":{"description":"The time that the run completed.","type":"string","format":"time"},"error":{"description":"The error message for this run, if present.","type":"string"}}},"Object634":{"type":"object","properties":{"id":{"description":"The query ID.","type":"integer"},"database":{"description":"The database ID.","type":"integer"},"credential":{"description":"The credential ID.","type":"integer"},"sql":{"description":"The SQL executed by the query.","type":"string"},"authorId":{"description":"The author of the query.","type":"integer"},"archived":{"description":"The archival status of the requested item(s).","type":"boolean"},"createdAt":{"type":"string","format":"time"},"updatedAt":{"type":"string","format":"time"},"lastRun":{"$ref":"#/definitions/Object635"}}},"Object637":{"type":"object","properties":{"deploymentId":{"description":"The ID for this deployment.","type":"integer"},"userId":{"description":"The ID of the owner.","type":"integer"},"host":{"description":"Domain of the deployment.","type":"string"},"name":{"description":"Name of the deployment.","type":"string"},"dockerImageName":{"description":"The name of the docker image to pull from DockerHub.","type":"string"},"dockerImageTag":{"description":"The tag of the docker image to pull from DockerHub (default: latest).","type":"string"},"instanceType":{"description":"The EC2 instance type requested for the deployment.","type":"string"},"memory":{"description":"The memory allocated to the deployment, in MB.","type":"integer"},"cpu":{"description":"The cpu allocated to the deployment, in millicores.","type":"integer"},"state":{"description":"The state of the deployment.","type":"string"},"stateMessage":{"description":"A detailed description of the state.","type":"string"},"maxMemoryUsage":{"description":"If the deployment has finished, the maximum amount of memory used during the deployment, in MB.","type":"number","format":"float"},"maxCpuUsage":{"description":"If the deployment has finished, the maximum amount of cpu used during the deployment, in millicores.","type":"number","format":"float"},"createdAt":{"type":"string","format":"time"},"updatedAt":{"type":"string","format":"time"},"serviceId":{"description":"The ID of owning Service","type":"integer"}}},"Object636":{"type":"object","properties":{"id":{"description":"The ID for this Service.","type":"integer"},"name":{"description":"The name of this Service.","type":"string"},"description":{"description":"The description of this Service.","type":"string"},"user":{"description":"The name of the author of this Service.","$ref":"#/definitions/Object33"},"type":{"description":"The type of this Service","type":"string"},"createdAt":{"type":"string","format":"time"},"updatedAt":{"type":"string","format":"time"},"gitRepoUrl":{"description":"The url for the git repo where the Service code lives.","type":"string"},"gitRepoRef":{"description":"The git reference to use when pulling code from the repo.","type":"string"},"gitPathDir":{"description":"The path to the Service code within the git repo. If unspecified, the root directory will be used.","type":"string"},"currentDeployment":{"$ref":"#/definitions/Object637"},"archived":{"description":"The archival status of the requested item(s).","type":"string"}}},"Object640":{"type":"object","properties":{"scheduledDays":{"description":"Days it is scheduled on, based on numeric value starting at 0 for Sunday","type":"array","items":{"type":"integer"}},"scheduledHours":{"description":"Hours it is scheduled on","type":"array","items":{"type":"integer"}}},"required":["scheduledDays","scheduledHours"]},"Object639":{"type":"object","properties":{"runtimePlan":{"description":"Only affects the service when deployed. On Demand means that the service will be turned on when viewed and automatically turned off after periods of inactivity. Specific Times means the service will be on when scheduled. Always On means the deployed service will always be on.","type":"string"},"recurrences":{"description":"List of day-hour combinations this item is scheduled for","type":"array","items":{"$ref":"#/definitions/Object640"}}},"required":["runtimePlan","recurrences"]},"Object641":{"type":"object","properties":{"failureEmailAddresses":{"description":"Addresses to notify by e-mail when the service fails.","type":"array","items":{"type":"string"}},"failureOn":{"description":"If failure email notifications are on","type":"boolean"}}},"Object638":{"type":"object","properties":{"name":{"description":"The name of this Service.","type":"string"},"description":{"description":"The description of this Service.","type":"string"},"type":{"description":"The type of this Service","type":"string"},"dockerImageName":{"description":"The name of the docker image to pull from DockerHub.","type":"string"},"dockerImageTag":{"description":"The tag of the docker image to pull from DockerHub (default: latest).","type":"string"},"schedule":{"description":"The schedule when the Service will run.","$ref":"#/definitions/Object639"},"replicas":{"description":"The number of Service replicas to deploy. When maxReplicas is set,\n this field defines the minimum number of replicas to deploy.","type":"integer"},"maxReplicas":{"description":"The maximum number of Service replicas to deploy. Defining this field enables autoscaling.","type":"integer"},"instanceType":{"description":"The EC2 instance type to deploy to.","type":"string"},"memory":{"description":"The amount of memory allocated to each replica of the Service.","type":"integer"},"cpu":{"description":"The amount of cpu allocated to each replica of the the Service.","type":"integer"},"credentials":{"description":"A list of credential IDs to pass to the Service.","type":"array","items":{"type":"integer"}},"permissionSetId":{"description":"The ID of the associated permission set, if any.","type":"integer"},"gitRepoUrl":{"description":"The url for the git repo where the Service code lives.","type":"string"},"gitRepoRef":{"description":"The git reference to use when pulling code from the repo.","type":"string"},"gitPathDir":{"description":"The path to the Service code within the git repo. If unspecified, the root directory will be used.","type":"string"},"environmentVariables":{"description":"Environment Variables to be passed into the Service.","type":"object","additionalProperties":{"type":"string"}},"notifications":{"description":"The notifications to send when the service fails.","$ref":"#/definitions/Object641"},"partitionLabel":{"description":"The partition label used to run this object.","type":"string"},"hidden":{"description":"The hidden status of the item.","type":"boolean"}}},"Object644":{"type":"object","properties":{"scheduledDays":{"description":"Days it is scheduled on, based on numeric value starting at 0 for Sunday","type":"array","items":{"type":"integer"}},"scheduledHours":{"description":"Hours it is scheduled on","type":"array","items":{"type":"integer"}}}},"Object643":{"type":"object","properties":{"runtimePlan":{"description":"Only affects the service when deployed. On Demand means that the service will be turned on when viewed and automatically turned off after periods of inactivity. Specific Times means the service will be on when scheduled. Always On means the deployed service will always be on.","type":"string"},"recurrences":{"description":"List of day-hour combinations this item is scheduled for","type":"array","items":{"$ref":"#/definitions/Object644"}}}},"Object645":{"type":"object","properties":{"deploymentId":{"description":"The ID for this deployment.","type":"integer"},"userId":{"description":"The ID of the owner.","type":"integer"},"host":{"description":"Domain of the deployment.","type":"string"},"name":{"description":"Name of the deployment.","type":"string"},"dockerImageName":{"description":"The name of the docker image to pull from DockerHub.","type":"string"},"dockerImageTag":{"description":"The tag of the docker image to pull from DockerHub (default: latest).","type":"string"},"displayUrl":{"description":"A signed URL for viewing the deployed item.","type":"string"},"instanceType":{"description":"The EC2 instance type requested for the deployment.","type":"string"},"memory":{"description":"The memory allocated to the deployment, in MB.","type":"integer"},"cpu":{"description":"The cpu allocated to the deployment, in millicores.","type":"integer"},"state":{"description":"The state of the deployment.","type":"string"},"stateMessage":{"description":"A detailed description of the state.","type":"string"},"maxMemoryUsage":{"description":"If the deployment has finished, the maximum amount of memory used during the deployment, in MB.","type":"number","format":"float"},"maxCpuUsage":{"description":"If the deployment has finished, the maximum amount of cpu used during the deployment, in millicores.","type":"number","format":"float"},"createdAt":{"type":"string","format":"time"},"updatedAt":{"type":"string","format":"time"},"serviceId":{"description":"The ID of owning Service","type":"integer"}}},"Object646":{"type":"object","properties":{"failureEmailAddresses":{"description":"Addresses to notify by e-mail when the service fails.","type":"array","items":{"type":"string"}},"failureOn":{"description":"If failure email notifications are on","type":"boolean"}}},"Object642":{"type":"object","properties":{"id":{"description":"The ID for this Service.","type":"integer"},"name":{"description":"The name of this Service.","type":"string"},"description":{"description":"The description of this Service.","type":"string"},"user":{"description":"The name of the author of this Service.","$ref":"#/definitions/Object33"},"type":{"description":"The type of this Service","type":"string"},"dockerImageName":{"description":"The name of the docker image to pull from DockerHub.","type":"string"},"dockerImageTag":{"description":"The tag of the docker image to pull from DockerHub (default: latest).","type":"string"},"schedule":{"description":"The schedule when the Service will run.","$ref":"#/definitions/Object643"},"timeZone":{"type":"string"},"replicas":{"description":"The number of Service replicas to deploy. When maxReplicas is set,\n this field defines the minimum number of replicas to deploy.","type":"integer"},"maxReplicas":{"description":"The maximum number of Service replicas to deploy. Defining this field enables autoscaling.","type":"integer"},"instanceType":{"description":"The EC2 instance type to deploy to.","type":"string"},"memory":{"description":"The amount of memory allocated to each replica of the Service.","type":"integer"},"cpu":{"description":"The amount of cpu allocated to each replica of the the Service.","type":"integer"},"createdAt":{"type":"string","format":"time"},"updatedAt":{"type":"string","format":"time"},"credentials":{"description":"A list of credential IDs to pass to the Service.","type":"array","items":{"type":"integer"}},"permissionSetId":{"description":"The ID of the associated permission set, if any.","type":"integer"},"gitRepoUrl":{"description":"The url for the git repo where the Service code lives.","type":"string"},"gitRepoRef":{"description":"The git reference to use when pulling code from the repo.","type":"string"},"gitPathDir":{"description":"The path to the Service code within the git repo. If unspecified, the root directory will be used.","type":"string"},"reportId":{"description":"The ID of the associated report.","type":"integer"},"currentDeployment":{"$ref":"#/definitions/Object645"},"currentUrl":{"description":"The URL that the service is hosted at.","type":"string"},"environmentVariables":{"description":"Environment Variables to be passed into the Service.","type":"object","additionalProperties":{"type":"string"}},"notifications":{"description":"The notifications to send when the service fails.","$ref":"#/definitions/Object646"},"partitionLabel":{"description":"The partition label used to run this object.","type":"string"},"myPermissionLevel":{"description":"Your permission level on the object. One of \"read\", \"write\", or \"manage\".","type":"string"},"archived":{"description":"The archival status of the requested item(s).","type":"string"},"hidden":{"description":"The hidden status of the item.","type":"boolean"}}},"Object647":{"type":"object","properties":{"name":{"description":"The name of this Service.","type":"string"},"description":{"description":"The description of this Service.","type":"string"},"dockerImageName":{"description":"The name of the docker image to pull from DockerHub.","type":"string"},"dockerImageTag":{"description":"The tag of the docker image to pull from DockerHub (default: latest).","type":"string"},"schedule":{"description":"The schedule when the Service will run.","$ref":"#/definitions/Object639"},"replicas":{"description":"The number of Service replicas to deploy. When maxReplicas is set,\n this field defines the minimum number of replicas to deploy.","type":"integer"},"maxReplicas":{"description":"The maximum number of Service replicas to deploy. Defining this field enables autoscaling.","type":"integer"},"instanceType":{"description":"The EC2 instance type to deploy to.","type":"string"},"memory":{"description":"The amount of memory allocated to each replica of the Service.","type":"integer"},"cpu":{"description":"The amount of cpu allocated to each replica of the the Service.","type":"integer"},"credentials":{"description":"A list of credential IDs to pass to the Service.","type":"array","items":{"type":"integer"}},"permissionSetId":{"description":"The ID of the associated permission set, if any.","type":"integer"},"gitRepoUrl":{"description":"The url for the git repo where the Service code lives.","type":"string"},"gitRepoRef":{"description":"The git reference to use when pulling code from the repo.","type":"string"},"gitPathDir":{"description":"The path to the Service code within the git repo. If unspecified, the root directory will be used.","type":"string"},"environmentVariables":{"description":"Environment Variables to be passed into the Service.","type":"object","additionalProperties":{"type":"string"}},"notifications":{"description":"The notifications to send when the service fails.","$ref":"#/definitions/Object641"},"partitionLabel":{"description":"The partition label used to run this object.","type":"string"}}},"Object648":{"type":"object","properties":{"userIds":{"description":"An array of one or more user IDs.","type":"array","items":{"type":"integer"}},"permissionLevel":{"description":"Options are: \"read\", \"write\", or \"manage\".","type":"string"},"shareEmailBody":{"description":"Custom body text for e-mail sent on a share.","type":"string"},"sendSharedEmail":{"description":"Send email to the recipients of a share.","type":"boolean"}},"required":["userIds","permissionLevel"]},"Object649":{"type":"object","properties":{"groupIds":{"description":"An array of one or more group IDs.","type":"array","items":{"type":"integer"}},"permissionLevel":{"description":"Options are: \"read\", \"write\", or \"manage\".","type":"string"},"shareEmailBody":{"description":"Custom body text for e-mail sent on a share.","type":"string"},"sendSharedEmail":{"description":"Send email to the recipients of a share.","type":"boolean"}},"required":["groupIds","permissionLevel"]},"Object650":{"type":"object","properties":{"userId":{"description":"ID of target user","type":"integer"},"includeDependencies":{"description":"Whether or not to give manage permissions on all dependencies","type":"boolean"},"emailBody":{"description":"Custom body text for e-mail sent on transfer.","type":"string"},"sendEmail":{"description":"Send email to the target user of the transfer?","type":"boolean"}},"required":["userId","includeDependencies"]},"Object651":{"type":"object","properties":{"status":{"description":"The desired archived status of the object.","type":"boolean"}},"required":["status"]},"Object652":{"type":"object","properties":{"deploymentId":{"description":"The ID for this deployment","type":"integer"}}},"Object655":{"type":"object","properties":{"name":{"description":"The name of the token.","type":"string"},"machineToken":{"description":"If true, create a compact token with no user information.","type":"boolean"},"expiresIn":{"description":"The number of seconds until the token should expire","type":"integer"}},"required":["name"]},"Object656":{"type":"object","properties":{"id":{"description":"The ID of the token.","type":"integer"},"name":{"description":"The name of the token.","type":"string"},"user":{"description":"The user that created the token.","$ref":"#/definitions/Object33"},"machineToken":{"description":"If true, this token is not tied to a particular user.","type":"boolean"},"expiresAt":{"description":"The date and time when the token expires.","type":"string","format":"date-time"},"createdAt":{"description":"The date and time when the token was created.","type":"string","format":"time"},"token":{"description":"The value of the token. Only returned when the token is first created.","type":"string"}}},"Object657":{"type":"object","properties":{"id":{"description":"The ID of the token.","type":"integer"},"name":{"description":"The name of the token.","type":"string"},"user":{"description":"The user that created the token.","$ref":"#/definitions/Object33"},"machineToken":{"description":"If true, this token is not tied to a particular user.","type":"boolean"},"expiresAt":{"description":"The date and time when the token expires.","type":"string","format":"date-time"},"createdAt":{"description":"The date and time when the token was created.","type":"string","format":"time"}}},"Object659":{"type":"object","properties":{"region":{"description":"The region for this storage host (ex. \"us-east-1\")","type":"string"}}},"Object658":{"type":"object","properties":{"id":{"description":"The ID of the storage host.","type":"integer"},"owner":{"description":"The user who created this storage host.","$ref":"#/definitions/Object33"},"name":{"description":"The human readable name for the storage host.","type":"string"},"provider":{"description":"The storage provider.One of: s3.","type":"string"},"bucket":{"description":"The bucket for this storage host.","type":"string"},"s3Options":{"description":"Additional s3-specific options for this storage host.","$ref":"#/definitions/Object659"}}},"Object661":{"type":"object","properties":{"region":{"description":"The region for this storage host (ex. \"us-east-1\")","type":"string"}}},"Object660":{"type":"object","properties":{"provider":{"description":"The storage provider.One of: s3.","type":"string"},"bucket":{"description":"The bucket for this storage host.","type":"string"},"s3Options":{"description":"Additional s3-specific options for this storage host.","$ref":"#/definitions/Object661"},"name":{"description":"The human readable name for the storage host.","type":"string"}},"required":["provider","bucket","name"]},"Object662":{"type":"object","properties":{"name":{"description":"The human readable name for the storage host.","type":"string"},"provider":{"description":"The storage provider.One of: s3.","type":"string"},"bucket":{"description":"The bucket for this storage host.","type":"string"},"s3Options":{"description":"Additional s3-specific options for this storage host.","$ref":"#/definitions/Object661"}},"required":["name","provider","bucket"]},"Object663":{"type":"object","properties":{"name":{"description":"The human readable name for the storage host.","type":"string"},"provider":{"description":"The storage provider.One of: s3.","type":"string"},"bucket":{"description":"The bucket for this storage host.","type":"string"},"s3Options":{"description":"Additional s3-specific options for this storage host.","$ref":"#/definitions/Object661"}}},"Object664":{"type":"object","properties":{"userIds":{"description":"An array of one or more user IDs.","type":"array","items":{"type":"integer"}},"permissionLevel":{"description":"Options are: \"read\", \"write\", or \"manage\".","type":"string"},"shareEmailBody":{"description":"Custom body text for e-mail sent on a share.","type":"string"},"sendSharedEmail":{"description":"Send email to the recipients of a share.","type":"boolean"}},"required":["userIds","permissionLevel"]},"Object665":{"type":"object","properties":{"groupIds":{"description":"An array of one or more group IDs.","type":"array","items":{"type":"integer"}},"permissionLevel":{"description":"Options are: \"read\", \"write\", or \"manage\".","type":"string"},"shareEmailBody":{"description":"Custom body text for e-mail sent on a share.","type":"string"},"sendSharedEmail":{"description":"Send email to the recipients of a share.","type":"boolean"}},"required":["groupIds","permissionLevel"]},"Object666":{"type":"object","properties":{"userId":{"description":"ID of target user","type":"integer"},"includeDependencies":{"description":"Whether or not to give manage permissions on all dependencies","type":"boolean"},"emailBody":{"description":"Custom body text for e-mail sent on transfer.","type":"string"},"sendEmail":{"description":"Send email to the target user of the transfer?","type":"boolean"}},"required":["userId","includeDependencies"]},"Object667":{"type":"object","properties":{"id":{"description":"Table Tag ID","type":"integer"},"name":{"description":"Table Tag Name","type":"string"},"tableCount":{"description":"The total number of tables associated with the tag.","type":"integer"},"user":{"description":"The creator of the table tag.","$ref":"#/definitions/Object33"}}},"Object668":{"type":"object","properties":{"name":{"description":"Table Tag Name","type":"string"}},"required":["name"]},"Object669":{"type":"object","properties":{"id":{"description":"Table Tag ID","type":"integer"},"name":{"description":"Table Tag Name","type":"string"},"createdAt":{"description":"The date the tag was created.","type":"string","format":"date-time"},"updatedAt":{"description":"The date the tag was recently updated on.","type":"string","format":"date-time"},"tableCount":{"description":"The total number of tables associated with the tag.","type":"integer"},"user":{"description":"The creator of the table tag.","$ref":"#/definitions/Object33"}}},"Object670":{"type":"object","properties":{"id":{"description":"The ID of the enhancement.","type":"integer"},"sourceTableId":{"description":"The ID of the table that was enhanced.","type":"integer"},"state":{"description":"The state of the enhancement, one of 'queued' 'running' 'succeeded' 'failed' or 'cancelled'.","type":"string"},"enhancedTableSchema":{"description":"The schema name of the table created by the enhancement.","type":"string"},"enhancedTableName":{"description":"The name of the table created by the enhancement.","type":"string"}}},"Object671":{"type":"object","properties":{"performNcoa":{"description":"Whether to update addresses for records matching the National Change of Address (NCOA) database.","type":"boolean"},"ncoaCredentialId":{"description":"Credential to use when performing NCOA updates. Required if 'performNcoa' is true.","type":"integer"},"outputLevel":{"description":"The set of fields persisted by a CASS or NCOA enhancement.For CASS enhancements, one of 'cass' or 'all.'For NCOA enhancements, one of 'cass', 'ncoa' , 'coalesced' or 'all'.By default, all fields will be returned.","type":"string"},"batchSize":{"description":"The maximum number of records processed at a time. Note that this parameter is not available to all users.","type":"integer"}}},"Object672":{"type":"object","properties":{"id":{"description":"The ID of the enhancement.","type":"integer"},"sourceTableId":{"description":"The ID of the table that was enhanced.","type":"integer"},"state":{"description":"The state of the enhancement, one of 'queued' 'running' 'succeeded' 'failed' or 'cancelled'.","type":"string"},"enhancedTableSchema":{"description":"The schema name of the table created by the enhancement.","type":"string"},"enhancedTableName":{"description":"The name of the table created by the enhancement.","type":"string"},"performNcoa":{"description":"Whether to update addresses for records matching the National Change of Address (NCOA) database.","type":"boolean"},"ncoaCredentialId":{"description":"Credential to use when performing NCOA updates. Required if 'performNcoa' is true.","type":"integer"},"outputLevel":{"description":"The set of fields persisted by a CASS or NCOA enhancement.For CASS enhancements, one of 'cass' or 'all.'For NCOA enhancements, one of 'cass', 'ncoa' , 'coalesced' or 'all'.By default, all fields will be returned.","type":"string"},"batchSize":{"description":"The maximum number of records processed at a time. Note that this parameter is not available to all users.","type":"integer"}}},"Object673":{"type":"object","properties":{"databaseId":{"description":"The ID of the database.","type":"integer"},"schema":{"description":"The name of the schema containing the table.","type":"string"},"tableName":{"description":"The name of the table.","type":"string"},"statsPriority":{"description":"When to sync table statistics. Valid Options are the following. Option: 'flag' means to flag stats for the next scheduled run of a full table scan on the database. Option: 'block' means to block this job on stats syncing. Option: 'queue' means to queue a separate job for syncing stats and do not block this job on the queued job. Defaults to 'flag'","type":"string"}},"required":["databaseId","schema","tableName"]},"Object674":{"type":"object","properties":{"jobId":{"description":"The ID of the job created.","type":"integer"},"runId":{"description":"The ID of the run created.","type":"integer"}}},"Object675":{"type":"object","properties":{"ontologyMapping":{"description":"The ontology-key to column-name mapping. See /ontology for the list of valid ontology keys.","type":"object","additionalProperties":{"type":"string"}},"description":{"description":"The user-defined description of the table.","type":"string"},"primaryKeys":{"description":"A list of column(s) which together uniquely identify a row in the data.These columns must not contain NULL values.","type":"array","items":{"type":"string"}},"lastModifiedKeys":{"description":"The columns indicating when a row was last modified.","type":"array","items":{"type":"string"}}}},"Object676":{"type":"object","properties":{"id":{"description":"The ID of the table.","type":"integer"},"databaseId":{"description":"The ID of the database.","type":"integer"},"schema":{"description":"The name of the schema containing the table.","type":"string"},"name":{"description":"Name of the table.","type":"string"},"description":{"description":"The description of the table, as specified by the table owner","type":"string"},"isView":{"description":"True if this table represents a view. False if it represents a regular table.","type":"boolean"},"rowCount":{"description":"The number of rows in the table.","type":"integer"},"columnCount":{"description":"The number of columns in the table.","type":"integer"},"sizeMb":{"description":"The size of the table in megabytes.","type":"number","format":"float"},"owner":{"description":"The database username of the table's owner.","type":"string"},"distkey":{"description":"The column used as the Amazon Redshift distkey.","type":"string"},"sortkeys":{"description":"The column used as the Amazon Redshift sortkey.","type":"string"},"refreshStatus":{"description":"How up-to-date the table's statistics on row counts, null counts, distinct counts, and values distributions are. One of: refreshing, stale, or current.","type":"string"},"lastRefresh":{"description":"The time of the last statistics refresh.","type":"string","format":"date-time"},"dataUpdatedAt":{"description":"The last time that Civis Platform captured a change in this table.Only applicable for Redshift tables; please see the Civis help desk for more info.","type":"string","format":"date-time"},"schemaUpdatedAt":{"description":"The last time that Civis Platform captured a change to the table attributes/structure.Only applicable for Redshift tables; please see the Civis help desk for more info.","type":"string","format":"date-time"},"refreshId":{"description":"The ID of the most recent statistics refresh.","type":"string"},"lastRun":{"description":"The last run of a refresh on this table.","$ref":"#/definitions/Object74"},"primaryKeys":{"description":"The primary keys for this table.","type":"array","items":{"type":"string"}},"lastModifiedKeys":{"description":"The columns indicating an entry's modification status for this table.","type":"array","items":{"type":"string"}},"tableTags":{"description":"The table tags associated with this table.","type":"array","items":{"$ref":"#/definitions/Object75"}},"ontologyMapping":{"description":"The ontology-key to column-name mapping. See /ontology for the list of valid ontology keys.","type":"object","additionalProperties":{"type":"string"}}}},"Object677":{"type":"object","properties":{"id":{"description":"The ID of the table.","type":"integer"},"tableTagId":{"description":"The ID of the tag.","type":"integer"}}},"Object678":{"type":"object","properties":{"userIds":{"description":"An array of one or more user IDs.","type":"array","items":{"type":"integer"}},"permissionLevel":{"description":"Options are: \"read\", \"write\", or \"manage\".","type":"string"},"shareEmailBody":{"description":"Custom body text for e-mail sent on a share.","type":"string"},"sendSharedEmail":{"description":"Send email to the recipients of a share.","type":"boolean"}},"required":["userIds","permissionLevel"]},"Object679":{"type":"object","properties":{"groupIds":{"description":"An array of one or more group IDs.","type":"array","items":{"type":"integer"}},"permissionLevel":{"description":"Options are: \"read\", \"write\", or \"manage\".","type":"string"},"shareEmailBody":{"description":"Custom body text for e-mail sent on a share.","type":"string"},"sendSharedEmail":{"description":"Send email to the recipients of a share.","type":"boolean"}},"required":["groupIds","permissionLevel"]},"Object680":{"type":"object","properties":{"userId":{"description":"ID of target user","type":"integer"},"includeDependencies":{"description":"Whether or not to give manage permissions on all dependencies","type":"boolean"},"emailBody":{"description":"Custom body text for e-mail sent on transfer.","type":"string"},"sendEmail":{"description":"Send email to the target user of the transfer?","type":"boolean"}},"required":["userId","includeDependencies"]},"Object681":{"type":"object","properties":{"id":{"type":"integer"},"name":{"description":"The name of the template.","type":"string"},"category":{"description":"The category of this report template. Can be left blank. Acceptable values are: dataset-viz","type":"string"},"createdAt":{"type":"string","format":"time"},"updatedAt":{"type":"string","format":"time"},"useCount":{"description":"The number of uses of this template.","type":"integer"},"archived":{"description":"Whether the template has been archived.","type":"boolean"},"techReviewed":{"description":"Whether this template has been audited by Civis for security vulnerability and correctness.","type":"boolean"},"author":{"description":"The author/owner of the item.","$ref":"#/definitions/Object33"}}},"Object682":{"type":"object","properties":{"name":{"description":"The name of the template.","type":"string"},"category":{"description":"The category of this report template. Can be left blank. Acceptable values are: dataset-viz","type":"string"},"archived":{"description":"Whether the template has been archived.","type":"boolean"},"codeBody":{"description":"The code for the Template body.","type":"string"},"provideAPIKey":{"description":"Whether reports based on this template request an API Key from the report viewer.","type":"boolean"},"hidden":{"description":"The hidden status of the item.","type":"boolean"}},"required":["name","codeBody"]},"Object683":{"type":"object","properties":{"id":{"type":"integer"},"name":{"description":"The name of the template.","type":"string"},"category":{"description":"The category of this report template. Can be left blank. Acceptable values are: dataset-viz","type":"string"},"createdAt":{"type":"string","format":"time"},"updatedAt":{"type":"string","format":"time"},"useCount":{"description":"The number of uses of this template.","type":"integer"},"archived":{"description":"Whether the template has been archived.","type":"boolean"},"techReviewed":{"description":"Whether this template has been audited by Civis for security vulnerability and correctness.","type":"boolean"},"author":{"description":"The author/owner of the item.","$ref":"#/definitions/Object33"},"authCodeUrl":{"description":"A URL to the template's stored code body.","type":"string"},"provideAPIKey":{"description":"Whether reports based on this template request an API Key from the report viewer.","type":"boolean"},"hidden":{"description":"The hidden status of the item.","type":"boolean"}}},"Object684":{"type":"object","properties":{"name":{"description":"The name of the template.","type":"string"},"category":{"description":"The category of this report template. Can be left blank. Acceptable values are: dataset-viz","type":"string"},"archived":{"description":"Whether the template has been archived.","type":"boolean"},"codeBody":{"description":"The code for the Template body.","type":"string"},"provideAPIKey":{"description":"Whether reports based on this template request an API Key from the report viewer.","type":"boolean"}},"required":["name","codeBody"]},"Object685":{"type":"object","properties":{"name":{"description":"The name of the template.","type":"string"},"category":{"description":"The category of this report template. Can be left blank. Acceptable values are: dataset-viz","type":"string"},"archived":{"description":"Whether the template has been archived.","type":"boolean"},"codeBody":{"description":"The code for the Template body.","type":"string"},"provideAPIKey":{"description":"Whether reports based on this template request an API Key from the report viewer.","type":"boolean"}}},"Object687":{"type":"object","properties":{"userIds":{"description":"An array of one or more user IDs.","type":"array","items":{"type":"integer"}},"permissionLevel":{"description":"Options are: \"read\", \"write\", or \"manage\".","type":"string"},"shareEmailBody":{"description":"Custom body text for e-mail sent on a share.","type":"string"},"sendSharedEmail":{"description":"Send email to the recipients of a share.","type":"boolean"}},"required":["userIds","permissionLevel"]},"Object688":{"type":"object","properties":{"groupIds":{"description":"An array of one or more group IDs.","type":"array","items":{"type":"integer"}},"permissionLevel":{"description":"Options are: \"read\", \"write\", or \"manage\".","type":"string"},"shareEmailBody":{"description":"Custom body text for e-mail sent on a share.","type":"string"},"sendSharedEmail":{"description":"Send email to the recipients of a share.","type":"boolean"}},"required":["groupIds","permissionLevel"]},"Object689":{"type":"object","properties":{"userId":{"description":"ID of target user","type":"integer"},"includeDependencies":{"description":"Whether or not to give manage permissions on all dependencies","type":"boolean"},"emailBody":{"description":"Custom body text for e-mail sent on transfer.","type":"string"},"sendEmail":{"description":"Send email to the target user of the transfer?","type":"boolean"}},"required":["userId","includeDependencies"]},"Object690":{"type":"object","properties":{"id":{"type":"integer"},"public":{"description":"If the template is public or not.","type":"boolean"},"scriptId":{"description":"The id of the script that this template uses.","type":"integer"},"userContext":{"description":"The user context of the script that this template uses.","type":"string"},"name":{"description":"The name of the template.","type":"string"},"category":{"description":"The category of this template.","type":"string"},"createdAt":{"type":"string","format":"time"},"updatedAt":{"type":"string","format":"time"},"useCount":{"description":"The number of uses of this template.","type":"integer"},"uiReportId":{"description":"The id of the report that this template uses.","type":"integer"},"techReviewed":{"description":"Whether this template has been audited by Civis for security vulnerability and correctness.","type":"boolean"},"archived":{"description":"Whether the template has been archived.","type":"boolean"},"author":{"description":"The author/owner of the item.","$ref":"#/definitions/Object33"}}},"Object691":{"type":"object","properties":{"scriptId":{"description":"The id of the script that this template uses.","type":"integer"},"name":{"description":"The name of the template.","type":"string"},"note":{"description":"A note describing what this template is used for; custom scripts created off this template will display this description.","type":"string"},"uiReportId":{"description":"The id of the report that this template uses.","type":"integer"},"archived":{"description":"Whether the template has been archived.","type":"boolean"},"hidden":{"description":"The hidden status of the item.","type":"boolean"}},"required":["scriptId","name"]},"Object692":{"type":"object","properties":{"id":{"type":"integer"},"public":{"description":"If the template is public or not.","type":"boolean"},"scriptId":{"description":"The id of the script that this template uses.","type":"integer"},"scriptType":{"description":"The type of the template's backing script (e.g SQL, Container, Python, R, JavaScript)","type":"string"},"userContext":{"description":"The user context of the script that this template uses.","type":"string"},"params":{"description":"A definition of the parameters that this template's backing script accepts in the arguments field.","type":"array","items":{"$ref":"#/definitions/Object526"}},"name":{"description":"The name of the template.","type":"string"},"category":{"description":"The category of this template.","type":"string"},"note":{"description":"A note describing what this template is used for; custom scripts created off this template will display this description.","type":"string"},"createdAt":{"type":"string","format":"time"},"updatedAt":{"type":"string","format":"time"},"useCount":{"description":"The number of uses of this template.","type":"integer"},"uiReportId":{"description":"The id of the report that this template uses.","type":"integer"},"techReviewed":{"description":"Whether this template has been audited by Civis for security vulnerability and correctness.","type":"boolean"},"archived":{"description":"Whether the template has been archived.","type":"boolean"},"hidden":{"description":"The hidden status of the item.","type":"boolean"},"author":{"description":"The author/owner of the item.","$ref":"#/definitions/Object33"},"myPermissionLevel":{"description":"Your permission level on the object. One of \"read\", \"write\", or \"manage\".","type":"string"}}},"Object693":{"type":"object","properties":{"name":{"description":"The name of the template.","type":"string"},"note":{"description":"A note describing what this template is used for; custom scripts created off this template will display this description.","type":"string"},"uiReportId":{"description":"The id of the report that this template uses.","type":"integer"},"archived":{"description":"Whether the template has been archived.","type":"boolean"}},"required":["name"]},"Object694":{"type":"object","properties":{"name":{"description":"The name of the template.","type":"string"},"note":{"description":"A note describing what this template is used for; custom scripts created off this template will display this description.","type":"string"},"uiReportId":{"description":"The id of the report that this template uses.","type":"integer"},"archived":{"description":"Whether the template has been archived.","type":"boolean"}}},"Object695":{"type":"object","properties":{"runId":{"description":"The ID of the run which contributed this usage.","type":"integer"},"jobId":{"description":"The ID of the job which contributed this usage.","type":"integer"},"userId":{"description":"The ID of the user who contributed this usage.","type":"integer"},"organizationId":{"description":"The organization of the user who contributed this usage.","type":"integer"},"runCreatedAt":{"description":"When the run was created at.","type":"string","format":"date-time"},"runTime":{"description":"The duration of the run in seconds.","type":"integer"},"numRecords":{"description":"The number of records matched by the run.","type":"integer"},"task":{"description":"The type of matching job contributing to this usage. One of [\"IDR\", \"CDM\"].","type":"string"}}},"Object698":{"type":"object","properties":{"id":{"description":"The ID of the usage statistic to get.","type":"integer"},"runId":{"description":"The ID of the run which contributed this usage.","type":"integer"},"jobId":{"description":"The ID of the job which contributed this usage.","type":"integer"},"userId":{"description":"The ID of the user who contributed this usage.","type":"integer"},"organizationId":{"description":"The organization of the user who contributed this usage.","type":"integer"},"runCreatedAt":{"description":"When the run was created at.","type":"string","format":"date-time"},"runTime":{"description":"The duration of the run in seconds.","type":"integer"},"credits":{"description":"The number of credits used.","type":"number","format":"float"},"inputTokens":{"description":"The number of tokens input to the run.","type":"integer"},"outputTokens":{"description":"The number of tokens output from the run.","type":"integer"},"modelId":{"description":"The ID of the LLM model used.","type":"string"}}},"Object701":{"type":"object","properties":{"credits":{"description":"The number of credits used.","type":"number","format":"float"},"organizationId":{"description":"The organization for which LLM usage statistics are summarized.","type":"integer"}}},"Object702":{"type":"object","properties":{"id":{"description":"The ID for the limit.","type":"integer"},"organizationId":{"description":"The ID of the organization to which this limit belongs.","type":"integer"},"createdAt":{"description":"The time this limit was created.","type":"string","format":"time"},"updatedAt":{"description":"The time the limit was last updated.","type":"string","format":"time"},"hardLimit":{"description":"The limit value. One of 50000000, 200000000, 500000000, 1000000000, and 2000000000.","type":"integer"},"task":{"description":"The category of this limit. One of 'IDR' or 'CDM'.","type":"string"},"notificationEmails":{"description":"Addresses to notify by e-mail when the limit is reached.","type":"array","items":{"type":"string"}}}},"Object705":{"type":"object","properties":{"id":{"description":"The ID for the limit.","type":"integer"},"organizationId":{"description":"The ID of the organization to which this limit belongs.","type":"integer"},"createdAt":{"description":"The time this limit was created.","type":"string","format":"time"},"updatedAt":{"description":"The time the limit was last updated.","type":"string","format":"time"},"hardLimit":{"description":"The limit value. One of 1000, 10000, 50000, and 100000.","type":"integer"}}},"Object708":{"type":"object","properties":{"id":{"description":"The ID of this group.","type":"integer"},"name":{"description":"The name of this group.","type":"string"},"slug":{"description":"The slug of this group.","type":"string"},"organizationId":{"description":"The ID of the organization associated with this group.","type":"integer"},"organizationName":{"description":"The name of the organization associated with this group.","type":"string"}}},"Object707":{"type":"object","properties":{"id":{"description":"The ID of this user.","type":"integer"},"user":{"description":"The username of this user.","type":"string"},"name":{"description":"The name of this user.","type":"string"},"email":{"description":"The email of this user.","type":"string"},"active":{"description":"Whether this user account is active or deactivated.","type":"boolean"},"primaryGroupId":{"description":"The ID of the primary group of this user.","type":"integer"},"groups":{"description":"An array of all the groups this user is in.","type":"array","items":{"$ref":"#/definitions/Object708"}},"createdAt":{"description":"The date and time when the user was created.","type":"string","format":"date-time"},"currentSignInAt":{"description":"The date and time when the user's current session began.","type":"string","format":"date-time"},"updatedAt":{"description":"The date and time when the user was last updated.","type":"string","format":"date-time"},"lastSeenAt":{"description":"The date and time when the user last visited Platform.","type":"string","format":"date-time"},"suspended":{"description":"Whether the user is suspended due to inactivity.","type":"boolean"},"createdById":{"description":"The ID of the user who created this user.","type":"integer"},"lastUpdatedById":{"description":"The ID of the user who last updated this user.","type":"integer"}}},"Object709":{"type":"object","properties":{"name":{"description":"The name of this user.","type":"string"},"email":{"description":"The email of this user.","type":"string"},"active":{"description":"Whether this user account is active or deactivated.","type":"boolean"},"primaryGroupId":{"description":"The ID of the primary group of this user.","type":"integer"},"city":{"description":"The city of this user.","type":"string"},"state":{"description":"The state of this user.","type":"string"},"timeZone":{"description":"The time zone of this user.","type":"string"},"initials":{"description":"The initials of this user.","type":"string"},"department":{"description":"The department of this user.","type":"string"},"title":{"description":"The title of this user.","type":"string"},"prefersSmsOtp":{"description":"The preference for phone authorization of this user","type":"boolean"},"groupIds":{"description":"An array of ids of all the groups this user is in.","type":"array","items":{"type":"integer"}},"vpnEnabled":{"description":"The availability of vpn for this user.","type":"boolean"},"ssoDisabled":{"description":"The availability of SSO for this user.","type":"boolean"},"otpRequiredForLogin":{"description":"The two factor authentication requirement for this user.","type":"boolean"},"exemptFromOrgSmsOtpDisabled":{"description":"Whether the user has SMS OTP enabled on an individual level. This field does not matter if the org does not have SMS OTP disabled.","type":"boolean"},"robot":{"description":"Whether the user is a robot.","type":"boolean"},"user":{"description":"The username of this user.","type":"string"},"sendEmail":{"description":"Whether the user will receive a welcome email. Defaults to false.","type":"boolean"}},"required":["name","email","primaryGroupId","user"]},"Object710":{"type":"object","properties":{"id":{"description":"The ID of this user.","type":"integer"},"user":{"description":"The username of this user.","type":"string"},"name":{"description":"The name of this user.","type":"string"},"email":{"description":"The email of this user.","type":"string"},"active":{"description":"Whether this user account is active or deactivated.","type":"boolean"},"primaryGroupId":{"description":"The ID of the primary group of this user.","type":"integer"},"groups":{"description":"An array of all the groups this user is in.","type":"array","items":{"$ref":"#/definitions/Object708"}},"city":{"description":"The city of this user.","type":"string"},"state":{"description":"The state of this user.","type":"string"},"timeZone":{"description":"The time zone of this user.","type":"string"},"initials":{"description":"The initials of this user.","type":"string"},"department":{"description":"The department of this user.","type":"string"},"title":{"description":"The title of this user.","type":"string"},"githubUsername":{"description":"The GitHub username of this user.","type":"string"},"prefersSmsOtp":{"description":"The preference for phone authorization of this user","type":"boolean"},"vpnEnabled":{"description":"The availability of vpn for this user.","type":"boolean"},"ssoDisabled":{"description":"The availability of SSO for this user.","type":"boolean"},"otpRequiredForLogin":{"description":"The two factor authentication requirement for this user.","type":"boolean"},"exemptFromOrgSmsOtpDisabled":{"description":"Whether the user has SMS OTP enabled on an individual level. This field does not matter if the org does not have SMS OTP disabled.","type":"boolean"},"smsOtpAllowed":{"description":"Whether the user is allowed to receive two factor authentication codes via SMS.","type":"boolean"},"robot":{"description":"Whether the user is a robot.","type":"boolean"},"phone":{"description":"The phone number of this user.","type":"string"},"organizationSlug":{"description":"The slug of the organization the user belongs to.","type":"string"},"organizationSSODisableCapable":{"description":"The user's organization's ability to disable sso for their users.","type":"boolean"},"organizationLoginType":{"description":"The user's organization's login type.","type":"string"},"organizationSmsOtpDisabled":{"description":"Whether the user's organization has SMS OTP disabled.","type":"boolean"},"myPermissionLevel":{"description":"Your permission level on the object. One of \"read\", \"write\", or \"manage\".","type":"string"},"createdAt":{"description":"The date and time when the user was created.","type":"string","format":"date-time"},"updatedAt":{"description":"The date and time when the user was last updated.","type":"string","format":"date-time"},"lastSeenAt":{"description":"The date and time when the user last visited Platform.","type":"string","format":"date-time"},"suspended":{"description":"Whether the user is suspended due to inactivity.","type":"boolean"},"createdById":{"description":"The ID of the user who created this user.","type":"integer"},"lastUpdatedById":{"description":"The ID of the user who last updated this user.","type":"integer"},"unconfirmedEmail":{"description":"The new email address awaiting confirmation from the user.","type":"string"},"accountStatus":{"description":"Account status of this user. One of: \"Active\", \"Deactivated\", \"Suspended\", \"Unsuspended\"","type":"string"}}},"Object711":{"type":"object","properties":{"id":{"description":"The ID of this user.","type":"integer"},"name":{"description":"This user's name.","type":"string"},"email":{"description":"This user's email address.","type":"string"},"username":{"description":"This user's username.","type":"string"},"initials":{"description":"This user's initials.","type":"string"},"lastCheckedAnnouncements":{"description":"The date and time at which the user last checked their announcements.","type":"string","format":"date-time"},"featureFlags":{"description":"The feature flag settings for this user.","type":"object","additionalProperties":{"type":"boolean"}},"roles":{"description":"The roles this user has, listed by slug.","type":"array","items":{"type":"string"}},"preferences":{"description":"This user's preferences.","type":"object","additionalProperties":{"type":"string"}},"customBranding":{"description":"The branding of Platform for this user.","type":"string"},"primaryGroupId":{"description":"The ID of the primary group of this user.","type":"integer"},"groups":{"description":"An array of all the groups this user is in.","type":"array","items":{"$ref":"#/definitions/Object708"}},"organizationName":{"description":"The name of the organization the user belongs to.","type":"string"},"organizationSlug":{"description":"The slug of the organization the user belongs to.","type":"string"},"organizationDefaultThemeId":{"description":"The ID of the organizations's default theme.","type":"integer"},"createdAt":{"description":"The date and time when the user was created.","type":"string","format":"date-time"},"signInCount":{"description":"The number of times the user has signed in.","type":"integer"},"assumingRole":{"description":"Whether the user is assuming this role or not.","type":"boolean"},"assumingAdmin":{"description":"Whether the user is assuming admin.","type":"boolean"},"assumingAdminExpiration":{"description":"When the user's admin role is set to expire.","type":"string","format":"date-time"},"superadminModeExpiration":{"description":"The user is in superadmin mode when set to a DateTime. The user is not in superadmin mode when set to null.","type":"string","format":"date-time"},"disableNonCompliantFedrampFeatures":{"description":"Whether to disable non-compliant fedramp features.","type":"boolean"},"personaRole":{"description":"The high-level role representing the current user's main permissions.","type":"string"},"createdById":{"description":"The ID of the user who created this user.","type":"integer"},"lastUpdatedById":{"description":"The ID of the user who last updated this user.","type":"integer"}}},"Object714":{"type":"object","properties":{"id":{"description":"The ID of the object.","type":"string"},"name":{"description":"The name of the object.","type":"string"},"type":{"description":"The type of the object.","type":"string"},"user":{"description":"The user associated with the object.","type":"string"},"category":{"description":"The job category, if the object is a job.","type":"string"},"state":{"description":"The state of the object. One of \"succeeded\", \"failed\", or \"running\".","type":"string"},"updatedAt":{"description":"When the object was last updated.","type":"string","format":"date-time"},"nextRunAt":{"description":"When the job is next scheduled to run, if the object is a job.","type":"string","format":"date-time"},"lastRunId":{"description":"The ID of the last run, if the object is a job.","type":"string"},"lastRunState":{"description":"The state of the last run, if the object is a job. One of \"succeeded\", \"failed\", or \"running\".","type":"string"}}},"Object715":{"type":"object","properties":{"id":{"description":"The ID of this user.","type":"integer"},"name":{"description":"This user's name.","type":"string"},"username":{"description":"This user's username.","type":"string"},"initials":{"description":"This user's initials.","type":"string"},"online":{"description":"Whether this user is online.","type":"boolean"},"email":{"description":"This user's email address.","type":"string"}}},"Object716":{"type":"object","properties":{"id":{"description":"The ID of this theme.","type":"integer"},"name":{"description":"The name of this theme.","type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}}},"Object717":{"type":"object","properties":{"id":{"description":"The ID of the API key.","type":"integer"},"name":{"description":"The name of the API key.","type":"string"},"expiresAt":{"description":"The date and time when the key expired.","type":"string","format":"date-time"},"createdAt":{"description":"The date and time when the key was created.","type":"string","format":"date-time"},"revokedAt":{"description":"The date and time when the key was revoked.","type":"string","format":"date-time"},"lastUsedAt":{"description":"The date and time when the key was last used.","type":"string","format":"date-time"},"scopes":{"description":"The scopes which the key is permissioned on.","type":"array","items":{"type":"string"}},"useCount":{"description":"The number of times the key has been used.","type":"integer"},"expired":{"description":"True if the key has expired.","type":"boolean"},"active":{"description":"True if the key has neither expired nor been revoked.","type":"boolean"},"constraintCount":{"description":"The number of constraints on the created key","type":"integer"}}},"Object719":{"type":"object","properties":{"constraint":{"description":"The path matcher of the constraint.","type":"string"},"constraintType":{"description":"The type of constraint (exact/prefix/regex/verb).","type":"string"},"getAllowed":{"description":"Whether the constraint allows GET requests.","type":"boolean"},"headAllowed":{"description":"Whether the constraint allows HEAD requests.","type":"boolean"},"postAllowed":{"description":"Whether the constraint allows POST requests.","type":"boolean"},"putAllowed":{"description":"Whether the constraint allows PUT requests.","type":"boolean"},"patchAllowed":{"description":"Whether the constraint allows PATCH requests.","type":"boolean"},"deleteAllowed":{"description":"Whether the constraint allows DELETE requests.","type":"boolean"}},"required":["constraintType"]},"Object718":{"type":"object","properties":{"expiresIn":{"description":"The number of seconds the key should last for.","type":"integer"},"constraints":{"description":"Constraints on the abilities of the created key.","type":"array","items":{"$ref":"#/definitions/Object719"}},"name":{"description":"The name of the API key.","type":"string"}},"required":["expiresIn","name"]},"Object721":{"type":"object","properties":{"constraint":{"description":"The path matcher of the constraint.","type":"string"},"constraintType":{"description":"The type of constraint (exact/prefix/regex/verb).","type":"string"},"getAllowed":{"description":"Whether the constraint allows GET requests.","type":"boolean"},"headAllowed":{"description":"Whether the constraint allows HEAD requests.","type":"boolean"},"postAllowed":{"description":"Whether the constraint allows POST requests.","type":"boolean"},"putAllowed":{"description":"Whether the constraint allows PUT requests.","type":"boolean"},"patchAllowed":{"description":"Whether the constraint allows PATCH requests.","type":"boolean"},"deleteAllowed":{"description":"Whether the constraint allows DELETE requests.","type":"boolean"}}},"Object720":{"type":"object","properties":{"id":{"description":"The ID of the API key.","type":"integer"},"name":{"description":"The name of the API key.","type":"string"},"expiresAt":{"description":"The date and time when the key expired.","type":"string","format":"date-time"},"createdAt":{"description":"The date and time when the key was created.","type":"string","format":"date-time"},"revokedAt":{"description":"The date and time when the key was revoked.","type":"string","format":"date-time"},"lastUsedAt":{"description":"The date and time when the key was last used.","type":"string","format":"date-time"},"scopes":{"description":"The scopes which the key is permissioned on.","type":"array","items":{"type":"string"}},"useCount":{"description":"The number of times the key has been used.","type":"integer"},"expired":{"description":"True if the key has expired.","type":"boolean"},"active":{"description":"True if the key has neither expired nor been revoked.","type":"boolean"},"constraints":{"description":"Constraints on the abilities of the created key","type":"array","items":{"$ref":"#/definitions/Object721"}},"token":{"description":"The API key.","type":"string"}}},"Object723":{"type":"object","properties":{"id":{"description":"The ID of the API key.","type":"integer"},"name":{"description":"The name of the API key.","type":"string"},"expiresAt":{"description":"The date and time when the key expired.","type":"string","format":"date-time"},"createdAt":{"description":"The date and time when the key was created.","type":"string","format":"date-time"},"revokedAt":{"description":"The date and time when the key was revoked.","type":"string","format":"date-time"},"lastUsedAt":{"description":"The date and time when the key was last used.","type":"string","format":"date-time"},"scopes":{"description":"The scopes which the key is permissioned on.","type":"array","items":{"type":"string"}},"useCount":{"description":"The number of times the key has been used.","type":"integer"},"expired":{"description":"True if the key has expired.","type":"boolean"},"active":{"description":"True if the key has neither expired nor been revoked.","type":"boolean"},"constraints":{"description":"Constraints on the abilities of the created key","type":"array","items":{"$ref":"#/definitions/Object721"}}}},"Object725":{"type":"object","properties":{"appIndexOrderField":{"description":"This attribute is deprecated","type":"string"},"appIndexOrderDir":{"description":"This attribute is deprecated","type":"string"},"resultIndexOrderField":{"description":"Order field for the reports index page.","type":"string"},"resultIndexOrderDir":{"description":"Order direction for the reports index page.","type":"string"},"resultIndexTypeFilter":{"description":"Type filter for the reports index page.","type":"string"},"resultIndexAuthorFilter":{"description":"Author filter for the reports index page.","type":"string"},"resultIndexArchivedFilter":{"description":"Archived filter for the reports index page.","type":"string"},"importIndexOrderField":{"description":"Order field for the imports index page.","type":"string"},"importIndexOrderDir":{"description":"Order direction for the imports index page.","type":"string"},"importIndexTypeFilter":{"description":"Type filter for the imports index page.","type":"string"},"importIndexAuthorFilter":{"description":"Author filter for the imports index page.","type":"string"},"importIndexDestFilter":{"description":"Destination filter for the imports index page.","type":"string"},"importIndexStatusFilter":{"description":"Status filter for the imports index page.","type":"string"},"importIndexArchivedFilter":{"description":"Archived filter for the imports index page.","type":"string"},"exportIndexOrderField":{"description":"Order field for the exports index page.","type":"string"},"exportIndexOrderDir":{"description":"Order direction for the exports index page.","type":"string"},"exportIndexTypeFilter":{"description":"Type filter for the exports index page.","type":"string"},"exportIndexAuthorFilter":{"description":"Author filter for the exports index page.","type":"string"},"exportIndexStatusFilter":{"description":"Status filter for the exports index page.","type":"string"},"modelIndexOrderField":{"description":"Order field for the models index page.","type":"string"},"modelIndexOrderDir":{"description":"Order direction for the models index page.","type":"string"},"modelIndexAuthorFilter":{"description":"Author filter for the models index page.","type":"string"},"modelIndexStatusFilter":{"description":"Status filter for the models index page.","type":"string"},"modelIndexArchivedFilter":{"description":"Archived filter for the models index page.","type":"string"},"modelIndexThumbnailView":{"description":"Thumbnail view for the models index page.","type":"string"},"scriptIndexOrderField":{"description":"Order field for the scripts index page.","type":"string"},"scriptIndexOrderDir":{"description":"Order direction for the scripts index page.","type":"string"},"scriptIndexTypeFilter":{"description":"Type filter for the scripts index page.","type":"string"},"scriptIndexAuthorFilter":{"description":"Author filter for the scripts index page.","type":"string"},"scriptIndexStatusFilter":{"description":"Status filter for the scripts index page.","type":"string"},"scriptIndexArchivedFilter":{"description":"Archived filter for the scripts index page.","type":"string"},"projectIndexOrderField":{"description":"Order field for the projects index page.","type":"string"},"projectIndexOrderDir":{"description":"Order direction for the projects index page.","type":"string"},"projectIndexAuthorFilter":{"description":"Author filter for the projects index page.","type":"string"},"projectIndexArchivedFilter":{"description":"Archived filter for the projects index page.","type":"string"},"reportIndexThumbnailView":{"description":"Thumbnail view for the reports index page.","type":"string"},"projectDetailOrderField":{"description":"Order field for projects detail pages.","type":"string"},"projectDetailOrderDir":{"description":"Order direction for projects detail pages.","type":"string"},"projectDetailAuthorFilter":{"description":"Author filter for projects detail pages.","type":"string"},"projectDetailTypeFilter":{"description":"Type filter for projects detail pages.","type":"string"},"projectDetailArchivedFilter":{"description":"Archived filter for the projects detail pages.","type":"string"},"enhancementIndexOrderField":{"description":"Order field for the enhancements index page.","type":"string"},"enhancementIndexOrderDir":{"description":"Order direction for the enhancements index page.","type":"string"},"enhancementIndexAuthorFilter":{"description":"Author filter for the enhancements index page.","type":"string"},"enhancementIndexArchivedFilter":{"description":"Archived filter for the enhancements index page.","type":"string"},"preferredServerId":{"description":"ID of preferred server.","type":"integer"},"civisExploreSkipIntro":{"description":"Whether the user is shown steps for each exploration.","type":"boolean"},"registrationIndexOrderField":{"description":"Order field for the registrations index page.","type":"string"},"registrationIndexOrderDir":{"description":"Order direction for the registrations index page.","type":"string"},"registrationIndexStatusFilter":{"description":"Status filter for the registrations index page.","type":"string"},"upgradeRequested":{"description":"Whether a free trial upgrade has been requested.","type":"string"},"welcomeOrderField":{"description":"Order direction for the welcome page.","type":"string"},"welcomeOrderDir":{"description":"Order direction for the welcome page.","type":"string"},"welcomeAuthorFilter":{"description":"Status filter for the welcome page.","type":"string"},"welcomeStatusFilter":{"description":"Status filter for the welcome page.","type":"string"},"welcomeArchivedFilter":{"description":"Status filter for the welcome page.","type":"string"},"dataPaneWidth":{"description":"Width of the data pane when expanded.","type":"string"},"dataPaneCollapsed":{"description":"Whether the data pane is collapsed.","type":"string"},"notebookOrderField":{"description":"Order field for the notebooks page.","type":"string"},"notebookOrderDir":{"description":"Order direction for the notebooks page.","type":"string"},"notebookAuthorFilter":{"description":"Author filter for the notebooks page.","type":"string"},"notebookArchivedFilter":{"description":"Archived filter for the notebooks page.","type":"string"},"notebookStatusFilter":{"description":"Status filter for the notebooks page.","type":"string"},"workflowIndexOrderField":{"description":"Order field for the workflows page.","type":"string"},"workflowIndexOrderDir":{"description":"Order direction for the workflows page.","type":"string"},"workflowIndexAuthorFilter":{"description":"Author filter for the workflows page.","type":"string"},"workflowIndexArchivedFilter":{"description":"Archived filter for the workflows page.","type":"string"},"serviceOrderField":{"description":"Order field for the services page.","type":"string"},"serviceOrderDir":{"description":"Order direction for the services page.","type":"string"},"serviceAuthorFilter":{"description":"Author filter for the services page.","type":"string"},"serviceArchivedFilter":{"description":"Archived filter for the services page.","type":"string"},"assumeRoleHistory":{"description":"JSON string of previously assumed roles.","type":"string"},"defaultSuccessNotificationsOn":{"description":"Whether email notifications for the success of all applicable jobs are on by default.","type":"boolean"},"defaultFailureNotificationsOn":{"description":"Whether email notifications for the failure of all applicable jobs are on by default.","type":"boolean"},"myActivityMetrics":{"description":"Whether the activity metrics are filtered to the current user.","type":"boolean"},"standardSQLAutocompleteDisabled":{"description":"Whether the query page includes standard SQL autocomplete.","type":"boolean"},"aiSQLAssistDisabled":{"description":"Whether the query page includes AI-powered SQL autocomplete.","type":"boolean"},"queryPreviewRows":{"description":"Number of preview rows query should return in the UI.","type":"integer"}}},"Object724":{"type":"object","properties":{"preferences":{"description":"A hash of user selected preferences. Values should be strings or null to indicate a key deletion.","$ref":"#/definitions/Object725"},"lastCheckedAnnouncements":{"description":"The date and time at which the user last checked their announcements.","type":"string","format":"date-time"}}},"Object726":{"type":"object","properties":{"name":{"description":"The name of this user.","type":"string"},"email":{"description":"The email of this user.","type":"string"},"active":{"description":"Whether this user account is active or deactivated.","type":"boolean"},"primaryGroupId":{"description":"The ID of the primary group of this user.","type":"integer"},"city":{"description":"The city of this user.","type":"string"},"state":{"description":"The state of this user.","type":"string"},"timeZone":{"description":"The time zone of this user.","type":"string"},"initials":{"description":"The initials of this user.","type":"string"},"department":{"description":"The department of this user.","type":"string"},"title":{"description":"The title of this user.","type":"string"},"prefersSmsOtp":{"description":"The preference for phone authorization of this user","type":"boolean"},"groupIds":{"description":"An array of ids of all the groups this user is in.","type":"array","items":{"type":"integer"}},"vpnEnabled":{"description":"The availability of vpn for this user.","type":"boolean"},"ssoDisabled":{"description":"The availability of SSO for this user.","type":"boolean"},"otpRequiredForLogin":{"description":"The two factor authentication requirement for this user.","type":"boolean"},"exemptFromOrgSmsOtpDisabled":{"description":"Whether the user has SMS OTP enabled on an individual level. This field does not matter if the org does not have SMS OTP disabled.","type":"boolean"},"robot":{"description":"Whether the user is a robot.","type":"boolean"},"phone":{"description":"The phone number of this user.","type":"string"},"password":{"description":"The password of this user.","type":"string"},"accountStatus":{"description":"Account status of this user. One of: \"Active\", \"Deactivated\", \"Suspended\", \"Unsuspended\"","type":"string"}}},"Object727":{"type":"object","properties":{"id":{"description":"The ID of this user.","type":"integer"},"user":{"description":"The username of this user.","type":"string"},"unlockedAt":{"description":"The time the user's account was unsuspended","type":"string","format":"date-time"}}},"Object729":{"type":"object","properties":{"urls":{"description":"URLs to receive a POST request at job completion","type":"array","items":{"type":"string"}},"successEmailSubject":{"description":"Custom subject line for success e-mail.","type":"string"},"successEmailBody":{"description":"Custom body text for success e-mail, written in Markdown.","type":"string"},"successEmailAddresses":{"description":"Addresses to notify by e-mail when the job completes successfully.","type":"array","items":{"type":"string"}},"failureEmailAddresses":{"description":"Addresses to notify by e-mail when the job fails.","type":"array","items":{"type":"string"}},"stallWarningMinutes":{"description":"Stall warning emails will be sent after this amount of minutes.","type":"integer"},"successOn":{"description":"If success email notifications are on","type":"boolean"},"failureOn":{"description":"If failure email notifications are on","type":"boolean"}}},"Object728":{"type":"object","properties":{"name":{"description":"The name of this workflow.","type":"string"},"description":{"description":"A description of the workflow.","type":"string"},"fromJobChain":{"description":"If specified, create a workflow from the job chain this job is in, and inherit the schedule from the root of the chain.","type":"integer"},"definition":{"description":"The definition of the workflow in YAML format. Must not be specified if `fromJobChain` is specified.","type":"string"},"schedule":{"description":"The schedule of when this workflow will be run. Must not be specified if `fromJobChain` is specified.","$ref":"#/definitions/Object101"},"allowConcurrentExecutions":{"description":"Whether the workflow can execute when already running.","type":"boolean"},"timeZone":{"description":"The time zone of this workflow.","type":"string"},"notifications":{"description":"The notifications to send after the workflow is executed.","$ref":"#/definitions/Object729"},"hidden":{"description":"The hidden status of the item.","type":"boolean"}},"required":["name"]},"Object731":{"type":"object","properties":{"urls":{"description":"URLs to receive a POST request at job completion","type":"array","items":{"type":"string"}},"successEmailSubject":{"description":"Custom subject line for success e-mail.","type":"string"},"successEmailBody":{"description":"Custom body text for success e-mail, written in Markdown.","type":"string"},"successEmailAddresses":{"description":"Addresses to notify by e-mail when the job completes successfully.","type":"array","items":{"type":"string"}},"failureEmailAddresses":{"description":"Addresses to notify by e-mail when the job fails.","type":"array","items":{"type":"string"}},"stallWarningMinutes":{"description":"Stall warning emails will be sent after this amount of minutes.","type":"integer"},"successOn":{"description":"If success email notifications are on","type":"boolean"},"failureOn":{"description":"If failure email notifications are on","type":"boolean"}}},"Object730":{"type":"object","properties":{"id":{"description":"The ID for this workflow.","type":"integer"},"name":{"description":"The name of this workflow.","type":"string"},"description":{"description":"A description of the workflow.","type":"string"},"definition":{"description":"The definition of the workflow in YAML format. Must not be specified if `fromJobChain` is specified.","type":"string"},"valid":{"description":"The validity of the workflow definition.","type":"boolean"},"validationErrors":{"description":"The errors encountered when validating the workflow definition.","type":"string"},"fileId":{"description":"The file id for the s3 file containing the workflow configuration.","type":"string"},"user":{"description":"The author of this workflow.","$ref":"#/definitions/Object33"},"state":{"description":"The state of the workflow. State is \"running\" if any execution is running, otherwise reflects most recent execution state.","type":"string"},"schedule":{"description":"The schedule of when this workflow will be run. Must not be specified if `fromJobChain` is specified.","$ref":"#/definitions/Object106"},"allowConcurrentExecutions":{"description":"Whether the workflow can execute when already running.","type":"boolean"},"timeZone":{"description":"The time zone of this workflow.","type":"string"},"nextExecutionAt":{"description":"The time of the next scheduled execution.","type":"string","format":"time"},"notifications":{"description":"The notifications to send after the workflow is executed.","$ref":"#/definitions/Object731"},"archived":{"description":"The archival status of the requested item(s).","type":"string"},"hidden":{"description":"The hidden status of the item.","type":"boolean"},"myPermissionLevel":{"description":"Your permission level on the object. One of \"read\", \"write\", or \"manage\".","type":"string"},"createdAt":{"type":"string","format":"time"},"updatedAt":{"type":"string","format":"time"}}},"Object732":{"type":"object","properties":{"name":{"description":"The name of this workflow.","type":"string"},"description":{"description":"A description of the workflow.","type":"string"},"definition":{"description":"The definition of the workflow in YAML format. Must not be specified if `fromJobChain` is specified.","type":"string"},"schedule":{"description":"The schedule of when this workflow will be run. Must not be specified if `fromJobChain` is specified.","$ref":"#/definitions/Object101"},"allowConcurrentExecutions":{"description":"Whether the workflow can execute when already running.","type":"boolean"},"timeZone":{"description":"The time zone of this workflow.","type":"string"},"notifications":{"description":"The notifications to send after the workflow is executed.","$ref":"#/definitions/Object729"}},"required":["name"]},"Object733":{"type":"object","properties":{"name":{"description":"The name of this workflow.","type":"string"},"description":{"description":"A description of the workflow.","type":"string"},"definition":{"description":"The definition of the workflow in YAML format. Must not be specified if `fromJobChain` is specified.","type":"string"},"schedule":{"description":"The schedule of when this workflow will be run. Must not be specified if `fromJobChain` is specified.","$ref":"#/definitions/Object101"},"allowConcurrentExecutions":{"description":"Whether the workflow can execute when already running.","type":"boolean"},"timeZone":{"description":"The time zone of this workflow.","type":"string"},"notifications":{"description":"The notifications to send after the workflow is executed.","$ref":"#/definitions/Object729"}}},"Object734":{"type":"object","properties":{"userIds":{"description":"An array of one or more user IDs.","type":"array","items":{"type":"integer"}},"permissionLevel":{"description":"Options are: \"read\", \"write\", or \"manage\".","type":"string"},"shareEmailBody":{"description":"Custom body text for e-mail sent on a share.","type":"string"},"sendSharedEmail":{"description":"Send email to the recipients of a share.","type":"boolean"}},"required":["userIds","permissionLevel"]},"Object735":{"type":"object","properties":{"groupIds":{"description":"An array of one or more group IDs.","type":"array","items":{"type":"integer"}},"permissionLevel":{"description":"Options are: \"read\", \"write\", or \"manage\".","type":"string"},"shareEmailBody":{"description":"Custom body text for e-mail sent on a share.","type":"string"},"sendSharedEmail":{"description":"Send email to the recipients of a share.","type":"boolean"}},"required":["groupIds","permissionLevel"]},"Object736":{"type":"object","properties":{"userId":{"description":"ID of target user","type":"integer"},"includeDependencies":{"description":"Whether or not to give manage permissions on all dependencies","type":"boolean"},"emailBody":{"description":"Custom body text for e-mail sent on transfer.","type":"string"},"sendEmail":{"description":"Send email to the target user of the transfer?","type":"boolean"}},"required":["userId","includeDependencies"]},"Object737":{"type":"object","properties":{"status":{"description":"The desired archived status of the object.","type":"boolean"}},"required":["status"]},"Object738":{"type":"object","properties":{"cloneSchedule":{"description":"If true, also copy the schedule to the new workflow.","type":"boolean"},"cloneNotifications":{"description":"If true, also copy the notifications to the new workflow.","type":"boolean"}}},"Object739":{"type":"object","properties":{"id":{"description":"The ID for this workflow execution.","type":"integer"},"state":{"description":"The state of this workflow execution.","type":"string"},"mistralState":{"description":"The state of this workflow as reported by mistral. One of running, paused, success, error, or cancelled","type":"string"},"mistralStateInfo":{"description":"The state info of this workflow as reported by mistral.","type":"string"},"user":{"description":"The user who created this execution.","$ref":"#/definitions/Object33"},"startedAt":{"description":"The time this execution started.","type":"string","format":"time"},"finishedAt":{"description":"The time this execution finished.","type":"string","format":"time"},"createdAt":{"description":"The time this execution was created.","type":"string","format":"time"},"updatedAt":{"description":"The time this execution was last updated.","type":"string","format":"time"}}},"Object742":{"type":"object","properties":{"id":{"description":"The ID of the run.","type":"integer"},"jobId":{"description":"The ID of the job associated with the run.","type":"integer"},"myPermissionLevel":{"description":"Your permission level on the job. One of \"read\", \"write\", \"manage\", or \"nil\".","type":"string"},"state":{"description":"The state of the run.","type":"string"},"createdAt":{"description":"The time that the run was queued.","type":"string","format":"time"},"startedAt":{"description":"The time that the run started.","type":"string","format":"time"},"finishedAt":{"description":"The time that the run completed.","type":"string","format":"time"}}},"Object743":{"type":"object","properties":{"id":{"description":"The ID of the execution.","type":"integer"},"workflowId":{"description":"The ID of the workflow associated with the execution.","type":"integer"},"myPermissionLevel":{"description":"Your permission level on the workflow. One of \"read\", \"write\", \"manage\", or \"nil\".","type":"string"},"state":{"description":"The state of this workflow execution.","type":"string"},"createdAt":{"description":"The time this execution was created.","type":"string","format":"time"},"startedAt":{"description":"The time this execution started.","type":"string","format":"time"},"finishedAt":{"description":"The time this execution finished.","type":"string","format":"time"}}},"Object741":{"type":"object","properties":{"name":{"description":"The name of the task.","type":"string"},"mistralState":{"description":"The state of this task. One of idle, waiting, running, delayed, success, error, or cancelled","type":"string"},"mistralStateInfo":{"description":"Extra info associated with the state of the task.","type":"string"},"runs":{"description":"The runs associated with this task, in descending order by id.","type":"array","items":{"$ref":"#/definitions/Object742"}},"executions":{"description":"The executions run by this task, in descending order by id.","type":"array","items":{"$ref":"#/definitions/Object743"}}}},"Object740":{"type":"object","properties":{"id":{"description":"The ID for this workflow execution.","type":"integer"},"state":{"description":"The state of this workflow execution.","type":"string"},"mistralState":{"description":"The state of this workflow as reported by mistral. One of running, paused, success, error, or cancelled","type":"string"},"mistralStateInfo":{"description":"The state info of this workflow as reported by mistral.","type":"string"},"user":{"description":"The user who created this execution.","$ref":"#/definitions/Object33"},"definition":{"description":"The definition of the workflow for this execution.","type":"string"},"input":{"description":"Key-value pairs defined for this execution.","type":"object"},"includedTasks":{"description":"The subset of workflow tasks selected to execute.","type":"array","items":{"type":"string"}},"tasks":{"description":"The tasks associated with this execution.","type":"array","items":{"$ref":"#/definitions/Object741"}},"startedAt":{"description":"The time this execution started.","type":"string","format":"time"},"finishedAt":{"description":"The time this execution finished.","type":"string","format":"time"},"createdAt":{"description":"The time this execution was created.","type":"string","format":"time"},"updatedAt":{"description":"The time this execution was last updated.","type":"string","format":"time"}}},"Object744":{"type":"object","properties":{"targetTask":{"description":"For a reverse workflow, the name of the task to target.","type":"string"},"input":{"description":"Key-value pairs to send to this execution as inputs.","type":"object"},"includedTasks":{"description":"If specified, executes only the subset of workflow tasks included as specified by task name.","type":"array","items":{"type":"string"}}}},"Object746":{"type":"object","properties":{"taskName":{"description":"If specified, the name of the task to be retried. If not specified, all failed tasks in the execution will be retried.","type":"string"}}},"Object747":{"type":"object","properties":{"name":{"description":"The name of the task.","type":"string"},"mistralState":{"description":"The state of this task. One of idle, waiting, running, delayed, success, error, or cancelled","type":"string"},"mistralStateInfo":{"description":"Extra info associated with the state of the task.","type":"string"},"runs":{"description":"The runs associated with this task, in descending order by id.","type":"array","items":{"$ref":"#/definitions/Object742"}},"executions":{"description":"The executions run by this task, in descending order by id.","type":"array","items":{"$ref":"#/definitions/Object743"}}}}},"securityDefinitions":{"api_key":{"type":"apiKey","name":"Authorization","in":"header"}},"security":[{"api_key":[]}]} \ No newline at end of file +{"swagger":"2.0","info":{"title":"Civis Analytics API","version":"1"},"host":"api.civisanalytics.com","schemes":["https"],"produces":["application/json"],"paths":{"/admin/organizations":{"get":{"summary":"List organizations","description":null,"deprecated":false,"parameters":[{"name":"status","in":"query","required":false,"description":"The status of the organization (active/trial/inactive).","type":"array","items":{"type":"string"}},{"name":"org_type","in":"query","required":false,"description":"The organization type (platform/ads/survey_vendor/other).","type":"array","items":{"type":"string"}}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object7"}}}},"x-examples":[{"resource":"Admin","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/admin/organizations","description":"List all orgs","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/admin/organizations","request_body":null,"request_headers":{"Content-Type":"application/json","Authorization":"Bearer 1yDslJPlzrkcnKN_o9cuxaIYEHMW3tR-oyIurJKJ1K4","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 1,\n \"name\": \"Civis Analytics\",\n \"slug\": \"civis\",\n \"accountManagerId\": null,\n \"csSpecialistId\": null,\n \"status\": \"active\",\n \"orgType\": null,\n \"customBranding\": null,\n \"contractSize\": null,\n \"maxAnalystUsers\": null,\n \"maxReportUsers\": null,\n \"vertical\": null,\n \"csMetadata\": null,\n \"removeFooterInEmails\": false,\n \"salesforceAccountId\": null,\n \"tableauSiteId\": null,\n \"fedrampEnabled\": true,\n \"createdById\": null,\n \"lastUpdatedById\": null,\n \"advancedSettings\": {\n \"dedicatedDjPoolEnabled\": false\n },\n \"tableauRefreshHistory\": [\n {\n \"time_period\": \"2023-07\",\n \"usage\": 0\n },\n {\n \"time_period\": \"2023-06\",\n \"usage\": 0\n }\n ]\n },\n {\n \"id\": 2,\n \"name\": \"Demo\",\n \"slug\": \"demo\",\n \"accountManagerId\": null,\n \"csSpecialistId\": null,\n \"status\": \"active\",\n \"orgType\": null,\n \"customBranding\": null,\n \"contractSize\": null,\n \"maxAnalystUsers\": null,\n \"maxReportUsers\": null,\n \"vertical\": null,\n \"csMetadata\": null,\n \"removeFooterInEmails\": false,\n \"salesforceAccountId\": null,\n \"tableauSiteId\": null,\n \"fedrampEnabled\": false,\n \"createdById\": null,\n \"lastUpdatedById\": null,\n \"advancedSettings\": {\n \"dedicatedDjPoolEnabled\": false\n },\n \"tableauRefreshHistory\": [\n {\n \"time_period\": \"2023-07\",\n \"usage\": 0\n },\n {\n \"time_period\": \"2023-06\",\n \"usage\": 0\n }\n ]\n },\n {\n \"id\": 3,\n \"name\": \"Default\",\n \"slug\": \"default\",\n \"accountManagerId\": null,\n \"csSpecialistId\": null,\n \"status\": \"active\",\n \"orgType\": null,\n \"customBranding\": null,\n \"contractSize\": null,\n \"maxAnalystUsers\": null,\n \"maxReportUsers\": null,\n \"vertical\": null,\n \"csMetadata\": null,\n \"removeFooterInEmails\": false,\n \"salesforceAccountId\": null,\n \"tableauSiteId\": null,\n \"fedrampEnabled\": false,\n \"createdById\": null,\n \"lastUpdatedById\": null,\n \"advancedSettings\": {\n \"dedicatedDjPoolEnabled\": false\n },\n \"tableauRefreshHistory\": [\n {\n \"time_period\": \"2023-07\",\n \"usage\": 0\n },\n {\n \"time_period\": \"2023-06\",\n \"usage\": 0\n }\n ]\n },\n {\n \"id\": 4,\n \"name\": \"Managers\",\n \"slug\": \"managers\",\n \"accountManagerId\": null,\n \"csSpecialistId\": null,\n \"status\": \"active\",\n \"orgType\": null,\n \"customBranding\": null,\n \"contractSize\": null,\n \"maxAnalystUsers\": null,\n \"maxReportUsers\": null,\n \"vertical\": null,\n \"csMetadata\": null,\n \"removeFooterInEmails\": false,\n \"salesforceAccountId\": null,\n \"tableauSiteId\": null,\n \"fedrampEnabled\": false,\n \"createdById\": null,\n \"lastUpdatedById\": null,\n \"advancedSettings\": {\n \"dedicatedDjPoolEnabled\": false\n },\n \"tableauRefreshHistory\": [\n {\n \"time_period\": \"2023-07\",\n \"usage\": 0\n },\n {\n \"time_period\": \"2023-06\",\n \"usage\": 0\n }\n ]\n },\n {\n \"id\": 5,\n \"name\": \"Organization 1\",\n \"slug\": \"organization_b\",\n \"accountManagerId\": 1,\n \"csSpecialistId\": 2,\n \"status\": \"active\",\n \"orgType\": \"platform\",\n \"customBranding\": null,\n \"contractSize\": 25555,\n \"maxAnalystUsers\": 3,\n \"maxReportUsers\": 20,\n \"vertical\": \"Snake Handling\",\n \"csMetadata\": \"{\\\"second_vertical\\\":\\\"snake disposal\\\"}\",\n \"removeFooterInEmails\": false,\n \"salesforceAccountId\": null,\n \"tableauSiteId\": \"tableau-site-id\",\n \"fedrampEnabled\": false,\n \"createdById\": null,\n \"lastUpdatedById\": null,\n \"advancedSettings\": {\n \"dedicatedDjPoolEnabled\": false\n },\n \"tableauRefreshHistory\": [\n {\n \"time_period\": \"2023-07\",\n \"usage\": 0\n },\n {\n \"time_period\": \"2023-06\",\n \"usage\": 0\n }\n ]\n },\n {\n \"id\": 6,\n \"name\": \"Organization 2\",\n \"slug\": \"organization_c\",\n \"accountManagerId\": null,\n \"csSpecialistId\": null,\n \"status\": \"active\",\n \"orgType\": \"ads\",\n \"customBranding\": null,\n \"contractSize\": null,\n \"maxAnalystUsers\": null,\n \"maxReportUsers\": null,\n \"vertical\": null,\n \"csMetadata\": null,\n \"removeFooterInEmails\": false,\n \"salesforceAccountId\": null,\n \"tableauSiteId\": \"tableau-site-id\",\n \"fedrampEnabled\": false,\n \"createdById\": null,\n \"lastUpdatedById\": null,\n \"advancedSettings\": {\n \"dedicatedDjPoolEnabled\": false\n },\n \"tableauRefreshHistory\": [\n {\n \"time_period\": \"2023-07\",\n \"usage\": 0\n },\n {\n \"time_period\": \"2023-06\",\n \"usage\": 0\n }\n ]\n },\n {\n \"id\": 7,\n \"name\": \"Organization 3\",\n \"slug\": \"organization_d\",\n \"accountManagerId\": null,\n \"csSpecialistId\": null,\n \"status\": \"trial\",\n \"orgType\": \"platform\",\n \"customBranding\": null,\n \"contractSize\": null,\n \"maxAnalystUsers\": null,\n \"maxReportUsers\": null,\n \"vertical\": null,\n \"csMetadata\": null,\n \"removeFooterInEmails\": false,\n \"salesforceAccountId\": null,\n \"tableauSiteId\": \"tableau-site-id\",\n \"fedrampEnabled\": false,\n \"createdById\": null,\n \"lastUpdatedById\": null,\n \"advancedSettings\": {\n \"dedicatedDjPoolEnabled\": false\n },\n \"tableauRefreshHistory\": [\n {\n \"time_period\": \"2023-07\",\n \"usage\": 0\n },\n {\n \"time_period\": \"2023-06\",\n \"usage\": 0\n }\n ]\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"74e73e7bf7620c87b7e673af70baa1fb\"","X-Request-Id":"42077289-bebd-41f1-828b-811aed4c544d","X-Runtime":"0.121092","Content-Length":"3880"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/admin/organizations\" -X GET \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer 1yDslJPlzrkcnKN_o9cuxaIYEHMW3tR-oyIurJKJ1K4\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Admin","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/admin/organizations","description":"Filter orgs","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/admin/organizations?status[]=active&status[]=trial&org_type=platform","request_body":null,"request_headers":{"Content-Type":"application/json","Authorization":"Bearer kOgBL0QrwUjMGCHQmmaQBCXr6xmkHGTzGvvC99OtSq0","Host":"api.civis.test","Cookie":""},"request_query_parameters":{"status":["active","trial"],"org_type":"platform"},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 8,\n \"name\": \"Organization 4\",\n \"slug\": \"organization_e\",\n \"accountManagerId\": null,\n \"csSpecialistId\": null,\n \"status\": \"active\",\n \"orgType\": \"platform\",\n \"customBranding\": null,\n \"contractSize\": 25555,\n \"maxAnalystUsers\": 3,\n \"maxReportUsers\": 20,\n \"vertical\": \"Snake Handling\",\n \"csMetadata\": \"{\\\"second_vertical\\\":\\\"snake disposal\\\"}\",\n \"removeFooterInEmails\": false,\n \"salesforceAccountId\": null,\n \"tableauSiteId\": \"tableau-site-id\",\n \"fedrampEnabled\": false,\n \"createdById\": null,\n \"lastUpdatedById\": null,\n \"advancedSettings\": {\n \"dedicatedDjPoolEnabled\": false\n },\n \"tableauRefreshHistory\": [\n {\n \"time_period\": \"2023-07\",\n \"usage\": 0\n },\n {\n \"time_period\": \"2023-06\",\n \"usage\": 0\n }\n ]\n },\n {\n \"id\": 10,\n \"name\": \"Organization 6\",\n \"slug\": \"organization_g\",\n \"accountManagerId\": null,\n \"csSpecialistId\": null,\n \"status\": \"trial\",\n \"orgType\": \"platform\",\n \"customBranding\": null,\n \"contractSize\": null,\n \"maxAnalystUsers\": null,\n \"maxReportUsers\": null,\n \"vertical\": null,\n \"csMetadata\": null,\n \"removeFooterInEmails\": false,\n \"salesforceAccountId\": null,\n \"tableauSiteId\": \"tableau-site-id\",\n \"fedrampEnabled\": false,\n \"createdById\": null,\n \"lastUpdatedById\": null,\n \"advancedSettings\": {\n \"dedicatedDjPoolEnabled\": false\n },\n \"tableauRefreshHistory\": [\n {\n \"time_period\": \"2023-07\",\n \"usage\": 0\n },\n {\n \"time_period\": \"2023-06\",\n \"usage\": 0\n }\n ]\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"2682b78bfeb17e80b8640cae322434f1\"","X-Request-Id":"7867350a-2bf6-4582-a840-b71ca9033591","X-Runtime":"0.015303","Content-Length":"1183"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/admin/organizations?status[]=active&status[]=trial&org_type=platform\" -X GET \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer kOgBL0QrwUjMGCHQmmaQBCXr6xmkHGTzGvvC99OtSq0\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Admin","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/admin/organizations","description":"List orgs","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/admin/organizations","request_body":null,"request_headers":{"Content-Type":"application/json","Authorization":"Bearer MJeydcFRT9x4SsYUsgBPXa1r1Mxm3h_Iq9FWmB4Drq4","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 11,\n \"name\": \"Organization 7\",\n \"slug\": \"organization_h\",\n \"accountManagerId\": null,\n \"csSpecialistId\": null,\n \"status\": \"active\",\n \"orgType\": \"platform\",\n \"customBranding\": null,\n \"contractSize\": 25555,\n \"maxAnalystUsers\": 3,\n \"maxReportUsers\": 20,\n \"vertical\": \"Snake Handling\",\n \"csMetadata\": \"{\\\"second_vertical\\\":\\\"snake disposal\\\"}\",\n \"removeFooterInEmails\": false,\n \"salesforceAccountId\": null,\n \"tableauSiteId\": \"tableau-site-id\",\n \"fedrampEnabled\": false,\n \"createdById\": null,\n \"lastUpdatedById\": null,\n \"advancedSettings\": {\n \"dedicatedDjPoolEnabled\": false\n },\n \"tableauRefreshHistory\": [\n {\n \"time_period\": \"2023-07\",\n \"usage\": 0\n },\n {\n \"time_period\": \"2023-06\",\n \"usage\": 0\n }\n ]\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"9f2d9ba0bf1356c1edc9eb15df18b528\"","X-Request-Id":"e060652d-6607-433e-b805-f2a88543f09b","X-Runtime":"0.015294","Content-Length":"616"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/admin/organizations\" -X GET \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer MJeydcFRT9x4SsYUsgBPXa1r1Mxm3h_Iq9FWmB4Drq4\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/aliases/{id}/shares":{"get":{"summary":"List users and groups permissioned on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object9"}}}},"x-examples":null,"x-deprecation-warning":null}},"/aliases/{id}/shares/users":{"put":{"summary":"Set the permissions users have on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"Object13","in":"body","schema":{"$ref":"#/definitions/Object13"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object9"}}},"x-examples":null,"x-deprecation-warning":null}},"/aliases/{id}/shares/users/{user_id}":{"delete":{"summary":"Revoke the permissions a user has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"user_id","in":"path","required":true,"description":"The ID of the user.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/aliases/{id}/shares/groups":{"put":{"summary":"Set the permissions groups has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"Object14","in":"body","schema":{"$ref":"#/definitions/Object14"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object9"}}},"x-examples":null,"x-deprecation-warning":null}},"/aliases/{id}/shares/groups/{group_id}":{"delete":{"summary":"Revoke the permissions a group has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"group_id","in":"path","required":true,"description":"The ID of the group.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/aliases/{id}/dependencies":{"get":{"summary":"List dependent objects for this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"user_id","in":"query","required":false,"description":"ID of target user","type":"integer"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object15"}}}},"x-examples":null,"x-deprecation-warning":null}},"/aliases/{id}/transfer":{"put":{"summary":"Transfer ownership of this object to another user","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"Object16","in":"body","schema":{"$ref":"#/definitions/Object16"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object17"}}},"x-examples":null,"x-deprecation-warning":null}},"/aliases/":{"get":{"summary":"List Aliases","description":null,"deprecated":false,"parameters":[{"name":"object_type","in":"query","required":false,"description":"Filter results by object type. Pass multiple object types with a comma-separatedlist. Valid types include: cass_ncoa, container_script, geocode, identity_resolution, dbt_script, python_script, r_script, javascript_script, sql_script, project, notebook, workflow, template_script, template_report, service, report, tableau and service_report.","type":"string"},{"name":"limit","in":"query","required":false,"description":"Number of results to return. Defaults to 50. Maximum allowed is 1000.","type":"integer"},{"name":"page_num","in":"query","required":false,"description":"Page number of the results to return. Defaults to the first page, 1.","type":"integer"},{"name":"order","in":"query","required":false,"description":"The field on which to order the result set. Defaults to id. Must be one of: id, object_type.","type":"string"},{"name":"order_dir","in":"query","required":false,"description":"Direction in which to sort, either asc (ascending) or desc (descending) defaulting to asc.","type":"string"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object19"}}}},"x-examples":null,"x-deprecation-warning":null},"post":{"summary":"Create an Alias","description":null,"deprecated":false,"parameters":[{"name":"Object20","in":"body","schema":{"$ref":"#/definitions/Object20"},"required":true}],"responses":{"201":{"description":"success","schema":{"$ref":"#/definitions/Object19"}}},"x-examples":null,"x-deprecation-warning":null}},"/aliases/{id}":{"get":{"summary":"Get an Alias","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object19"}}},"x-examples":null,"x-deprecation-warning":null},"put":{"summary":"Replace all attributes of this Alias","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The id of the Alias object.","type":"integer"},{"name":"Object21","in":"body","schema":{"$ref":"#/definitions/Object21"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object19"}}},"x-examples":null,"x-deprecation-warning":null},"patch":{"summary":"Update some attributes of this Alias","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The id of the Alias object.","type":"integer"},{"name":"Object22","in":"body","schema":{"$ref":"#/definitions/Object22"},"required":false}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object19"}}},"x-examples":null,"x-deprecation-warning":null},"delete":{"summary":"Delete an alias","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The id of the Alias object.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/aliases/{object_type}/{alias}":{"get":{"summary":"Get details about an alias within an FCO type","description":null,"deprecated":false,"parameters":[{"name":"object_type","in":"path","required":true,"description":"The type of the object. Valid types include: cass_ncoa, container_script, geocode, identity_resolution, dbt_script, python_script, r_script, javascript_script, sql_script, project, notebook, workflow, template_script, template_report, service, report, tableau and service_report.","type":"string"},{"name":"alias","in":"path","required":true,"description":"The alias of the object","type":"string"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object19"}}},"x-examples":null,"x-deprecation-warning":null}},"/announcements/":{"get":{"summary":"List announcements","description":null,"deprecated":false,"parameters":[{"name":"limit","in":"query","required":false,"description":"Number of results to return. Defaults to 10. Maximum allowed is 50.","type":"integer"},{"name":"page_num","in":"query","required":false,"description":"Page number of the results to return. Defaults to the first page, 1.","type":"integer"},{"name":"order","in":"query","required":false,"description":"The field on which to order the result set. Defaults to released_at. Must be one of: released_at.","type":"string"},{"name":"order_dir","in":"query","required":false,"description":"Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc.","type":"string"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object0"}}}},"x-examples":[{"resource":"Announcements","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/announcements","description":"List first page of announcements","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/announcements","request_body":null,"request_headers":{"Content-Type":"application/json","Authorization":"Bearer qEkd3_1rezHTtG68ijdjx5x1ac1ID8o0CPwC9Sm3g6g","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 44,\n \"subject\": \"Important message 44\",\n \"body\": \"The square root of 44 is 6.63.\",\n \"releasedAt\": \"2023-07-18T17:44:24.000Z\",\n \"createdAt\": \"2023-07-18T17:39:24.000Z\",\n \"updatedAt\": \"2023-07-18T17:39:24.000Z\"\n },\n {\n \"id\": 45,\n \"subject\": \"Important message 45\",\n \"body\": \"The square root of 45 is 6.71.\",\n \"releasedAt\": \"2023-07-18T16:44:24.000Z\",\n \"createdAt\": \"2023-07-18T16:39:24.000Z\",\n \"updatedAt\": \"2023-07-18T16:39:24.000Z\"\n },\n {\n \"id\": 46,\n \"subject\": \"Important message 46\",\n \"body\": \"The square root of 46 is 6.78.\",\n \"releasedAt\": \"2023-07-18T15:44:24.000Z\",\n \"createdAt\": \"2023-07-18T15:39:24.000Z\",\n \"updatedAt\": \"2023-07-18T15:39:24.000Z\"\n },\n {\n \"id\": 47,\n \"subject\": \"Important message 47\",\n \"body\": \"The square root of 47 is 6.86.\",\n \"releasedAt\": \"2023-07-18T14:44:24.000Z\",\n \"createdAt\": \"2023-07-18T14:39:24.000Z\",\n \"updatedAt\": \"2023-07-18T14:39:24.000Z\"\n },\n {\n \"id\": 48,\n \"subject\": \"Important message 48\",\n \"body\": \"The square root of 48 is 6.93.\",\n \"releasedAt\": \"2023-07-18T13:44:24.000Z\",\n \"createdAt\": \"2023-07-18T13:39:24.000Z\",\n \"updatedAt\": \"2023-07-18T13:39:24.000Z\"\n },\n {\n \"id\": 49,\n \"subject\": \"Important message 49\",\n \"body\": \"The square root of 49 is 7.0.\",\n \"releasedAt\": \"2023-07-18T12:44:24.000Z\",\n \"createdAt\": \"2023-07-18T12:39:24.000Z\",\n \"updatedAt\": \"2023-07-18T12:39:24.000Z\"\n },\n {\n \"id\": 50,\n \"subject\": \"Important message 50\",\n \"body\": \"The square root of 50 is 7.07.\",\n \"releasedAt\": \"2023-07-18T11:44:24.000Z\",\n \"createdAt\": \"2023-07-18T11:39:24.000Z\",\n \"updatedAt\": \"2023-07-18T11:39:24.000Z\"\n },\n {\n \"id\": 51,\n \"subject\": \"Important message 51\",\n \"body\": \"The square root of 51 is 7.14.\",\n \"releasedAt\": \"2023-07-18T10:44:24.000Z\",\n \"createdAt\": \"2023-07-18T10:39:24.000Z\",\n \"updatedAt\": \"2023-07-18T10:39:24.000Z\"\n },\n {\n \"id\": 52,\n \"subject\": \"Important message 52\",\n \"body\": \"The square root of 52 is 7.21.\",\n \"releasedAt\": \"2023-07-18T09:44:24.000Z\",\n \"createdAt\": \"2023-07-18T09:39:24.000Z\",\n \"updatedAt\": \"2023-07-18T09:39:24.000Z\"\n },\n {\n \"id\": 53,\n \"subject\": \"Important message 53\",\n \"body\": \"The square root of 53 is 7.28.\",\n \"releasedAt\": \"2023-07-18T08:44:24.000Z\",\n \"createdAt\": \"2023-07-18T08:39:24.000Z\",\n \"updatedAt\": \"2023-07-18T08:39:24.000Z\"\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","Date":"2023-07-18T18:39:24.900Z","Access-Control-Expose-Headers":"Date, X-Pagination-Per-Page, X-Pagination-Current-Page, X-Pagination-Total-Pages, X-Pagination-Total-Entries","X-Pagination-Per-Page":"10","X-Pagination-Current-Page":"1","X-Pagination-Total-Pages":"2","X-Pagination-Total-Entries":"20","Content-Type":"application/json; charset=utf-8","ETag":"W/\"9d41de72d1d0ee40af9342bf952fd109\"","X-Request-Id":"a273f2b0-7622-4a3d-a9cb-764b1972eb9c","X-Runtime":"0.014117","Content-Length":"2010"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/announcements\" -X GET \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer qEkd3_1rezHTtG68ijdjx5x1ac1ID8o0CPwC9Sm3g6g\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/clusters/kubernetes":{"get":{"summary":"List Kubernetes Clusters","description":null,"deprecated":false,"parameters":[{"name":"organization_id","in":"query","required":false,"description":"The ID of this cluster's organization. Cannot be used along with the organization slug.","type":"integer"},{"name":"organization_slug","in":"query","required":false,"description":"The slug of this cluster's organization. Cannot be used along with the organization ID.","type":"string"},{"name":"raw_cluster_slug","in":"query","required":false,"description":"The slug of this cluster's raw configuration.","type":"string"},{"name":"exclude_inactive_orgs","in":"query","required":false,"description":"When true, excludes KubeClusters associated with inactive orgs. Defaults to false.","type":"boolean"},{"name":"limit","in":"query","required":false,"description":"Number of results to return. Defaults to its maximum of 50.","type":"integer"},{"name":"page_num","in":"query","required":false,"description":"Page number of the results to return. Defaults to the first page, 1.","type":"integer"},{"name":"order","in":"query","required":false,"description":"The field on which to order the result set. Defaults to organization_id. Must be one of: organization_id, created_at.","type":"string"},{"name":"order_dir","in":"query","required":false,"description":"Direction in which to sort, either asc (ascending) or desc (descending) defaulting to asc.","type":"string"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object24"}}}},"x-examples":[{"resource":"Clusters","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/clusters/kubernetes","description":"List all Kubernetes clusters","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/clusters/kubernetes","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer PEuTh9FL1T9g_zhIBnd2zO7DD9VJSMlStMfgMo91zFc","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 1,\n \"organizationId\": 1,\n \"organizationName\": \"Civis Analytics\",\n \"organizationSlug\": \"civis\",\n \"rawClusterSlug\": \"cluster03-kubernetes-us-east-1\",\n \"customPartitions\": false,\n \"clusterPartitions\": [\n {\n \"clusterPartitionId\": 1,\n \"name\": \"jobs\",\n \"labels\": [\n \"Job\"\n ],\n \"instanceConfigs\": [\n {\n \"instanceConfigId\": 1,\n \"instanceType\": \"m4.xlarge\",\n \"minInstances\": 1,\n \"maxInstances\": 8,\n \"instanceMaxMemory\": 15320,\n \"instanceMaxCpu\": 4096,\n \"instanceMaxDisk\": 90.0,\n \"usageStats\": {\n \"pendingMemoryRequested\": null,\n \"pendingCpuRequested\": null,\n \"runningMemoryRequested\": null,\n \"runningCpuRequested\": null,\n \"pendingDeployments\": null,\n \"runningDeployments\": null\n }\n }\n ],\n \"defaultInstanceConfigId\": 1\n },\n {\n \"clusterPartitionId\": 2,\n \"name\": \"notebook_services\",\n \"labels\": [\n \"Notebook\",\n \"Service\"\n ],\n \"instanceConfigs\": [\n {\n \"instanceConfigId\": 2,\n \"instanceType\": \"m4.xlarge\",\n \"minInstances\": 0,\n \"maxInstances\": 2,\n \"instanceMaxMemory\": 15320,\n \"instanceMaxCpu\": 4096,\n \"instanceMaxDisk\": 90.0,\n \"usageStats\": {\n \"pendingMemoryRequested\": null,\n \"pendingCpuRequested\": null,\n \"runningMemoryRequested\": null,\n \"runningCpuRequested\": null,\n \"pendingDeployments\": null,\n \"runningDeployments\": null\n }\n }\n ],\n \"defaultInstanceConfigId\": 2\n }\n ],\n \"isNatEnabled\": false\n },\n {\n \"id\": 2,\n \"organizationId\": 2,\n \"organizationName\": \"civismatching\",\n \"organizationSlug\": \"platform-matching\",\n \"rawClusterSlug\": \"cluster03-kubernetes-us-east-1\",\n \"customPartitions\": false,\n \"clusterPartitions\": [\n {\n \"clusterPartitionId\": 3,\n \"name\": \"jobs\",\n \"labels\": [\n \"Job\"\n ],\n \"instanceConfigs\": [\n {\n \"instanceConfigId\": 3,\n \"instanceType\": \"m4.xlarge\",\n \"minInstances\": 1,\n \"maxInstances\": 8,\n \"instanceMaxMemory\": 15320,\n \"instanceMaxCpu\": 4096,\n \"instanceMaxDisk\": 90.0,\n \"usageStats\": {\n \"pendingMemoryRequested\": null,\n \"pendingCpuRequested\": null,\n \"runningMemoryRequested\": null,\n \"runningCpuRequested\": null,\n \"pendingDeployments\": null,\n \"runningDeployments\": null\n }\n }\n ],\n \"defaultInstanceConfigId\": 3\n },\n {\n \"clusterPartitionId\": 4,\n \"name\": \"notebook_services\",\n \"labels\": [\n \"Notebook\",\n \"Service\"\n ],\n \"instanceConfigs\": [\n {\n \"instanceConfigId\": 4,\n \"instanceType\": \"m4.xlarge\",\n \"minInstances\": 0,\n \"maxInstances\": 2,\n \"instanceMaxMemory\": 15320,\n \"instanceMaxCpu\": 4096,\n \"instanceMaxDisk\": 90.0,\n \"usageStats\": {\n \"pendingMemoryRequested\": null,\n \"pendingCpuRequested\": null,\n \"runningMemoryRequested\": null,\n \"runningCpuRequested\": null,\n \"pendingDeployments\": null,\n \"runningDeployments\": null\n }\n }\n ],\n \"defaultInstanceConfigId\": 4\n }\n ],\n \"isNatEnabled\": false\n },\n {\n \"id\": 3,\n \"organizationId\": 3,\n \"organizationName\": \"Demo\",\n \"organizationSlug\": \"demo\",\n \"rawClusterSlug\": \"cluster03-kubernetes-us-east-1\",\n \"customPartitions\": false,\n \"clusterPartitions\": [\n {\n \"clusterPartitionId\": 5,\n \"name\": \"jobs\",\n \"labels\": [\n \"Job\"\n ],\n \"instanceConfigs\": [\n {\n \"instanceConfigId\": 5,\n \"instanceType\": \"m4.xlarge\",\n \"minInstances\": 1,\n \"maxInstances\": 8,\n \"instanceMaxMemory\": 15320,\n \"instanceMaxCpu\": 4096,\n \"instanceMaxDisk\": 90.0,\n \"usageStats\": {\n \"pendingMemoryRequested\": null,\n \"pendingCpuRequested\": null,\n \"runningMemoryRequested\": null,\n \"runningCpuRequested\": null,\n \"pendingDeployments\": null,\n \"runningDeployments\": null\n }\n }\n ],\n \"defaultInstanceConfigId\": 5\n },\n {\n \"clusterPartitionId\": 6,\n \"name\": \"notebook_services\",\n \"labels\": [\n \"Notebook\",\n \"Service\"\n ],\n \"instanceConfigs\": [\n {\n \"instanceConfigId\": 6,\n \"instanceType\": \"m4.xlarge\",\n \"minInstances\": 0,\n \"maxInstances\": 2,\n \"instanceMaxMemory\": 15320,\n \"instanceMaxCpu\": 4096,\n \"instanceMaxDisk\": 90.0,\n \"usageStats\": {\n \"pendingMemoryRequested\": null,\n \"pendingCpuRequested\": null,\n \"runningMemoryRequested\": null,\n \"runningCpuRequested\": null,\n \"pendingDeployments\": null,\n \"runningDeployments\": null\n }\n }\n ],\n \"defaultInstanceConfigId\": 6\n }\n ],\n \"isNatEnabled\": false\n },\n {\n \"id\": 4,\n \"organizationId\": 4,\n \"organizationName\": \"Default\",\n \"organizationSlug\": \"default\",\n \"rawClusterSlug\": \"cluster03-kubernetes-us-east-1\",\n \"customPartitions\": false,\n \"clusterPartitions\": [\n {\n \"clusterPartitionId\": 7,\n \"name\": \"jobs\",\n \"labels\": [\n \"Job\"\n ],\n \"instanceConfigs\": [\n {\n \"instanceConfigId\": 7,\n \"instanceType\": \"m4.xlarge\",\n \"minInstances\": 1,\n \"maxInstances\": 8,\n \"instanceMaxMemory\": 15320,\n \"instanceMaxCpu\": 4096,\n \"instanceMaxDisk\": 90.0,\n \"usageStats\": {\n \"pendingMemoryRequested\": null,\n \"pendingCpuRequested\": null,\n \"runningMemoryRequested\": null,\n \"runningCpuRequested\": null,\n \"pendingDeployments\": null,\n \"runningDeployments\": null\n }\n }\n ],\n \"defaultInstanceConfigId\": 7\n },\n {\n \"clusterPartitionId\": 8,\n \"name\": \"notebook_services\",\n \"labels\": [\n \"Notebook\",\n \"Service\"\n ],\n \"instanceConfigs\": [\n {\n \"instanceConfigId\": 8,\n \"instanceType\": \"m4.xlarge\",\n \"minInstances\": 0,\n \"maxInstances\": 2,\n \"instanceMaxMemory\": 15320,\n \"instanceMaxCpu\": 4096,\n \"instanceMaxDisk\": 90.0,\n \"usageStats\": {\n \"pendingMemoryRequested\": null,\n \"pendingCpuRequested\": null,\n \"runningMemoryRequested\": null,\n \"runningCpuRequested\": null,\n \"pendingDeployments\": null,\n \"runningDeployments\": null\n }\n }\n ],\n \"defaultInstanceConfigId\": 8\n }\n ],\n \"isNatEnabled\": false\n },\n {\n \"id\": 5,\n \"organizationId\": 5,\n \"organizationName\": \"Managers\",\n \"organizationSlug\": \"managers\",\n \"rawClusterSlug\": \"cluster03-kubernetes-us-east-1\",\n \"customPartitions\": false,\n \"clusterPartitions\": [\n {\n \"clusterPartitionId\": 9,\n \"name\": \"jobs\",\n \"labels\": [\n \"Job\"\n ],\n \"instanceConfigs\": [\n {\n \"instanceConfigId\": 9,\n \"instanceType\": \"m4.xlarge\",\n \"minInstances\": 1,\n \"maxInstances\": 8,\n \"instanceMaxMemory\": 15320,\n \"instanceMaxCpu\": 4096,\n \"instanceMaxDisk\": 90.0,\n \"usageStats\": {\n \"pendingMemoryRequested\": null,\n \"pendingCpuRequested\": null,\n \"runningMemoryRequested\": null,\n \"runningCpuRequested\": null,\n \"pendingDeployments\": null,\n \"runningDeployments\": null\n }\n }\n ],\n \"defaultInstanceConfigId\": 9\n },\n {\n \"clusterPartitionId\": 10,\n \"name\": \"notebook_services\",\n \"labels\": [\n \"Notebook\",\n \"Service\"\n ],\n \"instanceConfigs\": [\n {\n \"instanceConfigId\": 10,\n \"instanceType\": \"m4.xlarge\",\n \"minInstances\": 0,\n \"maxInstances\": 2,\n \"instanceMaxMemory\": 15320,\n \"instanceMaxCpu\": 4096,\n \"instanceMaxDisk\": 90.0,\n \"usageStats\": {\n \"pendingMemoryRequested\": null,\n \"pendingCpuRequested\": null,\n \"runningMemoryRequested\": null,\n \"runningCpuRequested\": null,\n \"pendingDeployments\": null,\n \"runningDeployments\": null\n }\n }\n ],\n \"defaultInstanceConfigId\": 10\n }\n ],\n \"isNatEnabled\": false\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","X-Pagination-Per-Page":"50","Access-Control-Expose-Headers":"X-Pagination-Per-Page, X-Pagination-Current-Page, X-Pagination-Total-Pages, X-Pagination-Total-Entries","X-Pagination-Current-Page":"1","X-Pagination-Total-Pages":"1","X-Pagination-Total-Entries":"5","Content-Type":"application/json; charset=utf-8","ETag":"W/\"e32c92283e181147f0b84580f272be4c\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"7eda3318-3c02-4ab2-8e5d-eeb2aaea52d1","X-Runtime":"0.274637","Content-Length":"5582"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/clusters/kubernetes\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer PEuTh9FL1T9g_zhIBnd2zO7DD9VJSMlStMfgMo91zFc\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/clusters/kubernetes/{id}":{"get":{"summary":"Describe a Kubernetes Cluster","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"type":"integer"},{"name":"include_usage_stats","in":"query","required":false,"description":"When true, usage stats are returned in instance config objects. Defaults to false.","type":"boolean"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object29"}}},"x-examples":[{"resource":"Clusters","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/clusters/kubernetes/:id","description":"View a Kubernetes cluster's details","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/clusters/kubernetes/6","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer 75M0c0JTdbWo-DQqeMvzHFJEppSvnUkdNHIYmZTjCO0","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 6,\n \"organizationId\": 6,\n \"organizationName\": \"Organization 1\",\n \"organizationSlug\": \"organization_b\",\n \"rawClusterSlug\": \"cluster03-kubernetes-us-east-1\",\n \"customPartitions\": false,\n \"clusterPartitions\": [\n {\n \"clusterPartitionId\": 11,\n \"name\": \"jobs\",\n \"labels\": [\n \"Job\"\n ],\n \"instanceConfigs\": [\n {\n \"instanceConfigId\": 11,\n \"instanceType\": \"m4.xlarge\",\n \"minInstances\": 1,\n \"maxInstances\": 8,\n \"instanceMaxMemory\": 15320,\n \"instanceMaxCpu\": 4096,\n \"instanceMaxDisk\": 90.0,\n \"usageStats\": {\n \"pendingMemoryRequested\": null,\n \"pendingCpuRequested\": null,\n \"runningMemoryRequested\": null,\n \"runningCpuRequested\": null,\n \"pendingDeployments\": null,\n \"runningDeployments\": null\n }\n }\n ],\n \"defaultInstanceConfigId\": 11\n },\n {\n \"clusterPartitionId\": 12,\n \"name\": \"notebook_services\",\n \"labels\": [\n \"Notebook\",\n \"Service\"\n ],\n \"instanceConfigs\": [\n {\n \"instanceConfigId\": 12,\n \"instanceType\": \"m4.xlarge\",\n \"minInstances\": 0,\n \"maxInstances\": 2,\n \"instanceMaxMemory\": 15320,\n \"instanceMaxCpu\": 4096,\n \"instanceMaxDisk\": 90.0,\n \"usageStats\": {\n \"pendingMemoryRequested\": null,\n \"pendingCpuRequested\": null,\n \"runningMemoryRequested\": null,\n \"runningCpuRequested\": null,\n \"pendingDeployments\": null,\n \"runningDeployments\": null\n }\n }\n ],\n \"defaultInstanceConfigId\": 12\n }\n ],\n \"isNatEnabled\": false,\n \"hours\": null\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"b4d9fbe249a34a7e1d776c0d607b6632\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"010df0a9-2240-4a3a-955b-a7a0d20db163","X-Runtime":"0.043880","Content-Length":"1144"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/clusters/kubernetes/6\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer 75M0c0JTdbWo-DQqeMvzHFJEppSvnUkdNHIYmZTjCO0\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/clusters/kubernetes/{id}/compute_hours":{"get":{"summary":"List compute hours for a Kubernetes Cluster","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"type":"integer"},{"name":"include_usage_stats","in":"query","required":false,"description":"When true, usage stats are returned in instance config objects. Defaults to false.","type":"boolean"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object30"}}}},"x-examples":null,"x-deprecation-warning":null}},"/clusters/kubernetes/{id}/deployments":{"get":{"summary":"List the deployments associated with a Kubernetes Cluster","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The id of the cluster.","type":"integer"},{"name":"base_type","in":"query","required":false,"description":"If specified, return deployments of these base types. It accepts a comma-separated list, possible values are 'Notebook', 'Service', 'Run'.","type":"string"},{"name":"state","in":"query","required":false,"description":"If specified, return deployments in these states. It accepts a comma-separated list, possible values are pending, running, terminated, sleeping","type":"string"},{"name":"start_date","in":"query","required":false,"description":"If specified, return deployments created after this date. Must be 31 days or less before end date. Defaults to 7 days prior to end date. The date must be provided in the format YYYY-MM-DD.","type":"string"},{"name":"end_date","in":"query","required":false,"description":"If specified, return deployments created before this date. Defaults to 7 days after start date, or today if start date is not specified. The date must be provided in the format YYYY-MM-DD.","type":"string"},{"name":"limit","in":"query","required":false,"description":"Number of results to return. Defaults to its maximum of 50.","type":"integer"},{"name":"page_num","in":"query","required":false,"description":"Page number of the results to return. Defaults to the first page, 1.","type":"integer"},{"name":"order","in":"query","required":false,"description":"The field on which to order the result set. Defaults to created_at. Must be one of: created_at.","type":"string"},{"name":"order_dir","in":"query","required":false,"description":"Direction in which to sort, either asc (ascending) or desc (descending) defaulting to asc.","type":"string"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object32"}}}},"x-examples":null,"x-deprecation-warning":null}},"/clusters/kubernetes/{id}/deployment_stats":{"get":{"summary":"Get stats about deployments associated with a Kubernetes Cluster","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of this cluster.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object34"}}}},"x-examples":null,"x-deprecation-warning":null}},"/clusters/kubernetes/{id}/partitions":{"get":{"summary":"List Cluster Partitions for given cluster","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"type":"integer"},{"name":"include_usage_stats","in":"query","required":false,"description":"When true, usage stats are returned in instance config objects. Defaults to false.","type":"boolean"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object25"}}}},"x-examples":[{"resource":"Clusters","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/clusters/kubernetes/:id/partitions","description":"List all Cluster Partitions for a Kubernetes Cluster","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/clusters/kubernetes/15/partitions","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer 60rc_y6jLuwG_hXTNiNmlmg8ZVeunbSTqJvXPJPbLmA","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"clusterPartitionId\": 29,\n \"name\": \"jobs\",\n \"labels\": [\n \"Job\"\n ],\n \"instanceConfigs\": [\n {\n \"instanceConfigId\": 29,\n \"instanceType\": \"m4.xlarge\",\n \"minInstances\": 1,\n \"maxInstances\": 8,\n \"instanceMaxMemory\": 15320,\n \"instanceMaxCpu\": 4096,\n \"instanceMaxDisk\": 90.0,\n \"usageStats\": {\n \"pendingMemoryRequested\": null,\n \"pendingCpuRequested\": null,\n \"runningMemoryRequested\": null,\n \"runningCpuRequested\": null,\n \"pendingDeployments\": null,\n \"runningDeployments\": null\n }\n }\n ],\n \"defaultInstanceConfigId\": 29\n },\n {\n \"clusterPartitionId\": 30,\n \"name\": \"notebook_services\",\n \"labels\": [\n \"Notebook\",\n \"Service\"\n ],\n \"instanceConfigs\": [\n {\n \"instanceConfigId\": 30,\n \"instanceType\": \"m4.xlarge\",\n \"minInstances\": 0,\n \"maxInstances\": 2,\n \"instanceMaxMemory\": 15320,\n \"instanceMaxCpu\": 4096,\n \"instanceMaxDisk\": 90.0,\n \"usageStats\": {\n \"pendingMemoryRequested\": null,\n \"pendingCpuRequested\": null,\n \"runningMemoryRequested\": null,\n \"runningCpuRequested\": null,\n \"pendingDeployments\": null,\n \"runningDeployments\": null\n }\n }\n ],\n \"defaultInstanceConfigId\": 30\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"7d16f446fd1627e6cd3e86aa2b96185b\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"f0e635b7-1482-489f-a5bc-da5b0f9e0f38","X-Runtime":"0.033846","Content-Length":"915"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/clusters/kubernetes/15/partitions\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer 60rc_y6jLuwG_hXTNiNmlmg8ZVeunbSTqJvXPJPbLmA\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"post":{"summary":"Create a Cluster Partition for given cluster","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the cluster which this partition belongs to.","type":"integer"},{"name":"Object35","in":"body","schema":{"$ref":"#/definitions/Object35"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object25"}}},"x-examples":[{"resource":"Clusters","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/clusters/kubernetes/:id/partitions","description":"Create a Cluster Partition","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/clusters/kubernetes/17/partitions","request_body":"{\n \"name\": \"test\",\n \"labels\": [\n \"testlabel\"\n ],\n \"instance_configs\": [\n {\n \"instance_type\": \"m4.2xlarge\",\n \"min_instances\": 0,\n \"max_instances\": 1\n }\n ]\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer BkAQ68ac3veYVEGSlQefUg8GKgugwF7Jf9UwmnojWOQ","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"clusterPartitionId\": 35,\n \"name\": \"test\",\n \"labels\": [\n \"testlabel\"\n ],\n \"instanceConfigs\": [\n {\n \"instanceConfigId\": 35,\n \"instanceType\": \"m4.2xlarge\",\n \"minInstances\": 0,\n \"maxInstances\": 1,\n \"instanceMaxMemory\": 31641,\n \"instanceMaxCpu\": 8192,\n \"instanceMaxDisk\": 90.0,\n \"usageStats\": {\n \"pendingMemoryRequested\": null,\n \"pendingCpuRequested\": null,\n \"runningMemoryRequested\": null,\n \"runningCpuRequested\": null,\n \"pendingDeployments\": null,\n \"runningDeployments\": null\n }\n }\n ],\n \"defaultInstanceConfigId\": 35\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"6ea66d1269069c4b494c90928c467f29\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"57acd19f-43d9-4074-8f5f-04e4d5494cd1","X-Runtime":"0.034651","Content-Length":"449"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/clusters/kubernetes/17/partitions\" -d '{\"name\":\"test\",\"labels\":[\"testlabel\"],\"instance_configs\":[{\"instance_type\":\"m4.2xlarge\",\"min_instances\":0,\"max_instances\":1}]}' -X POST \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer BkAQ68ac3veYVEGSlQefUg8GKgugwF7Jf9UwmnojWOQ\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/clusters/kubernetes/{id}/partitions/{cluster_partition_id}":{"patch":{"summary":"Update a Cluster Partition","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the cluster which this partition belongs to.","type":"integer"},{"name":"cluster_partition_id","in":"path","required":true,"description":"The ID of this cluster partition.","type":"integer"},{"name":"Object37","in":"body","schema":{"$ref":"#/definitions/Object37"},"required":false}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object25"}}},"x-examples":[{"resource":"Clusters","resource_explanation":null,"http_method":"PATCH","route":"http://api.civis.test/clusters/kubernetes/:id/partitions/:cluster_partition_id","description":"Update a Cluster Partition's details","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"PATCH","request_path":"http://api.civis.test/clusters/kubernetes/19/partitions/38","request_body":"{\n \"labels\": [\n \"this\",\n \"that\"\n ]\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer 1Cxwjl3J1THBsUwcf3u18JXk7AnBoMd1zL7v-FPTqeg","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"clusterPartitionId\": 38,\n \"name\": \"jobs\",\n \"labels\": [\n \"this\",\n \"that\"\n ],\n \"instanceConfigs\": [\n {\n \"instanceConfigId\": 38,\n \"instanceType\": \"m4.xlarge\",\n \"minInstances\": 1,\n \"maxInstances\": 8,\n \"instanceMaxMemory\": 15320,\n \"instanceMaxCpu\": 4096,\n \"instanceMaxDisk\": 90.0,\n \"usageStats\": {\n \"pendingMemoryRequested\": null,\n \"pendingCpuRequested\": null,\n \"runningMemoryRequested\": null,\n \"runningCpuRequested\": null,\n \"pendingDeployments\": null,\n \"runningDeployments\": null\n }\n }\n ],\n \"defaultInstanceConfigId\": 38\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"4bcc6936359fddc61ea40fc591f25287\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"0eabd5d5-bbcb-4131-bf63-c6dbfb2f5962","X-Runtime":"0.056685","Content-Length":"450"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/clusters/kubernetes/19/partitions/38\" -d '{\"labels\":[\"this\",\"that\"]}' -X PATCH \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer 1Cxwjl3J1THBsUwcf3u18JXk7AnBoMd1zL7v-FPTqeg\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Clusters","resource_explanation":null,"http_method":"PATCH","route":"http://api.civis.test/clusters/kubernetes/:id/partitions/:cluster_partition_id","description":"Update a Cluster Partition's instance configuration","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"PATCH","request_path":"http://api.civis.test/clusters/kubernetes/20/partitions/40","request_body":"{\n \"instance_configs\": [\n {\n \"min_instances\": 3,\n \"max_instances\": 5,\n \"instance_type\": \"m4.xlarge\"\n }\n ]\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer 3x2gTCNoHAO_3my-2mFNj40egY-UNscY4rOMzi-0YuQ","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"clusterPartitionId\": 40,\n \"name\": \"jobs\",\n \"labels\": [\n \"Job\"\n ],\n \"instanceConfigs\": [\n {\n \"instanceConfigId\": 42,\n \"instanceType\": \"m4.xlarge\",\n \"minInstances\": 3,\n \"maxInstances\": 5,\n \"instanceMaxMemory\": 15320,\n \"instanceMaxCpu\": 4096,\n \"instanceMaxDisk\": 90.0,\n \"usageStats\": {\n \"pendingMemoryRequested\": null,\n \"pendingCpuRequested\": null,\n \"runningMemoryRequested\": null,\n \"runningCpuRequested\": null,\n \"pendingDeployments\": null,\n \"runningDeployments\": null\n }\n }\n ],\n \"defaultInstanceConfigId\": 42\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"5ddd1dfd427ba88d5f1145de0416b1e9\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"2b799906-1c32-48db-9e04-418d89f48ab7","X-Runtime":"0.034346","Content-Length":"442"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/clusters/kubernetes/20/partitions/40\" -d '{\"instance_configs\":[{\"min_instances\":3,\"max_instances\":5,\"instance_type\":\"m4.xlarge\"}]}' -X PATCH \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer 3x2gTCNoHAO_3my-2mFNj40egY-UNscY4rOMzi-0YuQ\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"delete":{"summary":"Delete a Cluster Partition","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the cluster which this partition belongs to.","type":"integer"},{"name":"cluster_partition_id","in":"path","required":true,"description":"The ID of this cluster partition.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":[{"resource":"Clusters","resource_explanation":null,"http_method":"DELETE","route":"http://api.civis.test/clusters/kubernetes/:id/partitions/:cluster_partition_id","description":"Delete a Cluster Partition","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"DELETE","request_path":"http://api.civis.test/clusters/kubernetes/18/partitions/36","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer eCDDysMwY3wxMK0MX_KPtHceIxgp3khKOg-AzY1KCsQ","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":204,"response_status_text":"No Content","response_body":null,"response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"0d642c2f-95db-4f67-a785-1899cbc39f2a","X-Runtime":"0.039033"},"response_content_type":null,"curl":"curl \"api.civis.testhttp://api.civis.test/clusters/kubernetes/18/partitions/36\" -d '' -X DELETE \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer eCDDysMwY3wxMK0MX_KPtHceIxgp3khKOg-AzY1KCsQ\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"get":{"summary":"Describe a Cluster Partition","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the cluster which this partition belongs to.","type":"integer"},{"name":"include_usage_stats","in":"query","required":false,"description":"When true, usage stats are returned in instance config objects. Defaults to false.","type":"boolean"},{"name":"cluster_partition_id","in":"path","required":true,"description":"The ID of this cluster partition.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object25"}}},"x-examples":[{"resource":"Clusters","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/clusters/kubernetes/:id/partitions/:cluster_partition_id","description":"View a Cluster Partitions's details","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/clusters/kubernetes/16/partitions/31","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer wAE_4Tj9p-YXOmxggOFSB4pI-Q-H3_p0tbjpRvQuydQ","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"clusterPartitionId\": 31,\n \"name\": \"jobs\",\n \"labels\": [\n \"Job\"\n ],\n \"instanceConfigs\": [\n {\n \"instanceConfigId\": 31,\n \"instanceType\": \"m4.xlarge\",\n \"minInstances\": 1,\n \"maxInstances\": 8,\n \"instanceMaxMemory\": 15320,\n \"instanceMaxCpu\": 4096,\n \"instanceMaxDisk\": 90.0,\n \"usageStats\": {\n \"pendingMemoryRequested\": null,\n \"pendingCpuRequested\": null,\n \"runningMemoryRequested\": null,\n \"runningCpuRequested\": null,\n \"pendingDeployments\": null,\n \"runningDeployments\": null\n }\n }\n ],\n \"defaultInstanceConfigId\": 31\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"dbd7647ea74d99f82f21ce96bca09592\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"18f701e1-99d9-4647-855a-6b3a38754f0d","X-Runtime":"0.034285","Content-Length":"442"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/clusters/kubernetes/16/partitions/31\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer wAE_4Tj9p-YXOmxggOFSB4pI-Q-H3_p0tbjpRvQuydQ\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/clusters/kubernetes/instance_configs/{instance_config_id}":{"get":{"summary":"Describe an Instance Config","description":null,"deprecated":false,"parameters":[{"name":"instance_config_id","in":"path","required":true,"description":"The ID of this instance config.","type":"integer"},{"name":"include_usage_stats","in":"query","required":false,"description":"When true, usage stats are returned in instance config objects. Defaults to false.","type":"boolean"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object39"}}},"x-examples":[{"resource":"Clusters","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/clusters/kubernetes/instance_configs/:instance_config_id","description":"View an instance config's details","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/clusters/kubernetes/instance_configs/19","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer OTD6YmdHL0TE2kxj009Uz-zGIax6n2pcPWPGk0sURtk","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"instanceConfigId\": 19,\n \"instanceType\": \"m4.xlarge\",\n \"minInstances\": 1,\n \"maxInstances\": 8,\n \"instanceMaxMemory\": 15320,\n \"instanceMaxCpu\": 4096,\n \"instanceMaxDisk\": 90.0,\n \"usageStats\": {\n \"pendingMemoryRequested\": null,\n \"pendingCpuRequested\": null,\n \"runningMemoryRequested\": null,\n \"runningCpuRequested\": null,\n \"pendingDeployments\": null,\n \"runningDeployments\": null\n },\n \"clusterPartitionId\": 19,\n \"clusterPartitionName\": \"jobs\"\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"d82509e71e535bc0a899995c30dc3ede\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"a895f0c3-651b-4caa-a192-0560a4a1946e","X-Runtime":"0.042051","Content-Length":"390"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/clusters/kubernetes/instance_configs/19\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer OTD6YmdHL0TE2kxj009Uz-zGIax6n2pcPWPGk0sURtk\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/clusters/kubernetes/instance_configs/{id}/active_workloads":{"get":{"summary":"List active workloads in an Instance Config","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The id of the instance config.","type":"integer"},{"name":"state","in":"query","required":false,"description":"If specified, return workloads in these states. It accepts a comma-separated list, possible values are pending, running","type":"string"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object40"}}}},"x-examples":[{"resource":"Clusters","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/clusters/kubernetes/instance_configs/:id/active_workloads","description":"List active workloads in an instance config","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/clusters/kubernetes/instance_configs/27/active_workloads","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer CepXkVqhWlatcSZXR6RJ1fkhmDh4s3QMZFKIgBUcTU4","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 2,\n \"baseType\": \"Run\",\n \"baseId\": 2,\n \"baseObjectName\": \"My python script\",\n \"jobType\": \"python_script\",\n \"jobId\": 4,\n \"jobCancelRequestedAt\": null,\n \"state\": \"running\",\n \"cpu\": 500,\n \"memory\": 2008,\n \"diskSpace\": 1.0,\n \"user\": {\n \"id\": 16,\n \"name\": \"Example User\",\n \"username\": \"devuserfactory2\",\n \"initials\": \"EU\",\n \"online\": null\n },\n \"createdAt\": \"2024-12-30T20:07:36.000Z\",\n \"cancellable\": false\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"9a518345d579af36b940de5d7e570073\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"e3d36b2d-88e0-4627-875e-c28bbdcc708a","X-Runtime":"0.067632","Content-Length":"353"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/clusters/kubernetes/instance_configs/27/active_workloads\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer CepXkVqhWlatcSZXR6RJ1fkhmDh4s3QMZFKIgBUcTU4\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/clusters/kubernetes/instance_configs/{instance_config_id}/user_statistics":{"get":{"summary":"Get statistics about the current users of an Instance Config","description":null,"deprecated":false,"parameters":[{"name":"instance_config_id","in":"path","required":true,"description":"The ID of this instance config.","type":"integer"},{"name":"order","in":"query","required":false,"description":"The field on which to order the result set. Defaults to running_deployments. Must be one of pending_memory_requested, pending_cpu_requested, running_memory_requested, running_cpu_requested, pending_deployments, running_deployments.","type":"string"},{"name":"order_dir","in":"query","required":false,"description":"Direction in which to sort, either asc (ascending) or desc (descending). Defaults to desc.","type":"string"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object41"}}}},"x-examples":[{"resource":"Clusters","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/clusters/kubernetes/instance_configs/:instance_config_id/user_statistics","description":"List user statistics for an instance config","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/clusters/kubernetes/instance_configs/21/user_statistics","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer KHjiiQ6u6y1DmLht9Bra_VjDg7MA5Bul2JOJJkADkik","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"userId\": 12,\n \"userName\": \"Example User\",\n \"pendingDeployments\": 0,\n \"pendingMemoryRequested\": 0,\n \"pendingCpuRequested\": 0,\n \"runningDeployments\": 1,\n \"runningMemoryRequested\": 2008,\n \"runningCpuRequested\": 500\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"e2ecfd5dd9aec9f9c8df865b57ef5223\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"c2398dc9-4f28-462a-9f93-b6d967a22f8a","X-Runtime":"0.046207","Content-Length":"194"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/clusters/kubernetes/instance_configs/21/user_statistics\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer KHjiiQ6u6y1DmLht9Bra_VjDg7MA5Bul2JOJJkADkik\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/clusters/kubernetes/instance_configs/{instance_config_id}/historical_graphs":{"get":{"summary":"Get graphs of historical resource usage in an Instance Config","description":null,"deprecated":false,"parameters":[{"name":"instance_config_id","in":"path","required":true,"description":"The ID of this instance config.","type":"integer"},{"name":"timeframe","in":"query","required":false,"description":"The span of time that the graphs cover. Must be one of 1_day, 1_week.","type":"string"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object42"}}},"x-examples":[{"resource":"Clusters","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/clusters/kubernetes/instance_configs/:instance_config_id/historical_graphs","description":"View historical resource usage graphs for an instance config","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/clusters/kubernetes/instance_configs/23/historical_graphs?timeframe=1_week","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer wn46A44xHYdrbbN_JiejdmkCDo9kf2JbStgmhFiBDJA","Host":"api.civis.test","Cookie":""},"request_query_parameters":{"timeframe":"1_week"},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"cpuGraphUrl\": \"https://app.datadoghq.com/graph/embed?token=cputoken&height=275&width=800&legend=false\",\n \"memGraphUrl\": \"https://app.datadoghq.com/graph/embed?token=memtoken&height=275&width=800&legend=false\"\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"a3c67938cb6d89c42d317be9182e3ef0\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"8ace10df-0f04-4a26-9e88-5a459b06a370","X-Runtime":"0.028394","Content-Length":"237"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/clusters/kubernetes/instance_configs/23/historical_graphs?timeframe=1_week\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer wn46A44xHYdrbbN_JiejdmkCDo9kf2JbStgmhFiBDJA\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/clusters/kubernetes/instance_configs/{instance_config_id}/historical_metrics":{"get":{"summary":"Get graphs of historical resource usage in an Instance Config","description":null,"deprecated":false,"parameters":[{"name":"instance_config_id","in":"path","required":true,"description":"The ID of this instance config.","type":"integer"},{"name":"timeframe","in":"query","required":false,"description":"The span of time that the graphs cover. Must be one of 1_day, 1_week.","type":"string"},{"name":"metric","in":"query","required":false,"description":"The metric to retrieve. Must be one of cpu, memory.","type":"string"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object43"}}},"x-examples":[{"resource":"Clusters","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/clusters/kubernetes/instance_configs/:instance_config_id/historical_metrics","description":"Retrieve historical metrics for an instance config","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/clusters/kubernetes/instance_configs/25/historical_metrics?timeframe=1_week&metric=cpu","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer cBbbSGrAxNXb-7HMvs0wxuVr1gS7eCvvAzTeudRcaOk","Host":"api.civis.test","Cookie":""},"request_query_parameters":{"timeframe":"1_week","metric":"cpu"},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"instanceConfigId\": 25,\n \"metric\": \"cpu\",\n \"timeframe\": \"1_week\",\n \"unit\": \"mCPU\",\n \"metrics\": {\n \"used\": {\n \"times\": [\n 1,\n 2,\n 3\n ],\n \"values\": [\n 5,\n 6,\n 7\n ]\n },\n \"requested\": {\n \"times\": [\n 1,\n 2\n ],\n \"values\": [\n 1,\n 2\n ]\n },\n \"capacity\": {\n \"times\": [\n 1,\n 2\n ],\n \"values\": [\n 3,\n 4\n ]\n }\n }\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"73574d9ed2cd0245f639ce445171e030\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"e07a40eb-38fd-4949-aeba-8b28fc9e85a5","X-Runtime":"0.031020","Content-Length":"212"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/clusters/kubernetes/instance_configs/25/historical_metrics?timeframe=1_week&metric=cpu\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer cBbbSGrAxNXb-7HMvs0wxuVr1gS7eCvvAzTeudRcaOk\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/credentials/types":{"get":{"summary":"Get list of Credential Types","description":null,"deprecated":false,"parameters":[],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object59"}}},"x-examples":null,"x-deprecation-warning":null}},"/credentials/":{"get":{"summary":"List credentials","description":null,"deprecated":false,"parameters":[{"name":"type","in":"query","required":false,"description":"The type (or types) of credentials to return. One or more of: Amazon Web Services S3, Bitbucket, CASS/NCOA PAF, Certificate, Civis Platform, Custom, Database, Google, Github, Salesforce User, Salesforce Client, and TableauUser. Specify multiple values as a comma-separated list (e.g., \"A,B\").","type":"string"},{"name":"remote_host_id","in":"query","required":false,"description":"The ID of the remote host associated with the credentials to return.","type":"integer"},{"name":"default","in":"query","required":false,"description":"If true, will return a list with a single credential which is the current user's default credential.","type":"boolean"},{"name":"system_credentials","in":"query","required":false,"description":"If true, will only return system credentials. System credentials can only be created and viewed by Civis Admins.","type":"boolean"},{"name":"users","in":"query","required":false,"description":"A comma-separated list of user ids. If specified, returns set of credentials owned by the users that requesting user has at least read access on.","type":"string"},{"name":"name","in":"query","required":false,"description":"If specified, will be used to filter the credentials returned. Will search across name and will return any full name containing the search string.","type":"string"},{"name":"limit","in":"query","required":false,"description":"Number of results to return. Defaults to its maximum of 1000.","type":"integer"},{"name":"page_num","in":"query","required":false,"description":"Page number of the results to return. Defaults to the first page, 1.","type":"integer"},{"name":"order","in":"query","required":false,"description":"The field on which to order the result set. Defaults to updated_at. Must be one of: updated_at, created_at, name.","type":"string"},{"name":"order_dir","in":"query","required":false,"description":"Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc.","type":"string"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object60"}}}},"x-examples":[{"resource":"Credentials","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/credentials","description":"#get all credentials","explanation":null,"parameters":[{"required":false,"name":"type","description":"The type (or types) of credentials to return. One or more of: Amazon Web Services S3, Bitbucket, CASS/NCOA PAF, Certificate, Civis Platform, Custom, Database, Google, Github, Salesforce User, Salesforce Client, and TableauUser. Specify multiple values as a comma-separated list (e.g., \"A,B\")."},{"required":false,"name":"remoteHostId","description":"The ID of the remote host associated with the credentials to return."},{"required":false,"name":"default","description":"If true, will return a list with a single credential which is the current user's default credential."},{"required":false,"name":"systemCredentials","description":"If true, will only return system credentials. System credentials can only be created and viewed by Civis Admins."},{"required":false,"name":"users","description":"A comma-separated list of user ids. If specified, returns set of credentials owned by the users that requesting user has at least read access on."},{"required":false,"name":"name","description":"If specified, will be used to filter the credentials returned. Will search across name and will return any full name containing the search string."},{"required":false,"name":"limit","description":"Number of results to return. Defaults to its maximum of 1000."},{"required":false,"name":"pageNum","description":"Page number of the results to return. Defaults to the first page, 1."},{"required":false,"name":"order","description":"The field on which to order the result set. Defaults to updated_at. Must be one of: updated_at, created_at, name."},{"required":false,"name":"orderDir","description":"Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc."}],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/credentials","request_body":null,"request_headers":{"Content-Type":"application/json","Authorization":"Bearer lWRcdYuWQC71P1UU-3Xp0FtBO3m3r4ABIoZgMLNG_QA","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 10,\n \"name\": \"db_user-1\",\n \"type\": \"Database\",\n \"username\": \"db_user-1\",\n \"description\": null,\n \"owner\": \"devuserfactory10\",\n \"user\": {\n \"id\": 34,\n \"name\": \"User devuserfactory10 8\",\n \"username\": \"devuserfactory10\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"remoteHostId\": 12,\n \"remoteHostName\": \"redshift-10000\",\n \"state\": null,\n \"createdAt\": \"2023-07-18T18:39:28.000Z\",\n \"updatedAt\": \"2023-07-18T18:38:28.000Z\",\n \"default\": false,\n \"oauth\": false\n },\n {\n \"id\": 12,\n \"name\": \"db_user-2\",\n \"type\": \"Database\",\n \"username\": \"db_user-2\",\n \"description\": null,\n \"owner\": \"devuserfactory10\",\n \"user\": {\n \"id\": 34,\n \"name\": \"User devuserfactory10 8\",\n \"username\": \"devuserfactory10\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"remoteHostId\": 13,\n \"remoteHostName\": \"redshift-10001\",\n \"state\": null,\n \"createdAt\": \"2023-07-18T18:39:28.000Z\",\n \"updatedAt\": \"2023-07-18T18:37:28.000Z\",\n \"default\": false,\n \"oauth\": false\n },\n {\n \"id\": 13,\n \"name\": \"salesforce-user-key-1\",\n \"type\": \"Salesforce User\",\n \"username\": \"skomanduri@civisanalytics.com\",\n \"description\": null,\n \"owner\": \"devuserfactory10\",\n \"user\": {\n \"id\": 34,\n \"name\": \"User devuserfactory10 8\",\n \"username\": \"devuserfactory10\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"remoteHostId\": null,\n \"remoteHostName\": null,\n \"state\": null,\n \"createdAt\": \"2023-07-18T18:39:28.000Z\",\n \"updatedAt\": \"2023-07-18T18:36:28.000Z\",\n \"default\": false,\n \"oauth\": false\n },\n {\n \"id\": 14,\n \"name\": \"Rentrak\",\n \"type\": \"Amazon Web Services S3\",\n \"username\": \"b1a44ca7-2c68-4a69-9986-cad248264f35\",\n \"description\": null,\n \"owner\": \"devuserfactory10\",\n \"user\": {\n \"id\": 34,\n \"name\": \"User devuserfactory10 8\",\n \"username\": \"devuserfactory10\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"remoteHostId\": null,\n \"remoteHostName\": null,\n \"state\": null,\n \"createdAt\": \"2023-07-18T18:39:28.000Z\",\n \"updatedAt\": \"2023-07-18T18:34:28.000Z\",\n \"default\": false,\n \"oauth\": false\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","X-Pagination-Per-Page":"1000","Access-Control-Expose-Headers":"X-Pagination-Per-Page, X-Pagination-Current-Page, X-Pagination-Total-Pages, X-Pagination-Total-Entries","X-Pagination-Current-Page":"1","X-Pagination-Total-Pages":"1","X-Pagination-Total-Entries":"4","Content-Type":"application/json; charset=utf-8","ETag":"W/\"f5942b4f55bf56bd4d9c3c528db50a41\"","X-Request-Id":"48ca0a58-455b-4492-bd11-97c6db7690d3","X-Runtime":"0.033309","Content-Length":"1655"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/credentials\" -X GET \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer lWRcdYuWQC71P1UU-3Xp0FtBO3m3r4ABIoZgMLNG_QA\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Credentials","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/credentials","description":"#get all credentials","explanation":null,"parameters":[{"required":false,"name":"type","description":"The type (or types) of credentials to return. One or more of: Amazon Web Services S3, Bitbucket, CASS/NCOA PAF, Certificate, Civis Platform, Custom, Database, Google, Github, Salesforce User, Salesforce Client, and TableauUser. Specify multiple values as a comma-separated list (e.g., \"A,B\")."},{"required":false,"name":"remoteHostId","description":"The ID of the remote host associated with the credentials to return."},{"required":false,"name":"default","description":"If true, will return a list with a single credential which is the current user's default credential."},{"required":false,"name":"systemCredentials","description":"If true, will only return system credentials. System credentials can only be created and viewed by Civis Admins."},{"required":false,"name":"users","description":"A comma-separated list of user ids. If specified, returns set of credentials owned by the users that requesting user has at least read access on."},{"required":false,"name":"name","description":"If specified, will be used to filter the credentials returned. Will search across name and will return any full name containing the search string."},{"required":false,"name":"limit","description":"Number of results to return. Defaults to its maximum of 1000."},{"required":false,"name":"pageNum","description":"Page number of the results to return. Defaults to the first page, 1."},{"required":false,"name":"order","description":"The field on which to order the result set. Defaults to updated_at. Must be one of: updated_at, created_at, name."},{"required":false,"name":"orderDir","description":"Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc."}],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/credentials","request_body":null,"request_headers":{"Content-Type":"application/json","Authorization":"Bearer -jElCftQeUXoOmEPiZfC3Nt_rRg_JOJFj_8GGKq6Yak","Accept":"application/vnd.civis-platform.v2","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 16,\n \"name\": \"db_user-3\",\n \"type\": \"Database\",\n \"username\": \"db_user-3\",\n \"description\": null,\n \"owner\": \"devuserfactory11\",\n \"user\": {\n \"id\": 37,\n \"name\": \"User devuserfactory11 9\",\n \"username\": \"devuserfactory11\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"remoteHostId\": 15,\n \"remoteHostName\": \"redshift-10002\",\n \"state\": null,\n \"createdAt\": \"2023-07-18T18:39:28.000Z\",\n \"updatedAt\": \"2023-07-18T18:38:28.000Z\",\n \"default\": false,\n \"oauth\": false\n },\n {\n \"id\": 18,\n \"name\": \"db_user-4\",\n \"type\": \"Database\",\n \"username\": \"db_user-4\",\n \"description\": null,\n \"owner\": \"devuserfactory11\",\n \"user\": {\n \"id\": 37,\n \"name\": \"User devuserfactory11 9\",\n \"username\": \"devuserfactory11\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"remoteHostId\": 16,\n \"remoteHostName\": \"redshift-10003\",\n \"state\": null,\n \"createdAt\": \"2023-07-18T18:39:28.000Z\",\n \"updatedAt\": \"2023-07-18T18:37:28.000Z\",\n \"default\": false,\n \"oauth\": false\n },\n {\n \"id\": 19,\n \"name\": \"salesforce-user-key-2\",\n \"type\": \"Salesforce User\",\n \"username\": \"skomanduri@civisanalytics.com\",\n \"description\": null,\n \"owner\": \"devuserfactory11\",\n \"user\": {\n \"id\": 37,\n \"name\": \"User devuserfactory11 9\",\n \"username\": \"devuserfactory11\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"remoteHostId\": null,\n \"remoteHostName\": null,\n \"state\": null,\n \"createdAt\": \"2023-07-18T18:39:28.000Z\",\n \"updatedAt\": \"2023-07-18T18:36:28.000Z\",\n \"default\": false,\n \"oauth\": false\n },\n {\n \"id\": 20,\n \"name\": \"Rentrak\",\n \"type\": \"Amazon Web Services S3\",\n \"username\": \"b1a44ca7-2c68-4a69-9986-cad248264f35\",\n \"description\": null,\n \"owner\": \"devuserfactory11\",\n \"user\": {\n \"id\": 37,\n \"name\": \"User devuserfactory11 9\",\n \"username\": \"devuserfactory11\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"remoteHostId\": null,\n \"remoteHostName\": null,\n \"state\": null,\n \"createdAt\": \"2023-07-18T18:39:28.000Z\",\n \"updatedAt\": \"2023-07-18T18:34:28.000Z\",\n \"default\": false,\n \"oauth\": false\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","X-Pagination-Per-Page":"1000","Access-Control-Expose-Headers":"X-Pagination-Per-Page, X-Pagination-Current-Page, X-Pagination-Total-Pages, X-Pagination-Total-Entries","X-Pagination-Current-Page":"1","X-Pagination-Total-Pages":"1","X-Pagination-Total-Entries":"4","Content-Type":"application/json; charset=utf-8","ETag":"W/\"efe5254b2f627e525b81252c184fbdd3\"","X-Request-Id":"c75a2cf7-260d-4d8f-a30c-0c803a56c9f1","X-Runtime":"0.021882","Content-Length":"1655"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/credentials\" -X GET \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer -jElCftQeUXoOmEPiZfC3Nt_rRg_JOJFj_8GGKq6Yak\" \\\n\t-H \"Accept: application/vnd.civis-platform.v2\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Credentials","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/credentials?type=Database","description":"List all credentials of the specified type","explanation":null,"parameters":[{"required":false,"name":"type","description":"The type (or types) of credentials to return. One or more of: Amazon Web Services S3, Bitbucket, CASS/NCOA PAF, Certificate, Civis Platform, Custom, Database, Google, Github, Salesforce User, Salesforce Client, and TableauUser. Specify multiple values as a comma-separated list (e.g., \"A,B\")."},{"required":false,"name":"remoteHostId","description":"The ID of the remote host associated with the credentials to return."},{"required":false,"name":"default","description":"If true, will return a list with a single credential which is the current user's default credential."},{"required":false,"name":"systemCredentials","description":"If true, will only return system credentials. System credentials can only be created and viewed by Civis Admins."},{"required":false,"name":"users","description":"A comma-separated list of user ids. If specified, returns set of credentials owned by the users that requesting user has at least read access on."},{"required":false,"name":"name","description":"If specified, will be used to filter the credentials returned. Will search across name and will return any full name containing the search string."},{"required":false,"name":"limit","description":"Number of results to return. Defaults to its maximum of 1000."},{"required":false,"name":"pageNum","description":"Page number of the results to return. Defaults to the first page, 1."},{"required":false,"name":"order","description":"The field on which to order the result set. Defaults to updated_at. Must be one of: updated_at, created_at, name."},{"required":false,"name":"orderDir","description":"Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc."}],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/credentials?type=Database","request_body":null,"request_headers":{"Content-Type":"application/json","Authorization":"Bearer kCJTtAHf9tOeeRMJx-OKl_gsiDq1xLEM2ZlfJHvc3Zw","Host":"api.civis.test","Cookie":""},"request_query_parameters":{"type":"Database"},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 22,\n \"name\": \"db_user-5\",\n \"type\": \"Database\",\n \"username\": \"db_user-5\",\n \"description\": null,\n \"owner\": \"devuserfactory12\",\n \"user\": {\n \"id\": 40,\n \"name\": \"User devuserfactory12 10\",\n \"username\": \"devuserfactory12\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"remoteHostId\": 18,\n \"remoteHostName\": \"redshift-10004\",\n \"state\": null,\n \"createdAt\": \"2023-07-18T18:39:28.000Z\",\n \"updatedAt\": \"2023-07-18T18:38:28.000Z\",\n \"default\": false,\n \"oauth\": false\n },\n {\n \"id\": 24,\n \"name\": \"db_user-6\",\n \"type\": \"Database\",\n \"username\": \"db_user-6\",\n \"description\": null,\n \"owner\": \"devuserfactory12\",\n \"user\": {\n \"id\": 40,\n \"name\": \"User devuserfactory12 10\",\n \"username\": \"devuserfactory12\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"remoteHostId\": 19,\n \"remoteHostName\": \"redshift-10005\",\n \"state\": null,\n \"createdAt\": \"2023-07-18T18:39:28.000Z\",\n \"updatedAt\": \"2023-07-18T18:37:28.000Z\",\n \"default\": false,\n \"oauth\": false\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","X-Pagination-Per-Page":"1000","Access-Control-Expose-Headers":"X-Pagination-Per-Page, X-Pagination-Current-Page, X-Pagination-Total-Pages, X-Pagination-Total-Entries","X-Pagination-Current-Page":"1","X-Pagination-Total-Pages":"1","X-Pagination-Total-Entries":"2","Content-Type":"application/json; charset=utf-8","ETag":"W/\"b0ed064374bcb6f1b44ef1d6956a6370\"","X-Request-Id":"079e5424-f525-4281-846e-28f0c47c5ade","X-Runtime":"0.020379","Content-Length":"801"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/credentials?type=Database\" -X GET \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer kCJTtAHf9tOeeRMJx-OKl_gsiDq1xLEM2ZlfJHvc3Zw\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Credentials","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/credentials?type=Database,Salesforce User","description":"List all credentials of multiple types","explanation":null,"parameters":[{"required":false,"name":"type","description":"The type (or types) of credentials to return. One or more of: Amazon Web Services S3, Bitbucket, CASS/NCOA PAF, Certificate, Civis Platform, Custom, Database, Google, Github, Salesforce User, Salesforce Client, and TableauUser. Specify multiple values as a comma-separated list (e.g., \"A,B\")."},{"required":false,"name":"remoteHostId","description":"The ID of the remote host associated with the credentials to return."},{"required":false,"name":"default","description":"If true, will return a list with a single credential which is the current user's default credential."},{"required":false,"name":"systemCredentials","description":"If true, will only return system credentials. System credentials can only be created and viewed by Civis Admins."},{"required":false,"name":"users","description":"A comma-separated list of user ids. If specified, returns set of credentials owned by the users that requesting user has at least read access on."},{"required":false,"name":"name","description":"If specified, will be used to filter the credentials returned. Will search across name and will return any full name containing the search string."},{"required":false,"name":"limit","description":"Number of results to return. Defaults to its maximum of 1000."},{"required":false,"name":"pageNum","description":"Page number of the results to return. Defaults to the first page, 1."},{"required":false,"name":"order","description":"The field on which to order the result set. Defaults to updated_at. Must be one of: updated_at, created_at, name."},{"required":false,"name":"orderDir","description":"Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc."}],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/credentials?type=Database,Salesforce User","request_body":null,"request_headers":{"Content-Type":"application/json","Authorization":"Bearer ewWXjWGfSIPFHnCkQIpZtpLesBPDFuE4KDus749ubCM","Host":"api.civis.test","Cookie":""},"request_query_parameters":{"type":"Database,Salesforce User"},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 28,\n \"name\": \"db_user-7\",\n \"type\": \"Database\",\n \"username\": \"db_user-7\",\n \"description\": null,\n \"owner\": \"devuserfactory13\",\n \"user\": {\n \"id\": 43,\n \"name\": \"User devuserfactory13 11\",\n \"username\": \"devuserfactory13\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"remoteHostId\": 21,\n \"remoteHostName\": \"redshift-10006\",\n \"state\": null,\n \"createdAt\": \"2023-07-18T18:39:29.000Z\",\n \"updatedAt\": \"2023-07-18T18:38:28.000Z\",\n \"default\": false,\n \"oauth\": false\n },\n {\n \"id\": 30,\n \"name\": \"db_user-8\",\n \"type\": \"Database\",\n \"username\": \"db_user-8\",\n \"description\": null,\n \"owner\": \"devuserfactory13\",\n \"user\": {\n \"id\": 43,\n \"name\": \"User devuserfactory13 11\",\n \"username\": \"devuserfactory13\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"remoteHostId\": 22,\n \"remoteHostName\": \"redshift-10007\",\n \"state\": null,\n \"createdAt\": \"2023-07-18T18:39:29.000Z\",\n \"updatedAt\": \"2023-07-18T18:37:29.000Z\",\n \"default\": false,\n \"oauth\": false\n },\n {\n \"id\": 31,\n \"name\": \"salesforce-user-key-4\",\n \"type\": \"Salesforce User\",\n \"username\": \"skomanduri@civisanalytics.com\",\n \"description\": null,\n \"owner\": \"devuserfactory13\",\n \"user\": {\n \"id\": 43,\n \"name\": \"User devuserfactory13 11\",\n \"username\": \"devuserfactory13\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"remoteHostId\": null,\n \"remoteHostName\": null,\n \"state\": null,\n \"createdAt\": \"2023-07-18T18:39:29.000Z\",\n \"updatedAt\": \"2023-07-18T18:36:29.000Z\",\n \"default\": false,\n \"oauth\": false\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","X-Pagination-Per-Page":"1000","Access-Control-Expose-Headers":"X-Pagination-Per-Page, X-Pagination-Current-Page, X-Pagination-Total-Pages, X-Pagination-Total-Entries","X-Pagination-Current-Page":"1","X-Pagination-Total-Pages":"1","X-Pagination-Total-Entries":"3","Content-Type":"application/json; charset=utf-8","ETag":"W/\"823dfe77904906c002e653ae5b757820\"","X-Request-Id":"c23a6866-e893-482a-bf1e-37da07317130","X-Runtime":"0.020499","Content-Length":"1230"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/credentials?type=Database,Salesforce User\" -X GET \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer ewWXjWGfSIPFHnCkQIpZtpLesBPDFuE4KDus749ubCM\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Credentials","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/credentials?remoteHostId=:remote_host_id","description":"List all credentials of the specified remote host","explanation":null,"parameters":[{"required":false,"name":"type","description":"The type (or types) of credentials to return. One or more of: Amazon Web Services S3, Bitbucket, CASS/NCOA PAF, Certificate, Civis Platform, Custom, Database, Google, Github, Salesforce User, Salesforce Client, and TableauUser. Specify multiple values as a comma-separated list (e.g., \"A,B\")."},{"required":false,"name":"remoteHostId","description":"The ID of the remote host associated with the credentials to return."},{"required":false,"name":"default","description":"If true, will return a list with a single credential which is the current user's default credential."},{"required":false,"name":"systemCredentials","description":"If true, will only return system credentials. System credentials can only be created and viewed by Civis Admins."},{"required":false,"name":"users","description":"A comma-separated list of user ids. If specified, returns set of credentials owned by the users that requesting user has at least read access on."},{"required":false,"name":"name","description":"If specified, will be used to filter the credentials returned. Will search across name and will return any full name containing the search string."},{"required":false,"name":"limit","description":"Number of results to return. Defaults to its maximum of 1000."},{"required":false,"name":"pageNum","description":"Page number of the results to return. Defaults to the first page, 1."},{"required":false,"name":"order","description":"The field on which to order the result set. Defaults to updated_at. Must be one of: updated_at, created_at, name."},{"required":false,"name":"orderDir","description":"Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc."}],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/credentials?remoteHostId=25","request_body":null,"request_headers":{"Content-Type":"application/json","Authorization":"Bearer zzbd9McxSd7aqfXop4oK5fk84cD4MxW1M3YmnP_X2qw","Host":"api.civis.test","Cookie":""},"request_query_parameters":{"remoteHostId":"25"},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 36,\n \"name\": \"db_user-10\",\n \"type\": \"Database\",\n \"username\": \"db_user-10\",\n \"description\": null,\n \"owner\": \"devuserfactory14\",\n \"user\": {\n \"id\": 46,\n \"name\": \"User devuserfactory14 12\",\n \"username\": \"devuserfactory14\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"remoteHostId\": 25,\n \"remoteHostName\": \"redshift-10009\",\n \"state\": null,\n \"createdAt\": \"2023-07-18T18:39:29.000Z\",\n \"updatedAt\": \"2023-07-18T18:37:29.000Z\",\n \"default\": false,\n \"oauth\": false\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","X-Pagination-Per-Page":"1000","Access-Control-Expose-Headers":"X-Pagination-Per-Page, X-Pagination-Current-Page, X-Pagination-Total-Pages, X-Pagination-Total-Entries","X-Pagination-Current-Page":"1","X-Pagination-Total-Pages":"1","X-Pagination-Total-Entries":"1","Content-Type":"application/json; charset=utf-8","ETag":"W/\"7a7fd4e1cc290b5cd2c2cc9c806544be\"","X-Request-Id":"0a44acbe-7bfc-4b52-8415-716ea6025ad3","X-Runtime":"0.022545","Content-Length":"403"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/credentials?remoteHostId=25\" -X GET \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer zzbd9McxSd7aqfXop4oK5fk84cD4MxW1M3YmnP_X2qw\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"post":{"summary":"Create a credential","description":null,"deprecated":false,"parameters":[{"name":"Object61","in":"body","schema":{"$ref":"#/definitions/Object61"},"required":true}],"responses":{"201":{"description":"success","schema":{"$ref":"#/definitions/Object60"}}},"x-examples":[{"resource":"Credentials","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/credentials","description":"Create a credential with a remote host","explanation":null,"parameters":[{"required":false,"name":"type","description":"The type (or types) of credentials to return. One or more of: Amazon Web Services S3, Bitbucket, CASS/NCOA PAF, Certificate, Civis Platform, Custom, Database, Google, Github, Salesforce User, Salesforce Client, and TableauUser. Specify multiple values as a comma-separated list (e.g., \"A,B\")."},{"required":false,"name":"remoteHostId","description":"The ID of the remote host associated with the credentials to return."},{"required":false,"name":"default","description":"If true, will return a list with a single credential which is the current user's default credential."},{"required":false,"name":"systemCredentials","description":"If true, will only return system credentials. System credentials can only be created and viewed by Civis Admins."},{"required":false,"name":"users","description":"A comma-separated list of user ids. If specified, returns set of credentials owned by the users that requesting user has at least read access on."},{"required":false,"name":"name","description":"If specified, will be used to filter the credentials returned. Will search across name and will return any full name containing the search string."},{"required":false,"name":"limit","description":"Number of results to return. Defaults to its maximum of 1000."},{"required":false,"name":"pageNum","description":"Page number of the results to return. Defaults to the first page, 1."},{"required":false,"name":"order","description":"The field on which to order the result set. Defaults to updated_at. Must be one of: updated_at, created_at, name."},{"required":false,"name":"orderDir","description":"Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc."}],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/credentials","request_body":"{\n \"username\": \"myUsername\",\n \"password\": \"myPassword\",\n \"type\": \"Database\",\n \"remote_host_id\": 32\n}","request_headers":{"Content-Type":"application/json","Authorization":"Bearer xwYT64ELyis0oONJywWu3WBL0aC9KYIqL5abCfIeY-4","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":201,"response_status_text":"Created","response_body":"{\n \"id\": 51,\n \"name\": \"myUsername\",\n \"type\": \"Database\",\n \"username\": \"myUsername\",\n \"description\": null,\n \"owner\": \"devuserfactory16\",\n \"user\": {\n \"id\": 52,\n \"name\": \"User devuserfactory16 14\",\n \"username\": \"devuserfactory16\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"remoteHostId\": 32,\n \"remoteHostName\": \"mysql-10006\",\n \"state\": null,\n \"createdAt\": \"2023-07-18T18:39:29.000Z\",\n \"updatedAt\": \"2023-07-18T18:39:29.000Z\",\n \"default\": false,\n \"oauth\": false\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"5060fd02a3871d6ab3bf73a612b296b6\"","X-Request-Id":"7115d4a8-7422-4526-8ca1-080507e854cb","X-Runtime":"0.029738","Content-Length":"398"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/credentials\" -d '{\"username\":\"myUsername\",\"password\":\"myPassword\",\"type\":\"Database\",\"remote_host_id\":32}' -X POST \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer xwYT64ELyis0oONJywWu3WBL0aC9KYIqL5abCfIeY-4\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Credentials","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/credentials","description":"Create a credential without a remote host","explanation":null,"parameters":[{"required":false,"name":"type","description":"The type (or types) of credentials to return. One or more of: Amazon Web Services S3, Bitbucket, CASS/NCOA PAF, Certificate, Civis Platform, Custom, Database, Google, Github, Salesforce User, Salesforce Client, and TableauUser. Specify multiple values as a comma-separated list (e.g., \"A,B\")."},{"required":false,"name":"remoteHostId","description":"The ID of the remote host associated with the credentials to return."},{"required":false,"name":"default","description":"If true, will return a list with a single credential which is the current user's default credential."},{"required":false,"name":"systemCredentials","description":"If true, will only return system credentials. System credentials can only be created and viewed by Civis Admins."},{"required":false,"name":"users","description":"A comma-separated list of user ids. If specified, returns set of credentials owned by the users that requesting user has at least read access on."},{"required":false,"name":"name","description":"If specified, will be used to filter the credentials returned. Will search across name and will return any full name containing the search string."},{"required":false,"name":"limit","description":"Number of results to return. Defaults to its maximum of 1000."},{"required":false,"name":"pageNum","description":"Page number of the results to return. Defaults to the first page, 1."},{"required":false,"name":"order","description":"The field on which to order the result set. Defaults to updated_at. Must be one of: updated_at, created_at, name."},{"required":false,"name":"orderDir","description":"Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc."}],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/credentials","request_body":"{\n \"username\": \"myUsername\",\n \"password\": \"myPassword\",\n \"type\": \"Custom\"\n}","request_headers":{"Content-Type":"application/json","Authorization":"Bearer y06KLhKAk83E9Br0bZUjXZ3wOaiAEZODQgLN7KuU8qo","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":201,"response_status_text":"Created","response_body":"{\n \"id\": 58,\n \"name\": \"myUsername\",\n \"type\": \"Custom\",\n \"username\": \"myUsername\",\n \"description\": null,\n \"owner\": \"devuserfactory17\",\n \"user\": {\n \"id\": 55,\n \"name\": \"User devuserfactory17 15\",\n \"username\": \"devuserfactory17\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"remoteHostId\": null,\n \"remoteHostName\": null,\n \"state\": null,\n \"createdAt\": \"2023-07-18T18:39:30.000Z\",\n \"updatedAt\": \"2023-07-18T18:39:30.000Z\",\n \"default\": false,\n \"oauth\": false\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"ec04daff3f0ae9ce74316dce0ba6ec2d\"","X-Request-Id":"696616d0-1273-4eca-aaff-1f5b40641b61","X-Runtime":"0.022498","Content-Length":"389"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/credentials\" -d '{\"username\":\"myUsername\",\"password\":\"myPassword\",\"type\":\"Custom\"}' -X POST \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer y06KLhKAk83E9Br0bZUjXZ3wOaiAEZODQgLN7KuU8qo\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/credentials/{id}":{"put":{"summary":"Update an existing credential","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the credential.","type":"integer"},{"name":"Object62","in":"body","schema":{"$ref":"#/definitions/Object62"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object60"}}},"x-examples":[{"resource":"Credentials","resource_explanation":null,"http_method":"PUT","route":"http://api.civis.test/credentials/:id","description":"Update a database credential","explanation":null,"parameters":[{"required":false,"name":"type","description":"The type (or types) of credentials to return. One or more of: Amazon Web Services S3, Bitbucket, CASS/NCOA PAF, Certificate, Civis Platform, Custom, Database, Google, Github, Salesforce User, Salesforce Client, and TableauUser. Specify multiple values as a comma-separated list (e.g., \"A,B\")."},{"required":false,"name":"remoteHostId","description":"The ID of the remote host associated with the credentials to return."},{"required":false,"name":"default","description":"If true, will return a list with a single credential which is the current user's default credential."},{"required":false,"name":"systemCredentials","description":"If true, will only return system credentials. System credentials can only be created and viewed by Civis Admins."},{"required":false,"name":"users","description":"A comma-separated list of user ids. If specified, returns set of credentials owned by the users that requesting user has at least read access on."},{"required":false,"name":"name","description":"If specified, will be used to filter the credentials returned. Will search across name and will return any full name containing the search string."},{"required":false,"name":"limit","description":"Number of results to return. Defaults to its maximum of 1000."},{"required":false,"name":"pageNum","description":"Page number of the results to return. Defaults to the first page, 1."},{"required":false,"name":"order","description":"The field on which to order the result set. Defaults to updated_at. Must be one of: updated_at, created_at, name."},{"required":false,"name":"orderDir","description":"Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc."}],"response_fields":[],"requests":[{"request_method":"PUT","request_path":"http://api.civis.test/credentials/64","request_body":"{\n \"name\": \"Updated Credential Name\",\n \"username\": \"myNewUsername\",\n \"password\": \"myNewPassword\",\n \"type\": \"Database\",\n \"remote_host_id\": 38\n}","request_headers":{"Content-Type":"application/json","Authorization":"Bearer Dodr5YT6zH8kyylIQu0SoA0pRPjqfxSPU_22cqItfvE","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 64,\n \"name\": \"Updated Credential Name\",\n \"type\": \"Database\",\n \"username\": \"myNewUsername\",\n \"description\": null,\n \"owner\": \"devuserfactory18\",\n \"user\": {\n \"id\": 58,\n \"name\": \"User devuserfactory18 16\",\n \"username\": \"devuserfactory18\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"remoteHostId\": 38,\n \"remoteHostName\": \"mysql-10008\",\n \"state\": null,\n \"createdAt\": \"2023-07-18T18:39:30.000Z\",\n \"updatedAt\": \"2023-07-18T18:39:31.000Z\",\n \"default\": false,\n \"oauth\": false\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"7642a485f3aceef05ed034dddd076fdd\"","X-Request-Id":"f6e27efc-12bc-4337-b449-3c45acbf56fc","X-Runtime":"0.041967","Content-Length":"414"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/credentials/64\" -d '{\"name\":\"Updated Credential Name\",\"username\":\"myNewUsername\",\"password\":\"myNewPassword\",\"type\":\"Database\",\"remote_host_id\":38}' -X PUT \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer Dodr5YT6zH8kyylIQu0SoA0pRPjqfxSPU_22cqItfvE\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Credentials","resource_explanation":null,"http_method":"PUT","route":"http://api.civis.test/credentials/:id","description":"Update a custom credential","explanation":null,"parameters":[{"required":false,"name":"type","description":"The type (or types) of credentials to return. One or more of: Amazon Web Services S3, Bitbucket, CASS/NCOA PAF, Certificate, Civis Platform, Custom, Database, Google, Github, Salesforce User, Salesforce Client, and TableauUser. Specify multiple values as a comma-separated list (e.g., \"A,B\")."},{"required":false,"name":"remoteHostId","description":"The ID of the remote host associated with the credentials to return."},{"required":false,"name":"default","description":"If true, will return a list with a single credential which is the current user's default credential."},{"required":false,"name":"systemCredentials","description":"If true, will only return system credentials. System credentials can only be created and viewed by Civis Admins."},{"required":false,"name":"users","description":"A comma-separated list of user ids. If specified, returns set of credentials owned by the users that requesting user has at least read access on."},{"required":false,"name":"name","description":"If specified, will be used to filter the credentials returned. Will search across name and will return any full name containing the search string."},{"required":false,"name":"limit","description":"Number of results to return. Defaults to its maximum of 1000."},{"required":false,"name":"pageNum","description":"Page number of the results to return. Defaults to the first page, 1."},{"required":false,"name":"order","description":"The field on which to order the result set. Defaults to updated_at. Must be one of: updated_at, created_at, name."},{"required":false,"name":"orderDir","description":"Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc."}],"response_fields":[],"requests":[{"request_method":"PUT","request_path":"http://api.civis.test/credentials/70","request_body":"{\n \"name\": \"Custom Name\",\n \"username\": \"myUserName\",\n \"password\": \"myNewPassword\",\n \"type\": \"Custom\"\n}","request_headers":{"Content-Type":"application/json","Authorization":"Bearer Zf7FyMc6F99HJPJTMMk_UFK3s6chBUoFoPreVp73X1c","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 70,\n \"name\": \"Custom Name\",\n \"type\": \"Custom\",\n \"username\": \"myUserName\",\n \"description\": null,\n \"owner\": \"devuserfactory19\",\n \"user\": {\n \"id\": 61,\n \"name\": \"User devuserfactory19 17\",\n \"username\": \"devuserfactory19\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"remoteHostId\": null,\n \"remoteHostName\": null,\n \"state\": null,\n \"createdAt\": \"2023-07-18T18:39:31.000Z\",\n \"updatedAt\": \"2023-07-18T18:39:31.000Z\",\n \"default\": false,\n \"oauth\": false\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"00d38ac6ebf68b372c0ee16f9403ba49\"","X-Request-Id":"0dd57aac-b8be-4cb3-ad8a-da37c6bbc69f","X-Runtime":"0.041605","Content-Length":"390"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/credentials/70\" -d '{\"name\":\"Custom Name\",\"username\":\"myUserName\",\"password\":\"myNewPassword\",\"type\":\"Custom\"}' -X PUT \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer Zf7FyMc6F99HJPJTMMk_UFK3s6chBUoFoPreVp73X1c\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"patch":{"summary":"Update some attributes of a credential","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the credential.","type":"integer"},{"name":"Object63","in":"body","schema":{"$ref":"#/definitions/Object63"},"required":false}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object60"}}},"x-examples":null,"x-deprecation-warning":null},"get":{"summary":"Get a credential","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the credential.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object60"}}},"x-examples":[{"resource":"Credentials","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/credentials/:id","description":"#get view credential","explanation":null,"parameters":[{"required":false,"name":"type","description":"The type (or types) of credentials to return. One or more of: Amazon Web Services S3, Bitbucket, CASS/NCOA PAF, Certificate, Civis Platform, Custom, Database, Google, Github, Salesforce User, Salesforce Client, and TableauUser. Specify multiple values as a comma-separated list (e.g., \"A,B\")."},{"required":false,"name":"remoteHostId","description":"The ID of the remote host associated with the credentials to return."},{"required":false,"name":"default","description":"If true, will return a list with a single credential which is the current user's default credential."},{"required":false,"name":"systemCredentials","description":"If true, will only return system credentials. System credentials can only be created and viewed by Civis Admins."},{"required":false,"name":"users","description":"A comma-separated list of user ids. If specified, returns set of credentials owned by the users that requesting user has at least read access on."},{"required":false,"name":"name","description":"If specified, will be used to filter the credentials returned. Will search across name and will return any full name containing the search string."},{"required":false,"name":"limit","description":"Number of results to return. Defaults to its maximum of 1000."},{"required":false,"name":"pageNum","description":"Page number of the results to return. Defaults to the first page, 1."},{"required":false,"name":"order","description":"The field on which to order the result set. Defaults to updated_at. Must be one of: updated_at, created_at, name."},{"required":false,"name":"orderDir","description":"Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc."}],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/credentials/76","request_body":null,"request_headers":{"Content-Type":"application/json","Authorization":"Bearer fVm7FD1_YGm2LtU6ARZP4Xfwh8C5RT3Nbesfu75DqFc","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 76,\n \"name\": \"Rentrak\",\n \"type\": \"Amazon Web Services S3\",\n \"username\": \"b1a44ca7-2c68-4a69-9986-cad248264f35\",\n \"description\": null,\n \"owner\": \"devuserfactory20\",\n \"user\": {\n \"id\": 64,\n \"name\": \"User devuserfactory20 18\",\n \"username\": \"devuserfactory20\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"remoteHostId\": null,\n \"remoteHostName\": null,\n \"state\": null,\n \"createdAt\": \"2023-07-18T18:39:31.000Z\",\n \"updatedAt\": \"2023-07-18T18:34:31.000Z\",\n \"default\": false,\n \"oauth\": false\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"96f0962884a7fdfc83fb021ee638f213\"","X-Request-Id":"9dcc675a-bd46-4bb7-b842-dac944be918e","X-Runtime":"0.015075","Content-Length":"428"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/credentials/76\" -X GET \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer fVm7FD1_YGm2LtU6ARZP4Xfwh8C5RT3Nbesfu75DqFc\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Credentials","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/credentials/:id","description":"#get view credential","explanation":null,"parameters":[{"required":false,"name":"type","description":"The type (or types) of credentials to return. One or more of: Amazon Web Services S3, Bitbucket, CASS/NCOA PAF, Certificate, Civis Platform, Custom, Database, Google, Github, Salesforce User, Salesforce Client, and TableauUser. Specify multiple values as a comma-separated list (e.g., \"A,B\")."},{"required":false,"name":"remoteHostId","description":"The ID of the remote host associated with the credentials to return."},{"required":false,"name":"default","description":"If true, will return a list with a single credential which is the current user's default credential."},{"required":false,"name":"systemCredentials","description":"If true, will only return system credentials. System credentials can only be created and viewed by Civis Admins."},{"required":false,"name":"users","description":"A comma-separated list of user ids. If specified, returns set of credentials owned by the users that requesting user has at least read access on."},{"required":false,"name":"name","description":"If specified, will be used to filter the credentials returned. Will search across name and will return any full name containing the search string."},{"required":false,"name":"limit","description":"Number of results to return. Defaults to its maximum of 1000."},{"required":false,"name":"pageNum","description":"Page number of the results to return. Defaults to the first page, 1."},{"required":false,"name":"order","description":"The field on which to order the result set. Defaults to updated_at. Must be one of: updated_at, created_at, name."},{"required":false,"name":"orderDir","description":"Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc."}],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/credentials/82","request_body":null,"request_headers":{"Content-Type":"application/json","Authorization":"Bearer j96OzcWeFDhObdOSV887ewbsH0RJrd01_VD8MavU1vs","Accept":"application/vnd.civis-platform.v2","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 82,\n \"name\": \"Rentrak\",\n \"type\": \"Amazon Web Services S3\",\n \"username\": \"b1a44ca7-2c68-4a69-9986-cad248264f35\",\n \"description\": null,\n \"owner\": \"devuserfactory21\",\n \"user\": {\n \"id\": 67,\n \"name\": \"User devuserfactory21 19\",\n \"username\": \"devuserfactory21\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"remoteHostId\": null,\n \"remoteHostName\": null,\n \"state\": null,\n \"createdAt\": \"2023-07-18T18:39:31.000Z\",\n \"updatedAt\": \"2023-07-18T18:34:31.000Z\",\n \"default\": false,\n \"oauth\": false\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"419910e9d9661b1208636709c6ee394c\"","X-Request-Id":"89737573-81c8-4253-bbe5-b40f853bea8f","X-Runtime":"0.013984","Content-Length":"428"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/credentials/82\" -X GET \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer j96OzcWeFDhObdOSV887ewbsH0RJrd01_VD8MavU1vs\" \\\n\t-H \"Accept: application/vnd.civis-platform.v2\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"delete":{"summary":"Delete a credential","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the credential.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":[{"resource":"Credentials","resource_explanation":null,"http_method":"DELETE","route":"http://api.civis.test/credentials/:id","description":"Delete a credential","explanation":null,"parameters":[{"required":false,"name":"type","description":"The type (or types) of credentials to return. One or more of: Amazon Web Services S3, Bitbucket, CASS/NCOA PAF, Certificate, Civis Platform, Custom, Database, Google, Github, Salesforce User, Salesforce Client, and TableauUser. Specify multiple values as a comma-separated list (e.g., \"A,B\")."},{"required":false,"name":"remoteHostId","description":"The ID of the remote host associated with the credentials to return."},{"required":false,"name":"default","description":"If true, will return a list with a single credential which is the current user's default credential."},{"required":false,"name":"systemCredentials","description":"If true, will only return system credentials. System credentials can only be created and viewed by Civis Admins."},{"required":false,"name":"users","description":"A comma-separated list of user ids. If specified, returns set of credentials owned by the users that requesting user has at least read access on."},{"required":false,"name":"name","description":"If specified, will be used to filter the credentials returned. Will search across name and will return any full name containing the search string."},{"required":false,"name":"limit","description":"Number of results to return. Defaults to its maximum of 1000."},{"required":false,"name":"pageNum","description":"Page number of the results to return. Defaults to the first page, 1."},{"required":false,"name":"order","description":"The field on which to order the result set. Defaults to updated_at. Must be one of: updated_at, created_at, name."},{"required":false,"name":"orderDir","description":"Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc."}],"response_fields":[],"requests":[{"request_method":"DELETE","request_path":"http://api.civis.test/credentials/40","request_body":null,"request_headers":{"Content-Type":"application/json","Authorization":"Bearer iqzl4lE3AZQeaChCwaQfEdTk8Er7zsf7fWVxRUSJP1I","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":204,"response_status_text":"No Content","response_body":null,"response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","X-Request-Id":"9456c5da-b068-46e2-af77-f9b76754b1e5","X-Runtime":"0.019931"},"response_content_type":null,"curl":"curl \"api.civis.testhttp://api.civis.test/credentials/40\" -d '' -X DELETE \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer iqzl4lE3AZQeaChCwaQfEdTk8Er7zsf7fWVxRUSJP1I\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/credentials/authenticate":{"post":{"summary":"Authenticate against a remote host","description":null,"deprecated":false,"parameters":[{"name":"Object64","in":"body","schema":{"$ref":"#/definitions/Object64"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object60"}}},"x-examples":[{"resource":"Credentials","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/credentials/authenticate","description":"Authenticate","explanation":null,"parameters":[{"required":false,"name":"type","description":"The type (or types) of credentials to return. One or more of: Amazon Web Services S3, Bitbucket, CASS/NCOA PAF, Certificate, Civis Platform, Custom, Database, Google, Github, Salesforce User, Salesforce Client, and TableauUser. Specify multiple values as a comma-separated list (e.g., \"A,B\")."},{"required":false,"name":"remoteHostId","description":"The ID of the remote host associated with the credentials to return."},{"required":false,"name":"default","description":"If true, will return a list with a single credential which is the current user's default credential."},{"required":false,"name":"systemCredentials","description":"If true, will only return system credentials. System credentials can only be created and viewed by Civis Admins."},{"required":false,"name":"users","description":"A comma-separated list of user ids. If specified, returns set of credentials owned by the users that requesting user has at least read access on."},{"required":false,"name":"name","description":"If specified, will be used to filter the credentials returned. Will search across name and will return any full name containing the search string."},{"required":false,"name":"limit","description":"Number of results to return. Defaults to its maximum of 1000."},{"required":false,"name":"pageNum","description":"Page number of the results to return. Defaults to the first page, 1."},{"required":false,"name":"order","description":"The field on which to order the result set. Defaults to updated_at. Must be one of: updated_at, created_at, name."},{"required":false,"name":"orderDir","description":"Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc."}],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/credentials/authenticate","request_body":"{\n \"url\": \"jdbc:mysql//myHost/myDb\",\n \"remote_host_type\": \"RemoteHostTypes::JDBC\",\n \"username\": \"myUsername\",\n \"password\": \"myPassword\"\n}","request_headers":{"Content-Type":"application/json","Authorization":"Bearer BH-FehqJmF7ms0QmgmoV_mSdty8yGVW9VcWobQyuB2c","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"success\": true\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"c955e57777ec0d73639dca6748560d00\"","X-Request-Id":"7f015898-18a7-4fa7-8305-04078909a82d","X-Runtime":"0.051966","Content-Length":"16"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/credentials/authenticate\" -d '{\"url\":\"jdbc:mysql//myHost/myDb\",\"remote_host_type\":\"RemoteHostTypes::JDBC\",\"username\":\"myUsername\",\"password\":\"myPassword\"}' -X POST \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer BH-FehqJmF7ms0QmgmoV_mSdty8yGVW9VcWobQyuB2c\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Credentials","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/credentials/authenticate","description":"Authenticate against incorrect username or password","explanation":null,"parameters":[{"required":false,"name":"type","description":"The type (or types) of credentials to return. One or more of: Amazon Web Services S3, Bitbucket, CASS/NCOA PAF, Certificate, Civis Platform, Custom, Database, Google, Github, Salesforce User, Salesforce Client, and TableauUser. Specify multiple values as a comma-separated list (e.g., \"A,B\")."},{"required":false,"name":"remoteHostId","description":"The ID of the remote host associated with the credentials to return."},{"required":false,"name":"default","description":"If true, will return a list with a single credential which is the current user's default credential."},{"required":false,"name":"systemCredentials","description":"If true, will only return system credentials. System credentials can only be created and viewed by Civis Admins."},{"required":false,"name":"users","description":"A comma-separated list of user ids. If specified, returns set of credentials owned by the users that requesting user has at least read access on."},{"required":false,"name":"name","description":"If specified, will be used to filter the credentials returned. Will search across name and will return any full name containing the search string."},{"required":false,"name":"limit","description":"Number of results to return. Defaults to its maximum of 1000."},{"required":false,"name":"pageNum","description":"Page number of the results to return. Defaults to the first page, 1."},{"required":false,"name":"order","description":"The field on which to order the result set. Defaults to updated_at. Must be one of: updated_at, created_at, name."},{"required":false,"name":"orderDir","description":"Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc."}],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/credentials/authenticate","request_body":"{\n \"url\": \"jdbc:mysql//myHost/myDb\",\n \"remote_host_type\": \"RemoteHostTypes::JDBC\",\n \"username\": \"myUsername\",\n \"password\": \"myPassword\"\n}","request_headers":{"Content-Type":"application/json","Authorization":"Bearer 1A4EUtbG8ZA7wbAe-Y4pr4ebzMmfsU9xFeCt5TRf-TM","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":400,"response_status_text":"Bad Request","response_body":"{\n \"error\": \"authentication_error\",\n \"errorDescription\": \"Username or password is incorrect.\",\n \"code\": 400\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","X-Request-Id":"cba36274-879c-49a9-8fee-3527eb64b75b","X-Runtime":"0.039783","Content-Length":"99"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/credentials/authenticate\" -d '{\"url\":\"jdbc:mysql//myHost/myDb\",\"remote_host_type\":\"RemoteHostTypes::JDBC\",\"username\":\"myUsername\",\"password\":\"myPassword\"}' -X POST \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer 1A4EUtbG8ZA7wbAe-Y4pr4ebzMmfsU9xFeCt5TRf-TM\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/credentials/{id}/temporary":{"post":{"summary":"Generate a temporary credential for accessing S3","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the credential.","type":"integer"},{"name":"Object66","in":"body","schema":{"$ref":"#/definitions/Object66"},"required":false}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object67"}}},"x-examples":[{"resource":"Credentials","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/credentials/:id/temporary","description":"Get a temporary credential","explanation":null,"parameters":[{"required":false,"name":"type","description":"The type (or types) of credentials to return. One or more of: Amazon Web Services S3, Bitbucket, CASS/NCOA PAF, Certificate, Civis Platform, Custom, Database, Google, Github, Salesforce User, Salesforce Client, and TableauUser. Specify multiple values as a comma-separated list (e.g., \"A,B\")."},{"required":false,"name":"remoteHostId","description":"The ID of the remote host associated with the credentials to return."},{"required":false,"name":"default","description":"If true, will return a list with a single credential which is the current user's default credential."},{"required":false,"name":"systemCredentials","description":"If true, will only return system credentials. System credentials can only be created and viewed by Civis Admins."},{"required":false,"name":"users","description":"A comma-separated list of user ids. If specified, returns set of credentials owned by the users that requesting user has at least read access on."},{"required":false,"name":"name","description":"If specified, will be used to filter the credentials returned. Will search across name and will return any full name containing the search string."},{"required":false,"name":"limit","description":"Number of results to return. Defaults to its maximum of 1000."},{"required":false,"name":"pageNum","description":"Page number of the results to return. Defaults to the first page, 1."},{"required":false,"name":"order","description":"The field on which to order the result set. Defaults to updated_at. Must be one of: updated_at, created_at, name."},{"required":false,"name":"orderDir","description":"Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc."}],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/credentials/100/temporary","request_body":null,"request_headers":{"Content-Type":"application/json","Authorization":"Bearer tEyZQ0Iz-qVErw3yRMcPVCmxwoJB8_KaimtXlYgZ2ZI","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"accessKey\": \"ASIAJILWE3NJGDWYTPCA\",\n \"secretAccessKey\": \"e3SVJWODk8FdCBynSarANFXj3W3bRDgoQLiyx28n\",\n \"sessionToken\": \"AQoDYXdzELP//////////wEa8AH5MvO75GKCny05yKXKFPoS+W59JVxHqk/tcsV+7+IXaG5DzkTo6zMq9A5si6DuJb9xYKwZKazsg45zM8elnWBGHV0uJrHJrmHk6kKIPHHykceevKHdElZ+d/q4ZE36JVD6GIO6AuQvbri01kB44nw6Y31CYPDxnzhL8NvJhnw8MlpA0czUCzVl0VhCM7H9HczenL1QCFuB/vOkEdYkkvmdo92+b3cD8ixJfePI9KuFuK2Fp3edfULdIJh61JwLnJAlEEO1Z+KHzbsmz5BckK0yYhD4adCEU+ADmk6AoTuG/NjftT98DdGJCrYVCU426nEgpe+xqQU=\"\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"80b44a0138b553730b3488aae09940bb\"","X-Request-Id":"c3dd96eb-238b-4143-a1c8-7af11eaca148","X-Runtime":"0.017955","Content-Length":"471"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/credentials/100/temporary\" -d '' -X POST \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer tEyZQ0Iz-qVErw3yRMcPVCmxwoJB8_KaimtXlYgZ2ZI\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/credentials/{id}/shares":{"get":{"summary":"List users and groups permissioned on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object9"}}}},"x-examples":null,"x-deprecation-warning":null}},"/credentials/{id}/shares/users":{"put":{"summary":"Set the permissions users have on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"Object68","in":"body","schema":{"$ref":"#/definitions/Object68"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object9"}}},"x-examples":null,"x-deprecation-warning":null}},"/credentials/{id}/shares/users/{user_id}":{"delete":{"summary":"Revoke the permissions a user has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"user_id","in":"path","required":true,"description":"The ID of the user.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/credentials/{id}/shares/groups":{"put":{"summary":"Set the permissions groups has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"Object69","in":"body","schema":{"$ref":"#/definitions/Object69"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object9"}}},"x-examples":null,"x-deprecation-warning":null}},"/credentials/{id}/shares/groups/{group_id}":{"delete":{"summary":"Revoke the permissions a group has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"group_id","in":"path","required":true,"description":"The ID of the group.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/credentials/{id}/dependencies":{"get":{"summary":"List dependent objects for this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"user_id","in":"query","required":false,"description":"ID of target user","type":"integer"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object15"}}}},"x-examples":null,"x-deprecation-warning":null}},"/credentials/{id}/transfer":{"put":{"summary":"Transfer ownership of this object to another user","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"Object70","in":"body","schema":{"$ref":"#/definitions/Object70"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object17"}}},"x-examples":null,"x-deprecation-warning":null}},"/databases/":{"get":{"summary":"List databases","description":null,"deprecated":false,"parameters":[],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object71"}}}},"x-examples":[{"resource":"Databases","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/databases","description":"list all databases","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/databases","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer kAQi7I_HPtOzB6zBy9kR7Imif17uwMfDSEw-ugdmXqM","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 15,\n \"name\": \"redshift the first\",\n \"adapter\": \"redshift\",\n \"clusterIdentifier\": \"cluster_identifier-1\",\n \"host\": \"localhost.factory\",\n \"port\": 1234,\n \"databaseName\": \"dev\",\n \"managed\": true\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"4ccda77ac4b23bdac19cd16e74e07697\"","X-Request-Id":"f44bb3d5-4964-41fc-b148-0d3f3ca5f300","X-Runtime":"0.192268","Content-Length":"178"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/databases\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer kAQi7I_HPtOzB6zBy9kR7Imif17uwMfDSEw-ugdmXqM\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Databases","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/databases","description":"list all databases","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/databases","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer ys8STCl-OQFtNwa4JdbJpyqS0N0R9ddiJf3tX7ylVWU","Accept":"application/vnd.civis-platform.v2","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 20,\n \"name\": \"redshift the first\",\n \"adapter\": \"redshift\",\n \"clusterIdentifier\": \"cluster_identifier-3\",\n \"host\": \"localhost.factory\",\n \"port\": 1234,\n \"databaseName\": \"dev\",\n \"managed\": true\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"0b5419085638678c2cd2052d7845140f\"","X-Request-Id":"0b15c544-cc52-4927-841d-b4fc00ccc0fa","X-Runtime":"0.082549","Content-Length":"178"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/databases\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer ys8STCl-OQFtNwa4JdbJpyqS0N0R9ddiJf3tX7ylVWU\" \\\n\t-H \"Accept: application/vnd.civis-platform.v2\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/databases/{id}":{"get":{"summary":"Show database information","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID for the database.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object71"}}},"x-examples":null,"x-deprecation-warning":null}},"/databases/{id}/schemas":{"get":{"summary":"List schemas in this database","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the database.","type":"integer"},{"name":"name","in":"query","required":false,"description":"If specified, will be used to filter the schemas returned.Substring matching is supported (e.g., \"name=schema\" will return both \"schema1\" and \"schema2\"). Does not apply to BigQuery databases.","type":"string"},{"name":"credential_id","in":"query","required":false,"description":"If provided, schemas will be filtered based on the given credential.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object72"}}}},"x-examples":[{"resource":"Databases","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/databases/:id/schemas","description":"List schemas in a database","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/databases/35/schemas","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer rIgRMYiaDrzl3yLEJcjIp5k7wpnj8BVlI0IyrrqC_5Q","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"schema\": \"visible_schema\"\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"14b9cb91d1854a2bbe42ca553a6b33da\"","X-Request-Id":"deac724e-5590-44fa-ad19-f5be95f41e32","X-Runtime":"0.060185","Content-Length":"29"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/databases/35/schemas\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer rIgRMYiaDrzl3yLEJcjIp5k7wpnj8BVlI0IyrrqC_5Q\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Databases","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/databases/:id/schemas?name=_schema","description":"Filter schemas by name","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/databases/40/schemas?name=_schema","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer B0CyQToEPHfvELu8HKB13l9r32_KHpFR3zGd-c3ToC4","Host":"api.civis.test","Cookie":""},"request_query_parameters":{"name":"_schema"},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"schema\": \"other_schema\"\n },\n {\n \"schema\": \"visible_schema\"\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"daa2dd76b4050f092c55ca635fd427f2\"","X-Request-Id":"565b9ea6-6a36-47db-99b2-0d32c896d270","X-Runtime":"0.080392","Content-Length":"55"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/databases/40/schemas?name=_schema\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer B0CyQToEPHfvELu8HKB13l9r32_KHpFR3zGd-c3ToC4\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/databases/{id}/schemas/{schema_name}/tables":{"get":{"summary":"List tables in this schema","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the database","type":"integer"},{"name":"schema_name","in":"path","required":true,"description":"The name of the schema","type":"string"},{"name":"credential_id","in":"query","required":false,"description":"If provided, schemas will be filtered based on the given credential.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object73"}}}},"x-examples":null,"x-deprecation-warning":null}},"/databases/{id}/schemas/{schema_name}/tables/{table_name}":{"get":{"summary":"Show basic table info","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the database","type":"integer"},{"name":"schema_name","in":"path","required":true,"description":"The name of the schema","type":"string"},{"name":"credential_id","in":"query","required":false,"description":"If provided, schemas will be filtered based on the given credential.","type":"integer"},{"name":"table_name","in":"path","required":true,"description":"The name of the table","type":"string"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object74"}}},"x-examples":null,"x-deprecation-warning":null},"patch":{"summary":"Update a table","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the database","type":"integer"},{"name":"schema_name","in":"path","required":true,"description":"The name of the schema","type":"string"},{"name":"table_name","in":"path","required":true,"description":"The name of the table","type":"string"},{"name":"Object84","in":"body","schema":{"$ref":"#/definitions/Object84"},"required":false}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object74"}}},"x-examples":null,"x-deprecation-warning":null}},"/databases/{id}/schemas/{schema_name}/tables/{table_name}/projects":{"get":{"summary":"List the projects a Table belongs to","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the database","type":"integer"},{"name":"hidden","in":"query","required":false,"description":"If specified to be true, returns hidden items. Defaults to false, returning non-hidden items.","type":"boolean"},{"name":"schema_name","in":"path","required":true,"description":"The name of the schema","type":"string"},{"name":"table_name","in":"path","required":true,"description":"The name of the table","type":"string"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object85"}}}},"x-examples":null,"x-deprecation-warning":null}},"/databases/{id}/schemas/{schema_name}/tables/{table_name}/projects/{project_id}":{"put":{"summary":"Add a Table to a project","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the database","type":"integer"},{"name":"project_id","in":"path","required":true,"description":"The ID of the project.","type":"integer"},{"name":"schema_name","in":"path","required":true,"description":"The name of the schema","type":"string"},{"name":"table_name","in":"path","required":true,"description":"The name of the table","type":"string"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null},"delete":{"summary":"Remove a Table from a project","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the database","type":"integer"},{"name":"project_id","in":"path","required":true,"description":"The ID of the project.","type":"integer"},{"name":"schema_name","in":"path","required":true,"description":"The name of the schema","type":"string"},{"name":"table_name","in":"path","required":true,"description":"The name of the table","type":"string"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/databases/{id}/schemas/scan":{"post":{"summary":"Creates and enqueues a schema scanner job","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the database.","type":"integer"},{"name":"Object86","in":"body","schema":{"$ref":"#/definitions/Object86"},"required":true}],"responses":{"201":{"description":"success","schema":{"$ref":"#/definitions/Object87"}}},"x-examples":[{"resource":"Databases","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/databases/:id/schemas/scan","description":"Scan an entire schema in a database","explanation":null,"parameters":[{"required":true,"name":"id","description":"The ID of the database."},{"required":true,"name":"schema","description":"The name of the schema."},{"required":false,"name":"statsPriority","description":"When to sync table statistics for every table in the schema. Valid options are the following. Option: 'flag' means to flag stats for the next scheduled run of a full table scan on the database. Option: 'block' means to block this job on stats syncing. Option: 'queue' means to queue a separate job for syncing stats and do not block this job on the queued job. Defaults to 'flag'"}],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/databases/45/schemas/scan","request_body":"{\n \"schema\": \"visible_schema\"\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer JJ7Fb5ehnlGWOZv9Lg2gfwNuMn9ornQpIGYe7H8A2c0","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":201,"response_status_text":"Created","response_body":"{\n \"jobId\": 1,\n \"runId\": 1\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"9a7eeddba3b0cada49d41e2eb1d0c886\"","X-Request-Id":"b0c0e268-4812-48ff-a1c4-c92316114645","X-Runtime":"0.350761","Content-Length":"21"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/databases/45/schemas/scan\" -d '{\"schema\":\"visible_schema\"}' -X POST \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer JJ7Fb5ehnlGWOZv9Lg2gfwNuMn9ornQpIGYe7H8A2c0\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/databases/{id}/tables":{"get":{"summary":"List tables in the specified database, deprecated use \"GET /tables\" instead","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the database.","type":"integer"},{"name":"name","in":"query","required":false,"description":"If specified, will be used to filter the tables returned. Substring matching is supported (e.g., \"name=table\" will return both \"table1\" and \"my table\").","type":"string"},{"name":"limit","in":"query","required":false,"description":"Number of results to return. Defaults to 200. Maximum allowed is 1000.","type":"integer"},{"name":"page_num","in":"query","required":false,"description":"Page number of the results to return. Defaults to the first page, 1.","type":"integer"},{"name":"order","in":"query","required":false,"description":"The field on which to order the result set. Defaults to name. Must be one of: name.","type":"string"},{"name":"order_dir","in":"query","required":false,"description":"Direction in which to sort, either asc (ascending) or desc (descending) defaulting to asc.","type":"string"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object88"}}}},"x-examples":[{"resource":"Databases","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/databases/:id/tables","description":"List tables on a redshift cluster","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/databases/25/tables","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer 8z6sQEfHY-BaB_P4FVY0SYtPOcpiRhMYs2NERhCQZYY","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 1,\n \"databaseId\": 25,\n \"schema\": \"visible_schema\",\n \"name\": \"visible_table\",\n \"description\": null,\n \"isView\": false,\n \"rowCount\": 1,\n \"columnCount\": 0,\n \"sizeMb\": null,\n \"owner\": \"dbadmin\",\n \"distkey\": null,\n \"sortkeys\": null,\n \"refreshStatus\": \"current\",\n \"lastRefresh\": null,\n \"refreshId\": null,\n \"lastRun\": null,\n \"tableTags\": [\n\n ]\n },\n {\n \"id\": 3,\n \"databaseId\": 25,\n \"schema\": \"visible_schema\",\n \"name\": \"will_not_find_this_table\",\n \"description\": null,\n \"isView\": false,\n \"rowCount\": 1,\n \"columnCount\": 0,\n \"sizeMb\": null,\n \"owner\": \"dbadmin\",\n \"distkey\": null,\n \"sortkeys\": null,\n \"refreshStatus\": \"current\",\n \"lastRefresh\": null,\n \"refreshId\": null,\n \"lastRun\": null,\n \"tableTags\": [\n\n ]\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","X-Pagination-Per-Page":"200","Access-Control-Expose-Headers":"X-Pagination-Per-Page, X-Pagination-Current-Page, X-Pagination-Total-Pages, X-Pagination-Total-Entries","X-Pagination-Current-Page":"1","X-Pagination-Total-Pages":"1","X-Pagination-Total-Entries":"2","Content-Type":"application/json; charset=utf-8","ETag":"W/\"14146ab0ab5d65a990836c79bdb571f3\"","X-Request-Id":"ef68a4c0-5b6b-48c0-a64b-49d05603efed","X-Runtime":"0.138492","Content-Length":"596"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/databases/25/tables\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer 8z6sQEfHY-BaB_P4FVY0SYtPOcpiRhMYs2NERhCQZYY\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Databases","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/databases/:id/tables?name=visible","description":"Filter tables by schema or table name","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/databases/30/tables?name=visible","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer H_kZq8CsWoYfqdqUgs0HB9AvsfoqIZowaWo9Y6SRwXc","Host":"api.civis.test","Cookie":""},"request_query_parameters":{"name":"visible"},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 4,\n \"databaseId\": 30,\n \"schema\": \"visible_schema\",\n \"name\": \"visible_table\",\n \"description\": null,\n \"isView\": false,\n \"rowCount\": 1,\n \"columnCount\": 0,\n \"sizeMb\": null,\n \"owner\": \"dbadmin\",\n \"distkey\": null,\n \"sortkeys\": null,\n \"refreshStatus\": \"current\",\n \"lastRefresh\": null,\n \"refreshId\": null,\n \"lastRun\": null,\n \"tableTags\": [\n\n ]\n },\n {\n \"id\": 6,\n \"databaseId\": 30,\n \"schema\": \"visible_schema\",\n \"name\": \"will_not_find_this_table\",\n \"description\": null,\n \"isView\": false,\n \"rowCount\": 1,\n \"columnCount\": 0,\n \"sizeMb\": null,\n \"owner\": \"dbadmin\",\n \"distkey\": null,\n \"sortkeys\": null,\n \"refreshStatus\": \"current\",\n \"lastRefresh\": null,\n \"refreshId\": null,\n \"lastRun\": null,\n \"tableTags\": [\n\n ]\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","X-Pagination-Per-Page":"200","Access-Control-Expose-Headers":"X-Pagination-Per-Page, X-Pagination-Current-Page, X-Pagination-Total-Pages, X-Pagination-Total-Entries","X-Pagination-Current-Page":"1","X-Pagination-Total-Pages":"1","X-Pagination-Total-Entries":"2","Content-Type":"application/json; charset=utf-8","ETag":"W/\"26c4eafe29942a4ed51982e59407a2d0\"","X-Request-Id":"a89cd411-5daf-4e13-9538-c83bfc1aac04","X-Runtime":"0.089954","Content-Length":"596"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/databases/30/tables?name=visible\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer H_kZq8CsWoYfqdqUgs0HB9AvsfoqIZowaWo9Y6SRwXc\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/databases/{id}/tables-search":{"get":{"summary":"List tables in the specified database, deprecated use \"GET /tables\" instead","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the database.","type":"integer"},{"name":"name","in":"query","required":false,"description":"If specified, will be used to filter the tables returned. Substring matching is supported (e.g., \"name=table\" will return both \"table1\" and \"my table\").","type":"string"},{"name":"column_name","in":"query","required":false,"description":"Search for tables containing a column with the given name.","type":"string"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object89"}}}},"x-examples":[{"resource":"Table Search","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/databases/:id/tables-search?name=carrots&column_name=aaa","description":"Search using table and column names","explanation":null,"parameters":[{"required":true,"name":"id","description":"The ID of the database."},{"required":false,"name":"name","description":"If specified, will be used to filter the tables returned. Substring matching is supported (e.g., \"name=table\" will return both \"table1\" and \"my table\")."},{"required":false,"name":"columnName","description":"Search for tables containing a column with the given name."}],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/databases/78/tables-search?name=carrots&column_name=aaa","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer bJhXuC4nESXtSXmjkZdq2mLWpMiLO1l8_TWk3DnnmCE","Host":"api.civis.test","Cookie":""},"request_query_parameters":{"name":"carrots","column_name":"aaa"},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 7,\n \"databaseId\": 78,\n \"schema\": \"schema_name\",\n \"name\": \"apples\",\n \"description\": null,\n \"isView\": false,\n \"rowCount\": 1,\n \"columnCount\": 4,\n \"sizeMb\": 10,\n \"owner\": \"dbadmin\",\n \"distkey\": \"c\",\n \"sortkeys\": \"d,e\",\n \"refreshStatus\": \"current\",\n \"lastRefresh\": null,\n \"refreshId\": null,\n \"lastRun\": null,\n \"tableTags\": [\n\n ],\n \"columnNames\": [\n \"aaa\"\n ]\n },\n {\n \"id\": 8,\n \"databaseId\": 78,\n \"schema\": \"schema_name\",\n \"name\": \"carrots\",\n \"description\": null,\n \"isView\": false,\n \"rowCount\": 1,\n \"columnCount\": 0,\n \"sizeMb\": null,\n \"owner\": \"dbadmin\",\n \"distkey\": null,\n \"sortkeys\": null,\n \"refreshStatus\": \"current\",\n \"lastRefresh\": null,\n \"refreshId\": null,\n \"lastRun\": null,\n \"tableTags\": [\n\n ],\n \"columnNames\": [\n \"bbb\"\n ]\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"2c1e20600ed0c0989a6d550c63094eac\"","X-Request-Id":"c8f2240d-13cd-4308-aecf-1be6448913be","X-Runtime":"0.027330","Content-Length":"608"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/databases/78/tables-search?name=carrots&column_name=aaa\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer bJhXuC4nESXtSXmjkZdq2mLWpMiLO1l8_TWk3DnnmCE\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/databases/{id}/table_privileges/{schema_name}/{table_name}":{"get":{"summary":"Show table privileges","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the database","type":"integer"},{"name":"schema_name","in":"path","required":true,"description":"The name of the schema","type":"string"},{"name":"credential_id","in":"query","required":false,"description":"If provided, schemas will be filtered based on the given credential.","type":"integer"},{"name":"table_name","in":"path","required":true,"description":"The name of the table","type":"string"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object90"}}},"x-examples":null,"x-deprecation-warning":null}},"/databases/{id}/schema_privileges/{schema_name}":{"get":{"summary":"Show schema privileges","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the database","type":"integer"},{"name":"schema_name","in":"path","required":true,"description":"The name of the schema","type":"string"},{"name":"credential_id","in":"query","required":false,"description":"If provided, schemas will be filtered based on the given credential.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object90"}}},"x-examples":null,"x-deprecation-warning":null}},"/databases/{id}/users":{"get":{"summary":"Show list of database users","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the database.","type":"integer"},{"name":"active","in":"query","required":false,"description":"If true returns active users. If false returns deactivated users. Defaults to true.","type":"boolean"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object91"}}},"x-examples":null,"x-deprecation-warning":null}},"/databases/{id}/groups":{"get":{"summary":"List groups in the specified database","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID for the database.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object92"}}}},"x-examples":null,"x-deprecation-warning":null}},"/databases/{id}/whitelist-ips":{"get":{"summary":"List whitelisted IPs for the specified database","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID for the database.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object93"}}}},"x-examples":[{"resource":"Databases","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/databases/:id/whitelist-ips","description":"List whitelisted IPs for this database","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/databases/50/whitelist-ips","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer SvoIR_ONwqY4gCPWLkihx5IcigPd0mCA6if1RU-6vJE","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 1,\n \"remoteHostId\": 50,\n \"securityGroupId\": \"sg_group_1\",\n \"subnetMask\": \"some ip\",\n \"createdAt\": \"2024-09-06T16:29:46.000Z\",\n \"updatedAt\": \"2024-09-06T16:29:46.000Z\"\n },\n {\n \"id\": 2,\n \"remoteHostId\": 50,\n \"securityGroupId\": \"sg_group_1\",\n \"subnetMask\": \"some ip\",\n \"createdAt\": \"2024-09-06T16:29:46.000Z\",\n \"updatedAt\": \"2024-09-06T16:29:46.000Z\"\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"07596b1601b97686d9e3bfafb2da8bfc\"","X-Request-Id":"701d0bf9-ed60-4ccc-8579-ce64a440f9d3","X-Runtime":"0.059295","Content-Length":"319"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/databases/50/whitelist-ips\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer SvoIR_ONwqY4gCPWLkihx5IcigPd0mCA6if1RU-6vJE\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/databases/{id}/whitelist-ips/{whitelisted_ip_id}":{"get":{"summary":"View details about a whitelisted IP","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the database this rule is applied to.","type":"integer"},{"name":"whitelisted_ip_id","in":"path","required":true,"description":"The ID of this whitelisted IP address.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object94"}}},"x-examples":[{"resource":"Databases","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/databases/:id/whitelist-ips/:whitelisted_ip_id","description":"View details about a whitelisted IP","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/databases/55/whitelist-ips/3","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer dceS_zo3eQp-r2a3NzhASDRCBv4UM0RUnFShDM4h3gk","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 3,\n \"remoteHostId\": 55,\n \"securityGroupId\": \"sg_group_1\",\n \"subnetMask\": \"some ip\",\n \"authorizedBy\": 59,\n \"isActive\": true,\n \"createdAt\": \"2024-09-06T16:29:46.000Z\",\n \"updatedAt\": \"2024-09-06T16:29:46.000Z\"\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"75c3fb46f053a1721a77635d4fba54b5\"","X-Request-Id":"d50dc39f-d15b-4482-a9ce-51c1f95d76a7","X-Runtime":"0.055960","Content-Length":"192"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/databases/55/whitelist-ips/3\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer dceS_zo3eQp-r2a3NzhASDRCBv4UM0RUnFShDM4h3gk\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/databases/{id}/advanced-settings":{"get":{"summary":"Get the advanced settings for this database","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the database this advanced settings object belongs to.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object95"}}},"x-examples":[{"resource":"Databases","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/databases/:id/advanced-settings","description":"fetches the advanced settings for this database server","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/databases/62/advanced-settings","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer _1Plm3GeOGtw7-Tyr_fFemVIILpY9xigQ7C3a9Ll5lc","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"exportCachingEnabled\": true\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"5b48be69a6593fee654b635cc44b8f45\"","X-Request-Id":"e82617c3-a4ac-4e02-8677-720ba73c905b","X-Runtime":"0.053824","Content-Length":"29"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/databases/62/advanced-settings\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer _1Plm3GeOGtw7-Tyr_fFemVIILpY9xigQ7C3a9Ll5lc\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"patch":{"summary":"Update the advanced settings for this database","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the database this advanced settings object belongs to.","type":"integer"},{"name":"Object96","in":"body","schema":{"$ref":"#/definitions/Object96"},"required":false}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object95"}}},"x-examples":[{"resource":"Databases","resource_explanation":null,"http_method":"PATCH","route":"http://api.civis.test/databases/:id/advanced-settings","description":"updates export_caching_enabled for the advanced settings for this database server","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"PATCH","request_path":"http://api.civis.test/databases/74/advanced-settings","request_body":"{\n \"exportCachingEnabled\": false\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer OC4E7LVUdWyRt7a7onZxU1en5Bb8xR7lWOKRuOigQOY","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"exportCachingEnabled\": false\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"c5ebbaf5f8d3d88c7086ad8758ca4824\"","X-Request-Id":"35d16212-a2d1-4bfa-b093-368bcca4315a","X-Runtime":"0.053461","Content-Length":"30"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/databases/74/advanced-settings\" -d '{\"exportCachingEnabled\":false}' -X PATCH \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer OC4E7LVUdWyRt7a7onZxU1en5Bb8xR7lWOKRuOigQOY\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"put":{"summary":"Edit the advanced settings for this database","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the database this advanced settings object belongs to.","type":"integer"},{"name":"Object97","in":"body","schema":{"$ref":"#/definitions/Object97"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object95"}}},"x-examples":[{"resource":"Databases","resource_explanation":null,"http_method":"PUT","route":"http://api.civis.test/databases/:id/advanced-settings","description":"updates the advanced settings for this database server","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"PUT","request_path":"http://api.civis.test/databases/68/advanced-settings","request_body":"{\n \"exportCachingEnabled\": true\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer Dx1CqHGDSE7hQBnp25wiRlVgRsWcVLL3T4esziqCbJE","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"exportCachingEnabled\": true\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"5b48be69a6593fee654b635cc44b8f45\"","X-Request-Id":"99ec3e4c-91f0-4670-bcf7-c4a32ebf9799","X-Runtime":"0.116363","Content-Length":"29"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/databases/68/advanced-settings\" -d '{\"exportCachingEnabled\":true}' -X PUT \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer Dx1CqHGDSE7hQBnp25wiRlVgRsWcVLL3T4esziqCbJE\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/databases/{id}/status_graphs/timeframe/{timeframe}":{"get":{"summary":"Get the status graphs for this database","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the database.","type":"integer"},{"name":"timeframe","in":"path","required":true,"description":"The span of time that the graphs cover. Must be one of 1_hour, 4_hours, 1_day, 2_days, 1_week.","type":"string"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object98"}}},"x-examples":null,"x-deprecation-warning":null}},"/endpoints/":{"get":{"summary":"List API endpoints","description":null,"deprecated":false,"parameters":[],"responses":{"200":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/enhancements/civis-data-match/":{"post":{"summary":"Create a Civis Data Match Enhancement","description":null,"deprecated":false,"parameters":[{"name":"Object101","in":"body","schema":{"$ref":"#/definitions/Object101"},"required":true}],"responses":{"201":{"description":"success","schema":{"$ref":"#/definitions/Object106"}}},"x-examples":[{"resource":"Enhancements","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/enhancements/civis-data-match","description":"Create a Civis Data Match enhancement","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/enhancements/civis-data-match","request_body":"{\n \"name\": \"My civis data match enhancement\",\n \"input_field_mapping\": {\n \"primary_key\": \"voterbase_id\",\n \"first_name\": \"first\",\n \"last_name\": \"last\",\n \"city\": \"city\",\n \"state\": \"state_code\",\n \"zip\": \"zip\"\n },\n \"input_table\": {\n \"database_name\": \"db1\",\n \"schema\": \"schema1\",\n \"table\": \"tbl1\"\n },\n \"output_table\": {\n \"database_name\": \"output_db\",\n \"schema\": \"output_schema\",\n \"table\": \"output_tbl\"\n },\n \"match_target_id\": 2\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer U5VTRRUrsOYhIrYWjbmEZD_AcY3XwR6QboeUC0NOmg8","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":201,"response_status_text":"Created","response_body":"{\n \"id\": 624,\n \"name\": \"My civis data match enhancement\",\n \"type\": \"Container\",\n \"createdAt\": \"2024-12-03T19:43:28.000Z\",\n \"updatedAt\": \"2024-12-03T19:43:28.000Z\",\n \"author\": {\n \"id\": 614,\n \"name\": \"User devuserfactory483 483\",\n \"username\": \"devuserfactory483\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"state\": \"idle\",\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n },\n \"notifications\": {\n \"urls\": [\n\n ],\n \"successEmailSubject\": null,\n \"successEmailBody\": null,\n \"successEmailAddresses\": [\n\n ],\n \"successEmailFromName\": null,\n \"successEmailReplyTo\": null,\n \"failureEmailAddresses\": [\n\n ],\n \"stallWarningMinutes\": null,\n \"successOn\": true,\n \"failureOn\": true\n },\n \"runningAs\": {\n \"id\": 614,\n \"name\": \"User devuserfactory483 483\",\n \"username\": \"devuserfactory483\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"myPermissionLevel\": \"manage\",\n \"inputFieldMapping\": {\n \"primary_key\": \"voterbase_id\",\n \"first_name\": \"first\",\n \"last_name\": \"last\",\n \"city\": \"city\",\n \"state\": \"state_code\",\n \"zip\": \"zip\"\n },\n \"inputTable\": {\n \"databaseName\": \"db1\",\n \"schema\": \"schema1\",\n \"table\": \"tbl1\"\n },\n \"matchTargetId\": 2,\n \"outputTable\": {\n \"databaseName\": \"output_db\",\n \"schema\": \"output_schema\",\n \"table\": \"output_tbl\"\n },\n \"maxMatches\": null,\n \"threshold\": 0.5,\n \"archived\": false,\n \"lastRun\": null,\n \"parentId\": null\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"94c49254cfa10d42470c339c6773990c\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"124ab9b5-86c1-4c1a-bce5-1084434b6edc","X-Runtime":"0.098097","Content-Length":"1220"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/enhancements/civis-data-match\" -d '{\"name\":\"My civis data match enhancement\",\"input_field_mapping\":{\"primary_key\":\"voterbase_id\",\"first_name\":\"first\",\"last_name\":\"last\",\"city\":\"city\",\"state\":\"state_code\",\"zip\":\"zip\"},\"input_table\":{\"database_name\":\"db1\",\"schema\":\"schema1\",\"table\":\"tbl1\"},\"output_table\":{\"database_name\":\"output_db\",\"schema\":\"output_schema\",\"table\":\"output_tbl\"},\"match_target_id\":2}' -X POST \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer U5VTRRUrsOYhIrYWjbmEZD_AcY3XwR6QboeUC0NOmg8\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/enhancements/civis-data-match/{id}":{"get":{"summary":"Get a Civis Data Match Enhancement","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object106"}}},"x-examples":[{"resource":"Enhancements","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/enhancements/civis-data-match/:civis_data_match_id","description":"View a Civis Data Match enhancement's details","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/enhancements/civis-data-match/396","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer 3Q0XciIWJxCrcOqiUVxm5MWdJVD-9_LPU_FKeXMfH3U","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 396,\n \"name\": \"Script #396\",\n \"type\": \"Container\",\n \"createdAt\": \"2024-12-03T19:43:10.000Z\",\n \"updatedAt\": \"2024-12-03T20:43:09.000Z\",\n \"author\": {\n \"id\": 370,\n \"name\": \"User devuserfactory297 297\",\n \"username\": \"devuserfactory297\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"state\": \"running\",\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n },\n \"notifications\": {\n \"urls\": [\n\n ],\n \"successEmailSubject\": null,\n \"successEmailBody\": null,\n \"successEmailAddresses\": [\n\n ],\n \"successEmailFromName\": null,\n \"successEmailReplyTo\": null,\n \"failureEmailAddresses\": [\n\n ],\n \"stallWarningMinutes\": null,\n \"successOn\": true,\n \"failureOn\": true\n },\n \"runningAs\": {\n \"id\": 370,\n \"name\": \"User devuserfactory297 297\",\n \"username\": \"devuserfactory297\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"myPermissionLevel\": \"manage\",\n \"inputFieldMapping\": {\n \"primary_key\": \"voterbase_id\",\n \"first_name\": \"first\",\n \"last_name\": \"last\",\n \"city\": \"city\",\n \"state\": \"state_code\",\n \"zip\": \"zip\"\n },\n \"inputTable\": {\n \"databaseName\": \"db1\",\n \"schema\": \"schema1\",\n \"table\": \"tbl1\"\n },\n \"matchTargetId\": 1,\n \"outputTable\": {\n \"databaseName\": \"output_db\",\n \"schema\": \"output_schema\",\n \"table\": \"output_tbl\"\n },\n \"maxMatches\": 1,\n \"threshold\": 0.0,\n \"archived\": false,\n \"lastRun\": {\n \"id\": 30,\n \"state\": \"running\",\n \"createdAt\": \"2024-12-03T19:43:10.000Z\",\n \"startedAt\": null,\n \"finishedAt\": null,\n \"error\": null\n },\n \"parentId\": null\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"eb51bd78b84a479ec3f4ba4b496a30f0\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"00d997c6-1b74-4cfb-b93d-48aa973891da","X-Runtime":"0.038037","Content-Length":"1310"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/enhancements/civis-data-match/396\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer 3Q0XciIWJxCrcOqiUVxm5MWdJVD-9_LPU_FKeXMfH3U\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"put":{"summary":"Replace all attributes of this Civis Data Match Enhancement","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID for the enhancement.","type":"integer"},{"name":"Object111","in":"body","schema":{"$ref":"#/definitions/Object111"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object106"}}},"x-examples":null,"x-deprecation-warning":null},"patch":{"summary":"Update some attributes of this Civis Data Match Enhancement","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID for the enhancement.","type":"integer"},{"name":"Object112","in":"body","schema":{"$ref":"#/definitions/Object112"},"required":false}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object106"}}},"x-examples":[{"resource":"Enhancements","resource_explanation":null,"http_method":"PATCH","route":"http://api.civis.test/enhancements/civis-data-match/:civis_data_match_id","description":"Update a Civis Data Match enhancement via PATCH","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"PATCH","request_path":"http://api.civis.test/enhancements/civis-data-match/1781","request_body":"{\n \"threshold\": 0.5,\n \"input_table\": {\n \"database_name\": \"db_input\",\n \"schema\": \"schema_input\",\n \"table\": \"tbl_input\"\n }\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer wYqHLzu5R3tIqObr5qYOV0B9I6zsdGmiI-vMgoL8rq4","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 1781,\n \"name\": \"Script #1781\",\n \"type\": \"Container\",\n \"createdAt\": \"2024-12-03T19:45:00.000Z\",\n \"updatedAt\": \"2024-12-03T20:45:00.000Z\",\n \"author\": {\n \"id\": 1819,\n \"name\": \"User devuserfactory1454 1454\",\n \"username\": \"devuserfactory1454\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"state\": \"running\",\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n },\n \"notifications\": {\n \"urls\": [\n\n ],\n \"successEmailSubject\": null,\n \"successEmailBody\": null,\n \"successEmailAddresses\": [\n\n ],\n \"successEmailFromName\": null,\n \"successEmailReplyTo\": null,\n \"failureEmailAddresses\": [\n\n ],\n \"stallWarningMinutes\": null,\n \"successOn\": true,\n \"failureOn\": true\n },\n \"runningAs\": {\n \"id\": 1819,\n \"name\": \"User devuserfactory1454 1454\",\n \"username\": \"devuserfactory1454\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"myPermissionLevel\": \"manage\",\n \"inputFieldMapping\": {\n \"primary_key\": \"voterbase_id\",\n \"first_name\": \"first\",\n \"last_name\": \"last\",\n \"city\": \"city\",\n \"state\": \"state_code\",\n \"zip\": \"zip\"\n },\n \"inputTable\": {\n \"databaseName\": \"db_input\",\n \"schema\": \"schema_input\",\n \"table\": \"tbl_input\"\n },\n \"matchTargetId\": 1,\n \"outputTable\": {\n \"databaseName\": \"output_db\",\n \"schema\": \"output_schema\",\n \"table\": \"output_tbl\"\n },\n \"maxMatches\": 1,\n \"threshold\": 0.5,\n \"archived\": false,\n \"lastRun\": {\n \"id\": 154,\n \"state\": \"running\",\n \"createdAt\": \"2024-12-03T19:45:00.000Z\",\n \"startedAt\": null,\n \"finishedAt\": null,\n \"error\": null\n },\n \"parentId\": null\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"faea88ecc59d7798aefa2476994e4318\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"46b67fe4-ea8f-4180-aff0-3b1d792f0ef4","X-Runtime":"0.106624","Content-Length":"1336"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/enhancements/civis-data-match/1781\" -d '{\"threshold\":0.5,\"input_table\":{\"database_name\":\"db_input\",\"schema\":\"schema_input\",\"table\":\"tbl_input\"}}' -X PATCH \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer wYqHLzu5R3tIqObr5qYOV0B9I6zsdGmiI-vMgoL8rq4\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Enhancements","resource_explanation":null,"http_method":"PATCH","route":"http://api.civis.test/enhancements/civis-data-match/:civis_data_match_id","description":"Update a Civis Data Match enhancement via PATCH without code attributes","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"PATCH","request_path":"http://api.civis.test/enhancements/civis-data-match/1818","request_body":"{\n \"name\": \"new cdm name\"\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer SfFvLlX7oCRcDpplttRHGJ7oN9xlvpMesqqMKUXC_yo","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 1818,\n \"name\": \"new cdm name\",\n \"type\": \"Container\",\n \"createdAt\": \"2024-12-03T19:45:03.000Z\",\n \"updatedAt\": \"2024-12-03T19:45:03.000Z\",\n \"author\": {\n \"id\": 1856,\n \"name\": \"User devuserfactory1485 1485\",\n \"username\": \"devuserfactory1485\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"state\": \"running\",\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n },\n \"notifications\": {\n \"urls\": [\n\n ],\n \"successEmailSubject\": null,\n \"successEmailBody\": null,\n \"successEmailAddresses\": [\n\n ],\n \"successEmailFromName\": null,\n \"successEmailReplyTo\": null,\n \"failureEmailAddresses\": [\n\n ],\n \"stallWarningMinutes\": null,\n \"successOn\": true,\n \"failureOn\": true\n },\n \"runningAs\": {\n \"id\": 1856,\n \"name\": \"User devuserfactory1485 1485\",\n \"username\": \"devuserfactory1485\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"myPermissionLevel\": \"manage\",\n \"inputFieldMapping\": {\n \"primary_key\": \"voterbase_id\",\n \"first_name\": \"first\",\n \"last_name\": \"last\",\n \"city\": \"city\",\n \"state\": \"state_code\",\n \"zip\": \"zip\"\n },\n \"inputTable\": {\n \"databaseName\": \"db1\",\n \"schema\": \"schema1\",\n \"table\": \"tbl1\"\n },\n \"matchTargetId\": 1,\n \"outputTable\": {\n \"databaseName\": \"output_db\",\n \"schema\": \"output_schema\",\n \"table\": \"output_tbl\"\n },\n \"maxMatches\": 1,\n \"threshold\": 0.0,\n \"archived\": false,\n \"lastRun\": {\n \"id\": 157,\n \"state\": \"running\",\n \"createdAt\": \"2024-12-03T19:45:03.000Z\",\n \"startedAt\": null,\n \"finishedAt\": null,\n \"error\": null\n },\n \"parentId\": null\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"a0d7a6c96155ee8cea4555a801d94e9e\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"360a9d1f-a04e-4ee1-9499-f4c301331122","X-Runtime":"0.127584","Content-Length":"1321"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/enhancements/civis-data-match/1818\" -d '{\"name\":\"new cdm name\"}' -X PATCH \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer SfFvLlX7oCRcDpplttRHGJ7oN9xlvpMesqqMKUXC_yo\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/enhancements/civis-data-match/{id}/clone":{"post":{"summary":"Clone this Civis Data Match Enhancement","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID for the enhancement.","type":"integer"},{"name":"Object115","in":"body","schema":{"$ref":"#/definitions/Object115"},"required":false}],"responses":{"201":{"description":"success","schema":{"$ref":"#/definitions/Object106"}}},"x-examples":[{"resource":"Enhancements","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/enhancements/civis-data-match/:civis_data_match_id/clone","description":"Clone a civis data match enhancement","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/enhancements/civis-data-match/1706/clone","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer OKNB1k9CExr-lG0qqZGK7afdY0s_mu5CEdZcTaqHukI","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":201,"response_status_text":"Created","response_body":"{\n \"id\": 1707,\n \"name\": \"Clone of Enhancement 1706 Script #1706\",\n \"type\": \"Container\",\n \"createdAt\": \"2024-12-03T19:44:54.000Z\",\n \"updatedAt\": \"2024-12-03T19:44:54.000Z\",\n \"author\": {\n \"id\": 1745,\n \"name\": \"User devuserfactory1392 1392\",\n \"username\": \"devuserfactory1392\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"state\": \"idle\",\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n },\n \"notifications\": {\n \"urls\": [\n\n ],\n \"successEmailSubject\": null,\n \"successEmailBody\": null,\n \"successEmailAddresses\": [\n \"enhancements_spec_user@civisanalytics.com\"\n ],\n \"successEmailFromName\": null,\n \"successEmailReplyTo\": null,\n \"failureEmailAddresses\": [\n \"enhancements_spec_user@civisanalytics.com\"\n ],\n \"stallWarningMinutes\": null,\n \"successOn\": true,\n \"failureOn\": true\n },\n \"runningAs\": {\n \"id\": 1745,\n \"name\": \"User devuserfactory1392 1392\",\n \"username\": \"devuserfactory1392\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"myPermissionLevel\": \"manage\",\n \"inputFieldMapping\": {\n \"primary_key\": \"voterbase_id\",\n \"first_name\": \"first\",\n \"last_name\": \"last\",\n \"city\": \"city\",\n \"state\": \"state_code\",\n \"zip\": \"zip\"\n },\n \"inputTable\": {\n \"databaseName\": \"db1\",\n \"schema\": \"schema1\",\n \"table\": \"tbl1\"\n },\n \"matchTargetId\": 1,\n \"outputTable\": {\n \"databaseName\": \"output_db\",\n \"schema\": \"output_schema\",\n \"table\": \"output_tbl\"\n },\n \"maxMatches\": 1,\n \"threshold\": 0.0,\n \"archived\": false,\n \"lastRun\": null,\n \"parentId\": null\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"53ba2363c9e7d844c548b709d6e55f90\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"ba555799-9971-4c62-be39-c31396bd4f1b","X-Runtime":"0.123980","Content-Length":"1319"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/enhancements/civis-data-match/1706/clone\" -d '' -X POST \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer OKNB1k9CExr-lG0qqZGK7afdY0s_mu5CEdZcTaqHukI\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Enhancements","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/enhancements/civis-data-match/:civis_data_match_id/clone","description":"Request 404s","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/enhancements/civis-data-match/1934/clone","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer 4lPEJJD5LeD8Tl7ihB3D5ZbpYk-dwCNze3W_gcOFeYM","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":404,"response_status_text":"Not Found","response_body":"{\n \"error\": \"not_found\",\n \"errorDescription\": \"The requested endpoint could not be found.\",\n \"code\": 404\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"7f6ef3a0-596d-4e94-a6e0-52bcca405451","X-Runtime":"0.022268","Content-Length":"96"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/enhancements/civis-data-match/1934/clone\" -d '' -X POST \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer 4lPEJJD5LeD8Tl7ihB3D5ZbpYk-dwCNze3W_gcOFeYM\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/enhancements/civis-data-match/{id}/runs":{"post":{"summary":"Start a run","description":"Start a run and provide a URI for checking its status. The response will provide a 'Location' header which will contain a URI which may be polled to monitor the status of the run.","deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Civis Data Match job.","type":"integer"}],"responses":{"202":{"description":"success","schema":{"$ref":"#/definitions/Object116"}}},"x-examples":[{"resource":"Enhancements","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/enhancements/civis-data-match/:civis_data_match_to_run_id/runs","description":"Create civis data match run","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/enhancements/civis-data-match/1669/runs","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer kFQBPrj85BNZQyaeljQ8j6epzTolT5bYyYqW1XmbWTc","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":202,"response_status_text":"Accepted","response_body":"{\n \"id\": 145,\n \"civisDataMatchId\": 1669,\n \"state\": \"queued\",\n \"isCancelRequested\": false,\n \"createdAt\": \"2024-12-03T19:44:51.000Z\",\n \"startedAt\": null,\n \"finishedAt\": null,\n \"error\": null\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Location":"http://api.civis.test/civis_data_match/1669/runs/145","Content-Type":"application/json; charset=utf-8","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"a98676d3-c751-4f19-82ba-b1207df3155c","X-Runtime":"0.109690","Content-Length":"164"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/enhancements/civis-data-match/1669/runs\" -d '' -X POST \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer kFQBPrj85BNZQyaeljQ8j6epzTolT5bYyYqW1XmbWTc\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Enhancements","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/enhancements/civis-data-match/:civis_data_match_to_run_id/runs","description":"Request 404s","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/enhancements/civis-data-match/%3Acivis_data_match_to_run_id/runs","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer WV6_wpXphm9fz7fC0hUyhJ0hBWtNo2hlLRWydp02cAg","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":404,"response_status_text":"Not Found","response_body":"{\n \"error\": \"not_found\",\n \"errorDescription\": \"The requested endpoint could not be found.\",\n \"code\": 404\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"8891152d-257a-494b-9576-7d1dd38ce9df","X-Runtime":"0.019938","Content-Length":"96"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/enhancements/civis-data-match/%3Acivis_data_match_to_run_id/runs\" -d '' -X POST \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer WV6_wpXphm9fz7fC0hUyhJ0hBWtNo2hlLRWydp02cAg\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"get":{"summary":"List runs for the given Civis Data Match job","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Civis Data Match job.","type":"integer"},{"name":"limit","in":"query","required":false,"description":"Number of results to return. Defaults to 20. Maximum allowed is 100.","type":"integer"},{"name":"page_num","in":"query","required":false,"description":"Page number of the results to return. Defaults to the first page, 1.","type":"integer"},{"name":"order","in":"query","required":false,"description":"The field on which to order the result set. Defaults to id. Must be one of: id.","type":"string"},{"name":"order_dir","in":"query","required":false,"description":"Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc.","type":"string"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object116"}}}},"x-examples":null,"x-deprecation-warning":null}},"/enhancements/civis-data-match/{id}/runs/{run_id}":{"get":{"summary":"Check status of a run","description":"View the status of a run. This endpoint may be polled to monitor the status of the run. When the 'state' field is no longer 'queued' or 'running' the run has reached its final state.","deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Civis Data Match job.","type":"integer"},{"name":"run_id","in":"path","required":true,"description":"The ID of the run.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object116"}}},"x-examples":[{"resource":"Enhancements","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/enhancements/civis-data-match/:civis_data_match_id/runs/:civis_data_match_run_id","description":"View a civis data match enhancement's run details","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/enhancements/civis-data-match/1744/runs/151","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer EXFe_CGVwcdlLykzlDk_zu4Gkz02BOzuI48MDkjR71c","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 151,\n \"civisDataMatchId\": 1744,\n \"state\": \"running\",\n \"isCancelRequested\": false,\n \"createdAt\": \"2024-12-03T19:44:57.000Z\",\n \"startedAt\": null,\n \"finishedAt\": null,\n \"error\": null\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"877b0f4349f1a00f6cb4ed0712e7a8d1\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"ff12ce8b-8906-40e5-a282-692cedd60b0f","X-Runtime":"0.030336","Content-Length":"165"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/enhancements/civis-data-match/1744/runs/151\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer EXFe_CGVwcdlLykzlDk_zu4Gkz02BOzuI48MDkjR71c\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"delete":{"summary":"Cancel a run","description":"Cancel a currently active run.","deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Civis Data Match job.","type":"integer"},{"name":"run_id","in":"path","required":true,"description":"The ID of the run.","type":"integer"}],"responses":{"202":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/enhancements/civis-data-match/{id}/runs/{run_id}/logs":{"get":{"summary":"Get the logs for a run","description":"Get the logs for a run.","deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Civis Data Match job.","type":"integer"},{"name":"run_id","in":"path","required":true,"description":"The ID of the run.","type":"integer"},{"name":"last_id","in":"query","required":false,"description":"The ID of the last log message received. Log entries with this ID value or lower will be omitted.Logs are sorted by ID if this value is provided, and are otherwise sorted by createdAt.","type":"integer"},{"name":"limit","in":"query","required":false,"description":"The maximum number of log messages to return. Default of 10000.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object117"}}}},"x-examples":null,"x-deprecation-warning":null}},"/enhancements/civis-data-match/{id}/cancel":{"post":{"summary":"Cancel a run","description":"Cancel a run.","deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the job.","type":"integer"}],"responses":{"202":{"description":"success","schema":{"$ref":"#/definitions/Object118"}}},"x-examples":null,"x-deprecation-warning":null}},"/enhancements/civis-data-match/{id}/runs/{run_id}/outputs":{"get":{"summary":"List the outputs for a run","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the job.","type":"integer"},{"name":"run_id","in":"path","required":true,"description":"The ID of the run.","type":"integer"},{"name":"limit","in":"query","required":false,"description":"Number of results to return. Defaults to its maximum of 50.","type":"integer"},{"name":"page_num","in":"query","required":false,"description":"Page number of the results to return. Defaults to the first page, 1.","type":"integer"},{"name":"order","in":"query","required":false,"description":"The field on which to order the result set. Defaults to created_at. Must be one of: created_at, id.","type":"string"},{"name":"order_dir","in":"query","required":false,"description":"Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc.","type":"string"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object119"}}}},"x-examples":[{"resource":"Enhancements","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/enhancements/civis-data-match/:job_with_run_id/runs/:job_run_id/outputs","description":"View a Civis Data Match Enhancement's outputs","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/enhancements/civis-data-match/1858/runs/161/outputs","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer diiWJY8kQQR-KjSmaN7sEZB8ij9D8pHvhNMCV8dm9VM","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"objectType\": \"File\",\n \"objectId\": 24,\n \"name\": \"my output file\",\n \"link\": \"api.civis.test/files/24\",\n \"value\": null\n },\n {\n \"objectType\": \"Report\",\n \"objectId\": 9,\n \"name\": \"my output report\",\n \"link\": \"api.civis.test/reports/9\",\n \"value\": null\n },\n {\n \"objectType\": \"Report\",\n \"objectId\": 10,\n \"name\": \"my output tableau report\",\n \"link\": \"api.civis.test/reports/10\",\n \"value\": null\n },\n {\n \"objectType\": \"Table\",\n \"objectId\": 124,\n \"name\": \"output.table\",\n \"link\": \"api.civis.test/tables/124\",\n \"value\": null\n },\n {\n \"objectType\": \"Project\",\n \"objectId\": 5,\n \"name\": \"my output project\",\n \"link\": \"api.civis.test/projects/5\",\n \"value\": null\n },\n {\n \"objectType\": \"Credential\",\n \"objectId\": 292,\n \"name\": \"my output credential\",\n \"link\": \"api.civis.test/credentials/292\",\n \"value\": null\n },\n {\n \"objectType\": \"JSONValue\",\n \"objectId\": 5,\n \"name\": \"my awesome JSON value\",\n \"link\": \"api.civis.test/json_values/5\",\n \"value\": {\n \"foo\": \"bar\"\n }\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","X-Pagination-Per-Page":"50","Access-Control-Expose-Headers":"X-Pagination-Per-Page, X-Pagination-Current-Page, X-Pagination-Total-Pages, X-Pagination-Total-Entries","X-Pagination-Current-Page":"1","X-Pagination-Total-Pages":"1","X-Pagination-Total-Entries":"7","Content-Type":"application/json; charset=utf-8","ETag":"W/\"c2d70d3d0e416103693197143b9bb8ca\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"c5f79aaa-9b4a-4283-8f3b-84eac310f5c6","X-Runtime":"0.071496","Content-Length":"815"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/enhancements/civis-data-match/1858/runs/161/outputs\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer diiWJY8kQQR-KjSmaN7sEZB8ij9D8pHvhNMCV8dm9VM\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/enhancements/civis-data-match/{id}/shares":{"get":{"summary":"List users and groups permissioned on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object9"}}}},"x-examples":null,"x-deprecation-warning":null}},"/enhancements/civis-data-match/{id}/shares/users":{"put":{"summary":"Set the permissions users have on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"Object120","in":"body","schema":{"$ref":"#/definitions/Object120"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object9"}}},"x-examples":null,"x-deprecation-warning":null}},"/enhancements/civis-data-match/{id}/shares/users/{user_id}":{"delete":{"summary":"Revoke the permissions a user has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"user_id","in":"path","required":true,"description":"The ID of the user.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/enhancements/civis-data-match/{id}/shares/groups":{"put":{"summary":"Set the permissions groups has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"Object121","in":"body","schema":{"$ref":"#/definitions/Object121"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object9"}}},"x-examples":null,"x-deprecation-warning":null}},"/enhancements/civis-data-match/{id}/shares/groups/{group_id}":{"delete":{"summary":"Revoke the permissions a group has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"group_id","in":"path","required":true,"description":"The ID of the group.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/enhancements/civis-data-match/{id}/dependencies":{"get":{"summary":"List dependent objects for this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"user_id","in":"query","required":false,"description":"ID of target user","type":"integer"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object15"}}}},"x-examples":null,"x-deprecation-warning":null}},"/enhancements/civis-data-match/{id}/transfer":{"put":{"summary":"Transfer ownership of this object to another user","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"Object122","in":"body","schema":{"$ref":"#/definitions/Object122"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object17"}}},"x-examples":null,"x-deprecation-warning":null}},"/enhancements/civis-data-match/{id}/archive":{"put":{"summary":"Update the archive status of this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the object.","type":"integer"},{"name":"Object123","in":"body","schema":{"$ref":"#/definitions/Object123"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object106"}}},"x-examples":null,"x-deprecation-warning":null}},"/enhancements/civis-data-match/{id}/projects":{"get":{"summary":"List the projects a Civis Data Match Enhancement belongs to","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Civis Data Match Enhancement.","type":"integer"},{"name":"hidden","in":"query","required":false,"description":"If specified to be true, returns hidden items. Defaults to false, returning non-hidden items.","type":"boolean"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object85"}}}},"x-examples":null,"x-deprecation-warning":null}},"/enhancements/civis-data-match/{id}/projects/{project_id}":{"put":{"summary":"Add a Civis Data Match Enhancement to a project","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Civis Data Match Enhancement.","type":"integer"},{"name":"project_id","in":"path","required":true,"description":"The ID of the project.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null},"delete":{"summary":"Remove a Civis Data Match Enhancement from a project","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Civis Data Match Enhancement.","type":"integer"},{"name":"project_id","in":"path","required":true,"description":"The ID of the project.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/enhancements/identity-resolution/":{"get":{"summary":"List Identity Resolution Enhancements","description":null,"deprecated":false,"parameters":[{"name":"archived","in":"query","required":false,"description":"The archival status of the requested item(s).","type":"string"},{"name":"status","in":"query","required":false,"description":"If specified, returns items with one of these statuses. It accepts a comma-separated list, possible values are 'running', 'failed', 'succeeded', 'idle', 'scheduled'.","type":"string"},{"name":"limit","in":"query","required":false,"description":"Number of results to return. Defaults to 50. Maximum allowed is 100.","type":"integer"},{"name":"page_num","in":"query","required":false,"description":"Page number of the results to return. Defaults to the first page, 1.","type":"integer"},{"name":"order","in":"query","required":false,"description":"The field on which to order the result set. Defaults to updated_at. Must be one of: updated_at, created_at, last_run_updated_at.","type":"string"},{"name":"order_dir","in":"query","required":false,"description":"Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc.","type":"string"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object124"}}}},"x-examples":null,"x-deprecation-warning":null},"post":{"summary":"Create an Identity Resolution Enhancement","description":null,"deprecated":false,"parameters":[{"name":"Object128","in":"body","schema":{"$ref":"#/definitions/Object128"},"required":true}],"responses":{"201":{"description":"success","schema":{"$ref":"#/definitions/Object135"}}},"x-examples":null,"x-deprecation-warning":null}},"/enhancements/identity-resolution/{id}":{"put":{"summary":"Replace all attributes of this Identity Resolution Enhancement","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID for the enhancement.","type":"integer"},{"name":"Object143","in":"body","schema":{"$ref":"#/definitions/Object143"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object135"}}},"x-examples":null,"x-deprecation-warning":null},"patch":{"summary":"Update some attributes of this Identity Resolution Enhancement","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID for the enhancement.","type":"integer"},{"name":"Object144","in":"body","schema":{"$ref":"#/definitions/Object144"},"required":false}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object135"}}},"x-examples":null,"x-deprecation-warning":null},"get":{"summary":"Get an Identity Resolution Enhancement","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID for the enhancement.","type":"integer"},{"name":"is_legacy_id","in":"query","required":false,"description":"Whether the given ID is for the Identity Resolution job in the legacy service app.","type":"boolean"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object135"}}},"x-examples":null,"x-deprecation-warning":null}},"/enhancements/identity-resolution/{id}/clone":{"post":{"summary":"Clone this Identity Resolution Enhancement","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID for the enhancement.","type":"integer"},{"name":"Object115","in":"body","schema":{"$ref":"#/definitions/Object115"},"required":false}],"responses":{"201":{"description":"success","schema":{"$ref":"#/definitions/Object135"}}},"x-examples":[{"resource":"Enhancements","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/enhancements/identity-resolution/:identity_resolution_id/clone","description":"Clone an identity resolution enhancement","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/enhancements/identity-resolution/1273/clone","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer z4jaPDEBfHA1M5AxyiV1E8H70ohpQu7KHLMy00Kf7Vs","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":201,"response_status_text":"Created","response_body":"{\n \"id\": 1274,\n \"name\": \"Clone of Identity Resolution 1273 Identity Resolution #1273\",\n \"type\": \"Identity Resolution\",\n \"createdAt\": \"2024-12-03T19:44:21.000Z\",\n \"updatedAt\": \"2024-12-03T19:44:21.000Z\",\n \"author\": {\n \"id\": 1307,\n \"name\": \"User devuserfactory1025 1025\",\n \"username\": \"devuserfactory1025\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"state\": \"idle\",\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n },\n \"notifications\": {\n \"urls\": [\n\n ],\n \"successEmailSubject\": null,\n \"successEmailBody\": null,\n \"successEmailAddresses\": [\n \"enhancements_spec_user@civisanalytics.com\"\n ],\n \"successEmailFromName\": null,\n \"successEmailReplyTo\": null,\n \"failureEmailAddresses\": [\n \"enhancements_spec_user@civisanalytics.com\"\n ],\n \"stallWarningMinutes\": null,\n \"successOn\": true,\n \"failureOn\": true\n },\n \"runningAs\": {\n \"id\": 1307,\n \"name\": \"User devuserfactory1025 1025\",\n \"username\": \"devuserfactory1025\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"myPermissionLevel\": \"manage\",\n \"archived\": false,\n \"threshold\": 0.5,\n \"sources\": [\n\n ],\n \"matchTargetId\": null,\n \"enforcedLinks\": [\n\n ],\n \"customerGraph\": null,\n \"goldenTable\": null,\n \"linkScores\": null,\n \"legacyId\": null,\n \"lastRun\": null\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"00f102e659ee244b00cd89713bb6e7d1\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"3cb53de1-842b-4813-8de8-f39047773d9c","X-Runtime":"0.097724","Content-Length":"1131"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/enhancements/identity-resolution/1273/clone\" -d '' -X POST \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer z4jaPDEBfHA1M5AxyiV1E8H70ohpQu7KHLMy00Kf7Vs\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/enhancements/identity-resolution/{id}/runs":{"post":{"summary":"Start a run","description":"Start a run and provide a URI for checking its status. The response will provide a 'Location' header which will contain a URI which may be polled to monitor the status of the run.","deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Identity Resolution job.","type":"integer"}],"responses":{"202":{"description":"success","schema":{"$ref":"#/definitions/Object151"}}},"x-examples":[{"resource":"Enhancements","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/enhancements/identity-resolution/:identity_resolution_id/runs","description":"Create a Identity Resolution run","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/enhancements/identity-resolution/1313/runs","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer BZLa2Qpn9BXeSxKxKfslNeFdvqPZ6ScUNMlBx-3LH1c","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":202,"response_status_text":"Accepted","response_body":"{\n \"id\": 109,\n \"identityResolutionId\": 1313,\n \"state\": \"queued\",\n \"isCancelRequested\": false,\n \"createdAt\": \"2024-12-03T19:44:25.000Z\",\n \"startedAt\": null,\n \"finishedAt\": null,\n \"error\": null,\n \"config\": null,\n \"sampleRecordsQuery\": null,\n \"expandClusterQuery\": null,\n \"runMetrics\": null,\n \"errorSection\": null\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Location":"http://api.civis.test/identity_resolution/1313/runs/109","Content-Type":"application/json; charset=utf-8","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"86c9e1be-4029-4881-826b-7fcbc1a9643e","X-Runtime":"0.126655","Content-Length":"272"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/enhancements/identity-resolution/1313/runs\" -d '' -X POST \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer BZLa2Qpn9BXeSxKxKfslNeFdvqPZ6ScUNMlBx-3LH1c\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"get":{"summary":"List runs for the given Identity Resolution job","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Identity Resolution job.","type":"integer"},{"name":"limit","in":"query","required":false,"description":"Number of results to return. Defaults to 20. Maximum allowed is 100.","type":"integer"},{"name":"page_num","in":"query","required":false,"description":"Page number of the results to return. Defaults to the first page, 1.","type":"integer"},{"name":"order","in":"query","required":false,"description":"The field on which to order the result set. Defaults to id. Must be one of: id.","type":"string"},{"name":"order_dir","in":"query","required":false,"description":"Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc.","type":"string"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object152"}}}},"x-examples":[{"resource":"Enhancements","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/enhancements/identity-resolution/:identity_resolution_id/runs","description":"View a Identity Resolution enhancement's runs","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/enhancements/identity-resolution/1391/runs","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer HBBQ0RHYBh14qZG-DG4kaA4k4MJUoS9JO4VgrFLangI","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 119,\n \"identityResolutionId\": 1391,\n \"state\": \"running\",\n \"isCancelRequested\": false,\n \"createdAt\": \"2024-12-03T19:44:30.000Z\",\n \"startedAt\": null,\n \"finishedAt\": \"2024-12-03T19:43:30.000Z\",\n \"error\": null,\n \"sampleRecordsQuery\": \"SELECT * FROM table\",\n \"expandClusterQuery\": \"SELECT * FROM table\",\n \"runMetrics\": {\n \"numRecords\": 3,\n \"uniqueIds\": 2,\n \"uniqueDeduplicatedIds\": 5,\n \"maxClusterSize\": 100,\n \"avgClusterSize\": 50.0,\n \"clusterSizeFrequencies\": {\n }\n }\n },\n {\n \"id\": 118,\n \"identityResolutionId\": 1391,\n \"state\": \"running\",\n \"isCancelRequested\": false,\n \"createdAt\": \"2024-12-03T19:44:30.000Z\",\n \"startedAt\": null,\n \"finishedAt\": \"2024-12-03T19:42:30.000Z\",\n \"error\": null,\n \"sampleRecordsQuery\": \"SELECT * FROM table\",\n \"expandClusterQuery\": \"SELECT * FROM table\",\n \"runMetrics\": {\n \"numRecords\": 3,\n \"uniqueIds\": 2,\n \"uniqueDeduplicatedIds\": 5,\n \"maxClusterSize\": 100,\n \"avgClusterSize\": 50.0,\n \"clusterSizeFrequencies\": {\n }\n }\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","X-Pagination-Per-Page":"20","Access-Control-Expose-Headers":"X-Pagination-Per-Page, X-Pagination-Current-Page, X-Pagination-Total-Pages, X-Pagination-Total-Entries","X-Pagination-Current-Page":"1","X-Pagination-Total-Pages":"1","X-Pagination-Total-Entries":"2","Content-Type":"application/json; charset=utf-8","ETag":"W/\"40309f988aff5525f50c4c68e7066866\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"9d0e8508-bf31-4667-8887-aeb06c6e4b97","X-Runtime":"0.038235","Content-Length":"839"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/enhancements/identity-resolution/1391/runs\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer HBBQ0RHYBh14qZG-DG4kaA4k4MJUoS9JO4VgrFLangI\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/enhancements/identity-resolution/{id}/runs/{run_id}":{"get":{"summary":"Check status of a run","description":"View the status of a run. This endpoint may be polled to monitor the status of the run. When the 'state' field is no longer 'queued' or 'running' the run has reached its final state.","deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Identity Resolution job.","type":"integer"},{"name":"run_id","in":"path","required":true,"description":"The ID of the run.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object151"}}},"x-examples":[{"resource":"Enhancements","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/enhancements/identity-resolution/:identity_resolution_id/runs/:idr_run_id","description":"View a Identity Resolution enhancement's run details","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/enhancements/identity-resolution/1352/runs/113","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer 5ALuB8foVGuGQpnhn-1a69OBIptrBbcNZQffXeOyF1k","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 113,\n \"identityResolutionId\": 1352,\n \"state\": \"running\",\n \"isCancelRequested\": false,\n \"createdAt\": \"2024-12-03T19:44:27.000Z\",\n \"startedAt\": null,\n \"finishedAt\": \"2024-12-03T19:42:27.000Z\",\n \"error\": null,\n \"config\": {\n \"job_id\": 1352,\n \"run_id\": 113,\n \"name\": \"Identity Resolution #1352\",\n \"updated_at\": \"2024-12-03T19:39:27.000Z\",\n \"threshold\": 0.5,\n \"match_target_id\": null,\n \"sources\": [\n\n ],\n \"enforced_links\": [\n\n ],\n \"customer_graph\": null,\n \"golden_table\": null,\n \"link_scores\": null\n },\n \"sampleRecordsQuery\": \"SELECT * FROM table\",\n \"expandClusterQuery\": \"SELECT * FROM table\",\n \"runMetrics\": {\n \"numRecords\": 3,\n \"uniqueIds\": 2,\n \"uniqueDeduplicatedIds\": 5,\n \"maxClusterSize\": 100,\n \"avgClusterSize\": 50.0,\n \"clusterSizeFrequencies\": {\n }\n },\n \"errorSection\": \"data_preparation\"\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"33bda6e77d84a94e640ab07971bad2a2\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"2dd781d3-aaad-4d1d-b80f-37b0ab60fce8","X-Runtime":"0.036446","Content-Length":"698"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/enhancements/identity-resolution/1352/runs/113\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer 5ALuB8foVGuGQpnhn-1a69OBIptrBbcNZQffXeOyF1k\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"delete":{"summary":"Cancel a run","description":"Cancel a currently active run.","deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Identity Resolution job.","type":"integer"},{"name":"run_id","in":"path","required":true,"description":"The ID of the run.","type":"integer"}],"responses":{"202":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/enhancements/identity-resolution/{id}/runs/{run_id}/logs":{"get":{"summary":"Get the logs for a run","description":"Get the logs for a run.","deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Identity Resolution job.","type":"integer"},{"name":"run_id","in":"path","required":true,"description":"The ID of the run.","type":"integer"},{"name":"last_id","in":"query","required":false,"description":"The ID of the last log message received. Log entries with this ID value or lower will be omitted.Logs are sorted by ID if this value is provided, and are otherwise sorted by createdAt.","type":"integer"},{"name":"limit","in":"query","required":false,"description":"The maximum number of log messages to return. Default of 10000.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object117"}}}},"x-examples":null,"x-deprecation-warning":null}},"/enhancements/identity-resolution/{id}/cancel":{"post":{"summary":"Cancel a run","description":"Cancel a run.","deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the job.","type":"integer"}],"responses":{"202":{"description":"success","schema":{"$ref":"#/definitions/Object153"}}},"x-examples":null,"x-deprecation-warning":null}},"/enhancements/types":{"get":{"summary":"List available enhancement types","description":null,"deprecated":false,"parameters":[],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object155"}}}},"x-examples":null,"x-deprecation-warning":null}},"/enhancements/field-mapping":{"get":{"summary":"List the fields in a field mapping for Civis Data Match, Data Unification, and Table Deduplication jobs","description":null,"deprecated":false,"parameters":[],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object156"}}}},"x-examples":[{"resource":"Enhancements","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/enhancements/field-mapping","description":"List the valid fields for a field mapping","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/enhancements/field-mapping","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer cPt-Zu43F3y8HhPM72k26zMF5oQ6dHG_QquJNTfXASA","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"field\": \"primary_key\",\n \"description\": \"A unique identifier.\"\n },\n {\n \"field\": \"first_name\",\n \"description\": \"First name.\"\n },\n {\n \"field\": \"middle_name\",\n \"description\": \"Middle name.\"\n },\n {\n \"field\": \"last_name\",\n \"description\": \"Last name.\"\n },\n {\n \"field\": \"gender\",\n \"description\": \"Gender. The following formats for gender are acceptable: Male/Female or M/F.\"\n },\n {\n \"field\": \"phone\",\n \"description\": \"10-digit phone number. All non-numeric characters (dashes, parentheses, spaces, periods, etc.) will be removed.\"\n },\n {\n \"field\": \"email\",\n \"description\": \"Email address.\"\n },\n {\n \"field\": \"birth_date\",\n \"description\": \"Full birth date, including year, month, and day.\"\n },\n {\n \"field\": \"birth_year\",\n \"description\": \"Birth year.\"\n },\n {\n \"field\": \"birth_month\",\n \"description\": \"Birth month.\"\n },\n {\n \"field\": \"birth_day\",\n \"description\": \"Birth day.\"\n },\n {\n \"field\": \"house_number\",\n \"description\": \"House number.\"\n },\n {\n \"field\": \"street\",\n \"description\": \"Street.\"\n },\n {\n \"field\": \"unit\",\n \"description\": \"Unit/apartment/suite number.\"\n },\n {\n \"field\": \"full_address\",\n \"description\": \"Full address with house number, street, and unit/apartment/suite number\"\n },\n {\n \"field\": \"city\",\n \"description\": \"City.\"\n },\n {\n \"field\": \"state\",\n \"description\": \"Full state name.\"\n },\n {\n \"field\": \"state_code\",\n \"description\": \"Two-digit state code.\"\n },\n {\n \"field\": \"zip\",\n \"description\": \"5-digit or 9-digit zip code. All non-numeric characters will be removed.\"\n },\n {\n \"field\": \"lat\",\n \"description\": \"Latitude.\"\n },\n {\n \"field\": \"lon\",\n \"description\": \"Longitude.\"\n },\n {\n \"field\": \"name_suffix\",\n \"description\": \"A name suffix such as Jr., Sr., etc ...\"\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"09e040220da82d82d92080b8704d210e\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"55037ed8-abce-4fe2-b545-ed0e8daa1b44","X-Runtime":"0.018571","Content-Length":"1457"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/enhancements/field-mapping\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer cPt-Zu43F3y8HhPM72k26zMF5oQ6dHG_QquJNTfXASA\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/enhancements/":{"get":{"summary":"List Enhancements","description":null,"deprecated":false,"parameters":[{"name":"type","in":"query","required":false,"description":"If specified, return items of these types.","type":"string"},{"name":"author","in":"query","required":false,"description":"If specified, return items from any of these authors. It accepts a comma-separated list of user IDs.","type":"string"},{"name":"status","in":"query","required":false,"description":"If specified, returns items with one of these statuses. It accepts a comma-separated list, possible values are 'running', 'failed', 'succeeded', 'idle', 'scheduled'.","type":"string"},{"name":"archived","in":"query","required":false,"description":"The archival status of the requested item(s).","type":"string"},{"name":"limit","in":"query","required":false,"description":"Number of results to return. Defaults to 20. Maximum allowed is 50.","type":"integer"},{"name":"page_num","in":"query","required":false,"description":"Page number of the results to return. Defaults to the first page, 1.","type":"integer"},{"name":"order","in":"query","required":false,"description":"The field on which to order the result set. Defaults to updated_at. Must be one of: updated_at, name, created_at, last_run.updated_at.","type":"string"},{"name":"order_dir","in":"query","required":false,"description":"Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc.","type":"string"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object157"}}}},"x-examples":[{"resource":"Enhancements","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/enhancements","description":"List all enhancements","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/enhancements","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer 2zR0Feo8IVd-UTJFAdH-ZSO0cGdpGg3YDp2R4C2IO70","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 13,\n \"name\": \"Script #13\",\n \"type\": \"Container\",\n \"createdAt\": \"2024-12-03T19:42:40.000Z\",\n \"updatedAt\": \"2024-12-03T22:42:40.000Z\",\n \"author\": {\n \"id\": 6,\n \"name\": \"User devuserfactory1 1\",\n \"username\": \"devuserfactory1\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"state\": \"running\",\n \"archived\": false\n },\n {\n \"id\": 25,\n \"name\": \"Script #25\",\n \"type\": \"Container\",\n \"createdAt\": \"2024-12-03T19:42:42.000Z\",\n \"updatedAt\": \"2024-12-03T21:42:41.000Z\",\n \"author\": {\n \"id\": 6,\n \"name\": \"User devuserfactory1 1\",\n \"username\": \"devuserfactory1\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"state\": \"running\",\n \"archived\": false\n },\n {\n \"id\": 37,\n \"name\": \"Script #37\",\n \"type\": \"Container\",\n \"createdAt\": \"2024-12-03T19:42:42.000Z\",\n \"updatedAt\": \"2024-12-03T20:42:42.000Z\",\n \"author\": {\n \"id\": 6,\n \"name\": \"User devuserfactory1 1\",\n \"username\": \"devuserfactory1\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"state\": \"running\",\n \"archived\": false\n },\n {\n \"id\": 1,\n \"name\": \"CASS/NCOA #1\",\n \"type\": \"CASS-NCOA\",\n \"createdAt\": \"2024-12-03T19:42:40.000Z\",\n \"updatedAt\": \"2024-12-03T19:37:39.000Z\",\n \"author\": {\n \"id\": 6,\n \"name\": \"User devuserfactory1 1\",\n \"username\": \"devuserfactory1\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"state\": \"idle\",\n \"archived\": false\n },\n {\n \"id\": 38,\n \"name\": \"CASS/NCOA #38\",\n \"type\": \"CASS-NCOA\",\n \"createdAt\": \"2024-12-03T19:42:43.000Z\",\n \"updatedAt\": \"2024-12-03T19:32:43.000Z\",\n \"author\": {\n \"id\": 43,\n \"name\": \"User devuserfactory32 32\",\n \"username\": \"devuserfactory32\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"state\": \"idle\",\n \"archived\": false\n },\n {\n \"id\": 41,\n \"name\": \"Script #41\",\n \"type\": \"Container\",\n \"createdAt\": \"2024-12-03T19:42:43.000Z\",\n \"updatedAt\": \"2024-12-03T19:27:43.000Z\",\n \"author\": {\n \"id\": 6,\n \"name\": \"User devuserfactory1 1\",\n \"username\": \"devuserfactory1\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"state\": \"idle\",\n \"archived\": false\n },\n {\n \"id\": 43,\n \"name\": \"Geocode #43\",\n \"type\": \"Geocode\",\n \"createdAt\": \"2024-12-03T19:42:43.000Z\",\n \"updatedAt\": \"2024-12-03T19:17:43.000Z\",\n \"author\": {\n \"id\": 6,\n \"name\": \"User devuserfactory1 1\",\n \"username\": \"devuserfactory1\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"state\": \"idle\",\n \"archived\": false\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","X-Pagination-Per-Page":"20","Access-Control-Expose-Headers":"X-Pagination-Per-Page, X-Pagination-Current-Page, X-Pagination-Total-Pages, X-Pagination-Total-Entries","X-Pagination-Current-Page":"1","X-Pagination-Total-Pages":"1","X-Pagination-Total-Entries":"7","Content-Type":"application/json; charset=utf-8","ETag":"W/\"f6dc8cb55897a243b7ebd14ffdec2bd6\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"c10c66b5-0cb9-4b9a-9e13-9f6ac44314b6","X-Runtime":"0.221880","Content-Length":"1893"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/enhancements\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer 2zR0Feo8IVd-UTJFAdH-ZSO0cGdpGg3YDp2R4C2IO70\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Enhancements","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/enhancements","description":"Filter enhancements by author","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/enhancements?author=87","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer mQKQws9vI0uHYQBIGxdH6qIMifui7v2-sk6eaKROYTg","Host":"api.civis.test","Cookie":""},"request_query_parameters":{"author":"87"},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 81,\n \"name\": \"CASS/NCOA #81\",\n \"type\": \"CASS-NCOA\",\n \"createdAt\": \"2024-12-03T19:42:46.000Z\",\n \"updatedAt\": \"2024-12-03T19:32:46.000Z\",\n \"author\": {\n \"id\": 87,\n \"name\": \"User devuserfactory67 67\",\n \"username\": \"devuserfactory67\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"state\": \"idle\",\n \"archived\": false\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","X-Pagination-Per-Page":"20","Access-Control-Expose-Headers":"X-Pagination-Per-Page, X-Pagination-Current-Page, X-Pagination-Total-Pages, X-Pagination-Total-Entries","X-Pagination-Current-Page":"1","X-Pagination-Total-Pages":"1","X-Pagination-Total-Entries":"1","Content-Type":"application/json; charset=utf-8","ETag":"W/\"9cf668135123810f0beab3ea9025849f\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"5dfe18c8-ec99-41d3-8350-ca3be6ec2348","X-Runtime":"0.037015","Content-Length":"276"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/enhancements?author=87\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer mQKQws9vI0uHYQBIGxdH6qIMifui7v2-sk6eaKROYTg\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Enhancements","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/enhancements","description":"Filter enhancements by type","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/enhancements?type=cass_ncoa","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer KaNGN7Yd7Er2LPJOB-2E6K55C7zJ7lBeM-myKqXjuew","Host":"api.civis.test","Cookie":""},"request_query_parameters":{"type":"cass_ncoa"},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 87,\n \"name\": \"CASS/NCOA #87\",\n \"type\": \"CASS-NCOA\",\n \"createdAt\": \"2024-12-03T19:42:47.000Z\",\n \"updatedAt\": \"2024-12-03T19:37:47.000Z\",\n \"author\": {\n \"id\": 94,\n \"name\": \"User devuserfactory71 71\",\n \"username\": \"devuserfactory71\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"state\": \"idle\",\n \"archived\": false\n },\n {\n \"id\": 124,\n \"name\": \"CASS/NCOA #124\",\n \"type\": \"CASS-NCOA\",\n \"createdAt\": \"2024-12-03T19:42:49.000Z\",\n \"updatedAt\": \"2024-12-03T19:32:49.000Z\",\n \"author\": {\n \"id\": 131,\n \"name\": \"User devuserfactory102 102\",\n \"username\": \"devuserfactory102\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"state\": \"idle\",\n \"archived\": false\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","X-Pagination-Per-Page":"20","Access-Control-Expose-Headers":"X-Pagination-Per-Page, X-Pagination-Current-Page, X-Pagination-Total-Pages, X-Pagination-Total-Entries","X-Pagination-Current-Page":"1","X-Pagination-Total-Pages":"1","X-Pagination-Total-Entries":"2","Content-Type":"application/json; charset=utf-8","ETag":"W/\"f5016f9a7916083df3f6b28291458852\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"f11e8f33-d9a9-479d-b790-4e20df564f34","X-Runtime":"0.030261","Content-Length":"557"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/enhancements?type=cass_ncoa\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer KaNGN7Yd7Er2LPJOB-2E6K55C7zJ7lBeM-myKqXjuew\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Enhancements","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/enhancements","description":"Filter enhancements by status","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/enhancements?status=running","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer IAj70RvpfKU5YW6w3hUGmnjo53iwIOZrXPOJ2up05Yk","Host":"api.civis.test","Cookie":""},"request_query_parameters":{"status":"running"},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 142,\n \"name\": \"Script #142\",\n \"type\": \"Container\",\n \"createdAt\": \"2024-12-03T19:42:51.000Z\",\n \"updatedAt\": \"2024-12-03T22:42:51.000Z\",\n \"author\": {\n \"id\": 138,\n \"name\": \"User devuserfactory106 106\",\n \"username\": \"devuserfactory106\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"state\": \"running\",\n \"archived\": false\n },\n {\n \"id\": 154,\n \"name\": \"Script #154\",\n \"type\": \"Container\",\n \"createdAt\": \"2024-12-03T19:42:51.000Z\",\n \"updatedAt\": \"2024-12-03T21:42:51.000Z\",\n \"author\": {\n \"id\": 138,\n \"name\": \"User devuserfactory106 106\",\n \"username\": \"devuserfactory106\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"state\": \"running\",\n \"archived\": false\n },\n {\n \"id\": 166,\n \"name\": \"Script #166\",\n \"type\": \"Container\",\n \"createdAt\": \"2024-12-03T19:42:52.000Z\",\n \"updatedAt\": \"2024-12-03T20:42:52.000Z\",\n \"author\": {\n \"id\": 138,\n \"name\": \"User devuserfactory106 106\",\n \"username\": \"devuserfactory106\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"state\": \"running\",\n \"archived\": false\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","X-Pagination-Per-Page":"20","Access-Control-Expose-Headers":"X-Pagination-Per-Page, X-Pagination-Current-Page, X-Pagination-Total-Pages, X-Pagination-Total-Entries","X-Pagination-Current-Page":"1","X-Pagination-Total-Pages":"1","X-Pagination-Total-Entries":"3","Content-Type":"application/json; charset=utf-8","ETag":"W/\"47e67e9ddc54da400fe77acd0a472f0e\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"938ec466-da3b-434b-8f58-7a1ad755564c","X-Runtime":"0.044192","Content-Length":"844"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/enhancements?status=running\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer IAj70RvpfKU5YW6w3hUGmnjo53iwIOZrXPOJ2up05Yk\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/enhancements/cass-ncoa":{"post":{"summary":"Create a CASS/NCOA Enhancement","description":null,"deprecated":false,"parameters":[{"name":"Object158","in":"body","schema":{"$ref":"#/definitions/Object158"},"required":true}],"responses":{"201":{"description":"success","schema":{"$ref":"#/definitions/Object164"}}},"x-examples":[{"resource":"Enhancements","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/enhancements/cass-ncoa","description":"Create a CASS/NCOA enhancement","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/enhancements/cass-ncoa","request_body":"{\n \"name\": \"My CASS enhancement\",\n \"source\": {\n \"database_table\": {\n \"remote_host_id\": 5,\n \"schema\": \"schema_name\",\n \"table\": \"table_name25\",\n \"credential_id\": 76\n }\n },\n \"notifications\": {\n \"success_email_addresses\": \"test1@civisanalytics.com\",\n \"failure_email_addresses\": \"test2@civisanalytics.com\"\n }\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer 53G8ayfPnX1zFcvOWzJ3zM4ZsuGnGDZPCpQxKtVeIRA","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":201,"response_status_text":"Created","response_body":"{\n \"id\": 434,\n \"name\": \"My CASS enhancement\",\n \"type\": \"CASS-NCOA\",\n \"createdAt\": \"2024-12-03T19:43:13.000Z\",\n \"updatedAt\": \"2024-12-03T19:43:13.000Z\",\n \"author\": {\n \"id\": 407,\n \"name\": \"User devuserfactory328 328\",\n \"username\": \"devuserfactory328\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"state\": \"idle\",\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n },\n \"notifications\": {\n \"urls\": [\n\n ],\n \"successEmailSubject\": null,\n \"successEmailBody\": null,\n \"successEmailAddresses\": [\n \"test1@civisanalytics.com\"\n ],\n \"successEmailFromName\": null,\n \"successEmailReplyTo\": null,\n \"failureEmailAddresses\": [\n \"test2@civisanalytics.com\"\n ],\n \"stallWarningMinutes\": null,\n \"successOn\": true,\n \"failureOn\": true\n },\n \"runningAs\": {\n \"id\": 407,\n \"name\": \"User devuserfactory328 328\",\n \"username\": \"devuserfactory328\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"myPermissionLevel\": \"manage\",\n \"source\": {\n \"databaseTable\": {\n \"schema\": \"schema_name\",\n \"table\": \"table_name25\",\n \"remoteHostId\": 5,\n \"credentialId\": 76,\n \"multipartKey\": [\n \"primary_key\"\n ]\n }\n },\n \"destination\": {\n \"databaseTable\": {\n \"schema\": \"schema_name\",\n \"table\": \"table_name25_output\"\n }\n },\n \"columnMapping\": {\n \"address1\": \"address1\",\n \"address2\": null,\n \"city\": \"city\",\n \"state\": \"state\",\n \"zip\": \"zip\",\n \"name\": \"first_name+last_name\",\n \"company\": \"company\"\n },\n \"useDefaultColumnMapping\": true,\n \"performNcoa\": false,\n \"ncoaCredentialId\": null,\n \"outputLevel\": \"all\",\n \"limitingSQL\": null,\n \"batchSize\": 250000,\n \"archived\": false,\n \"parentId\": null\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"cf14ad3a6fe189b06d7946f20543c2bf\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"e6d2f96c-56af-4ccd-bfbc-9dcd1b1f08d3","X-Runtime":"0.171235","Content-Length":"1405"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/enhancements/cass-ncoa\" -d '{\"name\":\"My CASS enhancement\",\"source\":{\"database_table\":{\"remote_host_id\":5,\"schema\":\"schema_name\",\"table\":\"table_name25\",\"credential_id\":76}},\"notifications\":{\"success_email_addresses\":\"test1@civisanalytics.com\",\"failure_email_addresses\":\"test2@civisanalytics.com\"}}' -X POST \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer 53G8ayfPnX1zFcvOWzJ3zM4ZsuGnGDZPCpQxKtVeIRA\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Enhancements","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/enhancements/cass-ncoa","description":"Create a CASS/NCOA enhancement with custom mapping","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/enhancements/cass-ncoa","request_body":"{\n \"name\": \"My CASS enhancement\",\n \"source\": {\n \"database_table\": {\n \"remote_host_id\": 5,\n \"schema\": \"schema_name\",\n \"table\": \"table_name37\",\n \"credential_id\": 90\n }\n },\n \"use_default_column_mapping\": false,\n \"column_mapping\": {\n \"address1\": \"street_address\",\n \"city\": \"city\",\n \"state\": \"state\",\n \"zip\": \"postal_code\",\n \"name\": \"resident_name\"\n }\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer K11pNGx6Bvp1FBXU-TfFzilCmarbrhJtzw0eN3Ds-xo","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":201,"response_status_text":"Created","response_body":"{\n \"id\": 472,\n \"name\": \"My CASS enhancement\",\n \"type\": \"CASS-NCOA\",\n \"createdAt\": \"2024-12-03T19:43:17.000Z\",\n \"updatedAt\": \"2024-12-03T19:43:17.000Z\",\n \"author\": {\n \"id\": 455,\n \"name\": \"User devuserfactory359 359\",\n \"username\": \"devuserfactory359\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"state\": \"idle\",\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n },\n \"notifications\": {\n \"urls\": [\n\n ],\n \"successEmailSubject\": null,\n \"successEmailBody\": null,\n \"successEmailAddresses\": [\n\n ],\n \"successEmailFromName\": null,\n \"successEmailReplyTo\": null,\n \"failureEmailAddresses\": [\n\n ],\n \"stallWarningMinutes\": null,\n \"successOn\": true,\n \"failureOn\": true\n },\n \"runningAs\": {\n \"id\": 455,\n \"name\": \"User devuserfactory359 359\",\n \"username\": \"devuserfactory359\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"myPermissionLevel\": \"manage\",\n \"source\": {\n \"databaseTable\": {\n \"schema\": \"schema_name\",\n \"table\": \"table_name37\",\n \"remoteHostId\": 5,\n \"credentialId\": 90,\n \"multipartKey\": [\n \"primary_key\"\n ]\n }\n },\n \"destination\": {\n \"databaseTable\": {\n \"schema\": \"schema_name\",\n \"table\": \"table_name37_output\"\n }\n },\n \"columnMapping\": {\n \"address1\": \"street_address\",\n \"address2\": null,\n \"city\": \"city\",\n \"state\": \"state\",\n \"zip\": \"postal_code\",\n \"name\": \"resident_name\",\n \"company\": null\n },\n \"useDefaultColumnMapping\": false,\n \"performNcoa\": false,\n \"ncoaCredentialId\": null,\n \"outputLevel\": \"all\",\n \"limitingSQL\": null,\n \"batchSize\": 250000,\n \"archived\": false,\n \"parentId\": null\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"14d2c0caef08c21163a1a8d52168466a\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"c9ce5823-d9ae-4644-b56e-61b595788383","X-Runtime":"0.160715","Content-Length":"1356"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/enhancements/cass-ncoa\" -d '{\"name\":\"My CASS enhancement\",\"source\":{\"database_table\":{\"remote_host_id\":5,\"schema\":\"schema_name\",\"table\":\"table_name37\",\"credential_id\":90}},\"use_default_column_mapping\":false,\"column_mapping\":{\"address1\":\"street_address\",\"city\":\"city\",\"state\":\"state\",\"zip\":\"postal_code\",\"name\":\"resident_name\"}}' -X POST \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer K11pNGx6Bvp1FBXU-TfFzilCmarbrhJtzw0eN3Ds-xo\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/enhancements/cass-ncoa/{id}":{"get":{"summary":"Get a CASS/NCOA Enhancement","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object164"}}},"x-examples":[{"resource":"Enhancements","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/enhancements/cass-ncoa/:cass_id","description":"View a CASS/NCOA enhancement's details","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/enhancements/cass-ncoa/210","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer kA1hYCC9xWFgQnP-VItnRm_Tje5RXh-lI2giviazLLo","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 210,\n \"name\": \"CASS/NCOA #210\",\n \"type\": \"CASS-NCOA\",\n \"createdAt\": \"2024-12-03T19:42:56.000Z\",\n \"updatedAt\": \"2024-12-03T19:37:56.000Z\",\n \"author\": {\n \"id\": 219,\n \"name\": \"User devuserfactory172 172\",\n \"username\": \"devuserfactory172\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"state\": \"idle\",\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n },\n \"notifications\": {\n \"urls\": [\n\n ],\n \"successEmailSubject\": null,\n \"successEmailBody\": null,\n \"successEmailAddresses\": [\n\n ],\n \"successEmailFromName\": null,\n \"successEmailReplyTo\": null,\n \"failureEmailAddresses\": [\n\n ],\n \"stallWarningMinutes\": null,\n \"successOn\": true,\n \"failureOn\": true\n },\n \"runningAs\": {\n \"id\": 219,\n \"name\": \"User devuserfactory172 172\",\n \"username\": \"devuserfactory172\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"myPermissionLevel\": \"manage\",\n \"source\": {\n \"databaseTable\": {\n \"schema\": \"schema_name\",\n \"table\": \"table_name18\",\n \"remoteHostId\": 5,\n \"credentialId\": 57,\n \"multipartKey\": [\n \"id\",\n \"another_id\"\n ]\n }\n },\n \"destination\": {\n \"databaseTable\": {\n \"schema\": \"my_schema\",\n \"table\": \"my_table\"\n }\n },\n \"columnMapping\": {\n \"address1\": \"address1\",\n \"address2\": \"address2\",\n \"city\": \"city\",\n \"state\": \"state\",\n \"zip\": \"zip\",\n \"name\": \"first_name + last_name\",\n \"company\": null\n },\n \"useDefaultColumnMapping\": false,\n \"performNcoa\": false,\n \"ncoaCredentialId\": 58,\n \"outputLevel\": \"all\",\n \"limitingSQL\": null,\n \"batchSize\": 250000,\n \"archived\": false,\n \"parentId\": null\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"ce5caef5b9691e9440022980332d8800\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"ef239388-9a69-48f3-b01f-e6fb50204f03","X-Runtime":"0.051531","Content-Length":"1341"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/enhancements/cass-ncoa/210\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer kA1hYCC9xWFgQnP-VItnRm_Tje5RXh-lI2giviazLLo\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"put":{"summary":"Replace all attributes of this CASS/NCOA Enhancement","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID for the enhancement.","type":"integer"},{"name":"Object170","in":"body","schema":{"$ref":"#/definitions/Object170"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object164"}}},"x-examples":[{"resource":"Enhancements","resource_explanation":null,"http_method":"PUT","route":"http://api.civis.test/enhancements/cass-ncoa/:cass_id","description":"Update a CASS/NCOA enhancement via PUT","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"PUT","request_path":"http://api.civis.test/enhancements/cass-ncoa/699","request_body":"{\n \"name\": \"standardize my addresses\",\n \"source\": {\n \"database_table\": {\n \"remote_host_id\": 5,\n \"schema\": \"schema_name\",\n \"table\": \"table_name77\",\n \"credential_id\": 144,\n \"multipart_key\": [\n \"primary key\"\n ]\n }\n },\n \"destination\": {\n \"database_table\": {\n \"schema\": \"schema_name\",\n \"table\": \"table_name77_output\"\n }\n },\n \"limiting_sql\": \"where id < 200\"\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer nHs1J4tqDbcyy5kmERaFzh-E3agO2xmgvLdzSFzLXoU","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 699,\n \"name\": \"standardize my addresses\",\n \"type\": \"CASS-NCOA\",\n \"createdAt\": \"2024-12-03T19:43:36.000Z\",\n \"updatedAt\": \"2024-12-03T19:43:39.000Z\",\n \"author\": {\n \"id\": 747,\n \"name\": \"User devuserfactory576 576\",\n \"username\": \"devuserfactory576\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"state\": \"idle\",\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n },\n \"notifications\": {\n \"urls\": [\n\n ],\n \"successEmailSubject\": null,\n \"successEmailBody\": null,\n \"successEmailAddresses\": [\n\n ],\n \"successEmailFromName\": null,\n \"successEmailReplyTo\": null,\n \"failureEmailAddresses\": [\n\n ],\n \"stallWarningMinutes\": null,\n \"successOn\": true,\n \"failureOn\": true\n },\n \"runningAs\": {\n \"id\": 747,\n \"name\": \"User devuserfactory576 576\",\n \"username\": \"devuserfactory576\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"myPermissionLevel\": \"manage\",\n \"source\": {\n \"databaseTable\": {\n \"schema\": \"schema_name\",\n \"table\": \"table_name77\",\n \"remoteHostId\": 5,\n \"credentialId\": 144,\n \"multipartKey\": [\n \"primary_key\"\n ]\n }\n },\n \"destination\": {\n \"databaseTable\": {\n \"schema\": \"schema_name\",\n \"table\": \"table_name77_output\"\n }\n },\n \"columnMapping\": {\n \"address1\": \"address1\",\n \"address2\": null,\n \"city\": \"city\",\n \"state\": \"state\",\n \"zip\": \"zip\",\n \"name\": \"first_name+last_name\",\n \"company\": \"company\"\n },\n \"useDefaultColumnMapping\": true,\n \"performNcoa\": false,\n \"ncoaCredentialId\": null,\n \"outputLevel\": \"all\",\n \"limitingSQL\": \"where id < 200\",\n \"batchSize\": 250000,\n \"archived\": false,\n \"parentId\": null\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"c3956a5d7a569aa88d01f800c14dedb4\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"02b58a26-965f-4bc8-81db-1badded8399a","X-Runtime":"0.212420","Content-Length":"1376"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/enhancements/cass-ncoa/699\" -d '{\"name\":\"standardize my addresses\",\"source\":{\"database_table\":{\"remote_host_id\":5,\"schema\":\"schema_name\",\"table\":\"table_name77\",\"credential_id\":144,\"multipart_key\":[\"primary key\"]}},\"destination\":{\"database_table\":{\"schema\":\"schema_name\",\"table\":\"table_name77_output\"}},\"limiting_sql\":\"where id \\u003c 200\"}' -X PUT \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer nHs1J4tqDbcyy5kmERaFzh-E3agO2xmgvLdzSFzLXoU\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"patch":{"summary":"Update some attributes of this CASS/NCOA Enhancement","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID for the enhancement.","type":"integer"},{"name":"Object171","in":"body","schema":{"$ref":"#/definitions/Object171"},"required":false}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object164"}}},"x-examples":[{"resource":"Enhancements","resource_explanation":null,"http_method":"PATCH","route":"http://api.civis.test/enhancements/cass-ncoa/:cass_id","description":"Update a CASS/NCOA enhancement via PATCH","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"PATCH","request_path":"http://api.civis.test/enhancements/cass-ncoa/625","request_body":"{\n \"name\": \"Clean Addresses\",\n \"output_level\": \"cass\",\n \"limiting_sql\": \"where id < 300\",\n \"schedule\": {\n \"scheduled\": true,\n \"scheduledDays\": [\n 3\n ],\n \"scheduledHours\": [\n 4,\n 8\n ],\n \"scheduledMinutes\": [\n 30\n ],\n \"scheduledRunsPerHour\": null\n }\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer Fdya1EgPcBdaIUBtxM-gdkMZ9Cif_iZ88-tURR7uIfU","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 625,\n \"name\": \"Clean Addresses\",\n \"type\": \"CASS-NCOA\",\n \"createdAt\": \"2024-12-03T19:43:28.000Z\",\n \"updatedAt\": \"2024-12-03T19:43:31.000Z\",\n \"author\": {\n \"id\": 651,\n \"name\": \"User devuserfactory514 514\",\n \"username\": \"devuserfactory514\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"state\": \"scheduled\",\n \"schedule\": {\n \"scheduled\": true,\n \"scheduledDays\": [\n 3\n ],\n \"scheduledHours\": [\n 4,\n 8\n ],\n \"scheduledMinutes\": [\n 30\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n },\n \"notifications\": {\n \"urls\": [\n\n ],\n \"successEmailSubject\": null,\n \"successEmailBody\": null,\n \"successEmailAddresses\": [\n\n ],\n \"successEmailFromName\": null,\n \"successEmailReplyTo\": null,\n \"failureEmailAddresses\": [\n\n ],\n \"stallWarningMinutes\": null,\n \"successOn\": true,\n \"failureOn\": true\n },\n \"runningAs\": {\n \"id\": 651,\n \"name\": \"User devuserfactory514 514\",\n \"username\": \"devuserfactory514\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"myPermissionLevel\": \"manage\",\n \"source\": {\n \"databaseTable\": {\n \"schema\": \"schema_name\",\n \"table\": \"table_name53\",\n \"remoteHostId\": 5,\n \"credentialId\": 116,\n \"multipartKey\": [\n \"id\",\n \"another_id\"\n ]\n }\n },\n \"destination\": {\n \"databaseTable\": {\n \"schema\": \"my_schema\",\n \"table\": \"my_table\"\n }\n },\n \"columnMapping\": {\n \"address1\": \"address1\",\n \"address2\": \"address2\",\n \"city\": \"city\",\n \"state\": \"state\",\n \"zip\": \"zip\",\n \"name\": \"first_name + last_name\",\n \"company\": null\n },\n \"useDefaultColumnMapping\": false,\n \"performNcoa\": false,\n \"ncoaCredentialId\": 117,\n \"outputLevel\": \"cass\",\n \"limitingSQL\": \"where id < 300\",\n \"batchSize\": 250000,\n \"archived\": false,\n \"parentId\": null\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"bfbfa01074f249a690be984b89ebb87c\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"da0908db-74c0-44cd-bb2d-b33521a0014d","X-Runtime":"0.194891","Content-Length":"1373"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/enhancements/cass-ncoa/625\" -d '{\"name\":\"Clean Addresses\",\"output_level\":\"cass\",\"limiting_sql\":\"where id \\u003c 300\",\"schedule\":{\"scheduled\":true,\"scheduledDays\":[3],\"scheduledHours\":[4,8],\"scheduledMinutes\":[30],\"scheduledRunsPerHour\":null}}' -X PATCH \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer Fdya1EgPcBdaIUBtxM-gdkMZ9Cif_iZ88-tURR7uIfU\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Enhancements","resource_explanation":null,"http_method":"PATCH","route":"http://api.civis.test/enhancements/cass-ncoa/:cass_id","description":"Update the column mapping of a CASS/NCOA enhancement via PATCH","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"PATCH","request_path":"http://api.civis.test/enhancements/cass-ncoa/662","request_body":"{\n \"use_default_column_mapping\": false,\n \"column_mapping\": {\n \"address1\": \"street_address\",\n \"city\": \"city\",\n \"state\": \"state\",\n \"zip\": \"postal_code\"\n }\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer l6mfY_xIEJUOZycGaET8MD6Ms491UKwUCM1uNcrKpM8","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 662,\n \"name\": \"CASS/NCOA #662\",\n \"type\": \"CASS-NCOA\",\n \"createdAt\": \"2024-12-03T19:43:32.000Z\",\n \"updatedAt\": \"2024-12-03T19:43:36.000Z\",\n \"author\": {\n \"id\": 699,\n \"name\": \"User devuserfactory545 545\",\n \"username\": \"devuserfactory545\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"state\": \"idle\",\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n },\n \"notifications\": {\n \"urls\": [\n\n ],\n \"successEmailSubject\": null,\n \"successEmailBody\": null,\n \"successEmailAddresses\": [\n\n ],\n \"successEmailFromName\": null,\n \"successEmailReplyTo\": null,\n \"failureEmailAddresses\": [\n\n ],\n \"stallWarningMinutes\": null,\n \"successOn\": true,\n \"failureOn\": true\n },\n \"runningAs\": {\n \"id\": 699,\n \"name\": \"User devuserfactory545 545\",\n \"username\": \"devuserfactory545\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"myPermissionLevel\": \"manage\",\n \"source\": {\n \"databaseTable\": {\n \"schema\": \"schema_name\",\n \"table\": \"table_name65\",\n \"remoteHostId\": 5,\n \"credentialId\": 130,\n \"multipartKey\": [\n \"id\",\n \"another_id\"\n ]\n }\n },\n \"destination\": {\n \"databaseTable\": {\n \"schema\": \"my_schema\",\n \"table\": \"my_table\"\n }\n },\n \"columnMapping\": {\n \"address1\": \"street_address\",\n \"address2\": null,\n \"city\": \"city\",\n \"state\": \"state\",\n \"zip\": \"postal_code\",\n \"name\": null,\n \"company\": null\n },\n \"useDefaultColumnMapping\": false,\n \"performNcoa\": false,\n \"ncoaCredentialId\": 131,\n \"outputLevel\": \"all\",\n \"limitingSQL\": null,\n \"batchSize\": 250000,\n \"archived\": false,\n \"parentId\": null\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"81b8a8e74d456cc5620aca69938249e1\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"8b818438-fdef-457d-9971-f2eb2dc9807f","X-Runtime":"0.160451","Content-Length":"1331"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/enhancements/cass-ncoa/662\" -d '{\"use_default_column_mapping\":false,\"column_mapping\":{\"address1\":\"street_address\",\"city\":\"city\",\"state\":\"state\",\"zip\":\"postal_code\"}}' -X PATCH \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer l6mfY_xIEJUOZycGaET8MD6Ms491UKwUCM1uNcrKpM8\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/enhancements/cass-ncoa/{id}/runs":{"post":{"summary":"Start a run","description":"Start a run and provide a URI for checking its status. The response will provide a 'Location' header which will contain a URI which may be polled to monitor the status of the run.","deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the CASS NCOA job.","type":"integer"}],"responses":{"202":{"description":"success","schema":{"$ref":"#/definitions/Object172"}}},"x-examples":[{"resource":"Enhancements","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/enhancements/cass-ncoa/:cass_ncoa_to_run_id/runs","description":"Create a CASS/NCOA run","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/enhancements/cass-ncoa/999/runs","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer fsB9hYQjujK53F31Mnw4kl__Tl6R1wnByL3ICLQMquA","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":202,"response_status_text":"Accepted","response_body":"{\n \"id\": 79,\n \"cassNcoaId\": 999,\n \"state\": \"queued\",\n \"isCancelRequested\": false,\n \"createdAt\": \"2024-12-03T19:43:59.000Z\",\n \"startedAt\": null,\n \"finishedAt\": null,\n \"error\": null\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Location":"http://api.civis.test/enhancements/cass-ncoa/999/runs/79","Content-Type":"application/json; charset=utf-8","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"f6141331-37cf-46c2-920c-ddd70c151626","X-Runtime":"0.160939","Content-Length":"156"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/enhancements/cass-ncoa/999/runs\" -d '' -X POST \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer fsB9hYQjujK53F31Mnw4kl__Tl6R1wnByL3ICLQMquA\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"get":{"summary":"List runs for the given CASS NCOA job","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the CASS NCOA job.","type":"integer"},{"name":"limit","in":"query","required":false,"description":"Number of results to return. Defaults to 20. Maximum allowed is 100.","type":"integer"},{"name":"page_num","in":"query","required":false,"description":"Page number of the results to return. Defaults to the first page, 1.","type":"integer"},{"name":"order","in":"query","required":false,"description":"The field on which to order the result set. Defaults to id. Must be one of: id.","type":"string"},{"name":"order_dir","in":"query","required":false,"description":"Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc.","type":"string"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object172"}}}},"x-examples":null,"x-deprecation-warning":null}},"/enhancements/cass-ncoa/{id}/runs/{run_id}":{"get":{"summary":"Check status of a run","description":"View the status of a run. This endpoint may be polled to monitor the status of the run. When the 'state' field is no longer 'queued' or 'running' the run has reached its final state.","deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the CASS NCOA job.","type":"integer"},{"name":"run_id","in":"path","required":true,"description":"The ID of the run.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object172"}}},"x-examples":[{"resource":"Enhancements","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/enhancements/cass-ncoa/:cass_id/runs/:cass_run_id","description":"View a CASS/NCOA enhancement's run details","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/enhancements/cass-ncoa/1000/runs/83","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer txrRIZ5b8db8GiI3vsyPoIkbujTaK61r2K1Kkp8TY3U","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 83,\n \"cassNcoaId\": 1000,\n \"state\": \"running\",\n \"isCancelRequested\": false,\n \"createdAt\": \"2024-12-03T19:44:03.000Z\",\n \"startedAt\": null,\n \"finishedAt\": \"2024-12-03T19:39:03.000Z\",\n \"error\": null\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"9f120e487823eca5ca12c774b75e9a77\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"a4488959-0c25-4552-9a89-5eab6c2993aa","X-Runtime":"0.050748","Content-Length":"180"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/enhancements/cass-ncoa/1000/runs/83\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer txrRIZ5b8db8GiI3vsyPoIkbujTaK61r2K1Kkp8TY3U\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"delete":{"summary":"Cancel a run","description":"Cancel a currently active run.","deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the CASS NCOA job.","type":"integer"},{"name":"run_id","in":"path","required":true,"description":"The ID of the run.","type":"integer"}],"responses":{"202":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/enhancements/cass-ncoa/{id}/runs/{run_id}/logs":{"get":{"summary":"Get the logs for a run","description":"Get the logs for a run.","deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the CASS NCOA job.","type":"integer"},{"name":"run_id","in":"path","required":true,"description":"The ID of the run.","type":"integer"},{"name":"last_id","in":"query","required":false,"description":"The ID of the last log message received. Log entries with this ID value or lower will be omitted.Logs are sorted by ID if this value is provided, and are otherwise sorted by createdAt.","type":"integer"},{"name":"limit","in":"query","required":false,"description":"The maximum number of log messages to return. Default of 10000.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object117"}}}},"x-examples":null,"x-deprecation-warning":null}},"/enhancements/cass-ncoa/{id}/cancel":{"post":{"summary":"Cancel a run","description":"Cancel a run.","deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the job.","type":"integer"}],"responses":{"202":{"description":"success","schema":{"$ref":"#/definitions/Object173"}}},"x-examples":null,"x-deprecation-warning":null}},"/enhancements/cass-ncoa/{id}/runs/{run_id}/outputs":{"get":{"summary":"List the outputs for a run","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the job.","type":"integer"},{"name":"run_id","in":"path","required":true,"description":"The ID of the run.","type":"integer"},{"name":"limit","in":"query","required":false,"description":"Number of results to return. Defaults to its maximum of 50.","type":"integer"},{"name":"page_num","in":"query","required":false,"description":"Page number of the results to return. Defaults to the first page, 1.","type":"integer"},{"name":"order","in":"query","required":false,"description":"The field on which to order the result set. Defaults to created_at. Must be one of: created_at, id.","type":"string"},{"name":"order_dir","in":"query","required":false,"description":"Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc.","type":"string"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object174"}}}},"x-examples":[{"resource":"Enhancements","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/enhancements/cass-ncoa/:job_with_run_id/runs/:job_run_id/outputs","description":"View a CASS/NCOA Enhancement's outputs","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/enhancements/cass-ncoa/1074/runs/87/outputs","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer UPBEsqQvI477lK-x_bmfKYP2vbD1EjD6huz_7bnnszY","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"objectType\": \"File\",\n \"objectId\": 2,\n \"name\": \"my output file\",\n \"link\": \"api.civis.test/files/2\",\n \"value\": null\n },\n {\n \"objectType\": \"Report\",\n \"objectId\": 1,\n \"name\": \"my output report\",\n \"link\": \"api.civis.test/reports/1\",\n \"value\": null\n },\n {\n \"objectType\": \"Report\",\n \"objectId\": 2,\n \"name\": \"my output tableau report\",\n \"link\": \"api.civis.test/reports/2\",\n \"value\": null\n },\n {\n \"objectType\": \"Table\",\n \"objectId\": 97,\n \"name\": \"output.table\",\n \"link\": \"api.civis.test/tables/97\",\n \"value\": null\n },\n {\n \"objectType\": \"Project\",\n \"objectId\": 1,\n \"name\": \"my output project\",\n \"link\": \"api.civis.test/projects/1\",\n \"value\": null\n },\n {\n \"objectType\": \"Credential\",\n \"objectId\": 203,\n \"name\": \"my output credential\",\n \"link\": \"api.civis.test/credentials/203\",\n \"value\": null\n },\n {\n \"objectType\": \"JSONValue\",\n \"objectId\": 1,\n \"name\": \"my awesome JSON value\",\n \"link\": \"api.civis.test/json_values/1\",\n \"value\": {\n \"foo\": \"bar\"\n }\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","X-Pagination-Per-Page":"50","Access-Control-Expose-Headers":"X-Pagination-Per-Page, X-Pagination-Current-Page, X-Pagination-Total-Pages, X-Pagination-Total-Entries","X-Pagination-Current-Page":"1","X-Pagination-Total-Pages":"1","X-Pagination-Total-Entries":"7","Content-Type":"application/json; charset=utf-8","ETag":"W/\"9ebfeccd30f12016061f0f3bb4e4f181\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"79e79167-c0c0-474a-b4bc-be16ee02839d","X-Runtime":"0.073063","Content-Length":"809"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/enhancements/cass-ncoa/1074/runs/87/outputs\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer UPBEsqQvI477lK-x_bmfKYP2vbD1EjD6huz_7bnnszY\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/enhancements/geocode":{"post":{"summary":"Create a Geocode Enhancement","description":null,"deprecated":false,"parameters":[{"name":"Object175","in":"body","schema":{"$ref":"#/definitions/Object175"},"required":true}],"responses":{"201":{"description":"success","schema":{"$ref":"#/definitions/Object176"}}},"x-examples":[{"resource":"Enhancements","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/enhancements/geocode","description":"Create a geocode enhancement","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/enhancements/geocode","request_body":"{\n \"name\": \"Geocoderific\",\n \"remoteHostId\": 5,\n \"credentialId\": 104,\n \"sourceSchemaAndTable\": \"schema_name.table_name49\",\n \"country\": \"us\",\n \"multipartKey\": \"MyString\"\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer 8xGc_GQWOziUEtFoYYnA5zZE42xEaSXDicpIy-7mwwQ","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":201,"response_status_text":"Created","response_body":"{\n \"id\": 510,\n \"name\": \"Geocoderific\",\n \"type\": \"Geocode\",\n \"createdAt\": \"2024-12-03T19:43:20.000Z\",\n \"updatedAt\": \"2024-12-03T19:43:20.000Z\",\n \"author\": {\n \"id\": 503,\n \"name\": \"User devuserfactory390 390\",\n \"username\": \"devuserfactory390\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"state\": \"idle\",\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n },\n \"notifications\": {\n \"urls\": [\n\n ],\n \"successEmailSubject\": null,\n \"successEmailBody\": null,\n \"successEmailAddresses\": [\n\n ],\n \"successEmailFromName\": null,\n \"successEmailReplyTo\": null,\n \"failureEmailAddresses\": [\n\n ],\n \"stallWarningMinutes\": null,\n \"successOn\": true,\n \"failureOn\": true\n },\n \"runningAs\": {\n \"id\": 503,\n \"name\": \"User devuserfactory390 390\",\n \"username\": \"devuserfactory390\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"myPermissionLevel\": \"manage\",\n \"remoteHostId\": 5,\n \"credentialId\": 104,\n \"sourceSchemaAndTable\": \"schema_name.table_name49\",\n \"multipartKey\": [\n \"MyString\"\n ],\n \"limitingSQL\": null,\n \"targetSchema\": null,\n \"targetTable\": null,\n \"country\": \"us\",\n \"provider\": null,\n \"outputAddress\": null,\n \"archived\": false,\n \"parentId\": null\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"929d7060fbd3ef7b09c79ad0b79b743c\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"0f59d5f4-3191-47da-9514-44404cb327f3","X-Runtime":"0.134683","Content-Length":"1059"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/enhancements/geocode\" -d '{\"name\":\"Geocoderific\",\"remoteHostId\":5,\"credentialId\":104,\"sourceSchemaAndTable\":\"schema_name.table_name49\",\"country\":\"us\",\"multipartKey\":\"MyString\"}' -X POST \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer 8xGc_GQWOziUEtFoYYnA5zZE42xEaSXDicpIy-7mwwQ\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/enhancements/geocode/{id}":{"get":{"summary":"Get a Geocode Enhancement","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object176"}}},"x-examples":[{"resource":"Enhancements","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/enhancements/geocode/:geocode_id","description":"View a Geocode enhancement's details","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/enhancements/geocode/285","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer r70DRHM04NGfPLENsiNmJ0JfljS6RwwHL2c-PsRxqEI","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 285,\n \"name\": \"Geocode #285\",\n \"type\": \"Geocode\",\n \"createdAt\": \"2024-12-03T19:43:01.000Z\",\n \"updatedAt\": \"2024-12-03T19:41:01.000Z\",\n \"author\": {\n \"id\": 256,\n \"name\": \"User devuserfactory203 203\",\n \"username\": \"devuserfactory203\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"state\": \"idle\",\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n },\n \"notifications\": {\n \"urls\": [\n\n ],\n \"successEmailSubject\": null,\n \"successEmailBody\": null,\n \"successEmailAddresses\": [\n\n ],\n \"successEmailFromName\": null,\n \"successEmailReplyTo\": null,\n \"failureEmailAddresses\": [\n\n ],\n \"stallWarningMinutes\": null,\n \"successOn\": true,\n \"failureOn\": true\n },\n \"runningAs\": {\n \"id\": 256,\n \"name\": \"User devuserfactory203 203\",\n \"username\": \"devuserfactory203\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"myPermissionLevel\": \"manage\",\n \"remoteHostId\": 32,\n \"credentialId\": 63,\n \"sourceSchemaAndTable\": \"schema_name.table_name21\",\n \"multipartKey\": [\n \"id\",\n \"another_id\"\n ],\n \"limitingSQL\": null,\n \"targetSchema\": \"\",\n \"targetTable\": \"\",\n \"country\": \"us\",\n \"provider\": null,\n \"outputAddress\": false,\n \"archived\": false,\n \"parentId\": null\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"1773b94adb3919f27df26362ee30e5a3\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"14b767a6-6a91-46d5-8dbe-e6e28b4e325e","X-Runtime":"0.045015","Content-Length":"1063"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/enhancements/geocode/285\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer r70DRHM04NGfPLENsiNmJ0JfljS6RwwHL2c-PsRxqEI\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"put":{"summary":"Replace all attributes of this Geocode Enhancement","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID for the enhancement.","type":"integer"},{"name":"Object177","in":"body","schema":{"$ref":"#/definitions/Object177"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object176"}}},"x-examples":null,"x-deprecation-warning":null},"patch":{"summary":"Update some attributes of this Geocode Enhancement","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID for the enhancement.","type":"integer"},{"name":"Object178","in":"body","schema":{"$ref":"#/definitions/Object178"},"required":false}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object176"}}},"x-examples":[{"resource":"Enhancements","resource_explanation":null,"http_method":"PATCH","route":"http://api.civis.test/enhancements/geocode/:geocode_id","description":"Update a Geocode enhancement via PATCH","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"PATCH","request_path":"http://api.civis.test/enhancements/geocode/774","request_body":"{\n \"name\": \"Zeno's endless geocoding job\",\n \"country\": \"ca\",\n \"multipartKey\": [\n \"MyString\"\n ],\n \"limiting_sql\": \"WHERE distance_travelled = 0\",\n \"targetSchema\": \"bow\",\n \"targetTable\": \"arrow\",\n \"outputAddress\": true\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer 2kd5BnYwXsQgEJZu1fo2BhWD0Q0uj3Vl-tavKonHt0c","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 774,\n \"name\": \"Zeno's endless geocoding job\",\n \"type\": \"Geocode\",\n \"createdAt\": \"2024-12-03T19:43:42.000Z\",\n \"updatedAt\": \"2024-12-03T19:43:42.000Z\",\n \"author\": {\n \"id\": 795,\n \"name\": \"User devuserfactory607 607\",\n \"username\": \"devuserfactory607\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"state\": \"idle\",\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n },\n \"notifications\": {\n \"urls\": [\n\n ],\n \"successEmailSubject\": null,\n \"successEmailBody\": null,\n \"successEmailAddresses\": [\n\n ],\n \"successEmailFromName\": null,\n \"successEmailReplyTo\": null,\n \"failureEmailAddresses\": [\n\n ],\n \"stallWarningMinutes\": null,\n \"successOn\": true,\n \"failureOn\": true\n },\n \"runningAs\": {\n \"id\": 795,\n \"name\": \"User devuserfactory607 607\",\n \"username\": \"devuserfactory607\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"myPermissionLevel\": \"manage\",\n \"remoteHostId\": 90,\n \"credentialId\": 161,\n \"sourceSchemaAndTable\": \"schema_name.table_name91\",\n \"multipartKey\": [\n \"MyString\"\n ],\n \"limitingSQL\": \"WHERE distance_travelled = 0\",\n \"targetSchema\": \"bow\",\n \"targetTable\": \"arrow\",\n \"country\": \"ca\",\n \"provider\": null,\n \"outputAddress\": true,\n \"archived\": false,\n \"parentId\": null\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"f3d5439a04d06087eb298a2009a95e08\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"96dd33b6-1e12-423f-b991-e6a0a3dd894a","X-Runtime":"0.119309","Content-Length":"1106"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/enhancements/geocode/774\" -d '{\"name\":\"Zeno\\u0027s endless geocoding job\",\"country\":\"ca\",\"multipartKey\":[\"MyString\"],\"limiting_sql\":\"WHERE distance_travelled = 0\",\"targetSchema\":\"bow\",\"targetTable\":\"arrow\",\"outputAddress\":true}' -X PATCH \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer 2kd5BnYwXsQgEJZu1fo2BhWD0Q0uj3Vl-tavKonHt0c\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Enhancements","resource_explanation":null,"http_method":"PATCH","route":"http://api.civis.test/enhancements/geocode/:geocode_id","description":"Update a Geocode enhancement via PUT","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"PATCH","request_path":"http://api.civis.test/enhancements/geocode/813","request_body":"{\n \"name\": \"Zebracoder\",\n \"remoteHostId\": 5,\n \"credentialId\": 165,\n \"sourceSchemaAndTable\": \"schema_name.table_name92\",\n \"country\": \"ca\",\n \"multipartKey\": [\n \"MyString\"\n ],\n \"limiting_sql\": \"where id < 200\",\n \"targetSchema\": \"human\",\n \"targetTable\": \"friendship\",\n \"outputAddress\": true\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer I3ZAOcw5rMF1gUp-i7Z24lmmxcV7cRcXq01CBoGgzSI","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 813,\n \"name\": \"Zebracoder\",\n \"type\": \"Geocode\",\n \"createdAt\": \"2024-12-03T19:43:45.000Z\",\n \"updatedAt\": \"2024-12-03T19:43:45.000Z\",\n \"author\": {\n \"id\": 835,\n \"name\": \"User devuserfactory639 639\",\n \"username\": \"devuserfactory639\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"state\": \"idle\",\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n },\n \"notifications\": {\n \"urls\": [\n\n ],\n \"successEmailSubject\": null,\n \"successEmailBody\": null,\n \"successEmailAddresses\": [\n\n ],\n \"successEmailFromName\": null,\n \"successEmailReplyTo\": null,\n \"failureEmailAddresses\": [\n\n ],\n \"stallWarningMinutes\": null,\n \"successOn\": true,\n \"failureOn\": true\n },\n \"runningAs\": {\n \"id\": 835,\n \"name\": \"User devuserfactory639 639\",\n \"username\": \"devuserfactory639\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"myPermissionLevel\": \"manage\",\n \"remoteHostId\": 5,\n \"credentialId\": 165,\n \"sourceSchemaAndTable\": \"schema_name.table_name92\",\n \"multipartKey\": [\n \"MyString\"\n ],\n \"limitingSQL\": \"where id < 200\",\n \"targetSchema\": \"human\",\n \"targetTable\": \"friendship\",\n \"country\": \"ca\",\n \"provider\": null,\n \"outputAddress\": true,\n \"archived\": false,\n \"parentId\": null\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"a0f7c24f06e9d310f803458e6e59a43a\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"96bf1352-4b2a-495b-842a-6f72080c71e1","X-Runtime":"0.224569","Content-Length":"1085"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/enhancements/geocode/813\" -d '{\"name\":\"Zebracoder\",\"remoteHostId\":5,\"credentialId\":165,\"sourceSchemaAndTable\":\"schema_name.table_name92\",\"country\":\"ca\",\"multipartKey\":[\"MyString\"],\"limiting_sql\":\"where id \\u003c 200\",\"targetSchema\":\"human\",\"targetTable\":\"friendship\",\"outputAddress\":true}' -X PATCH \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer I3ZAOcw5rMF1gUp-i7Z24lmmxcV7cRcXq01CBoGgzSI\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/enhancements/geocode/{id}/runs":{"post":{"summary":"Start a run","description":"Start a run and provide a URI for checking its status. The response will provide a 'Location' header which will contain a URI which may be polled to monitor the status of the run.","deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Geocode job.","type":"integer"}],"responses":{"202":{"description":"success","schema":{"$ref":"#/definitions/Object179"}}},"x-examples":[{"resource":"Enhancements","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/enhancements/geocode/:geocode_to_run_id/runs","description":"Create a Geocode run","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/enhancements/geocode/1115/runs","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer DyfbyKxoNHJuLxckAWWkMlClnQ9cnisqa9mkXZcN64c","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":202,"response_status_text":"Accepted","response_body":"{\n \"id\": 91,\n \"geocodeId\": 1115,\n \"state\": \"queued\",\n \"isCancelRequested\": false,\n \"createdAt\": \"2024-12-03T19:44:09.000Z\",\n \"startedAt\": null,\n \"finishedAt\": null,\n \"error\": null\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Location":"http://api.civis.test/enhancements/geocode/1115/runs/91","Content-Type":"application/json; charset=utf-8","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"11c72b75-a0f6-4b18-8317-97cedfc15a7e","X-Runtime":"0.148813","Content-Length":"156"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/enhancements/geocode/1115/runs\" -d '' -X POST \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer DyfbyKxoNHJuLxckAWWkMlClnQ9cnisqa9mkXZcN64c\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"get":{"summary":"List runs for the given Geocode job","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Geocode job.","type":"integer"},{"name":"limit","in":"query","required":false,"description":"Number of results to return. Defaults to 20. Maximum allowed is 100.","type":"integer"},{"name":"page_num","in":"query","required":false,"description":"Page number of the results to return. Defaults to the first page, 1.","type":"integer"},{"name":"order","in":"query","required":false,"description":"The field on which to order the result set. Defaults to id. Must be one of: id.","type":"string"},{"name":"order_dir","in":"query","required":false,"description":"Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc.","type":"string"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object179"}}}},"x-examples":null,"x-deprecation-warning":null}},"/enhancements/geocode/{id}/runs/{run_id}":{"get":{"summary":"Check status of a run","description":"View the status of a run. This endpoint may be polled to monitor the status of the run. When the 'state' field is no longer 'queued' or 'running' the run has reached its final state.","deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Geocode job.","type":"integer"},{"name":"run_id","in":"path","required":true,"description":"The ID of the run.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object179"}}},"x-examples":[{"resource":"Enhancements","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/enhancements/geocode/:geocode_id/runs/:geocode_run_id","description":"View a Geocode enhancement's run details","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/enhancements/geocode/1154/runs/95","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer JdKKHxx-_unVidrmTzXXwhAu31S5GR-1DCNnLsRo2cc","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 95,\n \"geocodeId\": 1154,\n \"state\": \"running\",\n \"isCancelRequested\": false,\n \"createdAt\": \"2024-12-03T19:44:12.000Z\",\n \"startedAt\": null,\n \"finishedAt\": \"2024-12-03T19:42:12.000Z\",\n \"error\": null\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"758da940788d7d4683611cab6f93fbf4\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"7ad1d5c3-df64-4b7b-aca2-c6ba34be9072","X-Runtime":"0.031477","Content-Length":"179"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/enhancements/geocode/1154/runs/95\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer JdKKHxx-_unVidrmTzXXwhAu31S5GR-1DCNnLsRo2cc\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"delete":{"summary":"Cancel a run","description":"Cancel a currently active run.","deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Geocode job.","type":"integer"},{"name":"run_id","in":"path","required":true,"description":"The ID of the run.","type":"integer"}],"responses":{"202":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/enhancements/geocode/{id}/runs/{run_id}/logs":{"get":{"summary":"Get the logs for a run","description":"Get the logs for a run.","deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Geocode job.","type":"integer"},{"name":"run_id","in":"path","required":true,"description":"The ID of the run.","type":"integer"},{"name":"last_id","in":"query","required":false,"description":"The ID of the last log message received. Log entries with this ID value or lower will be omitted.Logs are sorted by ID if this value is provided, and are otherwise sorted by createdAt.","type":"integer"},{"name":"limit","in":"query","required":false,"description":"The maximum number of log messages to return. Default of 10000.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object117"}}}},"x-examples":null,"x-deprecation-warning":null}},"/enhancements/geocode/{id}/cancel":{"post":{"summary":"Cancel a run","description":"Cancel a run.","deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the job.","type":"integer"}],"responses":{"202":{"description":"success","schema":{"$ref":"#/definitions/Object180"}}},"x-examples":null,"x-deprecation-warning":null}},"/enhancements/geocode/{id}/runs/{run_id}/outputs":{"get":{"summary":"List the outputs for a run","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the job.","type":"integer"},{"name":"run_id","in":"path","required":true,"description":"The ID of the run.","type":"integer"},{"name":"limit","in":"query","required":false,"description":"Number of results to return. Defaults to its maximum of 50.","type":"integer"},{"name":"page_num","in":"query","required":false,"description":"Page number of the results to return. Defaults to the first page, 1.","type":"integer"},{"name":"order","in":"query","required":false,"description":"The field on which to order the result set. Defaults to created_at. Must be one of: created_at, id.","type":"string"},{"name":"order_dir","in":"query","required":false,"description":"Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc.","type":"string"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object181"}}}},"x-examples":[{"resource":"Enhancements","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/enhancements/geocode/:job_with_run_id/runs/:job_run_id/outputs","description":"View a Geocode Enhancement's outputs","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/enhancements/geocode/1193/runs/99/outputs","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer CKYjGJWdG6Xfrut1mR5rjk-VkyKsDdkzPyrqwSGh5zs","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"objectType\": \"File\",\n \"objectId\": 6,\n \"name\": \"my output file\",\n \"link\": \"api.civis.test/files/6\",\n \"value\": null\n },\n {\n \"objectType\": \"Report\",\n \"objectId\": 3,\n \"name\": \"my output report\",\n \"link\": \"api.civis.test/reports/3\",\n \"value\": null\n },\n {\n \"objectType\": \"Report\",\n \"objectId\": 4,\n \"name\": \"my output tableau report\",\n \"link\": \"api.civis.test/reports/4\",\n \"value\": null\n },\n {\n \"objectType\": \"Table\",\n \"objectId\": 104,\n \"name\": \"output.table\",\n \"link\": \"api.civis.test/tables/104\",\n \"value\": null\n },\n {\n \"objectType\": \"Project\",\n \"objectId\": 2,\n \"name\": \"my output project\",\n \"link\": \"api.civis.test/projects/2\",\n \"value\": null\n },\n {\n \"objectType\": \"Credential\",\n \"objectId\": 228,\n \"name\": \"my output credential\",\n \"link\": \"api.civis.test/credentials/228\",\n \"value\": null\n },\n {\n \"objectType\": \"JSONValue\",\n \"objectId\": 2,\n \"name\": \"my awesome JSON value\",\n \"link\": \"api.civis.test/json_values/2\",\n \"value\": {\n \"foo\": \"bar\"\n }\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","X-Pagination-Per-Page":"50","Access-Control-Expose-Headers":"X-Pagination-Per-Page, X-Pagination-Current-Page, X-Pagination-Total-Pages, X-Pagination-Total-Entries","X-Pagination-Current-Page":"1","X-Pagination-Total-Pages":"1","X-Pagination-Total-Entries":"7","Content-Type":"application/json; charset=utf-8","ETag":"W/\"42e6f1d6a6026e742817c9b8bffadfde\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"1163989a-3873-44e5-9bde-6ebf440e9ce0","X-Runtime":"0.074133","Content-Length":"811"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/enhancements/geocode/1193/runs/99/outputs\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer CKYjGJWdG6Xfrut1mR5rjk-VkyKsDdkzPyrqwSGh5zs\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/enhancements/cass-ncoa/{id}/shares":{"get":{"summary":"List users and groups permissioned on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object9"}}}},"x-examples":null,"x-deprecation-warning":null}},"/enhancements/cass-ncoa/{id}/shares/users":{"put":{"summary":"Set the permissions users have on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"Object199","in":"body","schema":{"$ref":"#/definitions/Object199"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object9"}}},"x-examples":null,"x-deprecation-warning":null}},"/enhancements/cass-ncoa/{id}/shares/users/{user_id}":{"delete":{"summary":"Revoke the permissions a user has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"user_id","in":"path","required":true,"description":"The ID of the user.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/enhancements/cass-ncoa/{id}/shares/groups":{"put":{"summary":"Set the permissions groups has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"Object200","in":"body","schema":{"$ref":"#/definitions/Object200"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object9"}}},"x-examples":null,"x-deprecation-warning":null}},"/enhancements/cass-ncoa/{id}/shares/groups/{group_id}":{"delete":{"summary":"Revoke the permissions a group has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"group_id","in":"path","required":true,"description":"The ID of the group.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/enhancements/cass-ncoa/{id}/dependencies":{"get":{"summary":"List dependent objects for this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"user_id","in":"query","required":false,"description":"ID of target user","type":"integer"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object15"}}}},"x-examples":null,"x-deprecation-warning":null}},"/enhancements/cass-ncoa/{id}/transfer":{"put":{"summary":"Transfer ownership of this object to another user","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"Object201","in":"body","schema":{"$ref":"#/definitions/Object201"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object17"}}},"x-examples":null,"x-deprecation-warning":null}},"/enhancements/cass-ncoa/{id}/projects":{"get":{"summary":"List the projects a CASS/NCOA Enhancement belongs to","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the CASS/NCOA Enhancement.","type":"integer"},{"name":"hidden","in":"query","required":false,"description":"If specified to be true, returns hidden items. Defaults to false, returning non-hidden items.","type":"boolean"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object85"}}}},"x-examples":null,"x-deprecation-warning":null}},"/enhancements/cass-ncoa/{id}/projects/{project_id}":{"put":{"summary":"Add a CASS/NCOA Enhancement to a project","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the CASS/NCOA Enhancement.","type":"integer"},{"name":"project_id","in":"path","required":true,"description":"The ID of the project.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null},"delete":{"summary":"Remove a CASS/NCOA Enhancement from a project","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the CASS/NCOA Enhancement.","type":"integer"},{"name":"project_id","in":"path","required":true,"description":"The ID of the project.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/enhancements/cass-ncoa/{id}/archive":{"put":{"summary":"Update the archive status of this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the object.","type":"integer"},{"name":"Object202","in":"body","schema":{"$ref":"#/definitions/Object202"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object164"}}},"x-examples":null,"x-deprecation-warning":null}},"/enhancements/geocode/{id}/shares":{"get":{"summary":"List users and groups permissioned on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object9"}}}},"x-examples":null,"x-deprecation-warning":null}},"/enhancements/geocode/{id}/shares/users":{"put":{"summary":"Set the permissions users have on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"Object203","in":"body","schema":{"$ref":"#/definitions/Object203"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object9"}}},"x-examples":null,"x-deprecation-warning":null}},"/enhancements/geocode/{id}/shares/users/{user_id}":{"delete":{"summary":"Revoke the permissions a user has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"user_id","in":"path","required":true,"description":"The ID of the user.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/enhancements/geocode/{id}/shares/groups":{"put":{"summary":"Set the permissions groups has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"Object204","in":"body","schema":{"$ref":"#/definitions/Object204"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object9"}}},"x-examples":null,"x-deprecation-warning":null}},"/enhancements/geocode/{id}/shares/groups/{group_id}":{"delete":{"summary":"Revoke the permissions a group has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"group_id","in":"path","required":true,"description":"The ID of the group.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/enhancements/geocode/{id}/dependencies":{"get":{"summary":"List dependent objects for this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"user_id","in":"query","required":false,"description":"ID of target user","type":"integer"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object15"}}}},"x-examples":null,"x-deprecation-warning":null}},"/enhancements/geocode/{id}/transfer":{"put":{"summary":"Transfer ownership of this object to another user","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"Object205","in":"body","schema":{"$ref":"#/definitions/Object205"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object17"}}},"x-examples":null,"x-deprecation-warning":null}},"/enhancements/geocode/{id}/projects":{"get":{"summary":"List the projects a Geocode Enhancement belongs to","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Geocode Enhancement.","type":"integer"},{"name":"hidden","in":"query","required":false,"description":"If specified to be true, returns hidden items. Defaults to false, returning non-hidden items.","type":"boolean"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object85"}}}},"x-examples":null,"x-deprecation-warning":null}},"/enhancements/geocode/{id}/projects/{project_id}":{"put":{"summary":"Add a Geocode Enhancement to a project","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Geocode Enhancement.","type":"integer"},{"name":"project_id","in":"path","required":true,"description":"The ID of the project.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null},"delete":{"summary":"Remove a Geocode Enhancement from a project","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Geocode Enhancement.","type":"integer"},{"name":"project_id","in":"path","required":true,"description":"The ID of the project.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/enhancements/geocode/{id}/archive":{"put":{"summary":"Update the archive status of this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the object.","type":"integer"},{"name":"Object206","in":"body","schema":{"$ref":"#/definitions/Object206"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object176"}}},"x-examples":null,"x-deprecation-warning":null}},"/enhancements/identity-resolution/{id}/shares":{"get":{"summary":"List users and groups permissioned on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object9"}}}},"x-examples":null,"x-deprecation-warning":null}},"/enhancements/identity-resolution/{id}/shares/users":{"put":{"summary":"Set the permissions users have on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"Object207","in":"body","schema":{"$ref":"#/definitions/Object207"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object9"}}},"x-examples":null,"x-deprecation-warning":null}},"/enhancements/identity-resolution/{id}/shares/users/{user_id}":{"delete":{"summary":"Revoke the permissions a user has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"user_id","in":"path","required":true,"description":"The ID of the user.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/enhancements/identity-resolution/{id}/shares/groups":{"put":{"summary":"Set the permissions groups has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"Object208","in":"body","schema":{"$ref":"#/definitions/Object208"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object9"}}},"x-examples":null,"x-deprecation-warning":null}},"/enhancements/identity-resolution/{id}/shares/groups/{group_id}":{"delete":{"summary":"Revoke the permissions a group has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"group_id","in":"path","required":true,"description":"The ID of the group.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/enhancements/identity-resolution/{id}/dependencies":{"get":{"summary":"List dependent objects for this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"user_id","in":"query","required":false,"description":"ID of target user","type":"integer"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object15"}}}},"x-examples":null,"x-deprecation-warning":null}},"/enhancements/identity-resolution/{id}/transfer":{"put":{"summary":"Transfer ownership of this object to another user","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"Object209","in":"body","schema":{"$ref":"#/definitions/Object209"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object17"}}},"x-examples":[{"resource":"Enhancements","resource_explanation":null,"http_method":"PUT","route":"http://api.civis.test/enhancements/identity-resolution/:identity_resolution_id/transfer","description":"Transfer identity resolution enhancement to another user","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"PUT","request_path":"http://api.civis.test/enhancements/identity-resolution/1234/transfer","request_body":"{\n \"id\": 1234,\n \"user_id\": 1306,\n \"include_dependencies\": false\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer Kxd0ecPefx9ehJODa7qORens4nBdKOov_53ftLU_DG8","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"dependencies\": [\n\n ]\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"81059fe6210ccee4e3349c0f34c12d18\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"c1ef36df-46ea-4520-b6ba-59f22de52aaf","X-Runtime":"0.173575","Content-Length":"19"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/enhancements/identity-resolution/1234/transfer\" -d '{\"id\":1234,\"user_id\":1306,\"include_dependencies\":false}' -X PUT \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer Kxd0ecPefx9ehJODa7qORens4nBdKOov_53ftLU_DG8\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/enhancements/identity-resolution/{id}/projects":{"get":{"summary":"List the projects an Identity Resolution Enhancement belongs to","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Identity Resolution Enhancement.","type":"integer"},{"name":"hidden","in":"query","required":false,"description":"If specified to be true, returns hidden items. Defaults to false, returning non-hidden items.","type":"boolean"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object85"}}}},"x-examples":null,"x-deprecation-warning":null}},"/enhancements/identity-resolution/{id}/projects/{project_id}":{"put":{"summary":"Add an Identity Resolution Enhancement to a project","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Identity Resolution Enhancement.","type":"integer"},{"name":"project_id","in":"path","required":true,"description":"The ID of the project.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null},"delete":{"summary":"Remove an Identity Resolution Enhancement from a project","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Identity Resolution Enhancement.","type":"integer"},{"name":"project_id","in":"path","required":true,"description":"The ID of the project.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/enhancements/identity-resolution/{id}/archive":{"put":{"summary":"Update the archive status of this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the object.","type":"integer"},{"name":"Object210","in":"body","schema":{"$ref":"#/definitions/Object210"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object135"}}},"x-examples":null,"x-deprecation-warning":null}},"/exports/":{"get":{"summary":"List ","description":null,"deprecated":false,"parameters":[{"name":"type","in":"query","required":false,"description":"If specified, return exports of these types. It accepts a comma-separated list, possible values are 'database' and 'gdoc'.","type":"string"},{"name":"status","in":"query","required":false,"description":"If specified, returns export with one of these statuses. It accepts a comma-separated list, possible values are 'running', 'failed', 'succeeded', 'idle', 'scheduled'.","type":"string"},{"name":"author","in":"query","required":false,"description":"If specified, return items from any of these authors. It accepts a comma-separated list of user IDs.","type":"string"},{"name":"hidden","in":"query","required":false,"description":"If specified to be true, returns hidden items. Defaults to false, returning non-hidden items.","type":"boolean"},{"name":"archived","in":"query","required":false,"description":"The archival status of the requested item(s).","type":"string"},{"name":"limit","in":"query","required":false,"description":"Number of results to return. Defaults to 20. Maximum allowed is 50.","type":"integer"},{"name":"page_num","in":"query","required":false,"description":"Page number of the results to return. Defaults to the first page, 1.","type":"integer"},{"name":"order","in":"query","required":false,"description":"The field on which to order the result set. Defaults to updated_at. Must be one of: updated_at, name, created_at, last_run.updated_at.","type":"string"},{"name":"order_dir","in":"query","required":false,"description":"Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc.","type":"string"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object211"}}}},"x-examples":[{"resource":"Exports","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/exports","description":"Lists exports","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/exports","request_body":null,"request_headers":{"Content-Type":"application/json","Authorization":"Bearer cXp57HgSVBHD8XxU1btXSLoyDys-dNNUw6IiLxZzWoE","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 1849,\n \"name\": \"Export #1849\",\n \"type\": \"JobTypes::Import\",\n \"createdAt\": \"2023-07-18T18:42:06.000Z\",\n \"updatedAt\": \"2023-07-18T17:42:06.000Z\",\n \"state\": \"idle\",\n \"lastRun\": null,\n \"author\": {\n \"id\": 2132,\n \"name\": \"User devuserfactory1611 1609\",\n \"username\": \"devuserfactory1611\",\n \"initials\": \"UD\",\n \"online\": null\n }\n },\n {\n \"id\": 1856,\n \"name\": \"Export #1856\",\n \"type\": \"JobTypes::Import\",\n \"createdAt\": \"2023-07-18T18:42:06.000Z\",\n \"updatedAt\": \"2023-07-18T15:42:06.000Z\",\n \"state\": \"idle\",\n \"lastRun\": null,\n \"author\": {\n \"id\": 2136,\n \"name\": \"Admin devadminfactory520 520\",\n \"username\": \"devadminfactory520\",\n \"initials\": \"AD\",\n \"online\": null\n }\n },\n {\n \"id\": 1842,\n \"name\": \"Export #1842\",\n \"type\": \"JobTypes::Import\",\n \"createdAt\": \"2023-07-18T18:42:05.000Z\",\n \"updatedAt\": \"2023-07-18T14:42:06.000Z\",\n \"state\": \"idle\",\n \"lastRun\": null,\n \"author\": {\n \"id\": 2125,\n \"name\": \"Admin devadminfactory516 516\",\n \"username\": \"devadminfactory516\",\n \"initials\": \"AD\",\n \"online\": null\n }\n },\n {\n \"id\": 1834,\n \"name\": \"Test Import Job\",\n \"type\": \"JobTypes::Import\",\n \"createdAt\": \"2023-07-18T18:42:05.000Z\",\n \"updatedAt\": \"2023-07-18T13:42:06.000Z\",\n \"state\": \"idle\",\n \"lastRun\": null,\n \"author\": {\n \"id\": 2121,\n \"name\": \"Admin devadminfactory514 514\",\n \"username\": \"devadminfactory514\",\n \"initials\": \"AD\",\n \"online\": null\n }\n },\n {\n \"id\": 1838,\n \"name\": \"Export #1838\",\n \"type\": \"JobTypes::Import\",\n \"createdAt\": \"2023-07-18T18:42:05.000Z\",\n \"updatedAt\": \"2023-07-18T12:42:06.000Z\",\n \"state\": \"idle\",\n \"lastRun\": null,\n \"author\": {\n \"id\": 2123,\n \"name\": \"Admin devadminfactory515 515\",\n \"username\": \"devadminfactory515\",\n \"initials\": \"AD\",\n \"online\": null\n }\n },\n {\n \"id\": 1859,\n \"name\": \"Script #1859\",\n \"type\": \"JobTypes::ContainerDocker\",\n \"createdAt\": \"2023-07-18T18:42:06.000Z\",\n \"updatedAt\": \"2023-07-18T11:42:06.000Z\",\n \"state\": \"succeeded\",\n \"lastRun\": {\n \"id\": 203,\n \"state\": \"succeeded\",\n \"createdAt\": \"2023-07-18T18:42:06.000Z\",\n \"startedAt\": null,\n \"finishedAt\": \"2023-07-18T18:42:06.000Z\",\n \"error\": null\n },\n \"author\": {\n \"id\": 2138,\n \"name\": \"Admin devadminfactory521 521\",\n \"username\": \"devadminfactory521\",\n \"initials\": \"AD\",\n \"online\": null\n }\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","X-Pagination-Per-Page":"20","Access-Control-Expose-Headers":"X-Pagination-Per-Page, X-Pagination-Current-Page, X-Pagination-Total-Pages, X-Pagination-Total-Entries","X-Pagination-Current-Page":"1","X-Pagination-Total-Pages":"1","X-Pagination-Total-Entries":"6","Content-Type":"application/json; charset=utf-8","ETag":"W/\"78a817ab6b3e359dc9520c7602713743\"","X-Request-Id":"42bc3841-a547-41f3-9d91-9ee5b698c2ac","X-Runtime":"0.115299","Content-Length":"1887"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/exports\" -X GET \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer cXp57HgSVBHD8XxU1btXSLoyDys-dNNUw6IiLxZzWoE\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/exports/files/csv/{id}/runs":{"post":{"summary":"Start a run","description":"Start a run and provide a URI for checking its status. The response will provide a 'Location' header which will contain a URI which may be polled to monitor the status of the run.","deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the CSV Export job.","type":"integer"}],"responses":{"202":{"description":"success","schema":{"$ref":"#/definitions/Object212"}}},"x-examples":[{"resource":"Exports","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/exports/files/csv/:id/runs","description":"Run an export","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/exports/files/csv/1865/runs","request_body":null,"request_headers":{"Content-Type":"application/json","Authorization":"Bearer Z7f7RGwC4AsnFylq17wqw3gqkUlCRT5DKW0smBo6hi4","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":202,"response_status_text":"Accepted","response_body":"{\n \"id\": 204,\n \"state\": \"queued\",\n \"createdAt\": \"2023-07-18T18:42:08.000Z\",\n \"startedAt\": null,\n \"finishedAt\": null,\n \"error\": null,\n \"outputCachedOn\": null\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","Location":"http://api.civis.test/exports/files/csv/1865/runs/204","Content-Type":"application/json; charset=utf-8","X-Request-Id":"a0dcf65e-831d-4f4f-be13-76881481e134","X-Runtime":"0.116074","Content-Length":"136"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/exports/files/csv/1865/runs\" -d '' -X POST \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer Z7f7RGwC4AsnFylq17wqw3gqkUlCRT5DKW0smBo6hi4\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"get":{"summary":"List runs for the given CSV Export job","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the CSV Export job.","type":"integer"},{"name":"limit","in":"query","required":false,"description":"Number of results to return. Defaults to 20. Maximum allowed is 100.","type":"integer"},{"name":"page_num","in":"query","required":false,"description":"Page number of the results to return. Defaults to the first page, 1.","type":"integer"},{"name":"order","in":"query","required":false,"description":"The field on which to order the result set. Defaults to id. Must be one of: id.","type":"string"},{"name":"order_dir","in":"query","required":false,"description":"Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc.","type":"string"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object213"}}}},"x-examples":[{"resource":"Exports","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/exports/files/csv/:id/runs","description":"View an export's run history","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/exports/files/csv/1866/runs","request_body":null,"request_headers":{"Content-Type":"application/json","Authorization":"Bearer s4Vajzu6JMQAuUfPojJW4hGVTeEUt2dPhGCVsx9ByFs","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 206,\n \"state\": \"succeeded\",\n \"createdAt\": \"2023-07-18T18:42:09.000Z\",\n \"startedAt\": \"2023-07-18T18:41:09.000Z\",\n \"finishedAt\": \"2023-07-18T19:42:09.000Z\",\n \"error\": null\n },\n {\n \"id\": 205,\n \"state\": \"succeeded\",\n \"createdAt\": \"2023-07-18T18:42:09.000Z\",\n \"startedAt\": \"2023-07-18T18:41:09.000Z\",\n \"finishedAt\": \"2023-07-18T18:42:09.000Z\",\n \"error\": null\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","X-Pagination-Per-Page":"20","Access-Control-Expose-Headers":"X-Pagination-Per-Page, X-Pagination-Current-Page, X-Pagination-Total-Pages, X-Pagination-Total-Entries","X-Pagination-Current-Page":"1","X-Pagination-Total-Pages":"1","X-Pagination-Total-Entries":"2","Content-Type":"application/json; charset=utf-8","ETag":"W/\"c6b7a09750bd858bd5927da4d6d0e3b9\"","X-Request-Id":"6fc14e74-9a09-40ae-8605-4545d302f1e5","X-Runtime":"0.018877","Content-Length":"325"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/exports/files/csv/1866/runs\" -X GET \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer s4Vajzu6JMQAuUfPojJW4hGVTeEUt2dPhGCVsx9ByFs\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/exports/files/csv/{id}/runs/{run_id}":{"get":{"summary":"Check status of a run","description":"View the status of a run. This endpoint may be polled to monitor the status of the run. When the 'state' field is no longer 'queued' or 'running' the run has reached its final state.","deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the CSV Export job.","type":"integer"},{"name":"run_id","in":"path","required":true,"description":"The ID of the run.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object212"}}},"x-examples":[{"resource":"Exports","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/exports/files/csv/:id/runs/:run_id","description":"Get an export run's details","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/exports/files/csv/1867/runs/207","request_body":null,"request_headers":{"Content-Type":"application/json","Authorization":"Bearer jd6XBFWbirXdcGhFR3YywyCBUei3FS0Lb4lLjFaA5B4","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 207,\n \"state\": \"running\",\n \"createdAt\": \"2023-07-18T18:42:09.000Z\",\n \"startedAt\": null,\n \"finishedAt\": null,\n \"error\": null,\n \"outputCachedOn\": null\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"8d0cae164ed1b5584ae415cc9870ae8a\"","X-Request-Id":"5117bb29-26f7-4b5e-b6f0-6e4cbd9c3ede","X-Runtime":"0.016665","Content-Length":"137"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/exports/files/csv/1867/runs/207\" -X GET \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer jd6XBFWbirXdcGhFR3YywyCBUei3FS0Lb4lLjFaA5B4\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"delete":{"summary":"Cancel a run","description":"Cancel a currently active run.","deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the CSV Export job.","type":"integer"},{"name":"run_id","in":"path","required":true,"description":"The ID of the run.","type":"integer"}],"responses":{"202":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/exports/files/csv/{id}/runs/{run_id}/logs":{"get":{"summary":"Get the logs for a run","description":"Get the logs for a run.","deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the CSV Export job.","type":"integer"},{"name":"run_id","in":"path","required":true,"description":"The ID of the run.","type":"integer"},{"name":"last_id","in":"query","required":false,"description":"The ID of the last log message received. Log entries with this ID value or lower will be omitted.Logs are sorted by ID if this value is provided, and are otherwise sorted by createdAt.","type":"integer"},{"name":"limit","in":"query","required":false,"description":"The maximum number of log messages to return. Default of 10000.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object117"}}}},"x-examples":null,"x-deprecation-warning":null}},"/exports/files/csv/{id}/runs/{run_id}/outputs":{"get":{"summary":"List the outputs for a run","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the csv_export.","type":"integer"},{"name":"run_id","in":"path","required":true,"description":"The ID of the run.","type":"integer"},{"name":"limit","in":"query","required":false,"description":"Number of results to return. Defaults to its maximum of 50.","type":"integer"},{"name":"page_num","in":"query","required":false,"description":"Page number of the results to return. Defaults to the first page, 1.","type":"integer"},{"name":"order","in":"query","required":false,"description":"The field on which to order the result set. Defaults to created_at. Must be one of: created_at, id.","type":"string"},{"name":"order_dir","in":"query","required":false,"description":"Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc.","type":"string"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object214"}}}},"x-examples":[{"resource":"Exports","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/exports/files/csv/:job_with_run_id/runs/:job_run_id/outputs","description":"View a CSV Export's outputs","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/exports/files/csv/1868/runs/208/outputs","request_body":null,"request_headers":{"Content-Type":"application/json","Authorization":"Bearer FOblV6y5fyWNI5-lerHmv79JaApx0QhpP7uvJUjwByk","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"objectType\": \"File\",\n \"objectId\": 23,\n \"name\": \"my output file\",\n \"link\": \"api.civis.test/files/23\",\n \"value\": null\n },\n {\n \"objectType\": \"Report\",\n \"objectId\": 11,\n \"name\": \"my output report\",\n \"link\": \"api.civis.test/reports/11\",\n \"value\": null\n },\n {\n \"objectType\": \"Report\",\n \"objectId\": 12,\n \"name\": \"my output tableau report\",\n \"link\": \"api.civis.test/reports/12\",\n \"value\": null\n },\n {\n \"objectType\": \"Table\",\n \"objectId\": 132,\n \"name\": \"output.table\",\n \"link\": \"api.civis.test/tables/132\",\n \"value\": null\n },\n {\n \"objectType\": \"Project\",\n \"objectId\": 6,\n \"name\": \"my output project\",\n \"link\": \"api.civis.test/projects/6\",\n \"value\": null\n },\n {\n \"objectType\": \"Credential\",\n \"objectId\": 479,\n \"name\": \"my output credential\",\n \"link\": \"api.civis.test/credentials/479\",\n \"value\": null\n },\n {\n \"objectType\": \"JSONValue\",\n \"objectId\": 6,\n \"name\": \"my awesome JSON value\",\n \"link\": \"api.civis.test/json_values/6\",\n \"value\": {\n \"foo\": \"bar\"\n }\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","X-Pagination-Per-Page":"50","Access-Control-Expose-Headers":"X-Pagination-Per-Page, X-Pagination-Current-Page, X-Pagination-Total-Pages, X-Pagination-Total-Entries","X-Pagination-Current-Page":"1","X-Pagination-Total-Pages":"1","X-Pagination-Total-Entries":"7","Content-Type":"application/json; charset=utf-8","ETag":"W/\"0a285c874ac97cbcdb9b66fe387d6ad3\"","X-Request-Id":"6fc71b7e-3b4c-446a-b1ad-36caf60014f3","X-Runtime":"0.045534","Content-Length":"817"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/exports/files/csv/1868/runs/208/outputs\" -X GET \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer FOblV6y5fyWNI5-lerHmv79JaApx0QhpP7uvJUjwByk\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/exports/files/csv":{"post":{"summary":"Create a CSV Export","description":null,"deprecated":false,"parameters":[{"name":"Object215","in":"body","schema":{"$ref":"#/definitions/Object215"},"required":true}],"responses":{"201":{"description":"success","schema":{"$ref":"#/definitions/Object219"}}},"x-examples":[{"resource":"Exports","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/exports/files/csv","description":"successfuly creates a Csv Export job with the expected parameters.","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/exports/files/csv","request_body":"{\n \"source\": {\n \"sql\": \"select * from public.tea\",\n \"remote_host_id\": 238,\n \"credential_id\": 452\n },\n \"destination\": {\n \"filename_prefix\": \"prefix\"\n },\n \"compression\": \"zip\"\n}","request_headers":{"Content-Type":"application/json","Authorization":"Bearer uWRkepqbumslBuNCp2bK064pMWQJI4pLxaogF94vk8k","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":201,"response_status_text":"Created","response_body":"{\n \"id\": 1860,\n \"name\": \"CSV Export #1860\",\n \"source\": {\n \"sql\": \"select * from public.tea\",\n \"remoteHostId\": 238,\n \"credentialId\": 452\n },\n \"destination\": {\n \"filenamePrefix\": \"prefix\",\n \"storagePath\": {\n \"filePath\": null,\n \"storageHostId\": null,\n \"credentialId\": null,\n \"existingFiles\": \"fail\"\n }\n },\n \"includeHeader\": true,\n \"compression\": \"zip\",\n \"columnDelimiter\": \"comma\",\n \"hidden\": false,\n \"forceMultifile\": false,\n \"maxFileSize\": null,\n \"myPermissionLevel\": \"manage\"\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"63214430ddb2698d362d78bc107cacec\"","X-Request-Id":"989ceb36-a659-471a-b97d-7e6374b457ce","X-Runtime":"0.102854","Content-Length":"410"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/exports/files/csv\" -d '{\"source\":{\"sql\":\"select * from public.tea\",\"remote_host_id\":238,\"credential_id\":452},\"destination\":{\"filename_prefix\":\"prefix\"},\"compression\":\"zip\"}' -X POST \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer uWRkepqbumslBuNCp2bK064pMWQJI4pLxaogF94vk8k\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Exports","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/exports/files/csv","description":"successfuly creates a Csv Export job with the expected parameters.","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/exports/files/csv","request_body":"{\n \"source\": {\n \"sql\": \"select * from public.tea\",\n \"remote_host_id\": 248,\n \"credential_id\": 482\n },\n \"destination\": {\n \"filename_prefix\": \"prefix\",\n \"storage_path\": {\n \"file_path\": \"file_path1\",\n \"storage_host_id\": 249,\n \"credential_id\": 483,\n \"existing_files\": \"overwrite\"\n }\n },\n \"compression\": \"zip\"\n}","request_headers":{"Content-Type":"application/json","Authorization":"Bearer uohDXXHxhkJ-HDhyzM2tikNiGZ2gEdYEyPB3PiByC-0","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":201,"response_status_text":"Created","response_body":"{\n \"id\": 1872,\n \"name\": \"CSV Export #1872\",\n \"source\": {\n \"sql\": \"select * from public.tea\",\n \"remoteHostId\": 248,\n \"credentialId\": 482\n },\n \"destination\": {\n \"filenamePrefix\": \"prefix\",\n \"storagePath\": {\n \"filePath\": \"file_path1\",\n \"storageHostId\": 249,\n \"credentialId\": 483,\n \"existingFiles\": \"overwrite\"\n }\n },\n \"includeHeader\": true,\n \"compression\": \"zip\",\n \"columnDelimiter\": \"comma\",\n \"hidden\": false,\n \"forceMultifile\": false,\n \"maxFileSize\": null,\n \"myPermissionLevel\": \"manage\"\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"38044f9cd66ac9b6c50563ed2ea0537e\"","X-Request-Id":"1d116e70-7cf6-4996-b479-487bddddb6ce","X-Runtime":"0.080491","Content-Length":"421"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/exports/files/csv\" -d '{\"source\":{\"sql\":\"select * from public.tea\",\"remote_host_id\":248,\"credential_id\":482},\"destination\":{\"filename_prefix\":\"prefix\",\"storage_path\":{\"file_path\":\"file_path1\",\"storage_host_id\":249,\"credential_id\":483,\"existing_files\":\"overwrite\"}},\"compression\":\"zip\"}' -X POST \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer uohDXXHxhkJ-HDhyzM2tikNiGZ2gEdYEyPB3PiByC-0\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/exports/files/csv/{id}":{"get":{"summary":"Get a CSV Export","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object219"}}},"x-examples":[{"resource":"Exports","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/exports/files/csv/:id","description":"successfully retrieves a created Csv Export Job by its ID","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/exports/files/csv/1862","request_body":null,"request_headers":{"Content-Type":"application/json","Authorization":"Bearer VejzVhKXqdbkjcg-MrDkEycMiDemi55DlHUHajfcq7w","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 1862,\n \"name\": \"CSV Export #1862\",\n \"source\": {\n \"sql\": \"SELECT * FROM table LIMIT 10;\",\n \"remoteHostId\": 240,\n \"credentialId\": 457\n },\n \"destination\": {\n \"filenamePrefix\": null,\n \"storagePath\": {\n \"filePath\": null,\n \"storageHostId\": null,\n \"credentialId\": null,\n \"existingFiles\": \"fail\"\n }\n },\n \"includeHeader\": true,\n \"compression\": \"gzip\",\n \"columnDelimiter\": \"comma\",\n \"hidden\": false,\n \"forceMultifile\": false,\n \"maxFileSize\": null,\n \"myPermissionLevel\": \"manage\"\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"56b81bcde66ca87742deda8001ad700d\"","X-Request-Id":"4400e50b-ec0b-4b74-ab52-225783b09c54","X-Runtime":"0.023282","Content-Length":"412"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/exports/files/csv/1862\" -X GET \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer VejzVhKXqdbkjcg-MrDkEycMiDemi55DlHUHajfcq7w\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"put":{"summary":"Replace all attributes of this CSV Export","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of this Csv Export job.","type":"integer"},{"name":"Object223","in":"body","schema":{"$ref":"#/definitions/Object223"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object219"}}},"x-examples":[{"resource":"Exports","resource_explanation":null,"http_method":"PUT","route":"http://api.civis.test/exports/files/csv/:id","description":"successfully replaces all attributes of an existing Csv Export Job","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"PUT","request_path":"http://api.civis.test/exports/files/csv/1863","request_body":"{\n \"source\": {\n \"sql\": \"SELECT * FROM table LIMIT 10;\",\n \"remote_host_id\": 241,\n \"credential_id\": 460\n },\n \"destination\": {\n \"filename_prefix\": \"new_prefix\"\n },\n \"compression\": \"zip\"\n}","request_headers":{"Content-Type":"application/json","Authorization":"Bearer tSUDaPvZOMC9nn7uB4N8eKIiA3IMlN4VqgbmhZPYNc0","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 1863,\n \"name\": \"CSV Export #1863\",\n \"source\": {\n \"sql\": \"SELECT * FROM table LIMIT 10;\",\n \"remoteHostId\": 241,\n \"credentialId\": 460\n },\n \"destination\": {\n \"filenamePrefix\": \"new_prefix\",\n \"storagePath\": {\n \"filePath\": null,\n \"storageHostId\": null,\n \"credentialId\": null,\n \"existingFiles\": \"fail\"\n }\n },\n \"includeHeader\": true,\n \"compression\": \"zip\",\n \"columnDelimiter\": \"comma\",\n \"hidden\": false,\n \"forceMultifile\": false,\n \"maxFileSize\": null,\n \"myPermissionLevel\": \"manage\"\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"b2f18ac80f7acd3d135d2a7692eca0f3\"","X-Request-Id":"8aae9fd8-c7ee-43c4-9918-425ccbddc2f6","X-Runtime":"0.062912","Content-Length":"419"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/exports/files/csv/1863\" -d '{\"source\":{\"sql\":\"SELECT * FROM table LIMIT 10;\",\"remote_host_id\":241,\"credential_id\":460},\"destination\":{\"filename_prefix\":\"new_prefix\"},\"compression\":\"zip\"}' -X PUT \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer tSUDaPvZOMC9nn7uB4N8eKIiA3IMlN4VqgbmhZPYNc0\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"patch":{"summary":"Update some attributes of this CSV Export","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of this Csv Export job.","type":"integer"},{"name":"Object224","in":"body","schema":{"$ref":"#/definitions/Object224"},"required":false}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object219"}}},"x-examples":[{"resource":"Exports","resource_explanation":null,"http_method":"PATCH","route":"http://api.civis.test/exports/files/csv/:id","description":"successfully updates filename_prefix of a created Csv Export Job","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"PATCH","request_path":"http://api.civis.test/exports/files/csv/1864","request_body":"{\n \"destination\": {\n \"filename_prefix\": \"new_prefix\"\n }\n}","request_headers":{"Content-Type":"application/json","Authorization":"Bearer jlnYdV4W323Ke7BlgrkE4l6pzvviPmUtTPHoTH1CUB8","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 1864,\n \"name\": \"CSV Export #1864\",\n \"source\": {\n \"sql\": \"SELECT * FROM table LIMIT 10;\",\n \"remoteHostId\": 242,\n \"credentialId\": 463\n },\n \"destination\": {\n \"filenamePrefix\": \"new_prefix\",\n \"storagePath\": {\n \"filePath\": null,\n \"storageHostId\": null,\n \"credentialId\": null,\n \"existingFiles\": \"fail\"\n }\n },\n \"includeHeader\": true,\n \"compression\": \"gzip\",\n \"columnDelimiter\": \"comma\",\n \"hidden\": false,\n \"forceMultifile\": false,\n \"maxFileSize\": null,\n \"myPermissionLevel\": \"manage\"\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"832994e12eeb634cf98c7c8f5142c2bc\"","X-Request-Id":"cf34df5e-ed28-484f-a110-2564fabd59aa","X-Runtime":"0.060156","Content-Length":"420"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/exports/files/csv/1864\" -d '{\"destination\":{\"filename_prefix\":\"new_prefix\"}}' -X PATCH \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer jlnYdV4W323Ke7BlgrkE4l6pzvviPmUtTPHoTH1CUB8\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/exports/files/csv/{id}/archive":{"put":{"summary":"Update the archive status of this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the object.","type":"integer"},{"name":"Object226","in":"body","schema":{"$ref":"#/definitions/Object226"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object219"}}},"x-examples":null,"x-deprecation-warning":null}},"/files/{id}/projects":{"get":{"summary":"List the projects a File belongs to","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the File.","type":"integer"},{"name":"hidden","in":"query","required":false,"description":"If specified to be true, returns hidden items. Defaults to false, returning non-hidden items.","type":"boolean"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object85"}}}},"x-examples":null,"x-deprecation-warning":null}},"/files/{id}/projects/{project_id}":{"put":{"summary":"Add a File to a project","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the File.","type":"integer"},{"name":"project_id","in":"path","required":true,"description":"The ID of the project.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null},"delete":{"summary":"Remove a File from a project","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the File.","type":"integer"},{"name":"project_id","in":"path","required":true,"description":"The ID of the project.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/files/{id}/shares":{"get":{"summary":"List users and groups permissioned on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object9"}}}},"x-examples":null,"x-deprecation-warning":null}},"/files/{id}/shares/users":{"put":{"summary":"Set the permissions users have on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"Object232","in":"body","schema":{"$ref":"#/definitions/Object232"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object9"}}},"x-examples":null,"x-deprecation-warning":null}},"/files/{id}/shares/users/{user_id}":{"delete":{"summary":"Revoke the permissions a user has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"user_id","in":"path","required":true,"description":"The ID of the user.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/files/{id}/shares/groups":{"put":{"summary":"Set the permissions groups has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"Object233","in":"body","schema":{"$ref":"#/definitions/Object233"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object9"}}},"x-examples":null,"x-deprecation-warning":null}},"/files/{id}/shares/groups/{group_id}":{"delete":{"summary":"Revoke the permissions a group has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"group_id","in":"path","required":true,"description":"The ID of the group.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/files/{id}/dependencies":{"get":{"summary":"List dependent objects for this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"user_id","in":"query","required":false,"description":"ID of target user","type":"integer"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object15"}}}},"x-examples":null,"x-deprecation-warning":null}},"/files/{id}/transfer":{"put":{"summary":"Transfer ownership of this object to another user","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"Object234","in":"body","schema":{"$ref":"#/definitions/Object234"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object17"}}},"x-examples":null,"x-deprecation-warning":null}},"/files/":{"post":{"summary":"Initiate an upload of a file into the platform","description":"Uploading a file begins with this endpoint. This endpoint returns a URL that must be used to complete the upload.","deprecated":false,"parameters":[{"name":"Object235","in":"body","schema":{"$ref":"#/definitions/Object235"},"required":true}],"responses":{"201":{"description":"success","schema":{"$ref":"#/definitions/Object236"}}},"x-examples":[{"resource":"Files","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/files","description":"Initiate an upload of a file","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/files","request_body":"{\n \"name\": \"my_file.csv.gzip\",\n \"description\": \"my description\"\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer UajK_mghHwyt6eoS9RbJKUgyE8PStaogZCPjNMHuxjs","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":201,"response_status_text":"Created","response_body":"{\n \"id\": 1,\n \"name\": \"my_file.csv.gzip\",\n \"createdAt\": \"2016-01-13T12:23:00.000Z\",\n \"fileSize\": 0,\n \"expiresAt\": \"2016-02-12T12:23:00.000Z\",\n \"description\": \"my description\",\n \"uploadUrl\": \"presigned_url\",\n \"uploadFields\": {\n \"a\": \"1\",\n \"b\": \"2\"\n },\n \"myPermissionLevel\": \"manage\"\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"bd669684750d73c094528271ca0bac0f\"","X-Request-Id":"random-key","X-Runtime":"0.587227","Content-Length":"246"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/files\" -d '{\"name\":\"my_file.csv.gzip\",\"description\":\"my description\"}' -X POST \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer UajK_mghHwyt6eoS9RbJKUgyE8PStaogZCPjNMHuxjs\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Files","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/files","description":"Initiate an upload of a file with a non-default expiration","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/files","request_body":"{\n \"name\": \"my_file.csv.gzip\",\n \"expiresAt\": \"2016-12-31 23:59:59\"\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer 8OsBefHwMn9ZiYPIdydgWvHZSCeuzxK8egu9-IQMhTQ","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":201,"response_status_text":"Created","response_body":"{\n \"id\": 2,\n \"name\": \"my_file.csv.gzip\",\n \"createdAt\": \"2016-01-13T12:23:00.000Z\",\n \"fileSize\": 0,\n \"expiresAt\": \"2016-12-31T23:59:59.000Z\",\n \"description\": null,\n \"uploadUrl\": \"presigned_url\",\n \"uploadFields\": {\n \"a\": \"1\",\n \"b\": \"2\"\n },\n \"myPermissionLevel\": \"manage\"\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"5c71d220adc22d7a47e0688fbe4df85d\"","X-Request-Id":"random-key","X-Runtime":"0.100073","Content-Length":"234"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/files\" -d '{\"name\":\"my_file.csv.gzip\",\"expiresAt\":\"2016-12-31 23:59:59\"}' -X POST \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer 8OsBefHwMn9ZiYPIdydgWvHZSCeuzxK8egu9-IQMhTQ\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Files","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/files","description":"Initiate an upload of a file with no expiration","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/files","request_body":"{\n \"name\": \"my_file.csv.gzip\",\n \"expiresAt\": null\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer PSGj8UM0B02x9eJ490Tb7woTZaql6rqzvyKWWI6hDa4","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":201,"response_status_text":"Created","response_body":"{\n \"id\": 3,\n \"name\": \"my_file.csv.gzip\",\n \"createdAt\": \"2016-01-13T12:23:00.000Z\",\n \"fileSize\": 0,\n \"expiresAt\": null,\n \"description\": null,\n \"uploadUrl\": \"presigned_url\",\n \"uploadFields\": {\n \"a\": \"1\",\n \"b\": \"2\"\n },\n \"myPermissionLevel\": \"manage\"\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"4f43625107238aea8b6947415fc5fe38\"","X-Request-Id":"random-key","X-Runtime":"0.133671","Content-Length":"212"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/files\" -d '{\"name\":\"my_file.csv.gzip\",\"expiresAt\":null}' -X POST \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer PSGj8UM0B02x9eJ490Tb7woTZaql6rqzvyKWWI6hDa4\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/files/multipart":{"post":{"summary":"Initiate a multipart upload","description":null,"deprecated":false,"parameters":[{"name":"Object237","in":"body","schema":{"$ref":"#/definitions/Object237"},"required":true}],"responses":{"201":{"description":"success","schema":{"$ref":"#/definitions/Object238"}}},"x-examples":[{"resource":"Files","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/files/multipart","description":"Initiate a multipart upload","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/files/multipart","request_body":"{\n \"name\": \"my_file.csv.gzip\",\n \"num_parts\": 2,\n \"description\": \"my description\"\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer IhKlbNeID6BKsnq_gggEZBOCQPcsJuYpvSUH-4YI7Zw","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":201,"response_status_text":"Created","response_body":"{\n \"id\": 11,\n \"name\": \"my_file.csv.gzip\",\n \"createdAt\": \"2017-09-26T12:23:00.000Z\",\n \"fileSize\": 0,\n \"expiresAt\": \"2017-10-26T12:23:00.000Z\",\n \"description\": \"my description\",\n \"uploadUrls\": [\n \"url/1\",\n \"url/2\"\n ]\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"9dc1e1d13cf75a1724ccc123d0551954\"","X-Request-Id":"69839245-23f7-4c4c-bdc5-f67bcbf5cd94","X-Runtime":"0.112713","Content-Length":"188"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/files/multipart\" -d '{\"name\":\"my_file.csv.gzip\",\"num_parts\":2,\"description\":\"my description\"}' -X POST \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer IhKlbNeID6BKsnq_gggEZBOCQPcsJuYpvSUH-4YI7Zw\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/files/multipart/{id}/complete":{"post":{"summary":"Complete a multipart upload","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the file.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":[{"resource":"Files","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/files/multipart/:id/complete","description":"Complete a multipart upload","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/files/multipart/12/complete","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer Wo3m-U7RIVPR3dNsw4mhTSYz4ryD0tQfRxRLYe08Tis","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":204,"response_status_text":"No Content","response_body":null,"response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","X-Request-Id":"791a637e-d458-49ed-a305-bde67f3c66ac","X-Runtime":"0.043036"},"response_content_type":null,"curl":"curl \"api.civis.testhttp://api.civis.test/files/multipart/12/complete\" -d '' -X POST \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer Wo3m-U7RIVPR3dNsw4mhTSYz4ryD0tQfRxRLYe08Tis\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/files/{id}":{"get":{"summary":"Get details about a file","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the file.","type":"integer"},{"name":"link_expires_at","in":"query","required":false,"description":"The date and time the download link will expire. Must be a time between now and 36 hours from now. Defaults to 30 minutes from now.","type":"string","format":"date-time"},{"name":"inline","in":"query","required":false,"description":"If true, will return a url that can be displayed inline in HTML","type":"boolean"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object239"}}},"x-examples":[{"resource":"Files","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/files/:id","description":"Get a file's path","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/files/4","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer OvX6M2uh2N6dz0KOj5b4ZDcU2QSF5l5pjUAJ-h8A8yQ","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 4,\n \"name\": \"my_file.csv.gzip\",\n \"createdAt\": \"2024-07-24T22:10:25.000Z\",\n \"fileSize\": 42,\n \"expiresAt\": null,\n \"description\": \"my description\",\n \"author\": {\n \"id\": 9,\n \"name\": \"Admin devadminfactory4 4\",\n \"username\": \"devadminfactory4\",\n \"initials\": \"AD\",\n \"online\": null\n },\n \"downloadUrl\": \"https://s3.example.com/post?a=1&b=2&c=3\",\n \"fileUrl\": \"https://s3.example.com/post?a=1&b=2&c=3\",\n \"detectedInfo\": {\n \"includeHeader\": true,\n \"columnDelimiter\": \"comma\",\n \"compression\": \"gzip\",\n \"tableColumns\": [\n {\n \"name\": \"column_1\",\n \"sqlType\": \"INT\"\n },\n {\n \"name\": \"column_2\",\n \"sqlType\": \"VARCHAR(10)\"\n }\n ]\n },\n \"myPermissionLevel\": \"manage\"\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"417aaa4e90dc1aba09b27116c27176af\"","X-Request-Id":"f4a8901e-f8e8-4662-a123-d76f285717b5","X-Runtime":"0.073007","Content-Length":"586"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/files/4\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer OvX6M2uh2N6dz0KOj5b4ZDcU2QSF5l5pjUAJ-h8A8yQ\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Files","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/files/:id","description":"Handle a file with no S3 content","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/files/5","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer wx5oQrWHtsRmuTXJ8sZvpWQZ7ts_3WjVgLaH9LTmo8Y","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 5,\n \"name\": \"my_file.csv.gzip\",\n \"createdAt\": \"2024-07-24T22:10:25.000Z\",\n \"fileSize\": 0,\n \"expiresAt\": null,\n \"description\": \"my description\",\n \"author\": {\n \"id\": 10,\n \"name\": \"Admin devadminfactory5 5\",\n \"username\": \"devadminfactory5\",\n \"initials\": \"AD\",\n \"online\": null\n },\n \"downloadUrl\": null,\n \"fileUrl\": null,\n \"detectedInfo\": {\n \"includeHeader\": null,\n \"columnDelimiter\": null,\n \"compression\": null,\n \"tableColumns\": [\n\n ]\n },\n \"myPermissionLevel\": \"manage\"\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"ac239dd6c91d02984c2d3a126ab1f77c\"","X-Request-Id":"db854eaa-eeac-4b9e-bc82-302be75a5170","X-Runtime":"0.063339","Content-Length":"408"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/files/5\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer wx5oQrWHtsRmuTXJ8sZvpWQZ7ts_3WjVgLaH9LTmo8Y\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"put":{"summary":"Update details about a file","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the file.","type":"integer"},{"name":"Object242","in":"body","schema":{"$ref":"#/definitions/Object242"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object239"}}},"x-examples":[{"resource":"Files","resource_explanation":null,"http_method":"PUT","route":"http://api.civis.test/files/:id","description":"Update a file's name and expiration date","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"PUT","request_path":"http://api.civis.test/files/6","request_body":"{\n \"name\": \"new_name.csv.gzip\",\n \"expires_at\": \"2020-03-25T12:23:00.000Z\",\n \"description\": \"my new description\"\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer 2MnuAObpJzBl9bS-SRsuPmi9gjFDqbOE7DdQpLEBw20","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 6,\n \"name\": \"new_name.csv.gzip\",\n \"createdAt\": \"2020-01-13T12:23:00.000Z\",\n \"fileSize\": 42,\n \"expiresAt\": \"2020-03-25T12:23:00.000Z\",\n \"description\": \"my new description\",\n \"author\": {\n \"id\": 11,\n \"name\": \"Admin devadminfactory6 6\",\n \"username\": \"devadminfactory6\",\n \"initials\": \"AD\",\n \"online\": null\n },\n \"downloadUrl\": \"https://s3.example.com/post?a=1&b=2&c=3\",\n \"fileUrl\": \"https://s3.example.com/post?a=1&b=2&c=3\",\n \"detectedInfo\": {\n \"includeHeader\": true,\n \"columnDelimiter\": \"comma\",\n \"compression\": \"gzip\",\n \"tableColumns\": [\n {\n \"name\": \"column_1\",\n \"sqlType\": \"INT\"\n },\n {\n \"name\": \"column_2\",\n \"sqlType\": \"VARCHAR(10)\"\n }\n ]\n },\n \"myPermissionLevel\": \"manage\"\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"019dde21dc1d537522c14f4dd01c6403\"","X-Request-Id":"cfbfe6b7-9f5d-4230-a763-bcecef495a58","X-Runtime":"0.090537","Content-Length":"614"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/files/6\" -d '{\"name\":\"new_name.csv.gzip\",\"expires_at\":\"2020-03-25T12:23:00.000Z\",\"description\":\"my new description\"}' -X PUT \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer 2MnuAObpJzBl9bS-SRsuPmi9gjFDqbOE7DdQpLEBw20\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Files","resource_explanation":null,"http_method":"PUT","route":"http://api.civis.test/files/:id","description":"Handle a file with no S3 content","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"PUT","request_path":"http://api.civis.test/files/7","request_body":"{\n \"name\": \"new_name.csv.gzip\",\n \"expires_at\": \"2020-03-25T12:23:00.000Z\",\n \"description\": \"my new description\"\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer LXelVAAA5S9pzNTzeJa9JCtXBpkiWw3jvF9YS2BbUM0","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 7,\n \"name\": \"new_name.csv.gzip\",\n \"createdAt\": \"2020-01-13T12:23:00.000Z\",\n \"fileSize\": 0,\n \"expiresAt\": \"2020-03-25T12:23:00.000Z\",\n \"description\": \"my new description\",\n \"author\": {\n \"id\": 12,\n \"name\": \"Admin devadminfactory7 7\",\n \"username\": \"devadminfactory7\",\n \"initials\": \"AD\",\n \"online\": null\n },\n \"downloadUrl\": null,\n \"fileUrl\": null,\n \"detectedInfo\": {\n \"includeHeader\": null,\n \"columnDelimiter\": null,\n \"compression\": null,\n \"tableColumns\": [\n\n ]\n },\n \"myPermissionLevel\": \"manage\"\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"a0d08f0b810166a6e6425c87dab1c48a\"","X-Request-Id":"a1a078fd-3f32-4227-9af6-c7989f65c6c6","X-Runtime":"0.094599","Content-Length":"435"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/files/7\" -d '{\"name\":\"new_name.csv.gzip\",\"expires_at\":\"2020-03-25T12:23:00.000Z\",\"description\":\"my new description\"}' -X PUT \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer LXelVAAA5S9pzNTzeJa9JCtXBpkiWw3jvF9YS2BbUM0\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"patch":{"summary":"Update details about a file","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the file.","type":"integer"},{"name":"Object243","in":"body","schema":{"$ref":"#/definitions/Object243"},"required":false}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object239"}}},"x-examples":[{"resource":"Files","resource_explanation":null,"http_method":"PATCH","route":"http://api.civis.test/files/:id","description":"Update a file's name","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"PATCH","request_path":"http://api.civis.test/files/8","request_body":"{\n \"name\": \"new_name.csv.gzip\",\n \"description\": \"my new description\"\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer REtuDnw5xFM4ROlafU7rocaez-oMGFVAe6yyjkGR7MA","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 8,\n \"name\": \"new_name.csv.gzip\",\n \"createdAt\": \"2020-01-13T12:23:00.000Z\",\n \"fileSize\": 42,\n \"expiresAt\": \"2020-03-13T12:23:00.000Z\",\n \"description\": \"my new description\",\n \"author\": {\n \"id\": 13,\n \"name\": \"Admin devadminfactory8 8\",\n \"username\": \"devadminfactory8\",\n \"initials\": \"AD\",\n \"online\": null\n },\n \"downloadUrl\": \"https://s3.example.com/post?a=1&b=2&c=3\",\n \"fileUrl\": \"https://s3.example.com/post?a=1&b=2&c=3\",\n \"detectedInfo\": {\n \"includeHeader\": true,\n \"columnDelimiter\": \"comma\",\n \"compression\": \"gzip\",\n \"tableColumns\": [\n {\n \"name\": \"column_1\",\n \"sqlType\": \"INT\"\n },\n {\n \"name\": \"column_2\",\n \"sqlType\": \"VARCHAR(10)\"\n }\n ]\n },\n \"myPermissionLevel\": \"manage\"\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"ac43eb33d3328b889eb0af36963907a9\"","X-Request-Id":"3bbd5192-6c0c-4a31-8916-82dddd30b2e8","X-Runtime":"0.094085","Content-Length":"614"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/files/8\" -d '{\"name\":\"new_name.csv.gzip\",\"description\":\"my new description\"}' -X PATCH \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer REtuDnw5xFM4ROlafU7rocaez-oMGFVAe6yyjkGR7MA\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Files","resource_explanation":null,"http_method":"PATCH","route":"http://api.civis.test/files/:id","description":"Update a file's expiration date","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"PATCH","request_path":"http://api.civis.test/files/9","request_body":"{\n \"expires_at\": \"2020-03-25T12:23:00.000Z\",\n \"description\": \"my new description\"\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer jiETCFr1kVumd-iT5S8n___O_Y-wRu1pmsxXV9zNa_s","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 9,\n \"name\": \"my_file.csv.gzip\",\n \"createdAt\": \"2020-01-13T12:23:00.000Z\",\n \"fileSize\": 42,\n \"expiresAt\": \"2020-03-25T12:23:00.000Z\",\n \"description\": \"my new description\",\n \"author\": {\n \"id\": 14,\n \"name\": \"Admin devadminfactory9 9\",\n \"username\": \"devadminfactory9\",\n \"initials\": \"AD\",\n \"online\": null\n },\n \"downloadUrl\": \"https://s3.example.com/post?a=1&b=2&c=3\",\n \"fileUrl\": \"https://s3.example.com/post?a=1&b=2&c=3\",\n \"detectedInfo\": {\n \"includeHeader\": true,\n \"columnDelimiter\": \"comma\",\n \"compression\": \"gzip\",\n \"tableColumns\": [\n {\n \"name\": \"column_1\",\n \"sqlType\": \"INT\"\n },\n {\n \"name\": \"column_2\",\n \"sqlType\": \"VARCHAR(10)\"\n }\n ]\n },\n \"myPermissionLevel\": \"manage\"\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"a97d9ce5d7761fc9d4db9e0b5a9f5537\"","X-Request-Id":"12ea232a-7ccf-4cfa-9f15-1339d79537ac","X-Runtime":"0.051219","Content-Length":"613"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/files/9\" -d '{\"expires_at\":\"2020-03-25T12:23:00.000Z\",\"description\":\"my new description\"}' -X PATCH \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer jiETCFr1kVumd-iT5S8n___O_Y-wRu1pmsxXV9zNa_s\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Files","resource_explanation":null,"http_method":"PATCH","route":"http://api.civis.test/files/:id","description":"Handle a file with no S3 content","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"PATCH","request_path":"http://api.civis.test/files/10","request_body":"{\n \"name\": \"new_name.csv.gzip\",\n \"expires_at\": \"2020-03-25T12:23:00.000Z\",\n \"description\": \"my new description\"\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer Xr4DNyPeryLVuTfxTpIwlrqioXxCSYCThYzPvRCawP8","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 10,\n \"name\": \"new_name.csv.gzip\",\n \"createdAt\": \"2020-01-13T12:23:00.000Z\",\n \"fileSize\": 0,\n \"expiresAt\": \"2020-03-25T12:23:00.000Z\",\n \"description\": \"my new description\",\n \"author\": {\n \"id\": 15,\n \"name\": \"Admin devadminfactory10 10\",\n \"username\": \"devadminfactory10\",\n \"initials\": \"AD\",\n \"online\": null\n },\n \"downloadUrl\": null,\n \"fileUrl\": null,\n \"detectedInfo\": {\n \"includeHeader\": null,\n \"columnDelimiter\": null,\n \"compression\": null,\n \"tableColumns\": [\n\n ]\n },\n \"myPermissionLevel\": \"manage\"\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"0b6f896d837a05f0a5d9b7686a4f81f9\"","X-Request-Id":"f6308f5b-949b-43e9-b95d-c14590242ecd","X-Runtime":"0.053369","Content-Length":"439"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/files/10\" -d '{\"name\":\"new_name.csv.gzip\",\"expires_at\":\"2020-03-25T12:23:00.000Z\",\"description\":\"my new description\"}' -X PATCH \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer Xr4DNyPeryLVuTfxTpIwlrqioXxCSYCThYzPvRCawP8\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/files/preprocess/csv":{"post":{"summary":"Create a Preprocess CSV","description":null,"deprecated":false,"parameters":[{"name":"Object244","in":"body","schema":{"$ref":"#/definitions/Object244"},"required":true}],"responses":{"201":{"description":"success","schema":{"$ref":"#/definitions/Object245"}}},"x-examples":[{"resource":"Files","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/files/preprocess/csv","description":"Preprocess a CSV file","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/files/preprocess/csv","request_body":"{\n \"file_id\": 13\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer OayeswGdIKmGPD5hny44KdjyTykJ-QIK4ORr2YcB0n4","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":201,"response_status_text":"Created","response_body":"{\n \"id\": 1,\n \"fileId\": 13,\n \"inPlace\": true,\n \"detectTableColumns\": false,\n \"forceCharacterSetConversion\": false,\n \"includeHeader\": null,\n \"columnDelimiter\": null,\n \"hidden\": false\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"40170d8773f00c01fd1ec243f4359111\"","X-Request-Id":"2f2d338d-0ca2-4621-928e-f692301983e8","X-Runtime":"0.279042","Content-Length":"157"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/files/preprocess/csv\" -d '{\"file_id\":13}' -X POST \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer OayeswGdIKmGPD5hny44KdjyTykJ-QIK4ORr2YcB0n4\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/files/preprocess/csv/{id}":{"get":{"summary":"Get a Preprocess CSV","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object245"}}},"x-examples":null,"x-deprecation-warning":null},"put":{"summary":"Replace all attributes of this Preprocess CSV","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the job created.","type":"integer"},{"name":"Object246","in":"body","schema":{"$ref":"#/definitions/Object246"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object245"}}},"x-examples":null,"x-deprecation-warning":null},"patch":{"summary":"Update some attributes of this Preprocess CSV","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the job created.","type":"integer"},{"name":"Object247","in":"body","schema":{"$ref":"#/definitions/Object247"},"required":false}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object245"}}},"x-examples":[{"resource":"Files","resource_explanation":null,"http_method":"PATCH","route":"http://api.civis.test/files/preprocess/csv/:id","description":"Update a job","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"PATCH","request_path":"http://api.civis.test/files/preprocess/csv/3","request_body":"{\n \"in_place\": false,\n \"detect_table_columns\": true\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer tQAgxY5HMyCWD4JfRy2VHK8eWG9zfKUqFJkL1I9d6r8","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 3,\n \"fileId\": 14,\n \"inPlace\": false,\n \"detectTableColumns\": true,\n \"forceCharacterSetConversion\": false,\n \"includeHeader\": true,\n \"columnDelimiter\": \"comma\",\n \"hidden\": false\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"c64abbd7f7888ef294d60528e496217d\"","X-Request-Id":"379d45d8-13f8-4685-900c-c0128f761dde","X-Runtime":"0.061130","Content-Length":"160"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/files/preprocess/csv/3\" -d '{\"in_place\":false,\"detect_table_columns\":true}' -X PATCH \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer tQAgxY5HMyCWD4JfRy2VHK8eWG9zfKUqFJkL1I9d6r8\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"delete":{"summary":"Archive a Preprocess CSV (deprecated, use archiving endpoints instead)","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/files/preprocess/csv/{id}/archive":{"put":{"summary":"Update the archive status of this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the object.","type":"integer"},{"name":"Object248","in":"body","schema":{"$ref":"#/definitions/Object248"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object245"}}},"x-examples":null,"x-deprecation-warning":null}},"/git_repos/":{"get":{"summary":"List bookmarked git repositories","description":null,"deprecated":false,"parameters":[{"name":"limit","in":"query","required":false,"description":"Number of results to return. Defaults to 20. Maximum allowed is 100.","type":"integer"},{"name":"page_num","in":"query","required":false,"description":"Page number of the results to return. Defaults to the first page, 1.","type":"integer"},{"name":"order","in":"query","required":false,"description":"The field on which to order the result set. Defaults to repo_url. Must be one of: repo_url, created_at.","type":"string"},{"name":"order_dir","in":"query","required":false,"description":"Direction in which to sort, either asc (ascending) or desc (descending) defaulting to asc.","type":"string"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object249"}}}},"x-examples":[{"resource":"GitRepos","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/git_repos","description":"List all bookmarked git repositories","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/git_repos","request_body":null,"request_headers":{"Content-Type":"application/json","Authorization":"Bearer gDMFKg2zfeqX5ehVJd6bgvzBZ2hKvpSEEtrWY83r-R8","Accept":"application/vnd.civis-platform.v1","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 1,\n \"repoUrl\": \"https://github.com/civisanalytics_10000/console.git\",\n \"createdAt\": \"2023-07-18T18:42:13.000Z\",\n \"updatedAt\": \"2023-07-18T18:42:13.000Z\"\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","X-Pagination-Per-Page":"20","Access-Control-Expose-Headers":"X-Pagination-Per-Page, X-Pagination-Current-Page, X-Pagination-Total-Pages, X-Pagination-Total-Entries","X-Pagination-Current-Page":"1","X-Pagination-Total-Pages":"1","X-Pagination-Total-Entries":"1","Content-Type":"application/json; charset=utf-8","ETag":"W/\"0f8ace0ff70ad96e2c5927799c2c2f3e\"","X-Request-Id":"13b8a7db-505e-482d-bd86-377aaa0d793b","X-Runtime":"0.013031","Content-Length":"152"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/git_repos\" -X GET \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer gDMFKg2zfeqX5ehVJd6bgvzBZ2hKvpSEEtrWY83r-R8\" \\\n\t-H \"Accept: application/vnd.civis-platform.v1\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"post":{"summary":"Bookmark a git repository","description":null,"deprecated":false,"parameters":[{"name":"Object250","in":"body","schema":{"$ref":"#/definitions/Object250"},"required":true}],"responses":{"201":{"description":"success","schema":{"$ref":"#/definitions/Object249"}}},"x-examples":[{"resource":"GitRepos","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/git_repos","description":"Bookmark a git repository from a URL","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/git_repos","request_body":"{\n \"repo_url\": \"https://github.com/civisanalytics/potato.git\"\n}","request_headers":{"Content-Type":"application/json","Authorization":"Bearer 5XVs8Qo37dciUAnG2bBZVoJMsMpjcH34UGDbxwPl0ps","Accept":"application/vnd.civis-platform.v1","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":201,"response_status_text":"Created","response_body":"{\n \"id\": 5,\n \"repoUrl\": \"https://github.com/civisanalytics/potato.git\",\n \"createdAt\": \"2023-07-18T18:42:14.000Z\",\n \"updatedAt\": \"2023-07-18T18:42:14.000Z\"\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"f034712e10b157213de836030e538f25\"","X-Request-Id":"c3c6ae97-a16b-4ffc-b2c6-c447394395e9","X-Runtime":"0.017244","Content-Length":"143"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/git_repos\" -d '{\"repo_url\":\"https://github.com/civisanalytics/potato.git\"}' -X POST \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer 5XVs8Qo37dciUAnG2bBZVoJMsMpjcH34UGDbxwPl0ps\" \\\n\t-H \"Accept: application/vnd.civis-platform.v1\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/git_repos/{id}":{"get":{"summary":"Get a bookmarked git repository","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID for this git repository.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object249"}}},"x-examples":[{"resource":"GitRepos","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/git_repos/:id","description":"View a bookmarked git repository's details","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/git_repos/2","request_body":null,"request_headers":{"Content-Type":"application/json","Authorization":"Bearer D5J_M5qBy2kvRrNxUtgQF_vmQq_WVi4AdHQd2SRoOZY","Accept":"application/vnd.civis-platform.v1","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 2,\n \"repoUrl\": \"https://github.com/civisanalytics_10001/console.git\",\n \"createdAt\": \"2023-07-18T18:42:13.000Z\",\n \"updatedAt\": \"2023-07-18T18:42:13.000Z\"\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"19eeed854e247b773a3d705fd1336a40\"","X-Request-Id":"76bf2893-66b4-4f72-8c65-30f30b857970","X-Runtime":"0.010696","Content-Length":"150"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/git_repos/2\" -X GET \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer D5J_M5qBy2kvRrNxUtgQF_vmQq_WVi4AdHQd2SRoOZY\" \\\n\t-H \"Accept: application/vnd.civis-platform.v1\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"delete":{"summary":"Remove the bookmark on a git repository","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID for this git repository.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":[{"resource":"GitRepos","resource_explanation":null,"http_method":"DELETE","route":"http://api.civis.test/git_repos/:id","description":"Delete the bookmark on a git repository","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"DELETE","request_path":"http://api.civis.test/git_repos/6","request_body":null,"request_headers":{"Content-Type":"application/json","Authorization":"Bearer 8tOH6DaZfhgTXgsTLStVt1DCg5q6TIutR4bFw_nDSXQ","Accept":"application/vnd.civis-platform.v1","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":204,"response_status_text":"No Content","response_body":null,"response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","X-Request-Id":"45b31e1d-84db-464e-bc66-d2423edae9f2","X-Runtime":"0.013497"},"response_content_type":null,"curl":"curl \"api.civis.testhttp://api.civis.test/git_repos/6\" -d '' -X DELETE \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer 8tOH6DaZfhgTXgsTLStVt1DCg5q6TIutR4bFw_nDSXQ\" \\\n\t-H \"Accept: application/vnd.civis-platform.v1\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/git_repos/{id}/refs":{"get":{"summary":"Get all branches and tags of a bookmarked git repository","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID for this git repository.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object251"}}},"x-examples":[{"resource":"GitRepos","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/git_repos/:id/refs","description":"View a bookmarked git repository's branches and tags","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/git_repos/3/refs","request_body":null,"request_headers":{"Content-Type":"application/json","Authorization":"Bearer 9XXc7wvlnIgqPu_Y5ztovlCk47VYN1alMxvvcAscrxw","Accept":"application/vnd.civis-platform.v1","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"branches\": [\n \"main\"\n ],\n \"tags\": [\n \"v0.0.1\"\n ]\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"2013f96a65dfdc7ee597c05cb09c6a9d\"","X-Request-Id":"db4cd1d7-f678-42e5-9d4f-14e7eff6168f","X-Runtime":"0.017421","Content-Length":"39"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/git_repos/3/refs\" -X GET \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer 9XXc7wvlnIgqPu_Y5ztovlCk47VYN1alMxvvcAscrxw\" \\\n\t-H \"Accept: application/vnd.civis-platform.v1\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/groups/":{"get":{"summary":"List Groups","description":null,"deprecated":false,"parameters":[{"name":"query","in":"query","required":false,"description":"If specified, it will filter the groups returned.","type":"string"},{"name":"permission","in":"query","required":false,"description":"A permissions string, one of \"read\", \"write\", or \"manage\". Lists only groups for which the current user has that permission.","type":"string"},{"name":"include_members","in":"query","required":false,"description":"Show members of the group.","type":"boolean"},{"name":"organization_id","in":"query","required":false,"description":"The organization by which to filter groups.","type":"integer"},{"name":"user_ids","in":"query","required":false,"description":"A list of user IDs to filter groups by.Groups will be returned if any of the users is a member","type":"array","items":{"type":"integer"}},{"name":"limit","in":"query","required":false,"description":"Number of results to return. Defaults to 50. Maximum allowed is 1000.","type":"integer"},{"name":"page_num","in":"query","required":false,"description":"Page number of the results to return. Defaults to the first page, 1.","type":"integer"},{"name":"order","in":"query","required":false,"description":"The field on which to order the result set. Defaults to name. Must be one of: name, created_at.","type":"string"},{"name":"order_dir","in":"query","required":false,"description":"Direction in which to sort, either asc (ascending) or desc (descending) defaulting to asc.","type":"string"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object252"}}}},"x-examples":[{"resource":"Groups","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/groups","description":"List groups visible to the current user","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/groups","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer jNRGjLs4QkD9iHE-a6tFOxKnVb2x6OgtFh2vEekEJAs","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 30,\n \"name\": \"Default\",\n \"createdAt\": \"2025-02-26T17:48:11.000Z\",\n \"updatedAt\": \"2025-02-26T17:48:12.000Z\",\n \"description\": null,\n \"slug\": \"default\",\n \"organizationId\": 4,\n \"organizationName\": \"Default\",\n \"memberCount\": 1,\n \"totalMemberCount\": 1,\n \"lastUpdatedById\": null,\n \"createdById\": null,\n \"members\": [\n\n ]\n },\n {\n \"id\": 26,\n \"name\": \"Default Admins\",\n \"createdAt\": \"2025-02-26T17:48:11.000Z\",\n \"updatedAt\": \"2025-02-26T17:48:11.000Z\",\n \"description\": null,\n \"slug\": \"default_admins\",\n \"organizationId\": 4,\n \"organizationName\": \"Default\",\n \"memberCount\": 0,\n \"totalMemberCount\": 0,\n \"lastUpdatedById\": null,\n \"createdById\": null,\n \"members\": [\n\n ]\n },\n {\n \"id\": 28,\n \"name\": \"Default All Database Users\",\n \"createdAt\": \"2025-02-26T17:48:11.000Z\",\n \"updatedAt\": \"2025-02-26T17:48:11.000Z\",\n \"description\": null,\n \"slug\": \"default_dbusers\",\n \"organizationId\": 4,\n \"organizationName\": \"Default\",\n \"memberCount\": 0,\n \"totalMemberCount\": 0,\n \"lastUpdatedById\": null,\n \"createdById\": null,\n \"members\": [\n\n ]\n },\n {\n \"id\": 29,\n \"name\": \"Default Report Viewers\",\n \"createdAt\": \"2025-02-26T17:48:11.000Z\",\n \"updatedAt\": \"2025-02-26T17:48:11.000Z\",\n \"description\": null,\n \"slug\": \"default_reportviewers\",\n \"organizationId\": 4,\n \"organizationName\": \"Default\",\n \"memberCount\": 0,\n \"totalMemberCount\": 0,\n \"lastUpdatedById\": null,\n \"createdById\": null,\n \"members\": [\n\n ]\n },\n {\n \"id\": 27,\n \"name\": \"Default Team Admins\",\n \"createdAt\": \"2025-02-26T17:48:11.000Z\",\n \"updatedAt\": \"2025-02-26T17:48:11.000Z\",\n \"description\": null,\n \"slug\": \"default_teamadmins\",\n \"organizationId\": 4,\n \"organizationName\": \"Default\",\n \"memberCount\": 0,\n \"totalMemberCount\": 0,\n \"lastUpdatedById\": null,\n \"createdById\": null,\n \"members\": [\n\n ]\n },\n {\n \"id\": 49,\n \"name\": \"Group with gc role\",\n \"createdAt\": \"2025-02-26T17:48:15.000Z\",\n \"updatedAt\": \"2025-02-26T17:48:15.000Z\",\n \"description\": null,\n \"slug\": \"group_c\",\n \"organizationId\": 7,\n \"organizationName\": \"Organization 2\",\n \"memberCount\": 1,\n \"totalMemberCount\": 1,\n \"lastUpdatedById\": null,\n \"createdById\": null,\n \"members\": [\n\n ]\n },\n {\n \"id\": 43,\n \"name\": \"Shared Read\",\n \"createdAt\": \"2025-02-26T17:48:15.000Z\",\n \"updatedAt\": \"2025-02-26T17:48:15.000Z\",\n \"description\": null,\n \"slug\": \"group_b\",\n \"organizationId\": 6,\n \"organizationName\": \"Organization 1\",\n \"memberCount\": 1,\n \"totalMemberCount\": 1,\n \"lastUpdatedById\": null,\n \"createdById\": null,\n \"members\": [\n\n ]\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","X-Pagination-Per-Page":"50","Access-Control-Expose-Headers":"X-Pagination-Per-Page, X-Pagination-Current-Page, X-Pagination-Total-Pages, X-Pagination-Total-Entries","X-Pagination-Current-Page":"1","X-Pagination-Total-Pages":"1","X-Pagination-Total-Entries":"7","Content-Type":"application/json; charset=utf-8","ETag":"W/\"5e38176021076f175209f12e3af9466d\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"98e07dd7-b1bd-43c2-b397-e31b7c82d28f","X-Runtime":"0.203060","Content-Length":"2090"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/groups\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer jNRGjLs4QkD9iHE-a6tFOxKnVb2x6OgtFh2vEekEJAs\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"post":{"summary":"Create a Group","description":null,"deprecated":false,"parameters":[{"name":"Object253","in":"body","schema":{"$ref":"#/definitions/Object253"},"required":true}],"responses":{"201":{"description":"success","schema":{"$ref":"#/definitions/Object254"}}},"x-examples":[{"resource":"Groups","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/groups","description":"Create a new group","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/groups","request_body":"{\n \"name\": \"Friendship\"\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer ACETfFY6v3lerD4PbpCDMwgprKMZIUVQsINCBjkgDUk","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":201,"response_status_text":"Created","response_body":"{\n \"id\": 77,\n \"name\": \"Friendship\",\n \"createdAt\": \"2025-02-26T17:48:21.000Z\",\n \"updatedAt\": \"2025-02-26T17:48:21.000Z\",\n \"description\": null,\n \"slug\": \"7cd6860f-211d-4e90-903c-9c74e991a6a5\",\n \"organizationId\": 4,\n \"organizationName\": \"Default\",\n \"memberCount\": 0,\n \"totalMemberCount\": 0,\n \"defaultOtpRequiredForLogin\": null,\n \"roleIds\": [\n\n ],\n \"defaultTimeZone\": null,\n \"defaultJobsLabel\": null,\n \"defaultNotebooksLabel\": null,\n \"defaultServicesLabel\": null,\n \"lastUpdatedById\": 8,\n \"createdById\": 8,\n \"members\": [\n\n ]\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"59fcf4dbf21ccd043e03d40dccee7297\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"3589755b-1e0b-4f52-af19-ec704607b2ab","X-Runtime":"0.099555","Content-Length":"457"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/groups\" -d '{\"name\":\"Friendship\"}' -X POST \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer ACETfFY6v3lerD4PbpCDMwgprKMZIUVQsINCBjkgDUk\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/groups/{id}":{"get":{"summary":"Get a Group","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object254"}}},"x-examples":[{"resource":"Groups","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/groups/:shared_group_id","description":"Show info for a group","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/groups/56","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer YPyuEb9YuxpkYzlduwu5NqqDu-xhnShE76SIP85W4dI","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 56,\n \"name\": \"Shared Read\",\n \"createdAt\": \"2025-02-26T17:48:18.000Z\",\n \"updatedAt\": \"2025-02-26T17:48:18.000Z\",\n \"description\": null,\n \"slug\": \"group_d\",\n \"organizationId\": 8,\n \"organizationName\": \"Organization 3\",\n \"memberCount\": 1,\n \"totalMemberCount\": 1,\n \"defaultOtpRequiredForLogin\": null,\n \"roleIds\": [\n\n ],\n \"defaultTimeZone\": null,\n \"defaultJobsLabel\": null,\n \"defaultNotebooksLabel\": null,\n \"defaultServicesLabel\": null,\n \"lastUpdatedById\": null,\n \"createdById\": null,\n \"members\": [\n {\n \"id\": 7,\n \"name\": \"User devuserfactory2 2\",\n \"username\": \"devuserfactory2\",\n \"initials\": \"UD\",\n \"online\": null,\n \"email\": \"devuserfactory22user@localhost.test\",\n \"primaryGroupId\": 30,\n \"active\": true\n }\n ]\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"4c3a372147c540a1040f7bb56315aa74\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"d8e3204a-ee8a-4e6f-a65c-84b09625c28b","X-Runtime":"0.045865","Content-Length":"621"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/groups/56\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer YPyuEb9YuxpkYzlduwu5NqqDu-xhnShE76SIP85W4dI\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"put":{"summary":"Replace all attributes of this Group","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of this group.","type":"integer"},{"name":"Object256","in":"body","schema":{"$ref":"#/definitions/Object256"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object254"}}},"x-examples":null,"x-deprecation-warning":null},"patch":{"summary":"Update some attributes of this Group","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of this group.","type":"integer"},{"name":"Object257","in":"body","schema":{"$ref":"#/definitions/Object257"},"required":false}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object254"}}},"x-examples":[{"resource":"Groups","resource_explanation":null,"http_method":"PATCH","route":"http://api.civis.test/groups/:shared_group_id","description":"Update a group's name","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"PATCH","request_path":"http://api.civis.test/groups/83","request_body":"{\n \"name\": \"Friendship\"\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer ORJBLXUcyXr4t4HjkeRuSZPdWHDhABqlxH4F9K4V_-I","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 83,\n \"name\": \"Friendship\",\n \"createdAt\": \"2025-02-26T17:48:23.000Z\",\n \"updatedAt\": \"2025-02-26T17:48:24.000Z\",\n \"description\": null,\n \"slug\": \"group_h\",\n \"organizationId\": 12,\n \"organizationName\": \"Organization 7\",\n \"memberCount\": 1,\n \"totalMemberCount\": 1,\n \"defaultOtpRequiredForLogin\": null,\n \"roleIds\": [\n\n ],\n \"defaultTimeZone\": null,\n \"defaultJobsLabel\": null,\n \"defaultNotebooksLabel\": null,\n \"defaultServicesLabel\": null,\n \"lastUpdatedById\": 9,\n \"createdById\": null,\n \"members\": [\n {\n \"id\": 9,\n \"name\": \"User devuserfactory4 4\",\n \"username\": \"devuserfactory4\",\n \"initials\": \"UD\",\n \"online\": null,\n \"email\": \"devuserfactory44user@localhost.test\",\n \"primaryGroupId\": 30,\n \"active\": true\n }\n ]\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"471789e15a0f56ec89fa953aea82f44f\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"8b5c460d-9be4-444a-a4aa-888b58640518","X-Runtime":"0.132031","Content-Length":"618"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/groups/83\" -d '{\"name\":\"Friendship\"}' -X PATCH \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer ORJBLXUcyXr4t4HjkeRuSZPdWHDhABqlxH4F9K4V_-I\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Groups","resource_explanation":null,"http_method":"PATCH","route":"http://api.civis.test/groups/:shared_group_id","description":"Update a group's description","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"PATCH","request_path":"http://api.civis.test/groups/96","request_body":"{\n \"description\": \"Wonderful new description\"\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer BtD8FyVzQ5goaAJNwSiZHmyMQeiNSDvZZvOSsfdRGT8","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 96,\n \"name\": \"Shared Read\",\n \"createdAt\": \"2025-02-26T17:48:26.000Z\",\n \"updatedAt\": \"2025-02-26T17:48:27.000Z\",\n \"description\": \"Wonderful new description\",\n \"slug\": \"group_j\",\n \"organizationId\": 14,\n \"organizationName\": \"Organization 9\",\n \"memberCount\": 1,\n \"totalMemberCount\": 1,\n \"defaultOtpRequiredForLogin\": null,\n \"roleIds\": [\n\n ],\n \"defaultTimeZone\": null,\n \"defaultJobsLabel\": null,\n \"defaultNotebooksLabel\": null,\n \"defaultServicesLabel\": null,\n \"lastUpdatedById\": 10,\n \"createdById\": null,\n \"members\": [\n {\n \"id\": 10,\n \"name\": \"User devuserfactory5 5\",\n \"username\": \"devuserfactory5\",\n \"initials\": \"UD\",\n \"online\": null,\n \"email\": \"devuserfactory55user@localhost.test\",\n \"primaryGroupId\": 30,\n \"active\": true\n }\n ]\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"4f137bdedbafbbe4eb9c0d7a03a2fd5d\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"93b250f2-cd53-42d6-bb8f-d447f0708c30","X-Runtime":"0.097236","Content-Length":"644"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/groups/96\" -d '{\"description\":\"Wonderful new description\"}' -X PATCH \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer BtD8FyVzQ5goaAJNwSiZHmyMQeiNSDvZZvOSsfdRGT8\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"delete":{"summary":"Delete a Group (deprecated)","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":[{"resource":"Groups","resource_explanation":null,"http_method":"DELETE","route":"http://api.civis.test/groups/:shared_group_id","description":"Delete a group","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"DELETE","request_path":"http://api.civis.test/groups/109","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer QPKRFGJAEyWDS5VGICyS2ezNGeHzmrgrJ6OaxTdcCdY","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":204,"response_status_text":"No Content","response_body":null,"response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"3fb35005-e416-4134-af29-cea6412e43b2","X-Runtime":"0.113966"},"response_content_type":null,"curl":"curl \"api.civis.testhttp://api.civis.test/groups/109\" -d '' -X DELETE \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer QPKRFGJAEyWDS5VGICyS2ezNGeHzmrgrJ6OaxTdcCdY\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/groups/{id}/shares":{"get":{"summary":"List users and groups permissioned on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object9"}}}},"x-examples":null,"x-deprecation-warning":null}},"/groups/{id}/shares/users":{"put":{"summary":"Set the permissions users have on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"Object258","in":"body","schema":{"$ref":"#/definitions/Object258"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object9"}}},"x-examples":null,"x-deprecation-warning":null}},"/groups/{id}/shares/users/{user_id}":{"delete":{"summary":"Revoke the permissions a user has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"user_id","in":"path","required":true,"description":"The ID of the user.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/groups/{id}/shares/groups":{"put":{"summary":"Set the permissions groups has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"Object259","in":"body","schema":{"$ref":"#/definitions/Object259"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object9"}}},"x-examples":null,"x-deprecation-warning":null}},"/groups/{id}/shares/groups/{group_id}":{"delete":{"summary":"Revoke the permissions a group has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"group_id","in":"path","required":true,"description":"The ID of the group.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/groups/{id}/members/{user_id}":{"put":{"summary":"Add a user to a group","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the group.","type":"integer"},{"name":"user_id","in":"path","required":true,"description":"The ID of the user.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object254"}}},"x-examples":[{"resource":"Groups","resource_explanation":null,"http_method":"PUT","route":"http://api.civis.test/groups/:group_id/members/:user_id","description":"Add a user to a group","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"PUT","request_path":"http://api.civis.test/groups/124/members/13","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer t_Ue9ZuT25XVYD6TaCdYTmZMerVCg5kEpqJs5t3lj28","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 124,\n \"name\": \"Group 1\",\n \"createdAt\": \"2025-02-26T17:48:30.000Z\",\n \"updatedAt\": \"2025-02-26T17:48:30.000Z\",\n \"description\": null,\n \"slug\": \"group_n\",\n \"organizationId\": 18,\n \"organizationName\": \"Organization 13\",\n \"memberCount\": 1,\n \"totalMemberCount\": 1,\n \"defaultOtpRequiredForLogin\": null,\n \"roleIds\": [\n\n ],\n \"defaultTimeZone\": null,\n \"defaultJobsLabel\": null,\n \"defaultNotebooksLabel\": null,\n \"defaultServicesLabel\": null,\n \"lastUpdatedById\": null,\n \"createdById\": null,\n \"members\": [\n {\n \"id\": 13,\n \"name\": \"User devuserfactory7 7\",\n \"username\": \"devuserfactory7\",\n \"initials\": \"UD\",\n \"online\": null,\n \"email\": \"devuserfactory77user@localhost.test\",\n \"primaryGroupId\": 30,\n \"active\": true\n }\n ]\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"27245b2b99d348a44a7d98bf6d002d60\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"92dd88aa-0fd6-4c3b-bbbc-9389ff277ece","X-Runtime":"0.048870","Content-Length":"621"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/groups/124/members/13\" -d '' -X PUT \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer t_Ue9ZuT25XVYD6TaCdYTmZMerVCg5kEpqJs5t3lj28\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"delete":{"summary":"Remove a user from a group","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the group.","type":"integer"},{"name":"user_id","in":"path","required":true,"description":"The ID of the user.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":[{"resource":"Groups","resource_explanation":null,"http_method":"DELETE","route":"http://api.civis.test/groups/:group_id/members/:user_id","description":"Remove a user from a group","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"DELETE","request_path":"http://api.civis.test/groups/132/members/15","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer lM8X-Ocn907B3r3vxhC4oHxpO7LnnkDgEIQLukYn0LQ","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":204,"response_status_text":"No Content","response_body":null,"response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"e8535034-a6c4-4e5c-8316-5569ddf98f21","X-Runtime":"0.053456"},"response_content_type":null,"curl":"curl \"api.civis.testhttp://api.civis.test/groups/132/members/15\" -d '' -X DELETE \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer lM8X-Ocn907B3r3vxhC4oHxpO7LnnkDgEIQLukYn0LQ\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/groups/{id}/child_groups":{"get":{"summary":"Get child groups of this group","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of this group.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object260"}}},"x-examples":[{"resource":"Groups","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/groups/:group_id/child_groups","description":"Lists groups that this group has permissions on","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/groups/139/child_groups","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer J_0uMW4aGhFsh6pPIcvq79N-nbm8xHyYOPkM-2GM2iA","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"manageable\": [\n {\n \"id\": 145,\n \"name\": \"Group 4\"\n }\n ],\n \"writeable\": [\n {\n \"id\": 151,\n \"name\": \"Group 5\"\n }\n ],\n \"readable\": [\n {\n \"id\": 157,\n \"name\": \"Group 6\"\n }\n ]\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"d18e81098a070aaf4abbb458d5b022bf\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"5e0d3c3c-e31a-4983-91b2-bc694d41d73c","X-Runtime":"0.060658","Content-Length":"127"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/groups/139/child_groups\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer J_0uMW4aGhFsh6pPIcvq79N-nbm8xHyYOPkM-2GM2iA\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/imports/{id}/shares":{"get":{"summary":"List users and groups permissioned on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object9"}}}},"x-examples":null,"x-deprecation-warning":null}},"/imports/{id}/shares/users":{"put":{"summary":"Set the permissions users have on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"Object262","in":"body","schema":{"$ref":"#/definitions/Object262"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object9"}}},"x-examples":null,"x-deprecation-warning":null}},"/imports/{id}/shares/users/{user_id}":{"delete":{"summary":"Revoke the permissions a user has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"user_id","in":"path","required":true,"description":"The ID of the user.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/imports/{id}/shares/groups":{"put":{"summary":"Set the permissions groups has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"Object263","in":"body","schema":{"$ref":"#/definitions/Object263"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object9"}}},"x-examples":null,"x-deprecation-warning":null}},"/imports/{id}/shares/groups/{group_id}":{"delete":{"summary":"Revoke the permissions a group has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"group_id","in":"path","required":true,"description":"The ID of the group.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/imports/{id}/dependencies":{"get":{"summary":"List dependent objects for this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"user_id","in":"query","required":false,"description":"ID of target user","type":"integer"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object15"}}}},"x-examples":null,"x-deprecation-warning":null}},"/imports/{id}/transfer":{"put":{"summary":"Transfer ownership of this object to another user","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"Object264","in":"body","schema":{"$ref":"#/definitions/Object264"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object17"}}},"x-examples":null,"x-deprecation-warning":null}},"/imports/{id}/projects":{"get":{"summary":"List the projects an Import belongs to","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Import.","type":"integer"},{"name":"hidden","in":"query","required":false,"description":"If specified to be true, returns hidden items. Defaults to false, returning non-hidden items.","type":"boolean"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object85"}}}},"x-examples":null,"x-deprecation-warning":null}},"/imports/{id}/projects/{project_id}":{"put":{"summary":"Add an Import to a project","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Import.","type":"integer"},{"name":"project_id","in":"path","required":true,"description":"The ID of the project.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null},"delete":{"summary":"Remove an Import from a project","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Import.","type":"integer"},{"name":"project_id","in":"path","required":true,"description":"The ID of the project.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/imports/{id}/archive":{"put":{"summary":"Update the archive status of this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the object.","type":"integer"},{"name":"Object265","in":"body","schema":{"$ref":"#/definitions/Object265"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object266"}}},"x-examples":null,"x-deprecation-warning":null}},"/imports/":{"get":{"summary":"List Imports","description":null,"deprecated":false,"parameters":[{"name":"type","in":"query","required":false,"description":"If specified, return imports of these types. It accepts a comma-separated list, possible values are Dbsync, AutoImport, GdocImport, and GdocExport.","type":"string"},{"name":"destination","in":"query","required":false,"description":"If specified, returns imports with one of these destinations. It accepts a comma-separated list of remote host ids.","type":"string"},{"name":"source","in":"query","required":false,"description":"If specified, returns imports with one of these sources. It accepts a comma-separated list of remote host ids. 'Dbsync' must be specified for 'type'.","type":"string"},{"name":"status","in":"query","required":false,"description":"If specified, returns imports with one of these statuses. It accepts a comma-separated list, possible values are 'running', 'failed', 'succeeded', 'idle', 'scheduled'.","type":"string"},{"name":"author","in":"query","required":false,"description":"If specified, return items from any of these authors. It accepts a comma-separated list of user IDs.","type":"string"},{"name":"hidden","in":"query","required":false,"description":"If specified to be true, returns hidden items. Defaults to false, returning non-hidden items.","type":"boolean"},{"name":"archived","in":"query","required":false,"description":"The archival status of the requested item(s).","type":"string"},{"name":"limit","in":"query","required":false,"description":"Number of results to return. Defaults to 20. Maximum allowed is 50.","type":"integer"},{"name":"page_num","in":"query","required":false,"description":"Page number of the results to return. Defaults to the first page, 1.","type":"integer"},{"name":"order","in":"query","required":false,"description":"The field on which to order the result set. Defaults to updated_at. Must be one of: updated_at, name, created_at, last_run.updated_at.","type":"string"},{"name":"order_dir","in":"query","required":false,"description":"Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc.","type":"string"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object277"}}}},"x-examples":[{"resource":"Imports","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/imports","description":"List all imports for a user","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/imports","request_body":null,"request_headers":{"Content-Type":"application/json","Authorization":"Bearer 18nRfglG_NmAp5JqYBwwq2FWUXMBj5PRmJpDoKR4LMs","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"name\": \"Import #1899\",\n \"syncType\": \"AutoImport\",\n \"source\": null,\n \"destination\": {\n \"remoteHostId\": 259,\n \"credentialId\": 503,\n \"additionalCredentials\": [\n\n ],\n \"name\": \"redshift-10177\"\n },\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n },\n \"id\": 1899,\n \"isOutbound\": false,\n \"jobType\": \"JobTypes::Import\",\n \"state\": \"idle\",\n \"createdAt\": \"2023-07-18T18:42:30.000Z\",\n \"updatedAt\": \"2023-07-18T18:42:30.000Z\",\n \"lastRun\": null,\n \"user\": {\n \"id\": 2214,\n \"name\": \"User devuserfactory1651 1649\",\n \"username\": \"devuserfactory1651\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"timeZone\": \"America/Chicago\",\n \"archived\": false\n },\n {\n \"name\": \"Import #1880\",\n \"syncType\": \"Dbsync\",\n \"source\": {\n \"remoteHostId\": 251,\n \"credentialId\": 489,\n \"additionalCredentials\": [\n\n ],\n \"name\": \"redshift-10171\"\n },\n \"destination\": {\n \"remoteHostId\": 252,\n \"credentialId\": 491,\n \"additionalCredentials\": [\n\n ],\n \"name\": \"redshift-10172\"\n },\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n },\n \"id\": 1880,\n \"isOutbound\": false,\n \"jobType\": \"JobTypes::Import\",\n \"state\": \"idle\",\n \"createdAt\": \"2023-07-18T18:42:29.000Z\",\n \"updatedAt\": \"2023-07-18T18:37:28.000Z\",\n \"lastRun\": null,\n \"user\": {\n \"id\": 2215,\n \"name\": \"User devuserfactory1652 1650\",\n \"username\": \"devuserfactory1652\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"timeZone\": \"America/Chicago\",\n \"archived\": false\n },\n {\n \"name\": \"Import #1886\",\n \"syncType\": \"Dbsync\",\n \"source\": {\n \"remoteHostId\": 253,\n \"credentialId\": 493,\n \"additionalCredentials\": [\n\n ],\n \"name\": \"redshift-10173\"\n },\n \"destination\": {\n \"remoteHostId\": 254,\n \"credentialId\": 495,\n \"additionalCredentials\": [\n\n ],\n \"name\": \"redshift-10174\"\n },\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n },\n \"id\": 1886,\n \"isOutbound\": false,\n \"jobType\": \"JobTypes::Import\",\n \"state\": \"running\",\n \"createdAt\": \"2023-07-18T18:42:29.000Z\",\n \"updatedAt\": \"2023-07-18T18:32:29.000Z\",\n \"lastRun\": {\n \"id\": 209,\n \"state\": \"running\",\n \"createdAt\": \"2023-07-18T18:42:29.000Z\",\n \"startedAt\": null,\n \"finishedAt\": null,\n \"error\": null\n },\n \"user\": {\n \"id\": 2215,\n \"name\": \"User devuserfactory1652 1650\",\n \"username\": \"devuserfactory1652\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"timeZone\": \"America/Chicago\",\n \"archived\": false\n },\n {\n \"name\": \"Import #1891\",\n \"syncType\": \"GdocImport\",\n \"source\": {\n \"remoteHostId\": 257,\n \"credentialId\": 499,\n \"additionalCredentials\": [\n\n ],\n \"name\": \"redshift-10175\"\n },\n \"destination\": {\n \"remoteHostId\": 258,\n \"credentialId\": 501,\n \"additionalCredentials\": [\n\n ],\n \"name\": \"redshift-10176\"\n },\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n },\n \"id\": 1891,\n \"isOutbound\": false,\n \"jobType\": \"JobTypes::Import\",\n \"state\": \"queued\",\n \"createdAt\": \"2023-07-18T18:42:29.000Z\",\n \"updatedAt\": \"2023-07-18T18:27:29.000Z\",\n \"lastRun\": {\n \"id\": 210,\n \"state\": \"queued\",\n \"createdAt\": \"2023-07-18T18:42:29.000Z\",\n \"startedAt\": null,\n \"finishedAt\": null,\n \"error\": null\n },\n \"user\": {\n \"id\": 2215,\n \"name\": \"User devuserfactory1652 1650\",\n \"username\": \"devuserfactory1652\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"timeZone\": \"America/Chicago\",\n \"archived\": false\n },\n {\n \"name\": \"Script #1894\",\n \"syncType\": null,\n \"source\": null,\n \"destination\": null,\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n },\n \"id\": 1894,\n \"isOutbound\": false,\n \"jobType\": \"JobTypes::ContainerDocker\",\n \"state\": \"idle\",\n \"createdAt\": \"2023-07-18T18:42:29.000Z\",\n \"updatedAt\": \"2023-07-18T18:22:29.000Z\",\n \"lastRun\": null,\n \"user\": {\n \"id\": 2215,\n \"name\": \"User devuserfactory1652 1650\",\n \"username\": \"devuserfactory1652\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"timeZone\": \"America/Chicago\",\n \"archived\": false\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","X-Pagination-Per-Page":"20","Access-Control-Expose-Headers":"X-Pagination-Per-Page, X-Pagination-Current-Page, X-Pagination-Total-Pages, X-Pagination-Total-Entries","X-Pagination-Current-Page":"1","X-Pagination-Total-Pages":"1","X-Pagination-Total-Entries":"5","Content-Type":"application/json; charset=utf-8","ETag":"W/\"3578097c21ff8498410ff874762197d1\"","X-Request-Id":"6aa0e170-f0e5-4dbd-9a8b-e9d35c69e179","X-Runtime":"0.060477","Content-Length":"3607"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/imports\" -X GET \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer 18nRfglG_NmAp5JqYBwwq2FWUXMBj5PRmJpDoKR4LMs\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"post":{"summary":"Create a new import configuration","description":"Imports have a variety of types and consist of one or more syncs. Once you've created your import, use the post syncs endpoint to create new syncs for it. Make sure to set attributes which are compatible with the type of import you're using, either Dbsync, AutoImport, GdocImport or GdocExport.","deprecated":false,"parameters":[{"name":"Object278","in":"body","schema":{"$ref":"#/definitions/Object278"},"required":true}],"responses":{"201":{"description":"success","schema":{"$ref":"#/definitions/Object266"}}},"x-examples":null,"x-deprecation-warning":null}},"/imports/files":{"post":{"summary":"Initate an import of a tabular file into the platform","description":"Importing a tabular file, such as a CSV, begins with this endpoint. \nCompatible files must be comma, tab, or pipe-delimited. \nThey may be uncompressed, gzipped or zipped if the archive contains a single file. \n\nThis endpoint returns two URIs which must be used to complete the import. \nThe `uploadUri` is used to upload the file you wish to import. By default it expects the file contents \nin the body of a PUT request. Some examples of this usage are:\n\n* Python requests:\n\n ```\n requests.put(, data=open('', 'rb'))\n ```\n* curl:\n\n ```\n curl --request PUT --upload-file \n ```\n\nIf you set `multipart: true`, `uploadUri` will expect a `multipart/form-data` POST request \nincluding the attached `uploadFields` plus a `file` field (in this order):\n\n* Browser (AJAX form submission):\n\n ```\n var data = new FormData();\n _.each(, (value, field) => data.append(field, value));\n data.append(\"file\", fileInput.files[0]);\n request.post(, { body: data });\n ```\n\nOnce the upload is complete, the `runUri` field may then be used to \ncomplete the import of the uploaded tabular file.","deprecated":false,"parameters":[{"name":"Object280","in":"body","schema":{"$ref":"#/definitions/Object280"},"required":true}],"responses":{"201":{"description":"success","schema":{"$ref":"#/definitions/Object281"}}},"x-examples":[{"resource":"Imports","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/imports/files","description":"Initiating a file uploading","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/imports/files","request_body":"{\n \"schema\": \"table_schema\",\n \"name\": \"table_name\",\n \"distkey\": \"distkey\",\n \"sortkey1\": \"sort_1\",\n \"sortkey2\": \"sort_2\",\n \"existing_table_rows\": \"append\",\n \"remote_host_id\": 309,\n \"credential_id\": 616\n}","request_headers":{"Content-Type":"application/json","Authorization":"Bearer j6E6Vjb0dRVr2yPKgICZuPc8BUuxQegeL8yxaP64i94","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":201,"response_status_text":"Created","response_body":"{\n \"id\": 2003,\n \"uploadUri\": \"upload_uri\",\n \"runUri\": \"http://api.civis.test/imports/files/2003/runs\",\n \"uploadFields\": {\n }\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"f341c72b876dc30aaaf9a0f5825d7086\"","X-Request-Id":"upload_key","X-Runtime":"0.140196","Content-Length":"111"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/imports/files\" -d '{\"schema\":\"table_schema\",\"name\":\"table_name\",\"distkey\":\"distkey\",\"sortkey1\":\"sort_1\",\"sortkey2\":\"sort_2\",\"existing_table_rows\":\"append\",\"remote_host_id\":309,\"credential_id\":616}' -X POST \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer j6E6Vjb0dRVr2yPKgICZuPc8BUuxQegeL8yxaP64i94\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Imports","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/imports/files","description":"Initiating a multipart file uploading","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/imports/files","request_body":"{\n \"schema\": \"table_schema\",\n \"name\": \"table_name\",\n \"distkey\": \"distkey\",\n \"sortkey1\": \"sort_1\",\n \"sortkey2\": \"sort_2\",\n \"existing_table_rows\": \"append\",\n \"remote_host_id\": 310,\n \"credential_id\": 619,\n \"multipart\": true\n}","request_headers":{"Content-Type":"application/json","Authorization":"Bearer HW4pssfccePALY1hpLORMFP8k_FV7q1hCc8_RbVV-9o","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":201,"response_status_text":"Created","response_body":"{\n \"id\": 2005,\n \"uploadUri\": \"upload_uri\",\n \"runUri\": \"http://api.civis.test/imports/files/2005/runs\",\n \"uploadFields\": {\n \"aws_field1\": \"foo\",\n \"aws_field2\": \"bar\"\n }\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"e6a5ce26e5cc5967d27bdd14b5cecfbe\"","X-Request-Id":"upload_key","X-Runtime":"0.153413","Content-Length":"148"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/imports/files\" -d '{\"schema\":\"table_schema\",\"name\":\"table_name\",\"distkey\":\"distkey\",\"sortkey1\":\"sort_1\",\"sortkey2\":\"sort_2\",\"existing_table_rows\":\"append\",\"remote_host_id\":310,\"credential_id\":619,\"multipart\":true}' -X POST \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer HW4pssfccePALY1hpLORMFP8k_FV7q1hCc8_RbVV-9o\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/imports/files/{id}/runs":{"post":{"summary":"Start a run","description":"Start a run and provide a URI for checking its status. The response will provide a 'Location' header which will contain a URI which may be polled to monitor the status of the run.","deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Import job.","type":"integer"}],"responses":{"202":{"description":"success","schema":{"$ref":"#/definitions/Object282"}}},"x-examples":null,"x-deprecation-warning":null},"get":{"summary":"List runs for the given Import job","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Import job.","type":"integer"},{"name":"limit","in":"query","required":false,"description":"Number of results to return. Defaults to 20. Maximum allowed is 100.","type":"integer"},{"name":"page_num","in":"query","required":false,"description":"Page number of the results to return. Defaults to the first page, 1.","type":"integer"},{"name":"order","in":"query","required":false,"description":"The field on which to order the result set. Defaults to id. Must be one of: id.","type":"string"},{"name":"order_dir","in":"query","required":false,"description":"Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc.","type":"string"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object282"}}}},"x-examples":null,"x-deprecation-warning":null}},"/imports/files/{id}/runs/{run_id}":{"get":{"summary":"Check status of a run","description":"View the status of a run. This endpoint may be polled to monitor the status of the run. When the 'state' field is no longer 'queued' or 'running' the run has reached its final state.","deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Import job.","type":"integer"},{"name":"run_id","in":"path","required":true,"description":"The ID of the run.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object282"}}},"x-examples":null,"x-deprecation-warning":null},"delete":{"summary":"Cancel a run","description":"Cancel a currently active run.","deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Import job.","type":"integer"},{"name":"run_id","in":"path","required":true,"description":"The ID of the run.","type":"integer"}],"responses":{"202":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/imports/files/{id}/runs/{run_id}/logs":{"get":{"summary":"Get the logs for a run","description":"Get the logs for a run.","deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Import job.","type":"integer"},{"name":"run_id","in":"path","required":true,"description":"The ID of the run.","type":"integer"},{"name":"last_id","in":"query","required":false,"description":"The ID of the last log message received. Log entries with this ID value or lower will be omitted.Logs are sorted by ID if this value is provided, and are otherwise sorted by createdAt.","type":"integer"},{"name":"limit","in":"query","required":false,"description":"The maximum number of log messages to return. Default of 10000.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object117"}}}},"x-examples":null,"x-deprecation-warning":null}},"/imports/{id}/runs/{run_id}/logs":{"get":{"summary":"Get the logs for a run","description":"Get the logs for a run.","deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the import job.","type":"integer"},{"name":"run_id","in":"path","required":true,"description":"The ID of the run.","type":"integer"},{"name":"last_id","in":"query","required":false,"description":"The ID of the last log message received. Log entries with this ID value or lower will be omitted.Logs are sorted by ID if this value is provided, and are otherwise sorted by createdAt.","type":"integer"},{"name":"limit","in":"query","required":false,"description":"The maximum number of log messages to return. Default of 10000.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object117"}}}},"x-examples":null,"x-deprecation-warning":null}},"/imports/files/csv":{"post":{"summary":"Create a CSV Import","description":null,"deprecated":false,"parameters":[{"name":"Object283","in":"body","schema":{"$ref":"#/definitions/Object283"},"required":true}],"responses":{"201":{"description":"success","schema":{"$ref":"#/definitions/Object289"}}},"x-examples":[{"resource":"Imports","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/imports/files/csv","description":"Create a CSV file import with Civis file source","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/imports/files/csv","request_body":"{\n \"source\": {\n \"file_ids\": [\n 46\n ]\n },\n \"destination\": {\n \"schema\": \"public\",\n \"table\": \"muppets\",\n \"remote_host_id\": 311,\n \"credential_id\": 622,\n \"primary_keys\": [\n \"muppet_name\"\n ],\n \"last_modified_keys\": [\n \"species\"\n ]\n },\n \"first_row_is_header\": true,\n \"max_errors\": 42,\n \"loosen_types\": true,\n \"redshift_destination_options\": {\n \"distkey\": \"species\",\n \"sortkeys\": [\n \"muppet_name\"\n ]\n },\n \"table_columns\": [\n {\n \"name\": \"muppet_name\",\n \"sql_type\": \"varchar(30)\"\n },\n {\n \"name\": \"species\",\n \"sql_type\": null\n }\n ]\n}","request_headers":{"Content-Type":"application/json","Authorization":"Bearer TRs17wuHhGfrucWLCMoKFY7LnRlJP9ZiQpeOtrnDWnY","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":201,"response_status_text":"Created","response_body":"{\n \"id\": 2007,\n \"name\": \"CSV Import #2007\",\n \"source\": {\n \"fileIds\": [\n 46\n ],\n \"storagePath\": {\n \"storageHostId\": null,\n \"credentialId\": null,\n \"filePaths\": [\n\n ]\n }\n },\n \"destination\": {\n \"schema\": \"public\",\n \"table\": \"muppets\",\n \"remoteHostId\": 311,\n \"credentialId\": 622,\n \"primaryKeys\": [\n \"muppet_name\"\n ],\n \"lastModifiedKeys\": [\n \"species\"\n ]\n },\n \"firstRowIsHeader\": true,\n \"columnDelimiter\": \"comma\",\n \"escaped\": false,\n \"compression\": \"none\",\n \"existingTableRows\": \"fail\",\n \"maxErrors\": 42,\n \"tableColumns\": [\n {\n \"name\": \"muppet_name\",\n \"sqlType\": \"varchar(30)\"\n },\n {\n \"name\": \"species\",\n \"sqlType\": null\n }\n ],\n \"loosenTypes\": true,\n \"execution\": \"delayed\",\n \"redshiftDestinationOptions\": {\n \"diststyle\": \"key\",\n \"distkey\": \"species\",\n \"sortkeys\": [\n \"muppet_name\"\n ]\n },\n \"hidden\": false,\n \"myPermissionLevel\": \"manage\"\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"91fc3eac3ca09af7dfec4c9ae27dc14a\"","X-Request-Id":"da67d8e2-4fb0-46db-9617-82f128c1d0ce","X-Runtime":"0.137674","Content-Length":"694"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/imports/files/csv\" -d '{\"source\":{\"file_ids\":[46]},\"destination\":{\"schema\":\"public\",\"table\":\"muppets\",\"remote_host_id\":311,\"credential_id\":622,\"primary_keys\":[\"muppet_name\"],\"last_modified_keys\":[\"species\"]},\"first_row_is_header\":true,\"max_errors\":42,\"loosen_types\":true,\"redshift_destination_options\":{\"distkey\":\"species\",\"sortkeys\":[\"muppet_name\"]},\"table_columns\":[{\"name\":\"muppet_name\",\"sql_type\":\"varchar(30)\"},{\"name\":\"species\",\"sql_type\":null}]}' -X POST \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer TRs17wuHhGfrucWLCMoKFY7LnRlJP9ZiQpeOtrnDWnY\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Imports","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/imports/files/csv","description":"Create a CSV file import with storage source","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/imports/files/csv","request_body":"{\n \"source\": {\n \"storage_path\": {\n \"storage_host_id\": 312,\n \"credential_id\": 624,\n \"file_paths\": [\n \"test_path/muppets.csv\"\n ]\n }\n },\n \"destination\": {\n \"schema\": \"public\",\n \"table\": \"muppets\",\n \"remote_host_id\": 313,\n \"credential_id\": 626,\n \"primary_keys\": [\n \"muppet_name\"\n ],\n \"last_modified_keys\": [\n \"species\"\n ]\n },\n \"first_row_is_header\": true,\n \"max_errors\": 42,\n \"redshift_destination_options\": {\n \"distkey\": \"species\",\n \"sortkeys\": [\n \"muppet_name\"\n ]\n },\n \"table_columns\": [\n {\n \"name\": \"muppet_name\",\n \"sql_type\": \"varchar(30)\"\n },\n {\n \"name\": \"species\",\n \"sql_type\": null\n }\n ]\n}","request_headers":{"Content-Type":"application/json","Authorization":"Bearer 1Rj74avQr8ccy7pmUjq4U3ieWYpnQvGGhmt83s_fXh0","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":201,"response_status_text":"Created","response_body":"{\n \"id\": 2008,\n \"name\": \"CSV Import #2008\",\n \"source\": {\n \"fileIds\": [\n\n ],\n \"storagePath\": {\n \"storageHostId\": 312,\n \"credentialId\": 624,\n \"filePaths\": [\n \"test_path/muppets.csv\"\n ]\n }\n },\n \"destination\": {\n \"schema\": \"public\",\n \"table\": \"muppets\",\n \"remoteHostId\": 313,\n \"credentialId\": 626,\n \"primaryKeys\": [\n \"muppet_name\"\n ],\n \"lastModifiedKeys\": [\n \"species\"\n ]\n },\n \"firstRowIsHeader\": true,\n \"columnDelimiter\": \"comma\",\n \"escaped\": false,\n \"compression\": \"none\",\n \"existingTableRows\": \"fail\",\n \"maxErrors\": 42,\n \"tableColumns\": [\n {\n \"name\": \"muppet_name\",\n \"sqlType\": \"varchar(30)\"\n },\n {\n \"name\": \"species\",\n \"sqlType\": null\n }\n ],\n \"loosenTypes\": false,\n \"execution\": \"delayed\",\n \"redshiftDestinationOptions\": {\n \"diststyle\": \"key\",\n \"distkey\": \"species\",\n \"sortkeys\": [\n \"muppet_name\"\n ]\n },\n \"hidden\": false,\n \"myPermissionLevel\": \"manage\"\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"684a1f99ba0c0c61c976354363cefed3\"","X-Request-Id":"262678f8-be17-403f-877d-892cf1b1fbd2","X-Runtime":"0.142158","Content-Length":"714"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/imports/files/csv\" -d '{\"source\":{\"storage_path\":{\"storage_host_id\":312,\"credential_id\":624,\"file_paths\":[\"test_path/muppets.csv\"]}},\"destination\":{\"schema\":\"public\",\"table\":\"muppets\",\"remote_host_id\":313,\"credential_id\":626,\"primary_keys\":[\"muppet_name\"],\"last_modified_keys\":[\"species\"]},\"first_row_is_header\":true,\"max_errors\":42,\"redshift_destination_options\":{\"distkey\":\"species\",\"sortkeys\":[\"muppet_name\"]},\"table_columns\":[{\"name\":\"muppet_name\",\"sql_type\":\"varchar(30)\"},{\"name\":\"species\",\"sql_type\":null}]}' -X POST \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer 1Rj74avQr8ccy7pmUjq4U3ieWYpnQvGGhmt83s_fXh0\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/imports/files/csv/{id}":{"get":{"summary":"Get a CSV Import","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object289"}}},"x-examples":null,"x-deprecation-warning":null},"put":{"summary":"Replace all attributes of this CSV Import","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID for the import.","type":"integer"},{"name":"Object295","in":"body","schema":{"$ref":"#/definitions/Object295"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object289"}}},"x-examples":null,"x-deprecation-warning":null},"patch":{"summary":"Update some attributes of this CSV Import","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID for the import.","type":"integer"},{"name":"Object296","in":"body","schema":{"$ref":"#/definitions/Object296"},"required":false}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object289"}}},"x-examples":[{"resource":"Imports","resource_explanation":null,"http_method":"PATCH","route":"http://api.civis.test/imports/files/csv/:id","description":"Update a CSV file import","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"PATCH","request_path":"http://api.civis.test/imports/files/csv/2011","request_body":"{\n \"table_columns\": [\n {\n \"name\": \"muppet_name\",\n \"sql_type\": \"varchar(30)\"\n },\n {\n \"name\": \"species\",\n \"sql_type\": null\n },\n {\n \"name\": \"performer\",\n \"sql_type\": \"varchar(30)\"\n }\n ],\n \"existing_table_rows\": \"drop\"\n}","request_headers":{"Content-Type":"application/json","Authorization":"Bearer uDlK78qJw-s9Q0kWVmxspuLBwH2K9oCXyC7FCyODTIw","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 2011,\n \"name\": \"CSV Import #2011\",\n \"source\": {\n \"fileIds\": [\n 49\n ],\n \"storagePath\": {\n \"storageHostId\": null,\n \"credentialId\": null,\n \"filePaths\": [\n\n ]\n }\n },\n \"destination\": {\n \"schema\": \"my_schema\",\n \"table\": \"my_table\",\n \"remoteHostId\": 314,\n \"credentialId\": 629,\n \"primaryKeys\": [\n\n ],\n \"lastModifiedKeys\": [\n\n ]\n },\n \"firstRowIsHeader\": true,\n \"columnDelimiter\": \"comma\",\n \"escaped\": false,\n \"compression\": \"gzip\",\n \"existingTableRows\": \"drop\",\n \"maxErrors\": null,\n \"tableColumns\": [\n {\n \"name\": \"muppet_name\",\n \"sqlType\": \"varchar(30)\"\n },\n {\n \"name\": \"species\",\n \"sqlType\": null\n },\n {\n \"name\": \"performer\",\n \"sqlType\": \"varchar(30)\"\n }\n ],\n \"loosenTypes\": false,\n \"execution\": \"delayed\",\n \"redshiftDestinationOptions\": {\n \"diststyle\": \"key\",\n \"distkey\": \"mydist\",\n \"sortkeys\": [\n \"mysort\",\n \"anothersort\"\n ]\n },\n \"hidden\": false,\n \"myPermissionLevel\": \"manage\"\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"4a9d346477628ff80df3625bf412ffde\"","X-Request-Id":"00a41806-48a3-428d-adb5-0e0b8f335e80","X-Runtime":"0.203203","Content-Length":"732"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/imports/files/csv/2011\" -d '{\"table_columns\":[{\"name\":\"muppet_name\",\"sql_type\":\"varchar(30)\"},{\"name\":\"species\",\"sql_type\":null},{\"name\":\"performer\",\"sql_type\":\"varchar(30)\"}],\"existing_table_rows\":\"drop\"}' -X PATCH \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer uDlK78qJw-s9Q0kWVmxspuLBwH2K9oCXyC7FCyODTIw\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"delete":{"summary":"Archive a CSV Import (deprecated, use archiving endpoints instead)","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/imports/files/csv/{id}/archive":{"put":{"summary":"Update the archive status of this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the object.","type":"integer"},{"name":"Object299","in":"body","schema":{"$ref":"#/definitions/Object299"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object289"}}},"x-examples":null,"x-deprecation-warning":null}},"/imports/files/csv/{id}/runs":{"post":{"summary":"Start a run","description":"Start a run and provide a URI for checking its status. The response will provide a 'Location' header which will contain a URI which may be polled to monitor the status of the run.","deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the CSV Import job.","type":"integer"}],"responses":{"202":{"description":"success","schema":{"$ref":"#/definitions/Object300"}}},"x-examples":[{"resource":"Imports","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/imports/files/csv/:id/runs","description":"Run an import","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/imports/files/csv/2014/runs","request_body":null,"request_headers":{"Content-Type":"application/json","Authorization":"Bearer NuyT3qm53MbOjSMNU9pcwOkX2JVcEFDTzLyagZNhecU","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":202,"response_status_text":"Accepted","response_body":"{\n \"id\": 215,\n \"csvImportId\": 2014,\n \"state\": \"queued\",\n \"isCancelRequested\": false,\n \"createdAt\": \"2023-07-18T18:42:40.000Z\",\n \"startedAt\": null,\n \"finishedAt\": null,\n \"error\": null\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","Location":"http://api.civis.test/imports/files/csv/2014/runs/215","Content-Type":"application/json; charset=utf-8","X-Request-Id":"f08a8bcb-7093-4c7d-ad28-55734793f1b9","X-Runtime":"0.179308","Content-Length":"159"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/imports/files/csv/2014/runs\" -d '' -X POST \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer NuyT3qm53MbOjSMNU9pcwOkX2JVcEFDTzLyagZNhecU\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"get":{"summary":"List runs for the given CSV Import job","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the CSV Import job.","type":"integer"},{"name":"limit","in":"query","required":false,"description":"Number of results to return. Defaults to 20. Maximum allowed is 100.","type":"integer"},{"name":"page_num","in":"query","required":false,"description":"Page number of the results to return. Defaults to the first page, 1.","type":"integer"},{"name":"order","in":"query","required":false,"description":"The field on which to order the result set. Defaults to id. Must be one of: id.","type":"string"},{"name":"order_dir","in":"query","required":false,"description":"Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc.","type":"string"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object300"}}}},"x-examples":[{"resource":"Imports","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/imports/files/csv/:id/runs","description":"View an import's run history","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/imports/files/csv/2017/runs","request_body":null,"request_headers":{"Content-Type":"application/json","Authorization":"Bearer hVLFkMrpdTCPJdOOItAUaLN5WiHudjb3rc9kkcORA7Q","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 217,\n \"csvImportId\": 2017,\n \"state\": \"succeeded\",\n \"isCancelRequested\": false,\n \"createdAt\": \"2023-07-18T18:42:40.000Z\",\n \"startedAt\": \"2023-07-18T18:41:40.000Z\",\n \"finishedAt\": \"2023-07-18T19:42:40.000Z\",\n \"error\": null\n },\n {\n \"id\": 216,\n \"csvImportId\": 2017,\n \"state\": \"succeeded\",\n \"isCancelRequested\": false,\n \"createdAt\": \"2023-07-18T18:42:40.000Z\",\n \"startedAt\": \"2023-07-18T18:41:40.000Z\",\n \"finishedAt\": \"2023-07-18T18:42:40.000Z\",\n \"error\": null\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","X-Pagination-Per-Page":"20","Access-Control-Expose-Headers":"X-Pagination-Per-Page, X-Pagination-Current-Page, X-Pagination-Total-Pages, X-Pagination-Total-Entries","X-Pagination-Current-Page":"1","X-Pagination-Total-Pages":"1","X-Pagination-Total-Entries":"2","Content-Type":"application/json; charset=utf-8","ETag":"W/\"5a012fc44457ff036c5c70863307476d\"","X-Request-Id":"c62850a9-5a5a-45c2-a206-c7a4c8a79c52","X-Runtime":"0.022337","Content-Length":"415"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/imports/files/csv/2017/runs\" -X GET \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer hVLFkMrpdTCPJdOOItAUaLN5WiHudjb3rc9kkcORA7Q\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/imports/files/csv/{id}/runs/{run_id}":{"get":{"summary":"Check status of a run","description":"View the status of a run. This endpoint may be polled to monitor the status of the run. When the 'state' field is no longer 'queued' or 'running' the run has reached its final state.","deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the CSV Import job.","type":"integer"},{"name":"run_id","in":"path","required":true,"description":"The ID of the run.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object300"}}},"x-examples":null,"x-deprecation-warning":null},"delete":{"summary":"Cancel a run","description":"Cancel a currently active run.","deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the CSV Import job.","type":"integer"},{"name":"run_id","in":"path","required":true,"description":"The ID of the run.","type":"integer"}],"responses":{"202":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/imports/files/csv/{id}/runs/{run_id}/logs":{"get":{"summary":"Get the logs for a run","description":"Get the logs for a run.","deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the CSV Import job.","type":"integer"},{"name":"run_id","in":"path","required":true,"description":"The ID of the run.","type":"integer"},{"name":"last_id","in":"query","required":false,"description":"The ID of the last log message received. Log entries with this ID value or lower will be omitted.Logs are sorted by ID if this value is provided, and are otherwise sorted by createdAt.","type":"integer"},{"name":"limit","in":"query","required":false,"description":"The maximum number of log messages to return. Default of 10000.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object117"}}}},"x-examples":null,"x-deprecation-warning":null}},"/imports/batches":{"get":{"summary":"List batch imports","description":null,"deprecated":false,"parameters":[{"name":"hidden","in":"query","required":false,"description":"If specified to be true, returns hidden items. Defaults to false, returning non-hidden items.","type":"boolean"},{"name":"limit","in":"query","required":false,"description":"Number of results to return. Defaults to 20. Maximum allowed is 50.","type":"integer"},{"name":"page_num","in":"query","required":false,"description":"Page number of the results to return. Defaults to the first page, 1.","type":"integer"},{"name":"order","in":"query","required":false,"description":"The field on which to order the result set. Defaults to updated_at. Must be one of: updated_at, created_at.","type":"string"},{"name":"order_dir","in":"query","required":false,"description":"Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc.","type":"string"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object301"}}}},"x-examples":[{"resource":"Imports","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/imports/batches","description":"List all batch imports for a user","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/imports/batches","request_body":null,"request_headers":{"Content-Type":"application/json","Authorization":"Bearer gp__VtsP2dYc_F8aBEoCr97BwaLpkDh6x6BJLW6u6ro","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 2023,\n \"schema\": \"my_schema\",\n \"table\": \"my_table\",\n \"remoteHostId\": 318,\n \"state\": \"running\",\n \"startedAt\": null,\n \"finishedAt\": null,\n \"error\": null\n },\n {\n \"id\": 2020,\n \"schema\": \"my_schema\",\n \"table\": \"my_table\",\n \"remoteHostId\": 317,\n \"state\": \"running\",\n \"startedAt\": null,\n \"finishedAt\": null,\n \"error\": null\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","X-Pagination-Per-Page":"20","Access-Control-Expose-Headers":"X-Pagination-Per-Page, X-Pagination-Current-Page, X-Pagination-Total-Pages, X-Pagination-Total-Entries","X-Pagination-Current-Page":"1","X-Pagination-Total-Pages":"1","X-Pagination-Total-Entries":"2","Content-Type":"application/json; charset=utf-8","ETag":"W/\"701d77507e8d92b95b353c63cb1c3049\"","X-Request-Id":"904e81ec-8773-47e8-8c7a-135748be830e","X-Runtime":"0.019508","Content-Length":"275"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/imports/batches\" -X GET \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer gp__VtsP2dYc_F8aBEoCr97BwaLpkDh6x6BJLW6u6ro\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"post":{"summary":"Upload multiple files to Civis","description":"This endpoint allows multiple files to be imported into a database table. This will create a job and queue it. You can use the `id` returned to query `GET /imports/batches/:id` to check the job status.","deprecated":false,"parameters":[{"name":"Object303","in":"body","schema":{"$ref":"#/definitions/Object303"},"required":true}],"responses":{"201":{"description":"success","schema":{"$ref":"#/definitions/Object302"}}},"x-examples":[{"resource":"Imports","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/imports/batches","description":"Import 2 files","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/imports/batches","request_body":"{\n \"file_ids\": [\n 57,\n 58\n ],\n \"schema\": \"schema\",\n \"table\": \"table\",\n \"remote_host_id\": 321,\n \"credential_id\": 648\n}","request_headers":{"Content-Type":"application/json","Authorization":"Bearer vb1qpt81nyH3oZq-BFxgiWzZchlFTa_oqUshDUhYJ6M","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":201,"response_status_text":"Created","response_body":"{\n \"id\": 2030,\n \"schema\": \"schema\",\n \"table\": \"table\",\n \"remoteHostId\": 321,\n \"state\": \"queued\",\n \"startedAt\": null,\n \"finishedAt\": null,\n \"error\": null,\n \"hidden\": false\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"01429fe6a2d33c046b0ba227db3e5aac\"","X-Request-Id":"de58e311-e55f-4cd9-adbc-c377004afb28","X-Runtime":"0.148157","Content-Length":"144"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/imports/batches\" -d '{\"file_ids\":[57,58],\"schema\":\"schema\",\"table\":\"table\",\"remote_host_id\":321,\"credential_id\":648}' -X POST \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer vb1qpt81nyH3oZq-BFxgiWzZchlFTa_oqUshDUhYJ6M\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/imports/batches/{id}":{"get":{"summary":"Get details about a batch import","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID for the import.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object302"}}},"x-examples":[{"resource":"Imports","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/imports/batches/:id","description":"View a batch import","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/imports/batches/2026","request_body":null,"request_headers":{"Content-Type":"application/json","Authorization":"Bearer Jpwtxf-KqMexVfyLe5WL9Aw8hm9-SLmvnmtJwDL0W7k","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 2026,\n \"schema\": \"my_schema\",\n \"table\": \"my_table\",\n \"remoteHostId\": 319,\n \"state\": \"running\",\n \"startedAt\": null,\n \"finishedAt\": null,\n \"error\": null,\n \"hidden\": false\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"6e2a4f7586d5ef3c762dd6964cf96429\"","X-Request-Id":"a1540f50-a18c-478c-b577-5ca42b683ecd","X-Runtime":"0.018265","Content-Length":"151"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/imports/batches/2026\" -X GET \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer Jpwtxf-KqMexVfyLe5WL9Aw8hm9-SLmvnmtJwDL0W7k\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/imports/{id}":{"get":{"summary":"Get details about an import","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID for the import.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object266"}}},"x-examples":[{"resource":"Imports","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/imports/:id","description":"View an import","explanation":null,"parameters":[{"required":true,"name":"id","description":"The ID for the import."}],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/imports/1904","request_body":null,"request_headers":{"Content-Type":"application/json","Authorization":"Bearer 4-pbi18GNMPPt-T9lS2RfCMqkXbudHtrEvIjhw8eFUs","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"name\": \"Import #1904\",\n \"syncType\": \"Dbsync\",\n \"source\": {\n \"remoteHostId\": 261,\n \"credentialId\": 508,\n \"additionalCredentials\": [\n\n ],\n \"name\": \"redshift-10179\"\n },\n \"destination\": {\n \"remoteHostId\": 262,\n \"credentialId\": 510,\n \"additionalCredentials\": [\n\n ],\n \"name\": \"redshift-10180\"\n },\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n },\n \"notifications\": {\n \"urls\": [\n\n ],\n \"successEmailSubject\": null,\n \"successEmailBody\": null,\n \"successEmailAddresses\": [\n\n ],\n \"successEmailFromName\": null,\n \"successEmailReplyTo\": null,\n \"failureEmailAddresses\": [\n\n ],\n \"stallWarningMinutes\": null,\n \"successOn\": true,\n \"failureOn\": true\n },\n \"parentId\": null,\n \"id\": 1904,\n \"isOutbound\": false,\n \"jobType\": \"JobTypes::Import\",\n \"syncs\": [\n\n ],\n \"state\": \"idle\",\n \"createdAt\": \"2023-07-18T18:42:30.000Z\",\n \"updatedAt\": \"2023-07-18T18:42:30.000Z\",\n \"lastRun\": null,\n \"user\": {\n \"id\": 2226,\n \"name\": \"User devuserfactory1662 1660\",\n \"username\": \"devuserfactory1662\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"runningAs\": {\n \"id\": 2226,\n \"name\": \"User devuserfactory1662 1660\",\n \"username\": \"devuserfactory1662\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"nextRunAt\": null,\n \"timeZone\": \"America/Chicago\",\n \"hidden\": false,\n \"archived\": false,\n \"myPermissionLevel\": \"manage\"\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"ebba0f53c99c141e62d7269efd475de5\"","X-Request-Id":"d3619b6f-2eaa-4c6d-9a40-ff4daa9e53e5","X-Runtime":"0.025016","Content-Length":"1185"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/imports/1904\" -X GET \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer 4-pbi18GNMPPt-T9lS2RfCMqkXbudHtrEvIjhw8eFUs\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"put":{"summary":"Update an import","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID for the import.","type":"integer"},{"name":"Object304","in":"body","schema":{"$ref":"#/definitions/Object304"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object266"}}},"x-examples":[{"resource":"Imports","resource_explanation":null,"http_method":"PUT","route":"http://api.civis.test/imports/:id","description":"Update an import via PUT","explanation":null,"parameters":[{"required":true,"name":"name","description":"The name of the import."},{"required":true,"name":"syncType","description":"The type of sync to perform; one of Dbsync, AutoImport, GdocImport, and GdocExport."},{"required":false,"name":"source","description":"The data source from which to import."},{"required":false,"name":"destination","description":"The database into which to import."},{"required":false,"name":"schedule","description":"The schedule when the import will run."},{"required":false,"name":"notifications","description":"The notifications to send after the script is run."},{"required":false,"name":"parentId","description":"Parent id to trigger this import from"},{"required":false,"name":"id","description":"The ID for the import."},{"required":true,"name":"isOutbound","description":"is_outbound"},{"required":false,"name":"nextRunAt","description":"The time of the next scheduled run."},{"required":false,"name":"timeZone","description":"The time zone of this import."}],"response_fields":[],"requests":[{"request_method":"PUT","request_path":"http://api.civis.test/imports/1908","request_body":"{\n \"name\": \"Import #1908wee\",\n \"sync_type\": \"Dbsync\",\n \"is_outbound\": false,\n \"source\": {\n \"remoteHostId\": 265,\n \"credentialId\": 517\n },\n \"destination\": {\n \"remoteHostId\": 265,\n \"credentialId\": 517\n },\n \"schedule\": {\n \"scheduled\": true,\n \"scheduledDays\": [\n 1\n ],\n \"scheduledHours\": [\n 0,\n 4\n ],\n \"scheduledMinutes\": [\n 15\n ],\n \"scheduledRunsPerHour\": null\n },\n \"notifications\": {\n \"urls\": [\n \"www.google.com\",\n \"www.bing.com\"\n ],\n \"successEmailSubject\": \"new import subject\",\n \"successEmailBody\": \"new import body\",\n \"successEmailAddresses\": [\n \"new_success_email_1@civisanalytics.com\",\n \"new_success_email_2@civisanalytics.com\"\n ],\n \"failureEmailAddresses\": [\n \"new_failure_email_1@civisanalytics.com\",\n \"new_failure_email_2@civisanalytics.com\"\n ],\n \"stallWarningMinutes\": 15\n }\n}","request_headers":{"Content-Type":"application/json","Authorization":"Bearer 0EITZuQcZBPsL_Jr_VfG-P2pMHHYd3m0cnu__AfPFpM","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"name\": \"Import #1908wee\",\n \"syncType\": \"Dbsync\",\n \"source\": {\n \"remoteHostId\": 265,\n \"credentialId\": 517,\n \"additionalCredentials\": [\n\n ],\n \"name\": \"redshift-10183\"\n },\n \"destination\": {\n \"remoteHostId\": 265,\n \"credentialId\": 517,\n \"additionalCredentials\": [\n\n ],\n \"name\": \"redshift-10183\"\n },\n \"schedule\": {\n \"scheduled\": true,\n \"scheduledDays\": [\n 1\n ],\n \"scheduledHours\": [\n 0,\n 4\n ],\n \"scheduledMinutes\": [\n 15\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n },\n \"notifications\": {\n \"urls\": [\n \"www.google.com\",\n \"www.bing.com\"\n ],\n \"successEmailSubject\": \"new import subject\",\n \"successEmailBody\": \"new import body\",\n \"successEmailAddresses\": [\n \"new_success_email_1@civisanalytics.com\",\n \"new_success_email_2@civisanalytics.com\"\n ],\n \"successEmailFromName\": null,\n \"successEmailReplyTo\": null,\n \"failureEmailAddresses\": [\n \"new_failure_email_1@civisanalytics.com\",\n \"new_failure_email_2@civisanalytics.com\"\n ],\n \"stallWarningMinutes\": 15,\n \"successOn\": true,\n \"failureOn\": true\n },\n \"parentId\": null,\n \"id\": 1908,\n \"isOutbound\": false,\n \"jobType\": \"JobTypes::Import\",\n \"syncs\": [\n\n ],\n \"state\": \"scheduled\",\n \"createdAt\": \"2023-07-18T18:42:31.000Z\",\n \"updatedAt\": \"2023-07-18T18:42:31.000Z\",\n \"lastRun\": null,\n \"user\": {\n \"id\": 2228,\n \"name\": \"User devuserfactory1664 1662\",\n \"username\": \"devuserfactory1664\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"runningAs\": {\n \"id\": 2228,\n \"name\": \"User devuserfactory1664 1662\",\n \"username\": \"devuserfactory1664\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"nextRunAt\": \"2023-07-24T05:15:00.000Z\",\n \"timeZone\": \"America/Chicago\",\n \"hidden\": false,\n \"archived\": false,\n \"myPermissionLevel\": \"manage\"\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"2b5a3e99dca62901378f62d734ddf63e\"","X-Request-Id":"a286bdce-d091-4bc2-84d6-834bd2434901","X-Runtime":"0.119839","Content-Length":"1441"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/imports/1908\" -d '{\"name\":\"Import #1908wee\",\"sync_type\":\"Dbsync\",\"is_outbound\":false,\"source\":{\"remoteHostId\":265,\"credentialId\":517},\"destination\":{\"remoteHostId\":265,\"credentialId\":517},\"schedule\":{\"scheduled\":true,\"scheduledDays\":[1],\"scheduledHours\":[0,4],\"scheduledMinutes\":[15],\"scheduledRunsPerHour\":null},\"notifications\":{\"urls\":[\"www.google.com\",\"www.bing.com\"],\"successEmailSubject\":\"new import subject\",\"successEmailBody\":\"new import body\",\"successEmailAddresses\":[\"new_success_email_1@civisanalytics.com\",\"new_success_email_2@civisanalytics.com\"],\"failureEmailAddresses\":[\"new_failure_email_1@civisanalytics.com\",\"new_failure_email_2@civisanalytics.com\"],\"stallWarningMinutes\":15}}' -X PUT \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer 0EITZuQcZBPsL_Jr_VfG-P2pMHHYd3m0cnu__AfPFpM\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/imports/{id}/runs":{"get":{"summary":"Get the run history of this import","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"type":"integer"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object75"}}}},"x-examples":[{"resource":"Imports","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/imports/:id/runs","description":"View an import's run history","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/imports/1920/runs","request_body":null,"request_headers":{"Content-Type":"application/json","Authorization":"Bearer -6m3WwKkb9r-Lin8WN4hQhwmxdRZ4b1Pzc3_3qIJtGk","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 214,\n \"state\": \"succeeded\",\n \"createdAt\": \"2023-07-18T18:42:32.000Z\",\n \"startedAt\": \"2023-07-18T18:41:32.000Z\",\n \"finishedAt\": \"2023-07-18T19:42:32.000Z\",\n \"error\": null\n },\n {\n \"id\": 213,\n \"state\": \"succeeded\",\n \"createdAt\": \"2023-07-18T18:42:32.000Z\",\n \"startedAt\": \"2023-07-18T18:41:32.000Z\",\n \"finishedAt\": \"2023-07-18T18:42:32.000Z\",\n \"error\": null\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"ae68c575edd4feff1f2562be4fde6169\"","X-Request-Id":"5a977ddc-b3b3-4996-aaff-13bf3f1db14c","X-Runtime":"0.015350","Content-Length":"325"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/imports/1920/runs\" -X GET \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer -6m3WwKkb9r-Lin8WN4hQhwmxdRZ4b1Pzc3_3qIJtGk\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"post":{"summary":"Run an import","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the import to run.","type":"integer"}],"responses":{"202":{"description":"success","schema":{"$ref":"#/definitions/Object305"}}},"x-examples":[{"resource":"Imports","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/imports/:id/runs","description":"Run an import","explanation":null,"parameters":[{"required":true,"name":"id","description":"The ID of the import to run."}],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/imports/1912/runs","request_body":null,"request_headers":{"Content-Type":"application/json","Authorization":"Bearer 3Q8lj3S1j-qK0G9U2KDBd-foEU_M_xLgpPrL-xeVv08","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":202,"response_status_text":"Accepted","response_body":"{\n \"runId\": 211\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","X-Request-Id":"a17ef71e-c4d2-423c-8549-e06367ed81b3","X-Runtime":"0.127383","Content-Length":"13"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/imports/1912/runs\" -d '' -X POST \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer 3Q8lj3S1j-qK0G9U2KDBd-foEU_M_xLgpPrL-xeVv08\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Imports","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/imports/:id/runs","description":"Attempting to queue a running import returns an error","explanation":null,"parameters":[{"required":true,"name":"id","description":"The ID of the import to run."}],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/imports/1916/runs","request_body":null,"request_headers":{"Content-Type":"application/json","Authorization":"Bearer NZykLsrnnOyuBSijXPsWkCwqUQJ0vvkSRPPVjRfS1Dc","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":409,"response_status_text":"Conflict","response_body":"{\n \"error\": \"conflict\",\n \"errorDescription\": \"The import cannot be queued because it is already active.\",\n \"code\": 409\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","X-Request-Id":"c61b9b0a-e864-47d3-8d90-f488f3793420","X-Runtime":"0.015180","Content-Length":"110"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/imports/1916/runs\" -d '' -X POST \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer NZykLsrnnOyuBSijXPsWkCwqUQJ0vvkSRPPVjRfS1Dc\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/imports/{id}/cancel":{"post":{"summary":"Cancel a run","description":"Cancel a run.","deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the job.","type":"integer"}],"responses":{"202":{"description":"success","schema":{"$ref":"#/definitions/Object306"}}},"x-examples":null,"x-deprecation-warning":null}},"/imports/{id}/syncs":{"post":{"summary":"Create a sync","description":"Used to create a new Sync for an Import.","deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"type":"integer"},{"name":"Object307","in":"body","schema":{"$ref":"#/definitions/Object307"},"required":true}],"responses":{"201":{"description":"success","schema":{"$ref":"#/definitions/Object268"}}},"x-examples":[{"resource":"Imports","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/imports/:id/syncs","description":"Create a database sync","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/imports/1924/syncs","request_body":"{\n \"source\": {\n \"databaseTable\": {\n \"schema\": \"test\",\n \"table\": \"table1\"\n }\n },\n \"destination\": {\n \"databaseTable\": {\n \"schema\": \"test2\",\n \"table\": \"table2\"\n }\n }\n}","request_headers":{"Content-Type":"application/json","Authorization":"Bearer TZqGzMU2urhMWtufjyNpqBRRsM84DfMf2OY0SaDP4pE","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":201,"response_status_text":"Created","response_body":"{\n \"id\": 1925,\n \"source\": {\n \"id\": null,\n \"path\": \"\\\"test\\\".\\\"table1\\\"\",\n \"databaseTable\": {\n \"schema\": \"test\",\n \"table\": \"table1\",\n \"useWithoutSchema\": false\n },\n \"file\": null,\n \"googleWorksheet\": null,\n \"salesforce\": null\n },\n \"destination\": {\n \"path\": \"\\\"test2\\\".\\\"table2\\\"\",\n \"databaseTable\": {\n \"schema\": \"test2\",\n \"table\": \"table2\",\n \"useWithoutSchema\": false\n },\n \"googleWorksheet\": null\n },\n \"advancedOptions\": {\n \"maxErrors\": null,\n \"existingTableRows\": null,\n \"diststyle\": null,\n \"distkey\": null,\n \"sortkey1\": null,\n \"sortkey2\": null,\n \"columnDelimiter\": null,\n \"columnOverrides\": {\n },\n \"escaped\": false,\n \"identityColumn\": \"\",\n \"rowChunkSize\": null,\n \"wipeDestinationTable\": false,\n \"truncateLongLines\": false,\n \"invalidCharReplacement\": null,\n \"verifyTableRowCounts\": false,\n \"partitionColumnName\": null,\n \"partitionSchemaName\": null,\n \"partitionTableName\": null,\n \"partitionTablePartitionColumnMinName\": null,\n \"partitionTablePartitionColumnMaxName\": null,\n \"lastModifiedColumn\": null,\n \"mysqlCatalogMatchesSchema\": true,\n \"chunkingMethod\": null,\n \"firstRowIsHeader\": null,\n \"exportAction\": null,\n \"sqlQuery\": null,\n \"contactLists\": null,\n \"soqlQuery\": null,\n \"includeDeletedRecords\": null\n }\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"03372fff5e5bdcc633de84424f8ee823\"","X-Request-Id":"83121ecf-7056-474a-832e-18bc1ad8a431","X-Runtime":"0.061845","Content-Length":"1051"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/imports/1924/syncs\" -d '{\"source\":{\"databaseTable\":{\"schema\":\"test\",\"table\":\"table1\"}},\"destination\":{\"databaseTable\":{\"schema\":\"test2\",\"table\":\"table2\"}}}' -X POST \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer TZqGzMU2urhMWtufjyNpqBRRsM84DfMf2OY0SaDP4pE\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Imports","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/imports/:id/syncs","description":"Specify advanced database options","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/imports/1929/syncs","request_body":"{\n \"source\": {\n \"databaseTable\": {\n \"schema\": \"test\",\n \"table\": \"table1\"\n }\n },\n \"destination\": {\n \"databaseTable\": {\n \"schema\": \"test2\",\n \"table\": \"table2\"\n }\n },\n \"advancedOptions\": {\n \"identityColumn\": \"test\",\n \"rowChunkSize\": 100,\n \"wipeDestinationTable\": true,\n \"truncateLongLines\": false,\n \"verifyTableRowCounts\": true,\n \"partitionColumnName\": \"we\",\n \"partitionSchema_name\": \"are\",\n \"partitionTableName\": \"so\",\n \"partitionTablePartitionColumnMinName\": \"hungry\",\n \"partitionTablePartitionColumnMaxName\": \"today\"\n }\n}","request_headers":{"Content-Type":"application/json","Authorization":"Bearer ykNhBnOUrjIn0fRkhUbIIPzY7fBFLdpOQb7oaLV9N70","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":201,"response_status_text":"Created","response_body":"{\n \"id\": 1930,\n \"source\": {\n \"id\": null,\n \"path\": \"\\\"test\\\".\\\"table1\\\"\",\n \"databaseTable\": {\n \"schema\": \"test\",\n \"table\": \"table1\",\n \"useWithoutSchema\": false\n },\n \"file\": null,\n \"googleWorksheet\": null,\n \"salesforce\": null\n },\n \"destination\": {\n \"path\": \"\\\"test2\\\".\\\"table2\\\"\",\n \"databaseTable\": {\n \"schema\": \"test2\",\n \"table\": \"table2\",\n \"useWithoutSchema\": false\n },\n \"googleWorksheet\": null\n },\n \"advancedOptions\": {\n \"maxErrors\": null,\n \"existingTableRows\": null,\n \"diststyle\": null,\n \"distkey\": null,\n \"sortkey1\": null,\n \"sortkey2\": null,\n \"columnDelimiter\": null,\n \"columnOverrides\": {\n },\n \"escaped\": false,\n \"identityColumn\": \"test\",\n \"rowChunkSize\": 100,\n \"wipeDestinationTable\": true,\n \"truncateLongLines\": false,\n \"invalidCharReplacement\": null,\n \"verifyTableRowCounts\": true,\n \"partitionColumnName\": null,\n \"partitionSchemaName\": null,\n \"partitionTableName\": null,\n \"partitionTablePartitionColumnMinName\": null,\n \"partitionTablePartitionColumnMaxName\": null,\n \"lastModifiedColumn\": null,\n \"mysqlCatalogMatchesSchema\": true,\n \"chunkingMethod\": null,\n \"firstRowIsHeader\": null,\n \"exportAction\": null,\n \"sqlQuery\": null,\n \"contactLists\": null,\n \"soqlQuery\": null,\n \"includeDeletedRecords\": null\n }\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"0000598297e4f7b0dec05e30a4b4f416\"","X-Request-Id":"68b0a794-bb1f-4d0b-ba5e-8c16cf152403","X-Runtime":"0.051519","Content-Length":"1052"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/imports/1929/syncs\" -d '{\"source\":{\"databaseTable\":{\"schema\":\"test\",\"table\":\"table1\"}},\"destination\":{\"databaseTable\":{\"schema\":\"test2\",\"table\":\"table2\"}},\"advancedOptions\":{\"identityColumn\":\"test\",\"rowChunkSize\":100,\"wipeDestinationTable\":true,\"truncateLongLines\":false,\"verifyTableRowCounts\":true,\"partitionColumnName\":\"we\",\"partitionSchema_name\":\"are\",\"partitionTableName\":\"so\",\"partitionTablePartitionColumnMinName\":\"hungry\",\"partitionTablePartitionColumnMaxName\":\"today\"}}' -X POST \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer ykNhBnOUrjIn0fRkhUbIIPzY7fBFLdpOQb7oaLV9N70\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Imports","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/imports/:id/syncs","description":"Specify advanced CSV options","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/imports/1933/syncs","request_body":"{\n \"source\": {\n \"file\": {\n \"id\": 41\n }\n },\n \"destination\": {\n \"databaseTable\": {\n \"schema\": \"test2\",\n \"table\": \"table2\"\n }\n },\n \"advanced_options\": {\n \"existing_table_rows\": \"truncate\",\n \"max_errors\": 10,\n \"distkey\": \"first_name\",\n \"sortkey1\": \"last_name\",\n \"sortkey2\": \"zip\",\n \"column_overrides\": {\n \"0\": {\n \"name\": \"first_name\"\n },\n \"1\": {\n \"name\": \"last_name\",\n \"type\": \"VARCHAR(512)\"\n },\n \"2\": {\n \"type\": \"VARCHAR(64)\"\n }\n }\n }\n}","request_headers":{"Content-Type":"application/json","Authorization":"Bearer xG0HUhOyf0r5C8K2gSHH7K96KDJUYAu_n5oCHGg5oUg","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":201,"response_status_text":"Created","response_body":"{\n \"id\": 1938,\n \"source\": {\n \"id\": 41,\n \"path\": \"fake_name\",\n \"databaseTable\": null,\n \"file\": {\n \"id\": 41\n },\n \"googleWorksheet\": null,\n \"salesforce\": null\n },\n \"destination\": {\n \"path\": \"\\\"test2\\\".\\\"table2\\\"\",\n \"databaseTable\": {\n \"schema\": \"test2\",\n \"table\": \"table2\",\n \"useWithoutSchema\": false\n },\n \"googleWorksheet\": null\n },\n \"advancedOptions\": {\n \"maxErrors\": 10,\n \"existingTableRows\": \"truncate\",\n \"diststyle\": \"\",\n \"distkey\": \"first_name\",\n \"sortkey1\": \"last_name\",\n \"sortkey2\": \"zip\",\n \"columnDelimiter\": null,\n \"columnOverrides\": {\n \"0\": {\n \"name\": \"first_name\"\n },\n \"1\": {\n \"name\": \"last_name\",\n \"type\": \"VARCHAR(512)\"\n },\n \"2\": {\n \"type\": \"VARCHAR(64)\"\n }\n },\n \"escaped\": false,\n \"identityColumn\": null,\n \"rowChunkSize\": null,\n \"wipeDestinationTable\": false,\n \"truncateLongLines\": false,\n \"invalidCharReplacement\": null,\n \"verifyTableRowCounts\": false,\n \"partitionColumnName\": null,\n \"partitionSchemaName\": null,\n \"partitionTableName\": null,\n \"partitionTablePartitionColumnMinName\": null,\n \"partitionTablePartitionColumnMaxName\": null,\n \"lastModifiedColumn\": null,\n \"mysqlCatalogMatchesSchema\": true,\n \"chunkingMethod\": null,\n \"firstRowIsHeader\": null,\n \"exportAction\": null,\n \"sqlQuery\": null,\n \"contactLists\": null,\n \"soqlQuery\": null,\n \"includeDeletedRecords\": null\n }\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"88010f28012145f0be52d9af43629356\"","X-Request-Id":"1d7ee151-0973-46d9-b5e1-65ae4e72caaf","X-Runtime":"0.083074","Content-Length":"1108"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/imports/1933/syncs\" -d '{\"source\":{\"file\":{\"id\":41}},\"destination\":{\"databaseTable\":{\"schema\":\"test2\",\"table\":\"table2\"}},\"advanced_options\":{\"existing_table_rows\":\"truncate\",\"max_errors\":10,\"distkey\":\"first_name\",\"sortkey1\":\"last_name\",\"sortkey2\":\"zip\",\"column_overrides\":{\"0\":{\"name\":\"first_name\"},\"1\":{\"name\":\"last_name\",\"type\":\"VARCHAR(512)\"},\"2\":{\"type\":\"VARCHAR(64)\"}}}}' -X POST \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer xG0HUhOyf0r5C8K2gSHH7K96KDJUYAu_n5oCHGg5oUg\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Imports","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/imports/:id/syncs","description":"Create a Gdoc import","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/imports/1942/syncs","request_body":"{\n \"source\": {\n \"google_worksheet\": {\n \"spreadsheet\": \"my_spreadsheet\",\n \"worksheet\": \"my_worksheet\"\n }\n },\n \"destination\": {\n \"database_table\": {\n \"schema\": \"my_schema\",\n \"table\": \"my_table\"\n }\n }\n}","request_headers":{"Content-Type":"application/json","Authorization":"Bearer cjjkGV74EIOyXgrdQJ4AwE7vhchYjTZrb-YcSSKJqmg","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":201,"response_status_text":"Created","response_body":"{\n \"id\": 1947,\n \"source\": {\n \"id\": 1,\n \"path\": \"\\\"my_spreadsheet\\\".\\\"my_worksheet\\\"\",\n \"databaseTable\": null,\n \"file\": null,\n \"googleWorksheet\": {\n \"spreadsheet\": \"my_spreadsheet\",\n \"spreadsheetId\": null,\n \"worksheet\": \"my_worksheet\",\n \"worksheetId\": null\n },\n \"salesforce\": null\n },\n \"destination\": {\n \"path\": \"\\\"my_schema\\\".\\\"my_table\\\"\",\n \"databaseTable\": {\n \"schema\": \"my_schema\",\n \"table\": \"my_table\",\n \"useWithoutSchema\": false\n },\n \"googleWorksheet\": null\n },\n \"advancedOptions\": {\n \"maxErrors\": null,\n \"existingTableRows\": \"fail\",\n \"diststyle\": null,\n \"distkey\": null,\n \"sortkey1\": null,\n \"sortkey2\": null,\n \"columnDelimiter\": null,\n \"columnOverrides\": {\n },\n \"escaped\": false,\n \"identityColumn\": null,\n \"rowChunkSize\": null,\n \"wipeDestinationTable\": false,\n \"truncateLongLines\": false,\n \"invalidCharReplacement\": null,\n \"verifyTableRowCounts\": false,\n \"partitionColumnName\": null,\n \"partitionSchemaName\": null,\n \"partitionTableName\": null,\n \"partitionTablePartitionColumnMinName\": null,\n \"partitionTablePartitionColumnMaxName\": null,\n \"lastModifiedColumn\": null,\n \"mysqlCatalogMatchesSchema\": true,\n \"chunkingMethod\": null,\n \"firstRowIsHeader\": null,\n \"exportAction\": null,\n \"sqlQuery\": null,\n \"contactLists\": null,\n \"soqlQuery\": null,\n \"includeDeletedRecords\": null\n }\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"9bb2be7fbf1c9165bfe5d982ea5059b1\"","X-Request-Id":"e7c27eba-a35b-4c69-af7e-ac74fe6a2449","X-Runtime":"0.092126","Content-Length":"1120"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/imports/1942/syncs\" -d '{\"source\":{\"google_worksheet\":{\"spreadsheet\":\"my_spreadsheet\",\"worksheet\":\"my_worksheet\"}},\"destination\":{\"database_table\":{\"schema\":\"my_schema\",\"table\":\"my_table\"}}}' -X POST \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer cjjkGV74EIOyXgrdQJ4AwE7vhchYjTZrb-YcSSKJqmg\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Imports","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/imports/:id/syncs","description":"Specify advanced Gdoc import options","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/imports/1951/syncs","request_body":"{\n \"source\": {\n \"google_worksheet\": {\n \"spreadsheet\": \"my_spreadsheet\",\n \"worksheet\": \"my_worksheet\"\n }\n },\n \"destination\": {\n \"database_table\": {\n \"schema\": \"my_schema\",\n \"table\": \"my_table\"\n }\n },\n \"advanced_options\": {\n \"first_row_is_header\": true,\n \"max_errors\": 10,\n \"existing_table_rows\": \"append\"\n }\n}","request_headers":{"Content-Type":"application/json","Authorization":"Bearer OeKA_MlDYFWItQHx6KwrEZwPj0w9HJzh1DzLzdpPOig","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":201,"response_status_text":"Created","response_body":"{\n \"id\": 1956,\n \"source\": {\n \"id\": 2,\n \"path\": \"\\\"my_spreadsheet\\\".\\\"my_worksheet\\\"\",\n \"databaseTable\": null,\n \"file\": null,\n \"googleWorksheet\": {\n \"spreadsheet\": \"my_spreadsheet\",\n \"spreadsheetId\": null,\n \"worksheet\": \"my_worksheet\",\n \"worksheetId\": null\n },\n \"salesforce\": null\n },\n \"destination\": {\n \"path\": \"\\\"my_schema\\\".\\\"my_table\\\"\",\n \"databaseTable\": {\n \"schema\": \"my_schema\",\n \"table\": \"my_table\",\n \"useWithoutSchema\": false\n },\n \"googleWorksheet\": null\n },\n \"advancedOptions\": {\n \"maxErrors\": 10,\n \"existingTableRows\": \"append\",\n \"diststyle\": null,\n \"distkey\": null,\n \"sortkey1\": null,\n \"sortkey2\": null,\n \"columnDelimiter\": null,\n \"columnOverrides\": {\n },\n \"escaped\": false,\n \"identityColumn\": null,\n \"rowChunkSize\": null,\n \"wipeDestinationTable\": false,\n \"truncateLongLines\": false,\n \"invalidCharReplacement\": null,\n \"verifyTableRowCounts\": false,\n \"partitionColumnName\": null,\n \"partitionSchemaName\": null,\n \"partitionTableName\": null,\n \"partitionTablePartitionColumnMinName\": null,\n \"partitionTablePartitionColumnMaxName\": null,\n \"lastModifiedColumn\": null,\n \"mysqlCatalogMatchesSchema\": true,\n \"chunkingMethod\": null,\n \"firstRowIsHeader\": true,\n \"exportAction\": null,\n \"sqlQuery\": null,\n \"contactLists\": null,\n \"soqlQuery\": null,\n \"includeDeletedRecords\": null\n }\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"f468bf128ab686519d1140c822df9200\"","X-Request-Id":"64fe2ae6-fae3-4c36-a23a-dc7217d62e83","X-Runtime":"0.063130","Content-Length":"1120"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/imports/1951/syncs\" -d '{\"source\":{\"google_worksheet\":{\"spreadsheet\":\"my_spreadsheet\",\"worksheet\":\"my_worksheet\"}},\"destination\":{\"database_table\":{\"schema\":\"my_schema\",\"table\":\"my_table\"}},\"advanced_options\":{\"first_row_is_header\":true,\"max_errors\":10,\"existing_table_rows\":\"append\"}}' -X POST \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer OeKA_MlDYFWItQHx6KwrEZwPj0w9HJzh1DzLzdpPOig\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Imports","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/imports/:id/syncs","description":"Create a Gdoc export","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/imports/1960/syncs","request_body":"{\n \"source\": {\n \"database_table\": {\n \"schema\": \"my_schema\",\n \"table\": \"my_table\"\n }\n },\n \"destination\": {\n \"google_worksheet\": {\n \"spreadsheet\": \"my_spreadsheet\",\n \"worksheet\": \"my_worksheet\"\n }\n },\n \"advanced_options\": {\n \"export_action\": \"newwksht\"\n }\n}","request_headers":{"Content-Type":"application/json","Authorization":"Bearer goja3BPHsQLmBNP-m5U_qbrRx2r5A-tiIyT1nnODpCk","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":201,"response_status_text":"Created","response_body":"{\n \"id\": 1965,\n \"source\": {\n \"id\": null,\n \"path\": null,\n \"databaseTable\": null,\n \"file\": null,\n \"googleWorksheet\": null,\n \"salesforce\": null\n },\n \"destination\": {\n \"path\": \"my_spreadsheet.my_worksheet\",\n \"databaseTable\": null,\n \"googleWorksheet\": {\n \"spreadsheet\": \"my_spreadsheet\",\n \"spreadsheetId\": null,\n \"worksheet\": \"my_worksheet\",\n \"worksheetId\": null\n }\n },\n \"advancedOptions\": {\n \"maxErrors\": null,\n \"existingTableRows\": null,\n \"diststyle\": null,\n \"distkey\": null,\n \"sortkey1\": null,\n \"sortkey2\": null,\n \"columnDelimiter\": null,\n \"columnOverrides\": {\n },\n \"escaped\": false,\n \"identityColumn\": null,\n \"rowChunkSize\": null,\n \"wipeDestinationTable\": false,\n \"truncateLongLines\": false,\n \"invalidCharReplacement\": null,\n \"verifyTableRowCounts\": false,\n \"partitionColumnName\": null,\n \"partitionSchemaName\": null,\n \"partitionTableName\": null,\n \"partitionTablePartitionColumnMinName\": null,\n \"partitionTablePartitionColumnMaxName\": null,\n \"lastModifiedColumn\": null,\n \"mysqlCatalogMatchesSchema\": true,\n \"chunkingMethod\": null,\n \"firstRowIsHeader\": null,\n \"exportAction\": \"newwksht\",\n \"sqlQuery\": null,\n \"contactLists\": null,\n \"soqlQuery\": null,\n \"includeDeletedRecords\": null\n }\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"6b2a8e91fd22d7bc3a7b1329d6acc262\"","X-Request-Id":"dee8715f-a184-4622-8c8b-db251aaecea2","X-Runtime":"0.099759","Content-Length":"1033"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/imports/1960/syncs\" -d '{\"source\":{\"database_table\":{\"schema\":\"my_schema\",\"table\":\"my_table\"}},\"destination\":{\"google_worksheet\":{\"spreadsheet\":\"my_spreadsheet\",\"worksheet\":\"my_worksheet\"}},\"advanced_options\":{\"export_action\":\"newwksht\"}}' -X POST \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer goja3BPHsQLmBNP-m5U_qbrRx2r5A-tiIyT1nnODpCk\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Imports","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/imports/:id/syncs","description":"Specify advanced Gdoc export options using query as source","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/imports/1969/syncs","request_body":"{\n \"source\": {},\n \"destination\": {\n \"google_worksheet\": {\n \"spreadsheet\": \"my_spreadsheet\",\n \"worksheet\": \"my_worksheet\"\n }\n },\n \"advanced_options\": {\n \"export_action\": \"newsprsht\",\n \"sql_query\": \"SELECT * from test;\"\n }\n}","request_headers":{"Content-Type":"application/json","Authorization":"Bearer j2O4K38_p3lvyF1WFrTTAGyZf8Ur6SLxoFVh58OKSAI","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":201,"response_status_text":"Created","response_body":"{\n \"id\": 1974,\n \"source\": {\n \"id\": null,\n \"path\": \"SELECT * from test;\",\n \"databaseTable\": null,\n \"file\": null,\n \"googleWorksheet\": null,\n \"salesforce\": null\n },\n \"destination\": {\n \"path\": \"my_spreadsheet.my_worksheet\",\n \"databaseTable\": null,\n \"googleWorksheet\": {\n \"spreadsheet\": \"my_spreadsheet\",\n \"spreadsheetId\": null,\n \"worksheet\": \"my_worksheet\",\n \"worksheetId\": null\n }\n },\n \"advancedOptions\": {\n \"maxErrors\": null,\n \"existingTableRows\": null,\n \"diststyle\": null,\n \"distkey\": null,\n \"sortkey1\": null,\n \"sortkey2\": null,\n \"columnDelimiter\": null,\n \"columnOverrides\": {\n },\n \"escaped\": false,\n \"identityColumn\": null,\n \"rowChunkSize\": null,\n \"wipeDestinationTable\": false,\n \"truncateLongLines\": false,\n \"invalidCharReplacement\": null,\n \"verifyTableRowCounts\": false,\n \"partitionColumnName\": null,\n \"partitionSchemaName\": null,\n \"partitionTableName\": null,\n \"partitionTablePartitionColumnMinName\": null,\n \"partitionTablePartitionColumnMaxName\": null,\n \"lastModifiedColumn\": null,\n \"mysqlCatalogMatchesSchema\": true,\n \"chunkingMethod\": null,\n \"firstRowIsHeader\": null,\n \"exportAction\": \"newsprsht\",\n \"sqlQuery\": \"SELECT * from test;\",\n \"contactLists\": null,\n \"soqlQuery\": null,\n \"includeDeletedRecords\": null\n }\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"f7e57b43514e9043464187a3811a7c3a\"","X-Request-Id":"049c48a8-91d2-41d5-8d5a-e7f9672ad39d","X-Runtime":"0.055821","Content-Length":"1068"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/imports/1969/syncs\" -d '{\"source\":{},\"destination\":{\"google_worksheet\":{\"spreadsheet\":\"my_spreadsheet\",\"worksheet\":\"my_worksheet\"}},\"advanced_options\":{\"export_action\":\"newsprsht\",\"sql_query\":\"SELECT * from test;\"}}' -X POST \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer j2O4K38_p3lvyF1WFrTTAGyZf8Ur6SLxoFVh58OKSAI\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/imports/{id}/syncs/{sync_id}":{"put":{"summary":"Update a sync","description":"Used to update an existing Sync for an Import.","deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the import to fetch.","type":"integer"},{"name":"sync_id","in":"path","required":true,"description":"The ID of the sync to fetch.","type":"integer"},{"name":"Object316","in":"body","schema":{"$ref":"#/definitions/Object316"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object268"}}},"x-examples":[{"resource":"Imports","resource_explanation":null,"http_method":"PUT","route":"http://api.civis.test/imports/:id/syncs/:sync_id","description":"Update a database sync","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"PUT","request_path":"http://api.civis.test/imports/1980/syncs/%3Async_id","request_body":"{\n \"syncId\": 1981,\n \"source\": {\n \"database_table\": {\n \"schema\": \"test\",\n \"table\": \"table1\"\n }\n },\n \"destination\": {\n \"databaseTable\": {\n \"schema\": \"test2\",\n \"table\": \"table2\"\n }\n },\n \"advancedOptions\": {\n \"identityColumn\": \"weak\",\n \"chunkingMethod\": \"sorted_by_identity_columns\",\n \"rowChunkSize\": 100,\n \"wipeDestinationTable\": true,\n \"truncateLongLines\": false,\n \"verifyTableRowCounts\": false,\n \"partitionColumnName\": \"we\",\n \"partitionSchema_name\": \"are\",\n \"partitionTableName\": \"so\",\n \"partitionTablePartitionColumnMinName\": \"hungry\",\n \"partitionTablePartitionColumnMaxName\": \"today\",\n \"lastModifiedColumn\": \"\"\n }\n}","request_headers":{"Content-Type":"application/json","Authorization":"Bearer 6oLoMTv1DSUBADqU-R763tjGidRR9n6X724hAP9_WuM","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 1981,\n \"source\": {\n \"id\": null,\n \"path\": \"\\\"test\\\".\\\"table1\\\"\",\n \"databaseTable\": {\n \"schema\": \"test\",\n \"table\": \"table1\",\n \"useWithoutSchema\": false\n },\n \"file\": null,\n \"googleWorksheet\": null,\n \"salesforce\": null\n },\n \"destination\": {\n \"path\": \"\\\"test2\\\".\\\"table2\\\"\",\n \"databaseTable\": {\n \"schema\": \"test2\",\n \"table\": \"table2\",\n \"useWithoutSchema\": false\n },\n \"googleWorksheet\": null\n },\n \"advancedOptions\": {\n \"maxErrors\": null,\n \"existingTableRows\": null,\n \"diststyle\": null,\n \"distkey\": null,\n \"sortkey1\": null,\n \"sortkey2\": null,\n \"columnDelimiter\": null,\n \"columnOverrides\": {\n },\n \"escaped\": false,\n \"identityColumn\": \"weak\",\n \"rowChunkSize\": 100,\n \"wipeDestinationTable\": true,\n \"truncateLongLines\": false,\n \"invalidCharReplacement\": null,\n \"verifyTableRowCounts\": false,\n \"partitionColumnName\": null,\n \"partitionSchemaName\": null,\n \"partitionTableName\": null,\n \"partitionTablePartitionColumnMinName\": null,\n \"partitionTablePartitionColumnMaxName\": null,\n \"lastModifiedColumn\": \"\",\n \"mysqlCatalogMatchesSchema\": true,\n \"chunkingMethod\": null,\n \"firstRowIsHeader\": null,\n \"exportAction\": null,\n \"sqlQuery\": null,\n \"contactLists\": null,\n \"soqlQuery\": null,\n \"includeDeletedRecords\": null\n }\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"e98005584358916d895abb96d66996ea\"","X-Request-Id":"035a57d3-1fdd-4161-a068-36d84b4f8a1f","X-Runtime":"0.107342","Content-Length":"1051"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/imports/1980/syncs/%3Async_id\" -d '{\"syncId\":1981,\"source\":{\"database_table\":{\"schema\":\"test\",\"table\":\"table1\"}},\"destination\":{\"databaseTable\":{\"schema\":\"test2\",\"table\":\"table2\"}},\"advancedOptions\":{\"identityColumn\":\"weak\",\"chunkingMethod\":\"sorted_by_identity_columns\",\"rowChunkSize\":100,\"wipeDestinationTable\":true,\"truncateLongLines\":false,\"verifyTableRowCounts\":false,\"partitionColumnName\":\"we\",\"partitionSchema_name\":\"are\",\"partitionTableName\":\"so\",\"partitionTablePartitionColumnMinName\":\"hungry\",\"partitionTablePartitionColumnMaxName\":\"today\",\"lastModifiedColumn\":\"\"}}' -X PUT \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer 6oLoMTv1DSUBADqU-R763tjGidRR9n6X724hAP9_WuM\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Imports","resource_explanation":null,"http_method":"PUT","route":"http://api.civis.test/imports/:id/syncs/:sync_id","description":"Update a CSV import","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"PUT","request_path":"http://api.civis.test/imports/1990/syncs/%3Async_id","request_body":"{\n \"syncId\": 1991,\n \"source\": {\n \"file\": {\n \"id\": 43\n }\n },\n \"destination\": {\n \"databaseTable\": {\n \"schema\": \"test2\",\n \"table\": \"table2\"\n }\n },\n \"advancedOptions\": {\n \"existing_table_rows\": \"append\",\n \"max_errors\": 100,\n \"distkey\": \"first_name\",\n \"sortkey1\": \"last_name\",\n \"sortkey2\": \"zip\",\n \"column_delimiter\": \"comma\",\n \"columnOverrides\": {\n \"0\": {\n \"name\": \"first_name\"\n },\n \"1\": {\n \"name\": \"last_name\",\n \"type\": \"VARCHAR(512)\"\n },\n \"2\": {\n \"type\": \"VARCHAR(64)\"\n }\n },\n \"first_row_is_header\": true\n }\n}","request_headers":{"Content-Type":"application/json","Authorization":"Bearer OBepYRq6VUvNz73IWX7z1kUBtxH1bPeqSoSOQ0xMnj8","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 1991,\n \"source\": {\n \"id\": 43,\n \"path\": \"fake_name\",\n \"databaseTable\": null,\n \"file\": {\n \"id\": 43\n },\n \"googleWorksheet\": null,\n \"salesforce\": null\n },\n \"destination\": {\n \"path\": \"\\\"test2\\\".\\\"table2\\\"\",\n \"databaseTable\": {\n \"schema\": \"test2\",\n \"table\": \"table2\",\n \"useWithoutSchema\": false\n },\n \"googleWorksheet\": null\n },\n \"advancedOptions\": {\n \"maxErrors\": 100,\n \"existingTableRows\": \"append\",\n \"diststyle\": \"key\",\n \"distkey\": \"first_name\",\n \"sortkey1\": \"last_name\",\n \"sortkey2\": \"zip\",\n \"columnDelimiter\": \"comma\",\n \"columnOverrides\": {\n \"0\": {\n \"name\": \"first_name\"\n },\n \"1\": {\n \"name\": \"last_name\",\n \"type\": \"VARCHAR(512)\"\n },\n \"2\": {\n \"type\": \"VARCHAR(64)\"\n }\n },\n \"escaped\": false,\n \"identityColumn\": null,\n \"rowChunkSize\": null,\n \"wipeDestinationTable\": false,\n \"truncateLongLines\": false,\n \"invalidCharReplacement\": null,\n \"verifyTableRowCounts\": false,\n \"partitionColumnName\": null,\n \"partitionSchemaName\": null,\n \"partitionTableName\": null,\n \"partitionTablePartitionColumnMinName\": null,\n \"partitionTablePartitionColumnMaxName\": null,\n \"lastModifiedColumn\": null,\n \"mysqlCatalogMatchesSchema\": true,\n \"chunkingMethod\": null,\n \"firstRowIsHeader\": true,\n \"exportAction\": null,\n \"sqlQuery\": null,\n \"contactLists\": null,\n \"soqlQuery\": null,\n \"includeDeletedRecords\": null\n }\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"6f1174623a1550f9428d30f1d92ae3d9\"","X-Request-Id":"656cef77-a8c7-4b2b-bece-b5fff9806440","X-Runtime":"0.087448","Content-Length":"1113"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/imports/1990/syncs/%3Async_id\" -d '{\"syncId\":1991,\"source\":{\"file\":{\"id\":43}},\"destination\":{\"databaseTable\":{\"schema\":\"test2\",\"table\":\"table2\"}},\"advancedOptions\":{\"existing_table_rows\":\"append\",\"max_errors\":100,\"distkey\":\"first_name\",\"sortkey1\":\"last_name\",\"sortkey2\":\"zip\",\"column_delimiter\":\"comma\",\"columnOverrides\":{\"0\":{\"name\":\"first_name\"},\"1\":{\"name\":\"last_name\",\"type\":\"VARCHAR(512)\"},\"2\":{\"type\":\"VARCHAR(64)\"}},\"first_row_is_header\":true}}' -X PUT \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer OBepYRq6VUvNz73IWX7z1kUBtxH1bPeqSoSOQ0xMnj8\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"delete":{"summary":"Archive a sync (deprecated, use the /archive endpoint instead)","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the import to fetch.","type":"integer"},{"name":"sync_id","in":"path","required":true,"description":"The ID of the sync to fetch.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/imports/{id}/syncs/{sync_id}/archive":{"put":{"summary":"Update the archive status of this sync","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the import to fetch.","type":"integer"},{"name":"sync_id","in":"path","required":true,"description":"The ID of the sync to fetch.","type":"integer"},{"name":"Object317","in":"body","schema":{"$ref":"#/definitions/Object317"},"required":false}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object268"}}},"x-examples":null,"x-deprecation-warning":null}},"/jobs/":{"get":{"summary":"List Jobs","description":null,"deprecated":false,"parameters":[{"name":"state","in":"query","required":false,"description":"The job's state. One or more of queued, running, succeeded, failed, and cancelled. Specify multiple values as a comma-separated list (e.g., \"A,B\").","type":"string"},{"name":"type","in":"query","required":false,"description":"The job's type. Specify multiple values as a comma-separated list (e.g., \"A,B\").","type":"string"},{"name":"q","in":"query","required":false,"description":"Query string to search on the id, name, and job type.","type":"string"},{"name":"permission","in":"query","required":false,"description":"A permissions string, one of \"read\", \"write\", or \"manage\". Lists only jobs for which the current user has that permission.","type":"string"},{"name":"scheduled","in":"query","required":false,"description":"If the item is scheduled.","type":"boolean"},{"name":"hidden","in":"query","required":false,"description":"If specified to be true, returns hidden items. Defaults to false, returning non-hidden items.","type":"boolean"},{"name":"archived","in":"query","required":false,"description":"The archival status of the requested item(s).","type":"string"},{"name":"author","in":"query","required":false,"description":"If specified, return items from any of these authors. It accepts a comma-separated list of user IDs.","type":"string"},{"name":"limit","in":"query","required":false,"description":"Number of results to return. Defaults to its maximum of 50.","type":"integer"},{"name":"page_num","in":"query","required":false,"description":"Page number of the results to return. Defaults to the first page, 1.","type":"integer"},{"name":"order","in":"query","required":false,"description":"The field on which to order the result set. Defaults to updated_at. Must be one of: updated_at.","type":"string"},{"name":"order_dir","in":"query","required":false,"description":"Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc.","type":"string"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object318"}}}},"x-examples":[{"resource":"Jobs","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/jobs","description":"List all readable jobs for a user","explanation":null,"parameters":[{"required":false,"name":"state","description":"The job's state. One or more of queued, running, succeeded, failed, and cancelled. Specify multiple values as a comma-separated list (e.g., \"A,B\")."},{"required":false,"name":"type","description":"The job's type. Specify multiple values as a comma-separated list (e.g., \"A,B\")."},{"required":false,"name":"q","description":"Query string to search on the id, name, and job type."},{"required":false,"name":"permission","description":"A permissions string, one of \"read\", \"write\", or \"manage\". Lists only jobs for which the current user has that permission."},{"required":false,"name":"scheduled","description":"If the item is scheduled."},{"required":false,"name":"hidden","description":"If specified to be true, returns hidden items. Defaults to false, returning non-hidden items."},{"required":false,"name":"archived","description":"The archival status of the requested item(s)."},{"required":false,"name":"author","description":"If specified, return items from any of these authors. It accepts a comma-separated list of user IDs."},{"required":false,"name":"limit","description":"Number of results to return. Defaults to its maximum of 50."},{"required":false,"name":"pageNum","description":"Page number of the results to return. Defaults to the first page, 1."},{"required":false,"name":"order","description":"The field on which to order the result set. Defaults to updated_at. Must be one of: updated_at."},{"required":false,"name":"orderDir","description":"Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc."}],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/jobs","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer Azkq2NXGSt3rtMG7D1-WXm56KthfMBsVn2i4rUsdb_E","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 4,\n \"name\": \"Query\",\n \"type\": \"JobTypes::Query\",\n \"fromTemplateId\": null,\n \"state\": \"succeeded\",\n \"createdAt\": \"2025-02-26T17:48:32.000Z\",\n \"updatedAt\": \"2025-02-26T17:18:32.000Z\",\n \"lastRun\": {\n \"id\": 3,\n \"state\": \"succeeded\",\n \"createdAt\": \"2025-02-26T17:48:32.000Z\",\n \"startedAt\": \"2025-02-26T17:17:32.000Z\",\n \"finishedAt\": \"2025-02-26T17:18:32.000Z\",\n \"error\": null\n },\n \"archived\": false,\n \"author\": {\n \"id\": 21,\n \"name\": \"User devuserfactory12 12\",\n \"username\": \"devuserfactory12\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n }\n },\n {\n \"id\": 3,\n \"name\": \"Test Job 3\",\n \"type\": \"JobTypes::CassNcoa\",\n \"fromTemplateId\": null,\n \"state\": \"queued\",\n \"createdAt\": \"2025-02-26T17:48:32.000Z\",\n \"updatedAt\": \"2025-02-26T16:48:32.000Z\",\n \"lastRun\": {\n \"id\": 2,\n \"state\": \"queued\",\n \"createdAt\": \"2025-02-26T17:48:32.000Z\",\n \"startedAt\": null,\n \"finishedAt\": null,\n \"error\": null\n },\n \"archived\": false,\n \"author\": {\n \"id\": 20,\n \"name\": \"User devuserfactory11 11\",\n \"username\": \"devuserfactory11\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"schedule\": {\n \"scheduled\": true,\n \"scheduledDays\": [\n 0\n ],\n \"scheduledHours\": [\n 12\n ],\n \"scheduledMinutes\": [\n 30\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n }\n },\n {\n \"id\": 2,\n \"name\": \"Test Job 2\",\n \"type\": \"JobTypes::Test\",\n \"fromTemplateId\": null,\n \"state\": \"running\",\n \"createdAt\": \"2025-02-26T17:48:32.000Z\",\n \"updatedAt\": \"2025-02-26T15:48:32.000Z\",\n \"lastRun\": {\n \"id\": 1,\n \"state\": \"running\",\n \"createdAt\": \"2025-02-26T17:48:32.000Z\",\n \"startedAt\": null,\n \"finishedAt\": null,\n \"error\": null\n },\n \"archived\": false,\n \"author\": {\n \"id\": 19,\n \"name\": \"User devuserfactory10 10\",\n \"username\": \"devuserfactory10\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n }\n },\n {\n \"id\": 1,\n \"name\": \"Test Job 1\",\n \"type\": \"JobTypes::Test\",\n \"fromTemplateId\": null,\n \"state\": \"idle\",\n \"createdAt\": \"2025-02-26T17:48:31.000Z\",\n \"updatedAt\": \"2025-02-26T14:48:31.000Z\",\n \"lastRun\": null,\n \"archived\": false,\n \"author\": {\n \"id\": 18,\n \"name\": \"User devuserfactory9 9\",\n \"username\": \"devuserfactory9\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n }\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","X-Pagination-Per-Page":"50","Access-Control-Expose-Headers":"X-Pagination-Per-Page, X-Pagination-Current-Page, X-Pagination-Total-Pages, X-Pagination-Total-Entries","X-Pagination-Current-Page":"1","X-Pagination-Total-Pages":"1","X-Pagination-Total-Entries":"4","Content-Type":"application/json; charset=utf-8","ETag":"W/\"94fee55e61f7d1cc3ab0c49f192e39c4\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"756f0b15-d476-48f5-8d9a-0232a7b2ca44","X-Runtime":"0.079190","Content-Length":"2217"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/jobs\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer Azkq2NXGSt3rtMG7D1-WXm56KthfMBsVn2i4rUsdb_E\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Jobs","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/jobs?limit=1","description":"Limit the number of jobs returned","explanation":null,"parameters":[{"required":false,"name":"state","description":"The job's state. One or more of queued, running, succeeded, failed, and cancelled. Specify multiple values as a comma-separated list (e.g., \"A,B\")."},{"required":false,"name":"type","description":"The job's type. Specify multiple values as a comma-separated list (e.g., \"A,B\")."},{"required":false,"name":"q","description":"Query string to search on the id, name, and job type."},{"required":false,"name":"permission","description":"A permissions string, one of \"read\", \"write\", or \"manage\". Lists only jobs for which the current user has that permission."},{"required":false,"name":"scheduled","description":"If the item is scheduled."},{"required":false,"name":"hidden","description":"If specified to be true, returns hidden items. Defaults to false, returning non-hidden items."},{"required":false,"name":"archived","description":"The archival status of the requested item(s)."},{"required":false,"name":"author","description":"If specified, return items from any of these authors. It accepts a comma-separated list of user IDs."},{"required":false,"name":"limit","description":"Number of results to return. Defaults to its maximum of 50."},{"required":false,"name":"pageNum","description":"Page number of the results to return. Defaults to the first page, 1."},{"required":false,"name":"order","description":"The field on which to order the result set. Defaults to updated_at. Must be one of: updated_at."},{"required":false,"name":"orderDir","description":"Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc."}],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/jobs?limit=1","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer k4c0jEMStXU7dPiFbsnKSPb0QDwY_ihRPtaHNdwtN2k","Host":"api.civis.test","Cookie":""},"request_query_parameters":{"limit":"1"},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 9,\n \"name\": \"Query\",\n \"type\": \"JobTypes::Query\",\n \"fromTemplateId\": null,\n \"state\": \"succeeded\",\n \"createdAt\": \"2025-02-26T17:48:32.000Z\",\n \"updatedAt\": \"2025-02-26T17:18:33.000Z\",\n \"lastRun\": {\n \"id\": 6,\n \"state\": \"succeeded\",\n \"createdAt\": \"2025-02-26T17:48:33.000Z\",\n \"startedAt\": \"2025-02-26T17:17:33.000Z\",\n \"finishedAt\": \"2025-02-26T17:18:33.000Z\",\n \"error\": null\n },\n \"archived\": false,\n \"author\": {\n \"id\": 30,\n \"name\": \"User devuserfactory20 20\",\n \"username\": \"devuserfactory20\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n }\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","X-Pagination-Per-Page":"1","Access-Control-Expose-Headers":"X-Pagination-Per-Page, X-Pagination-Current-Page, X-Pagination-Total-Pages, X-Pagination-Total-Entries","X-Pagination-Current-Page":"1","X-Pagination-Total-Pages":"4","X-Pagination-Total-Entries":"4","Content-Type":"application/json; charset=utf-8","ETag":"W/\"f6bb96b640b08a8523615580470772ab\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"77d948fc-9348-45e6-93b2-78f80bf12243","X-Runtime":"0.034772","Content-Length":"615"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/jobs?limit=1\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer k4c0jEMStXU7dPiFbsnKSPb0QDwY_ihRPtaHNdwtN2k\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Jobs","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/jobs?state=running","description":"List all jobs in the specified state","explanation":null,"parameters":[{"required":false,"name":"state","description":"The job's state. One or more of queued, running, succeeded, failed, and cancelled. Specify multiple values as a comma-separated list (e.g., \"A,B\")."},{"required":false,"name":"type","description":"The job's type. Specify multiple values as a comma-separated list (e.g., \"A,B\")."},{"required":false,"name":"q","description":"Query string to search on the id, name, and job type."},{"required":false,"name":"permission","description":"A permissions string, one of \"read\", \"write\", or \"manage\". Lists only jobs for which the current user has that permission."},{"required":false,"name":"scheduled","description":"If the item is scheduled."},{"required":false,"name":"hidden","description":"If specified to be true, returns hidden items. Defaults to false, returning non-hidden items."},{"required":false,"name":"archived","description":"The archival status of the requested item(s)."},{"required":false,"name":"author","description":"If specified, return items from any of these authors. It accepts a comma-separated list of user IDs."},{"required":false,"name":"limit","description":"Number of results to return. Defaults to its maximum of 50."},{"required":false,"name":"pageNum","description":"Page number of the results to return. Defaults to the first page, 1."},{"required":false,"name":"order","description":"The field on which to order the result set. Defaults to updated_at. Must be one of: updated_at."},{"required":false,"name":"orderDir","description":"Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc."}],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/jobs?state=running","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer 2G4G3GtLXAMh3MMa8jLrqmLlAfemR2Bs78xMMFg1WDc","Host":"api.civis.test","Cookie":""},"request_query_parameters":{"state":"running"},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 12,\n \"name\": \"Test Job 10\",\n \"type\": \"JobTypes::Test\",\n \"fromTemplateId\": null,\n \"state\": \"running\",\n \"createdAt\": \"2025-02-26T17:48:33.000Z\",\n \"updatedAt\": \"2025-02-26T15:48:33.000Z\",\n \"lastRun\": {\n \"id\": 7,\n \"state\": \"running\",\n \"createdAt\": \"2025-02-26T17:48:33.000Z\",\n \"startedAt\": null,\n \"finishedAt\": null,\n \"error\": null\n },\n \"archived\": false,\n \"author\": {\n \"id\": 37,\n \"name\": \"User devuserfactory26 26\",\n \"username\": \"devuserfactory26\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n }\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","X-Pagination-Per-Page":"50","Access-Control-Expose-Headers":"X-Pagination-Per-Page, X-Pagination-Current-Page, X-Pagination-Total-Pages, X-Pagination-Total-Entries","X-Pagination-Current-Page":"1","X-Pagination-Total-Pages":"1","X-Pagination-Total-Entries":"1","Content-Type":"application/json; charset=utf-8","ETag":"W/\"cad032ae4d9a0a14bb30348080f0f5fa\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"4cb79d50-c08b-4d92-aa2d-3e6af65e9c74","X-Runtime":"0.029921","Content-Length":"573"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/jobs?state=running\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer 2G4G3GtLXAMh3MMa8jLrqmLlAfemR2Bs78xMMFg1WDc\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Jobs","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/jobs?state=queued,running","description":"List all jobs in multiple state","explanation":null,"parameters":[{"required":false,"name":"state","description":"The job's state. One or more of queued, running, succeeded, failed, and cancelled. Specify multiple values as a comma-separated list (e.g., \"A,B\")."},{"required":false,"name":"type","description":"The job's type. Specify multiple values as a comma-separated list (e.g., \"A,B\")."},{"required":false,"name":"q","description":"Query string to search on the id, name, and job type."},{"required":false,"name":"permission","description":"A permissions string, one of \"read\", \"write\", or \"manage\". Lists only jobs for which the current user has that permission."},{"required":false,"name":"scheduled","description":"If the item is scheduled."},{"required":false,"name":"hidden","description":"If specified to be true, returns hidden items. Defaults to false, returning non-hidden items."},{"required":false,"name":"archived","description":"The archival status of the requested item(s)."},{"required":false,"name":"author","description":"If specified, return items from any of these authors. It accepts a comma-separated list of user IDs."},{"required":false,"name":"limit","description":"Number of results to return. Defaults to its maximum of 50."},{"required":false,"name":"pageNum","description":"Page number of the results to return. Defaults to the first page, 1."},{"required":false,"name":"order","description":"The field on which to order the result set. Defaults to updated_at. Must be one of: updated_at."},{"required":false,"name":"orderDir","description":"Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc."}],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/jobs?state=queued,running","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer hA_BuPFWLYAqcFiUHXofZiI8Z8FYYWTEk_5Rv4RMgxE","Host":"api.civis.test","Cookie":""},"request_query_parameters":{"state":"queued,running"},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 18,\n \"name\": \"Test Job 15\",\n \"type\": \"JobTypes::CassNcoa\",\n \"fromTemplateId\": null,\n \"state\": \"queued\",\n \"createdAt\": \"2025-02-26T17:48:34.000Z\",\n \"updatedAt\": \"2025-02-26T16:48:34.000Z\",\n \"lastRun\": {\n \"id\": 11,\n \"state\": \"queued\",\n \"createdAt\": \"2025-02-26T17:48:34.000Z\",\n \"startedAt\": null,\n \"finishedAt\": null,\n \"error\": null\n },\n \"archived\": false,\n \"author\": {\n \"id\": 47,\n \"name\": \"User devuserfactory35 35\",\n \"username\": \"devuserfactory35\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"schedule\": {\n \"scheduled\": true,\n \"scheduledDays\": [\n 0\n ],\n \"scheduledHours\": [\n 12\n ],\n \"scheduledMinutes\": [\n 30\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n }\n },\n {\n \"id\": 17,\n \"name\": \"Test Job 14\",\n \"type\": \"JobTypes::Test\",\n \"fromTemplateId\": null,\n \"state\": \"running\",\n \"createdAt\": \"2025-02-26T17:48:34.000Z\",\n \"updatedAt\": \"2025-02-26T15:48:34.000Z\",\n \"lastRun\": {\n \"id\": 10,\n \"state\": \"running\",\n \"createdAt\": \"2025-02-26T17:48:34.000Z\",\n \"startedAt\": null,\n \"finishedAt\": null,\n \"error\": null\n },\n \"archived\": false,\n \"author\": {\n \"id\": 46,\n \"name\": \"User devuserfactory34 34\",\n \"username\": \"devuserfactory34\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n }\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","X-Pagination-Per-Page":"50","Access-Control-Expose-Headers":"X-Pagination-Per-Page, X-Pagination-Current-Page, X-Pagination-Total-Pages, X-Pagination-Total-Entries","X-Pagination-Current-Page":"1","X-Pagination-Total-Pages":"1","X-Pagination-Total-Entries":"2","Content-Type":"application/json; charset=utf-8","ETag":"W/\"bba5e87f2ee37ac0e85de617acc19ced\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"96179c2f-5a7f-47f8-8c30-6499ec47135f","X-Runtime":"0.033133","Content-Length":"1154"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/jobs?state=queued,running\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer hA_BuPFWLYAqcFiUHXofZiI8Z8FYYWTEk_5Rv4RMgxE\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Jobs","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/jobs?type=JobTypes::Test","description":"List all jobs of the specified type","explanation":null,"parameters":[{"required":false,"name":"state","description":"The job's state. One or more of queued, running, succeeded, failed, and cancelled. Specify multiple values as a comma-separated list (e.g., \"A,B\")."},{"required":false,"name":"type","description":"The job's type. Specify multiple values as a comma-separated list (e.g., \"A,B\")."},{"required":false,"name":"q","description":"Query string to search on the id, name, and job type."},{"required":false,"name":"permission","description":"A permissions string, one of \"read\", \"write\", or \"manage\". Lists only jobs for which the current user has that permission."},{"required":false,"name":"scheduled","description":"If the item is scheduled."},{"required":false,"name":"hidden","description":"If specified to be true, returns hidden items. Defaults to false, returning non-hidden items."},{"required":false,"name":"archived","description":"The archival status of the requested item(s)."},{"required":false,"name":"author","description":"If specified, return items from any of these authors. It accepts a comma-separated list of user IDs."},{"required":false,"name":"limit","description":"Number of results to return. Defaults to its maximum of 50."},{"required":false,"name":"pageNum","description":"Page number of the results to return. Defaults to the first page, 1."},{"required":false,"name":"order","description":"The field on which to order the result set. Defaults to updated_at. Must be one of: updated_at."},{"required":false,"name":"orderDir","description":"Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc."}],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/jobs?type=JobTypes:%3ATest","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer 3PcJNPltbx8j3TbuMri-z_DIz4jS_P0VEfPqx1-oblA","Host":"api.civis.test","Cookie":""},"request_query_parameters":{"type":"JobTypes::Test"},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 22,\n \"name\": \"Test Job 18\",\n \"type\": \"JobTypes::Test\",\n \"fromTemplateId\": null,\n \"state\": \"running\",\n \"createdAt\": \"2025-02-26T17:48:34.000Z\",\n \"updatedAt\": \"2025-02-26T15:48:34.000Z\",\n \"lastRun\": {\n \"id\": 13,\n \"state\": \"running\",\n \"createdAt\": \"2025-02-26T17:48:34.000Z\",\n \"startedAt\": null,\n \"finishedAt\": null,\n \"error\": null\n },\n \"archived\": false,\n \"author\": {\n \"id\": 55,\n \"name\": \"User devuserfactory42 42\",\n \"username\": \"devuserfactory42\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n }\n },\n {\n \"id\": 21,\n \"name\": \"Test Job 17\",\n \"type\": \"JobTypes::Test\",\n \"fromTemplateId\": null,\n \"state\": \"idle\",\n \"createdAt\": \"2025-02-26T17:48:34.000Z\",\n \"updatedAt\": \"2025-02-26T14:48:34.000Z\",\n \"lastRun\": null,\n \"archived\": false,\n \"author\": {\n \"id\": 54,\n \"name\": \"User devuserfactory41 41\",\n \"username\": \"devuserfactory41\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n }\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","X-Pagination-Per-Page":"50","Access-Control-Expose-Headers":"X-Pagination-Per-Page, X-Pagination-Current-Page, X-Pagination-Total-Pages, X-Pagination-Total-Entries","X-Pagination-Current-Page":"1","X-Pagination-Total-Pages":"1","X-Pagination-Total-Entries":"2","Content-Type":"application/json; charset=utf-8","ETag":"W/\"bd1d4bdbaf745e26a842c81913493594\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"0b23ffde-b817-4251-aef9-2520cc8f279b","X-Runtime":"0.032148","Content-Length":"1034"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/jobs?type=JobTypes:%3ATest\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer 3PcJNPltbx8j3TbuMri-z_DIz4jS_P0VEfPqx1-oblA\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Jobs","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/jobs?type=JobTypes::Test,JobTypes::CassNcoa","description":"List all jobs of multiple types","explanation":null,"parameters":[{"required":false,"name":"state","description":"The job's state. One or more of queued, running, succeeded, failed, and cancelled. Specify multiple values as a comma-separated list (e.g., \"A,B\")."},{"required":false,"name":"type","description":"The job's type. Specify multiple values as a comma-separated list (e.g., \"A,B\")."},{"required":false,"name":"q","description":"Query string to search on the id, name, and job type."},{"required":false,"name":"permission","description":"A permissions string, one of \"read\", \"write\", or \"manage\". Lists only jobs for which the current user has that permission."},{"required":false,"name":"scheduled","description":"If the item is scheduled."},{"required":false,"name":"hidden","description":"If specified to be true, returns hidden items. Defaults to false, returning non-hidden items."},{"required":false,"name":"archived","description":"The archival status of the requested item(s)."},{"required":false,"name":"author","description":"If specified, return items from any of these authors. It accepts a comma-separated list of user IDs."},{"required":false,"name":"limit","description":"Number of results to return. Defaults to its maximum of 50."},{"required":false,"name":"pageNum","description":"Page number of the results to return. Defaults to the first page, 1."},{"required":false,"name":"order","description":"The field on which to order the result set. Defaults to updated_at. Must be one of: updated_at."},{"required":false,"name":"orderDir","description":"Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc."}],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/jobs?type=JobTypes:%3ATest,JobTypes:%3ACassNcoa","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer kXDgh4_ACOlAXlP67TqE5gFs2u57lHWCbO_vGYxphO8","Host":"api.civis.test","Cookie":""},"request_query_parameters":{"type":"JobTypes::Test,JobTypes::CassNcoa"},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 28,\n \"name\": \"Test Job 23\",\n \"type\": \"JobTypes::CassNcoa\",\n \"fromTemplateId\": null,\n \"state\": \"queued\",\n \"createdAt\": \"2025-02-26T17:48:35.000Z\",\n \"updatedAt\": \"2025-02-26T16:48:35.000Z\",\n \"lastRun\": {\n \"id\": 17,\n \"state\": \"queued\",\n \"createdAt\": \"2025-02-26T17:48:35.000Z\",\n \"startedAt\": null,\n \"finishedAt\": null,\n \"error\": null\n },\n \"archived\": false,\n \"author\": {\n \"id\": 65,\n \"name\": \"User devuserfactory51 51\",\n \"username\": \"devuserfactory51\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"schedule\": {\n \"scheduled\": true,\n \"scheduledDays\": [\n 0\n ],\n \"scheduledHours\": [\n 12\n ],\n \"scheduledMinutes\": [\n 30\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n }\n },\n {\n \"id\": 27,\n \"name\": \"Test Job 22\",\n \"type\": \"JobTypes::Test\",\n \"fromTemplateId\": null,\n \"state\": \"running\",\n \"createdAt\": \"2025-02-26T17:48:35.000Z\",\n \"updatedAt\": \"2025-02-26T15:48:35.000Z\",\n \"lastRun\": {\n \"id\": 16,\n \"state\": \"running\",\n \"createdAt\": \"2025-02-26T17:48:35.000Z\",\n \"startedAt\": null,\n \"finishedAt\": null,\n \"error\": null\n },\n \"archived\": false,\n \"author\": {\n \"id\": 64,\n \"name\": \"User devuserfactory50 50\",\n \"username\": \"devuserfactory50\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n }\n },\n {\n \"id\": 26,\n \"name\": \"Test Job 21\",\n \"type\": \"JobTypes::Test\",\n \"fromTemplateId\": null,\n \"state\": \"idle\",\n \"createdAt\": \"2025-02-26T17:48:35.000Z\",\n \"updatedAt\": \"2025-02-26T14:48:35.000Z\",\n \"lastRun\": null,\n \"archived\": false,\n \"author\": {\n \"id\": 63,\n \"name\": \"User devuserfactory49 49\",\n \"username\": \"devuserfactory49\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n }\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","X-Pagination-Per-Page":"50","Access-Control-Expose-Headers":"X-Pagination-Per-Page, X-Pagination-Current-Page, X-Pagination-Total-Pages, X-Pagination-Total-Entries","X-Pagination-Current-Page":"1","X-Pagination-Total-Pages":"1","X-Pagination-Total-Entries":"3","Content-Type":"application/json; charset=utf-8","ETag":"W/\"d9c98db13d98c55a13576b2d95535bbe\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"0bcad674-3197-4506-a6d8-8e4188dcf89b","X-Runtime":"0.035203","Content-Length":"1614"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/jobs?type=JobTypes:%3ATest,JobTypes:%3ACassNcoa\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer kXDgh4_ACOlAXlP67TqE5gFs2u57lHWCbO_vGYxphO8\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Jobs","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/jobs?q=Test Job","description":"List all jobs based on query parameter","explanation":null,"parameters":[{"required":false,"name":"state","description":"The job's state. One or more of queued, running, succeeded, failed, and cancelled. Specify multiple values as a comma-separated list (e.g., \"A,B\")."},{"required":false,"name":"type","description":"The job's type. Specify multiple values as a comma-separated list (e.g., \"A,B\")."},{"required":false,"name":"q","description":"Query string to search on the id, name, and job type."},{"required":false,"name":"permission","description":"A permissions string, one of \"read\", \"write\", or \"manage\". Lists only jobs for which the current user has that permission."},{"required":false,"name":"scheduled","description":"If the item is scheduled."},{"required":false,"name":"hidden","description":"If specified to be true, returns hidden items. Defaults to false, returning non-hidden items."},{"required":false,"name":"archived","description":"The archival status of the requested item(s)."},{"required":false,"name":"author","description":"If specified, return items from any of these authors. It accepts a comma-separated list of user IDs."},{"required":false,"name":"limit","description":"Number of results to return. Defaults to its maximum of 50."},{"required":false,"name":"pageNum","description":"Page number of the results to return. Defaults to the first page, 1."},{"required":false,"name":"order","description":"The field on which to order the result set. Defaults to updated_at. Must be one of: updated_at."},{"required":false,"name":"orderDir","description":"Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc."}],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/jobs?q=Test Job","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer ttYzvX2Br3AcuMeDMQraQigzU_GQVAx48jCsw5O2iys","Host":"api.civis.test","Cookie":""},"request_query_parameters":{"q":"Test Job"},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 33,\n \"name\": \"Test Job 27\",\n \"type\": \"JobTypes::CassNcoa\",\n \"fromTemplateId\": null,\n \"state\": \"queued\",\n \"createdAt\": \"2025-02-26T17:48:36.000Z\",\n \"updatedAt\": \"2025-02-26T16:48:36.000Z\",\n \"lastRun\": {\n \"id\": 20,\n \"state\": \"queued\",\n \"createdAt\": \"2025-02-26T17:48:36.000Z\",\n \"startedAt\": null,\n \"finishedAt\": null,\n \"error\": null\n },\n \"archived\": false,\n \"author\": {\n \"id\": 74,\n \"name\": \"User devuserfactory59 59\",\n \"username\": \"devuserfactory59\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"schedule\": {\n \"scheduled\": true,\n \"scheduledDays\": [\n 0\n ],\n \"scheduledHours\": [\n 12\n ],\n \"scheduledMinutes\": [\n 30\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n }\n },\n {\n \"id\": 32,\n \"name\": \"Test Job 26\",\n \"type\": \"JobTypes::Test\",\n \"fromTemplateId\": null,\n \"state\": \"running\",\n \"createdAt\": \"2025-02-26T17:48:35.000Z\",\n \"updatedAt\": \"2025-02-26T15:48:36.000Z\",\n \"lastRun\": {\n \"id\": 19,\n \"state\": \"running\",\n \"createdAt\": \"2025-02-26T17:48:36.000Z\",\n \"startedAt\": null,\n \"finishedAt\": null,\n \"error\": null\n },\n \"archived\": false,\n \"author\": {\n \"id\": 73,\n \"name\": \"User devuserfactory58 58\",\n \"username\": \"devuserfactory58\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n }\n },\n {\n \"id\": 31,\n \"name\": \"Test Job 25\",\n \"type\": \"JobTypes::Test\",\n \"fromTemplateId\": null,\n \"state\": \"idle\",\n \"createdAt\": \"2025-02-26T17:48:35.000Z\",\n \"updatedAt\": \"2025-02-26T14:48:35.000Z\",\n \"lastRun\": null,\n \"archived\": false,\n \"author\": {\n \"id\": 72,\n \"name\": \"User devuserfactory57 57\",\n \"username\": \"devuserfactory57\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n }\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","X-Pagination-Per-Page":"50","Access-Control-Expose-Headers":"X-Pagination-Per-Page, X-Pagination-Current-Page, X-Pagination-Total-Pages, X-Pagination-Total-Entries","X-Pagination-Current-Page":"1","X-Pagination-Total-Pages":"1","X-Pagination-Total-Entries":"3","Content-Type":"application/json; charset=utf-8","ETag":"W/\"6b4b421175bb3d31d53a5f701d407aa4\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"ea037d12-b009-4235-9466-82cbf2591a2a","X-Runtime":"0.035673","Content-Length":"1614"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/jobs?q=Test Job\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer ttYzvX2Br3AcuMeDMQraQigzU_GQVAx48jCsw5O2iys\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Jobs","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/jobs?scheduled=False","description":"List all jobs based on whether they are scheduled","explanation":null,"parameters":[{"required":false,"name":"state","description":"The job's state. One or more of queued, running, succeeded, failed, and cancelled. Specify multiple values as a comma-separated list (e.g., \"A,B\")."},{"required":false,"name":"type","description":"The job's type. Specify multiple values as a comma-separated list (e.g., \"A,B\")."},{"required":false,"name":"q","description":"Query string to search on the id, name, and job type."},{"required":false,"name":"permission","description":"A permissions string, one of \"read\", \"write\", or \"manage\". Lists only jobs for which the current user has that permission."},{"required":false,"name":"scheduled","description":"If the item is scheduled."},{"required":false,"name":"hidden","description":"If specified to be true, returns hidden items. Defaults to false, returning non-hidden items."},{"required":false,"name":"archived","description":"The archival status of the requested item(s)."},{"required":false,"name":"author","description":"If specified, return items from any of these authors. It accepts a comma-separated list of user IDs."},{"required":false,"name":"limit","description":"Number of results to return. Defaults to its maximum of 50."},{"required":false,"name":"pageNum","description":"Page number of the results to return. Defaults to the first page, 1."},{"required":false,"name":"order","description":"The field on which to order the result set. Defaults to updated_at. Must be one of: updated_at."},{"required":false,"name":"orderDir","description":"Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc."}],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/jobs?scheduled=False","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer -Paxy3hBhi265baytFV1HTvv4Bt6yy6qGUIzpcMvDb4","Host":"api.civis.test","Cookie":""},"request_query_parameters":{"scheduled":"False"},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 39,\n \"name\": \"Query\",\n \"type\": \"JobTypes::Query\",\n \"fromTemplateId\": null,\n \"state\": \"succeeded\",\n \"createdAt\": \"2025-02-26T17:48:36.000Z\",\n \"updatedAt\": \"2025-02-26T17:18:37.000Z\",\n \"lastRun\": {\n \"id\": 24,\n \"state\": \"succeeded\",\n \"createdAt\": \"2025-02-26T17:48:37.000Z\",\n \"startedAt\": \"2025-02-26T17:17:36.000Z\",\n \"finishedAt\": \"2025-02-26T17:18:36.000Z\",\n \"error\": null\n },\n \"archived\": false,\n \"author\": {\n \"id\": 84,\n \"name\": \"User devuserfactory68 68\",\n \"username\": \"devuserfactory68\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n }\n },\n {\n \"id\": 37,\n \"name\": \"Test Job 30\",\n \"type\": \"JobTypes::Test\",\n \"fromTemplateId\": null,\n \"state\": \"running\",\n \"createdAt\": \"2025-02-26T17:48:36.000Z\",\n \"updatedAt\": \"2025-02-26T15:48:36.000Z\",\n \"lastRun\": {\n \"id\": 22,\n \"state\": \"running\",\n \"createdAt\": \"2025-02-26T17:48:36.000Z\",\n \"startedAt\": null,\n \"finishedAt\": null,\n \"error\": null\n },\n \"archived\": false,\n \"author\": {\n \"id\": 82,\n \"name\": \"User devuserfactory66 66\",\n \"username\": \"devuserfactory66\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n }\n },\n {\n \"id\": 36,\n \"name\": \"Test Job 29\",\n \"type\": \"JobTypes::Test\",\n \"fromTemplateId\": null,\n \"state\": \"idle\",\n \"createdAt\": \"2025-02-26T17:48:36.000Z\",\n \"updatedAt\": \"2025-02-26T14:48:36.000Z\",\n \"lastRun\": null,\n \"archived\": false,\n \"author\": {\n \"id\": 81,\n \"name\": \"User devuserfactory65 65\",\n \"username\": \"devuserfactory65\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n }\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","X-Pagination-Per-Page":"50","Access-Control-Expose-Headers":"X-Pagination-Per-Page, X-Pagination-Current-Page, X-Pagination-Total-Pages, X-Pagination-Total-Entries","X-Pagination-Current-Page":"1","X-Pagination-Total-Pages":"1","X-Pagination-Total-Entries":"3","Content-Type":"application/json; charset=utf-8","ETag":"W/\"3679dcb6fb37c389fa4e23a0c914d462\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"4c57b85a-f8a6-4fc5-9154-770c9e4cc7f8","X-Runtime":"0.039814","Content-Length":"1650"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/jobs?scheduled=False\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer -Paxy3hBhi265baytFV1HTvv4Bt6yy6qGUIzpcMvDb4\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Jobs","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/jobs?permission=manage","description":"List only jobs that this user has permission to manage","explanation":null,"parameters":[{"required":false,"name":"state","description":"The job's state. One or more of queued, running, succeeded, failed, and cancelled. Specify multiple values as a comma-separated list (e.g., \"A,B\")."},{"required":false,"name":"type","description":"The job's type. Specify multiple values as a comma-separated list (e.g., \"A,B\")."},{"required":false,"name":"q","description":"Query string to search on the id, name, and job type."},{"required":false,"name":"permission","description":"A permissions string, one of \"read\", \"write\", or \"manage\". Lists only jobs for which the current user has that permission."},{"required":false,"name":"scheduled","description":"If the item is scheduled."},{"required":false,"name":"hidden","description":"If specified to be true, returns hidden items. Defaults to false, returning non-hidden items."},{"required":false,"name":"archived","description":"The archival status of the requested item(s)."},{"required":false,"name":"author","description":"If specified, return items from any of these authors. It accepts a comma-separated list of user IDs."},{"required":false,"name":"limit","description":"Number of results to return. Defaults to its maximum of 50."},{"required":false,"name":"pageNum","description":"Page number of the results to return. Defaults to the first page, 1."},{"required":false,"name":"order","description":"The field on which to order the result set. Defaults to updated_at. Must be one of: updated_at."},{"required":false,"name":"orderDir","description":"Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc."}],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/jobs?permission=manage","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer vFYK6aZG3rFBrKiqVP8py_ekYhobqvU9A5q2TO_KHuA","Host":"api.civis.test","Cookie":""},"request_query_parameters":{"permission":"manage"},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 46,\n \"name\": \"Test Job 37\",\n \"type\": \"JobTypes::Test\",\n \"fromTemplateId\": null,\n \"state\": \"idle\",\n \"createdAt\": \"2025-02-26T17:48:37.000Z\",\n \"updatedAt\": \"2025-02-26T17:48:37.000Z\",\n \"lastRun\": null,\n \"archived\": false,\n \"author\": {\n \"id\": 98,\n \"name\": \"User devuserfactory81 81\",\n \"username\": \"devuserfactory81\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n }\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","X-Pagination-Per-Page":"50","Access-Control-Expose-Headers":"X-Pagination-Per-Page, X-Pagination-Current-Page, X-Pagination-Total-Pages, X-Pagination-Total-Entries","X-Pagination-Current-Page":"1","X-Pagination-Total-Pages":"1","X-Pagination-Total-Entries":"1","Content-Type":"application/json; charset=utf-8","ETag":"W/\"7523784b429c28b32cb8f93f30e1e209\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"85b597fb-ce00-4e96-83e4-9dd9b4bc137b","X-Runtime":"0.034666","Content-Length":"461"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/jobs?permission=manage\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer vFYK6aZG3rFBrKiqVP8py_ekYhobqvU9A5q2TO_KHuA\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/jobs/{id}":{"get":{"summary":"Show basic job info","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID for this job.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object319"}}},"x-examples":[{"resource":"Jobs","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/jobs/:id","description":"View a job","explanation":null,"parameters":[{"required":true,"name":"id","description":"The ID for this job."}],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/jobs/48","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer dm4b-Zb3bkPQMZYduh4V7AocLcFzqFen9N1JQHVS6f8","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 48,\n \"name\": \"Test Job 39\",\n \"type\": \"JobTypes::Test\",\n \"fromTemplateId\": null,\n \"state\": \"running\",\n \"createdAt\": \"2025-02-26T17:48:38.000Z\",\n \"updatedAt\": \"2025-02-26T17:48:38.000Z\",\n \"runs\": [\n {\n \"id\": 28,\n \"state\": \"running\",\n \"createdAt\": \"2025-02-26T17:48:38.000Z\",\n \"startedAt\": null,\n \"finishedAt\": null,\n \"error\": null\n }\n ],\n \"lastRun\": {\n \"id\": 28,\n \"state\": \"running\",\n \"createdAt\": \"2025-02-26T17:48:38.000Z\",\n \"startedAt\": null,\n \"finishedAt\": null,\n \"error\": null\n },\n \"hidden\": false,\n \"archived\": false,\n \"author\": {\n \"id\": 100,\n \"name\": \"Admin devadminfactory14 14\",\n \"username\": \"devadminfactory14\",\n \"initials\": \"AD\",\n \"online\": null\n },\n \"myPermissionLevel\": \"manage\",\n \"successEmailSubject\": null,\n \"successEmailBody\": null,\n \"runningAsUser\": \"devadminfactory14\",\n \"runByUser\": \"devadminfactory14\",\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n }\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"16a0e53120e87d0c12ce9904a2229d0a\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"934e37ab-220d-4c25-978e-d5b089af0715","X-Runtime":"0.040396","Content-Length":"863"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/jobs/48\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer dm4b-Zb3bkPQMZYduh4V7AocLcFzqFen9N1JQHVS6f8\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/jobs/{id}/trigger_email":{"post":{"summary":"Generate and retrieve trigger email address","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID for this job.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object320"}}},"x-examples":[{"resource":"Jobs","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/jobs/:id/trigger_email","description":"Generate an email trigger address","explanation":null,"parameters":[{"required":true,"name":"id","description":"The ID for this job."}],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/jobs/47/trigger_email","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer ejd3iRoT_eIq1VoGwvNJfcQidMOnGB61a8IgIgXE9ok","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"triggerEmail\": \"console-inbound+run.47.ab68878acea1a3c11968f208ad6773c7@civisanalytics.com\"\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"129c0718dda4fbce81934d2c80a7d553\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"99c16634-d64c-4068-a186-1dfa49a0f237","X-Runtime":"0.252221","Content-Length":"93"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/jobs/47/trigger_email\" -d '' -X POST \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer ejd3iRoT_eIq1VoGwvNJfcQidMOnGB61a8IgIgXE9ok\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/jobs/{id}/parents":{"get":{"summary":"Show chain of parents as a list that this job triggers from","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID for this job.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object319"}}},"x-examples":[{"resource":"Jobs","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/jobs/:id/parents","description":"View a job that has no parent","explanation":null,"parameters":[{"required":true,"name":"id","description":"The ID for this job."}],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/jobs/58/parents","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer P7wzs_8xD3CqMNYMfLAWoMfylFXbrcXMaT4MQ5deJtg","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"4f53cda18c2baa0c0354bb5f9a3ecbe5\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"2cc6ffcf-1638-4715-b6a4-25b5ab1aa8e9","X-Runtime":"0.026720","Content-Length":"2"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/jobs/58/parents\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer P7wzs_8xD3CqMNYMfLAWoMfylFXbrcXMaT4MQ5deJtg\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Jobs","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/jobs/:job_with_parent_id/parents","description":"View a job with a parent","explanation":null,"parameters":[{"required":true,"name":"id","description":"The ID for this job."}],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/jobs/60/parents?id=59","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer iHd6_P7tCf-is8T7amE67tfHG7r04z5OyU1r89iXmRs","Host":"api.civis.test","Cookie":""},"request_query_parameters":{"id":"59"},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 59,\n \"name\": \"Test Job 49\",\n \"type\": \"JobTypes::Test\",\n \"fromTemplateId\": null,\n \"state\": \"idle\",\n \"createdAt\": \"2025-02-26T17:48:41.000Z\",\n \"updatedAt\": \"2025-02-26T17:48:41.000Z\",\n \"runs\": [\n\n ],\n \"lastRun\": null,\n \"hidden\": false,\n \"archived\": false,\n \"author\": {\n \"id\": 117,\n \"name\": \"Admin devadminfactory23 23\",\n \"username\": \"devadminfactory23\",\n \"initials\": \"AD\",\n \"online\": null\n },\n \"myPermissionLevel\": \"manage\",\n \"successEmailSubject\": null,\n \"successEmailBody\": null,\n \"runningAsUser\": \"devadminfactory23\",\n \"runByUser\": null,\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n }\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"9b76634bef2abc7b2e2d0cd6ee0b8130\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"52e3925c-07d6-4450-b0e1-ed7c136d845a","X-Runtime":"0.038350","Content-Length":"623"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/jobs/60/parents?id=59\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer iHd6_P7tCf-is8T7amE67tfHG7r04z5OyU1r89iXmRs\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/jobs/{id}/children":{"get":{"summary":"Show nested tree of children that this job triggers","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID for this job.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object321"}}},"x-examples":[{"resource":"Jobs","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/jobs/:id/children","description":"View a job with no children","explanation":null,"parameters":[{"required":true,"name":"id","description":"The ID for this job."}],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/jobs/65/children","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer GmVi1P9dopLge5Nv9ZceNs6NwJFXrkdzD8pssRr-LNE","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"4f53cda18c2baa0c0354bb5f9a3ecbe5\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"95e3a1a2-8991-450a-917f-ea1eafda6863","X-Runtime":"0.029077","Content-Length":"2"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/jobs/65/children\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer GmVi1P9dopLge5Nv9ZceNs6NwJFXrkdzD8pssRr-LNE\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Jobs","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/jobs/:child_job_id/children","description":"View a jobs children","explanation":null,"parameters":[{"required":true,"name":"id","description":"The ID for this job."}],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/jobs/66/children?id=70","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer xyuaoQWB8b5ko9igK5XFlcr0IzJC2432qZgMhxpT8M8","Host":"api.civis.test","Cookie":""},"request_query_parameters":{"id":"70"},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 68,\n \"name\": \"Test Job 58\",\n \"type\": \"JobTypes::Test\",\n \"fromTemplateId\": null,\n \"state\": \"idle\",\n \"createdAt\": \"2025-02-26T17:48:41.000Z\",\n \"updatedAt\": \"2025-02-26T17:48:41.000Z\",\n \"runs\": [\n\n ],\n \"lastRun\": null,\n \"children\": [\n\n ]\n },\n {\n \"id\": 69,\n \"name\": \"Test Job 59\",\n \"type\": \"JobTypes::Test\",\n \"fromTemplateId\": null,\n \"state\": \"idle\",\n \"createdAt\": \"2025-02-26T17:48:41.000Z\",\n \"updatedAt\": \"2025-02-26T17:48:41.000Z\",\n \"runs\": [\n\n ],\n \"lastRun\": null,\n \"children\": [\n\n ]\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"783c27bb5b03b0cfa05fa599e59de429\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"3750ff97-40ea-4e88-9cca-09bf667a961d","X-Runtime":"0.044632","Content-Length":"419"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/jobs/66/children?id=70\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer xyuaoQWB8b5ko9igK5XFlcr0IzJC2432qZgMhxpT8M8\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Jobs","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/jobs/:parent_job_id/children","description":"View a jobs children with grandchild","explanation":null,"parameters":[{"required":true,"name":"id","description":"The ID for this job."}],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/jobs/72/children?id=75","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer Ew-FJ_jSb9IGiCZFCNuB4IneEs1F2DcJE078g9i_u7E","Host":"api.civis.test","Cookie":""},"request_query_parameters":{"id":"75"},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 71,\n \"name\": \"Test Job 61\",\n \"type\": \"JobTypes::Test\",\n \"fromTemplateId\": null,\n \"state\": \"idle\",\n \"createdAt\": \"2025-02-26T17:48:42.000Z\",\n \"updatedAt\": \"2025-02-26T17:48:42.000Z\",\n \"runs\": [\n\n ],\n \"lastRun\": null,\n \"children\": [\n {\n \"id\": 73,\n \"name\": \"Test Job 63\",\n \"type\": \"JobTypes::Test\",\n \"fromTemplateId\": null,\n \"state\": \"idle\",\n \"createdAt\": \"2025-02-26T17:48:42.000Z\",\n \"updatedAt\": \"2025-02-26T17:48:42.000Z\",\n \"runs\": [\n\n ],\n \"lastRun\": null,\n \"children\": [\n\n ]\n },\n {\n \"id\": 74,\n \"name\": \"Test Job 64\",\n \"type\": \"JobTypes::Test\",\n \"fromTemplateId\": null,\n \"state\": \"idle\",\n \"createdAt\": \"2025-02-26T17:48:42.000Z\",\n \"updatedAt\": \"2025-02-26T17:48:42.000Z\",\n \"runs\": [\n\n ],\n \"lastRun\": null,\n \"children\": [\n\n ]\n }\n ]\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"d3aa97c6451ed33b2c523a86192ba9b1\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"a090afad-6f36-4692-b03e-cea6f1d43875","X-Runtime":"0.045253","Content-Length":"627"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/jobs/72/children?id=75\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer Ew-FJ_jSb9IGiCZFCNuB4IneEs1F2DcJE078g9i_u7E\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/jobs/{id}/runs":{"get":{"summary":"List runs for the given job","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID for this job.","type":"integer"},{"name":"limit","in":"query","required":false,"description":"Number of results to return. Defaults to 20. Maximum allowed is 100.","type":"integer"},{"name":"page_num","in":"query","required":false,"description":"Page number of the results to return. Defaults to the first page, 1.","type":"integer"},{"name":"order","in":"query","required":false,"description":"The field on which to order the result set. Defaults to id. Must be one of: id.","type":"string"},{"name":"order_dir","in":"query","required":false,"description":"Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc.","type":"string"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object75"}}}},"x-examples":[{"resource":"Jobs","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/jobs/:id/runs","description":"Get a job's runs","explanation":null,"parameters":[{"required":true,"name":"id","description":"The ID for this job."}],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/jobs/49/runs","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer d290i_EyEWZVNsWEnZeinEXseVIuSL_oAR9grrcLBbU","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 30,\n \"state\": \"failed\",\n \"createdAt\": \"2025-02-26T17:48:38.000Z\",\n \"startedAt\": \"2025-02-26T17:47:38.000Z\",\n \"finishedAt\": \"2025-02-26T17:48:38.000Z\",\n \"error\": null\n },\n {\n \"id\": 29,\n \"state\": \"succeeded\",\n \"createdAt\": \"2025-02-26T17:48:38.000Z\",\n \"startedAt\": \"2025-02-26T17:43:38.000Z\",\n \"finishedAt\": \"2025-02-26T17:44:38.000Z\",\n \"error\": null\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","X-Pagination-Per-Page":"20","Access-Control-Expose-Headers":"X-Pagination-Per-Page, X-Pagination-Current-Page, X-Pagination-Total-Pages, X-Pagination-Total-Entries","X-Pagination-Current-Page":"1","X-Pagination-Total-Pages":"1","X-Pagination-Total-Entries":"2","Content-Type":"application/json; charset=utf-8","ETag":"W/\"cacae7f8b5eae2f62020d47e4b485036\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"316417c3-60d0-4867-97a9-65f8adfa8a2e","X-Runtime":"0.033941","Content-Length":"320"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/jobs/49/runs\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer d290i_EyEWZVNsWEnZeinEXseVIuSL_oAR9grrcLBbU\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"post":{"summary":"Run a job","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID for this job.","type":"integer"}],"responses":{"201":{"description":"success","schema":{"$ref":"#/definitions/Object75"}}},"x-examples":[{"resource":"Jobs","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/jobs/:id/runs","description":"Run a job","explanation":null,"parameters":[{"required":true,"name":"id","description":"The ID for this job."}],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/jobs/50/runs","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer RAzm1VuzkFvJ-YnLlro_CIpOWRVCrBryf6uLw8C_y2c","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":201,"response_status_text":"Created","response_body":"{\n \"id\": 31,\n \"state\": \"queued\",\n \"createdAt\": \"2025-02-26T17:48:38.000Z\",\n \"startedAt\": null,\n \"finishedAt\": null,\n \"error\": null\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"69e6c216523b464c4e9451ca8ce4c5c0\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"774b0c97-375d-4c5b-a367-1d7038c1970a","X-Runtime":"0.091445","Content-Length":"113"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/jobs/50/runs\" -d '' -X POST \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer RAzm1VuzkFvJ-YnLlro_CIpOWRVCrBryf6uLw8C_y2c\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Jobs","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/jobs/:id/runs","description":"Attempting to queue a running job returns an error","explanation":null,"parameters":[{"required":true,"name":"id","description":"The ID for this job."}],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/jobs/51/runs","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer xQWqss4yCTLu-ecmx6bkX7tBnFQcaP0_dis5qEAXF3Y","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":409,"response_status_text":"Conflict","response_body":"{\n \"error\": \"already_running\",\n \"errorDescription\": \"The job cannot be queued because it is already running\",\n \"code\": 409\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"e8c43564-bad4-4a6b-8ea6-aa2cee7cfdcc","X-Runtime":"0.035450","Content-Length":"114"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/jobs/51/runs\" -d '' -X POST \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer xQWqss4yCTLu-ecmx6bkX7tBnFQcaP0_dis5qEAXF3Y\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/jobs/{id}/runs/{run_id}":{"get":{"summary":"Check status of a job","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Job.","type":"integer"},{"name":"run_id","in":"path","required":true,"description":"The ID of the Run.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object75"}}},"x-examples":[{"resource":"Jobs","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/jobs/:id/runs/:run_id","description":"Check status of a job","explanation":null,"parameters":[{"required":true,"name":"id","description":"The ID for this job."}],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/jobs/52/runs/33","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer zincKq_-TAXkS8sPQqU7JQTQ3-sVhJSbeSRh9x1fhTc","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 33,\n \"state\": \"succeeded\",\n \"createdAt\": \"2025-02-26T17:48:39.000Z\",\n \"startedAt\": \"2025-02-26T17:47:39.000Z\",\n \"finishedAt\": \"2025-02-26T17:48:39.000Z\",\n \"error\": null\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"0e58e9750ab6eccc0ca4ef3b46bf0c5c\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"83fe4993-3739-45d5-b059-5d3fea6d13a8","X-Runtime":"0.049053","Content-Length":"160"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/jobs/52/runs/33\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer zincKq_-TAXkS8sPQqU7JQTQ3-sVhJSbeSRh9x1fhTc\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"delete":{"summary":"Cancel a run","description":"Cancel a currently active run.","deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Job.","type":"integer"},{"name":"run_id","in":"path","required":true,"description":"The ID of the Run.","type":"integer"}],"responses":{"202":{"description":"success"}},"x-examples":[{"resource":"Jobs","resource_explanation":null,"http_method":"DELETE","route":"http://api.civis.test/jobs/:id/runs/:run_id","description":"Cancel a running job","explanation":null,"parameters":[{"required":true,"name":"id","description":"The ID for this job."}],"response_fields":[],"requests":[{"request_method":"DELETE","request_path":"http://api.civis.test/jobs/53/runs/34","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer latj6zCiVMDp_olc5tm4ORu0-sM5FzpRfL86vN-umsk","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":202,"response_status_text":"Accepted","response_body":null,"response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"text/plain; charset=utf-8","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"5eb1c855-409b-4a62-8ecc-a1181b84cb76","X-Runtime":"0.168129","Content-Length":"0"},"response_content_type":"text/plain; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/jobs/53/runs/34\" -d '' -X DELETE \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer latj6zCiVMDp_olc5tm4ORu0-sM5FzpRfL86vN-umsk\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/jobs/{id}/runs/{run_id}/outputs":{"get":{"summary":"List the outputs for a run","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the job.","type":"integer"},{"name":"run_id","in":"path","required":true,"description":"The ID of the run.","type":"integer"},{"name":"limit","in":"query","required":false,"description":"Number of results to return. Defaults to its maximum of 50.","type":"integer"},{"name":"page_num","in":"query","required":false,"description":"Page number of the results to return. Defaults to the first page, 1.","type":"integer"},{"name":"order","in":"query","required":false,"description":"The field on which to order the result set. Defaults to created_at. Must be one of: created_at, id.","type":"string"},{"name":"order_dir","in":"query","required":false,"description":"Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc.","type":"string"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object324"}}}},"x-examples":[{"resource":"Jobs","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/jobs/:job_with_run_id/runs/:job_run_id/outputs","description":"View a job's outputs","explanation":null,"parameters":[{"required":true,"name":"id","description":"The ID for this job."}],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/jobs/54/runs/35/outputs?id=57","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer UtUCpgBXdo3W0ZdrNUWo5BNmHGWv_zs_Wq1xWfsvlms","Host":"api.civis.test","Cookie":""},"request_query_parameters":{"id":"57"},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"objectType\": \"File\",\n \"objectId\": 2,\n \"name\": \"my output file\",\n \"link\": \"api.civis.test/files/2\",\n \"value\": null\n },\n {\n \"objectType\": \"Report\",\n \"objectId\": 1,\n \"name\": \"my output report\",\n \"link\": \"api.civis.test/reports/1\",\n \"value\": null\n },\n {\n \"objectType\": \"Report\",\n \"objectId\": 2,\n \"name\": \"my output tableau report\",\n \"link\": \"api.civis.test/reports/2\",\n \"value\": null\n },\n {\n \"objectType\": \"Table\",\n \"objectId\": 1,\n \"name\": \"output.table\",\n \"link\": \"api.civis.test/tables/1\",\n \"value\": null\n },\n {\n \"objectType\": \"Project\",\n \"objectId\": 1,\n \"name\": \"my output project\",\n \"link\": \"api.civis.test/projects/1\",\n \"value\": null\n },\n {\n \"objectType\": \"Credential\",\n \"objectId\": 12,\n \"name\": \"my output credential\",\n \"link\": \"api.civis.test/credentials/12\",\n \"value\": null\n },\n {\n \"objectType\": \"JSONValue\",\n \"objectId\": 1,\n \"name\": \"my awesome JSON value\",\n \"link\": \"api.civis.test/json_values/1\",\n \"value\": {\n \"foo\": \"bar\"\n }\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","X-Pagination-Per-Page":"50","Access-Control-Expose-Headers":"X-Pagination-Per-Page, X-Pagination-Current-Page, X-Pagination-Total-Pages, X-Pagination-Total-Entries","X-Pagination-Current-Page":"1","X-Pagination-Total-Pages":"1","X-Pagination-Total-Entries":"7","Content-Type":"application/json; charset=utf-8","ETag":"W/\"2d1fd73a4b1de6c89ee45525cb8bc74d\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"5a20b30c-2cc3-49d2-97b4-cb1cde0e8eee","X-Runtime":"0.089220","Content-Length":"805"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/jobs/54/runs/35/outputs?id=57\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer UtUCpgBXdo3W0ZdrNUWo5BNmHGWv_zs_Wq1xWfsvlms\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/jobs/{id}/runs/{run_id}/logs":{"get":{"summary":"Get the logs for a run","description":"Get the logs for a run.","deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the job job.","type":"integer"},{"name":"run_id","in":"path","required":true,"description":"The ID of the run.","type":"integer"},{"name":"last_id","in":"query","required":false,"description":"The ID of the last log message received. Log entries with this ID value or lower will be omitted.Logs are sorted by ID if this value is provided, and are otherwise sorted by createdAt.","type":"integer"},{"name":"limit","in":"query","required":false,"description":"The maximum number of log messages to return. Default of 10000.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object117"}}}},"x-examples":[{"resource":"Jobs","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/jobs/:id/runs/:run_id/logs","description":"Get logs for a run","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/jobs/77/runs/36/logs","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer WN3xqcn2SrihIHbUHhrTLHmkPDFpiEdRCweICALOlb8","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 0,\n \"createdAt\": \"2025-02-26T16:48:42.651Z\",\n \"message\": \"Log message 0\",\n \"level\": \"debug\"\n },\n {\n \"id\": 1,\n \"createdAt\": \"2025-02-26T16:49:42.651Z\",\n \"message\": \"Log message 1\",\n \"level\": \"info\"\n },\n {\n \"id\": 2,\n \"createdAt\": \"2025-02-26T16:50:42.651Z\",\n \"message\": \"Log message 2\",\n \"level\": \"warn\"\n },\n {\n \"id\": 3,\n \"createdAt\": \"2025-02-26T16:51:42.651Z\",\n \"message\": \"Log message 3\",\n \"level\": \"error\"\n },\n {\n \"id\": 4,\n \"createdAt\": \"2025-02-26T16:52:42.651Z\",\n \"message\": \"Log message 4\",\n \"level\": \"fatal\"\n },\n {\n \"id\": 5,\n \"createdAt\": \"2025-02-26T16:53:42.651Z\",\n \"message\": \"Log message 5\",\n \"level\": \"unknown\"\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Access-Control-Expose-Headers":["Civis-Cache-Control","Civis-Max-Id"],"Civis-Cache-Control":"no-store","Civis-Max-Id":null,"Content-Type":"application/json; charset=utf-8","ETag":"W/\"0513f1e0bbbb98175f587effa78f8eff\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"e709e7e2-381f-4fe6-8a19-8fd28477c80d","X-Runtime":"0.028930","Content-Length":"541"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/jobs/77/runs/36/logs\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer WN3xqcn2SrihIHbUHhrTLHmkPDFpiEdRCweICALOlb8\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/jobs/{id}/workflows":{"get":{"summary":"List the workflows a job belongs to","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"type":"integer"},{"name":"archived","in":"query","required":false,"description":"The archival status of the requested item(s).","type":"string"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object325"}}}},"x-examples":[{"resource":"Jobs","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/jobs/:id/workflows","description":"View workflows associated with a job","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/jobs/76/workflows","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer OlW6UvLao5LBCalcv3sF5ldQeFmRedjVaDazkT5dx6k","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 1,\n \"name\": \"Test Workflow\",\n \"description\": null,\n \"valid\": true,\n \"fileId\": 5,\n \"user\": {\n \"id\": 121,\n \"name\": \"Admin devadminfactory27 27\",\n \"username\": \"devadminfactory27\",\n \"initials\": \"AD\",\n \"online\": null\n },\n \"state\": \"idle\",\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n },\n \"allowConcurrentExecutions\": true,\n \"timeZone\": \"America/Chicago\",\n \"nextExecutionAt\": null,\n \"archived\": false,\n \"createdAt\": \"2025-02-26T17:48:42.000Z\",\n \"updatedAt\": \"2025-02-26T17:48:42.000Z\"\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"0d7a91e3369c80d01d3448f3acfa3712\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"0b8d79e3-60ee-45a1-9caf-0c41c32cc477","X-Runtime":"0.039699","Content-Length":"531"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/jobs/76/workflows\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer OlW6UvLao5LBCalcv3sF5ldQeFmRedjVaDazkT5dx6k\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/jobs/{id}/shares":{"get":{"summary":"List users and groups permissioned on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object9"}}}},"x-examples":null,"x-deprecation-warning":null}},"/jobs/{id}/shares/users":{"put":{"summary":"Set the permissions users have on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"Object329","in":"body","schema":{"$ref":"#/definitions/Object329"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object9"}}},"x-examples":null,"x-deprecation-warning":null}},"/jobs/{id}/shares/users/{user_id}":{"delete":{"summary":"Revoke the permissions a user has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"user_id","in":"path","required":true,"description":"The ID of the user.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/jobs/{id}/shares/groups":{"put":{"summary":"Set the permissions groups has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"Object330","in":"body","schema":{"$ref":"#/definitions/Object330"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object9"}}},"x-examples":null,"x-deprecation-warning":null}},"/jobs/{id}/shares/groups/{group_id}":{"delete":{"summary":"Revoke the permissions a group has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"group_id","in":"path","required":true,"description":"The ID of the group.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/jobs/{id}/dependencies":{"get":{"summary":"List dependent objects for this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"user_id","in":"query","required":false,"description":"ID of target user","type":"integer"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object15"}}}},"x-examples":null,"x-deprecation-warning":null}},"/jobs/{id}/transfer":{"put":{"summary":"Transfer ownership of this object to another user","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"Object331","in":"body","schema":{"$ref":"#/definitions/Object331"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object17"}}},"x-examples":null,"x-deprecation-warning":null}},"/jobs/{id}/projects":{"get":{"summary":"List the projects a Job belongs to","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Job.","type":"integer"},{"name":"hidden","in":"query","required":false,"description":"If specified to be true, returns hidden items. Defaults to false, returning non-hidden items.","type":"boolean"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object85"}}}},"x-examples":null,"x-deprecation-warning":null}},"/jobs/{id}/projects/{project_id}":{"put":{"summary":"Add a Job to a project","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Job.","type":"integer"},{"name":"project_id","in":"path","required":true,"description":"The ID of the project.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null},"delete":{"summary":"Remove a Job from a project","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Job.","type":"integer"},{"name":"project_id","in":"path","required":true,"description":"The ID of the project.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/jobs/{id}/archive":{"put":{"summary":"Update the archive status of this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the object.","type":"integer"},{"name":"Object332","in":"body","schema":{"$ref":"#/definitions/Object332"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object319"}}},"x-examples":null,"x-deprecation-warning":null}},"/json_values/":{"post":{"summary":"Create a JSON Value","description":"Creates a JSON Value in Platform that can be used as a run output.","deprecated":false,"parameters":[{"name":"Object333","in":"body","schema":{"$ref":"#/definitions/Object333"},"required":true}],"responses":{"201":{"description":"success","schema":{"$ref":"#/definitions/Object334"}}},"x-examples":[{"resource":"JSONValues","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/json_values","description":"Create a JSONValue","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/json_values","request_body":"{\n \"name\": \"my awesome JSON Value\",\n \"value_str\": \"{\\\"foo\\\": \\\"bar\\\"}\"\n}","request_headers":{"Content-Type":"application/json","Authorization":"Bearer Ukc1HQdp7UIQBgEcwk41faLrWYeOAKkWsgXm8w5Vhqw","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":201,"response_status_text":"Created","response_body":"{\n \"id\": 11,\n \"name\": \"my awesome JSON Value\",\n \"value\": {\n \"foo\": \"bar\"\n }\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"b877ca0df07da087c3e9463a0346622f\"","X-Request-Id":"f8645842-e376-468d-acd1-0b98cee53493","X-Runtime":"0.050270","Content-Length":"62"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/json_values\" -d '{\"name\":\"my awesome JSON Value\",\"value_str\":\"{\\\"foo\\\": \\\"bar\\\"}\"}' -X POST \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer Ukc1HQdp7UIQBgEcwk41faLrWYeOAKkWsgXm8w5Vhqw\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/json_values/{id}":{"get":{"summary":"Get details about a JSON Value","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the JSON Value.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object334"}}},"x-examples":[{"resource":"JSONValues","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/json_values/:id","description":"Get a JSONValue","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/json_values/12","request_body":null,"request_headers":{"Content-Type":"application/json","Authorization":"Bearer ox1fOrN8_pW2Vu1UXGoqNo53Bri0Ul-dHJRJNV8CrEE","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 12,\n \"name\": \"my awesome JSON Value\",\n \"value\": 8\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"bc58617e74a168ad9a4b50e5eedbaf28\"","X-Request-Id":"ff85043a-ba9d-41b8-bdd4-322e5c42610a","X-Runtime":"0.043691","Content-Length":"50"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/json_values/12\" -X GET \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer ox1fOrN8_pW2Vu1UXGoqNo53Bri0Ul-dHJRJNV8CrEE\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"patch":{"summary":"Update some attributes of this JSON Value","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the JSON Value.","type":"integer"},{"name":"Object335","in":"body","schema":{"$ref":"#/definitions/Object335"},"required":false}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object334"}}},"x-examples":[{"resource":"JSONValues","resource_explanation":null,"http_method":"PATCH","route":"http://api.civis.test/json_values/:id","description":"Update a JSONValue","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"PATCH","request_path":"http://api.civis.test/json_values/13","request_body":"{\n \"name\": \"updated name\",\n \"value_str\": \"{\\\"foo2\\\": \\\"bar2\\\"}\"\n}","request_headers":{"Content-Type":"application/json","Authorization":"Bearer Vx9TB9DO_5OFKIPXMLFtIanSyOyLpF8-qo672-0tz_M","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 13,\n \"name\": \"updated name\",\n \"value\": {\n \"foo2\": \"bar2\"\n }\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"5fced5cf0d91a9b1b67ae65029af7f56\"","X-Request-Id":"dac51c95-00e4-4e40-a43c-18f7c24691df","X-Runtime":"0.020514","Content-Length":"55"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/json_values/13\" -d '{\"name\":\"updated name\",\"value_str\":\"{\\\"foo2\\\": \\\"bar2\\\"}\"}' -X PATCH \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer Vx9TB9DO_5OFKIPXMLFtIanSyOyLpF8-qo672-0tz_M\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/json_values/{id}/shares":{"get":{"summary":"List users and groups permissioned on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object9"}}}},"x-examples":null,"x-deprecation-warning":null}},"/json_values/{id}/shares/users":{"put":{"summary":"Set the permissions users have on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"Object336","in":"body","schema":{"$ref":"#/definitions/Object336"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object9"}}},"x-examples":null,"x-deprecation-warning":null}},"/json_values/{id}/shares/users/{user_id}":{"delete":{"summary":"Revoke the permissions a user has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"user_id","in":"path","required":true,"description":"The ID of the user.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/json_values/{id}/shares/groups":{"put":{"summary":"Set the permissions groups has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"Object337","in":"body","schema":{"$ref":"#/definitions/Object337"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object9"}}},"x-examples":null,"x-deprecation-warning":null}},"/json_values/{id}/shares/groups/{group_id}":{"delete":{"summary":"Revoke the permissions a group has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"group_id","in":"path","required":true,"description":"The ID of the group.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/json_values/{id}/dependencies":{"get":{"summary":"List dependent objects for this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"user_id","in":"query","required":false,"description":"ID of target user","type":"integer"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object15"}}}},"x-examples":null,"x-deprecation-warning":null}},"/json_values/{id}/transfer":{"put":{"summary":"Transfer ownership of this object to another user","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"Object338","in":"body","schema":{"$ref":"#/definitions/Object338"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object17"}}},"x-examples":null,"x-deprecation-warning":null}},"/match_targets/{id}/shares":{"get":{"summary":"List users and groups permissioned on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object9"}}}},"x-examples":null,"x-deprecation-warning":null}},"/match_targets/{id}/shares/users":{"put":{"summary":"Set the permissions users have on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"Object342","in":"body","schema":{"$ref":"#/definitions/Object342"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object9"}}},"x-examples":null,"x-deprecation-warning":null}},"/match_targets/{id}/shares/users/{user_id}":{"delete":{"summary":"Revoke the permissions a user has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"user_id","in":"path","required":true,"description":"The ID of the user.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/match_targets/{id}/shares/groups":{"put":{"summary":"Set the permissions groups has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"Object343","in":"body","schema":{"$ref":"#/definitions/Object343"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object9"}}},"x-examples":null,"x-deprecation-warning":null}},"/match_targets/{id}/shares/groups/{group_id}":{"delete":{"summary":"Revoke the permissions a group has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"group_id","in":"path","required":true,"description":"The ID of the group.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/match_targets/{id}/archive":{"put":{"summary":"Update the archive status of this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the object.","type":"integer"},{"name":"Object344","in":"body","schema":{"$ref":"#/definitions/Object344"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object345"}}},"x-examples":null,"x-deprecation-warning":null}},"/match_targets/":{"get":{"summary":"List match targets","description":null,"deprecated":false,"parameters":[],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object345"}}}},"x-examples":[{"resource":"Match Targets","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/match_targets","description":"Lists match targets","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/match_targets","request_body":null,"request_headers":{"Content-Type":"application/json","Authorization":"Bearer Nw5eZgitOQCAsxEv1JGuXzUbBGY3qplaqXhZxvYlk-M","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 1,\n \"name\": \"FriendlyString\",\n \"targetFileName\": \"some_file_in_s3\",\n \"createdAt\": \"2023-07-18T18:42:50.000Z\",\n \"updatedAt\": \"2023-07-18T18:42:50.000Z\",\n \"archived\": false\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"3b6c9b07b23fc50f3acd09a74a997a57\"","X-Request-Id":"0ed54c63-9004-4a31-931b-e9510213f255","X-Runtime":"0.012321","Content-Length":"164"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/match_targets\" -X GET \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer Nw5eZgitOQCAsxEv1JGuXzUbBGY3qplaqXhZxvYlk-M\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"post":{"summary":"Create a new match target","description":null,"deprecated":false,"parameters":[{"name":"Object346","in":"body","schema":{"$ref":"#/definitions/Object346"},"required":true}],"responses":{"201":{"description":"success","schema":{"$ref":"#/definitions/Object345"}}},"x-examples":[{"resource":"Match Targets","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/match_targets","description":"Creates a Dynamo match target","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/match_targets","request_body":"{\n \"name\": \"New Match Target\",\n \"target_file_name\": \"file_name\"\n}","request_headers":{"Content-Type":"application/json","Authorization":"Bearer EhjJXvOEbNSYHC8AT1tW4w3D5fpCzbRTS3x9GrEtVWM","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":201,"response_status_text":"Created","response_body":"{\n \"id\": null,\n \"name\": \"New Match Target\",\n \"targetFileName\": \"file_name\",\n \"createdAt\": null,\n \"updatedAt\": null,\n \"archived\": false\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"04710ce4d85980c79660116ceddd2a9f\"","X-Request-Id":"d6091c62-31af-4122-8282-f3d956bdfa4f","X-Runtime":"0.024653","Content-Length":"117"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/match_targets\" -d '{\"name\":\"New Match Target\",\"target_file_name\":\"file_name\"}' -X POST \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer EhjJXvOEbNSYHC8AT1tW4w3D5fpCzbRTS3x9GrEtVWM\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/match_targets/{id}":{"get":{"summary":"Show Match Target info","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the match target","type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object345"}}},"x-examples":[{"resource":"Match Targets","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/match_targets/:id","description":"View a match target's details","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/match_targets/2","request_body":null,"request_headers":{"Content-Type":"application/json","Authorization":"Bearer elw2EdkZB9_QLmgq0MyJXSJHGt58IZG6qIOsb6vxYi8","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 2,\n \"name\": \"FriendlyString\",\n \"targetFileName\": \"some_file_in_s3\",\n \"createdAt\": \"2023-07-18T18:42:50.000Z\",\n \"updatedAt\": \"2023-07-18T18:42:50.000Z\",\n \"archived\": false\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"2d5c426769a1148961bcb00798d80bf8\"","X-Request-Id":"d7aeec2c-6852-4fa9-9310-f9730109eccd","X-Runtime":"0.012820","Content-Length":"162"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/match_targets/2\" -X GET \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer elw2EdkZB9_QLmgq0MyJXSJHGt58IZG6qIOsb6vxYi8\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"patch":{"summary":"Update a match target","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the match target","type":"integer"},{"name":"Object347","in":"body","schema":{"$ref":"#/definitions/Object347"},"required":false}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object345"}}},"x-examples":[{"resource":"Match Targets","resource_explanation":null,"http_method":"PATCH","route":"http://api.civis.test/match_targets/:id","description":"updates a match target","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"PATCH","request_path":"http://api.civis.test/match_targets/4","request_body":"{\n \"name\": \"New Match Target\",\n \"target_file_name\": \"new_file_name\"\n}","request_headers":{"Content-Type":"application/json","Authorization":"Bearer 2YAS2HxMobnvRx6MVhsUZZlopOnOOA1_n6jdojWptds","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 4,\n \"name\": \"New Match Target\",\n \"targetFileName\": \"new_file_name\",\n \"createdAt\": \"2023-07-18T18:42:51.000Z\",\n \"updatedAt\": \"2023-07-18T18:42:51.000Z\",\n \"archived\": false\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"2e6f028a5396009da5b10b7b3a48f50e\"","X-Request-Id":"f1e4e33b-6c13-4e95-b735-b446003ca8a7","X-Runtime":"0.016458","Content-Length":"162"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/match_targets/4\" -d '{\"name\":\"New Match Target\",\"target_file_name\":\"new_file_name\"}' -X PATCH \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer 2YAS2HxMobnvRx6MVhsUZZlopOnOOA1_n6jdojWptds\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/media/spot_orders/{id}/shares":{"get":{"summary":"List users and groups permissioned on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object9"}}}},"x-examples":null,"x-deprecation-warning":null}},"/media/spot_orders/{id}/shares/users":{"put":{"summary":"Set the permissions users have on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"Object348","in":"body","schema":{"$ref":"#/definitions/Object348"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object9"}}},"x-examples":null,"x-deprecation-warning":null}},"/media/spot_orders/{id}/shares/users/{user_id}":{"delete":{"summary":"Revoke the permissions a user has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"user_id","in":"path","required":true,"description":"The ID of the user.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/media/spot_orders/{id}/shares/groups":{"put":{"summary":"Set the permissions groups has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"Object349","in":"body","schema":{"$ref":"#/definitions/Object349"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object9"}}},"x-examples":null,"x-deprecation-warning":null}},"/media/spot_orders/{id}/shares/groups/{group_id}":{"delete":{"summary":"Revoke the permissions a group has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"group_id","in":"path","required":true,"description":"The ID of the group.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/media/spot_orders/{id}/archive":{"put":{"summary":"Update the archive status of this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the object.","type":"integer"},{"name":"Object350","in":"body","schema":{"$ref":"#/definitions/Object350"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object351"}}},"x-examples":null,"x-deprecation-warning":null}},"/media/optimizations/{id}/shares":{"get":{"summary":"List users and groups permissioned on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object9"}}}},"x-examples":null,"x-deprecation-warning":null}},"/media/optimizations/{id}/shares/users":{"put":{"summary":"Set the permissions users have on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"Object352","in":"body","schema":{"$ref":"#/definitions/Object352"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object9"}}},"x-examples":null,"x-deprecation-warning":null}},"/media/optimizations/{id}/shares/users/{user_id}":{"delete":{"summary":"Revoke the permissions a user has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"user_id","in":"path","required":true,"description":"The ID of the user.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/media/optimizations/{id}/shares/groups":{"put":{"summary":"Set the permissions groups has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"Object353","in":"body","schema":{"$ref":"#/definitions/Object353"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object9"}}},"x-examples":null,"x-deprecation-warning":null}},"/media/optimizations/{id}/shares/groups/{group_id}":{"delete":{"summary":"Revoke the permissions a group has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"group_id","in":"path","required":true,"description":"The ID of the group.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/media/optimizations/{id}/archive":{"put":{"summary":"Update the archive status of this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the object.","type":"integer"},{"name":"Object354","in":"body","schema":{"$ref":"#/definitions/Object354"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object355"}}},"x-examples":null,"x-deprecation-warning":null}},"/media/ratecards/{id}/shares":{"get":{"summary":"List users and groups permissioned on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object9"}}}},"x-examples":null,"x-deprecation-warning":null}},"/media/ratecards/{id}/shares/users":{"put":{"summary":"Set the permissions users have on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"Object358","in":"body","schema":{"$ref":"#/definitions/Object358"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object9"}}},"x-examples":null,"x-deprecation-warning":null}},"/media/ratecards/{id}/shares/users/{user_id}":{"delete":{"summary":"Revoke the permissions a user has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"user_id","in":"path","required":true,"description":"The ID of the user.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/media/ratecards/{id}/shares/groups":{"put":{"summary":"Set the permissions groups has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"Object359","in":"body","schema":{"$ref":"#/definitions/Object359"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object9"}}},"x-examples":null,"x-deprecation-warning":null}},"/media/ratecards/{id}/shares/groups/{group_id}":{"delete":{"summary":"Revoke the permissions a group has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"group_id","in":"path","required":true,"description":"The ID of the group.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/media/ratecards/{id}/archive":{"put":{"summary":"Update the archive status of this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the object.","type":"integer"},{"name":"Object360","in":"body","schema":{"$ref":"#/definitions/Object360"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object361"}}},"x-examples":null,"x-deprecation-warning":null}},"/media/optimizations":{"get":{"summary":"List all optimizations","description":null,"deprecated":false,"parameters":[{"name":"archived","in":"query","required":false,"description":"The archival status of the requested item(s).","type":"string"},{"name":"limit","in":"query","required":false,"description":"Number of results to return. Defaults to 20. Maximum allowed is 50.","type":"integer"},{"name":"page_num","in":"query","required":false,"description":"Page number of the results to return. Defaults to the first page, 1.","type":"integer"},{"name":"order","in":"query","required":false,"description":"The field on which to order the result set. Defaults to created_at. Must be one of: created_at, author, name.","type":"string"},{"name":"order_dir","in":"query","required":false,"description":"Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc.","type":"string"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object362"}}}},"x-examples":null,"x-deprecation-warning":null},"post":{"summary":"Create a new optimization","description":null,"deprecated":false,"parameters":[{"name":"Object363","in":"body","schema":{"$ref":"#/definitions/Object363"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object355"}}},"x-examples":null,"x-deprecation-warning":null}},"/media/optimizations/{id}":{"get":{"summary":"Show a single optimization","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The optimization ID.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object355"}}},"x-examples":null,"x-deprecation-warning":null},"patch":{"summary":"Edit an existing optimization","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The optimization ID.","type":"integer"},{"name":"Object367","in":"body","schema":{"$ref":"#/definitions/Object367"},"required":false}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object355"}}},"x-examples":null,"x-deprecation-warning":null}},"/media/optimizations/{id}/clone":{"post":{"summary":"Clone an existing optimization","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The optimization ID.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object355"}}},"x-examples":null,"x-deprecation-warning":null}},"/media/optimizations/{id}/runs":{"post":{"summary":"Start a run","description":"Start a run and provide a URI for checking its status. The response will provide a 'Location' header which will contain a URI which may be polled to monitor the status of the run.","deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Optimization job.","type":"integer"}],"responses":{"202":{"description":"success","schema":{"$ref":"#/definitions/Object366"}}},"x-examples":null,"x-deprecation-warning":null},"get":{"summary":"List runs for the given Optimization job","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Optimization job.","type":"integer"},{"name":"limit","in":"query","required":false,"description":"Number of results to return. Defaults to 20. Maximum allowed is 100.","type":"integer"},{"name":"page_num","in":"query","required":false,"description":"Page number of the results to return. Defaults to the first page, 1.","type":"integer"},{"name":"order","in":"query","required":false,"description":"The field on which to order the result set. Defaults to id. Must be one of: id.","type":"string"},{"name":"order_dir","in":"query","required":false,"description":"Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc.","type":"string"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object366"}}}},"x-examples":null,"x-deprecation-warning":null}},"/media/optimizations/{id}/runs/{run_id}":{"get":{"summary":"Check status of a run","description":"View the status of a run. This endpoint may be polled to monitor the status of the run. When the 'state' field is no longer 'queued' or 'running' the run has reached its final state.","deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Optimization job.","type":"integer"},{"name":"run_id","in":"path","required":true,"description":"The ID of the run.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object366"}}},"x-examples":null,"x-deprecation-warning":null},"delete":{"summary":"Cancel a run","description":"Cancel a currently active run.","deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Optimization job.","type":"integer"},{"name":"run_id","in":"path","required":true,"description":"The ID of the run.","type":"integer"}],"responses":{"202":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/media/optimizations/{id}/runs/{run_id}/logs":{"get":{"summary":"Get the logs for a run","description":"Get the logs for a run.","deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Optimization job.","type":"integer"},{"name":"run_id","in":"path","required":true,"description":"The ID of the run.","type":"integer"},{"name":"last_id","in":"query","required":false,"description":"The ID of the last log message received. Log entries with this ID value or lower will be omitted.Logs are sorted by ID if this value is provided, and are otherwise sorted by createdAt.","type":"integer"},{"name":"limit","in":"query","required":false,"description":"The maximum number of log messages to return. Default of 10000.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object117"}}}},"x-examples":null,"x-deprecation-warning":null}},"/media/spot_orders":{"get":{"summary":"List all spot orders","description":null,"deprecated":false,"parameters":[{"name":"id","in":"query","required":false,"description":"The ID for the spot order.","type":"integer"},{"name":"archived","in":"query","required":false,"description":"The archival status of the requested item(s).","type":"string"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object370"}}}},"x-examples":null,"x-deprecation-warning":null},"post":{"summary":"Create a spot order","description":null,"deprecated":false,"parameters":[{"name":"Object371","in":"body","schema":{"$ref":"#/definitions/Object371"},"required":false}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object351"}}},"x-examples":null,"x-deprecation-warning":null}},"/media/spot_orders/{id}":{"get":{"summary":"Show a single spot order","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID for the spot order.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object351"}}},"x-examples":null,"x-deprecation-warning":null},"put":{"summary":"Edit the specified spot order","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID for the spot order.","type":"integer"},{"name":"Object372","in":"body","schema":{"$ref":"#/definitions/Object372"},"required":false}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object351"}}},"x-examples":null,"x-deprecation-warning":null}},"/media/ratecards":{"get":{"summary":"List all ratecards","description":null,"deprecated":false,"parameters":[{"name":"archived","in":"query","required":false,"description":"The archival status of the requested item(s).","type":"string"},{"name":"filename","in":"query","required":false,"description":"If specified, will be used to filter the ratecards returned. Substring matching is supported with \"%\" and \"*\" wildcards (e.g., \"filename=%ratecard%\" will return both \"ratecard 1\" and \"my ratecard\").","type":"string"},{"name":"dma_number","in":"query","required":false,"description":"If specified, will be used to filter the ratecards by DMA.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object361"}}}},"x-examples":null,"x-deprecation-warning":null},"post":{"summary":"Create a Ratecard","description":null,"deprecated":false,"parameters":[{"name":"Object373","in":"body","schema":{"$ref":"#/definitions/Object373"},"required":true}],"responses":{"201":{"description":"success","schema":{"$ref":"#/definitions/Object361"}}},"x-examples":null,"x-deprecation-warning":null}},"/media/ratecards/{id}":{"get":{"summary":"Get a Ratecard","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object361"}}},"x-examples":null,"x-deprecation-warning":null},"put":{"summary":"Replace all attributes of this Ratecard","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ratecard ID.","type":"integer"},{"name":"Object374","in":"body","schema":{"$ref":"#/definitions/Object374"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object361"}}},"x-examples":null,"x-deprecation-warning":null},"patch":{"summary":"Update some attributes of this Ratecard","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ratecard ID.","type":"integer"},{"name":"Object375","in":"body","schema":{"$ref":"#/definitions/Object375"},"required":false}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object361"}}},"x-examples":null,"x-deprecation-warning":null}},"/media/dmas":{"get":{"summary":"List all Designated Market Areas","description":null,"deprecated":false,"parameters":[{"name":"name","in":"query","required":false,"description":"If specified, will be used to filter the DMAs returned. Substring matching is supported with \"%\" and \"*\" wildcards (e.g., \"name=%region%\" will return both \"region1\" and \"my region\").","type":"string"},{"name":"number","in":"query","required":false,"description":"If specified, will be used to filter the DMAS by number.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object376"}}}},"x-examples":null,"x-deprecation-warning":null}},"/media/targets":{"get":{"summary":"List all Media Targets","description":null,"deprecated":false,"parameters":[{"name":"name","in":"query","required":false,"description":"The name of the target.","type":"string"},{"name":"identifier","in":"query","required":false,"description":"A unique identifier for this target.","type":"string"},{"name":"data_source","in":"query","required":false,"description":"The source of viewership data for this target.","type":"string"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object377"}}}},"x-examples":null,"x-deprecation-warning":null}},"/models/types":{"get":{"summary":"List all available model types","description":null,"deprecated":false,"parameters":[],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object378"}}}},"x-examples":[{"resource":"Models","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/models/types","description":"List model types","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/models/types","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer pMwQCpfoYhfba3GApatyOnOtlvK1isbJk1MKrD2IOjk","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 18,\n \"algorithm\": \"Sparse Logistic\",\n \"dvType\": \"Binary\",\n \"fintAllowed\": true\n },\n {\n \"id\": 19,\n \"algorithm\": \"Vowpal Wabbit\",\n \"dvType\": \"Binary\",\n \"fintAllowed\": false\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"8e957afce90f7cdfe58e2b2c1159ebbd\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"38fd202c-f23f-48d9-9be5-d6ffb15e0b8b","X-Runtime":"0.050903","Content-Length":"154"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/models/types\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer pMwQCpfoYhfba3GApatyOnOtlvK1isbJk1MKrD2IOjk\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/models/":{"get":{"summary":"List ","description":null,"deprecated":false,"parameters":[{"name":"model_name","in":"query","required":false,"description":"If specified, will be used to filter the models returned. Substring matching is supported. (e.g., \"modelName=model\" will return both \"model1\" and \"my model\").","type":"string"},{"name":"training_table_name","in":"query","required":false,"description":"If specified, will be used to filter the models returned by the training dataset table name. Substring matching is supported. (e.g., \"trainingTableName=table\" will return both \"table1\" and \"my_table\").","type":"string"},{"name":"dependent_variable","in":"query","required":false,"description":"If specified, will be used to filter the models returned by the dependent variable column name. Substring matching is supported. (e.g., \"dependentVariable=predictor\" will return both \"predictor\" and \"my predictor\").","type":"string"},{"name":"status","in":"query","required":false,"description":"If specified, returns models with one of these statuses. It accepts a comma-separated list, possible values are 'running', 'failed', 'succeeded', 'idle', 'scheduled'.","type":"string"},{"name":"author","in":"query","required":false,"description":"If specified, return items from any of these authors. It accepts a comma-separated list of user IDs.","type":"string"},{"name":"hidden","in":"query","required":false,"description":"If specified to be true, returns hidden items. Defaults to false, returning non-hidden items.","type":"boolean"},{"name":"archived","in":"query","required":false,"description":"The archival status of the requested item(s).","type":"string"},{"name":"limit","in":"query","required":false,"description":"Number of results to return. Defaults to its maximum of 50.","type":"integer"},{"name":"page_num","in":"query","required":false,"description":"Page number of the results to return. Defaults to the first page, 1.","type":"integer"},{"name":"order","in":"query","required":false,"description":"The field on which to order the result set. Defaults to updated_at. Must be one of: updated_at, name, created_at, last_run.updated_at.","type":"string"},{"name":"order_dir","in":"query","required":false,"description":"Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc.","type":"string"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object379"}}}},"x-examples":[{"resource":"Models","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/models","description":"List models","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/models","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer 56pYoFTY2nP2stVB3M6eeoklAHCgIsqZ5Ha4Q0Mqfpg","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 86,\n \"tableName\": \"schema_name.table_name15\",\n \"databaseId\": 32,\n \"credentialId\": 38,\n \"modelName\": \"and_this_model\",\n \"description\": \"it is a really good model\",\n \"interactionTerms\": false,\n \"boxCoxTransformation\": null,\n \"modelTypeId\": 5,\n \"primaryKey\": \"id\",\n \"dependentVariable\": \"dv\",\n \"dependentVariableOrder\": [\n\n ],\n \"excludedColumns\": [\n\n ],\n \"limitingSQL\": null,\n \"crossValidationParameters\": {\n },\n \"numberOfFolds\": null,\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n },\n \"parentId\": null,\n \"timeZone\": \"America/Chicago\",\n \"lastRun\": null,\n \"user\": {\n \"id\": 147,\n \"name\": \"Admin devadminfactory45 45\",\n \"username\": \"devadminfactory45\",\n \"initials\": \"AD\",\n \"online\": null\n },\n \"createdAt\": \"2025-02-26T17:48:46.000Z\",\n \"updatedAt\": \"2025-02-26T16:48:46.000Z\",\n \"currentBuildState\": \"idle\",\n \"currentBuildException\": null,\n \"builds\": [\n\n ],\n \"predictions\": [\n\n ],\n \"lastOutputLocation\": null,\n \"archived\": false\n },\n {\n \"id\": 85,\n \"tableName\": \"schema_name.table_name14\",\n \"databaseId\": 30,\n \"credentialId\": 35,\n \"modelName\": \"find_this_model_too\",\n \"description\": \"it is a really good model\",\n \"interactionTerms\": false,\n \"boxCoxTransformation\": null,\n \"modelTypeId\": 4,\n \"primaryKey\": \"id\",\n \"dependentVariable\": \"dv\",\n \"dependentVariableOrder\": [\n\n ],\n \"excludedColumns\": [\n\n ],\n \"limitingSQL\": null,\n \"crossValidationParameters\": {\n },\n \"numberOfFolds\": null,\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n },\n \"parentId\": null,\n \"timeZone\": \"America/Chicago\",\n \"lastRun\": null,\n \"user\": {\n \"id\": 148,\n \"name\": \"Admin devadminfactory46 46\",\n \"username\": \"devadminfactory46\",\n \"initials\": \"AD\",\n \"online\": null\n },\n \"createdAt\": \"2025-02-26T17:48:46.000Z\",\n \"updatedAt\": \"2025-02-26T15:48:46.000Z\",\n \"currentBuildState\": \"idle\",\n \"currentBuildException\": null,\n \"builds\": [\n\n ],\n \"predictions\": [\n\n ],\n \"lastOutputLocation\": null,\n \"archived\": false\n },\n {\n \"id\": 83,\n \"tableName\": \"schema_name.table_name12\",\n \"databaseId\": 27,\n \"credentialId\": 31,\n \"modelName\": \"find_this_model\",\n \"description\": \"it is a really good model\",\n \"interactionTerms\": false,\n \"boxCoxTransformation\": null,\n \"modelTypeId\": 3,\n \"primaryKey\": \"id\",\n \"dependentVariable\": \"dv\",\n \"dependentVariableOrder\": [\n\n ],\n \"excludedColumns\": [\n\n ],\n \"limitingSQL\": null,\n \"crossValidationParameters\": {\n },\n \"numberOfFolds\": null,\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n },\n \"parentId\": null,\n \"timeZone\": \"America/Chicago\",\n \"lastRun\": null,\n \"user\": {\n \"id\": 148,\n \"name\": \"Admin devadminfactory46 46\",\n \"username\": \"devadminfactory46\",\n \"initials\": \"AD\",\n \"online\": null\n },\n \"createdAt\": \"2025-02-26T17:48:45.000Z\",\n \"updatedAt\": \"2025-02-26T14:48:46.000Z\",\n \"currentBuildState\": \"idle\",\n \"currentBuildException\": null,\n \"builds\": [\n {\n \"id\": 40,\n \"name\": \"v3\",\n \"createdAt\": \"2025-02-26T17:48:46.000Z\",\n \"description\": null,\n \"rootMeanSquaredError\": null,\n \"rSquaredError\": null,\n \"rocAuc\": null\n }\n ],\n \"predictions\": [\n\n ],\n \"lastOutputLocation\": null,\n \"archived\": false\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","X-Pagination-Per-Page":"50","Access-Control-Expose-Headers":"X-Pagination-Per-Page, X-Pagination-Current-Page, X-Pagination-Total-Pages, X-Pagination-Total-Entries","X-Pagination-Current-Page":"1","X-Pagination-Total-Pages":"1","X-Pagination-Total-Entries":"3","Content-Type":"application/json; charset=utf-8","ETag":"W/\"71db636e8b5683a687a95afe4ba59f88\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"f7ae132c-2d1c-4e16-a257-f2960be31ab8","X-Runtime":"0.066441","Content-Length":"2885"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/models\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer 56pYoFTY2nP2stVB3M6eeoklAHCgIsqZ5Ha4Q0Mqfpg\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Models","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/models?modelName=find_this_model","description":"Filter models by model name","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/models?modelName=find_this_model","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer nqRZ0I7ulM7tFX-2B2babDKZrRARQsmzMDP8zG_v8CU","Host":"api.civis.test","Cookie":""},"request_query_parameters":{"modelName":"find_this_model"},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 89,\n \"tableName\": \"schema_name.table_name18\",\n \"databaseId\": 37,\n \"credentialId\": 45,\n \"modelName\": \"find_this_model_too\",\n \"description\": \"it is a really good model\",\n \"interactionTerms\": false,\n \"boxCoxTransformation\": null,\n \"modelTypeId\": 7,\n \"primaryKey\": \"id\",\n \"dependentVariable\": \"dv\",\n \"dependentVariableOrder\": [\n\n ],\n \"excludedColumns\": [\n\n ],\n \"limitingSQL\": null,\n \"crossValidationParameters\": {\n },\n \"numberOfFolds\": null,\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n },\n \"parentId\": null,\n \"timeZone\": \"America/Chicago\",\n \"lastRun\": null,\n \"user\": {\n \"id\": 155,\n \"name\": \"Admin devadminfactory52 52\",\n \"username\": \"devadminfactory52\",\n \"initials\": \"AD\",\n \"online\": null\n },\n \"createdAt\": \"2025-02-26T17:48:47.000Z\",\n \"updatedAt\": \"2025-02-26T15:48:47.000Z\",\n \"currentBuildState\": \"idle\",\n \"currentBuildException\": null,\n \"builds\": [\n\n ],\n \"predictions\": [\n\n ],\n \"lastOutputLocation\": null,\n \"archived\": false\n },\n {\n \"id\": 87,\n \"tableName\": \"schema_name.table_name16\",\n \"databaseId\": 34,\n \"credentialId\": 41,\n \"modelName\": \"find_this_model\",\n \"description\": \"it is a really good model\",\n \"interactionTerms\": false,\n \"boxCoxTransformation\": null,\n \"modelTypeId\": 6,\n \"primaryKey\": \"id\",\n \"dependentVariable\": \"dv\",\n \"dependentVariableOrder\": [\n\n ],\n \"excludedColumns\": [\n\n ],\n \"limitingSQL\": null,\n \"crossValidationParameters\": {\n },\n \"numberOfFolds\": null,\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n },\n \"parentId\": null,\n \"timeZone\": \"America/Chicago\",\n \"lastRun\": null,\n \"user\": {\n \"id\": 155,\n \"name\": \"Admin devadminfactory52 52\",\n \"username\": \"devadminfactory52\",\n \"initials\": \"AD\",\n \"online\": null\n },\n \"createdAt\": \"2025-02-26T17:48:47.000Z\",\n \"updatedAt\": \"2025-02-26T14:48:47.000Z\",\n \"currentBuildState\": \"idle\",\n \"currentBuildException\": null,\n \"builds\": [\n {\n \"id\": 41,\n \"name\": \"v4\",\n \"createdAt\": \"2025-02-26T17:48:47.000Z\",\n \"description\": null,\n \"rootMeanSquaredError\": null,\n \"rSquaredError\": null,\n \"rocAuc\": null\n }\n ],\n \"predictions\": [\n\n ],\n \"lastOutputLocation\": null,\n \"archived\": false\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","X-Pagination-Per-Page":"50","Access-Control-Expose-Headers":"X-Pagination-Per-Page, X-Pagination-Current-Page, X-Pagination-Total-Pages, X-Pagination-Total-Entries","X-Pagination-Current-Page":"1","X-Pagination-Total-Pages":"1","X-Pagination-Total-Entries":"2","Content-Type":"application/json; charset=utf-8","ETag":"W/\"5b9688d483255f284aabcd46701f98be\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"e7a8954d-d3bb-4126-9248-98a63917704a","X-Runtime":"0.055989","Content-Length":"1973"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/models?modelName=find_this_model\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer nqRZ0I7ulM7tFX-2B2babDKZrRARQsmzMDP8zG_v8CU\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Models","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/models?trainingTableName=training_table","description":"Filter models by training table name","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/models?trainingTableName=training_table","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer KXgz3gCEB5IaoOhsEs0KF-OK4mJkfRc0v5frFLjvm1w","Host":"api.civis.test","Cookie":""},"request_query_parameters":{"trainingTableName":"training_table"},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 94,\n \"tableName\": \"my_training_table\",\n \"databaseId\": 46,\n \"credentialId\": 58,\n \"modelName\": \"find_this_model_too\",\n \"description\": \"it is a really good model\",\n \"interactionTerms\": false,\n \"boxCoxTransformation\": null,\n \"modelTypeId\": 11,\n \"primaryKey\": \"id\",\n \"dependentVariable\": \"dv\",\n \"dependentVariableOrder\": [\n\n ],\n \"excludedColumns\": [\n\n ],\n \"limitingSQL\": null,\n \"crossValidationParameters\": {\n },\n \"numberOfFolds\": null,\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n },\n \"parentId\": null,\n \"timeZone\": \"America/Chicago\",\n \"lastRun\": null,\n \"user\": {\n \"id\": 163,\n \"name\": \"Admin devadminfactory59 59\",\n \"username\": \"devadminfactory59\",\n \"initials\": \"AD\",\n \"online\": null\n },\n \"createdAt\": \"2025-02-26T17:48:49.000Z\",\n \"updatedAt\": \"2025-02-26T15:48:49.000Z\",\n \"currentBuildState\": \"idle\",\n \"currentBuildException\": null,\n \"builds\": [\n\n ],\n \"predictions\": [\n\n ],\n \"lastOutputLocation\": null,\n \"archived\": false\n },\n {\n \"id\": 92,\n \"tableName\": \"training_table\",\n \"databaseId\": 43,\n \"credentialId\": 54,\n \"modelName\": \"find_this_model\",\n \"description\": \"it is a really good model\",\n \"interactionTerms\": false,\n \"boxCoxTransformation\": null,\n \"modelTypeId\": 10,\n \"primaryKey\": \"id\",\n \"dependentVariable\": \"dv\",\n \"dependentVariableOrder\": [\n\n ],\n \"excludedColumns\": [\n\n ],\n \"limitingSQL\": null,\n \"crossValidationParameters\": {\n },\n \"numberOfFolds\": null,\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n },\n \"parentId\": null,\n \"timeZone\": \"America/Chicago\",\n \"lastRun\": null,\n \"user\": {\n \"id\": 163,\n \"name\": \"Admin devadminfactory59 59\",\n \"username\": \"devadminfactory59\",\n \"initials\": \"AD\",\n \"online\": null\n },\n \"createdAt\": \"2025-02-26T17:48:48.000Z\",\n \"updatedAt\": \"2025-02-26T14:48:48.000Z\",\n \"currentBuildState\": \"idle\",\n \"currentBuildException\": null,\n \"builds\": [\n {\n \"id\": 42,\n \"name\": \"v5\",\n \"createdAt\": \"2025-02-26T17:48:48.000Z\",\n \"description\": null,\n \"rootMeanSquaredError\": null,\n \"rSquaredError\": null,\n \"rocAuc\": null\n }\n ],\n \"predictions\": [\n\n ],\n \"lastOutputLocation\": null,\n \"archived\": false\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","X-Pagination-Per-Page":"50","Access-Control-Expose-Headers":"X-Pagination-Per-Page, X-Pagination-Current-Page, X-Pagination-Total-Pages, X-Pagination-Total-Entries","X-Pagination-Current-Page":"1","X-Pagination-Total-Pages":"1","X-Pagination-Total-Entries":"2","Content-Type":"application/json; charset=utf-8","ETag":"W/\"962c7f847ca1d2858524654f1dd3a758\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"bc58c369-a6c2-4b52-86d6-5fc6a403b74d","X-Runtime":"0.067097","Content-Length":"1958"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/models?trainingTableName=training_table\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer KXgz3gCEB5IaoOhsEs0KF-OK4mJkfRc0v5frFLjvm1w\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Models","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/models?dependentVariable=dv","description":"Filter models by dependent variable","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/models?dependentVariable=dv","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer Qk7uTKc96xx6E8qHzbcAdh2M8kJbCvfMXJZODrbyhnI","Host":"api.civis.test","Cookie":""},"request_query_parameters":{"dependentVariable":"dv"},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 99,\n \"tableName\": \"schema_name.table_name28\",\n \"databaseId\": 55,\n \"credentialId\": 71,\n \"modelName\": \"find_this_model_too\",\n \"description\": \"it is a really good model\",\n \"interactionTerms\": false,\n \"boxCoxTransformation\": null,\n \"modelTypeId\": 15,\n \"primaryKey\": \"id\",\n \"dependentVariable\": \"my_dv\",\n \"dependentVariableOrder\": [\n\n ],\n \"excludedColumns\": [\n\n ],\n \"limitingSQL\": null,\n \"crossValidationParameters\": {\n },\n \"numberOfFolds\": null,\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n },\n \"parentId\": null,\n \"timeZone\": \"America/Chicago\",\n \"lastRun\": null,\n \"user\": {\n \"id\": 171,\n \"name\": \"Admin devadminfactory66 66\",\n \"username\": \"devadminfactory66\",\n \"initials\": \"AD\",\n \"online\": null\n },\n \"createdAt\": \"2025-02-26T17:48:50.000Z\",\n \"updatedAt\": \"2025-02-26T15:48:50.000Z\",\n \"currentBuildState\": \"idle\",\n \"currentBuildException\": null,\n \"builds\": [\n\n ],\n \"predictions\": [\n\n ],\n \"lastOutputLocation\": null,\n \"archived\": false\n },\n {\n \"id\": 97,\n \"tableName\": \"schema_name.table_name26\",\n \"databaseId\": 52,\n \"credentialId\": 67,\n \"modelName\": \"find_this_model\",\n \"description\": \"it is a really good model\",\n \"interactionTerms\": false,\n \"boxCoxTransformation\": null,\n \"modelTypeId\": 14,\n \"primaryKey\": \"id\",\n \"dependentVariable\": \"dv\",\n \"dependentVariableOrder\": [\n\n ],\n \"excludedColumns\": [\n\n ],\n \"limitingSQL\": null,\n \"crossValidationParameters\": {\n },\n \"numberOfFolds\": null,\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n },\n \"parentId\": null,\n \"timeZone\": \"America/Chicago\",\n \"lastRun\": null,\n \"user\": {\n \"id\": 171,\n \"name\": \"Admin devadminfactory66 66\",\n \"username\": \"devadminfactory66\",\n \"initials\": \"AD\",\n \"online\": null\n },\n \"createdAt\": \"2025-02-26T17:48:49.000Z\",\n \"updatedAt\": \"2025-02-26T14:48:50.000Z\",\n \"currentBuildState\": \"idle\",\n \"currentBuildException\": null,\n \"builds\": [\n {\n \"id\": 43,\n \"name\": \"v6\",\n \"createdAt\": \"2025-02-26T17:48:50.000Z\",\n \"description\": null,\n \"rootMeanSquaredError\": null,\n \"rSquaredError\": null,\n \"rocAuc\": null\n }\n ],\n \"predictions\": [\n\n ],\n \"lastOutputLocation\": null,\n \"archived\": false\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","X-Pagination-Per-Page":"50","Access-Control-Expose-Headers":"X-Pagination-Per-Page, X-Pagination-Current-Page, X-Pagination-Total-Pages, X-Pagination-Total-Entries","X-Pagination-Current-Page":"1","X-Pagination-Total-Pages":"1","X-Pagination-Total-Entries":"2","Content-Type":"application/json; charset=utf-8","ETag":"W/\"eac5b21c61e34574669be9d86c8b2041\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"e678df4e-274e-4d3a-aa0b-308b50444861","X-Runtime":"0.064744","Content-Length":"1978"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/models?dependentVariable=dv\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer Qk7uTKc96xx6E8qHzbcAdh2M8kJbCvfMXJZODrbyhnI\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/models/{id}":{"get":{"summary":"Retrieve model configuration","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the model.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object382"}}},"x-examples":[{"resource":"Models","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/models/:id","description":"Get a model","explanation":null,"parameters":[{"required":true,"name":"id","description":"The ID of the model."}],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/models/80","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer l2Y9SDM2bDwqVcsgGYudxT4d46kBwIkrDyf03sx0S8M","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 80,\n \"tableName\": \"schema_name.table_name10\",\n \"databaseId\": 24,\n \"credentialId\": 27,\n \"modelName\": \"Model #80\",\n \"description\": \"it is a really good model\",\n \"interactionTerms\": false,\n \"boxCoxTransformation\": null,\n \"modelTypeId\": 2,\n \"primaryKey\": \"id\",\n \"dependentVariable\": \"dv\",\n \"dependentVariableOrder\": [\n\n ],\n \"excludedColumns\": [\n\n ],\n \"limitingSQL\": null,\n \"activeBuildId\": null,\n \"crossValidationParameters\": {\n },\n \"numberOfFolds\": null,\n \"notifications\": {\n \"urls\": [\n\n ],\n \"successEmailSubject\": null,\n \"successEmailBody\": null,\n \"successEmailAddresses\": [\n\n ],\n \"successEmailFromName\": null,\n \"successEmailReplyTo\": null,\n \"failureEmailAddresses\": [\n\n ],\n \"stallWarningMinutes\": null,\n \"successOn\": true,\n \"failureOn\": true\n },\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n },\n \"parentId\": null,\n \"runningAs\": {\n \"id\": 138,\n \"name\": \"Admin devadminfactory41 41\",\n \"username\": \"devadminfactory41\",\n \"initials\": \"AD\",\n \"online\": null\n },\n \"timeZone\": \"America/Chicago\",\n \"lastRun\": {\n \"id\": 39,\n \"state\": \"failed\",\n \"createdAt\": \"2025-02-26T17:48:45.000Z\",\n \"startedAt\": null,\n \"finishedAt\": null,\n \"error\": null\n },\n \"hidden\": false,\n \"user\": {\n \"id\": 138,\n \"name\": \"Admin devadminfactory41 41\",\n \"username\": \"devadminfactory41\",\n \"initials\": \"AD\",\n \"online\": null\n },\n \"createdAt\": \"2025-02-26T17:48:44.000Z\",\n \"updatedAt\": \"2025-02-26T17:48:44.000Z\",\n \"currentBuildState\": \"failed\",\n \"currentBuildException\": null,\n \"builds\": [\n {\n \"id\": 37,\n \"name\": \"v1\",\n \"createdAt\": \"2025-02-26T17:48:44.000Z\",\n \"description\": null,\n \"rootMeanSquaredError\": null,\n \"rSquaredError\": null,\n \"rocAuc\": null\n }\n ],\n \"predictions\": [\n {\n \"id\": 82,\n \"tableName\": \"schema_name.table_name2\",\n \"primaryKey\": [\n \"personid\"\n ],\n \"limitingSQL\": null,\n \"outputTable\": \"schema.out_table\",\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n },\n \"state\": \"idle\"\n }\n ],\n \"lastOutputLocation\": null,\n \"archived\": false\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"6853220586d05588d0845f60ebeb4ebe\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"0586484c-9aa1-4911-9508-f9d9512ea247","X-Runtime":"0.190568","Content-Length":"1849"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/models/80\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer l2Y9SDM2bDwqVcsgGYudxT4d46kBwIkrDyf03sx0S8M\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/models/{id}/builds/{build_id}":{"get":{"summary":"Check status of a build","description":"View the status of a build. This endpoint may be polled to monitor the status of the build. When the 'state' field is no longer 'queued' or 'running' the build has reached its final state.","deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Model job.","type":"integer"},{"name":"build_id","in":"path","required":true,"description":"The ID of the build.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object384"}}},"x-examples":[{"resource":"Models","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/models/:model_id/builds/:build_id","description":"Show build output","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/models/8/builds/44","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer s6qB3rZb1Dw1cYfE8m9TRfmHYHbdtWjCThcP4QAtP8U","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 44,\n \"state\": \"queued\",\n \"error\": null,\n \"name\": \"v7\",\n \"createdAt\": \"2025-02-26T17:48:51.000Z\",\n \"description\": null,\n \"rootMeanSquaredError\": null,\n \"rSquaredError\": null,\n \"rocAuc\": null,\n \"transformationMetadata\": {\n },\n \"output\": \"{\\\"a\\\": 1}\",\n \"outputLocation\": \"http://dummy_output_uri\"\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"7a5041ad3acdf06ad15079c582a88fe1\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"f1cbad9e-9600-4b12-8cb3-00a0b8a9312d","X-Runtime":"0.075560","Content-Length":"265"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/models/8/builds/44\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer s6qB3rZb1Dw1cYfE8m9TRfmHYHbdtWjCThcP4QAtP8U\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"delete":{"summary":"Cancel a build","description":"Cancel a currently active build.","deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Model job.","type":"integer"},{"name":"build_id","in":"path","required":true,"description":"The ID of the build.","type":"integer"}],"responses":{"202":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/models/{id}/builds":{"get":{"summary":"List builds for the given Model job","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Model job.","type":"integer"},{"name":"limit","in":"query","required":false,"description":"Number of results to return. Defaults to 20. Maximum allowed is 100.","type":"integer"},{"name":"page_num","in":"query","required":false,"description":"Page number of the results to return. Defaults to the first page, 1.","type":"integer"},{"name":"order","in":"query","required":false,"description":"The field on which to order the result set. Defaults to id. Must be one of: id.","type":"string"},{"name":"order_dir","in":"query","required":false,"description":"Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc.","type":"string"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object384"}}}},"x-examples":[{"resource":"Models","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/models/:model_id/builds","description":"Show build output","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/models/8/builds","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer QCifE6s1VRU3uf8htlXmhnkZexEz38VK2E_ntHwPcQM","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 46,\n \"state\": \"running\",\n \"error\": null,\n \"name\": \"v9\",\n \"createdAt\": \"2025-02-26T17:48:52.000Z\",\n \"description\": null,\n \"rootMeanSquaredError\": null,\n \"rSquaredError\": null,\n \"rocAuc\": null,\n \"transformationMetadata\": {\n },\n \"output\": null,\n \"outputLocation\": \"http://dummy_output_uri\"\n },\n {\n \"id\": 45,\n \"state\": \"queued\",\n \"error\": null,\n \"name\": \"v8\",\n \"createdAt\": \"2025-02-26T17:48:52.000Z\",\n \"description\": null,\n \"rootMeanSquaredError\": null,\n \"rSquaredError\": null,\n \"rocAuc\": null,\n \"transformationMetadata\": {\n },\n \"output\": \"{\\\"a\\\": 1}\",\n \"outputLocation\": \"http://dummy_output_uri\"\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","X-Pagination-Per-Page":"20","Access-Control-Expose-Headers":"X-Pagination-Per-Page, X-Pagination-Current-Page, X-Pagination-Total-Pages, X-Pagination-Total-Entries","X-Pagination-Current-Page":"1","X-Pagination-Total-Pages":"1","X-Pagination-Total-Entries":"2","Content-Type":"application/json; charset=utf-8","ETag":"W/\"7b6ae44178d7eec15352efb104f32fe2\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"7ed8df71-64fe-4e64-9336-290696c19751","X-Runtime":"0.105335","Content-Length":"526"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/models/8/builds\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer QCifE6s1VRU3uf8htlXmhnkZexEz38VK2E_ntHwPcQM\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/models/{id}/builds/{build_id}/logs":{"get":{"summary":"Get the logs for a build","description":"Get the logs for a build.","deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Model job.","type":"integer"},{"name":"build_id","in":"path","required":true,"description":"The ID of the build.","type":"integer"},{"name":"last_id","in":"query","required":false,"description":"The ID of the last log message received. Log entries with this ID value or lower will be omitted.Logs are sorted by ID if this value is provided, and are otherwise sorted by createdAt.","type":"integer"},{"name":"limit","in":"query","required":false,"description":"The maximum number of log messages to return. Default of 10000.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object117"}}}},"x-examples":null,"x-deprecation-warning":null}},"/models/{id}/shares":{"get":{"summary":"List users and groups permissioned on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object9"}}}},"x-examples":null,"x-deprecation-warning":null}},"/models/{id}/shares/users":{"put":{"summary":"Set the permissions users have on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"Object385","in":"body","schema":{"$ref":"#/definitions/Object385"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object9"}}},"x-examples":null,"x-deprecation-warning":null}},"/models/{id}/shares/users/{user_id}":{"delete":{"summary":"Revoke the permissions a user has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"user_id","in":"path","required":true,"description":"The ID of the user.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/models/{id}/shares/groups":{"put":{"summary":"Set the permissions groups has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"Object386","in":"body","schema":{"$ref":"#/definitions/Object386"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object9"}}},"x-examples":null,"x-deprecation-warning":null}},"/models/{id}/shares/groups/{group_id}":{"delete":{"summary":"Revoke the permissions a group has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"group_id","in":"path","required":true,"description":"The ID of the group.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/models/{id}/dependencies":{"get":{"summary":"List dependent objects for this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"user_id","in":"query","required":false,"description":"ID of target user","type":"integer"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object15"}}}},"x-examples":null,"x-deprecation-warning":null}},"/models/{id}/transfer":{"put":{"summary":"Transfer ownership of this object to another user","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"Object387","in":"body","schema":{"$ref":"#/definitions/Object387"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object17"}}},"x-examples":null,"x-deprecation-warning":null}},"/models/{id}/projects":{"get":{"summary":"List the projects a Model belongs to","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Model.","type":"integer"},{"name":"hidden","in":"query","required":false,"description":"If specified to be true, returns hidden items. Defaults to false, returning non-hidden items.","type":"boolean"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object85"}}}},"x-examples":null,"x-deprecation-warning":null}},"/models/{id}/projects/{project_id}":{"put":{"summary":"Add a Model to a project","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Model.","type":"integer"},{"name":"project_id","in":"path","required":true,"description":"The ID of the project.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null},"delete":{"summary":"Remove a Model from a project","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Model.","type":"integer"},{"name":"project_id","in":"path","required":true,"description":"The ID of the project.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/models/{id}/archive":{"put":{"summary":"Update the archive status of this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the object.","type":"integer"},{"name":"Object388","in":"body","schema":{"$ref":"#/definitions/Object388"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object382"}}},"x-examples":null,"x-deprecation-warning":null}},"/models/{id}/schedules":{"get":{"summary":"Show the model build schedule","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the model associated with this schedule.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object389"}}},"x-examples":[{"resource":"Models","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/models/:id/schedules","description":"View a model's schedule","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/models/78/schedules","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer IZqw8tmj3kagOYtnFNe3OUXLOraSfBE5hagTzhsihrQ","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 78,\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n }\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"c452548657cab88c9acd47a0f12ddfa0\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"7173189d-8d83-42c0-b834-73f2cf0f3530","X-Runtime":"0.071361","Content-Length":"154"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/models/78/schedules\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer IZqw8tmj3kagOYtnFNe3OUXLOraSfBE5hagTzhsihrQ\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/notebooks/":{"get":{"summary":"List Notebooks","description":null,"deprecated":false,"parameters":[{"name":"hidden","in":"query","required":false,"description":"If specified to be true, returns hidden items. Defaults to false, returning non-hidden items.","type":"boolean"},{"name":"archived","in":"query","required":false,"description":"The archival status of the requested item(s).","type":"string"},{"name":"author","in":"query","required":false,"description":"If specified, return items from any of these authors. It accepts a comma-separated list of user IDs.","type":"string"},{"name":"status","in":"query","required":false,"description":"If specified, returns notebooks with one of these statuses. It accepts a comma-separated list, possible values are 'running', 'pending', 'idle'.","type":"string"},{"name":"limit","in":"query","required":false,"description":"Number of results to return. Defaults to 20. Maximum allowed is 50.","type":"integer"},{"name":"page_num","in":"query","required":false,"description":"Page number of the results to return. Defaults to the first page, 1.","type":"integer"},{"name":"order","in":"query","required":false,"description":"The field on which to order the result set. Defaults to updated_at. Must be one of: updated_at, name, created_at.","type":"string"},{"name":"order_dir","in":"query","required":false,"description":"Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc.","type":"string"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object390"}}}},"x-examples":[{"resource":"Notebooks","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/notebooks","description":"List all notebooks","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/notebooks","request_body":null,"request_headers":{"Content-Type":"application/json","Authorization":"Bearer CKAL5MX5aRiYWcDNiM8oR_Zhl6OyQddAWoJ_COLDFDg","Accept":"application/vnd.civis-platform.v1","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 1,\n \"name\": \"Test Notebook\",\n \"language\": \"python3\",\n \"description\": null,\n \"user\": {\n \"id\": 2515,\n \"name\": \"User devuserfactory1841 1839\",\n \"username\": \"devuserfactory1841\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"createdAt\": \"2023-07-18T18:42:58.000Z\",\n \"updatedAt\": \"2023-07-18T18:42:58.000Z\",\n \"mostRecentDeployment\": null,\n \"archived\": false\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","X-Pagination-Per-Page":"20","Access-Control-Expose-Headers":"X-Pagination-Per-Page, X-Pagination-Current-Page, X-Pagination-Total-Pages, X-Pagination-Total-Entries","X-Pagination-Current-Page":"1","X-Pagination-Total-Pages":"1","X-Pagination-Total-Entries":"1","Content-Type":"application/json; charset=utf-8","ETag":"W/\"be934a57a069f5e1df52babec133c50b\"","X-Request-Id":"a25a3d90-a46d-46c8-a81a-20fed26112cb","X-Runtime":"0.020943","Content-Length":"315"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/notebooks\" -X GET \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer CKAL5MX5aRiYWcDNiM8oR_Zhl6OyQddAWoJ_COLDFDg\" \\\n\t-H \"Accept: application/vnd.civis-platform.v1\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"post":{"summary":"Create a Notebook","description":null,"deprecated":false,"parameters":[{"name":"Object392","in":"body","schema":{"$ref":"#/definitions/Object392"},"required":false}],"responses":{"201":{"description":"success","schema":{"$ref":"#/definitions/Object393"}}},"x-examples":[{"resource":"Notebooks","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/notebooks","description":"Create a notebook","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/notebooks","request_body":"{\n \"name\": \"Custom Name\",\n \"language\": \"python3\",\n \"docker_image_tag\": \"1.0.0\"\n}","request_headers":{"Content-Type":"application/json","Authorization":"Bearer X-9aGPhHNWjtyvWu7I_dQUKvT2v5Ug31DtO5KO2toSg","Accept":"application/vnd.civis-platform.v1","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":201,"response_status_text":"Created","response_body":"{\n \"id\": 6,\n \"name\": \"Custom Name\",\n \"language\": \"python3\",\n \"description\": null,\n \"notebookUrl\": \"https://civis-console.s3.amazonaws.com/tgtg/notebooks/1/notebook.ipynb?AWSAccessKeyId=XXX&Expires=1490366474&Signature=XXX&response-content-type=application%2Foctet-stream&x-amz-security-token=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX\",\n \"notebookPreviewUrl\": \"https://civis-console.s3.amazonaws.com/tgtg/notebooks/1/preview.html?AWSAccessKeyId=XXX&Expires=1490366474&Signature=XXX&response-content-type=application%2Foctet-stream&x-amz-security-token=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX\",\n \"requirementsUrl\": \"https://civis-console.s3.amazonaws.com/tgtg/notebooks/1/requirements.txt?AWSAccessKeyId=XXX&Expires=1490366474&Signature=XXX&response-content-type=application%2Foctet-stream&x-amz-security-token=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX\",\n \"fileId\": 86,\n \"requirementsFileId\": 88,\n \"user\": {\n \"id\": 2528,\n \"name\": \"User devuserfactory1854 1852\",\n \"username\": \"devuserfactory1854\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"dockerImageName\": \"civisanalytics/civis-jupyter-python3\",\n \"dockerImageTag\": \"1.0.0\",\n \"instanceType\": null,\n \"memory\": 3000,\n \"cpu\": 800,\n \"createdAt\": \"2023-07-18T18:43:00.000Z\",\n \"updatedAt\": \"2023-07-18T18:43:00.000Z\",\n \"mostRecentDeployment\": null,\n \"credentials\": [\n\n ],\n \"environmentVariables\": {\n },\n \"idleTimeout\": 3,\n \"partitionLabel\": null,\n \"gitRepoId\": null,\n \"gitRepoUrl\": null,\n \"gitRef\": null,\n \"gitPath\": null,\n \"myPermissionLevel\": \"manage\",\n \"archived\": false,\n \"hidden\": false\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"5a34f8453aa32ad9b41ebd62f521ce32\"","X-Request-Id":"2f7c15c3-188f-40cf-bca3-bb2ae190bf43","X-Runtime":"0.193441","Content-Length":"1573"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/notebooks\" -d '{\"name\":\"Custom Name\",\"language\":\"python3\",\"docker_image_tag\":\"1.0.0\"}' -X POST \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer X-9aGPhHNWjtyvWu7I_dQUKvT2v5Ug31DtO5KO2toSg\" \\\n\t-H \"Accept: application/vnd.civis-platform.v1\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Notebooks","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/notebooks","description":"Create a notebook with non-default values","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/notebooks","request_body":"{\n \"name\": \"Custom name\",\n \"language\": \"r\",\n \"memory\": 3000,\n \"cpu\": 600,\n \"dockerImageName\": \"dummy\",\n \"dockerImageTag\": \"dummy\",\n \"credentials\": [\n 728\n ]\n}","request_headers":{"Content-Type":"application/json","Authorization":"Bearer MD16yK7MwwSCyIyb1Xuzx-2xEwgAQYX6rQJqJmxKlNg","Accept":"application/vnd.civis-platform.v1","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":201,"response_status_text":"Created","response_body":"{\n \"id\": 8,\n \"name\": \"Custom name\",\n \"language\": \"r\",\n \"description\": null,\n \"notebookUrl\": \"https://civis-console.s3.amazonaws.com/tgtg/notebooks/1/notebook.ipynb?AWSAccessKeyId=XXX&Expires=1490366474&Signature=XXX&response-content-type=application%2Foctet-stream&x-amz-security-token=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX\",\n \"notebookPreviewUrl\": \"https://civis-console.s3.amazonaws.com/tgtg/notebooks/1/preview.html?AWSAccessKeyId=XXX&Expires=1490366474&Signature=XXX&response-content-type=application%2Foctet-stream&x-amz-security-token=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX\",\n \"requirementsUrl\": \"https://civis-console.s3.amazonaws.com/tgtg/notebooks/1/requirements.txt?AWSAccessKeyId=XXX&Expires=1490366474&Signature=XXX&response-content-type=application%2Foctet-stream&x-amz-security-token=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX\",\n \"fileId\": 92,\n \"requirementsFileId\": 94,\n \"user\": {\n \"id\": 2533,\n \"name\": \"User devuserfactory1859 1857\",\n \"username\": \"devuserfactory1859\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"dockerImageName\": \"dummy\",\n \"dockerImageTag\": \"dummy\",\n \"instanceType\": null,\n \"memory\": 3000,\n \"cpu\": 600,\n \"createdAt\": \"2023-07-18T18:43:00.000Z\",\n \"updatedAt\": \"2023-07-18T18:43:00.000Z\",\n \"mostRecentDeployment\": null,\n \"credentials\": [\n {\n \"id\": 728,\n \"name\": \"api-key-1\"\n }\n ],\n \"environmentVariables\": {\n },\n \"idleTimeout\": 3,\n \"partitionLabel\": null,\n \"gitRepoId\": null,\n \"gitRepoUrl\": null,\n \"gitRef\": null,\n \"gitPath\": null,\n \"myPermissionLevel\": \"manage\",\n \"archived\": false,\n \"hidden\": false\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"b8c572169a911cea56c4625be8c8bb26\"","X-Request-Id":"763a29ef-6793-4630-9608-99019f686b9b","X-Runtime":"0.190343","Content-Length":"1565"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/notebooks\" -d '{\"name\":\"Custom name\",\"language\":\"r\",\"memory\":3000,\"cpu\":600,\"dockerImageName\":\"dummy\",\"dockerImageTag\":\"dummy\",\"credentials\":[728]}' -X POST \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer MD16yK7MwwSCyIyb1Xuzx-2xEwgAQYX6rQJqJmxKlNg\" \\\n\t-H \"Accept: application/vnd.civis-platform.v1\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/notebooks/{id}":{"get":{"summary":"Get a Notebook","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object393"}}},"x-examples":[{"resource":"Notebooks","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/notebooks/:id","description":"View a notebooks's details","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/notebooks/2","request_body":null,"request_headers":{"Content-Type":"application/json","Authorization":"Bearer Z-qcZ_47g4EV_PG-nzACgJ1ehfs_dg2__7Jkhe1W-x0","Accept":"application/vnd.civis-platform.v1","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 2,\n \"name\": \"Test Notebook\",\n \"language\": \"python3\",\n \"description\": null,\n \"notebookUrl\": \"https://civis-console.s3.amazonaws.com/tgtg/notebooks/1/notebook.ipynb?AWSAccessKeyId=XXX&Expires=1490366474&Signature=XXX&response-content-type=application%2Foctet-stream&x-amz-security-token=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX\",\n \"notebookPreviewUrl\": \"https://civis-console.s3.amazonaws.com/tgtg/notebooks/1/preview.html?AWSAccessKeyId=XXX&Expires=1490366474&Signature=XXX&response-content-type=application%2Foctet-stream&x-amz-security-token=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX\",\n \"requirementsUrl\": \"https://civis-console.s3.amazonaws.com/tgtg/notebooks/1/requirements.txt?AWSAccessKeyId=XXX&Expires=1490366474&Signature=XXX&response-content-type=application%2Foctet-stream&x-amz-security-token=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX\",\n \"fileId\": 74,\n \"requirementsFileId\": 76,\n \"user\": {\n \"id\": 2518,\n \"name\": \"User devuserfactory1844 1842\",\n \"username\": \"devuserfactory1844\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"dockerImageName\": \"civisanalytics/civis-jupyter-python3\",\n \"dockerImageTag\": \"foo\",\n \"instanceType\": null,\n \"memory\": 3000,\n \"cpu\": 800,\n \"createdAt\": \"2023-07-18T18:42:59.000Z\",\n \"updatedAt\": \"2023-07-18T18:42:59.000Z\",\n \"mostRecentDeployment\": null,\n \"credentials\": [\n\n ],\n \"environmentVariables\": {\n },\n \"idleTimeout\": 3,\n \"partitionLabel\": null,\n \"gitRepoId\": null,\n \"gitRepoUrl\": null,\n \"gitRef\": null,\n \"gitPath\": null,\n \"myPermissionLevel\": \"manage\",\n \"archived\": false,\n \"hidden\": false\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"6b74428e9fec1957b93d3be2cfb4b3ba\"","X-Request-Id":"5abf896c-3116-4d6d-9136-8d6a696dbd27","X-Runtime":"0.030792","Content-Length":"1573"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/notebooks/2\" -X GET \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer Z-qcZ_47g4EV_PG-nzACgJ1ehfs_dg2__7Jkhe1W-x0\" \\\n\t-H \"Accept: application/vnd.civis-platform.v1\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Notebooks","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/notebooks/:id","description":"View details of a notebook including an active deployment","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/notebooks/3","request_body":null,"request_headers":{"Content-Type":"application/json","Authorization":"Bearer rwNO9z6ZjRUnSV6sLxUGvu0R8Zf4a6PPJya63inPEz4","Accept":"application/vnd.civis-platform.v1","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 3,\n \"name\": \"Test Notebook\",\n \"language\": \"python3\",\n \"description\": null,\n \"notebookUrl\": \"https://civis-console.s3.amazonaws.com/tgtg/notebooks/1/notebook.ipynb?AWSAccessKeyId=XXX&Expires=1490366474&Signature=XXX&response-content-type=application%2Foctet-stream&x-amz-security-token=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX\",\n \"notebookPreviewUrl\": \"https://civis-console.s3.amazonaws.com/tgtg/notebooks/1/preview.html?AWSAccessKeyId=XXX&Expires=1490366474&Signature=XXX&response-content-type=application%2Foctet-stream&x-amz-security-token=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX\",\n \"requirementsUrl\": \"https://civis-console.s3.amazonaws.com/tgtg/notebooks/1/requirements.txt?AWSAccessKeyId=XXX&Expires=1490366474&Signature=XXX&response-content-type=application%2Foctet-stream&x-amz-security-token=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX\",\n \"fileId\": 77,\n \"requirementsFileId\": 79,\n \"user\": {\n \"id\": 2521,\n \"name\": \"User devuserfactory1847 1845\",\n \"username\": \"devuserfactory1847\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"dockerImageName\": \"civisanalytics/civis-jupyter-python3\",\n \"dockerImageTag\": \"foo\",\n \"instanceType\": null,\n \"memory\": 3000,\n \"cpu\": 800,\n \"createdAt\": \"2023-07-18T18:42:59.000Z\",\n \"updatedAt\": \"2023-07-18T18:42:59.000Z\",\n \"mostRecentDeployment\": {\n \"deploymentId\": 3,\n \"userId\": 2524,\n \"host\": \"deployment.foo.com\",\n \"name\": \"deployment\",\n \"dockerImageName\": \"civis-custom-image\",\n \"dockerImageTag\": \"1.1\",\n \"displayUrl\": \"https://deployment.foo.com/civis-platform-auth?token=bm9uY2UyMTNfWFhYWFhYXzI0X2J5dGVzywz4O2fOZE0_u6JvdF3U0t3Zs0lOTho1WiPDK8olECtZlbbcTGWk31vDshg8REPJ45_ZPY2TNDj_UCdOlAu21GGdbgJpnLw4O2ptocsWiSuTnqrykic8G_f7rQpmSqnL9TnBHbJAX-xXRQETDV90Mci2z4X7eQ86eNWMuM3goOfmU0lAv_TfK97dAa5nRnwQInzxWPvu2pkgAga_XfFJqTYF85A0CXTRS9mMYvwY03uOS3ONIYD7AJ4JneMAv-5dO7eniun-I0n7Den_Ab6jOWJzVNYgqDwB8PQj2gO60j66LmwPYFbyVbilsBKNQwHkdy8yOhZCJxkyWe6eo0hAjqvxiP-P0l1ul7A1_guxT0U5g3gSW9CGNq1CUn5ZjscW2oOD-s-dJye3jiU6Bu5ixmClE6c_KzUEY0M=\",\n \"instanceType\": \"m4.xlarge\",\n \"memory\": 2008,\n \"cpu\": 500,\n \"state\": \"running\",\n \"stateMessage\": null,\n \"maxMemoryUsage\": null,\n \"maxCpuUsage\": null,\n \"createdAt\": \"2023-07-18T18:42:59.000Z\",\n \"updatedAt\": \"2023-07-18T18:42:59.000Z\",\n \"notebookId\": 3\n },\n \"credentials\": [\n\n ],\n \"environmentVariables\": {\n },\n \"idleTimeout\": 3,\n \"partitionLabel\": null,\n \"gitRepoId\": null,\n \"gitRepoUrl\": null,\n \"gitRef\": null,\n \"gitPath\": null,\n \"myPermissionLevel\": \"manage\",\n \"archived\": false,\n \"hidden\": false\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"b6a746540a13eb5f165ac2a933600a63\"","X-Request-Id":"0377a9e7-78cd-4da3-804c-b4527d4212a1","X-Runtime":"0.031352","Content-Length":"2455"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/notebooks/3\" -X GET \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer rwNO9z6ZjRUnSV6sLxUGvu0R8Zf4a6PPJya63inPEz4\" \\\n\t-H \"Accept: application/vnd.civis-platform.v1\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"put":{"summary":"Replace all attributes of this Notebook","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID for this notebook.","type":"integer"},{"name":"Object395","in":"body","schema":{"$ref":"#/definitions/Object395"},"required":false}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object393"}}},"x-examples":null,"x-deprecation-warning":null},"patch":{"summary":"Update some attributes of this Notebook","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID for this notebook.","type":"integer"},{"name":"Object395","in":"body","schema":{"$ref":"#/definitions/Object395"},"required":false}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object393"}}},"x-examples":null,"x-deprecation-warning":null},"delete":{"summary":"Archive a Notebook (deprecated, use archiving endpoints instead)","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/notebooks/{id}/update-links":{"get":{"summary":"Get URLs to update notebook","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object396"}}},"x-examples":[{"resource":"Notebooks","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/notebooks/:id/update-links","description":"View URLs for PUTing new notebook contents","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/notebooks/4/update-links","request_body":null,"request_headers":{"Content-Type":"application/json","Authorization":"Bearer FXe2TbAKDyDAD8dxJtornWT9DTfRGnMy0ObEv1wrkek","Accept":"application/vnd.civis-platform.v1","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"updateUrl\": \"https://civis-console.s3.amazonaws.com/tgtg/notebooks/1/notebook.ipynb?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=XXXX%2FXXX%2Faws4_request&X-Amz-Date=20170324T143614Z&X-Amz-Expires=300&X-Amz-SignedHeaders=host&X-Amz-Signature=XXXX\",\n \"updatePreviewUrl\": \"https://civis-console.s3.amazonaws.com/tgtg/notebooks/1/preview.html?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=XXXX%2FXXX%2Faws4_request&X-Amz-Date=20170324T143614Z&X-Amz-Expires=300&X-Amz-SignedHeaders=host&X-Amz-Signature=XXXX\"\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"2d520d4b544eda6ce3b3b852488e3e56\"","X-Request-Id":"5de447a5-d2fe-4366-a1d7-a8ba256383d9","X-Runtime":"0.013694","Content-Length":"562"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/notebooks/4/update-links\" -X GET \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer FXe2TbAKDyDAD8dxJtornWT9DTfRGnMy0ObEv1wrkek\" \\\n\t-H \"Accept: application/vnd.civis-platform.v1\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/notebooks/{id}/clone":{"post":{"summary":"Clone this Notebook","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"type":"integer"}],"responses":{"201":{"description":"success","schema":{"$ref":"#/definitions/Object393"}}},"x-examples":[{"resource":"Notebooks","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/notebooks/:id/clone","description":"Make a clone of an existing notebook","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/notebooks/9/clone","request_body":null,"request_headers":{"Content-Type":"application/json","Authorization":"Bearer FFV85rV6jBfqb1bqrM2UUdRJMjskz_48JlUPKnfnobI","Accept":"application/vnd.civis-platform.v1","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":201,"response_status_text":"Created","response_body":"{\n \"id\": 10,\n \"name\": \"Clone of Test Notebook\",\n \"language\": \"python3\",\n \"description\": null,\n \"notebookUrl\": \"https://civis-console.s3.amazonaws.com/tgtg/notebooks/1/notebook.ipynb?AWSAccessKeyId=XXX&Expires=1490366474&Signature=XXX&response-content-type=application%2Foctet-stream&x-amz-security-token=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX\",\n \"notebookPreviewUrl\": \"https://civis-console.s3.amazonaws.com/tgtg/notebooks/1/preview.html?AWSAccessKeyId=XXX&Expires=1490366474&Signature=XXX&response-content-type=application%2Foctet-stream&x-amz-security-token=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX\",\n \"requirementsUrl\": \"https://civis-console.s3.amazonaws.com/tgtg/notebooks/1/requirements.txt?AWSAccessKeyId=XXX&Expires=1490366474&Signature=XXX&response-content-type=application%2Foctet-stream&x-amz-security-token=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX\",\n \"fileId\": 98,\n \"requirementsFileId\": 100,\n \"user\": {\n \"id\": 2538,\n \"name\": \"User devuserfactory1864 1862\",\n \"username\": \"devuserfactory1864\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"dockerImageName\": \"civisanalytics/civis-jupyter-python3\",\n \"dockerImageTag\": \"foo\",\n \"instanceType\": null,\n \"memory\": 3000,\n \"cpu\": 800,\n \"createdAt\": \"2023-07-18T18:43:00.000Z\",\n \"updatedAt\": \"2023-07-18T18:43:00.000Z\",\n \"mostRecentDeployment\": null,\n \"credentials\": [\n\n ],\n \"environmentVariables\": {\n },\n \"idleTimeout\": 3,\n \"partitionLabel\": null,\n \"gitRepoId\": null,\n \"gitRepoUrl\": null,\n \"gitRef\": null,\n \"gitPath\": null,\n \"myPermissionLevel\": \"manage\",\n \"archived\": false,\n \"hidden\": false\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"3f7c181c74b27ebd906de42a019db1e1\"","X-Request-Id":"b82d282b-da20-40eb-9a61-aa61d4e6417a","X-Runtime":"0.180598","Content-Length":"1584"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/notebooks/9/clone\" -d '' -X POST \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer FFV85rV6jBfqb1bqrM2UUdRJMjskz_48JlUPKnfnobI\" \\\n\t-H \"Accept: application/vnd.civis-platform.v1\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/notebooks/{id}/shares":{"get":{"summary":"List users and groups permissioned on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object9"}}}},"x-examples":null,"x-deprecation-warning":null}},"/notebooks/{id}/shares/users":{"put":{"summary":"Set the permissions users have on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"Object397","in":"body","schema":{"$ref":"#/definitions/Object397"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object9"}}},"x-examples":null,"x-deprecation-warning":null}},"/notebooks/{id}/shares/users/{user_id}":{"delete":{"summary":"Revoke the permissions a user has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"user_id","in":"path","required":true,"description":"The ID of the user.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/notebooks/{id}/shares/groups":{"put":{"summary":"Set the permissions groups has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"Object398","in":"body","schema":{"$ref":"#/definitions/Object398"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object9"}}},"x-examples":null,"x-deprecation-warning":null}},"/notebooks/{id}/shares/groups/{group_id}":{"delete":{"summary":"Revoke the permissions a group has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"group_id","in":"path","required":true,"description":"The ID of the group.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/notebooks/{id}/dependencies":{"get":{"summary":"List dependent objects for this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"user_id","in":"query","required":false,"description":"ID of target user","type":"integer"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object15"}}}},"x-examples":null,"x-deprecation-warning":null}},"/notebooks/{id}/transfer":{"put":{"summary":"Transfer ownership of this object to another user","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"Object399","in":"body","schema":{"$ref":"#/definitions/Object399"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object17"}}},"x-examples":null,"x-deprecation-warning":null}},"/notebooks/{id}/archive":{"put":{"summary":"Update the archive status of this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the object.","type":"integer"},{"name":"Object400","in":"body","schema":{"$ref":"#/definitions/Object400"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object393"}}},"x-examples":null,"x-deprecation-warning":null}},"/notebooks/{id}/projects":{"get":{"summary":"List the projects a Notebook belongs to","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Notebook.","type":"integer"},{"name":"hidden","in":"query","required":false,"description":"If specified to be true, returns hidden items. Defaults to false, returning non-hidden items.","type":"boolean"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object85"}}}},"x-examples":null,"x-deprecation-warning":null}},"/notebooks/{id}/projects/{project_id}":{"put":{"summary":"Add a Notebook to a project","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Notebook.","type":"integer"},{"name":"project_id","in":"path","required":true,"description":"The ID of the project.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null},"delete":{"summary":"Remove a Notebook from a project","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Notebook.","type":"integer"},{"name":"project_id","in":"path","required":true,"description":"The ID of the project.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/notebooks/{notebook_id}/deployments":{"get":{"summary":"List deployments for a Notebook","description":null,"deprecated":false,"parameters":[{"name":"notebook_id","in":"path","required":true,"description":"The ID of the owning Notebook","type":"integer"},{"name":"deployment_id","in":"query","required":false,"description":"The ID for this deployment","type":"integer"},{"name":"limit","in":"query","required":false,"description":"Number of results to return. Defaults to 20. Maximum allowed is 50.","type":"integer"},{"name":"page_num","in":"query","required":false,"description":"Page number of the results to return. Defaults to the first page, 1.","type":"integer"},{"name":"order","in":"query","required":false,"description":"The field on which to order the result set. Defaults to created_at. Must be one of: created_at.","type":"string"},{"name":"order_dir","in":"query","required":false,"description":"Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc.","type":"string"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object391"}}}},"x-examples":[{"resource":"Notebooks","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/notebooks/:notebook_id/deployments","description":"List all Deployments for a notebook","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/notebooks/11/deployments","request_body":null,"request_headers":{"Content-Type":"application/json","Authorization":"Bearer GqkfHLcYSk2SXyIpqFm8rS51upQ8Bs6yjy9W6rsnCjw","Accept":"application/vnd.civis-platform.v1","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"deploymentId\": 4,\n \"userId\": 2543,\n \"host\": \"deployment.foo.com\",\n \"name\": \"deployment\",\n \"dockerImageName\": \"civis-custom-image\",\n \"dockerImageTag\": \"1.1\",\n \"instanceType\": \"m4.xlarge\",\n \"memory\": 2008,\n \"cpu\": 500,\n \"state\": null,\n \"stateMessage\": null,\n \"maxMemoryUsage\": null,\n \"maxCpuUsage\": null,\n \"createdAt\": \"2023-07-18T18:43:01.000Z\",\n \"updatedAt\": \"2023-07-18T18:43:01.000Z\",\n \"notebookId\": 11\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","X-Pagination-Per-Page":"20","Access-Control-Expose-Headers":"X-Pagination-Per-Page, X-Pagination-Current-Page, X-Pagination-Total-Pages, X-Pagination-Total-Entries","X-Pagination-Current-Page":"1","X-Pagination-Total-Pages":"1","X-Pagination-Total-Entries":"1","Content-Type":"application/json; charset=utf-8","ETag":"W/\"88ffd4b0672326438560dc4631b03383\"","X-Request-Id":"79580e58-6209-438a-968c-452ab0db5223","X-Runtime":"0.017668","Content-Length":"363"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/notebooks/11/deployments\" -X GET \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer GqkfHLcYSk2SXyIpqFm8rS51upQ8Bs6yjy9W6rsnCjw\" \\\n\t-H \"Accept: application/vnd.civis-platform.v1\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"post":{"summary":"Deploy a Notebook","description":null,"deprecated":false,"parameters":[{"name":"notebook_id","in":"path","required":true,"description":"The ID of the owning Notebook","type":"integer"},{"name":"Object401","in":"body","schema":{"$ref":"#/definitions/Object401"},"required":false}],"responses":{"201":{"description":"success","schema":{"$ref":"#/definitions/Object394"}}},"x-examples":[{"resource":"Notebooks","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/notebooks/:notebook_id/deployments","description":"Create a deployment for a notebook","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/notebooks/14/deployments","request_body":null,"request_headers":{"Content-Type":"application/json","Authorization":"Bearer dARbakSNs3dTh-MNUSr_SfFyXrJ9BpYOceIgyTd2EM8","Accept":"application/vnd.civis-platform.v1","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":201,"response_status_text":"Created","response_body":"{\n \"deploymentId\": 7,\n \"userId\": 2551,\n \"host\": \"deployment.foo.com\",\n \"name\": \"deployment\",\n \"dockerImageName\": \"civis-custom-image\",\n \"dockerImageTag\": \"1.1\",\n \"displayUrl\": \"https://deployment.foo.com/civis-platform-auth?token=bm9uY2UyMTNfWFhYWFhYXzI0X2J5dGVzuV1_xogAaANpzAZzkPEy4X05eodHpWFX4aOxQbRdnPtix7wZKb7yC88Yla3ETUJdRkliso7_9JZSH_00PbtDY1y-yXSxPhsNGu1rC1LooqsAtiEin09UXUPSZjktNn8LuLM1DPehzl0OVtcfjacIk3p4smNHX2nfL7I2jPjRfvbQym90NuURdCER-UZYwl2ZrInGHg5PP0ZHZEbCeRpcT3j6VpGfS4Gsd7yVsW47259cZH8I3hNKRNg--Jt69y1YdZAMUWAp5rGx7WaF-O6EG8ew1-X-FeiG89oTviOVgqBH9DPY9t0An0XEXl7C-XCZ37RWHycftVqE2x3qlvPYcXfTXRqI3lrh5Cf_xYTw5qyzaDx3biW3KbrvsWYKV3zDphGbkefJ4JAMtanLEXEVGO6AoqxF2K16-10=\",\n \"instanceType\": \"m4.xlarge\",\n \"memory\": 2008,\n \"cpu\": 500,\n \"state\": null,\n \"stateMessage\": null,\n \"maxMemoryUsage\": null,\n \"maxCpuUsage\": null,\n \"createdAt\": \"2023-07-18T18:43:01.000Z\",\n \"updatedAt\": \"2023-07-18T18:43:01.000Z\",\n \"notebookId\": 14\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"8df05aff45abb8af3e391ecfd9e07c1a\"","X-Request-Id":"e76232f2-c8f1-4abc-8e38-acc3e93f8cf9","X-Runtime":"0.020275","Content-Length":"882"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/notebooks/14/deployments\" -d '' -X POST \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer dARbakSNs3dTh-MNUSr_SfFyXrJ9BpYOceIgyTd2EM8\" \\\n\t-H \"Accept: application/vnd.civis-platform.v1\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/notebooks/{notebook_id}/deployments/{deployment_id}":{"get":{"summary":"Get details about a Notebook deployment","description":null,"deprecated":false,"parameters":[{"name":"notebook_id","in":"path","required":true,"description":"The ID of the owning Notebook","type":"integer"},{"name":"deployment_id","in":"path","required":true,"description":"The ID for this deployment","type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object394"}}},"x-examples":[{"resource":"Notebooks","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/notebooks/:notebook_id/deployments/:deployment_id","description":"View a notebook deployment's details","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/notebooks/12/deployments/5","request_body":null,"request_headers":{"Content-Type":"application/json","Authorization":"Bearer ob6CYh8SvRf9Jk5hlqoPWF-l_kcOZj7g5iKh0DQ-45E","Accept":"application/vnd.civis-platform.v1","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"deploymentId\": 5,\n \"userId\": 2547,\n \"host\": \"deployment.foo.com\",\n \"name\": \"deployment\",\n \"dockerImageName\": \"civis-custom-image\",\n \"dockerImageTag\": \"1.1\",\n \"displayUrl\": \"https://deployment.foo.com/civis-platform-auth?token=bm9uY2UyMTNfWFhYWFhYXzI0X2J5dGVzMTc2fH5GiQJfEO0LWPDnF_EnyVt22pXUy2queGqSkpIFAfYxuETBTutrM3LxA71FOYSF13RX9uoQAF7CbpaXWuw8qgeoQush0HQrp1-AYR05TyqXFd7jRqaYJR0ap90IdXV0VXWupkYeWj4Ud7vnxfFRmY1EYpPklcKFsJvuOZipexX_Msc_wQgiUMSUEBU2-eI9FknCwJDT-5I_z0kxCNJLM5UB8WwnW65Ri6dpqbqF2GJ3qO5sM_9q9FsxxaFG0mgske3dJ8rT3I5R60hnGqvA5-IyvhRSKt9Dje14fWACXFab3bki6pT-1ZzD3PaM6ChOoo7gWBnlX9P35tWJl9ZzNH88umv7ZMpBJ6x9vYLmp9bgSMpC8QChdrpjNK4DyMlUu5FGyw4jODsm4pvumXSOrjtDazD_eLw=\",\n \"instanceType\": \"m4.xlarge\",\n \"memory\": 2008,\n \"cpu\": 500,\n \"state\": null,\n \"stateMessage\": null,\n \"maxMemoryUsage\": null,\n \"maxCpuUsage\": null,\n \"createdAt\": \"2023-07-18T18:43:01.000Z\",\n \"updatedAt\": \"2023-07-18T18:43:01.000Z\",\n \"notebookId\": 12\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"d39e37d5392c96f1759e911543a07dd5\"","X-Request-Id":"5cd3dfe9-aed7-4ac6-85fa-0f54f474344b","X-Runtime":"0.019256","Content-Length":"882"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/notebooks/12/deployments/5\" -X GET \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer ob6CYh8SvRf9Jk5hlqoPWF-l_kcOZj7g5iKh0DQ-45E\" \\\n\t-H \"Accept: application/vnd.civis-platform.v1\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"delete":{"summary":"Delete a Notebook deployment","description":null,"deprecated":false,"parameters":[{"name":"notebook_id","in":"path","required":true,"description":"The ID of the owning Notebook","type":"integer"},{"name":"deployment_id","in":"path","required":true,"description":"The ID for this deployment","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":[{"resource":"Notebooks","resource_explanation":null,"http_method":"DELETE","route":"http://api.civis.test/notebooks/:notebook_id/deployments/:deployment_id","description":"Delete a deployment for a notebook","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"DELETE","request_path":"http://api.civis.test/notebooks/15/deployments/8","request_body":null,"request_headers":{"Content-Type":"application/json","Authorization":"Bearer 0nnkNn_tUoRH7qWCjbeKse4mA9dmlGQ9kGEpZESXr9Q","Accept":"application/vnd.civis-platform.v1","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":204,"response_status_text":"No Content","response_body":null,"response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","X-Request-Id":"26e97429-3fbf-4e8f-a8f0-ddc9b4621567","X-Runtime":"0.017184"},"response_content_type":null,"curl":"curl \"api.civis.testhttp://api.civis.test/notebooks/15/deployments/8\" -d '' -X DELETE \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer 0nnkNn_tUoRH7qWCjbeKse4mA9dmlGQ9kGEpZESXr9Q\" \\\n\t-H \"Accept: application/vnd.civis-platform.v1\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/notebooks/{id}/deployments/{deployment_id}/logs":{"get":{"summary":"Get the logs for a Notebook deployment","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the owning Notebook.","type":"integer"},{"name":"deployment_id","in":"path","required":true,"description":"The ID for this deployment.","type":"integer"},{"name":"start_at","in":"query","required":false,"description":"Log entries with a lower timestamp will be omitted.","type":"string","format":"date-time"},{"name":"end_at","in":"query","required":false,"description":"Log entries with a higher timestamp will be omitted.","type":"string","format":"date-time"},{"name":"limit","in":"query","required":false,"description":"The maximum number of log messages to return. Default of 10000.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object57"}}}},"x-examples":null,"x-deprecation-warning":null}},"/notebooks/{id}/git":{"get":{"summary":"Get the git metadata attached to an item","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the item.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object403"}}},"x-examples":null,"x-deprecation-warning":null},"put":{"summary":"Attach an item to a file in a git repo","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the item.","type":"integer"},{"name":"Object404","in":"body","schema":{"$ref":"#/definitions/Object404"},"required":false}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object403"}}},"x-examples":null,"x-deprecation-warning":null},"patch":{"summary":"Update an attached git file","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the item.","type":"integer"},{"name":"Object404","in":"body","schema":{"$ref":"#/definitions/Object404"},"required":false}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object403"}}},"x-examples":null,"x-deprecation-warning":null}},"/notebooks/{id}/git/commits":{"get":{"summary":"Get the git commits for an item on the current branch","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the item.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object405"}}},"x-examples":null,"x-deprecation-warning":null},"post":{"summary":"Commit and push a new version of the file","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the item.","type":"integer"},{"name":"Object406","in":"body","schema":{"$ref":"#/definitions/Object406"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object407"}}},"x-examples":null,"x-deprecation-warning":null}},"/notebooks/{id}/git/commits/{commit_hash}":{"get":{"summary":"Get file contents at git ref","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the item.","type":"integer"},{"name":"commit_hash","in":"path","required":true,"description":"The SHA (full or shortened) of the desired git commit.","type":"string"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object407"}}},"x-examples":null,"x-deprecation-warning":null}},"/notifications/":{"get":{"summary":"Receive a stream of notifications as they come in","description":null,"deprecated":false,"parameters":[{"name":"last_event_id","in":"query","required":false,"description":"allows browser to keep track of last event fired","type":"string"},{"name":"r","in":"query","required":false,"description":"specifies retry/reconnect timeout","type":"string"},{"name":"mock","in":"query","required":false,"description":"used for testing","type":"string"}],"responses":{"200":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/ontology/":{"get":{"summary":"List the ontology of column names Civis uses","description":null,"deprecated":false,"parameters":[{"name":"subset","in":"query","required":false,"description":"A subset of fields to return.","type":"string"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object412"}}}},"x-examples":[{"resource":"Ontology","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/ontology","description":"List the ontology","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/ontology","request_body":null,"request_headers":{"Authorization":"Bearer t5ypz45C2EeizJFxGUJ0hkJzFyyZ598BSWBsdGzv9hs","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":null,"response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"key\": \"primary_key\",\n \"title\": \"Primary Key\",\n \"desc\": \"A primary key (aka an ID) for a record\",\n \"aliases\": [\n \"id\"\n ]\n },\n {\n \"key\": \"name\",\n \"title\": \"Full Name\",\n \"desc\": \"Some combination of first, last, and maybe middle name\",\n \"aliases\": [\n \"full_name\"\n ]\n },\n {\n \"key\": \"company\",\n \"title\": \"Company\",\n \"desc\": \"The company/firm/organization name \",\n \"aliases\": [\n\n ]\n },\n {\n \"key\": \"first_name\",\n \"title\": \"First Name\",\n \"desc\": \"A person's first (given) name\",\n \"aliases\": [\n \"first\",\n \"firstname\"\n ]\n },\n {\n \"key\": \"middle_name\",\n \"title\": \"Middle Name\",\n \"desc\": \"A person's middle name\",\n \"aliases\": [\n \"middle\",\n \"middlename\"\n ]\n },\n {\n \"key\": \"middle_initial\",\n \"title\": \"Middle Initial\",\n \"desc\": \"The first letter of a person's middle name\",\n \"aliases\": [\n \"mi\"\n ]\n },\n {\n \"key\": \"last_name\",\n \"title\": \"Last Name\",\n \"desc\": \"A person's last name (surname)\",\n \"aliases\": [\n \"last\",\n \"lastname\"\n ]\n },\n {\n \"key\": \"gender\",\n \"title\": \"Gender\",\n \"desc\": \"A person's gender\",\n \"aliases\": [\n \"sex\"\n ]\n },\n {\n \"key\": \"birth_date\",\n \"title\": \"Birth Date\",\n \"desc\": \"A person's full birth date, including year, month, and day\",\n \"aliases\": [\n \"dob\",\n \"birthdate\"\n ]\n },\n {\n \"key\": \"phone\",\n \"title\": \"Phone\",\n \"desc\": \"A person's phone number\",\n \"aliases\": [\n\n ]\n },\n {\n \"key\": \"email\",\n \"title\": \"Email\",\n \"desc\": \"A person's email address\",\n \"aliases\": [\n \"email_address\"\n ]\n },\n {\n \"key\": \"birth_year\",\n \"title\": \"Birth Year\",\n \"desc\": \"The year in which a person was born\",\n \"aliases\": [\n \"birthyear\"\n ]\n },\n {\n \"key\": \"birth_month\",\n \"title\": \"Birth Month\",\n \"desc\": \"The month in which a person was born\",\n \"aliases\": [\n \"birthmonth\"\n ]\n },\n {\n \"key\": \"birth_day\",\n \"title\": \"Birth Day\",\n \"desc\": \"The day of the month in which a person was born\",\n \"aliases\": [\n \"birthday\"\n ]\n },\n {\n \"key\": \"house_number\",\n \"title\": \"House Number\",\n \"desc\": \"The house number portion of a Street Address\",\n \"aliases\": [\n \"addresshouse\"\n ]\n },\n {\n \"key\": \"street\",\n \"title\": \"Street\",\n \"desc\": \"The street name portion of a Street Address\",\n \"aliases\": [\n \"addressstreet\"\n ]\n },\n {\n \"key\": \"unit\",\n \"title\": \"Address Unit Number\",\n \"desc\": \"The unit/apartment number portion of a Street Address\",\n \"aliases\": [\n \"addressapt\",\n \"addressunit\"\n ]\n },\n {\n \"key\": \"full_address\",\n \"title\": \"Full Address\",\n \"desc\": \"A complete address in a single string\",\n \"aliases\": [\n \"address\"\n ]\n },\n {\n \"key\": \"address1\",\n \"title\": \"Street Address\",\n \"desc\": \"The first line of an address\",\n \"aliases\": [\n \"street_address\",\n \"street_address1\"\n ]\n },\n {\n \"key\": \"address2\",\n \"title\": \"Address 2\",\n \"desc\": \"The second line of an address, usually for a unit #\",\n \"aliases\": [\n \"street_address2\"\n ]\n },\n {\n \"key\": \"city\",\n \"title\": \"City\",\n \"desc\": \"The city name\",\n \"aliases\": [\n \"town\"\n ]\n },\n {\n \"key\": \"state\",\n \"title\": \"State Name\",\n \"desc\": \"The name of the state\",\n \"aliases\": [\n\n ]\n },\n {\n \"key\": \"state_code\",\n \"title\": \"State Abbreviation\",\n \"desc\": \"The state's abbreviation\",\n \"aliases\": [\n\n ]\n },\n {\n \"key\": \"county\",\n \"title\": \"County\",\n \"desc\": \"The US county or parish\",\n \"aliases\": [\n\n ]\n },\n {\n \"key\": \"zip\",\n \"title\": \"Zip Code\",\n \"desc\": \"A postal code, possibly zip-5 or zip-9\",\n \"aliases\": [\n \"zip_code\",\n \"zipcode\",\n \"postalcode\",\n \"pcode\"\n ]\n },\n {\n \"key\": \"zip5\",\n \"title\": \"5-digit zip code\",\n \"desc\": \"\",\n \"aliases\": [\n\n ]\n },\n {\n \"key\": \"zip4\",\n \"title\": \"4-digit zip code\",\n \"desc\": \"The final four digits of a 9-digit zip code\",\n \"aliases\": [\n\n ]\n },\n {\n \"key\": \"zip9\",\n \"title\": \"9-digit zip code\",\n \"desc\": \"A full 9-digit US postal code\",\n \"aliases\": [\n\n ]\n },\n {\n \"key\": \"lat\",\n \"title\": \"Latitude\",\n \"desc\": \"\",\n \"aliases\": [\n \"latitude\"\n ]\n },\n {\n \"key\": \"lon\",\n \"title\": \"Longitude\",\n \"desc\": \"\",\n \"aliases\": [\n \"longitude\",\n \"long\"\n ]\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"cb9e7271ce6121f520d1d93777093847\"","X-Request-Id":"9ac7635a-5af6-425c-afb8-dc6b36371c54","X-Runtime":"0.012576","Content-Length":"3152"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/ontology\" -X GET \\\n\t-H \"Authorization: Bearer t5ypz45C2EeizJFxGUJ0hkJzFyyZ598BSWBsdGzv9hs\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/organizations/favorites":{"get":{"summary":"List Favorites","description":"List organization-level favorites.","deprecated":false,"parameters":[{"name":"object_id","in":"query","required":false,"description":"The id of the object. If specified as a query parameter, must also specify object_type parameter.","type":"integer"},{"name":"object_type","in":"query","required":false,"description":"The type of the object that is favorited. Valid options: Container Script, Identity Resolution, Import, Python Script, R Script, dbt Script, JavaScript Script, SQL Script, Template Script, Project, Workflow, Tableau Report, Service Report, HTML Report, SQL Report","type":"string"},{"name":"limit","in":"query","required":false,"description":"Number of results to return. Defaults to 50. Maximum allowed is 1000.","type":"integer"},{"name":"page_num","in":"query","required":false,"description":"Page number of the results to return. Defaults to the first page, 1.","type":"integer"},{"name":"order","in":"query","required":false,"description":"The field on which to order the result set. Defaults to created_at. Must be one of: created_at, object_type, object_id.","type":"string"},{"name":"order_dir","in":"query","required":false,"description":"Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc.","type":"string"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object413"}}}},"x-examples":null,"x-deprecation-warning":null},"post":{"summary":"Favorite an item for your organization","description":"Only available for Organization Admin users.","deprecated":false,"parameters":[{"name":"Object414","in":"body","schema":{"$ref":"#/definitions/Object414"},"required":true}],"responses":{"201":{"description":"success","schema":{"$ref":"#/definitions/Object415"}}},"x-examples":null,"x-deprecation-warning":null}},"/organizations/favorites/{id}":{"delete":{"summary":"Unfavorite an item for your organization","description":"Only available for Organization Admin users.","deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The id of the favorite.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/permission_sets/":{"get":{"summary":"List Permission Sets","description":null,"deprecated":false,"parameters":[{"name":"archived","in":"query","required":false,"description":"The archival status of the requested item(s).","type":"string"},{"name":"author","in":"query","required":false,"description":"If specified, return items from any of these authors. It accepts a comma-separated list of user IDs.","type":"string"},{"name":"limit","in":"query","required":false,"description":"Number of results to return. Defaults to 20. Maximum allowed is 50.","type":"integer"},{"name":"page_num","in":"query","required":false,"description":"Page number of the results to return. Defaults to the first page, 1.","type":"integer"},{"name":"order","in":"query","required":false,"description":"The field on which to order the result set. Defaults to updated_at. Must be one of: updated_at, name, created_at.","type":"string"},{"name":"order_dir","in":"query","required":false,"description":"Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc.","type":"string"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object416"}}}},"x-examples":[{"resource":"PermissionSets","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/permission_sets","description":"List all permission sets","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/permission_sets","request_body":null,"request_headers":{"Content-Type":"application/json","Authorization":"Bearer Yb1bWbkrPEOwa0jUafbpml2ytdTVItfI8TUSznrvi68","Accept":"application/vnd.civis-platform.v1","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 1,\n \"name\": \"permission set\",\n \"description\": null,\n \"author\": {\n \"id\": 2566,\n \"name\": \"User devuserfactory1888 1886\",\n \"username\": \"devuserfactory1888\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"createdAt\": \"2023-07-18T18:43:02.000Z\",\n \"updatedAt\": \"2023-07-18T18:43:02.000Z\",\n \"archived\": false\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","X-Pagination-Per-Page":"20","Access-Control-Expose-Headers":"X-Pagination-Per-Page, X-Pagination-Current-Page, X-Pagination-Total-Pages, X-Pagination-Total-Entries","X-Pagination-Current-Page":"1","X-Pagination-Total-Pages":"1","X-Pagination-Total-Entries":"1","Content-Type":"application/json; charset=utf-8","ETag":"W/\"22c98349607cd82dccadc85fcfd876b7\"","X-Request-Id":"6342574a-0eb2-48ed-a967-adb5146302c2","X-Runtime":"0.016662","Content-Length":"269"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/permission_sets\" -X GET \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer Yb1bWbkrPEOwa0jUafbpml2ytdTVItfI8TUSznrvi68\" \\\n\t-H \"Accept: application/vnd.civis-platform.v1\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"post":{"summary":"Create a Permission Set","description":null,"deprecated":false,"parameters":[{"name":"Object417","in":"body","schema":{"$ref":"#/definitions/Object417"},"required":true}],"responses":{"201":{"description":"success","schema":{"$ref":"#/definitions/Object416"}}},"x-examples":[{"resource":"PermissionSets","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/permission_sets","description":"Create a permission set","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/permission_sets","request_body":"{\n \"name\": \"service permissions\"\n}","request_headers":{"Content-Type":"application/json","Authorization":"Bearer 5anL9DoDsZLfe1qXjrnTONv9MzAH65mzEF1pr4KAF4k","Accept":"application/vnd.civis-platform.v1","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":201,"response_status_text":"Created","response_body":"{\n \"id\": 3,\n \"name\": \"service permissions\",\n \"description\": null,\n \"author\": {\n \"id\": 2567,\n \"name\": \"User devuserfactory1889 1887\",\n \"username\": \"devuserfactory1889\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"createdAt\": \"2023-07-18T18:43:02.000Z\",\n \"updatedAt\": \"2023-07-18T18:43:02.000Z\",\n \"archived\": false\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"a83e33e36f8cbfda869b7751e4640add\"","X-Request-Id":"eee01563-b565-48eb-a10c-b29d0b94dfcf","X-Runtime":"0.049765","Content-Length":"272"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/permission_sets\" -d '{\"name\":\"service permissions\"}' -X POST \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer 5anL9DoDsZLfe1qXjrnTONv9MzAH65mzEF1pr4KAF4k\" \\\n\t-H \"Accept: application/vnd.civis-platform.v1\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/permission_sets/{id}":{"get":{"summary":"Get a Permission Set","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object416"}}},"x-examples":[{"resource":"PermissionSets","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/permission_sets/:id","description":"View a permission set's details","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/permission_sets/4","request_body":null,"request_headers":{"Content-Type":"application/json","Authorization":"Bearer A83QH9sK5Jtg1_q0LvCtRYEo1UWIecSJ6QsyaZ4gBVA","Accept":"application/vnd.civis-platform.v1","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 4,\n \"name\": \"permission set\",\n \"description\": null,\n \"author\": {\n \"id\": 2568,\n \"name\": \"User devuserfactory1890 1888\",\n \"username\": \"devuserfactory1890\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"createdAt\": \"2023-07-18T18:43:03.000Z\",\n \"updatedAt\": \"2023-07-18T18:43:03.000Z\",\n \"archived\": false\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"e11578662bb76800f503ff52a52eb5ad\"","X-Request-Id":"06bbeaff-4fc9-4d05-96ad-d13b7b849c77","X-Runtime":"0.014690","Content-Length":"267"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/permission_sets/4\" -X GET \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer A83QH9sK5Jtg1_q0LvCtRYEo1UWIecSJ6QsyaZ4gBVA\" \\\n\t-H \"Accept: application/vnd.civis-platform.v1\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"put":{"summary":"Replace all attributes of this Permission Set","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID for this permission set.","type":"integer"},{"name":"Object418","in":"body","schema":{"$ref":"#/definitions/Object418"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object416"}}},"x-examples":null,"x-deprecation-warning":null},"patch":{"summary":"Update some attributes of this Permission Set","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID for this permission set.","type":"integer"},{"name":"Object419","in":"body","schema":{"$ref":"#/definitions/Object419"},"required":false}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object416"}}},"x-examples":[{"resource":"PermissionSets","resource_explanation":null,"http_method":"PATCH","route":"http://api.civis.test/permission_sets/:id","description":"Update a permission set","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"PATCH","request_path":"http://api.civis.test/permission_sets/5","request_body":"{\n \"description\": \"access control\"\n}","request_headers":{"Content-Type":"application/json","Authorization":"Bearer JpmL-LNTUqMbtd5Mg3gX2YhVJBSiDxiOwGFeUNw5HJc","Accept":"application/vnd.civis-platform.v1","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 5,\n \"name\": \"permission set\",\n \"description\": \"access control\",\n \"author\": {\n \"id\": 2569,\n \"name\": \"User devuserfactory1891 1889\",\n \"username\": \"devuserfactory1891\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"createdAt\": \"2023-07-18T18:43:03.000Z\",\n \"updatedAt\": \"2023-07-18T18:43:03.000Z\",\n \"archived\": false\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"bf8af75545627f86ffcd95ff5acce5a7\"","X-Request-Id":"7af7060f-ccea-4591-81e5-e1990991f403","X-Runtime":"0.023627","Content-Length":"279"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/permission_sets/5\" -d '{\"description\":\"access control\"}' -X PATCH \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer JpmL-LNTUqMbtd5Mg3gX2YhVJBSiDxiOwGFeUNw5HJc\" \\\n\t-H \"Accept: application/vnd.civis-platform.v1\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/permission_sets/{id}/shares":{"get":{"summary":"List users and groups permissioned on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object9"}}}},"x-examples":null,"x-deprecation-warning":null}},"/permission_sets/{id}/shares/users":{"put":{"summary":"Set the permissions users have on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"Object420","in":"body","schema":{"$ref":"#/definitions/Object420"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object9"}}},"x-examples":null,"x-deprecation-warning":null}},"/permission_sets/{id}/shares/users/{user_id}":{"delete":{"summary":"Revoke the permissions a user has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"user_id","in":"path","required":true,"description":"The ID of the user.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/permission_sets/{id}/shares/groups":{"put":{"summary":"Set the permissions groups has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"Object421","in":"body","schema":{"$ref":"#/definitions/Object421"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object9"}}},"x-examples":null,"x-deprecation-warning":null}},"/permission_sets/{id}/shares/groups/{group_id}":{"delete":{"summary":"Revoke the permissions a group has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"group_id","in":"path","required":true,"description":"The ID of the group.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/permission_sets/{id}/dependencies":{"get":{"summary":"List dependent objects for this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"user_id","in":"query","required":false,"description":"ID of target user","type":"integer"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object15"}}}},"x-examples":null,"x-deprecation-warning":null}},"/permission_sets/{id}/transfer":{"put":{"summary":"Transfer ownership of this object to another user","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"Object422","in":"body","schema":{"$ref":"#/definitions/Object422"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object17"}}},"x-examples":null,"x-deprecation-warning":null}},"/permission_sets/{id}/archive":{"put":{"summary":"Update the archive status of this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the object.","type":"integer"},{"name":"Object423","in":"body","schema":{"$ref":"#/definitions/Object423"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object416"}}},"x-examples":null,"x-deprecation-warning":null}},"/permission_sets/{id}/users/{user_id}/permissions":{"get":{"summary":"Get all permissions for a user, in this permission set","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID for this permission set.","type":"integer"},{"name":"user_id","in":"path","required":true,"description":"The ID for the user.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object424"}}}},"x-examples":[{"resource":"PermissionSets","resource_explanation":null,"http_method":"GET","route":"https://api.civis.test/permission_sets/:id/users/:user_id/permissions","description":"Retrieve all permissions for a user in this permission set","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"https://api.civis.test/permission_sets/11/users/2576/permissions","request_body":null,"request_headers":{"Content-Type":"application/json","Authorization":"Bearer NMfdIGafki57EwqMfuVY4kJt90M5p221EK17itms5Bs","Accept":"application/vnd.civis-platform.v1","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"resourceName\": \"resource_10\",\n \"read\": true,\n \"write\": false,\n \"manage\": false\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"f2489b65e86e25aa08d87503f016bd55\"","X-Request-Id":"83837a8b-5369-4513-9e84-ea50c54eb829","X-Runtime":"0.061662","Content-Length":"73"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttps://api.civis.test/permission_sets/11/users/2576/permissions\" -X GET \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer NMfdIGafki57EwqMfuVY4kJt90M5p221EK17itms5Bs\" \\\n\t-H \"Accept: application/vnd.civis-platform.v1\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/permission_sets/{id}/resources":{"get":{"summary":"List resources in a permission set","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID for this permission set.","type":"integer"},{"name":"limit","in":"query","required":false,"description":"Number of results to return. Defaults to 50. Maximum allowed is 1000.","type":"integer"},{"name":"page_num","in":"query","required":false,"description":"Page number of the results to return. Defaults to the first page, 1.","type":"integer"},{"name":"order","in":"query","required":false,"description":"The field on which to order the result set. Defaults to name. Must be one of: name, id, updated_at, created_at.","type":"string"},{"name":"order_dir","in":"query","required":false,"description":"Direction in which to sort, either asc (ascending) or desc (descending) defaulting to asc.","type":"string"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object425"}}}},"x-examples":[{"resource":"PermissionSets","resource_explanation":null,"http_method":"GET","route":"https://api.civis.test/permission_sets/:id/resources","description":"List all resources in a permission set","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"https://api.civis.test/permission_sets/6/resources","request_body":null,"request_headers":{"Content-Type":"application/json","Authorization":"Bearer y2nHhHOyGBpWSweICPAKzb6Eppq-SuLs4hK6Gmy5gFo","Accept":"application/vnd.civis-platform.v1","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"permissionSetId\": 6,\n \"name\": \"resource_5\",\n \"description\": null,\n \"createdAt\": \"2023-07-18T18:43:03.000Z\",\n \"updatedAt\": \"2023-07-18T18:43:03.000Z\"\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","X-Pagination-Per-Page":"50","Access-Control-Expose-Headers":"X-Pagination-Per-Page, X-Pagination-Current-Page, X-Pagination-Total-Pages, X-Pagination-Total-Entries","X-Pagination-Current-Page":"1","X-Pagination-Total-Pages":"1","X-Pagination-Total-Entries":"1","Content-Type":"application/json; charset=utf-8","ETag":"W/\"644c8327ad8601c8ef89922dd0e4ad75\"","X-Request-Id":"d8269832-484b-48cd-ad47-d0903298ffd5","X-Runtime":"0.017848","Content-Length":"140"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttps://api.civis.test/permission_sets/6/resources\" -X GET \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer y2nHhHOyGBpWSweICPAKzb6Eppq-SuLs4hK6Gmy5gFo\" \\\n\t-H \"Accept: application/vnd.civis-platform.v1\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"post":{"summary":"Create a resource in a permission set","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID for this permission set.","type":"integer"},{"name":"Object426","in":"body","schema":{"$ref":"#/definitions/Object426"},"required":true}],"responses":{"201":{"description":"success","schema":{"$ref":"#/definitions/Object425"}}},"x-examples":[{"resource":"PermissionSets","resource_explanation":null,"http_method":"POST","route":"https://api.civis.test/permission_sets/:id/resources","description":"Create a resource in a permission set","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"https://api.civis.test/permission_sets/7/resources","request_body":"{\n \"name\": \"new_resource\"\n}","request_headers":{"Content-Type":"application/json","Authorization":"Bearer 6M0c8dRU7c0JyHu_bAXxCmCz9IUTPXGMOZeSfyp9Vlc","Accept":"application/vnd.civis-platform.v1","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":201,"response_status_text":"Created","response_body":"{\n \"permissionSetId\": 7,\n \"name\": \"new_resource\",\n \"description\": null,\n \"createdAt\": \"2023-07-18T18:43:03.000Z\",\n \"updatedAt\": \"2023-07-18T18:43:03.000Z\"\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"8a21c45bc91871bc07c68ef70cb4cf3c\"","X-Request-Id":"2cdcc9a8-c98e-45bc-b113-396076ae7890","X-Runtime":"0.019039","Content-Length":"140"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttps://api.civis.test/permission_sets/7/resources\" -d '{\"name\":\"new_resource\"}' -X POST \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer 6M0c8dRU7c0JyHu_bAXxCmCz9IUTPXGMOZeSfyp9Vlc\" \\\n\t-H \"Accept: application/vnd.civis-platform.v1\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/permission_sets/{id}/resources/{name}":{"get":{"summary":"Get a resource in a permission set","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID for this permission set.","type":"integer"},{"name":"name","in":"path","required":true,"description":"The name of this resource.","type":"string"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object425"}}},"x-examples":[{"resource":"PermissionSets","resource_explanation":null,"http_method":"GET","route":"https://api.civis.test/permission_sets/:id/resources/:name","description":"View a resource's details","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"https://api.civis.test/permission_sets/8/resources/resource_7","request_body":null,"request_headers":{"Content-Type":"application/json","Authorization":"Bearer qD3Fxvtxro6olrCCpDz3CjFVngiGDTBMb6QFEjkqaL4","Accept":"application/vnd.civis-platform.v1","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"permissionSetId\": 8,\n \"name\": \"resource_7\",\n \"description\": null,\n \"createdAt\": \"2023-07-18T18:43:03.000Z\",\n \"updatedAt\": \"2023-07-18T18:43:03.000Z\"\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"ae0b55bb9acaa873bd299f46ec9b10b9\"","X-Request-Id":"45d6ee23-6d35-4668-a4fe-e62d71280ebe","X-Runtime":"0.014550","Content-Length":"138"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttps://api.civis.test/permission_sets/8/resources/resource_7\" -X GET \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer qD3Fxvtxro6olrCCpDz3CjFVngiGDTBMb6QFEjkqaL4\" \\\n\t-H \"Accept: application/vnd.civis-platform.v1\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"patch":{"summary":"Update a resource in a permission set","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID for this permission set.","type":"integer"},{"name":"name","in":"path","required":true,"description":"The name of this resource.","type":"string"},{"name":"Object427","in":"body","schema":{"$ref":"#/definitions/Object427"},"required":false}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object425"}}},"x-examples":[{"resource":"PermissionSets","resource_explanation":null,"http_method":"PATCH","route":"https://api.civis.test/permission_sets/:id/resources/:name","description":"Update a resource in a permission set","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"PATCH","request_path":"https://api.civis.test/permission_sets/9/resources/resource_8","request_body":"{\n \"description\": \"security\"\n}","request_headers":{"Content-Type":"application/json","Authorization":"Bearer tuLO11CAIUWHE_e5FG26hTMys6V0QXLEbegwEGdm_j4","Accept":"application/vnd.civis-platform.v1","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"permissionSetId\": 9,\n \"name\": \"resource_8\",\n \"description\": \"security\",\n \"createdAt\": \"2023-07-18T18:43:03.000Z\",\n \"updatedAt\": \"2023-07-18T18:43:03.000Z\"\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"167e69dd22590cd5ea7a3f181a56330b\"","X-Request-Id":"8ac5b481-745f-4e00-8e87-000abdcaf01e","X-Runtime":"0.018431","Content-Length":"144"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttps://api.civis.test/permission_sets/9/resources/resource_8\" -d '{\"description\":\"security\"}' -X PATCH \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer tuLO11CAIUWHE_e5FG26hTMys6V0QXLEbegwEGdm_j4\" \\\n\t-H \"Accept: application/vnd.civis-platform.v1\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"delete":{"summary":"Delete a resource in a permission set","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID for this permission set.","type":"integer"},{"name":"name","in":"path","required":true,"description":"The name of this resource.","type":"string"}],"responses":{"204":{"description":"success"}},"x-examples":[{"resource":"PermissionSets","resource_explanation":null,"http_method":"DELETE","route":"https://api.civis.test/permission_sets/:id/resources/:name","description":"Delete a resource in a permission set","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"DELETE","request_path":"https://api.civis.test/permission_sets/10/resources/resource_9","request_body":null,"request_headers":{"Content-Type":"application/json","Authorization":"Bearer fBALXDU3Ltz47HJDk6HuWfv8y_5qYejQQrh3NrYEYNc","Accept":"application/vnd.civis-platform.v1","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":204,"response_status_text":"No Content","response_body":null,"response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","X-Request-Id":"6e297d45-2fba-42f2-b01a-8c5c342d9d3c","X-Runtime":"0.021675"},"response_content_type":null,"curl":"curl \"api.civis.testhttps://api.civis.test/permission_sets/10/resources/resource_9\" -d '' -X DELETE \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer fBALXDU3Ltz47HJDk6HuWfv8y_5qYejQQrh3NrYEYNc\" \\\n\t-H \"Accept: application/vnd.civis-platform.v1\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/permission_sets/{id}/resources/{name}/shares":{"get":{"summary":"List users and groups permissioned on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID for this permission set.","type":"integer"},{"name":"name","in":"path","required":true,"description":"The name of this resource.","type":"string"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object9"}}}},"x-examples":null,"x-deprecation-warning":null}},"/permission_sets/{id}/resources/{name}/shares/users":{"put":{"summary":"Set the permissions users have on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID for this permission set.","type":"integer"},{"name":"name","in":"path","required":true,"description":"The name of this resource.","type":"string"},{"name":"Object428","in":"body","schema":{"$ref":"#/definitions/Object428"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object9"}}},"x-examples":null,"x-deprecation-warning":null}},"/permission_sets/{id}/resources/{name}/shares/users/{user_id}":{"delete":{"summary":"Revoke the permissions a user has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID for this permission set.","type":"integer"},{"name":"name","in":"path","required":true,"description":"The name of this resource.","type":"string"},{"name":"user_id","in":"path","required":true,"description":"The ID of the user.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/permission_sets/{id}/resources/{name}/shares/groups":{"put":{"summary":"Set the permissions groups has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID for this permission set.","type":"integer"},{"name":"name","in":"path","required":true,"description":"The name of this resource.","type":"string"},{"name":"Object429","in":"body","schema":{"$ref":"#/definitions/Object429"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object9"}}},"x-examples":null,"x-deprecation-warning":null}},"/permission_sets/{id}/resources/{name}/shares/groups/{group_id}":{"delete":{"summary":"Revoke the permissions a group has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID for this permission set.","type":"integer"},{"name":"name","in":"path","required":true,"description":"The name of this resource.","type":"string"},{"name":"group_id","in":"path","required":true,"description":"The ID of the group.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/predictions/":{"get":{"summary":"List predictions","description":null,"deprecated":false,"parameters":[{"name":"model_id","in":"query","required":false,"description":"If specified, only return predictions associated with this model ID.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object430"}}}},"x-examples":[{"resource":"Predictions","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/predictions?modelId=:model_id","description":"Filter predictions by predictive model","explanation":null,"parameters":[{"required":false,"name":"modelId","description":"If specified, only return predictions associated with this model ID."}],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/predictions?modelId=2127","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer yC-xAgHtHYbIlNVLB4x6kjEgONQegEjaxgPBNCuz5bQ","Host":"api.civis.test","Cookie":""},"request_query_parameters":{"modelId":"2127"},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 2132,\n \"modelId\": 2127,\n \"scoredTableId\": 132,\n \"scoredTableName\": \"schema_name.table_name137\",\n \"outputTableName\": null,\n \"state\": \"running\",\n \"error\": null,\n \"startedAt\": \"2015-01-01T01:01:01.000Z\",\n \"finishedAt\": \"2012-02-02T02:02:02.000Z\",\n \"lastRun\": {\n \"id\": 190,\n \"state\": \"running\",\n \"createdAt\": \"2024-03-29T15:00:40.000Z\",\n \"startedAt\": \"2015-01-01T01:01:01.000Z\",\n \"finishedAt\": \"2012-02-02T02:02:02.000Z\",\n \"error\": null\n }\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"289c8862324503cf9150563b650736cb\"","X-Request-Id":"48a5740e-fdda-449d-beba-8e04c0e8d131","X-Runtime":"0.030223","Content-Length":"397"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/predictions?modelId=2127\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer yC-xAgHtHYbIlNVLB4x6kjEgONQegEjaxgPBNCuz5bQ\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Predictions","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/predictions","description":"List visible predictions","explanation":null,"parameters":[{"required":false,"name":"modelId","description":"If specified, only return predictions associated with this model ID."}],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/predictions","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer mBlTWzap-KZMlH3yO0d9ZSYmEGkdiTyOh7gYS03BBXY","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 2143,\n \"modelId\": 2140,\n \"scoredTableId\": 159,\n \"scoredTableName\": \"schema_name.table_name164\",\n \"outputTableName\": null,\n \"state\": \"running\",\n \"error\": null,\n \"startedAt\": \"2015-01-01T01:01:01.000Z\",\n \"finishedAt\": \"2012-02-02T02:02:02.000Z\",\n \"lastRun\": {\n \"id\": 195,\n \"state\": \"running\",\n \"createdAt\": \"2024-03-29T15:00:43.000Z\",\n \"startedAt\": \"2015-01-01T01:01:01.000Z\",\n \"finishedAt\": \"2012-02-02T02:02:02.000Z\",\n \"error\": null\n }\n },\n {\n \"id\": 2142,\n \"modelId\": 2137,\n \"scoredTableId\": 150,\n \"scoredTableName\": \"schema_name.table_name155\",\n \"outputTableName\": null,\n \"state\": \"running\",\n \"error\": null,\n \"startedAt\": \"2015-01-01T01:01:01.000Z\",\n \"finishedAt\": \"2012-02-02T02:02:02.000Z\",\n \"lastRun\": {\n \"id\": 194,\n \"state\": \"running\",\n \"createdAt\": \"2024-03-29T15:00:43.000Z\",\n \"startedAt\": \"2015-01-01T01:01:01.000Z\",\n \"finishedAt\": \"2012-02-02T02:02:02.000Z\",\n \"error\": null\n }\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"a412eac0bec8714550c7bd9c84abd0d8\"","X-Request-Id":"03ed568a-0cdb-4ead-af95-357f3935e8bf","X-Runtime":"0.033118","Content-Length":"793"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/predictions\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer mBlTWzap-KZMlH3yO0d9ZSYmEGkdiTyOh7gYS03BBXY\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/predictions/{id}":{"get":{"summary":"Show the specified prediction","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the prediction.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object431"}}},"x-examples":[{"resource":"Predictions","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/predictions/:id","description":"View a prediction","explanation":null,"parameters":[{"required":true,"name":"id","description":"The ID of the prediction."}],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/predictions/2149","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer vOC65m_mBdKCIdRigXkojIZ6S1rWhusO-rNWCiduhqk","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 2149,\n \"modelId\": 2147,\n \"scoredTableId\": 168,\n \"scoredTableName\": \"schema_name.table_name173\",\n \"outputTableName\": null,\n \"state\": \"running\",\n \"error\": null,\n \"startedAt\": \"2015-01-01T01:01:01.000Z\",\n \"finishedAt\": \"2012-02-02T02:02:02.000Z\",\n \"lastRun\": {\n \"id\": 197,\n \"state\": \"running\",\n \"createdAt\": \"2024-03-29T15:00:44.000Z\",\n \"startedAt\": \"2015-01-01T01:01:01.000Z\",\n \"finishedAt\": \"2012-02-02T02:02:02.000Z\",\n \"error\": null\n },\n \"scoredTables\": [\n {\n \"id\": 1,\n \"schema\": \"schema_name\",\n \"name\": \"table_name183\",\n \"createdAt\": \"2024-03-29T15:00:44.000Z\",\n \"scoreStats\": [\n {\n \"scoreName\": \"score\",\n \"histogram\": [\n 1,\n 2,\n 3,\n 4,\n 5,\n 6,\n 7,\n 8,\n 9,\n 10,\n 11,\n 12,\n 13,\n 14,\n 15,\n 16,\n 17,\n 18,\n 19,\n 20\n ],\n \"avgScore\": 0.5,\n \"minScore\": 0.1,\n \"maxScore\": 0.9\n }\n ]\n },\n {\n \"id\": 2,\n \"schema\": \"schema_name\",\n \"name\": \"table_name185\",\n \"createdAt\": \"2024-03-29T15:00:45.000Z\",\n \"scoreStats\": [\n {\n \"scoreName\": \"score\",\n \"histogram\": [\n 1,\n 2,\n 3,\n 4,\n 5,\n 6,\n 7,\n 8,\n 9,\n 10,\n 11,\n 12,\n 13,\n 14,\n 15,\n 16,\n 17,\n 18,\n 19,\n 20\n ],\n \"avgScore\": 0.5,\n \"minScore\": 0.1,\n \"maxScore\": 0.9\n }\n ]\n }\n ],\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n },\n \"limitingSQL\": null,\n \"primaryKey\": [\n \"personid\"\n ]\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"46a9b69eccfa9e69f3cc783ec43043d3\"","X-Request-Id":"2ddd9029-e119-486f-b586-66a65921ae4a","X-Runtime":"0.036726","Content-Length":"1084"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/predictions/2149\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer vOC65m_mBdKCIdRigXkojIZ6S1rWhusO-rNWCiduhqk\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/predictions/{id}/schedules":{"get":{"summary":"Show the prediction schedule","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"ID of the prediction associated with this schedule.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object434"}}},"x-examples":[{"resource":"Predictions","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/predictions/:id/schedules","description":"show prediction schedule","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/predictions/2156/schedules","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer IfxYd3UXTG1GzkovGbU9tV0B5sB4zqEwfOv-o33pKw4","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 2156,\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n },\n \"scoreOnModelBuild\": false\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"64074594ca3da685820338a46607307f\"","X-Request-Id":"01d5fa24-79a4-4620-b471-13b6a73f234f","X-Runtime":"0.028659","Content-Length":"182"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/predictions/2156/schedules\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer IfxYd3UXTG1GzkovGbU9tV0B5sB4zqEwfOv-o33pKw4\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/projects/":{"get":{"summary":"List projects","description":null,"deprecated":false,"parameters":[{"name":"permission","in":"query","required":false,"description":"A permissions string, one of \"read\", \"write\", or \"manage\". Lists only projects for which the current user has that permission.","type":"string"},{"name":"auto_share","in":"query","required":false,"description":"Used to filter projects based on whether the project is autoshare enabled or not.","type":"boolean"},{"name":"author","in":"query","required":false,"description":"If specified, return items from any of these authors. It accepts a comma-separated list of user IDs.","type":"string"},{"name":"hidden","in":"query","required":false,"description":"If specified to be true, returns hidden items. Defaults to false, returning non-hidden items.","type":"boolean"},{"name":"archived","in":"query","required":false,"description":"The archival status of the requested item(s).","type":"string"},{"name":"limit","in":"query","required":false,"description":"Number of results to return. Defaults to 20. Maximum allowed is 1000.","type":"integer"},{"name":"page_num","in":"query","required":false,"description":"Page number of the results to return. Defaults to the first page, 1.","type":"integer"},{"name":"order","in":"query","required":false,"description":"The field on which to order the result set. Defaults to updated_at. Must be one of: updated_at, name, created_at.","type":"string"},{"name":"order_dir","in":"query","required":false,"description":"Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc.","type":"string"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object85"}}}},"x-examples":[{"resource":"Projects","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/projects","description":"Lists projects","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/projects","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer cLKTrThHf-BYgKmV0dM8zCuMm9k5zDuA_xyK0o6wvZc","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 5,\n \"author\": {\n \"id\": 227,\n \"name\": \"User devuserfactory133 133\",\n \"username\": \"devuserfactory133\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"name\": \"Test Project\",\n \"description\": null,\n \"users\": [\n {\n \"id\": 227,\n \"name\": \"User devuserfactory133 133\",\n \"username\": \"devuserfactory133\",\n \"initials\": \"UD\",\n \"online\": null\n }\n ],\n \"autoShare\": false,\n \"createdAt\": \"2025-02-26T17:48:58.000Z\",\n \"updatedAt\": \"2025-02-26T19:48:58.000Z\",\n \"archived\": false\n },\n {\n \"id\": 2,\n \"author\": {\n \"id\": 194,\n \"name\": \"User devuserfactory109 109\",\n \"username\": \"devuserfactory109\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"name\": \"Test Project\",\n \"description\": null,\n \"users\": [\n {\n \"id\": 194,\n \"name\": \"User devuserfactory109 109\",\n \"username\": \"devuserfactory109\",\n \"initials\": \"UD\",\n \"online\": null\n }\n ],\n \"autoShare\": false,\n \"createdAt\": \"2025-02-26T17:48:54.000Z\",\n \"updatedAt\": \"2025-02-26T18:48:57.000Z\",\n \"archived\": false\n },\n {\n \"id\": 3,\n \"author\": {\n \"id\": 194,\n \"name\": \"User devuserfactory109 109\",\n \"username\": \"devuserfactory109\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"name\": \"Test Project\",\n \"description\": null,\n \"users\": [\n {\n \"id\": 194,\n \"name\": \"User devuserfactory109 109\",\n \"username\": \"devuserfactory109\",\n \"initials\": \"UD\",\n \"online\": null\n }\n ],\n \"autoShare\": false,\n \"createdAt\": \"2025-02-26T17:48:57.000Z\",\n \"updatedAt\": \"2025-02-26T17:48:57.000Z\",\n \"archived\": false\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","X-Pagination-Per-Page":"20","Access-Control-Expose-Headers":"X-Pagination-Per-Page, X-Pagination-Current-Page, X-Pagination-Total-Pages, X-Pagination-Total-Entries","X-Pagination-Current-Page":"1","X-Pagination-Total-Pages":"1","X-Pagination-Total-Entries":"3","Content-Type":"application/json; charset=utf-8","ETag":"W/\"93f866947d760576266693079fdbe0e0\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"156fd807-0ffb-4997-b160-dc4e16d6ffbb","X-Runtime":"0.041020","Content-Length":"1195"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/projects\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer cLKTrThHf-BYgKmV0dM8zCuMm9k5zDuA_xyK0o6wvZc\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Projects","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/projects","description":"Filter projects by author","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/projects?author=261","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer yC7LCnL9x953gPrKMNTbaNbDEoajOTL4Qh2tcKfEhXM","Host":"api.civis.test","Cookie":""},"request_query_parameters":{"author":"261"},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 9,\n \"author\": {\n \"id\": 261,\n \"name\": \"User devuserfactory158 158\",\n \"username\": \"devuserfactory158\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"name\": \"Test Project\",\n \"description\": null,\n \"users\": [\n {\n \"id\": 261,\n \"name\": \"User devuserfactory158 158\",\n \"username\": \"devuserfactory158\",\n \"initials\": \"UD\",\n \"online\": null\n }\n ],\n \"autoShare\": false,\n \"createdAt\": \"2025-02-26T17:49:05.000Z\",\n \"updatedAt\": \"2025-02-26T19:49:05.000Z\",\n \"archived\": false\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","X-Pagination-Per-Page":"20","Access-Control-Expose-Headers":"X-Pagination-Per-Page, X-Pagination-Current-Page, X-Pagination-Total-Pages, X-Pagination-Total-Entries","X-Pagination-Current-Page":"1","X-Pagination-Total-Pages":"1","X-Pagination-Total-Entries":"1","Content-Type":"application/json; charset=utf-8","ETag":"W/\"c434f8a1d79ebe1b6c76051c7127696c\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"d78ee7cc-250d-47ae-8dd7-8d64bc1d75f6","X-Runtime":"0.048909","Content-Length":"399"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/projects?author=261\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer yC7LCnL9x953gPrKMNTbaNbDEoajOTL4Qh2tcKfEhXM\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Projects","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/projects","description":"Filter projects by multiple authors","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/projects?author=295%2C262","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer bgbdBUpsJGf1urHDcSnsESpMMzYQXEdC-_7WICnslJw","Host":"api.civis.test","Cookie":""},"request_query_parameters":{"author":"295,262"},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 13,\n \"author\": {\n \"id\": 295,\n \"name\": \"User devuserfactory183 183\",\n \"username\": \"devuserfactory183\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"name\": \"Test Project\",\n \"description\": null,\n \"users\": [\n {\n \"id\": 295,\n \"name\": \"User devuserfactory183 183\",\n \"username\": \"devuserfactory183\",\n \"initials\": \"UD\",\n \"online\": null\n }\n ],\n \"autoShare\": false,\n \"createdAt\": \"2025-02-26T17:49:15.000Z\",\n \"updatedAt\": \"2025-02-26T19:49:15.000Z\",\n \"archived\": false\n },\n {\n \"id\": 10,\n \"author\": {\n \"id\": 262,\n \"name\": \"User devuserfactory159 159\",\n \"username\": \"devuserfactory159\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"name\": \"Test Project\",\n \"description\": null,\n \"users\": [\n {\n \"id\": 262,\n \"name\": \"User devuserfactory159 159\",\n \"username\": \"devuserfactory159\",\n \"initials\": \"UD\",\n \"online\": null\n }\n ],\n \"autoShare\": false,\n \"createdAt\": \"2025-02-26T17:49:10.000Z\",\n \"updatedAt\": \"2025-02-26T18:49:14.000Z\",\n \"archived\": false\n },\n {\n \"id\": 11,\n \"author\": {\n \"id\": 262,\n \"name\": \"User devuserfactory159 159\",\n \"username\": \"devuserfactory159\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"name\": \"Test Project\",\n \"description\": null,\n \"users\": [\n {\n \"id\": 262,\n \"name\": \"User devuserfactory159 159\",\n \"username\": \"devuserfactory159\",\n \"initials\": \"UD\",\n \"online\": null\n }\n ],\n \"autoShare\": false,\n \"createdAt\": \"2025-02-26T17:49:14.000Z\",\n \"updatedAt\": \"2025-02-26T17:49:14.000Z\",\n \"archived\": false\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","X-Pagination-Per-Page":"20","Access-Control-Expose-Headers":"X-Pagination-Per-Page, X-Pagination-Current-Page, X-Pagination-Total-Pages, X-Pagination-Total-Entries","X-Pagination-Current-Page":"1","X-Pagination-Total-Pages":"1","X-Pagination-Total-Entries":"3","Content-Type":"application/json; charset=utf-8","ETag":"W/\"c1801d07e501bffa66c394fea2902ace\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"d7974d08-4659-4350-9709-4af42e9f436d","X-Runtime":"0.057537","Content-Length":"1198"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/projects?author=295%2C262\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer bgbdBUpsJGf1urHDcSnsESpMMzYQXEdC-_7WICnslJw\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Projects","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/projects","description":"Filter projects by permission","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/projects?permission=write","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer AGFs6g7I81GlWOYPTcupi--VK9c49O9nt98T_kaFjkE","Host":"api.civis.test","Cookie":""},"request_query_parameters":{"permission":"write"},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 14,\n \"author\": {\n \"id\": 296,\n \"name\": \"User devuserfactory184 184\",\n \"username\": \"devuserfactory184\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"name\": \"Test Project\",\n \"description\": null,\n \"users\": [\n {\n \"id\": 296,\n \"name\": \"User devuserfactory184 184\",\n \"username\": \"devuserfactory184\",\n \"initials\": \"UD\",\n \"online\": null\n }\n ],\n \"autoShare\": false,\n \"createdAt\": \"2025-02-26T17:49:19.000Z\",\n \"updatedAt\": \"2025-02-26T18:49:21.000Z\",\n \"archived\": false\n },\n {\n \"id\": 15,\n \"author\": {\n \"id\": 296,\n \"name\": \"User devuserfactory184 184\",\n \"username\": \"devuserfactory184\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"name\": \"Test Project\",\n \"description\": null,\n \"users\": [\n {\n \"id\": 296,\n \"name\": \"User devuserfactory184 184\",\n \"username\": \"devuserfactory184\",\n \"initials\": \"UD\",\n \"online\": null\n }\n ],\n \"autoShare\": false,\n \"createdAt\": \"2025-02-26T17:49:21.000Z\",\n \"updatedAt\": \"2025-02-26T17:49:21.000Z\",\n \"archived\": false\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","X-Pagination-Per-Page":"20","Access-Control-Expose-Headers":"X-Pagination-Per-Page, X-Pagination-Current-Page, X-Pagination-Total-Pages, X-Pagination-Total-Entries","X-Pagination-Current-Page":"1","X-Pagination-Total-Pages":"1","X-Pagination-Total-Entries":"2","Content-Type":"application/json; charset=utf-8","ETag":"W/\"482c29591dc62ac310d661933f25859f\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"a434a3fe-ab28-496d-8bf7-1010a208c85a","X-Runtime":"0.036522","Content-Length":"799"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/projects?permission=write\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer AGFs6g7I81GlWOYPTcupi--VK9c49O9nt98T_kaFjkE\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"post":{"summary":"Create a project","description":null,"deprecated":false,"parameters":[{"name":"Object435","in":"body","schema":{"$ref":"#/definitions/Object435"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object436"}}},"x-examples":[{"resource":"Projects","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/projects","description":"Create a project","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/projects","request_body":"{\n \"name\": \"NewProject\",\n \"description\": \"NewDescription\",\n \"note\": \"NewNote\"\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer ptgdEphAqWGg9lhoGo_shsNjbA1CuCIgO7CAeKX4_IA","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 25,\n \"author\": {\n \"id\": 384,\n \"name\": \"User devuserfactory250 250\",\n \"username\": \"devuserfactory250\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"name\": \"NewProject\",\n \"description\": \"NewDescription\",\n \"users\": [\n {\n \"id\": 384,\n \"name\": \"User devuserfactory250 250\",\n \"username\": \"devuserfactory250\",\n \"initials\": \"UD\",\n \"online\": null\n }\n ],\n \"autoShare\": false,\n \"createdAt\": \"2025-02-26T17:49:35.000Z\",\n \"updatedAt\": \"2025-02-26T17:49:35.000Z\",\n \"tables\": [\n\n ],\n \"surveys\": [\n\n ],\n \"scripts\": [\n\n ],\n \"imports\": [\n\n ],\n \"exports\": [\n\n ],\n \"models\": [\n\n ],\n \"notebooks\": [\n\n ],\n \"services\": [\n\n ],\n \"workflows\": [\n\n ],\n \"reports\": [\n\n ],\n \"scriptTemplates\": [\n\n ],\n \"files\": [\n\n ],\n \"enhancements\": [\n\n ],\n \"projects\": [\n\n ],\n \"allObjects\": [\n\n ],\n \"note\": \"NewNote\",\n \"canCurrentUserEnableAutoShare\": true,\n \"hidden\": false,\n \"archived\": false,\n \"parentProject\": null,\n \"myPermissionLevel\": \"manage\"\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"0c2326ee5ffa74d704dfeddde2ec7467\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"e4acaafa-042e-4fc0-9bc1-4a07e8ac4bbd","X-Runtime":"0.109475","Content-Length":"740"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/projects\" -d '{\"name\":\"NewProject\",\"description\":\"NewDescription\",\"note\":\"NewNote\"}' -X POST \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer ptgdEphAqWGg9lhoGo_shsNjbA1CuCIgO7CAeKX4_IA\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/projects/{id}/clone":{"post":{"summary":"Clone this ","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID for this project.","type":"integer"},{"name":"Object453","in":"body","schema":{"$ref":"#/definitions/Object453"},"required":false}],"responses":{"201":{"description":"success","schema":{"$ref":"#/definitions/Object436"}}},"x-examples":null,"x-deprecation-warning":null}},"/projects/{project_id}":{"get":{"summary":"Get a detailed view of a project and the objects in it","description":null,"deprecated":false,"parameters":[{"name":"project_id","in":"path","required":true,"type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object436"}}},"x-examples":[{"resource":"Projects","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/projects/:project_id","description":"View a project","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/projects/17","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer lwQL5X9lhKIb6WuzAOL-SJtcGfNumFu-8_clAIfeeWU","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 17,\n \"author\": {\n \"id\": 329,\n \"name\": \"User devuserfactory208 208\",\n \"username\": \"devuserfactory208\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"name\": \"Test Project\",\n \"description\": null,\n \"users\": [\n {\n \"id\": 329,\n \"name\": \"User devuserfactory208 208\",\n \"username\": \"devuserfactory208\",\n \"initials\": \"UD\",\n \"online\": null\n }\n ],\n \"autoShare\": false,\n \"createdAt\": \"2025-02-26T17:49:24.000Z\",\n \"updatedAt\": \"2025-02-26T18:49:27.000Z\",\n \"tables\": [\n {\n \"schema\": \"schema_name\",\n \"name\": \"table_name49\",\n \"rowCount\": 1,\n \"columnCount\": 1,\n \"createdAt\": \"2025-02-26T17:49:24.000Z\",\n \"updatedAt\": \"2025-02-26T17:49:24.000Z\"\n }\n ],\n \"surveys\": [\n\n ],\n \"scripts\": [\n {\n \"id\": 191,\n \"createdAt\": \"2025-02-26T17:49:22.000Z\",\n \"updatedAt\": \"2025-02-26T17:49:22.000Z\",\n \"name\": \"Script #191\",\n \"type\": \"JobTypes::SqlRunner\",\n \"finishedAt\": \"2025-02-26T17:49:22.000Z\",\n \"state\": \"running\",\n \"lastRun\": {\n \"state\": \"running\",\n \"updatedAt\": \"2025-02-26T17:49:22.000Z\"\n }\n }\n ],\n \"imports\": [\n {\n \"id\": 202,\n \"createdAt\": \"2025-02-26T17:49:25.000Z\",\n \"updatedAt\": \"2025-02-26T17:49:25.000Z\",\n \"name\": \"Import #202\",\n \"type\": \"JobTypes::Import\",\n \"finishedAt\": null,\n \"state\": \"idle\",\n \"lastRun\": null\n }\n ],\n \"exports\": [\n {\n \"id\": 206,\n \"createdAt\": \"2025-02-26T17:49:25.000Z\",\n \"updatedAt\": \"2025-02-26T17:49:25.000Z\",\n \"name\": \"Export #206\",\n \"type\": \"JobTypes::Import\",\n \"finishedAt\": null,\n \"state\": \"running\",\n \"lastRun\": {\n \"state\": \"running\",\n \"updatedAt\": \"2025-02-26T17:49:25.000Z\"\n }\n }\n ],\n \"models\": [\n {\n \"id\": 198,\n \"createdAt\": \"2025-02-26T17:49:24.000Z\",\n \"updatedAt\": \"2025-02-26T17:49:24.000Z\",\n \"name\": \"Model #198\",\n \"state\": \"idle\"\n }\n ],\n \"notebooks\": [\n {\n \"id\": 9,\n \"createdAt\": \"2025-02-26T17:49:26.000Z\",\n \"updatedAt\": \"2025-02-26T17:49:26.000Z\",\n \"name\": \"Test Notebook\",\n \"currentDeploymentId\": null,\n \"lastDeploy\": null\n },\n {\n \"id\": 10,\n \"createdAt\": \"2025-02-26T17:49:26.000Z\",\n \"updatedAt\": \"2025-02-26T17:49:26.000Z\",\n \"name\": \"Test Notebook\",\n \"currentDeploymentId\": 9,\n \"lastDeploy\": {\n \"state\": \"running\",\n \"updatedAt\": \"2025-02-26T17:49:27.000Z\"\n }\n }\n ],\n \"services\": [\n {\n \"id\": 9,\n \"createdAt\": \"2025-02-26T17:49:26.000Z\",\n \"updatedAt\": \"2025-02-26T17:49:26.000Z\",\n \"name\": \"Service #9\",\n \"currentDeploymentId\": null,\n \"lastDeploy\": null\n },\n {\n \"id\": 10,\n \"createdAt\": \"2025-02-26T17:49:27.000Z\",\n \"updatedAt\": \"2025-02-26T17:49:27.000Z\",\n \"name\": \"Service #10\",\n \"currentDeploymentId\": null,\n \"lastDeploy\": {\n \"state\": \"terminated\",\n \"updatedAt\": \"2025-02-26T17:49:27.000Z\"\n }\n }\n ],\n \"workflows\": [\n {\n \"id\": 6,\n \"createdAt\": \"2025-02-26T17:49:26.000Z\",\n \"updatedAt\": \"2025-02-26T17:49:26.000Z\",\n \"name\": \"Test Workflow\",\n \"state\": \"idle\",\n \"lastExecution\": null\n }\n ],\n \"reports\": [\n {\n \"id\": 15,\n \"createdAt\": \"2025-02-26T17:49:23.000Z\",\n \"updatedAt\": \"2025-02-26T17:49:23.000Z\",\n \"name\": \"Project report\",\n \"state\": \"idle\"\n }\n ],\n \"scriptTemplates\": [\n {\n \"id\": 5,\n \"createdAt\": \"2025-02-26T17:49:26.000Z\",\n \"updatedAt\": \"2025-02-26T17:49:26.000Z\",\n \"name\": \"awesome sql template\"\n }\n ],\n \"files\": [\n {\n \"id\": 56,\n \"createdAt\": \"2025-02-26T17:49:26.000Z\",\n \"updatedAt\": \"2025-02-26T17:49:26.000Z\",\n \"fileName\": \"fake_name\",\n \"fileSize\": 1,\n \"expired\": null\n }\n ],\n \"enhancements\": [\n {\n \"id\": 211,\n \"createdAt\": \"2025-02-26T17:49:26.000Z\",\n \"updatedAt\": \"2025-02-26T17:49:26.000Z\",\n \"name\": \"CASS/NCOA #211\",\n \"lastRun\": null\n }\n ],\n \"projects\": [\n {\n \"id\": 18,\n \"createdAt\": \"2025-02-26T17:49:27.000Z\",\n \"updatedAt\": \"2025-02-26T17:49:27.000Z\",\n \"name\": \"Test Project\",\n \"description\": null\n }\n ],\n \"allObjects\": [\n {\n \"projectId\": 17,\n \"objectId\": 191,\n \"objectType\": \"JobTypes::SqlRunner\",\n \"fcoType\": \"scripts/sql\",\n \"subType\": null,\n \"name\": \"Script #191\",\n \"icon\": \"civicon-scripts\",\n \"author\": \"Admin devadminfactory117 117\",\n \"updatedAt\": \"2025-02-26T17:49:22.000Z\",\n \"autoShare\": null,\n \"archived\": false,\n \"hidden\": true,\n \"myPermissionLevel\": \"write\"\n },\n {\n \"projectId\": 17,\n \"objectId\": 202,\n \"objectType\": \"JobTypes::Import\",\n \"fcoType\": \"imports\",\n \"subType\": null,\n \"name\": \"Import #202\",\n \"icon\": \"civicon-imports\",\n \"author\": \"User devuserfactory208 208\",\n \"updatedAt\": \"2025-02-26T17:49:25.000Z\",\n \"autoShare\": null,\n \"archived\": false,\n \"hidden\": false,\n \"myPermissionLevel\": \"manage\"\n },\n {\n \"projectId\": 17,\n \"objectId\": 206,\n \"objectType\": \"JobTypes::Import\",\n \"fcoType\": \"exports\",\n \"subType\": null,\n \"name\": \"Export #206\",\n \"icon\": \"civicon-exports\",\n \"author\": \"User devuserfactory208 208\",\n \"updatedAt\": \"2025-02-26T17:49:25.000Z\",\n \"autoShare\": null,\n \"archived\": false,\n \"hidden\": false,\n \"myPermissionLevel\": \"manage\"\n },\n {\n \"projectId\": 17,\n \"objectId\": 198,\n \"objectType\": \"JobTypes::BuildModel\",\n \"fcoType\": \"models\",\n \"subType\": null,\n \"name\": \"Model #198\",\n \"icon\": \"civicon-modeling\",\n \"author\": \"Admin devadminfactory121 121\",\n \"updatedAt\": \"2025-02-26T17:49:24.000Z\",\n \"autoShare\": null,\n \"archived\": false,\n \"hidden\": false,\n \"myPermissionLevel\": \"write\"\n },\n {\n \"projectId\": 17,\n \"objectId\": 9,\n \"objectType\": \"Notebook\",\n \"fcoType\": \"notebooks\",\n \"subType\": null,\n \"name\": \"Test Notebook\",\n \"icon\": \"civicon-book\",\n \"author\": \"User devuserfactory208 208\",\n \"updatedAt\": \"2025-02-26T17:49:26.000Z\",\n \"autoShare\": null,\n \"archived\": false,\n \"hidden\": false,\n \"myPermissionLevel\": \"manage\"\n },\n {\n \"projectId\": 17,\n \"objectId\": 10,\n \"objectType\": \"Notebook\",\n \"fcoType\": \"notebooks\",\n \"subType\": null,\n \"name\": \"Test Notebook\",\n \"icon\": \"civicon-book\",\n \"author\": \"User devuserfactory208 208\",\n \"updatedAt\": \"2025-02-26T17:49:26.000Z\",\n \"autoShare\": null,\n \"archived\": false,\n \"hidden\": false,\n \"myPermissionLevel\": \"manage\"\n },\n {\n \"projectId\": 17,\n \"objectId\": 6,\n \"objectType\": \"Workflow::Workflow\",\n \"fcoType\": \"workflows\",\n \"subType\": null,\n \"name\": \"Test Workflow\",\n \"icon\": \"civicon-workflows\",\n \"author\": \"User devuserfactory208 208\",\n \"updatedAt\": \"2025-02-26T17:49:26.000Z\",\n \"autoShare\": null,\n \"archived\": false,\n \"hidden\": false,\n \"myPermissionLevel\": \"manage\"\n },\n {\n \"projectId\": 17,\n \"objectId\": 15,\n \"objectType\": \"ReportTypes::Html\",\n \"fcoType\": \"reports\",\n \"subType\": null,\n \"name\": \"Project report\",\n \"icon\": \"civicon-reports\",\n \"author\": \"User devuserfactory212 212\",\n \"updatedAt\": \"2025-02-26T17:49:23.000Z\",\n \"autoShare\": null,\n \"archived\": false,\n \"hidden\": false,\n \"myPermissionLevel\": \"write\"\n },\n {\n \"projectId\": 17,\n \"objectId\": 50,\n \"objectType\": \"Database::Table\",\n \"fcoType\": \"tables\",\n \"subType\": null,\n \"name\": \"table_name49\",\n \"icon\": \"civicon-table\",\n \"author\": \"dbadmin\",\n \"updatedAt\": \"2025-02-26T17:49:24.000Z\",\n \"autoShare\": null,\n \"archived\": false,\n \"hidden\": false,\n \"myPermissionLevel\": null\n },\n {\n \"projectId\": 17,\n \"objectId\": 5,\n \"objectType\": \"Template::Script\",\n \"fcoType\": \"script_templates\",\n \"subType\": null,\n \"name\": \"awesome sql template\",\n \"icon\": \"civicon-scripts\",\n \"author\": \"User devuserfactory223 223\",\n \"updatedAt\": \"2025-02-26T17:49:26.000Z\",\n \"autoShare\": null,\n \"archived\": false,\n \"hidden\": false,\n \"myPermissionLevel\": \"read\"\n },\n {\n \"projectId\": 17,\n \"objectId\": 211,\n \"objectType\": \"JobTypes::CassNcoa\",\n \"fcoType\": \"enhancements\",\n \"subType\": null,\n \"name\": \"CASS/NCOA #211\",\n \"icon\": \"civicon-enhancements\",\n \"author\": \"User devuserfactory208 208\",\n \"updatedAt\": \"2025-02-26T17:49:26.000Z\",\n \"autoShare\": null,\n \"archived\": false,\n \"hidden\": false,\n \"myPermissionLevel\": \"manage\"\n },\n {\n \"projectId\": 17,\n \"objectId\": 56,\n \"objectType\": \"S3File\",\n \"fcoType\": \"files\",\n \"subType\": null,\n \"name\": \"fake_name\",\n \"icon\": \"civicon-csv\",\n \"author\": \"User devuserfactory208 208\",\n \"updatedAt\": \"2025-02-26T17:49:26.000Z\",\n \"autoShare\": null,\n \"archived\": false,\n \"hidden\": false,\n \"myPermissionLevel\": \"manage\"\n },\n {\n \"projectId\": 17,\n \"objectId\": 9,\n \"objectType\": \"ServiceTypes::App\",\n \"fcoType\": \"services\",\n \"subType\": null,\n \"name\": \"Service #9\",\n \"icon\": \"civicon-dashboard\",\n \"author\": \"User devuserfactory208 208\",\n \"updatedAt\": \"2025-02-26T17:49:26.000Z\",\n \"autoShare\": null,\n \"archived\": false,\n \"hidden\": false,\n \"myPermissionLevel\": \"manage\"\n },\n {\n \"projectId\": 17,\n \"objectId\": 10,\n \"objectType\": \"ServiceTypes::App\",\n \"fcoType\": \"services\",\n \"subType\": null,\n \"name\": \"Service #10\",\n \"icon\": \"civicon-dashboard\",\n \"author\": \"User devuserfactory208 208\",\n \"updatedAt\": \"2025-02-26T17:49:27.000Z\",\n \"autoShare\": null,\n \"archived\": false,\n \"hidden\": false,\n \"myPermissionLevel\": \"manage\"\n },\n {\n \"projectId\": 17,\n \"objectId\": 18,\n \"objectType\": \"Project\",\n \"fcoType\": \"projects\",\n \"subType\": null,\n \"name\": \"Test Project\",\n \"icon\": \"civicon-MuiDriveFolderUploadIcon\",\n \"author\": \"User devuserfactory208 208\",\n \"updatedAt\": \"2025-02-26T17:49:27.000Z\",\n \"autoShare\": false,\n \"archived\": false,\n \"hidden\": false,\n \"myPermissionLevel\": \"manage\"\n }\n ],\n \"note\": null,\n \"canCurrentUserEnableAutoShare\": false,\n \"hidden\": false,\n \"archived\": false,\n \"parentProject\": null,\n \"myPermissionLevel\": \"manage\"\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"66b7c86dd03f2dac0949d89c5aa159e8\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"e50aef83-7208-4dcc-b7a1-8431f4b4c1da","X-Runtime":"0.242145","Content-Length":"7691"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/projects/17\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer lwQL5X9lhKIb6WuzAOL-SJtcGfNumFu-8_clAIfeeWU\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"put":{"summary":"Update a project","description":null,"deprecated":false,"parameters":[{"name":"project_id","in":"path","required":true,"type":"integer"},{"name":"Object454","in":"body","schema":{"$ref":"#/definitions/Object454"},"required":false}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object436"}}},"x-examples":[{"resource":"Projects","resource_explanation":null,"http_method":"PUT","route":"http://api.civis.test/projects/:project_id","description":"Update a project","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"PUT","request_path":"http://api.civis.test/projects/26","request_body":"{\n \"name\": \"newname\",\n \"description\": \"super_cool_description\"\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer icTZKdDSCZ-WLhUxbDlSnPv34Es6HBlagWDGLXwCBME","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 26,\n \"author\": {\n \"id\": 417,\n \"name\": \"User devuserfactory274 274\",\n \"username\": \"devuserfactory274\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"name\": \"newname\",\n \"description\": \"super_cool_description\",\n \"users\": [\n {\n \"id\": 417,\n \"name\": \"User devuserfactory274 274\",\n \"username\": \"devuserfactory274\",\n \"initials\": \"UD\",\n \"online\": null\n }\n ],\n \"autoShare\": false,\n \"createdAt\": \"2025-02-26T17:49:37.000Z\",\n \"updatedAt\": \"2025-02-26T17:49:41.000Z\",\n \"tables\": [\n {\n \"schema\": \"schema_name\",\n \"name\": \"table_name55\",\n \"rowCount\": 1,\n \"columnCount\": 1,\n \"createdAt\": \"2025-02-26T17:49:38.000Z\",\n \"updatedAt\": \"2025-02-26T17:49:38.000Z\"\n }\n ],\n \"surveys\": [\n\n ],\n \"scripts\": [\n {\n \"id\": 243,\n \"createdAt\": \"2025-02-26T17:49:36.000Z\",\n \"updatedAt\": \"2025-02-26T17:49:36.000Z\",\n \"name\": \"Script #243\",\n \"type\": \"JobTypes::SqlRunner\",\n \"finishedAt\": \"2025-02-26T17:49:36.000Z\",\n \"state\": \"running\",\n \"lastRun\": {\n \"state\": \"running\",\n \"updatedAt\": \"2025-02-26T17:49:36.000Z\"\n }\n }\n ],\n \"imports\": [\n {\n \"id\": 254,\n \"createdAt\": \"2025-02-26T17:49:38.000Z\",\n \"updatedAt\": \"2025-02-26T17:49:38.000Z\",\n \"name\": \"Import #254\",\n \"type\": \"JobTypes::Import\",\n \"finishedAt\": null,\n \"state\": \"idle\",\n \"lastRun\": null\n }\n ],\n \"exports\": [\n {\n \"id\": 258,\n \"createdAt\": \"2025-02-26T17:49:39.000Z\",\n \"updatedAt\": \"2025-02-26T17:49:39.000Z\",\n \"name\": \"Export #258\",\n \"type\": \"JobTypes::Import\",\n \"finishedAt\": null,\n \"state\": \"running\",\n \"lastRun\": {\n \"state\": \"running\",\n \"updatedAt\": \"2025-02-26T17:49:39.000Z\"\n }\n }\n ],\n \"models\": [\n {\n \"id\": 250,\n \"createdAt\": \"2025-02-26T17:49:38.000Z\",\n \"updatedAt\": \"2025-02-26T17:49:38.000Z\",\n \"name\": \"Model #250\",\n \"state\": \"idle\"\n }\n ],\n \"notebooks\": [\n {\n \"id\": 14,\n \"createdAt\": \"2025-02-26T17:49:40.000Z\",\n \"updatedAt\": \"2025-02-26T17:49:40.000Z\",\n \"name\": \"Test Notebook\",\n \"currentDeploymentId\": null,\n \"lastDeploy\": null\n },\n {\n \"id\": 15,\n \"createdAt\": \"2025-02-26T17:49:40.000Z\",\n \"updatedAt\": \"2025-02-26T17:49:40.000Z\",\n \"name\": \"Test Notebook\",\n \"currentDeploymentId\": 15,\n \"lastDeploy\": {\n \"state\": \"running\",\n \"updatedAt\": \"2025-02-26T17:49:40.000Z\"\n }\n }\n ],\n \"services\": [\n {\n \"id\": 14,\n \"createdAt\": \"2025-02-26T17:49:40.000Z\",\n \"updatedAt\": \"2025-02-26T17:49:40.000Z\",\n \"name\": \"Service #14\",\n \"currentDeploymentId\": null,\n \"lastDeploy\": null\n },\n {\n \"id\": 15,\n \"createdAt\": \"2025-02-26T17:49:40.000Z\",\n \"updatedAt\": \"2025-02-26T17:49:40.000Z\",\n \"name\": \"Service #15\",\n \"currentDeploymentId\": null,\n \"lastDeploy\": {\n \"state\": \"terminated\",\n \"updatedAt\": \"2025-02-26T17:49:41.000Z\"\n }\n }\n ],\n \"workflows\": [\n {\n \"id\": 8,\n \"createdAt\": \"2025-02-26T17:49:40.000Z\",\n \"updatedAt\": \"2025-02-26T17:49:40.000Z\",\n \"name\": \"Test Workflow\",\n \"state\": \"idle\",\n \"lastExecution\": null\n }\n ],\n \"reports\": [\n {\n \"id\": 24,\n \"createdAt\": \"2025-02-26T17:49:37.000Z\",\n \"updatedAt\": \"2025-02-26T17:49:37.000Z\",\n \"name\": \"Project report\",\n \"state\": \"idle\"\n },\n {\n \"id\": 26,\n \"createdAt\": \"2025-02-26T17:49:37.000Z\",\n \"updatedAt\": \"2025-02-26T17:49:37.000Z\",\n \"name\": \"test_report\",\n \"state\": \"idle\"\n }\n ],\n \"scriptTemplates\": [\n {\n \"id\": 7,\n \"createdAt\": \"2025-02-26T17:49:39.000Z\",\n \"updatedAt\": \"2025-02-26T17:49:39.000Z\",\n \"name\": \"awesome sql template\"\n }\n ],\n \"files\": [\n {\n \"id\": 84,\n \"createdAt\": \"2025-02-26T17:49:39.000Z\",\n \"updatedAt\": \"2025-02-26T17:49:39.000Z\",\n \"fileName\": \"fake_name\",\n \"fileSize\": 1,\n \"expired\": null\n }\n ],\n \"enhancements\": [\n {\n \"id\": 263,\n \"createdAt\": \"2025-02-26T17:49:40.000Z\",\n \"updatedAt\": \"2025-02-26T17:49:40.000Z\",\n \"name\": \"CASS/NCOA #263\",\n \"lastRun\": null\n }\n ],\n \"projects\": [\n {\n \"id\": 27,\n \"createdAt\": \"2025-02-26T17:49:40.000Z\",\n \"updatedAt\": \"2025-02-26T17:49:40.000Z\",\n \"name\": \"Test Project\",\n \"description\": null\n }\n ],\n \"allObjects\": [\n\n ],\n \"note\": null,\n \"canCurrentUserEnableAutoShare\": false,\n \"hidden\": false,\n \"archived\": false,\n \"parentProject\": null,\n \"myPermissionLevel\": \"manage\"\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"6e9fcb340fd531d3802c80744847243b\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"eb8b0755-3740-45b3-ba60-6888e883fb39","X-Runtime":"0.156674","Content-Length":"3336"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/projects/26\" -d '{\"name\":\"newname\",\"description\":\"super_cool_description\"}' -X PUT \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer icTZKdDSCZ-WLhUxbDlSnPv34Es6HBlagWDGLXwCBME\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"delete":{"summary":"Archive a project (deprecated, use the /archive endpoint instead)","description":null,"deprecated":false,"parameters":[{"name":"project_id","in":"path","required":true,"type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":[{"resource":"Projects","resource_explanation":null,"http_method":"DELETE","route":"http://api.civis.test/projects/:project_id","description":"Delete a project (deprecated, now archives the project)","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"DELETE","request_path":"http://api.civis.test/projects/20","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer BmVsOt4cEn9gd8bumHMqAjSoGl7qhowiz2Zas3yKsDo","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":204,"response_status_text":"No Content","response_body":null,"response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"6bd073fe-884f-4b2d-8ddd-dae914e14fbd","X-Runtime":"0.063440"},"response_content_type":null,"curl":"curl \"api.civis.testhttp://api.civis.test/projects/20\" -d '' -X DELETE \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer BmVsOt4cEn9gd8bumHMqAjSoGl7qhowiz2Zas3yKsDo\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/projects/{project_id}/auto_share":{"put":{"summary":"Enable or disable Auto-Share on a project","description":null,"deprecated":false,"parameters":[{"name":"project_id","in":"path","required":true,"type":"integer"},{"name":"Object455","in":"body","schema":{"$ref":"#/definitions/Object455"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object436"}}},"x-examples":null,"x-deprecation-warning":null}},"/projects/{id}/shares":{"get":{"summary":"List users and groups permissioned on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object9"}}}},"x-examples":null,"x-deprecation-warning":null}},"/projects/{id}/shares/users":{"put":{"summary":"Set the permissions users have on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"Object456","in":"body","schema":{"$ref":"#/definitions/Object456"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object9"}}},"x-examples":null,"x-deprecation-warning":null}},"/projects/{id}/shares/users/{user_id}":{"delete":{"summary":"Revoke the permissions a user has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"user_id","in":"path","required":true,"description":"The ID of the user.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/projects/{id}/shares/groups":{"put":{"summary":"Set the permissions groups has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"Object457","in":"body","schema":{"$ref":"#/definitions/Object457"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object9"}}},"x-examples":null,"x-deprecation-warning":null}},"/projects/{id}/shares/groups/{group_id}":{"delete":{"summary":"Revoke the permissions a group has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"group_id","in":"path","required":true,"description":"The ID of the group.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/projects/{id}/dependencies":{"get":{"summary":"List dependent objects for this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"user_id","in":"query","required":false,"description":"ID of target user","type":"integer"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object15"}}}},"x-examples":null,"x-deprecation-warning":null}},"/projects/{id}/transfer":{"put":{"summary":"Transfer ownership of this object to another user","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"Object458","in":"body","schema":{"$ref":"#/definitions/Object458"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object17"}}},"x-examples":null,"x-deprecation-warning":null}},"/projects/{id}/archive":{"put":{"summary":"Update the archive status of this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the object.","type":"integer"},{"name":"Object459","in":"body","schema":{"$ref":"#/definitions/Object459"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object436"}}},"x-examples":null,"x-deprecation-warning":null}},"/projects/{id}/parent_projects":{"get":{"summary":"List the Parent Projects an item belongs to","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the item.","type":"integer"},{"name":"hidden","in":"query","required":false,"description":"If specified to be true, returns hidden items. Defaults to false, returning non-hidden items.","type":"boolean"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object85"}}}},"x-examples":null,"x-deprecation-warning":null}},"/projects/{id}/parent_projects/{parent_project_id}":{"put":{"summary":"Add an item to a Parent Project","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the item.","type":"integer"},{"name":"parent_project_id","in":"path","required":true,"description":"The ID of the Parent Project.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null},"delete":{"summary":"Remove an item from a Parent Project","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the item.","type":"integer"},{"name":"parent_project_id","in":"path","required":true,"description":"The ID of the Parent Project.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/queries/":{"get":{"summary":"List queries","description":null,"deprecated":false,"parameters":[{"name":"query","in":"query","required":false,"description":"Space delimited query for searching queries by their SQL. Supports wild card characters \"?\" for any single character, and \"*\" for zero or more characters.","type":"string"},{"name":"database_id","in":"query","required":false,"description":"The database ID.","type":"integer"},{"name":"credential_id","in":"query","required":false,"description":"The credential ID.","type":"integer"},{"name":"author_id","in":"query","required":false,"description":"The author of the query.","type":"integer"},{"name":"created_before","in":"query","required":false,"description":"An upper bound for the creation date of the query.","type":"string","format":"date-time"},{"name":"created_after","in":"query","required":false,"description":"A lower bound for the creation date of the query.","type":"string","format":"date-time"},{"name":"started_before","in":"query","required":false,"description":"An upper bound for the start date of the last run.","type":"string","format":"date-time"},{"name":"started_after","in":"query","required":false,"description":"A lower bound for the start date of the last run.","type":"string","format":"date-time"},{"name":"state","in":"query","required":false,"description":"The state of the last run. One or more of queued, running, succeeded, failed, and cancelled. Specify multiple values as a comma-separated list (e.g., \"A,B\").","type":"array","items":{"type":"string"}},{"name":"exclude_results","in":"query","required":false,"description":"If true, does not return cached query results.","type":"boolean"},{"name":"hidden","in":"query","required":false,"description":"If specified to be true, returns hidden items. Defaults to false, returning non-hidden items.","type":"boolean"},{"name":"archived","in":"query","required":false,"description":"The archival status of the requested item(s).","type":"string"},{"name":"limit","in":"query","required":false,"description":"Number of results to return. Defaults to 20. Maximum allowed is 50.","type":"integer"},{"name":"page_num","in":"query","required":false,"description":"Page number of the results to return. Defaults to the first page, 1.","type":"integer"},{"name":"order","in":"query","required":false,"description":"The field on which to order the result set. Defaults to created_at. Must be one of: created_at, started_at.","type":"string"},{"name":"order_dir","in":"query","required":false,"description":"Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc.","type":"string"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object460"}}}},"x-examples":[{"resource":"Queries","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/queries","description":"List all queries","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/queries","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer NpofuSAXVl5sn5zxHUZF30MfUPLJFhxz9aZCg7hC3To","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 264,\n \"database\": 177,\n \"sql\": \"SELECT * FROM table LIMIT 10;\",\n \"credential\": 345,\n \"resultRows\": [\n\n ],\n \"resultColumns\": [\n\n ],\n \"error\": null,\n \"startedAt\": null,\n \"finishedAt\": null,\n \"state\": \"idle\",\n \"scriptId\": null,\n \"exception\": null,\n \"createdAt\": \"2025-02-26T17:49:41.000Z\",\n \"updatedAt\": \"2025-02-26T17:49:41.000Z\",\n \"lastRunId\": null,\n \"archived\": false,\n \"previewRows\": 3,\n \"reportId\": null\n },\n {\n \"id\": 265,\n \"database\": 179,\n \"sql\": \"SELECT * FROM table LIMIT 10;\",\n \"credential\": 347,\n \"resultRows\": [\n [\n 1,\n 2\n ],\n [\n 3,\n 4\n ]\n ],\n \"resultColumns\": [\n \"id\",\n \"value\"\n ],\n \"error\": null,\n \"startedAt\": null,\n \"finishedAt\": null,\n \"state\": \"idle\",\n \"scriptId\": null,\n \"exception\": null,\n \"createdAt\": \"2025-02-26T17:49:36.000Z\",\n \"updatedAt\": \"2025-02-26T17:49:41.000Z\",\n \"lastRunId\": null,\n \"archived\": false,\n \"previewRows\": 3,\n \"reportId\": null\n },\n {\n \"id\": 266,\n \"database\": 180,\n \"sql\": \"SELECT * FROM table LIMIT 10;\",\n \"credential\": 349,\n \"resultRows\": [\n\n ],\n \"resultColumns\": [\n\n ],\n \"error\": null,\n \"startedAt\": null,\n \"finishedAt\": null,\n \"state\": \"idle\",\n \"scriptId\": null,\n \"exception\": null,\n \"createdAt\": \"2025-02-26T17:49:26.000Z\",\n \"updatedAt\": \"2025-02-26T17:49:42.000Z\",\n \"lastRunId\": null,\n \"archived\": false,\n \"previewRows\": 3,\n \"reportId\": null\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","X-Pagination-Per-Page":"20","Access-Control-Expose-Headers":"X-Pagination-Per-Page, X-Pagination-Current-Page, X-Pagination-Total-Pages, X-Pagination-Total-Entries","X-Pagination-Current-Page":"1","X-Pagination-Total-Pages":"1","X-Pagination-Total-Entries":"3","Content-Type":"application/json; charset=utf-8","ETag":"W/\"f3ceb22091ff6dc66edfd1fcb338b388\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"9dae5a15-181c-4905-bbb7-00a1c22f3f68","X-Runtime":"0.053374","Content-Length":"1092"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/queries\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer NpofuSAXVl5sn5zxHUZF30MfUPLJFhxz9aZCg7hC3To\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Queries","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/queries","description":"Filter queries by database","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/queries?databaseId=183","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer oHK-Jn7I8Ub-3k6Ka8-a1sM42Z4aX7O611QHZAMmtI0","Host":"api.civis.test","Cookie":""},"request_query_parameters":{"databaseId":"183"},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 268,\n \"database\": 183,\n \"sql\": \"SELECT * FROM table LIMIT 10;\",\n \"credential\": 355,\n \"resultRows\": [\n [\n 1,\n 2\n ],\n [\n 3,\n 4\n ]\n ],\n \"resultColumns\": [\n \"id\",\n \"value\"\n ],\n \"error\": null,\n \"startedAt\": null,\n \"finishedAt\": null,\n \"state\": \"idle\",\n \"scriptId\": null,\n \"exception\": null,\n \"createdAt\": \"2025-02-26T17:49:37.000Z\",\n \"updatedAt\": \"2025-02-26T17:49:42.000Z\",\n \"lastRunId\": null,\n \"archived\": false,\n \"previewRows\": 3,\n \"reportId\": null\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","X-Pagination-Per-Page":"20","Access-Control-Expose-Headers":"X-Pagination-Per-Page, X-Pagination-Current-Page, X-Pagination-Total-Pages, X-Pagination-Total-Entries","X-Pagination-Current-Page":"1","X-Pagination-Total-Pages":"1","X-Pagination-Total-Entries":"1","Content-Type":"application/json; charset=utf-8","ETag":"W/\"35743446ad5362da947b1c0bbf28fb9a\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"995a41c9-25ac-4ca5-9577-ce6a0ac44795","X-Runtime":"0.045185","Content-Length":"380"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/queries?databaseId=183\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer oHK-Jn7I8Ub-3k6Ka8-a1sM42Z4aX7O611QHZAMmtI0\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Queries","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/queries","description":"Filter queries by author","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/queries?authorId=462","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer Hlt0myMagt1Xo9pvkC4ZPESq8yVArJsQieilI3B0eVI","Host":"api.civis.test","Cookie":""},"request_query_parameters":{"authorId":"462"},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 270,\n \"database\": 186,\n \"sql\": \"SELECT * FROM table LIMIT 10;\",\n \"credential\": 361,\n \"resultRows\": [\n\n ],\n \"resultColumns\": [\n\n ],\n \"error\": null,\n \"startedAt\": null,\n \"finishedAt\": null,\n \"state\": \"idle\",\n \"scriptId\": null,\n \"exception\": null,\n \"createdAt\": \"2025-02-26T17:49:28.000Z\",\n \"updatedAt\": \"2025-02-26T17:49:43.000Z\",\n \"lastRunId\": null,\n \"archived\": false,\n \"previewRows\": 3,\n \"reportId\": null\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","X-Pagination-Per-Page":"20","Access-Control-Expose-Headers":"X-Pagination-Per-Page, X-Pagination-Current-Page, X-Pagination-Total-Pages, X-Pagination-Total-Entries","X-Pagination-Current-Page":"1","X-Pagination-Total-Pages":"1","X-Pagination-Total-Entries":"1","Content-Type":"application/json; charset=utf-8","ETag":"W/\"208f5b404523b41cfb80788944faa299\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"0ea81dae-528b-4110-a2f7-40dcffa18507","X-Runtime":"0.039853","Content-Length":"357"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/queries?authorId=462\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer Hlt0myMagt1Xo9pvkC4ZPESq8yVArJsQieilI3B0eVI\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Queries","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/queries","description":"Filter queries by creation date","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/queries?createdBefore=2025-02-26T17%3A49%3A43.000Z&createdAfter=2025-02-26T17%3A49%3A28.000Z","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer VWMfOjtbNLA9PUlix4G4nqZJV2iofHGh1K-eZvaW0LY","Host":"api.civis.test","Cookie":""},"request_query_parameters":{"createdBefore":"2025-02-26T17:49:43.000Z","createdAfter":"2025-02-26T17:49:28.000Z"},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 273,\n \"database\": 190,\n \"sql\": \"SELECT * FROM table LIMIT 10;\",\n \"credential\": 369,\n \"resultRows\": [\n [\n 1,\n 2\n ],\n [\n 3,\n 4\n ]\n ],\n \"resultColumns\": [\n \"id\",\n \"value\"\n ],\n \"error\": null,\n \"startedAt\": null,\n \"finishedAt\": null,\n \"state\": \"idle\",\n \"scriptId\": null,\n \"exception\": null,\n \"createdAt\": \"2025-02-26T17:49:38.000Z\",\n \"updatedAt\": \"2025-02-26T17:49:44.000Z\",\n \"lastRunId\": null,\n \"archived\": false,\n \"previewRows\": 3,\n \"reportId\": null\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","X-Pagination-Per-Page":"20","Access-Control-Expose-Headers":"X-Pagination-Per-Page, X-Pagination-Current-Page, X-Pagination-Total-Pages, X-Pagination-Total-Entries","X-Pagination-Current-Page":"1","X-Pagination-Total-Pages":"1","X-Pagination-Total-Entries":"1","Content-Type":"application/json; charset=utf-8","ETag":"W/\"c5a179834dfdaabeab6795731c8f1b6e\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"5b7c4276-73c4-4650-afb8-5a5df9b64013","X-Runtime":"0.041492","Content-Length":"380"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/queries?createdBefore=2025-02-26T17%3A49%3A43.000Z&createdAfter=2025-02-26T17%3A49%3A28.000Z\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer VWMfOjtbNLA9PUlix4G4nqZJV2iofHGh1K-eZvaW0LY\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Queries","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/queries","description":"Includes rows/cols from response normally","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/queries","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer H15SoLQ0Ox3zyRsi_hubSanSwJGHTztN2XEA3O7j9qg","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 274,\n \"database\": 192,\n \"sql\": \"SELECT * FROM table LIMIT 10;\",\n \"credential\": 372,\n \"resultRows\": [\n [\n 1,\n 2\n ],\n [\n 3,\n 4\n ]\n ],\n \"resultColumns\": [\n \"id\",\n \"value\"\n ],\n \"error\": null,\n \"startedAt\": null,\n \"finishedAt\": null,\n \"state\": \"idle\",\n \"scriptId\": null,\n \"exception\": null,\n \"createdAt\": \"2025-02-26T17:49:39.000Z\",\n \"updatedAt\": \"2025-02-26T17:49:44.000Z\",\n \"lastRunId\": null,\n \"archived\": false,\n \"previewRows\": 3,\n \"reportId\": null\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","X-Pagination-Per-Page":"20","Access-Control-Expose-Headers":"X-Pagination-Per-Page, X-Pagination-Current-Page, X-Pagination-Total-Pages, X-Pagination-Total-Entries","X-Pagination-Current-Page":"1","X-Pagination-Total-Pages":"1","X-Pagination-Total-Entries":"1","Content-Type":"application/json; charset=utf-8","ETag":"W/\"183303195534bc82fd119afa260f541c\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"5131fb3c-79bc-4710-929b-9926c84bedfa","X-Runtime":"0.039571","Content-Length":"380"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/queries\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer H15SoLQ0Ox3zyRsi_hubSanSwJGHTztN2XEA3O7j9qg\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Queries","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/queries","description":"Exclude rows/cols from response with excludeResults=true","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/queries?excludeResults=true","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer HaUkk6hj63obNDO6DOItYN_d4MOxGwHDLBzm_ux_c4k","Host":"api.civis.test","Cookie":""},"request_query_parameters":{"excludeResults":"true"},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 275,\n \"database\": 194,\n \"sql\": \"SELECT * FROM table LIMIT 10;\",\n \"credential\": 375,\n \"resultRows\": [\n\n ],\n \"resultColumns\": [\n\n ],\n \"error\": null,\n \"startedAt\": null,\n \"finishedAt\": null,\n \"state\": \"idle\",\n \"scriptId\": null,\n \"exception\": null,\n \"createdAt\": \"2025-02-26T17:49:40.000Z\",\n \"updatedAt\": \"2025-02-26T17:49:45.000Z\",\n \"lastRunId\": null,\n \"archived\": false,\n \"previewRows\": 3,\n \"reportId\": null\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","X-Pagination-Per-Page":"20","Access-Control-Expose-Headers":"X-Pagination-Per-Page, X-Pagination-Current-Page, X-Pagination-Total-Pages, X-Pagination-Total-Entries","X-Pagination-Current-Page":"1","X-Pagination-Total-Pages":"1","X-Pagination-Total-Entries":"1","Content-Type":"application/json; charset=utf-8","ETag":"W/\"384bca1d8e6755fdd6be9c06dba0f294\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"1f8e9b2a-99b6-45bb-b4da-9aa75a823455","X-Runtime":"0.063933","Content-Length":"357"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/queries?excludeResults=true\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer HaUkk6hj63obNDO6DOItYN_d4MOxGwHDLBzm_ux_c4k\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Queries","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/queries","description":"Lists searched queries","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/queries?query=LIMIT","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer YdE0zuCp3S7kfZqgBtpo1JCJ4TJmsQwasCU64m-1HRU","Host":"api.civis.test","Cookie":""},"request_query_parameters":{"query":"LIMIT"},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 276,\n \"database\": 195,\n \"sql\": \"SELECT * FROM table LIMIT 10;\",\n \"credential\": 379,\n \"resultRows\": [\n\n ],\n \"resultColumns\": [\n\n ],\n \"error\": null,\n \"startedAt\": \"2025-02-26T17:49:45.000Z\",\n \"finishedAt\": null,\n \"state\": \"succeeded\",\n \"scriptId\": null,\n \"exception\": null,\n \"createdAt\": \"2025-02-26T17:49:45.000Z\",\n \"updatedAt\": \"2025-02-26T17:49:45.000Z\",\n \"lastRunId\": 62,\n \"archived\": false,\n \"previewRows\": 3,\n \"reportId\": null\n },\n {\n \"id\": 277,\n \"database\": 197,\n \"sql\": \"SELECT * FROM table LIMIT 10;\",\n \"credential\": 381,\n \"resultRows\": [\n\n ],\n \"resultColumns\": [\n\n ],\n \"error\": null,\n \"startedAt\": \"2025-02-26T17:49:40.000Z\",\n \"finishedAt\": null,\n \"state\": \"cancelled\",\n \"scriptId\": null,\n \"exception\": null,\n \"createdAt\": \"2025-02-26T17:49:30.000Z\",\n \"updatedAt\": \"2025-02-26T17:49:46.000Z\",\n \"lastRunId\": 63,\n \"archived\": false,\n \"previewRows\": 3,\n \"reportId\": null\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","X-Pagination-Current-Page":"1","Access-Control-Expose-Headers":"X-Pagination-Current-Page, X-Pagination-Total-Entries, X-Pagination-Total-Pages, X-Pagination-Per-Page","X-Pagination-Total-Entries":"2","X-Pagination-Total-Pages":"1","X-Pagination-Per-Page":"20","Content-Type":"application/json; charset=utf-8","ETag":"W/\"9ebd67e1f98ae1a4908c11a009dd2332\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"d1f02b9e-869b-4527-bb21-c4d94bd27ad9","X-Runtime":"0.162709","Content-Length":"763"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/queries?query=LIMIT\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer YdE0zuCp3S7kfZqgBtpo1JCJ4TJmsQwasCU64m-1HRU\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"post":{"summary":"Execute a query","description":null,"deprecated":false,"parameters":[{"name":"Object462","in":"body","schema":{"$ref":"#/definitions/Object462"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object463"}}},"x-examples":[{"resource":"Queries","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/queries","description":"Submit a query","explanation":null,"parameters":[{"required":true,"name":"database","description":"The database ID."},{"required":true,"name":"sql","description":"The SQL to execute."},{"required":false,"name":"credential","description":"The credential ID."},{"required":false,"name":"hidden","description":"The hidden status of the item."},{"required":false,"name":"interactive","description":"Deprecated and not used."},{"required":true,"name":"previewRows","description":"The number of rows to save from the query's result (maximum: 1000)."},{"required":false,"name":"includeHeader","description":"Whether the CSV output should include a header row [default: true]."},{"required":false,"name":"compression","description":"The type of compression. One of gzip or zip, or none [default: gzip]."},{"required":false,"name":"columnDelimiter","description":"The delimiter to use. One of comma or tab, or pipe [default: comma]."},{"required":false,"name":"unquoted","description":"If true, will not quote fields."},{"required":false,"name":"filenamePrefix","description":"The output filename prefix."}],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/queries","request_body":"{\n \"sql\": \"SELECT 1\",\n \"credential\": 383,\n \"database\": 198,\n \"previewRows\": 10\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer Xr1IojIS1drNfLJK_cqCb13hzvg4dCnDmlcMPRQbyaQ","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 278,\n \"database\": 198,\n \"sql\": \"SELECT 1\",\n \"credential\": 383,\n \"resultRows\": [\n\n ],\n \"resultColumns\": [\n\n ],\n \"error\": null,\n \"startedAt\": null,\n \"finishedAt\": null,\n \"state\": \"queued\",\n \"scriptId\": null,\n \"exception\": null,\n \"createdAt\": \"2025-02-26T17:49:46.000Z\",\n \"updatedAt\": \"2025-02-26T17:49:46.000Z\",\n \"lastRunId\": 64,\n \"hidden\": false,\n \"archived\": false,\n \"myPermissionLevel\": \"manage\",\n \"interactive\": false,\n \"previewRows\": 10,\n \"includeHeader\": true,\n \"compression\": \"gzip\",\n \"columnDelimiter\": \"comma\",\n \"unquoted\": null,\n \"filenamePrefix\": null,\n \"reportId\": null\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"6c261a1aa0d7aab976952220f5336d6a\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"4ad44eed-0d4a-43e8-b8a7-926eebe7e5f6","X-Runtime":"0.319027","Content-Length":"505"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/queries\" -d '{\"sql\":\"SELECT 1\",\"credential\":383,\"database\":198,\"previewRows\":10}' -X POST \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer Xr1IojIS1drNfLJK_cqCb13hzvg4dCnDmlcMPRQbyaQ\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Queries","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/queries","description":"Specifying optional parameters","explanation":null,"parameters":[{"required":true,"name":"database","description":"The database ID."},{"required":true,"name":"sql","description":"The SQL to execute."},{"required":false,"name":"credential","description":"The credential ID."},{"required":false,"name":"hidden","description":"The hidden status of the item."},{"required":false,"name":"interactive","description":"Deprecated and not used."},{"required":true,"name":"previewRows","description":"The number of rows to save from the query's result (maximum: 1000)."},{"required":false,"name":"includeHeader","description":"Whether the CSV output should include a header row [default: true]."},{"required":false,"name":"compression","description":"The type of compression. One of gzip or zip, or none [default: gzip]."},{"required":false,"name":"columnDelimiter","description":"The delimiter to use. One of comma or tab, or pipe [default: comma]."},{"required":false,"name":"unquoted","description":"If true, will not quote fields."},{"required":false,"name":"filenamePrefix","description":"The output filename prefix."}],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/queries","request_body":"{\n \"sql\": \"SELECT 1\",\n \"credential\": 385,\n \"database\": 199,\n \"preview_rows\": 12,\n \"include_header\": false,\n \"compression\": \"none\",\n \"column_delimiter\": \"tab\",\n \"unquoted\": true,\n \"filename_prefix\": \"pfx\"\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer gYFazXvgVPB0GCjFcckaDQ3ppGeFjXCJOymJjUTYdRI","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 279,\n \"database\": 199,\n \"sql\": \"SELECT 1\",\n \"credential\": 385,\n \"resultRows\": [\n\n ],\n \"resultColumns\": [\n\n ],\n \"error\": null,\n \"startedAt\": null,\n \"finishedAt\": null,\n \"state\": \"queued\",\n \"scriptId\": null,\n \"exception\": null,\n \"createdAt\": \"2025-02-26T17:49:47.000Z\",\n \"updatedAt\": \"2025-02-26T17:49:47.000Z\",\n \"lastRunId\": 65,\n \"hidden\": false,\n \"archived\": false,\n \"myPermissionLevel\": \"manage\",\n \"interactive\": false,\n \"previewRows\": 12,\n \"includeHeader\": false,\n \"compression\": \"none\",\n \"columnDelimiter\": \"tab\",\n \"unquoted\": true,\n \"filenamePrefix\": \"pfx\",\n \"reportId\": null\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"be38ee81ebd914dcc0da8c28559a1af5\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"759abb9d-eb14-4148-be60-7623eb558735","X-Runtime":"0.304038","Content-Length":"505"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/queries\" -d '{\"sql\":\"SELECT 1\",\"credential\":385,\"database\":199,\"preview_rows\":12,\"include_header\":false,\"compression\":\"none\",\"column_delimiter\":\"tab\",\"unquoted\":true,\"filename_prefix\":\"pfx\"}' -X POST \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer gYFazXvgVPB0GCjFcckaDQ3ppGeFjXCJOymJjUTYdRI\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/queries/{id}/runs":{"post":{"summary":"Start a run","description":"Start a run and provide a URI for checking its status. The response will provide a 'Location' header which will contain a URI which may be polled to monitor the status of the run.","deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Query job.","type":"integer"}],"responses":{"202":{"description":"success","schema":{"$ref":"#/definitions/Object461"}}},"x-examples":null,"x-deprecation-warning":null},"get":{"summary":"List runs for the given Query job","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Query job.","type":"integer"},{"name":"limit","in":"query","required":false,"description":"Number of results to return. Defaults to 20. Maximum allowed is 100.","type":"integer"},{"name":"page_num","in":"query","required":false,"description":"Page number of the results to return. Defaults to the first page, 1.","type":"integer"},{"name":"order","in":"query","required":false,"description":"The field on which to order the result set. Defaults to id. Must be one of: id.","type":"string"},{"name":"order_dir","in":"query","required":false,"description":"Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc.","type":"string"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object461"}}}},"x-examples":null,"x-deprecation-warning":null}},"/queries/{id}/runs/{run_id}":{"get":{"summary":"Check status of a run","description":"View the status of a run. This endpoint may be polled to monitor the status of the run. When the 'state' field is no longer 'queued' or 'running' the run has reached its final state.","deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Query job.","type":"integer"},{"name":"run_id","in":"path","required":true,"description":"The ID of the run.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object461"}}},"x-examples":null,"x-deprecation-warning":null},"delete":{"summary":"Cancel a run","description":"Cancel a currently active run.","deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Query job.","type":"integer"},{"name":"run_id","in":"path","required":true,"description":"The ID of the run.","type":"integer"}],"responses":{"202":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/queries/{id}/runs/{run_id}/logs":{"get":{"summary":"Get the logs for a run","description":"Get the logs for a run.","deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Query job.","type":"integer"},{"name":"run_id","in":"path","required":true,"description":"The ID of the run.","type":"integer"},{"name":"last_id","in":"query","required":false,"description":"The ID of the last log message received. Log entries with this ID value or lower will be omitted.Logs are sorted by ID if this value is provided, and are otherwise sorted by createdAt.","type":"integer"},{"name":"limit","in":"query","required":false,"description":"The maximum number of log messages to return. Default of 10000.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object117"}}}},"x-examples":null,"x-deprecation-warning":null}},"/queries/{id}/scripts/{script_id}":{"put":{"summary":"Update the query's associated script","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The query ID.","type":"integer"},{"name":"script_id","in":"path","required":true,"description":"The ID of the script associated with this query.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object464"}}},"x-examples":[{"resource":"Queries","resource_explanation":null,"http_method":"PUT","route":"http://api.civis.test/queries/:id/scripts/:script_id","description":"Update a query","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"PUT","request_path":"http://api.civis.test/queries/283/scripts/73","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer 5qvMuZOQpCdulGUtS1V4ExOgz_zkZqNTxgJMRouuPBY","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 283,\n \"database\": 204,\n \"sql\": \"SELECT * FROM table LIMIT 10;\",\n \"credential\": 394,\n \"resultRows\": [\n [\n 1,\n 2\n ],\n [\n 3,\n 4\n ]\n ],\n \"resultColumns\": [\n \"id\",\n \"value\"\n ],\n \"error\": null,\n \"startedAt\": null,\n \"finishedAt\": null,\n \"state\": \"idle\",\n \"scriptId\": 73,\n \"exception\": null,\n \"createdAt\": \"2025-02-26T17:49:43.000Z\",\n \"updatedAt\": \"2025-02-26T17:49:48.000Z\",\n \"lastRunId\": null,\n \"hidden\": false,\n \"archived\": false,\n \"name\": \"Query #283\",\n \"author\": {\n \"id\": 490,\n \"name\": \"User devuserfactory327 327\",\n \"username\": \"devuserfactory327\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"reportId\": null\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"696b4086b098e0eb383b3522bd501b09\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"0ab942b5-c8a2-45ff-8bf9-6ba03a42b078","X-Runtime":"0.090569","Content-Length":"512"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/queries/283/scripts/73\" -d '' -X PUT \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer 5qvMuZOQpCdulGUtS1V4ExOgz_zkZqNTxgJMRouuPBY\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/queries/{id}":{"get":{"summary":"Get details about a query","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The query ID.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object464"}}},"x-examples":[{"resource":"Queries","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/queries/:id","description":"View a query","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/queries/280","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer meveRdr09vYisSLuYOlmk_iW0F54UiLO3-QKpO5KjF0","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 280,\n \"database\": 201,\n \"sql\": \"SELECT * FROM table LIMIT 10;\",\n \"credential\": 388,\n \"resultRows\": [\n [\n 1,\n 2\n ],\n [\n 3,\n 4\n ]\n ],\n \"resultColumns\": [\n \"id\",\n \"value\"\n ],\n \"error\": null,\n \"startedAt\": \"2015-01-01T01:01:01.000Z\",\n \"finishedAt\": \"2012-02-02T02:02:02.000Z\",\n \"state\": \"running\",\n \"scriptId\": null,\n \"exception\": null,\n \"createdAt\": \"2025-02-26T17:49:42.000Z\",\n \"updatedAt\": \"2025-02-26T17:49:47.000Z\",\n \"lastRunId\": 66,\n \"hidden\": false,\n \"archived\": false,\n \"name\": \"Query #280\",\n \"author\": {\n \"id\": 485,\n \"name\": \"User devuserfactory323 323\",\n \"username\": \"devuserfactory323\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"reportId\": null\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"7685b36e43c073d28fbeae3f9bebe209\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"8db5ea08-6a69-48fd-a180-9f1b42750b19","X-Runtime":"0.042164","Content-Length":"559"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/queries/280\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer meveRdr09vYisSLuYOlmk_iW0F54UiLO3-QKpO5KjF0\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"delete":{"summary":"Sets Query Hidden to true","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The query ID.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object464"}}},"x-examples":null,"x-deprecation-warning":null}},"/remote_hosts/":{"get":{"summary":"List Remote Hosts","description":null,"deprecated":false,"parameters":[{"name":"type","in":"query","required":false,"description":"The type of remote host. One of: RemoteHostTypes::Bigquery, RemoteHostTypes::Bitbucket, RemoteHostTypes::GitSSH, RemoteHostTypes::Github, RemoteHostTypes::GoogleDoc, RemoteHostTypes::JDBC, RemoteHostTypes::Postgres, RemoteHostTypes::Redshift, RemoteHostTypes::S3Storage, and RemoteHostTypes::Salesforce","type":"string"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object465"}}}},"x-examples":[{"resource":"RemoteHosts","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/remote_hosts","description":"List all remote hosts","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/remote_hosts","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer e4Ocdc7yY2YTow1p9IblBHzIYTTzfkvGgv7moeTlrO4","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 1,\n \"name\": \"Github API Connection\",\n \"type\": \"RemoteHostTypes::Github\",\n \"url\": \"http://www.github.com\"\n },\n {\n \"id\": 2,\n \"name\": \"Bitbucket API Connection\",\n \"type\": \"RemoteHostTypes::Bitbucket\",\n \"url\": \"http://www.bitbucket.org\"\n },\n {\n \"id\": 3,\n \"name\": \"Google\",\n \"type\": \"RemoteHostTypes::GoogleDoc\",\n \"url\": \"http://www.google.com\"\n },\n {\n \"id\": 206,\n \"name\": \"JDBC Remote Host\",\n \"type\": \"RemoteHostTypes::JDBC\",\n \"url\": \"jdbc:redshift://address/db\"\n },\n {\n \"id\": 207,\n \"name\": \"redshift-10194\",\n \"type\": \"RemoteHostTypes::Redshift\",\n \"url\": \"jdbc:redshift://localhost.civis.io/db\"\n },\n {\n \"id\": 208,\n \"name\": \"prod salesforce 10000\",\n \"type\": \"RemoteHostTypes::Salesforce\",\n \"url\": \"https://login.salesforce.com\"\n },\n {\n \"id\": 210,\n \"name\": \"S3Storage\",\n \"type\": \"RemoteHostTypes::S3Storage\",\n \"url\": \"https://mybucket.s3.amazonaws.com\"\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"dea6c7b11d58fb723e3828819b0e5636\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"5fee878d-8a8e-4e25-8aaf-4685dfaee509","X-Runtime":"0.080915","Content-Length":"750"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/remote_hosts\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer e4Ocdc7yY2YTow1p9IblBHzIYTTzfkvGgv7moeTlrO4\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"RemoteHosts","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/remote_hosts","description":"List all remote hosts","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/remote_hosts","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer MVfGrIKjHkpeLCepBl8XzLm3Y4qOhvtlx30SJx9ZrRE","Accept":"application/vnd.civis-platform.v2","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 1,\n \"name\": \"Github API Connection\",\n \"type\": \"RemoteHostTypes::Github\",\n \"url\": \"http://www.github.com\"\n },\n {\n \"id\": 2,\n \"name\": \"Bitbucket API Connection\",\n \"type\": \"RemoteHostTypes::Bitbucket\",\n \"url\": \"http://www.bitbucket.org\"\n },\n {\n \"id\": 3,\n \"name\": \"Google\",\n \"type\": \"RemoteHostTypes::GoogleDoc\",\n \"url\": \"http://www.google.com\"\n },\n {\n \"id\": 211,\n \"name\": \"JDBC Remote Host\",\n \"type\": \"RemoteHostTypes::JDBC\",\n \"url\": \"jdbc:redshift://address/db\"\n },\n {\n \"id\": 212,\n \"name\": \"redshift-10196\",\n \"type\": \"RemoteHostTypes::Redshift\",\n \"url\": \"jdbc:redshift://localhost.civis.io/db\"\n },\n {\n \"id\": 213,\n \"name\": \"prod salesforce 10001\",\n \"type\": \"RemoteHostTypes::Salesforce\",\n \"url\": \"https://login.salesforce.com\"\n },\n {\n \"id\": 215,\n \"name\": \"S3Storage\",\n \"type\": \"RemoteHostTypes::S3Storage\",\n \"url\": \"https://mybucket.s3.amazonaws.com\"\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"bc6a73301f2fae0b9ae09a59f43eb332\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"b2c4369a-1eda-49ca-8cb5-893bea22721e","X-Runtime":"0.077788","Content-Length":"750"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/remote_hosts\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer MVfGrIKjHkpeLCepBl8XzLm3Y4qOhvtlx30SJx9ZrRE\" \\\n\t-H \"Accept: application/vnd.civis-platform.v2\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"RemoteHosts","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/remote_hosts","description":"List all remote hosts for a user","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/remote_hosts","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer -mJhBgoIyNpnH5K_lFJ2nU9lPTynSNk0rZs4UBQGrmQ","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 1,\n \"name\": \"Github API Connection\",\n \"type\": \"RemoteHostTypes::Github\",\n \"url\": \"http://www.github.com\"\n },\n {\n \"id\": 2,\n \"name\": \"Bitbucket API Connection\",\n \"type\": \"RemoteHostTypes::Bitbucket\",\n \"url\": \"http://www.bitbucket.org\"\n },\n {\n \"id\": 3,\n \"name\": \"Google\",\n \"type\": \"RemoteHostTypes::GoogleDoc\",\n \"url\": \"http://www.google.com\"\n },\n {\n \"id\": 216,\n \"name\": \"JDBC Remote Host\",\n \"type\": \"RemoteHostTypes::JDBC\",\n \"url\": \"jdbc:redshift://address/db\"\n },\n {\n \"id\": 217,\n \"name\": \"redshift-10198\",\n \"type\": \"RemoteHostTypes::Redshift\",\n \"url\": \"jdbc:redshift://localhost.civis.io/db\"\n },\n {\n \"id\": 218,\n \"name\": \"prod salesforce 10002\",\n \"type\": \"RemoteHostTypes::Salesforce\",\n \"url\": \"https://login.salesforce.com\"\n },\n {\n \"id\": 220,\n \"name\": \"S3Storage\",\n \"type\": \"RemoteHostTypes::S3Storage\",\n \"url\": \"https://mybucket.s3.amazonaws.com\"\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"071ff19d257011545f8f9190353f70dd\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"c751f02e-5bbe-4556-9558-c2fa7bd3a8a0","X-Runtime":"0.067661","Content-Length":"750"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/remote_hosts\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer -mJhBgoIyNpnH5K_lFJ2nU9lPTynSNk0rZs4UBQGrmQ\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"post":{"summary":"Create a Remote Host","description":null,"deprecated":false,"parameters":[{"name":"Object466","in":"body","schema":{"$ref":"#/definitions/Object466"},"required":true}],"responses":{"201":{"description":"success","schema":{"$ref":"#/definitions/Object467"}}},"x-examples":[{"resource":"RemoteHosts","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/remote_hosts","description":"Create a Remote Host","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/remote_hosts","request_body":"{\n \"name\": \"My Remote Host\",\n \"url\": \"jdbc:mysql://address/db\",\n \"type\": \"RemoteHostTypes::JDBC\"\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer 7G8DeMGR4tLBw-MbwZtCyLHqIyknEn86BmhSaqkf85o","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":201,"response_status_text":"Created","response_body":"{\n \"id\": 226,\n \"name\": \"My Remote Host\",\n \"type\": \"RemoteHostTypes::JDBC\",\n \"url\": \"jdbc:mysql://address/db\",\n \"description\": null,\n \"myPermissionLevel\": \"manage\",\n \"user\": {\n \"id\": 499,\n \"name\": \"User devuserfactory333 333\",\n \"username\": \"devuserfactory333\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"createdAt\": \"2025-02-26T17:49:50.000Z\",\n \"updatedAt\": \"2025-02-26T17:49:50.000Z\"\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"3c84672274a57ebc2ac1a233a73073a0\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"aee60e8c-fcd1-4995-a390-86690065d221","X-Runtime":"0.062086","Content-Length":"338"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/remote_hosts\" -d '{\"name\":\"My Remote Host\",\"url\":\"jdbc:mysql://address/db\",\"type\":\"RemoteHostTypes::JDBC\"}' -X POST \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer 7G8DeMGR4tLBw-MbwZtCyLHqIyknEn86BmhSaqkf85o\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/remote_hosts/{id}":{"get":{"summary":"Get a Remote Host","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object467"}}},"x-examples":[{"resource":"RemoteHosts","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/remote_hosts/:id","description":"View a Remote Host's details","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/remote_hosts/227","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer 4eKSCTVf_H-AueFFogIlIEcSdEc_MRCrWGhWJK3zius","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 227,\n \"name\": \"JDBC Remote Host\",\n \"type\": \"RemoteHostTypes::JDBC\",\n \"url\": \"jdbc:redshift://address/db\",\n \"description\": null,\n \"myPermissionLevel\": \"manage\",\n \"user\": {\n \"id\": 501,\n \"name\": \"User devuserfactory334 334\",\n \"username\": \"devuserfactory334\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"createdAt\": \"2025-02-26T17:49:50.000Z\",\n \"updatedAt\": \"2025-02-26T17:49:50.000Z\"\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"c5c84a0c27b74b2010a423a66cc3c750\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"62069a1b-bb53-43b6-88c1-7384d374787b","X-Runtime":"0.031301","Content-Length":"343"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/remote_hosts/227\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer 4eKSCTVf_H-AueFFogIlIEcSdEc_MRCrWGhWJK3zius\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"put":{"summary":"Replace all attributes of this Remote Host","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the remote host.","type":"integer"},{"name":"Object468","in":"body","schema":{"$ref":"#/definitions/Object468"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object467"}}},"x-examples":[{"resource":"RemoteHosts","resource_explanation":null,"http_method":"PUT","route":"http://api.civis.test/remote_hosts/:id","description":"Replace all attributes of a Remote Host","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"PUT","request_path":"http://api.civis.test/remote_hosts/237","request_body":"{\n \"name\": \"New Name\",\n \"type\": \"RemoteHostTypes::JDBC\",\n \"url\": \"jdbc:redshift://new-address/db\",\n \"description\": \"New description\"\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer jqIOZCkoxtVjXmp4ZcxKhZUFvmsdcA6RsXpFB-Srvlk","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 237,\n \"name\": \"New Name\",\n \"type\": \"RemoteHostTypes::JDBC\",\n \"url\": \"jdbc:redshift://new-address/db\",\n \"description\": \"New description\",\n \"myPermissionLevel\": \"manage\",\n \"user\": {\n \"id\": 505,\n \"name\": \"User devuserfactory336 336\",\n \"username\": \"devuserfactory336\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"createdAt\": \"2025-02-26T17:49:51.000Z\",\n \"updatedAt\": \"2025-02-26T17:49:51.000Z\"\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"23902bf09e14cd53d455433a4727cd57\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"e3c80f1d-587d-4761-b452-daa6829a2149","X-Runtime":"0.050333","Content-Length":"352"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/remote_hosts/237\" -d '{\"name\":\"New Name\",\"type\":\"RemoteHostTypes::JDBC\",\"url\":\"jdbc:redshift://new-address/db\",\"description\":\"New description\"}' -X PUT \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer jqIOZCkoxtVjXmp4ZcxKhZUFvmsdcA6RsXpFB-Srvlk\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"patch":{"summary":"Update some attributes of this Remote Host","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the remote host.","type":"integer"},{"name":"Object469","in":"body","schema":{"$ref":"#/definitions/Object469"},"required":false}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object467"}}},"x-examples":[{"resource":"RemoteHosts","resource_explanation":null,"http_method":"PATCH","route":"http://api.civis.test/remote_hosts/:id","description":"Update a Remote Host","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"PATCH","request_path":"http://api.civis.test/remote_hosts/232","request_body":"{\n \"name\": \"New Name\"\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer AjwctydRoYoo9Rt-F3T7-VITPyEHX6D8fcTgdmmsqa8","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 232,\n \"name\": \"New Name\",\n \"type\": \"RemoteHostTypes::JDBC\",\n \"url\": \"jdbc:redshift://address/db\",\n \"description\": null,\n \"myPermissionLevel\": \"manage\",\n \"user\": {\n \"id\": 503,\n \"name\": \"User devuserfactory335 335\",\n \"username\": \"devuserfactory335\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"createdAt\": \"2025-02-26T17:49:50.000Z\",\n \"updatedAt\": \"2025-02-26T17:49:51.000Z\"\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"7de13fbc73a35615cfd77c2cbcf999d9\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"9b8ca87e-3b12-404d-9ec6-ab82b183c6a6","X-Runtime":"0.056349","Content-Length":"335"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/remote_hosts/232\" -d '{\"name\":\"New Name\"}' -X PATCH \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer AjwctydRoYoo9Rt-F3T7-VITPyEHX6D8fcTgdmmsqa8\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/remote_hosts/{id}/shares":{"get":{"summary":"List users and groups permissioned on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object9"}}}},"x-examples":null,"x-deprecation-warning":null}},"/remote_hosts/{id}/shares/users":{"put":{"summary":"Set the permissions users have on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"Object470","in":"body","schema":{"$ref":"#/definitions/Object470"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object9"}}},"x-examples":null,"x-deprecation-warning":null}},"/remote_hosts/{id}/shares/users/{user_id}":{"delete":{"summary":"Revoke the permissions a user has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"user_id","in":"path","required":true,"description":"The ID of the user.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/remote_hosts/{id}/shares/groups":{"put":{"summary":"Set the permissions groups has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"Object471","in":"body","schema":{"$ref":"#/definitions/Object471"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object9"}}},"x-examples":null,"x-deprecation-warning":null}},"/remote_hosts/{id}/shares/groups/{group_id}":{"delete":{"summary":"Revoke the permissions a group has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"group_id","in":"path","required":true,"description":"The ID of the group.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/remote_hosts/{id}/authenticate":{"post":{"summary":"Authenticate against a remote host using either a credential or a user name and password","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the remote host.","type":"integer"},{"name":"Object472","in":"body","schema":{"$ref":"#/definitions/Object472"},"required":false}],"responses":{"204":{"description":"success"}},"x-examples":[{"resource":"RemoteHosts","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/remote_hosts/:id/authenticate","description":"Authenticate against the remote host","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/remote_hosts/242/authenticate","request_body":"{\n \"credential_id\": 415\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer 7dz0ql_hpHcQX83IFUCRd5EodlIn_H3KbGRubqpXEek","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":204,"response_status_text":"No Content","response_body":null,"response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"73c70107-9914-48f5-b953-5df1d410c6d4","X-Runtime":"0.030662"},"response_content_type":null,"curl":"curl \"api.civis.testhttp://api.civis.test/remote_hosts/242/authenticate\" -d '{\"credential_id\":415}' -X POST \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer 7dz0ql_hpHcQX83IFUCRd5EodlIn_H3KbGRubqpXEek\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"RemoteHosts","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/remote_hosts/:id/authenticate","description":"Authenticate against the remote host can fail","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/remote_hosts/248/authenticate","request_body":"{\n \"credential_id\": 419\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer ifsjHu756kof7XmuMqQXqHCawhxsXDgTWhbMjGZ9B4g","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":400,"response_status_text":"Bad Request","response_body":"{\n \"error\": \"authentication_error\",\n \"errorDescription\": \"Username or password is incorrect.\",\n \"code\": 400\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"836967e4-7c83-49a7-a63c-df9b713c8a6f","X-Runtime":"0.029796","Content-Length":"99"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/remote_hosts/248/authenticate\" -d '{\"credential_id\":419}' -X POST \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer ifsjHu756kof7XmuMqQXqHCawhxsXDgTWhbMjGZ9B4g\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/remote_hosts/{id}/data_sets":{"get":{"summary":"List data sets available from a remote host","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the remote host.","type":"integer"},{"name":"credential_id","in":"query","required":false,"description":"The credential ID.","type":"integer"},{"name":"username","in":"query","required":false,"description":"The user name for remote host.","type":"string"},{"name":"password","in":"query","required":false,"description":"The password for remote host.","type":"string"},{"name":"q","in":"query","required":false,"description":"The query string for data set.","type":"string"},{"name":"s","in":"query","required":false,"description":"If true will only return schemas, otherwise, the results will be the full path.","type":"boolean"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object473"}}}},"x-examples":[{"resource":"RemoteHosts","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/remote_hosts/:id/data_sets?credential_id=:credential_id","description":"List all data sets for a user","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/remote_hosts/254/data_sets?credential_id=423","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer yWxJUkiY3STj0jB3cZa_FUjWpEe4df_wYdz8CNv-MjI","Host":"api.civis.test","Cookie":""},"request_query_parameters":{"credential_id":"423"},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"name\": \"table_schema.table_name\",\n \"fullPath\": false\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"14a255c21424381eabfdd24ebee5fd3b\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"b0cd88bc-6496-440c-9de7-27e4b1936fd3","X-Runtime":"0.026468","Content-Length":"53"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/remote_hosts/254/data_sets?credential_id=423\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer yWxJUkiY3STj0jB3cZa_FUjWpEe4df_wYdz8CNv-MjI\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/reports/":{"get":{"summary":"List Reports","description":null,"deprecated":false,"parameters":[{"name":"type","in":"query","required":false,"description":"If specified, return report of these types. It accepts a comma-separated list, possible values are 'tableau' or 'other'.","type":"string"},{"name":"template_id","in":"query","required":false,"description":"If specified, return reports using the provided Template.","type":"integer"},{"name":"author","in":"query","required":false,"description":"If specified, return items from any of these authors. It accepts a comma-separated list of user IDs.","type":"string"},{"name":"hidden","in":"query","required":false,"description":"If specified to be true, returns hidden items. Defaults to false, returning non-hidden items.","type":"boolean"},{"name":"archived","in":"query","required":false,"description":"The archival status of the requested item(s).","type":"string"},{"name":"limit","in":"query","required":false,"description":"Number of results to return. Defaults to 20. Maximum allowed is 50.","type":"integer"},{"name":"page_num","in":"query","required":false,"description":"Page number of the results to return. Defaults to the first page, 1.","type":"integer"},{"name":"order","in":"query","required":false,"description":"The field on which to order the result set. Defaults to updated_at. Must be one of: updated_at, name, created_at.","type":"string"},{"name":"order_dir","in":"query","required":false,"description":"Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc.","type":"string"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object474"}}}},"x-examples":[{"resource":"Report","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/reports","description":"List all reports","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/reports","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer UHqSYTcHLGW1nmYo4a5uN1dRpWabVxtW-AXOo1ZG9v8","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 1,\n \"name\": \"test_report\",\n \"user\": {\n \"id\": 7,\n \"name\": \"User devuserfactory2 2\",\n \"username\": \"devuserfactory2\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"createdAt\": \"2016-03-01T01:01:00.000Z\",\n \"updatedAt\": \"2016-03-01T01:01:00.000Z\",\n \"type\": \"ReportTypes::Html\",\n \"projects\": [\n {\n \"id\": 1,\n \"name\": \"Test Project\"\n }\n ],\n \"state\": \"running\",\n \"finishedAt\": \"2024-03-14T15:40:49.000Z\",\n \"vizUpdatedAt\": null,\n \"script\": {\n \"id\": 2,\n \"name\": \"Script #2\",\n \"sql\": \"SELECT * FROM table LIMIT 10;\"\n },\n \"jobPath\": \"/scripts/sql/2\",\n \"tableauId\": null,\n \"templateId\": null,\n \"authThumbnailUrl\": null,\n \"lastRun\": {\n \"id\": 1,\n \"state\": \"running\",\n \"createdAt\": \"2024-03-14T15:40:49.000Z\",\n \"startedAt\": null,\n \"finishedAt\": \"2024-03-14T15:40:49.000Z\",\n \"error\": null\n },\n \"archived\": false\n },\n {\n \"id\": 2,\n \"name\": \"custom tableau view\",\n \"user\": {\n \"id\": 7,\n \"name\": \"User devuserfactory2 2\",\n \"username\": \"devuserfactory2\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"createdAt\": \"2024-03-14T15:40:49.000Z\",\n \"updatedAt\": \"2016-02-01T01:01:00.000Z\",\n \"type\": \"ReportTypes::Tableau\",\n \"projects\": [\n\n ],\n \"state\": null,\n \"finishedAt\": null,\n \"vizUpdatedAt\": null,\n \"script\": null,\n \"jobPath\": null,\n \"tableauId\": 1,\n \"templateId\": null,\n \"authThumbnailUrl\": null,\n \"lastRun\": null,\n \"archived\": false\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","X-Pagination-Per-Page":"20","Access-Control-Expose-Headers":"X-Pagination-Per-Page, X-Pagination-Current-Page, X-Pagination-Total-Pages, X-Pagination-Total-Entries","X-Pagination-Current-Page":"1","X-Pagination-Total-Pages":"1","X-Pagination-Total-Entries":"2","Content-Type":"application/json; charset=utf-8","ETag":"W/\"2895d73f9ea709e21dcc8eb796a14984\"","X-Request-Id":"d64b01ea-39cc-497c-a4dc-f01e8e08eeee","X-Runtime":"0.147772","Content-Length":"1124"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/reports\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer UHqSYTcHLGW1nmYo4a5uN1dRpWabVxtW-AXOo1ZG9v8\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Report","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/reports?templateId=:template_id","description":"Filter reports by Template ID","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/reports?templateId=1","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer d9H3LD4CWSmVEJdMAHF7c-VKZbvNzX2iwEHSy3WhinI","Host":"api.civis.test","Cookie":""},"request_query_parameters":{"templateId":"1"},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 8,\n \"name\": \"test_report\",\n \"user\": {\n \"id\": 31,\n \"name\": \"User devuserfactory20 20\",\n \"username\": \"devuserfactory20\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"createdAt\": \"2024-03-14T15:40:51.000Z\",\n \"updatedAt\": \"2024-03-14T15:40:51.000Z\",\n \"type\": \"ReportTypes::Html\",\n \"projects\": [\n\n ],\n \"state\": \"running\",\n \"finishedAt\": \"2024-03-14T15:40:50.000Z\",\n \"vizUpdatedAt\": null,\n \"script\": {\n \"id\": 6,\n \"name\": \"Script #6\",\n \"sql\": \"SELECT * FROM table LIMIT 10;\"\n },\n \"jobPath\": \"/scripts/sql/6\",\n \"tableauId\": null,\n \"templateId\": 1,\n \"authThumbnailUrl\": null,\n \"lastRun\": {\n \"id\": 2,\n \"state\": \"running\",\n \"createdAt\": \"2024-03-14T15:40:50.000Z\",\n \"startedAt\": null,\n \"finishedAt\": \"2024-03-14T15:40:50.000Z\",\n \"error\": null\n },\n \"archived\": false\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","X-Pagination-Per-Page":"20","Access-Control-Expose-Headers":"X-Pagination-Per-Page, X-Pagination-Current-Page, X-Pagination-Total-Pages, X-Pagination-Total-Entries","X-Pagination-Current-Page":"1","X-Pagination-Total-Pages":"1","X-Pagination-Total-Entries":"1","Content-Type":"application/json; charset=utf-8","ETag":"W/\"addb5e02068e01194f35667d5383cdfa\"","X-Request-Id":"5fa9910f-f152-46cd-8936-d69adb14fba5","X-Runtime":"0.038287","Content-Length":"660"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/reports?templateId=1\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer d9H3LD4CWSmVEJdMAHF7c-VKZbvNzX2iwEHSy3WhinI\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"post":{"summary":"Create an HTML report","description":null,"deprecated":false,"parameters":[{"name":"Object478","in":"body","schema":{"$ref":"#/definitions/Object478"},"required":false}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object477"}}},"x-examples":[{"resource":"Report","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/reports","description":"Create a report","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/reports","request_body":"{\n \"script_id\": 12,\n \"name\": \"Custom Name\"\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer i3Pcc7Xh4K7oeMlAjNB_BIUt3h4bu-Kdv230DFa27B0","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 15,\n \"name\": \"Custom Name\",\n \"user\": {\n \"id\": 43,\n \"name\": \"User devuserfactory30 30\",\n \"username\": \"devuserfactory30\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"createdAt\": \"2024-03-14T15:40:54.000Z\",\n \"updatedAt\": \"2024-03-14T15:40:54.000Z\",\n \"type\": \"ReportTypes::Html\",\n \"description\": null,\n \"myPermissionLevel\": \"manage\",\n \"projects\": [\n\n ],\n \"state\": \"idle\",\n \"finishedAt\": null,\n \"vizUpdatedAt\": null,\n \"script\": {\n \"id\": 12,\n \"name\": \"Script #12\",\n \"sql\": \"SELECT * FROM table LIMIT 10;\"\n },\n \"jobPath\": \"/scripts/sql/12\",\n \"tableauId\": null,\n \"templateId\": null,\n \"authThumbnailUrl\": null,\n \"lastRun\": null,\n \"archived\": false,\n \"hidden\": false,\n \"authDataUrl\": \"\",\n \"authCodeUrl\": \"\",\n \"config\": null,\n \"validOutputFile\": false,\n \"provideAPIKey\": false,\n \"apiKey\": null,\n \"apiKeyId\": null,\n \"appState\": {\n },\n \"useViewersTableauUsername\": false\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"a0663130c3226e8474eb83c8aa5ad935\"","X-Request-Id":"d7971346-6e2b-4b92-8be5-1f122a9aa66b","X-Runtime":"0.086713","Content-Length":"744"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/reports\" -d '{\"script_id\":12,\"name\":\"Custom Name\"}' -X POST \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer i3Pcc7Xh4K7oeMlAjNB_BIUt3h4bu-Kdv230DFa27B0\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Report","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/reports","description":"Create a report specifying a code body","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/reports","request_body":"{\n \"script_id\": 16,\n \"name\": \"Custom Name\",\n \"code_body\": \"

Hello Civis

\"\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer R8VTdgCT-fezsAgWZuNmJMyhg5kdlX6yJrJf0nHPEE4","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 19,\n \"name\": \"Custom Name\",\n \"user\": {\n \"id\": 55,\n \"name\": \"User devuserfactory38 38\",\n \"username\": \"devuserfactory38\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"createdAt\": \"2024-03-14T15:40:55.000Z\",\n \"updatedAt\": \"2024-03-14T15:40:55.000Z\",\n \"type\": \"ReportTypes::Html\",\n \"description\": null,\n \"myPermissionLevel\": \"manage\",\n \"projects\": [\n\n ],\n \"state\": \"idle\",\n \"finishedAt\": null,\n \"vizUpdatedAt\": null,\n \"script\": {\n \"id\": 16,\n \"name\": \"Script #16\",\n \"sql\": \"SELECT * FROM table LIMIT 10;\"\n },\n \"jobPath\": \"/scripts/sql/16\",\n \"tableauId\": null,\n \"templateId\": null,\n \"authThumbnailUrl\": null,\n \"lastRun\": null,\n \"archived\": false,\n \"hidden\": false,\n \"authDataUrl\": \"\",\n \"authCodeUrl\": \"http://s3_url\",\n \"config\": null,\n \"validOutputFile\": false,\n \"provideAPIKey\": false,\n \"apiKey\": null,\n \"apiKeyId\": null,\n \"appState\": {\n },\n \"useViewersTableauUsername\": false\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"dde55cc3e39894ce9bfc9f9a14b2653b\"","X-Request-Id":"5fae3ad1-3df6-4a5a-b741-ae85de5f99e5","X-Runtime":"0.078129","Content-Length":"757"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/reports\" -d '{\"script_id\":16,\"name\":\"Custom Name\",\"code_body\":\"\\u003ch1\\u003eHello Civis\\u003c/h1\\u003e\"}' -X POST \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer R8VTdgCT-fezsAgWZuNmJMyhg5kdlX6yJrJf0nHPEE4\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/reports/{id}/git":{"get":{"summary":"Get the git metadata attached to an item","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the item.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object403"}}},"x-examples":null,"x-deprecation-warning":null},"put":{"summary":"Attach an item to a file in a git repo","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the item.","type":"integer"},{"name":"Object404","in":"body","schema":{"$ref":"#/definitions/Object404"},"required":false}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object403"}}},"x-examples":null,"x-deprecation-warning":null},"patch":{"summary":"Update an attached git file","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the item.","type":"integer"},{"name":"Object404","in":"body","schema":{"$ref":"#/definitions/Object404"},"required":false}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object403"}}},"x-examples":null,"x-deprecation-warning":null}},"/reports/{id}/git/commits":{"get":{"summary":"Get the git commits for an item on the current branch","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the item.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object405"}}},"x-examples":null,"x-deprecation-warning":null},"post":{"summary":"Commit and push a new version of the file","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the item.","type":"integer"},{"name":"Object406","in":"body","schema":{"$ref":"#/definitions/Object406"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object407"}}},"x-examples":null,"x-deprecation-warning":null}},"/reports/{id}/git/commits/{commit_hash}":{"get":{"summary":"Get file contents at git ref","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the item.","type":"integer"},{"name":"commit_hash","in":"path","required":true,"description":"The SHA (full or shortened) of the desired git commit.","type":"string"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object407"}}},"x-examples":null,"x-deprecation-warning":null}},"/reports/{id}":{"get":{"summary":"Get a single report","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of this report.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object477"}}},"x-examples":[{"resource":"Report","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/reports/:id","description":"View a report's details","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/reports/9","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer QcoMjIy8sSXYgbw13SSdYgOBMUhfZr0HKDv2VrlsxJk","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 9,\n \"name\": \"test_report\",\n \"user\": {\n \"id\": 34,\n \"name\": \"User devuserfactory23 23\",\n \"username\": \"devuserfactory23\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"createdAt\": \"2016-03-01T01:01:00.000Z\",\n \"updatedAt\": \"2016-03-01T01:01:00.000Z\",\n \"type\": \"ReportTypes::Html\",\n \"description\": null,\n \"myPermissionLevel\": \"manage\",\n \"projects\": [\n {\n \"id\": 3,\n \"name\": \"Test Project\"\n }\n ],\n \"state\": \"running\",\n \"finishedAt\": \"2024-03-14T15:40:52.000Z\",\n \"vizUpdatedAt\": null,\n \"script\": {\n \"id\": 8,\n \"name\": \"Script #8\",\n \"sql\": \"SELECT * FROM table LIMIT 10;\"\n },\n \"jobPath\": \"/scripts/sql/8\",\n \"tableauId\": null,\n \"templateId\": null,\n \"authThumbnailUrl\": null,\n \"lastRun\": {\n \"id\": 3,\n \"state\": \"running\",\n \"createdAt\": \"2024-03-14T15:40:52.000Z\",\n \"startedAt\": null,\n \"finishedAt\": \"2024-03-14T15:40:52.000Z\",\n \"error\": null\n },\n \"archived\": false,\n \"hidden\": false,\n \"authDataUrl\": \"\",\n \"authCodeUrl\": \"http://s3_url\",\n \"config\": null,\n \"validOutputFile\": false,\n \"provideAPIKey\": false,\n \"apiKey\": null,\n \"apiKeyId\": null,\n \"appState\": {\n },\n \"useViewersTableauUsername\": false\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"f88ae87b3b6ca452e4b2a97b524107e5\"","X-Request-Id":"be33b29e-1588-4f54-b6a0-8c85b80eee81","X-Runtime":"0.196145","Content-Length":"939"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/reports/9\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer QcoMjIy8sSXYgbw13SSdYgOBMUhfZr0HKDv2VrlsxJk\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"patch":{"summary":"Update a report","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the report to modify.","type":"integer"},{"name":"Object479","in":"body","schema":{"$ref":"#/definitions/Object479"},"required":false}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object477"}}},"x-examples":[{"resource":"Report","resource_explanation":null,"http_method":"PATCH","route":"http://api.civis.test/reports/:id","description":"Update a report's app_state","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"PATCH","request_path":"http://api.civis.test/reports/20","request_body":"{\n \"app_state\": {\n \"app_state\": \"blob\"\n }\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer ImfIxfIE0p3Xfn1PpWDdmQHOrmh6GLEzsXHXNVzWw4o","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 20,\n \"name\": \"test_report\",\n \"user\": {\n \"id\": 67,\n \"name\": \"User devuserfactory46 46\",\n \"username\": \"devuserfactory46\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"createdAt\": \"2016-03-01T01:01:00.000Z\",\n \"updatedAt\": \"2024-03-14T15:40:56.000Z\",\n \"type\": \"ReportTypes::Html\",\n \"description\": null,\n \"myPermissionLevel\": \"manage\",\n \"projects\": [\n {\n \"id\": 6,\n \"name\": \"Test Project\"\n }\n ],\n \"state\": \"running\",\n \"finishedAt\": \"2024-03-14T15:40:55.000Z\",\n \"vizUpdatedAt\": null,\n \"script\": {\n \"id\": 18,\n \"name\": \"Script #18\",\n \"sql\": \"SELECT * FROM table LIMIT 10;\"\n },\n \"jobPath\": \"/scripts/sql/18\",\n \"tableauId\": null,\n \"templateId\": null,\n \"authThumbnailUrl\": null,\n \"lastRun\": {\n \"id\": 6,\n \"state\": \"running\",\n \"createdAt\": \"2024-03-14T15:40:55.000Z\",\n \"startedAt\": null,\n \"finishedAt\": \"2024-03-14T15:40:55.000Z\",\n \"error\": null\n },\n \"archived\": false,\n \"hidden\": false,\n \"authDataUrl\": \"\",\n \"authCodeUrl\": \"http://s3_url\",\n \"config\": null,\n \"validOutputFile\": false,\n \"provideAPIKey\": false,\n \"apiKey\": null,\n \"apiKeyId\": null,\n \"appState\": {\n \"app_state\": \"blob\"\n },\n \"useViewersTableauUsername\": false\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"751d7b3f0c56cfac0d55d3f704ba1044\"","X-Request-Id":"945f41ee-7194-41fd-89f2-eea5578d448f","X-Runtime":"0.083227","Content-Length":"961"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/reports/20\" -d '{\"app_state\":{\"app_state\":\"blob\"}}' -X PATCH \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer ImfIxfIE0p3Xfn1PpWDdmQHOrmh6GLEzsXHXNVzWw4o\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Report","resource_explanation":null,"http_method":"PATCH","route":"http://api.civis.test/reports/:id","description":"Update a report's name, script job, and code_body","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"PATCH","request_path":"http://api.civis.test/reports/23","request_body":"{\n \"name\": \"New Name\",\n \"script_id\": 22,\n \"code_body\": \"

New Code Body

\"\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer qagGaFGyuhuHYW-rHpF9R1tmabHxauqo1HyzRI5gM1w","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 23,\n \"name\": \"New Name\",\n \"user\": {\n \"id\": 76,\n \"name\": \"User devuserfactory53 53\",\n \"username\": \"devuserfactory53\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"createdAt\": \"2016-03-01T01:01:00.000Z\",\n \"updatedAt\": \"2024-03-14T15:40:57.000Z\",\n \"type\": \"ReportTypes::Html\",\n \"description\": null,\n \"myPermissionLevel\": \"manage\",\n \"projects\": [\n {\n \"id\": 7,\n \"name\": \"Test Project\"\n }\n ],\n \"state\": \"idle\",\n \"finishedAt\": null,\n \"vizUpdatedAt\": null,\n \"script\": {\n \"id\": 22,\n \"name\": \"Script #22\",\n \"sql\": \"SELECT * FROM table LIMIT 10;\"\n },\n \"jobPath\": \"/scripts/sql/22\",\n \"tableauId\": null,\n \"templateId\": null,\n \"authThumbnailUrl\": null,\n \"lastRun\": null,\n \"archived\": false,\n \"hidden\": false,\n \"authDataUrl\": \"\",\n \"authCodeUrl\": \"http://s3_url\",\n \"config\": null,\n \"validOutputFile\": false,\n \"provideAPIKey\": false,\n \"apiKey\": null,\n \"apiKeyId\": null,\n \"appState\": {\n },\n \"useViewersTableauUsername\": false\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"1910584f1146cfc3a792181ed01cb0a5\"","X-Request-Id":"5a75c87d-e699-49d3-a418-203389ce79f1","X-Runtime":"0.048498","Content-Length":"784"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/reports/23\" -d '{\"name\":\"New Name\",\"script_id\":22,\"code_body\":\"\\u003ch1\\u003eNew Code Body\\u003c/h1\\u003e\"}' -X PATCH \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer qagGaFGyuhuHYW-rHpF9R1tmabHxauqo1HyzRI5gM1w\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Report","resource_explanation":null,"http_method":"PATCH","route":"http://api.civis.test/reports/:id","description":"Update a report's template","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"PATCH","request_path":"http://api.civis.test/reports/26","request_body":"{\n \"template_id\": 2\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer MJmQlo8s0KRZOiDQt39OhvMnGwlJjYBOsLsCBJIvZ50","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 26,\n \"name\": \"test_report\",\n \"user\": {\n \"id\": 88,\n \"name\": \"User devuserfactory61 61\",\n \"username\": \"devuserfactory61\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"createdAt\": \"2016-03-01T01:01:00.000Z\",\n \"updatedAt\": \"2024-03-14T15:40:58.000Z\",\n \"type\": \"ReportTypes::Html\",\n \"description\": null,\n \"myPermissionLevel\": \"manage\",\n \"projects\": [\n {\n \"id\": 8,\n \"name\": \"Test Project\"\n }\n ],\n \"state\": \"running\",\n \"finishedAt\": \"2024-03-14T15:40:57.000Z\",\n \"vizUpdatedAt\": null,\n \"script\": {\n \"id\": 24,\n \"name\": \"Script #24\",\n \"sql\": \"SELECT * FROM table LIMIT 10;\"\n },\n \"jobPath\": \"/scripts/sql/24\",\n \"tableauId\": null,\n \"templateId\": 2,\n \"authThumbnailUrl\": null,\n \"lastRun\": {\n \"id\": 8,\n \"state\": \"running\",\n \"createdAt\": \"2024-03-14T15:40:57.000Z\",\n \"startedAt\": null,\n \"finishedAt\": \"2024-03-14T15:40:57.000Z\",\n \"error\": null\n },\n \"archived\": false,\n \"hidden\": false,\n \"authDataUrl\": \"\",\n \"authCodeUrl\": \"http://s3_url\",\n \"config\": null,\n \"validOutputFile\": false,\n \"provideAPIKey\": null,\n \"apiKey\": null,\n \"apiKeyId\": null,\n \"appState\": {\n },\n \"useViewersTableauUsername\": false\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"5e8ed63205928690803d7b34c5a2aab4\"","X-Request-Id":"2e108d79-fe53-4669-976f-12c7f6f61abc","X-Runtime":"0.057747","Content-Length":"939"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/reports/26\" -d '{\"template_id\":2}' -X PATCH \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer MJmQlo8s0KRZOiDQt39OhvMnGwlJjYBOsLsCBJIvZ50\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/reports/{id}/grants":{"post":{"summary":"Grant this report the ability to perform Civis platform API operations on your behalf","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of this report.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object477"}}},"x-examples":[{"resource":"Report","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/reports/:id/grants","description":"Grant access to the Civis platform API to a report","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/reports/38/grants","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer Jwn23yHHq99O5w5ffbIgqYTRH70L_7RrIoQxuyY4YOc","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 38,\n \"name\": \"test_report\",\n \"user\": {\n \"id\": 126,\n \"name\": \"User devuserfactory91 91\",\n \"username\": \"devuserfactory91\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"createdAt\": \"2016-03-01T01:01:00.000Z\",\n \"updatedAt\": \"2016-03-01T01:01:00.000Z\",\n \"type\": \"ReportTypes::Html\",\n \"description\": null,\n \"myPermissionLevel\": \"manage\",\n \"projects\": [\n {\n \"id\": 12,\n \"name\": \"Test Project\"\n }\n ],\n \"state\": \"running\",\n \"finishedAt\": \"2024-03-14T15:41:01.000Z\",\n \"vizUpdatedAt\": null,\n \"script\": {\n \"id\": 32,\n \"name\": \"Script #32\",\n \"sql\": \"SELECT * FROM table LIMIT 10;\"\n },\n \"jobPath\": \"/scripts/sql/32\",\n \"tableauId\": null,\n \"templateId\": null,\n \"authThumbnailUrl\": null,\n \"lastRun\": {\n \"id\": 12,\n \"state\": \"running\",\n \"createdAt\": \"2024-03-14T15:41:01.000Z\",\n \"startedAt\": null,\n \"finishedAt\": \"2024-03-14T15:41:01.000Z\",\n \"error\": null\n },\n \"archived\": false,\n \"hidden\": false,\n \"authDataUrl\": \"\",\n \"authCodeUrl\": \"http://s3_url\",\n \"config\": null,\n \"validOutputFile\": false,\n \"provideAPIKey\": false,\n \"apiKey\": \"13AEDvgtaqIcGM5NjbBh-_T2wDFhkmyRaC7SVoB1RoQ\",\n \"apiKeyId\": 13,\n \"appState\": {\n },\n \"useViewersTableauUsername\": false\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"5905b6bb02f7b9b870bc0c4766443d5d\"","X-Request-Id":"ec2f72f0-5af8-4788-8be8-9131337887bf","X-Runtime":"0.083148","Content-Length":"985"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/reports/38/grants\" -d '' -X POST \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer Jwn23yHHq99O5w5ffbIgqYTRH70L_7RrIoQxuyY4YOc\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"delete":{"summary":"Revoke permission for this report to perform Civis platform API operations on your behalf","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of this report.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":[{"resource":"Report","resource_explanation":null,"http_method":"DELETE","route":"http://api.civis.test/reports/:id/grants","description":"Revoke access to the Civis platform API from a report","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"DELETE","request_path":"http://api.civis.test/reports/41/grants","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer wor9kxnz5DZ5ohaLjQV9I-YIyJIwr6pRgjp4fYdjmTc","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":204,"response_status_text":"No Content","response_body":null,"response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","X-Request-Id":"0bb6a3be-d87e-40be-b088-1989a6afabcb","X-Runtime":"0.030907"},"response_content_type":null,"curl":"curl \"api.civis.testhttp://api.civis.test/reports/41/grants\" -d '' -X DELETE \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer wor9kxnz5DZ5ohaLjQV9I-YIyJIwr6pRgjp4fYdjmTc\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/reports/{id}/shares":{"get":{"summary":"List users and groups permissioned on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object9"}}}},"x-examples":null,"x-deprecation-warning":null}},"/reports/{id}/shares/users":{"put":{"summary":"Set the permissions users have on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"Object480","in":"body","schema":{"$ref":"#/definitions/Object480"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object9"}}},"x-examples":null,"x-deprecation-warning":null}},"/reports/{id}/shares/users/{user_id}":{"delete":{"summary":"Revoke the permissions a user has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"user_id","in":"path","required":true,"description":"The ID of the user.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/reports/{id}/shares/groups":{"put":{"summary":"Set the permissions groups has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"Object481","in":"body","schema":{"$ref":"#/definitions/Object481"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object9"}}},"x-examples":null,"x-deprecation-warning":null}},"/reports/{id}/shares/groups/{group_id}":{"delete":{"summary":"Revoke the permissions a group has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"group_id","in":"path","required":true,"description":"The ID of the group.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/reports/{id}/dependencies":{"get":{"summary":"List dependent objects for this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"user_id","in":"query","required":false,"description":"ID of target user","type":"integer"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object15"}}}},"x-examples":null,"x-deprecation-warning":null}},"/reports/{id}/transfer":{"put":{"summary":"Transfer ownership of this object to another user","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"Object482","in":"body","schema":{"$ref":"#/definitions/Object482"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object17"}}},"x-examples":null,"x-deprecation-warning":null}},"/reports/{id}/projects":{"get":{"summary":"List the projects a Report belongs to","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Report.","type":"integer"},{"name":"hidden","in":"query","required":false,"description":"If specified to be true, returns hidden items. Defaults to false, returning non-hidden items.","type":"boolean"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object85"}}}},"x-examples":null,"x-deprecation-warning":null}},"/reports/{id}/projects/{project_id}":{"put":{"summary":"Add a Report to a project","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Report.","type":"integer"},{"name":"project_id","in":"path","required":true,"description":"The ID of the project.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null},"delete":{"summary":"Remove a Report from a project","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Report.","type":"integer"},{"name":"project_id","in":"path","required":true,"description":"The ID of the project.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/reports/{id}/archive":{"put":{"summary":"Update the archive status of this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the object.","type":"integer"},{"name":"Object483","in":"body","schema":{"$ref":"#/definitions/Object483"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object477"}}},"x-examples":null,"x-deprecation-warning":null}},"/reports/services/{id}":{"get":{"summary":"Get a single service report","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of this report.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object484"}}},"x-examples":null,"x-deprecation-warning":null},"patch":{"summary":"Update some attributes of this service report","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of this report.","type":"integer"},{"name":"Object486","in":"body","schema":{"$ref":"#/definitions/Object486"},"required":false}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object484"}}},"x-examples":null,"x-deprecation-warning":null}},"/reports/services":{"post":{"summary":"Create a service report","description":null,"deprecated":false,"parameters":[{"name":"Object485","in":"body","schema":{"$ref":"#/definitions/Object485"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object484"}}},"x-examples":null,"x-deprecation-warning":null}},"/reports/services/{id}/shares":{"get":{"summary":"List users and groups permissioned on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object9"}}}},"x-examples":null,"x-deprecation-warning":null}},"/reports/services/{id}/shares/users":{"put":{"summary":"Set the permissions users have on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"Object487","in":"body","schema":{"$ref":"#/definitions/Object487"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object9"}}},"x-examples":null,"x-deprecation-warning":null}},"/reports/services/{id}/shares/users/{user_id}":{"delete":{"summary":"Revoke the permissions a user has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"user_id","in":"path","required":true,"description":"The ID of the user.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/reports/services/{id}/shares/groups":{"put":{"summary":"Set the permissions groups has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"Object488","in":"body","schema":{"$ref":"#/definitions/Object488"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object9"}}},"x-examples":null,"x-deprecation-warning":null}},"/reports/services/{id}/shares/groups/{group_id}":{"delete":{"summary":"Revoke the permissions a group has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"group_id","in":"path","required":true,"description":"The ID of the group.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/reports/services/{id}/dependencies":{"get":{"summary":"List dependent objects for this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"user_id","in":"query","required":false,"description":"ID of target user","type":"integer"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object15"}}}},"x-examples":null,"x-deprecation-warning":null}},"/reports/services/{id}/transfer":{"put":{"summary":"Transfer ownership of this object to another user","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"Object489","in":"body","schema":{"$ref":"#/definitions/Object489"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object17"}}},"x-examples":null,"x-deprecation-warning":null}},"/reports/services/{id}/projects":{"get":{"summary":"List the projects a Service Report belongs to","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Service Report.","type":"integer"},{"name":"hidden","in":"query","required":false,"description":"If specified to be true, returns hidden items. Defaults to false, returning non-hidden items.","type":"boolean"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object85"}}}},"x-examples":null,"x-deprecation-warning":null}},"/reports/services/{id}/projects/{project_id}":{"put":{"summary":"Add a Service Report to a project","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Service Report.","type":"integer"},{"name":"project_id","in":"path","required":true,"description":"The ID of the project.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null},"delete":{"summary":"Remove a Service Report from a project","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Service Report.","type":"integer"},{"name":"project_id","in":"path","required":true,"description":"The ID of the project.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/reports/services/{id}/archive":{"put":{"summary":"Update the archive status of this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the object.","type":"integer"},{"name":"Object490","in":"body","schema":{"$ref":"#/definitions/Object490"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object484"}}},"x-examples":null,"x-deprecation-warning":null}},"/reports/{id}/refresh":{"post":{"summary":"Refresh the data in this Tableau report","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of this report.","type":"integer"}],"responses":{"202":{"description":"success","schema":{"$ref":"#/definitions/Object491"}}},"x-examples":[{"resource":"Report","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/reports/:id/refresh","description":"Refresh the data in a Tableau report","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/reports/30/refresh","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer di6K2UpxsKQKPqo8GK2vJNL4BN52AM6MUBAq9OVj0Ys","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":202,"response_status_text":"Accepted","response_body":"{\n \"id\": 30,\n \"organization\": {\n \"id\": 21,\n \"tableauRefreshUsage\": 0,\n \"tableauRefreshLimit\": 5000,\n \"tableauRefreshHistory\": [\n {\n \"time_period\": \"2019-01\",\n \"usage\": 0\n },\n {\n \"time_period\": \"2018-12\",\n \"usage\": 0\n }\n ]\n }\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","X-Request-Id":"de23c92a-6d86-4a48-ab74-dfa7f3e091e5","X-Runtime":"0.044789","Content-Length":"183"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/reports/30/refresh\" -d '' -X POST \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer di6K2UpxsKQKPqo8GK2vJNL4BN52AM6MUBAq9OVj0Ys\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Report","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/reports/:id/refresh","description":"For a report with no data sources","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/reports/33/refresh","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer mbAjIvz4iR7-H_LhOJKmrWOGX7il4TZTa-tyqSr_Nnc","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":502,"response_status_text":"Bad Gateway","response_body":"{\n \"error\": \"refresh_failed\",\n \"errorDescription\": \"Tableau was unable to schedule a manual refresh. This workbook may not have associated data sources.\",\n \"code\": 502\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","X-Request-Id":"fc519fb6-5578-4a63-ba27-7e0de379d4fa","X-Runtime":"0.047650","Content-Length":"159"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/reports/33/refresh\" -d '' -X POST \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer mbAjIvz4iR7-H_LhOJKmrWOGX7il4TZTa-tyqSr_Nnc\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Report","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/reports/:id/refresh","description":"For an organization over its refresh limit","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/reports/36/refresh","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer x5RBjRGWq5Z1jOPrQKwXm0qO1RmqhjBWneSCcKe21sE","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":403,"response_status_text":"Forbidden","response_body":"{\n \"error\": \"refresh_limit\",\n \"errorDescription\": \"Organization's refresh limit has been reached. Contact your organization manager or client success to consider increasing this limit.\",\n \"code\": 403\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","X-Request-Id":"d5a6b098-494a-4d29-a65c-8096f12456c3","X-Runtime":"0.028620","Content-Length":"191"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/reports/36/refresh\" -d '' -X POST \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer x5RBjRGWq5Z1jOPrQKwXm0qO1RmqhjBWneSCcKe21sE\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/reports/sql":{"post":{"summary":"Create a SQL report","description":null,"deprecated":false,"parameters":[{"name":"Object493","in":"body","schema":{"$ref":"#/definitions/Object493"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object494"}}},"x-examples":null,"x-deprecation-warning":null}},"/reports/sql/{id}":{"get":{"summary":"Get a single SQL report","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of this report.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object494"}}},"x-examples":null,"x-deprecation-warning":null},"patch":{"summary":"Update a SQL report","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of this report.","type":"integer"},{"name":"Object496","in":"body","schema":{"$ref":"#/definitions/Object496"},"required":false}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object494"}}},"x-examples":null,"x-deprecation-warning":null}},"/reports/sql/{id}/refresh":{"post":{"summary":"Refresh the data in a SQL report","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of this report.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object494"}}},"x-examples":null,"x-deprecation-warning":null}},"/reports/sql/{id}/shares":{"get":{"summary":"List users and groups permissioned on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object9"}}}},"x-examples":null,"x-deprecation-warning":null}},"/reports/sql/{id}/shares/users":{"put":{"summary":"Set the permissions users have on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"Object497","in":"body","schema":{"$ref":"#/definitions/Object497"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object9"}}},"x-examples":null,"x-deprecation-warning":null}},"/reports/sql/{id}/shares/users/{user_id}":{"delete":{"summary":"Revoke the permissions a user has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"user_id","in":"path","required":true,"description":"The ID of the user.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/reports/sql/{id}/shares/groups":{"put":{"summary":"Set the permissions groups has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"Object498","in":"body","schema":{"$ref":"#/definitions/Object498"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object9"}}},"x-examples":null,"x-deprecation-warning":null}},"/reports/sql/{id}/shares/groups/{group_id}":{"delete":{"summary":"Revoke the permissions a group has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"group_id","in":"path","required":true,"description":"The ID of the group.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/reports/sql/{id}/dependencies":{"get":{"summary":"List dependent objects for this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"user_id","in":"query","required":false,"description":"ID of target user","type":"integer"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object15"}}}},"x-examples":null,"x-deprecation-warning":null}},"/reports/sql/{id}/transfer":{"put":{"summary":"Transfer ownership of this object to another user","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"Object499","in":"body","schema":{"$ref":"#/definitions/Object499"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object17"}}},"x-examples":null,"x-deprecation-warning":null}},"/reports/sql/{id}/projects":{"get":{"summary":"List the projects a SQL Report belongs to","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the SQL Report.","type":"integer"},{"name":"hidden","in":"query","required":false,"description":"If specified to be true, returns hidden items. Defaults to false, returning non-hidden items.","type":"boolean"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object85"}}}},"x-examples":null,"x-deprecation-warning":null}},"/reports/sql/{id}/projects/{project_id}":{"put":{"summary":"Add a SQL Report to a project","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the SQL Report.","type":"integer"},{"name":"project_id","in":"path","required":true,"description":"The ID of the project.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null},"delete":{"summary":"Remove a SQL Report from a project","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the SQL Report.","type":"integer"},{"name":"project_id","in":"path","required":true,"description":"The ID of the project.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/reports/sql/{id}/archive":{"put":{"summary":"Update the archive status of this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the object.","type":"integer"},{"name":"Object500","in":"body","schema":{"$ref":"#/definitions/Object500"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object494"}}},"x-examples":null,"x-deprecation-warning":null}},"/roles/":{"get":{"summary":"List Roles","description":null,"deprecated":false,"parameters":[{"name":"limit","in":"query","required":false,"description":"Number of results to return. Defaults to 50. Maximum allowed is 1000.","type":"integer"},{"name":"page_num","in":"query","required":false,"description":"Page number of the results to return. Defaults to the first page, 1.","type":"integer"},{"name":"order","in":"query","required":false,"description":"The field on which to order the result set. Defaults to id. Must be one of: id.","type":"string"},{"name":"order_dir","in":"query","required":false,"description":"Direction in which to sort, either asc (ascending) or desc (descending) defaulting to asc.","type":"string"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object501"}}}},"x-examples":[{"resource":"Roles","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/roles","description":"List roles visible to the current user","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/roles","request_body":null,"request_headers":{"Content-Type":"application/json","Authorization":"Bearer Fc8UWP9XvtFfswTIBlY1NQjtMI1zrry98NGOSmK1kSg","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 1,\n \"name\": \"Standard Data Management\",\n \"slug\": \"sdm\",\n \"description\": null\n },\n {\n \"id\": 2,\n \"name\": \"Civis Staff\",\n \"slug\": \"cstaff\",\n \"description\": null\n },\n {\n \"id\": 3,\n \"name\": \"User Creator\",\n \"slug\": \"uc\",\n \"description\": null\n },\n {\n \"id\": 4,\n \"name\": \"Group Creator\",\n \"slug\": \"gc\",\n \"description\": null\n },\n {\n \"id\": 5,\n \"name\": \"User Maintenance\",\n \"slug\": \"um\",\n \"description\": null\n },\n {\n \"id\": 6,\n \"name\": \"Org Group Manager Override\",\n \"slug\": \"ogmo\",\n \"description\": null\n },\n {\n \"id\": 7,\n \"name\": \"Can Enable Superadmin Mode\",\n \"slug\": \"cesm\",\n \"description\": null\n },\n {\n \"id\": 8,\n \"name\": \"Table Tag Admin\",\n \"slug\": \"tta\",\n \"description\": null\n },\n {\n \"id\": 9,\n \"name\": \"Report Viewer\",\n \"slug\": \"rv\",\n \"description\": null\n },\n {\n \"id\": 10,\n \"name\": \"Auto-Grant Trusted\",\n \"slug\": \"agt\",\n \"description\": null\n },\n {\n \"id\": 11,\n \"name\": \"Standard User\",\n \"slug\": \"standard_user\",\n \"description\": null\n },\n {\n \"id\": 12,\n \"name\": \"Custom Visualizations\",\n \"slug\": \"cusviz\",\n \"description\": null\n },\n {\n \"id\": 13,\n \"name\": \"Modeling\",\n \"slug\": \"mdl\",\n \"description\": null\n },\n {\n \"id\": 14,\n \"name\": \"Custom Scripts\",\n \"slug\": \"cusscr\",\n \"description\": null\n },\n {\n \"id\": 15,\n \"name\": \"Team Admin\",\n \"slug\": \"team_admin\",\n \"description\": null\n },\n {\n \"id\": 16,\n \"name\": \"Organization Admin\",\n \"slug\": \"org_admin\",\n \"description\": null\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","X-Pagination-Per-Page":"50","Access-Control-Expose-Headers":"X-Pagination-Per-Page, X-Pagination-Current-Page, X-Pagination-Total-Pages, X-Pagination-Total-Entries","X-Pagination-Current-Page":"1","X-Pagination-Total-Pages":"1","X-Pagination-Total-Entries":"16","Content-Type":"application/json; charset=utf-8","ETag":"W/\"ce308b10d644a2ea23ce547a8b772ee0\"","X-Request-Id":"bfa66837-2167-4db6-a8b8-f705995f71b7","X-Runtime":"0.016044","Content-Length":"1112"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/roles\" -X GET \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer Fc8UWP9XvtFfswTIBlY1NQjtMI1zrry98NGOSmK1kSg\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/scripts/types":{"get":{"summary":"List available script types","description":null,"deprecated":false,"parameters":[],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object520"}}}},"x-examples":[{"resource":"Scripts","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/scripts/types","description":"List all types","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/scripts/types","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer BCtFanjgno2HEk_PPq7PviCzKIzVi0fEOqRsB19oGKs","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"name\": \"sql\"\n },\n {\n \"name\": \"python3\"\n },\n {\n \"name\": \"javascript\"\n },\n {\n \"name\": \"r\"\n },\n {\n \"name\": \"containers\"\n },\n {\n \"name\": \"dbt\"\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"613065e885b2eb4bec91adf8a3227d61\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"cfdc8282-3a13-4179-8aa6-2622d6422bf8","X-Runtime":"0.045219","Content-Length":"107"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/scripts/types\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer BCtFanjgno2HEk_PPq7PviCzKIzVi0fEOqRsB19oGKs\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/scripts/{id}/history":{"get":{"summary":"Get the run history and outputs of this script","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID for the script.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object521"}}},"x-examples":[{"resource":"Scripts","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/scripts/:id/history","description":"View a script's run history","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/scripts/2275/history","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer 6bAGG4tfoDtZ2OZuvlNiTtjjLYDvEI3uJxcbk_2tdsM","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 193,\n \"sqlId\": 2275,\n \"state\": \"failed\",\n \"isCancelRequested\": false,\n \"finishedAt\": \"2024-12-03T20:45:44.000Z\",\n \"error\": \"silly error\",\n \"output\": [\n\n ]\n },\n {\n \"id\": 192,\n \"sqlId\": 2275,\n \"state\": \"succeeded\",\n \"isCancelRequested\": false,\n \"finishedAt\": \"2024-12-03T19:45:44.000Z\",\n \"error\": null,\n \"output\": [\n {\n \"outputName\": \"output_file\",\n \"fileId\": 45,\n \"path\": \"http://aws/file.csv\"\n }\n ]\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"49359aa3c394e8a209660f3542a890ef\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"acb12ec3-d0ef-4f6f-b205-4d934a60f511","X-Runtime":"0.033998","Content-Length":"346"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/scripts/2275/history\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer 6bAGG4tfoDtZ2OZuvlNiTtjjLYDvEI3uJxcbk_2tdsM\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/scripts/":{"post":{"summary":"Create a script (legacy)","description":"Deprecated endpoint for creating SQL Scripts. Please use POST scripts/sql instead.","deprecated":false,"parameters":[{"name":"Object523","in":"body","schema":{"$ref":"#/definitions/Object523"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object525"}}},"x-examples":[{"resource":"Scripts","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/scripts","description":"Create a script","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/scripts","request_body":"{\n \"name\": \"My new script\",\n \"remote_host_id\": 221,\n \"credential_id\": 604,\n \"sql\": \"select * from tablename\",\n \"notifications\": {\n \"success_email_addresses\": \"test1@civisanalytics.com\",\n \"failure_email_addresses\": \"test2@civisanalytics.com\"\n }\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer 5sQV_7CbsTdWM4VCzbO48DwKWyCpBvpexxPHaO5Et1k","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 2284,\n \"name\": \"My new script\",\n \"type\": \"SQL\",\n \"createdAt\": \"2024-12-03T19:45:45.000Z\",\n \"updatedAt\": \"2024-12-03T19:45:45.000Z\",\n \"author\": {\n \"id\": 2338,\n \"name\": \"User devuserfactory1888 1888\",\n \"username\": \"devuserfactory1888\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"state\": \"idle\",\n \"finishedAt\": null,\n \"category\": \"script\",\n \"projects\": [\n\n ],\n \"parentId\": null,\n \"userContext\": \"runner\",\n \"params\": [\n\n ],\n \"arguments\": {\n },\n \"isTemplate\": false,\n \"publishedAsTemplateId\": null,\n \"fromTemplateId\": null,\n \"templateDependentsCount\": null,\n \"templateScriptName\": null,\n \"links\": {\n \"details\": \"api.civis.test/scripts/sql/2284\",\n \"runs\": \"api.civis.test/scripts/sql/2284/runs\"\n },\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n },\n \"notifications\": {\n \"urls\": [\n\n ],\n \"successEmailSubject\": null,\n \"successEmailBody\": null,\n \"successEmailAddresses\": [\n \"test1@civisanalytics.com\"\n ],\n \"successEmailFromName\": null,\n \"successEmailReplyTo\": null,\n \"failureEmailAddresses\": [\n \"test2@civisanalytics.com\"\n ],\n \"stallWarningMinutes\": null,\n \"successOn\": true,\n \"failureOn\": true\n },\n \"runningAs\": {\n \"id\": 2338,\n \"name\": \"User devuserfactory1888 1888\",\n \"username\": \"devuserfactory1888\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"nextRunAt\": null,\n \"timeZone\": \"America/Chicago\",\n \"lastRun\": null,\n \"myPermissionLevel\": \"manage\",\n \"hidden\": false,\n \"targetProjectId\": null,\n \"archived\": false,\n \"templateScriptId\": null\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"b9776c5fa2b5196b3619e77fb107bb38\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"7fcaecf7-a5e3-4e13-a7af-9cd21367e6d3","X-Runtime":"0.105227","Content-Length":"1345"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/scripts\" -d '{\"name\":\"My new script\",\"remote_host_id\":221,\"credential_id\":604,\"sql\":\"select * from tablename\",\"notifications\":{\"success_email_addresses\":\"test1@civisanalytics.com\",\"failure_email_addresses\":\"test2@civisanalytics.com\"}}' -X POST \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer 5sQV_7CbsTdWM4VCzbO48DwKWyCpBvpexxPHaO5Et1k\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Scripts","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/scripts","description":"Create a script with params","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/scripts","request_body":"{\n \"name\": \"My new template script\",\n \"remote_host_id\": 224,\n \"credential_id\": 613,\n \"params\": [\n {\n \"name\": \"numb\",\n \"label\": \"Number\",\n \"description\": null,\n \"type\": \"integer\",\n \"required\": true,\n \"value\": null,\n \"default\": null,\n \"allowedValues\": []\n }\n ],\n \"arguments\": {\n \"numb\": 2\n },\n \"sql\": \"Select {{ numb }};\"\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer PbXz4VXVNH6UyquuhPKfkjBI4AuC8u5FlLgargzwEr4","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 2291,\n \"name\": \"My new template script\",\n \"type\": \"SQL\",\n \"createdAt\": \"2024-12-03T19:45:46.000Z\",\n \"updatedAt\": \"2024-12-03T19:45:46.000Z\",\n \"author\": {\n \"id\": 2345,\n \"name\": \"User devuserfactory1894 1894\",\n \"username\": \"devuserfactory1894\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"state\": \"idle\",\n \"finishedAt\": null,\n \"category\": \"script\",\n \"projects\": [\n\n ],\n \"parentId\": null,\n \"userContext\": \"runner\",\n \"params\": [\n {\n \"name\": \"numb\",\n \"label\": \"Number\",\n \"description\": null,\n \"type\": \"integer\",\n \"required\": true,\n \"value\": null,\n \"default\": null,\n \"allowedValues\": [\n\n ]\n }\n ],\n \"arguments\": {\n \"numb\": 2\n },\n \"isTemplate\": false,\n \"publishedAsTemplateId\": null,\n \"fromTemplateId\": null,\n \"templateDependentsCount\": null,\n \"templateScriptName\": null,\n \"links\": {\n \"details\": \"api.civis.test/scripts/sql/2291\",\n \"runs\": \"api.civis.test/scripts/sql/2291/runs\"\n },\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n },\n \"notifications\": {\n \"urls\": [\n\n ],\n \"successEmailSubject\": null,\n \"successEmailBody\": null,\n \"successEmailAddresses\": [\n\n ],\n \"successEmailFromName\": null,\n \"successEmailReplyTo\": null,\n \"failureEmailAddresses\": [\n\n ],\n \"stallWarningMinutes\": null,\n \"successOn\": true,\n \"failureOn\": true\n },\n \"runningAs\": {\n \"id\": 2345,\n \"name\": \"User devuserfactory1894 1894\",\n \"username\": \"devuserfactory1894\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"nextRunAt\": null,\n \"timeZone\": \"America/Chicago\",\n \"lastRun\": null,\n \"myPermissionLevel\": \"manage\",\n \"hidden\": false,\n \"targetProjectId\": null,\n \"archived\": false,\n \"templateScriptId\": null\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"af803e54c7e098b260d1bd0990db63af\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"0f0d57bc-1339-42d0-8f1a-0307d1d7c9ba","X-Runtime":"0.096431","Content-Length":"1441"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/scripts\" -d '{\"name\":\"My new template script\",\"remote_host_id\":224,\"credential_id\":613,\"params\":[{\"name\":\"numb\",\"label\":\"Number\",\"description\":null,\"type\":\"integer\",\"required\":true,\"value\":null,\"default\":null,\"allowedValues\":[]}],\"arguments\":{\"numb\":2},\"sql\":\"Select {{ numb }};\"}' -X POST \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer PbXz4VXVNH6UyquuhPKfkjBI4AuC8u5FlLgargzwEr4\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"get":{"summary":"List Scripts","description":null,"deprecated":false,"parameters":[{"name":"type","in":"query","required":false,"description":"If specified, return items of these types. The valid types are sql, python3, javascript, r, containers, and dbt.","type":"string"},{"name":"category","in":"query","required":false,"description":"A job category for filtering scripts. Must be one of script, import, export, and enhancement.","type":"string"},{"name":"author","in":"query","required":false,"description":"If specified, return items from any of these authors. It accepts a comma-separated list of user IDs.","type":"string"},{"name":"status","in":"query","required":false,"description":"If specified, returns items with one of these statuses. It accepts a comma-separated list, possible values are 'running', 'failed', 'succeeded', 'idle', 'scheduled'.","type":"string"},{"name":"hidden","in":"query","required":false,"description":"If specified to be true, returns hidden items. Defaults to false, returning non-hidden items.","type":"boolean"},{"name":"archived","in":"query","required":false,"description":"The archival status of the requested item(s).","type":"string"},{"name":"limit","in":"query","required":false,"description":"Number of results to return. Defaults to 20. Maximum allowed is 50.","type":"integer"},{"name":"page_num","in":"query","required":false,"description":"Page number of the results to return. Defaults to the first page, 1.","type":"integer"},{"name":"order","in":"query","required":false,"description":"The field on which to order the result set. Defaults to updated_at. Must be one of: updated_at, name, created_at, last_run.updated_at.","type":"string"},{"name":"order_dir","in":"query","required":false,"description":"Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc.","type":"string"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object542"}}}},"x-examples":[{"resource":"Scripts","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/scripts","description":"List all scripts","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/scripts","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer J67XqylSKznwsEm3CEGrOuWu5twgecz1yAe2FKOjRKw","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 2014,\n \"name\": \"Script #2014\",\n \"type\": \"SQL\",\n \"createdAt\": \"2024-12-03T19:45:18.000Z\",\n \"updatedAt\": \"2024-12-03T19:45:18.000Z\",\n \"author\": {\n \"id\": 2086,\n \"name\": \"User devuserfactory1677 1677\",\n \"username\": \"devuserfactory1677\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"state\": \"idle\",\n \"finishedAt\": null,\n \"projects\": [\n\n ],\n \"parentId\": null,\n \"isTemplate\": false,\n \"fromTemplateId\": null,\n \"links\": {\n \"details\": \"api.civis.test/scripts/sql/2014\",\n \"runs\": \"api.civis.test/scripts/sql/2014/runs\"\n },\n \"timeZone\": \"America/Chicago\",\n \"lastRun\": null,\n \"archived\": false,\n \"templateScriptId\": null\n },\n {\n \"id\": 2012,\n \"name\": \"Script #2012\",\n \"type\": \"SQL\",\n \"createdAt\": \"2024-12-03T19:45:18.000Z\",\n \"updatedAt\": \"2024-12-03T19:45:17.000Z\",\n \"author\": {\n \"id\": 2086,\n \"name\": \"User devuserfactory1677 1677\",\n \"username\": \"devuserfactory1677\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"state\": \"running\",\n \"finishedAt\": \"2024-12-03T19:45:18.000Z\",\n \"projects\": [\n {\n \"id\": 6,\n \"name\": \"Test Project\"\n }\n ],\n \"parentId\": null,\n \"isTemplate\": false,\n \"fromTemplateId\": null,\n \"links\": {\n \"details\": \"api.civis.test/scripts/sql/2012\",\n \"runs\": \"api.civis.test/scripts/sql/2012/runs\"\n },\n \"timeZone\": \"America/Chicago\",\n \"lastRun\": {\n \"id\": 174,\n \"state\": \"running\",\n \"createdAt\": \"2024-12-03T19:45:18.000Z\",\n \"startedAt\": null,\n \"finishedAt\": \"2024-12-03T19:45:18.000Z\",\n \"error\": null\n },\n \"archived\": false,\n \"templateScriptId\": null\n },\n {\n \"id\": 2017,\n \"name\": \"Script #2017\",\n \"type\": \"Container\",\n \"createdAt\": \"2024-12-03T19:45:18.000Z\",\n \"updatedAt\": \"2024-12-03T19:44:18.000Z\",\n \"author\": {\n \"id\": 2086,\n \"name\": \"User devuserfactory1677 1677\",\n \"username\": \"devuserfactory1677\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"state\": \"idle\",\n \"finishedAt\": null,\n \"projects\": [\n\n ],\n \"parentId\": null,\n \"isTemplate\": false,\n \"fromTemplateId\": null,\n \"links\": {\n \"details\": \"api.civis.test/scripts/containers/2017\",\n \"runs\": \"api.civis.test/scripts/containers/2017/runs\"\n },\n \"timeZone\": \"America/Chicago\",\n \"lastRun\": null,\n \"archived\": false,\n \"templateScriptId\": null\n },\n {\n \"id\": 2020,\n \"name\": \"Script #2020\",\n \"type\": \"Python\",\n \"createdAt\": \"2024-12-03T19:45:18.000Z\",\n \"updatedAt\": \"2024-12-03T19:43:18.000Z\",\n \"author\": {\n \"id\": 2086,\n \"name\": \"User devuserfactory1677 1677\",\n \"username\": \"devuserfactory1677\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"state\": \"idle\",\n \"finishedAt\": null,\n \"projects\": [\n\n ],\n \"parentId\": null,\n \"isTemplate\": false,\n \"fromTemplateId\": null,\n \"links\": {\n \"details\": \"api.civis.test/scripts/python3/2020\",\n \"runs\": \"api.civis.test/scripts/python3/2020/runs\"\n },\n \"timeZone\": \"America/Chicago\",\n \"lastRun\": null,\n \"archived\": false,\n \"templateScriptId\": null\n },\n {\n \"id\": 2023,\n \"name\": \"Script #2023\",\n \"type\": \"R\",\n \"createdAt\": \"2024-12-03T19:45:18.000Z\",\n \"updatedAt\": \"2024-12-03T19:42:18.000Z\",\n \"author\": {\n \"id\": 2086,\n \"name\": \"User devuserfactory1677 1677\",\n \"username\": \"devuserfactory1677\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"state\": \"idle\",\n \"finishedAt\": null,\n \"projects\": [\n\n ],\n \"parentId\": null,\n \"isTemplate\": false,\n \"fromTemplateId\": null,\n \"links\": {\n \"details\": \"api.civis.test/scripts/r/2023\",\n \"runs\": \"api.civis.test/scripts/r/2023/runs\"\n },\n \"timeZone\": \"America/Chicago\",\n \"lastRun\": null,\n \"archived\": false,\n \"templateScriptId\": null\n },\n {\n \"id\": 2025,\n \"name\": \"Script #2025\",\n \"type\": \"JavaScript\",\n \"createdAt\": \"2024-12-03T19:45:19.000Z\",\n \"updatedAt\": \"2024-12-03T19:41:18.000Z\",\n \"author\": {\n \"id\": 2086,\n \"name\": \"User devuserfactory1677 1677\",\n \"username\": \"devuserfactory1677\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"state\": \"idle\",\n \"finishedAt\": null,\n \"projects\": [\n\n ],\n \"parentId\": null,\n \"isTemplate\": false,\n \"fromTemplateId\": null,\n \"links\": {\n \"details\": \"api.civis.test/scripts/javascript/2025\",\n \"runs\": \"api.civis.test/scripts/javascript/2025/runs\"\n },\n \"timeZone\": \"America/Chicago\",\n \"lastRun\": null,\n \"archived\": false,\n \"templateScriptId\": null\n },\n {\n \"id\": 2028,\n \"name\": \"Script #2028\",\n \"type\": \"Python\",\n \"createdAt\": \"2024-12-03T19:45:19.000Z\",\n \"updatedAt\": \"2024-12-03T19:40:19.000Z\",\n \"author\": {\n \"id\": 2098,\n \"name\": \"User devuserfactory1689 1689\",\n \"username\": \"devuserfactory1689\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"state\": \"idle\",\n \"finishedAt\": null,\n \"projects\": [\n\n ],\n \"parentId\": null,\n \"isTemplate\": false,\n \"fromTemplateId\": null,\n \"links\": {\n \"details\": \"api.civis.test/scripts/python3/2028\",\n \"runs\": \"api.civis.test/scripts/python3/2028/runs\"\n },\n \"timeZone\": \"America/Chicago\",\n \"lastRun\": null,\n \"archived\": false,\n \"templateScriptId\": null\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","X-Pagination-Per-Page":"20","Access-Control-Expose-Headers":"X-Pagination-Per-Page, X-Pagination-Current-Page, X-Pagination-Total-Pages, X-Pagination-Total-Entries","X-Pagination-Current-Page":"1","X-Pagination-Total-Pages":"1","X-Pagination-Total-Entries":"7","Content-Type":"application/json; charset=utf-8","ETag":"W/\"325b141b9d40f7b48852532064abbb10\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"825e6dae-368f-44e6-93da-c2eed8bf384d","X-Runtime":"0.072037","Content-Length":"3991"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/scripts\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer J67XqylSKznwsEm3CEGrOuWu5twgecz1yAe2FKOjRKw\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Scripts","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/scripts","description":"Filter scripts by author","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/scripts?author=2115","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer 6rqtXiOB1cflOrRsXytywh-vp13YCZr0K9cLfOt9x_4","Host":"api.civis.test","Cookie":""},"request_query_parameters":{"author":"2115"},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 2048,\n \"name\": \"Script #2048\",\n \"type\": \"Python\",\n \"createdAt\": \"2024-12-03T19:45:20.000Z\",\n \"updatedAt\": \"2024-12-03T19:40:20.000Z\",\n \"author\": {\n \"id\": 2115,\n \"name\": \"User devuserfactory1705 1705\",\n \"username\": \"devuserfactory1705\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"state\": \"idle\",\n \"finishedAt\": null,\n \"projects\": [\n\n ],\n \"parentId\": null,\n \"isTemplate\": false,\n \"fromTemplateId\": null,\n \"links\": {\n \"details\": \"api.civis.test/scripts/python3/2048\",\n \"runs\": \"api.civis.test/scripts/python3/2048/runs\"\n },\n \"timeZone\": \"America/Chicago\",\n \"lastRun\": null,\n \"archived\": false,\n \"templateScriptId\": null\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","X-Pagination-Per-Page":"20","Access-Control-Expose-Headers":"X-Pagination-Per-Page, X-Pagination-Current-Page, X-Pagination-Total-Pages, X-Pagination-Total-Entries","X-Pagination-Current-Page":"1","X-Pagination-Total-Pages":"1","X-Pagination-Total-Entries":"1","Content-Type":"application/json; charset=utf-8","ETag":"W/\"da0b7368d6fe3973ac5b26f19cacf577\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"ec5f1406-250f-403b-9165-8acf9fc68600","X-Runtime":"0.033179","Content-Length":"547"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/scripts?author=2115\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer 6rqtXiOB1cflOrRsXytywh-vp13YCZr0K9cLfOt9x_4\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Scripts","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/scripts","description":"Filter scripts by type","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/scripts?type=r","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer Kj3RI-nXjlK46nWJT7QdESl28vXUUjztMreaDLYPY1U","Host":"api.civis.test","Cookie":""},"request_query_parameters":{"type":"r"},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 2063,\n \"name\": \"Script #2063\",\n \"type\": \"R\",\n \"createdAt\": \"2024-12-03T19:45:22.000Z\",\n \"updatedAt\": \"2024-12-03T19:42:22.000Z\",\n \"author\": {\n \"id\": 2120,\n \"name\": \"User devuserfactory1709 1709\",\n \"username\": \"devuserfactory1709\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"state\": \"idle\",\n \"finishedAt\": null,\n \"projects\": [\n\n ],\n \"parentId\": null,\n \"isTemplate\": false,\n \"fromTemplateId\": null,\n \"links\": {\n \"details\": \"api.civis.test/scripts/r/2063\",\n \"runs\": \"api.civis.test/scripts/r/2063/runs\"\n },\n \"timeZone\": \"America/Chicago\",\n \"lastRun\": null,\n \"archived\": false,\n \"templateScriptId\": null\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","X-Pagination-Per-Page":"20","Access-Control-Expose-Headers":"X-Pagination-Per-Page, X-Pagination-Current-Page, X-Pagination-Total-Pages, X-Pagination-Total-Entries","X-Pagination-Current-Page":"1","X-Pagination-Total-Pages":"1","X-Pagination-Total-Entries":"1","Content-Type":"application/json; charset=utf-8","ETag":"W/\"60fe8e60297dfd0af45f8d9361f6f25f\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"26c393c9-f7da-46eb-9b7c-20dc3c72c912","X-Runtime":"0.032498","Content-Length":"530"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/scripts?type=r\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer Kj3RI-nXjlK46nWJT7QdESl28vXUUjztMreaDLYPY1U\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Scripts","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/scripts","description":"Filter scripts by status","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/scripts?status=running","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer U6YEBHkJYyQAdaux40E7zjFvPIKVwuduIdgWCVFbTZQ","Host":"api.civis.test","Cookie":""},"request_query_parameters":{"status":"running"},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 2072,\n \"name\": \"Script #2072\",\n \"type\": \"SQL\",\n \"createdAt\": \"2024-12-03T19:45:22.000Z\",\n \"updatedAt\": \"2024-12-03T19:45:22.000Z\",\n \"author\": {\n \"id\": 2137,\n \"name\": \"User devuserfactory1725 1725\",\n \"username\": \"devuserfactory1725\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"state\": \"running\",\n \"finishedAt\": \"2024-12-03T19:45:22.000Z\",\n \"projects\": [\n {\n \"id\": 9,\n \"name\": \"Test Project\"\n }\n ],\n \"parentId\": null,\n \"isTemplate\": false,\n \"fromTemplateId\": null,\n \"links\": {\n \"details\": \"api.civis.test/scripts/sql/2072\",\n \"runs\": \"api.civis.test/scripts/sql/2072/runs\"\n },\n \"timeZone\": \"America/Chicago\",\n \"lastRun\": {\n \"id\": 177,\n \"state\": \"running\",\n \"createdAt\": \"2024-12-03T19:45:22.000Z\",\n \"startedAt\": null,\n \"finishedAt\": \"2024-12-03T19:45:22.000Z\",\n \"error\": null\n },\n \"archived\": false,\n \"templateScriptId\": null\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","X-Pagination-Per-Page":"20","Access-Control-Expose-Headers":"X-Pagination-Per-Page, X-Pagination-Current-Page, X-Pagination-Total-Pages, X-Pagination-Total-Entries","X-Pagination-Current-Page":"1","X-Pagination-Total-Pages":"1","X-Pagination-Total-Entries":"1","Content-Type":"application/json; charset=utf-8","ETag":"W/\"ac1ec961892e938a18947daef72e94dc\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"306beabd-de6a-49fc-93b0-ba1ada606e81","X-Runtime":"0.054492","Content-Length":"724"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/scripts?status=running\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer U6YEBHkJYyQAdaux40E7zjFvPIKVwuduIdgWCVFbTZQ\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Scripts","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/scripts?page_num=1&limit=2","description":"List all scripts ordered by updatedAt desc","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/scripts?page_num=1&limit=2","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer tjmngyqVI2bApfGTET1Ae7YhDEilRUG7ucPtptLrxvg","Host":"api.civis.test","Cookie":""},"request_query_parameters":{"page_num":"1","limit":"2"},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 2098,\n \"name\": \"Script #2098\",\n \"type\": \"SQL\",\n \"createdAt\": \"2024-12-03T19:45:25.000Z\",\n \"updatedAt\": \"2024-12-03T22:45:25.000Z\",\n \"author\": {\n \"id\": 2154,\n \"name\": \"User devuserfactory1741 1741\",\n \"username\": \"devuserfactory1741\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"state\": \"idle\",\n \"finishedAt\": null,\n \"projects\": [\n\n ],\n \"parentId\": null,\n \"isTemplate\": false,\n \"fromTemplateId\": null,\n \"links\": {\n \"details\": \"api.civis.test/scripts/sql/2098\",\n \"runs\": \"api.civis.test/scripts/sql/2098/runs\"\n },\n \"timeZone\": \"America/Chicago\",\n \"lastRun\": null,\n \"archived\": false,\n \"templateScriptId\": null\n },\n {\n \"id\": 2096,\n \"name\": \"Script #2096\",\n \"type\": \"SQL\",\n \"createdAt\": \"2024-12-03T19:45:25.000Z\",\n \"updatedAt\": \"2024-12-03T20:45:24.000Z\",\n \"author\": {\n \"id\": 2154,\n \"name\": \"User devuserfactory1741 1741\",\n \"username\": \"devuserfactory1741\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"state\": \"idle\",\n \"finishedAt\": null,\n \"projects\": [\n\n ],\n \"parentId\": null,\n \"isTemplate\": false,\n \"fromTemplateId\": null,\n \"links\": {\n \"details\": \"api.civis.test/scripts/sql/2096\",\n \"runs\": \"api.civis.test/scripts/sql/2096/runs\"\n },\n \"timeZone\": \"America/Chicago\",\n \"lastRun\": null,\n \"archived\": false,\n \"templateScriptId\": null\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","X-Pagination-Per-Page":"2","Access-Control-Expose-Headers":"X-Pagination-Per-Page, X-Pagination-Current-Page, X-Pagination-Total-Pages, X-Pagination-Total-Entries","X-Pagination-Current-Page":"1","X-Pagination-Total-Pages":"2","X-Pagination-Total-Entries":"4","Content-Type":"application/json; charset=utf-8","ETag":"W/\"d1f25ba7711200b66e21efec889086f1\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"baf15ff7-5bdd-44bb-b355-b160424321a7","X-Runtime":"0.038899","Content-Length":"1071"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/scripts?page_num=1&limit=2\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer tjmngyqVI2bApfGTET1Ae7YhDEilRUG7ucPtptLrxvg\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/scripts/{id}/run":{"post":{"summary":"Run a SQL script (legacy)","description":"Deprecated. Please use POST scripts/sql/:id/run instead.","deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID for the script.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":[{"resource":"Scripts","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/scripts/:id/run","description":"Run a script","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/scripts/2576/run","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer xcSlNzVRS1TdeaqGtAT95YndeYXZbBaanklR-bbVYd8","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":204,"response_status_text":"No Content","response_body":null,"response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"9aabd72f-4f29-404a-a917-f5c31844879d","X-Runtime":"0.166105"},"response_content_type":null,"curl":"curl \"api.civis.testhttp://api.civis.test/scripts/2576/run\" -d '' -X POST \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer xcSlNzVRS1TdeaqGtAT95YndeYXZbBaanklR-bbVYd8\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Scripts","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/scripts/:id/run","description":"Attempting to queue a running job returns an error","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/scripts/2582/run","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer 7rHqLZ3wlifGhkvP0JHts5nsgHfBbEXeXfLhCTvhlHo","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":409,"response_status_text":"Conflict","response_body":"{\n \"error\": \"conflict\",\n \"errorDescription\": \"The script cannot be queued because it is already active.\",\n \"code\": 409\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"e136dfed-75ee-425b-9fa8-b4b605c8ac6e","X-Runtime":"0.024608","Content-Length":"110"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/scripts/2582/run\" -d '' -X POST \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer 7rHqLZ3wlifGhkvP0JHts5nsgHfBbEXeXfLhCTvhlHo\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/scripts/{id}/cancel":{"post":{"summary":"Cancel a run","description":"Cancel a run.","deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the job.","type":"integer"}],"responses":{"202":{"description":"success","schema":{"$ref":"#/definitions/Object529"}}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/{id}":{"delete":{"summary":"Archive a script (deprecated, use archive endpoints instead)","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID for the script.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null},"get":{"summary":"Get details about a SQL script (legacy)","description":"Deprecated. Please use GET scripts/sql/:id instead.","deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID for the script.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object576"}}},"x-examples":[{"resource":"Scripts","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/scripts/:id","description":"View a script's details","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/scripts/2150","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer mjOYNwjFT1L_66u5iScTY_-W-2aBVTLCnBbAfkuhMjY","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 2150,\n \"name\": \"Script #2150\",\n \"type\": \"JobTypes::SqlRunner\",\n \"createdAt\": \"2024-12-03T19:45:30.000Z\",\n \"updatedAt\": \"2024-12-03T19:45:30.000Z\",\n \"author\": {\n \"id\": 2209,\n \"name\": \"User devuserfactory1783 1783\",\n \"username\": \"devuserfactory1783\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"state\": \"running\",\n \"finishedAt\": \"2024-12-03T19:45:30.000Z\",\n \"category\": \"script\",\n \"projects\": [\n {\n \"id\": 13,\n \"name\": \"Test Project\"\n }\n ],\n \"parentId\": null,\n \"userContext\": \"runner\",\n \"params\": [\n {\n \"name\": \"id\",\n \"label\": \"ID\",\n \"description\": null,\n \"type\": \"integer\",\n \"required\": true,\n \"value\": null,\n \"default\": null,\n \"allowedValues\": [\n\n ]\n },\n {\n \"name\": \"state\",\n \"label\": \"State\",\n \"description\": null,\n \"type\": \"string\",\n \"required\": true,\n \"value\": null,\n \"default\": null,\n \"allowedValues\": [\n\n ]\n },\n {\n \"name\": \"table\",\n \"label\": \"Table\",\n \"description\": null,\n \"type\": \"string\",\n \"required\": false,\n \"value\": null,\n \"default\": null,\n \"allowedValues\": [\n\n ]\n },\n {\n \"name\": \"abool\",\n \"label\": \"A Bool\",\n \"description\": null,\n \"type\": \"bool\",\n \"required\": false,\n \"value\": null,\n \"default\": false,\n \"allowedValues\": [\n\n ]\n },\n {\n \"name\": \"afloat\",\n \"label\": \"A Float\",\n \"description\": null,\n \"type\": \"float\",\n \"required\": false,\n \"value\": null,\n \"default\": null,\n \"allowedValues\": [\n\n ]\n },\n {\n \"name\": \"optionalstr\",\n \"label\": \"Optional String\",\n \"description\": null,\n \"type\": \"string\",\n \"required\": false,\n \"value\": null,\n \"default\": null,\n \"allowedValues\": [\n\n ]\n },\n {\n \"name\": \"cred\",\n \"label\": \"Cred\",\n \"description\": null,\n \"type\": \"credential_redshift\",\n \"required\": false,\n \"value\": null,\n \"default\": null,\n \"allowedValues\": [\n\n ]\n },\n {\n \"name\": \"cred2\",\n \"label\": \"Cred AWS\",\n \"description\": null,\n \"type\": \"credential_aws\",\n \"required\": false,\n \"value\": null,\n \"default\": null,\n \"allowedValues\": [\n\n ]\n }\n ],\n \"arguments\": {\n \"id\": 2,\n \"state\": \"IL\",\n \"table\": \"test.test\"\n },\n \"isTemplate\": false,\n \"publishedAsTemplateId\": null,\n \"fromTemplateId\": null,\n \"templateDependentsCount\": null,\n \"templateScriptName\": null,\n \"links\": {\n \"details\": \"api.civis.test/scripts/sql/2150\",\n \"runs\": \"api.civis.test/scripts/sql/2150/runs\"\n },\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n },\n \"notifications\": {\n \"urls\": [\n\n ],\n \"successEmailSubject\": \"success email subject\",\n \"successEmailBody\": \"success_email_template\",\n \"successEmailAddresses\": [\n \"script_spec_user@civisanalytics.com\"\n ],\n \"successEmailFromName\": null,\n \"successEmailReplyTo\": null,\n \"failureEmailAddresses\": [\n \"script_spec_user@civisanalytics.com\"\n ],\n \"stallWarningMinutes\": null,\n \"successOn\": true,\n \"failureOn\": true\n },\n \"runningAs\": {\n \"id\": 2209,\n \"name\": \"User devuserfactory1783 1783\",\n \"username\": \"devuserfactory1783\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"nextRunAt\": null,\n \"timeZone\": \"America/Chicago\",\n \"lastRun\": {\n \"id\": 181,\n \"state\": \"running\",\n \"createdAt\": \"2024-12-03T19:45:30.000Z\",\n \"startedAt\": null,\n \"finishedAt\": \"2024-12-03T19:45:30.000Z\",\n \"error\": null\n },\n \"myPermissionLevel\": \"manage\",\n \"hidden\": false,\n \"targetProjectId\": null,\n \"archived\": false,\n \"sql\": \"SELECT * FROM table LIMIT 10;\",\n \"expandedArguments\": {\n \"id\": 2,\n \"state\": \"IL\",\n \"state.literal\": \"'IL'\",\n \"state.identifier\": \"\\\"IL\\\"\",\n \"state.shell_escaped\": \"IL\",\n \"table\": \"test.test\",\n \"table.literal\": \"'test.test'\",\n \"table.identifier\": \"\\\"test.test\\\"\",\n \"table.shell_escaped\": \"test.test\",\n \"abool\": false,\n \"afloat\": 0,\n \"optionalstr\": \"\",\n \"optionalstr.literal\": \"''\",\n \"optionalstr.identifier\": \"\\\"\\\"\",\n \"optionalstr.shell_escaped\": \"''\",\n \"cred.id\": \"\",\n \"cred.username\": \"\",\n \"cred.password\": \"\",\n \"cred2.id\": \"\",\n \"cred2.access_key_id\": \"\",\n \"cred2.secret_access_key\": \"\"\n },\n \"templateScriptId\": null\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"1cf20be71b47205997d2ae0a0b55bf3b\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"6fa2180d-12f1-4554-bc3d-7cc5f0433cd8","X-Runtime":"0.046007","Content-Length":"3267"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/scripts/2150\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer mjOYNwjFT1L_66u5iScTY_-W-2aBVTLCnBbAfkuhMjY\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Scripts","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/scripts/:script_dependent_id","description":"View a script's details that is a template dependent","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/scripts/2166","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer APsCbI3VgF3J4SGI-4JsHircKiKRFWDvJv4w_JCrffQ","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 2166,\n \"name\": \"awesome sql template #2166\",\n \"type\": \"JobTypes::SqlRunner\",\n \"createdAt\": \"2024-12-03T19:45:32.000Z\",\n \"updatedAt\": \"2024-12-03T19:45:32.000Z\",\n \"author\": {\n \"id\": 2216,\n \"name\": \"User devuserfactory1789 1789\",\n \"username\": \"devuserfactory1789\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"state\": \"idle\",\n \"finishedAt\": null,\n \"category\": \"script\",\n \"projects\": [\n\n ],\n \"parentId\": null,\n \"userContext\": \"runner\",\n \"params\": [\n {\n \"name\": \"id\",\n \"label\": \"ID\",\n \"description\": null,\n \"type\": \"integer\",\n \"required\": true,\n \"value\": null,\n \"default\": null,\n \"allowedValues\": [\n\n ]\n },\n {\n \"name\": \"state\",\n \"label\": \"State\",\n \"description\": null,\n \"type\": \"string\",\n \"required\": true,\n \"value\": null,\n \"default\": null,\n \"allowedValues\": [\n\n ]\n },\n {\n \"name\": \"table\",\n \"label\": \"Table\",\n \"description\": null,\n \"type\": \"string\",\n \"required\": false,\n \"value\": null,\n \"default\": null,\n \"allowedValues\": [\n\n ]\n }\n ],\n \"arguments\": {\n \"id\": 2,\n \"state\": \"IL\",\n \"table\": \"test.test\"\n },\n \"isTemplate\": false,\n \"publishedAsTemplateId\": null,\n \"fromTemplateId\": 161,\n \"templateDependentsCount\": null,\n \"templateScriptName\": \"Script #2163\",\n \"links\": {\n \"details\": \"api.civis.test/scripts/custom/2166\",\n \"runs\": \"api.civis.test/scripts/custom/2166/runs\"\n },\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n },\n \"notifications\": {\n \"urls\": [\n\n ],\n \"successEmailSubject\": null,\n \"successEmailBody\": null,\n \"successEmailAddresses\": [\n\n ],\n \"successEmailFromName\": null,\n \"successEmailReplyTo\": null,\n \"failureEmailAddresses\": [\n\n ],\n \"stallWarningMinutes\": null,\n \"successOn\": true,\n \"failureOn\": true\n },\n \"runningAs\": {\n \"id\": 2216,\n \"name\": \"User devuserfactory1789 1789\",\n \"username\": \"devuserfactory1789\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"nextRunAt\": null,\n \"timeZone\": \"America/Chicago\",\n \"lastRun\": null,\n \"myPermissionLevel\": \"manage\",\n \"hidden\": false,\n \"targetProjectId\": null,\n \"archived\": false,\n \"sql\": \"select * from {{table}} where id = {{id}} and state = '{{state}}'\",\n \"expandedArguments\": {\n \"id\": 2,\n \"state\": \"IL\",\n \"state.literal\": \"'IL'\",\n \"state.identifier\": \"\\\"IL\\\"\",\n \"state.shell_escaped\": \"IL\",\n \"table\": \"test.test\",\n \"table.literal\": \"'test.test'\",\n \"table.identifier\": \"\\\"test.test\\\"\",\n \"table.shell_escaped\": \"test.test\"\n },\n \"templateScriptId\": null\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"0d69228f5ed2e6333dcca52f5fb60ac6\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"0be48b75-34de-469a-b779-97c6c1b04bd5","X-Runtime":"0.061341","Content-Length":"2077"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/scripts/2166\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer APsCbI3VgF3J4SGI-4JsHircKiKRFWDvJv4w_JCrffQ\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Scripts","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/scripts/:script_template_id","description":"View a script's details that is a template","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/scripts/2176","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer nLqigCCJSE5VplCLpjUQFMAWnBYnZCAjfFZBLHjSORw","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 2176,\n \"name\": \"Script #2176\",\n \"type\": \"JobTypes::SqlRunner\",\n \"createdAt\": \"2024-12-03T19:45:33.000Z\",\n \"updatedAt\": \"2024-12-03T19:45:33.000Z\",\n \"author\": {\n \"id\": 2229,\n \"name\": \"User devuserfactory1799 1799\",\n \"username\": \"devuserfactory1799\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"state\": \"idle\",\n \"finishedAt\": null,\n \"category\": \"script\",\n \"projects\": [\n\n ],\n \"parentId\": null,\n \"userContext\": \"runner\",\n \"params\": [\n {\n \"name\": \"id\",\n \"label\": \"ID\",\n \"description\": null,\n \"type\": \"integer\",\n \"required\": true,\n \"value\": null,\n \"default\": null,\n \"allowedValues\": [\n\n ]\n },\n {\n \"name\": \"state\",\n \"label\": \"State\",\n \"description\": null,\n \"type\": \"string\",\n \"required\": true,\n \"value\": null,\n \"default\": null,\n \"allowedValues\": [\n\n ]\n },\n {\n \"name\": \"table\",\n \"label\": \"Table\",\n \"description\": null,\n \"type\": \"string\",\n \"required\": false,\n \"value\": null,\n \"default\": null,\n \"allowedValues\": [\n\n ]\n }\n ],\n \"arguments\": {\n },\n \"isTemplate\": true,\n \"publishedAsTemplateId\": 162,\n \"fromTemplateId\": null,\n \"templateDependentsCount\": 1,\n \"templateScriptName\": null,\n \"links\": {\n \"details\": \"api.civis.test/scripts/sql/2176\",\n \"runs\": \"api.civis.test/scripts/sql/2176/runs\"\n },\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n },\n \"notifications\": {\n \"urls\": [\n\n ],\n \"successEmailSubject\": null,\n \"successEmailBody\": null,\n \"successEmailAddresses\": [\n\n ],\n \"successEmailFromName\": null,\n \"successEmailReplyTo\": null,\n \"failureEmailAddresses\": [\n\n ],\n \"stallWarningMinutes\": null,\n \"successOn\": true,\n \"failureOn\": true\n },\n \"runningAs\": {\n \"id\": 2229,\n \"name\": \"User devuserfactory1799 1799\",\n \"username\": \"devuserfactory1799\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"nextRunAt\": null,\n \"timeZone\": \"America/Chicago\",\n \"lastRun\": null,\n \"myPermissionLevel\": \"manage\",\n \"hidden\": false,\n \"targetProjectId\": null,\n \"archived\": false,\n \"sql\": \"select * from {{table}} where id = {{id}} and state = '{{state}}'\",\n \"expandedArguments\": {\n \"id\": null,\n \"state\": null,\n \"state.literal\": null,\n \"state.identifier\": null,\n \"state.shell_escaped\": null,\n \"table\": \"\",\n \"table.literal\": \"''\",\n \"table.identifier\": \"\\\"\\\"\",\n \"table.shell_escaped\": \"''\"\n },\n \"templateScriptId\": null\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"d2f6f515dfce665a57570ac91e215bef\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"6b1c06aa-1bbd-4fed-950d-4dd483768672","X-Runtime":"0.059276","Content-Length":"1967"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/scripts/2176\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer nLqigCCJSE5VplCLpjUQFMAWnBYnZCAjfFZBLHjSORw\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/scripts/containers":{"post":{"summary":"Create a container","description":null,"deprecated":false,"parameters":[{"name":"Object530","in":"body","schema":{"$ref":"#/definitions/Object530"},"required":true}],"responses":{"201":{"description":"success","schema":{"$ref":"#/definitions/Object532"}}},"x-examples":[{"resource":"Scripts","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/scripts/containers","description":"Create a container script","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/scripts/containers","request_body":"{\n \"name\": \"My new container script\",\n \"repo_http_uri\": \"github.com/my_repo\",\n \"repo_ref\": \"master\",\n \"docker_command\": \"python3 main.py\",\n \"docker_image_name\": \"civisanalytics/datascience-base\",\n \"docker_image_tag\": \"awesome_tag\",\n \"git_credential_id\": 659,\n \"required_resources\": {\n \"cpu\": 99,\n \"memory\": 98,\n \"disk_space\": 4.0\n },\n \"remote_host_credential_id\": 658\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer GDdH4_xn7K5PHj3lHVUQexmvuEuqwMxJKtgJlClALtU","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":201,"response_status_text":"Created","response_body":"{\n \"id\": 2326,\n \"fromTemplateAliases\": [\n\n ],\n \"name\": \"My new container script\",\n \"type\": \"Container\",\n \"createdAt\": \"2024-12-03T19:45:50.000Z\",\n \"updatedAt\": \"2024-12-03T19:45:50.000Z\",\n \"author\": {\n \"id\": 2380,\n \"name\": \"User devuserfactory1924 1924\",\n \"username\": \"devuserfactory1924\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"state\": \"idle\",\n \"finishedAt\": null,\n \"category\": \"script\",\n \"projects\": [\n\n ],\n \"parentId\": null,\n \"userContext\": \"runner\",\n \"params\": [\n\n ],\n \"arguments\": {\n },\n \"isTemplate\": false,\n \"templateDependentsCount\": null,\n \"publishedAsTemplateId\": null,\n \"fromTemplateId\": null,\n \"templateScriptName\": null,\n \"links\": {\n \"details\": \"api.civis.test/scripts/containers/2326\",\n \"runs\": \"api.civis.test/scripts/containers/2326/runs\"\n },\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n },\n \"notifications\": {\n \"urls\": [\n\n ],\n \"successEmailSubject\": null,\n \"successEmailBody\": null,\n \"successEmailAddresses\": [\n\n ],\n \"successEmailFromName\": null,\n \"successEmailReplyTo\": null,\n \"failureEmailAddresses\": [\n\n ],\n \"stallWarningMinutes\": null,\n \"successOn\": true,\n \"failureOn\": true\n },\n \"runningAs\": {\n \"id\": 2380,\n \"name\": \"User devuserfactory1924 1924\",\n \"username\": \"devuserfactory1924\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"requiredResources\": {\n \"cpu\": 99,\n \"memory\": 98,\n \"diskSpace\": 4.0\n },\n \"repoHttpUri\": \"github.com/my_repo\",\n \"repoRef\": \"master\",\n \"remoteHostCredentialId\": 658,\n \"gitCredentialId\": 659,\n \"dockerCommand\": \"python3 main.py\",\n \"dockerImageName\": \"civisanalytics/datascience-base\",\n \"dockerImageTag\": \"awesome_tag\",\n \"instanceType\": null,\n \"cancelTimeout\": 0,\n \"lastRun\": null,\n \"timeZone\": \"America/Chicago\",\n \"partitionLabel\": null,\n \"myPermissionLevel\": \"manage\",\n \"hidden\": false,\n \"archived\": false,\n \"targetProjectId\": null,\n \"runningAsId\": 2380\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"fae6139a0aa43154953727da7677a33a\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"4aead607-8f8c-4525-9f2e-a3424fe827aa","X-Runtime":"0.099772","Content-Length":"1667"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/scripts/containers\" -d '{\"name\":\"My new container script\",\"repo_http_uri\":\"github.com/my_repo\",\"repo_ref\":\"master\",\"docker_command\":\"python3 main.py\",\"docker_image_name\":\"civisanalytics/datascience-base\",\"docker_image_tag\":\"awesome_tag\",\"git_credential_id\":659,\"required_resources\":{\"cpu\":99,\"memory\":98,\"disk_space\":4.0},\"remote_host_credential_id\":658}' -X POST \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer GDdH4_xn7K5PHj3lHVUQexmvuEuqwMxJKtgJlClALtU\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Scripts","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/scripts/containers","description":"Create a parameterized container script","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/scripts/containers","request_body":"{\n \"name\": \"My new container script\",\n \"params\": [\n {\n \"name\": \"schema\",\n \"label\": \"Schema\",\n \"description\": \"the schema of the table\",\n \"type\": \"string\",\n \"required\": true,\n \"value\": null,\n \"default\": null,\n \"allowedValues\": []\n },\n {\n \"name\": \"table\",\n \"label\": \"Table\",\n \"description\": \"the name of the table\",\n \"type\": \"string\",\n \"required\": true,\n \"value\": null,\n \"default\": null,\n \"allowedValues\": []\n },\n {\n \"name\": \"fixed_cred\",\n \"label\": \"My fixed credential\",\n \"description\": \"A fixed credential\",\n \"type\": \"credential_redshift\",\n \"required\": true,\n \"value\": \"670\",\n \"default\": null,\n \"allowedValues\": []\n },\n {\n \"name\": \"file\",\n \"label\": \"File\",\n \"description\": \"the name of the file\",\n \"type\": \"file\",\n \"required\": true,\n \"value\": null,\n \"default\": null,\n \"allowedValues\": []\n }\n ],\n \"arguments\": {\n \"schema\": \"my_schema\",\n \"table\": \"my_table\",\n \"file\": 54\n },\n \"repo_http_uri\": \"github.com/my_repo\",\n \"repo_ref\": \"master\",\n \"docker_command\": \"python3 main.py\",\n \"docker_image_name\": \"civisanalytics/datascience-base\",\n \"docker_image_tag\": \"awesome_tag\",\n \"git_credential_id\": 671,\n \"user_context\": \"author\",\n \"required_resources\": {\n \"cpu\": 99,\n \"memory\": 98,\n \"disk_space\": 4\n }\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer uiMrT6LwZWPZST3ke8FgQBQJ-I0k5Wo5HwTC_xHZoxE","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":201,"response_status_text":"Created","response_body":"{\n \"id\": 2333,\n \"fromTemplateAliases\": [\n\n ],\n \"name\": \"My new container script\",\n \"type\": \"Container\",\n \"createdAt\": \"2024-12-03T19:45:51.000Z\",\n \"updatedAt\": \"2024-12-03T19:45:51.000Z\",\n \"author\": {\n \"id\": 2387,\n \"name\": \"User devuserfactory1930 1930\",\n \"username\": \"devuserfactory1930\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"state\": \"idle\",\n \"finishedAt\": null,\n \"category\": \"script\",\n \"projects\": [\n\n ],\n \"parentId\": null,\n \"userContext\": \"author\",\n \"params\": [\n {\n \"name\": \"schema\",\n \"label\": \"Schema\",\n \"description\": \"the schema of the table\",\n \"type\": \"string\",\n \"required\": true,\n \"value\": null,\n \"default\": null,\n \"allowedValues\": [\n\n ]\n },\n {\n \"name\": \"table\",\n \"label\": \"Table\",\n \"description\": \"the name of the table\",\n \"type\": \"string\",\n \"required\": true,\n \"value\": null,\n \"default\": null,\n \"allowedValues\": [\n\n ]\n },\n {\n \"name\": \"fixed_cred\",\n \"label\": \"My fixed credential\",\n \"description\": \"A fixed credential\",\n \"type\": \"credential_redshift\",\n \"required\": true,\n \"value\": \"670\",\n \"default\": null,\n \"allowedValues\": [\n\n ]\n },\n {\n \"name\": \"file\",\n \"label\": \"File\",\n \"description\": \"the name of the file\",\n \"type\": \"file\",\n \"required\": true,\n \"value\": null,\n \"default\": null,\n \"allowedValues\": [\n\n ]\n }\n ],\n \"arguments\": {\n \"schema\": \"my_schema\",\n \"table\": \"my_table\",\n \"file\": 54\n },\n \"isTemplate\": false,\n \"templateDependentsCount\": null,\n \"publishedAsTemplateId\": null,\n \"fromTemplateId\": null,\n \"templateScriptName\": null,\n \"links\": {\n \"details\": \"api.civis.test/scripts/containers/2333\",\n \"runs\": \"api.civis.test/scripts/containers/2333/runs\"\n },\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n },\n \"notifications\": {\n \"urls\": [\n\n ],\n \"successEmailSubject\": null,\n \"successEmailBody\": null,\n \"successEmailAddresses\": [\n\n ],\n \"successEmailFromName\": null,\n \"successEmailReplyTo\": null,\n \"failureEmailAddresses\": [\n\n ],\n \"stallWarningMinutes\": null,\n \"successOn\": true,\n \"failureOn\": true\n },\n \"runningAs\": {\n \"id\": 2387,\n \"name\": \"User devuserfactory1930 1930\",\n \"username\": \"devuserfactory1930\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"requiredResources\": {\n \"cpu\": 99,\n \"memory\": 98,\n \"diskSpace\": 4.0\n },\n \"repoHttpUri\": \"github.com/my_repo\",\n \"repoRef\": \"master\",\n \"remoteHostCredentialId\": null,\n \"gitCredentialId\": 671,\n \"dockerCommand\": \"python3 main.py\",\n \"dockerImageName\": \"civisanalytics/datascience-base\",\n \"dockerImageTag\": \"awesome_tag\",\n \"instanceType\": null,\n \"cancelTimeout\": 0,\n \"lastRun\": null,\n \"timeZone\": \"America/Chicago\",\n \"partitionLabel\": null,\n \"myPermissionLevel\": \"manage\",\n \"hidden\": false,\n \"archived\": false,\n \"targetProjectId\": null,\n \"runningAsId\": 2387\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"ba2c2ec78efe0e627115b7cbe39ea2fe\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"548b412a-be42-4ec9-86b0-ec055cd9ba67","X-Runtime":"0.095972","Content-Length":"2345"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/scripts/containers\" -d '{\"name\":\"My new container script\",\"params\":[{\"name\":\"schema\",\"label\":\"Schema\",\"description\":\"the schema of the table\",\"type\":\"string\",\"required\":true,\"value\":null,\"default\":null,\"allowedValues\":[]},{\"name\":\"table\",\"label\":\"Table\",\"description\":\"the name of the table\",\"type\":\"string\",\"required\":true,\"value\":null,\"default\":null,\"allowedValues\":[]},{\"name\":\"fixed_cred\",\"label\":\"My fixed credential\",\"description\":\"A fixed credential\",\"type\":\"credential_redshift\",\"required\":true,\"value\":\"670\",\"default\":null,\"allowedValues\":[]},{\"name\":\"file\",\"label\":\"File\",\"description\":\"the name of the file\",\"type\":\"file\",\"required\":true,\"value\":null,\"default\":null,\"allowedValues\":[]}],\"arguments\":{\"schema\":\"my_schema\",\"table\":\"my_table\",\"file\":54},\"repo_http_uri\":\"github.com/my_repo\",\"repo_ref\":\"master\",\"docker_command\":\"python3 main.py\",\"docker_image_name\":\"civisanalytics/datascience-base\",\"docker_image_tag\":\"awesome_tag\",\"git_credential_id\":671,\"user_context\":\"author\",\"required_resources\":{\"cpu\":99,\"memory\":98,\"disk_space\":4}}' -X POST \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer uiMrT6LwZWPZST3ke8FgQBQJ-I0k5Wo5HwTC_xHZoxE\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Scripts","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/scripts/containers","description":"Create a parameterized container script with defaults","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/scripts/containers","request_body":"{\n \"name\": \"My new container script\",\n \"params\": [\n {\n \"name\": \"schema\",\n \"label\": \"Schema\",\n \"description\": \"the schema of the table\",\n \"type\": \"string\",\n \"required\": false,\n \"value\": null,\n \"default\": \"cool_schema\",\n \"allowedValues\": []\n },\n {\n \"name\": \"table\",\n \"label\": \"Table\",\n \"description\": \"the name of the table\",\n \"type\": \"string\",\n \"required\": false,\n \"value\": null,\n \"default\": \"cool_table\",\n \"allowedValues\": []\n },\n {\n \"name\": \"db\",\n \"label\": \"Database\",\n \"description\": \"the name of the database\",\n \"type\": \"database\",\n \"required\": true,\n \"value\": null,\n \"default\": null,\n \"allowedValues\": []\n }\n ],\n \"arguments\": {\n \"db\": {\n \"database\": 248,\n \"credential\": 683\n }\n },\n \"repo_http_uri\": \"github.com/my_repo\",\n \"repo_ref\": \"master\",\n \"docker_command\": \"python3 main.py\",\n \"docker_image_name\": \"civisanalytics/datascience-base\",\n \"docker_image_tag\": \"awesome_tag\",\n \"git_credential_id\": 684,\n \"required_resources\": {\n \"cpu\": 99,\n \"memory\": 98,\n \"disk_space\": 4\n }\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer evxcvQKM0m_IVkadvzvZf3lkvByeKA29eVdA9jGEfhA","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":201,"response_status_text":"Created","response_body":"{\n \"id\": 2340,\n \"fromTemplateAliases\": [\n\n ],\n \"name\": \"My new container script\",\n \"type\": \"Container\",\n \"createdAt\": \"2024-12-03T19:45:52.000Z\",\n \"updatedAt\": \"2024-12-03T19:45:52.000Z\",\n \"author\": {\n \"id\": 2395,\n \"name\": \"User devuserfactory1936 1936\",\n \"username\": \"devuserfactory1936\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"state\": \"idle\",\n \"finishedAt\": null,\n \"category\": \"script\",\n \"projects\": [\n\n ],\n \"parentId\": null,\n \"userContext\": \"runner\",\n \"params\": [\n {\n \"name\": \"schema\",\n \"label\": \"Schema\",\n \"description\": \"the schema of the table\",\n \"type\": \"string\",\n \"required\": false,\n \"value\": null,\n \"default\": \"cool_schema\",\n \"allowedValues\": [\n\n ]\n },\n {\n \"name\": \"table\",\n \"label\": \"Table\",\n \"description\": \"the name of the table\",\n \"type\": \"string\",\n \"required\": false,\n \"value\": null,\n \"default\": \"cool_table\",\n \"allowedValues\": [\n\n ]\n },\n {\n \"name\": \"db\",\n \"label\": \"Database\",\n \"description\": \"the name of the database\",\n \"type\": \"database\",\n \"required\": true,\n \"value\": null,\n \"default\": null,\n \"allowedValues\": [\n\n ]\n }\n ],\n \"arguments\": {\n \"db\": {\n \"database\": 248,\n \"credential\": 683\n }\n },\n \"isTemplate\": false,\n \"templateDependentsCount\": null,\n \"publishedAsTemplateId\": null,\n \"fromTemplateId\": null,\n \"templateScriptName\": null,\n \"links\": {\n \"details\": \"api.civis.test/scripts/containers/2340\",\n \"runs\": \"api.civis.test/scripts/containers/2340/runs\"\n },\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n },\n \"notifications\": {\n \"urls\": [\n\n ],\n \"successEmailSubject\": null,\n \"successEmailBody\": null,\n \"successEmailAddresses\": [\n\n ],\n \"successEmailFromName\": null,\n \"successEmailReplyTo\": null,\n \"failureEmailAddresses\": [\n\n ],\n \"stallWarningMinutes\": null,\n \"successOn\": true,\n \"failureOn\": true\n },\n \"runningAs\": {\n \"id\": 2395,\n \"name\": \"User devuserfactory1936 1936\",\n \"username\": \"devuserfactory1936\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"requiredResources\": {\n \"cpu\": 99,\n \"memory\": 98,\n \"diskSpace\": 4.0\n },\n \"repoHttpUri\": \"github.com/my_repo\",\n \"repoRef\": \"master\",\n \"remoteHostCredentialId\": null,\n \"gitCredentialId\": 684,\n \"dockerCommand\": \"python3 main.py\",\n \"dockerImageName\": \"civisanalytics/datascience-base\",\n \"dockerImageTag\": \"awesome_tag\",\n \"instanceType\": null,\n \"cancelTimeout\": 0,\n \"lastRun\": null,\n \"timeZone\": \"America/Chicago\",\n \"partitionLabel\": null,\n \"myPermissionLevel\": \"manage\",\n \"hidden\": false,\n \"archived\": false,\n \"targetProjectId\": null,\n \"runningAsId\": 2395\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"ea8c787fbf544d2a04ccb68e166a0ec0\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"40862fb5-7ff4-4fea-8d0a-d9774fb71bce","X-Runtime":"0.100475","Content-Length":"2183"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/scripts/containers\" -d '{\"name\":\"My new container script\",\"params\":[{\"name\":\"schema\",\"label\":\"Schema\",\"description\":\"the schema of the table\",\"type\":\"string\",\"required\":false,\"value\":null,\"default\":\"cool_schema\",\"allowedValues\":[]},{\"name\":\"table\",\"label\":\"Table\",\"description\":\"the name of the table\",\"type\":\"string\",\"required\":false,\"value\":null,\"default\":\"cool_table\",\"allowedValues\":[]},{\"name\":\"db\",\"label\":\"Database\",\"description\":\"the name of the database\",\"type\":\"database\",\"required\":true,\"value\":null,\"default\":null,\"allowedValues\":[]}],\"arguments\":{\"db\":{\"database\":248,\"credential\":683}},\"repo_http_uri\":\"github.com/my_repo\",\"repo_ref\":\"master\",\"docker_command\":\"python3 main.py\",\"docker_image_name\":\"civisanalytics/datascience-base\",\"docker_image_tag\":\"awesome_tag\",\"git_credential_id\":684,\"required_resources\":{\"cpu\":99,\"memory\":98,\"disk_space\":4}}' -X POST \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer evxcvQKM0m_IVkadvzvZf3lkvByeKA29eVdA9jGEfhA\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Scripts","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/scripts/containers","description":"Fails if provides a default param value to required param","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/scripts/containers","request_body":"{\n \"name\": \"My new container script\",\n \"params\": [\n {\n \"name\": \"schema\",\n \"label\": \"Schema\",\n \"description\": \"the schema of the table\",\n \"type\": \"string\",\n \"required\": true,\n \"value\": null,\n \"default\": \"cool_schema\",\n \"allowedValues\": []\n },\n {\n \"name\": \"table\",\n \"label\": \"Table\",\n \"description\": \"the name of the table\",\n \"type\": \"string\",\n \"required\": true,\n \"value\": null,\n \"default\": \"cool_table\",\n \"allowedValues\": []\n }\n ],\n \"repo_http_uri\": \"github.com/my_repo\",\n \"repo_ref\": \"master\",\n \"docker_command\": \"python3 main.py\",\n \"docker_image_name\": \"civisanalytics/datascience-base\",\n \"docker_image_tag\": \"awesome_tag\",\n \"git_credential_id\": 694,\n \"required_resources\": {\n \"cpu\": 1024,\n \"memory\": 8,\n \"disk_space\": 2\n }\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer 5tK3-TL_Vue_SjeTtIC1wLBAF_ZNGriyZ3kFu1dtoeY","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":400,"response_status_text":"Bad Request","response_body":"{\n \"error\": \"bad_request\",\n \"errorDescription\": \"The given request was not as expected: Validation failed: Code.Parameters schema cannot have a default value since it is required., Code.Parameters table cannot have a default value since it is required.\",\n \"code\": 400\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"d14cd725-7a11-4a94-8a16-c9e2e425de58","X-Runtime":"0.056048","Content-Length":"259"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/scripts/containers\" -d '{\"name\":\"My new container script\",\"params\":[{\"name\":\"schema\",\"label\":\"Schema\",\"description\":\"the schema of the table\",\"type\":\"string\",\"required\":true,\"value\":null,\"default\":\"cool_schema\",\"allowedValues\":[]},{\"name\":\"table\",\"label\":\"Table\",\"description\":\"the name of the table\",\"type\":\"string\",\"required\":true,\"value\":null,\"default\":\"cool_table\",\"allowedValues\":[]}],\"repo_http_uri\":\"github.com/my_repo\",\"repo_ref\":\"master\",\"docker_command\":\"python3 main.py\",\"docker_image_name\":\"civisanalytics/datascience-base\",\"docker_image_tag\":\"awesome_tag\",\"git_credential_id\":694,\"required_resources\":{\"cpu\":1024,\"memory\":8,\"disk_space\":2}}' -X POST \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer 5tK3-TL_Vue_SjeTtIC1wLBAF_ZNGriyZ3kFu1dtoeY\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/scripts/containers/{id}":{"get":{"summary":"View a container","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID for the script.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object532"}}},"x-examples":[{"resource":"Scripts","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/scripts/containers/:container_id","description":"View a Container script's details","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/scripts/containers/2225","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer U2BGEALpVOiI8ek7SfBbmViPWr8LEqrTx6VYjGj7cFM","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 2225,\n \"fromTemplateAliases\": [\n\n ],\n \"name\": \"Script #2225\",\n \"type\": \"Container\",\n \"createdAt\": \"2024-12-03T19:45:38.000Z\",\n \"updatedAt\": \"2024-12-03T19:45:38.000Z\",\n \"author\": {\n \"id\": 2278,\n \"name\": \"User devuserfactory1840 1840\",\n \"username\": \"devuserfactory1840\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"state\": \"idle\",\n \"finishedAt\": null,\n \"category\": \"script\",\n \"projects\": [\n\n ],\n \"parentId\": null,\n \"userContext\": \"runner\",\n \"params\": [\n\n ],\n \"arguments\": {\n },\n \"isTemplate\": false,\n \"templateDependentsCount\": null,\n \"publishedAsTemplateId\": null,\n \"fromTemplateId\": null,\n \"templateScriptName\": null,\n \"links\": {\n \"details\": \"api.civis.test/scripts/containers/2225\",\n \"runs\": \"api.civis.test/scripts/containers/2225/runs\"\n },\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n },\n \"notifications\": {\n \"urls\": [\n\n ],\n \"successEmailSubject\": null,\n \"successEmailBody\": null,\n \"successEmailAddresses\": [\n\n ],\n \"successEmailFromName\": null,\n \"successEmailReplyTo\": null,\n \"failureEmailAddresses\": [\n\n ],\n \"stallWarningMinutes\": null,\n \"successOn\": true,\n \"failureOn\": true\n },\n \"runningAs\": {\n \"id\": 2278,\n \"name\": \"User devuserfactory1840 1840\",\n \"username\": \"devuserfactory1840\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"requiredResources\": {\n \"cpu\": null,\n \"memory\": null,\n \"diskSpace\": 1.0\n },\n \"repoHttpUri\": \"git_repo_url\",\n \"repoRef\": \"git_repo_ref\",\n \"remoteHostCredentialId\": null,\n \"gitCredentialId\": null,\n \"dockerCommand\": \"command\",\n \"dockerImageName\": \"docker_image_name\",\n \"dockerImageTag\": \"mock_latest_tag\",\n \"instanceType\": null,\n \"cancelTimeout\": 0,\n \"lastRun\": null,\n \"timeZone\": \"America/Chicago\",\n \"partitionLabel\": null,\n \"myPermissionLevel\": \"manage\",\n \"hidden\": false,\n \"archived\": false,\n \"targetProjectId\": null,\n \"runningAsId\": 2278\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"d99588f584d9f10bfbdbf74856e4bccb\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"0017757e-1b03-4711-b523-124d9310836a","X-Runtime":"0.051852","Content-Length":"1644"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/scripts/containers/2225\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer U2BGEALpVOiI8ek7SfBbmViPWr8LEqrTx6VYjGj7cFM\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"put":{"summary":"Edit a container","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID for the script.","type":"integer"},{"name":"Object535","in":"body","schema":{"$ref":"#/definitions/Object535"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object532"}}},"x-examples":[{"resource":"Scripts","resource_explanation":null,"http_method":"PUT","route":"http://api.civis.test/scripts/containers/:container_id","description":"Update a Container Script via Put","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"PUT","request_path":"http://api.civis.test/scripts/containers/2462","request_body":"{\n \"id\": 2462,\n \"name\": \"My updated Container script\",\n \"parent_id\": null,\n \"repo_http_uri\": \"github.com/new_repo\",\n \"repo_ref\": \"cool-branch\",\n \"docker_command\": \"python3 new_main.py\",\n \"docker_image_name\": \"new_docker_image\",\n \"required_resources\": {\n \"cpu\": 1024,\n \"memory\": 1024,\n \"disk_space\": 4\n },\n \"remote_host_credential_id\": 839,\n \"running_as_id\": 2519,\n \"docker_image_tag\": \"latest\"\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer ZtT5dnsK7yOa_tGZqZjLL1CfakyRfO1pHZ8pFBtaBWk","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 2462,\n \"fromTemplateAliases\": [\n\n ],\n \"name\": \"My updated Container script\",\n \"type\": \"Container\",\n \"createdAt\": \"2024-12-03T19:46:07.000Z\",\n \"updatedAt\": \"2024-12-03T19:46:07.000Z\",\n \"author\": {\n \"id\": 2519,\n \"name\": \"User devuserfactory2041 2041\",\n \"username\": \"devuserfactory2041\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"state\": \"idle\",\n \"finishedAt\": null,\n \"category\": \"script\",\n \"projects\": [\n\n ],\n \"parentId\": null,\n \"userContext\": \"runner\",\n \"params\": [\n\n ],\n \"arguments\": {\n },\n \"isTemplate\": false,\n \"templateDependentsCount\": null,\n \"publishedAsTemplateId\": null,\n \"fromTemplateId\": null,\n \"templateScriptName\": null,\n \"links\": {\n \"details\": \"api.civis.test/scripts/containers/2462\",\n \"runs\": \"api.civis.test/scripts/containers/2462/runs\"\n },\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n },\n \"notifications\": {\n \"urls\": [\n\n ],\n \"successEmailSubject\": null,\n \"successEmailBody\": null,\n \"successEmailAddresses\": [\n\n ],\n \"successEmailFromName\": null,\n \"successEmailReplyTo\": null,\n \"failureEmailAddresses\": [\n\n ],\n \"stallWarningMinutes\": null,\n \"successOn\": true,\n \"failureOn\": true\n },\n \"runningAs\": {\n \"id\": 2519,\n \"name\": \"User devuserfactory2041 2041\",\n \"username\": \"devuserfactory2041\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"requiredResources\": {\n \"cpu\": 1024,\n \"memory\": 1024,\n \"diskSpace\": 4.0\n },\n \"repoHttpUri\": \"github.com/new_repo\",\n \"repoRef\": \"cool-branch\",\n \"remoteHostCredentialId\": 839,\n \"gitCredentialId\": null,\n \"dockerCommand\": \"python3 new_main.py\",\n \"dockerImageName\": \"new_docker_image\",\n \"dockerImageTag\": \"latest\",\n \"instanceType\": null,\n \"cancelTimeout\": 0,\n \"lastRun\": null,\n \"timeZone\": \"America/Chicago\",\n \"partitionLabel\": null,\n \"myPermissionLevel\": \"manage\",\n \"hidden\": false,\n \"archived\": false,\n \"targetProjectId\": null,\n \"runningAsId\": 2519\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"fc2836ae324504934fe2a040c5d9c4a4\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"25c82d49-054f-4707-8735-93fdfec56804","X-Runtime":"0.105065","Content-Length":"1666"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/scripts/containers/2462\" -d '{\"id\":2462,\"name\":\"My updated Container script\",\"parent_id\":null,\"repo_http_uri\":\"github.com/new_repo\",\"repo_ref\":\"cool-branch\",\"docker_command\":\"python3 new_main.py\",\"docker_image_name\":\"new_docker_image\",\"required_resources\":{\"cpu\":1024,\"memory\":1024,\"disk_space\":4},\"remote_host_credential_id\":839,\"running_as_id\":2519,\"docker_image_tag\":\"latest\"}' -X PUT \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer ZtT5dnsK7yOa_tGZqZjLL1CfakyRfO1pHZ8pFBtaBWk\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"patch":{"summary":"Update a container","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID for the script.","type":"integer"},{"name":"Object536","in":"body","schema":{"$ref":"#/definitions/Object536"},"required":false}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object532"}}},"x-examples":[{"resource":"Scripts","resource_explanation":null,"http_method":"PATCH","route":"http://api.civis.test/scripts/containers/:container_id","description":"Update a Container Script via Patch","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"PATCH","request_path":"http://api.civis.test/scripts/containers/2407","request_body":"{\n \"name\": \"My updated Container script\",\n \"repo_http_uri\": \"github.com/new_repo\",\n \"repo_ref\": \"cool-branch\",\n \"docker_command\": \"python3 new_main.py\",\n \"docker_image_name\": \"new_docker_image\",\n \"required_resources\": {\n \"cpu\": 500,\n \"memory\": 2000,\n \"disk_space\": 3\n }\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer _TkRemGqzGrPTq9r_pnGIdEIye8r7Uo3nKf1NpVmyhc","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 2407,\n \"fromTemplateAliases\": [\n\n ],\n \"name\": \"My updated Container script\",\n \"type\": \"Container\",\n \"createdAt\": \"2024-12-03T19:46:00.000Z\",\n \"updatedAt\": \"2024-12-03T19:46:01.000Z\",\n \"author\": {\n \"id\": 2464,\n \"name\": \"User devuserfactory1994 1994\",\n \"username\": \"devuserfactory1994\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"state\": \"idle\",\n \"finishedAt\": null,\n \"category\": \"script\",\n \"projects\": [\n\n ],\n \"parentId\": null,\n \"userContext\": \"runner\",\n \"params\": [\n\n ],\n \"arguments\": {\n },\n \"isTemplate\": false,\n \"templateDependentsCount\": null,\n \"publishedAsTemplateId\": null,\n \"fromTemplateId\": null,\n \"templateScriptName\": null,\n \"links\": {\n \"details\": \"api.civis.test/scripts/containers/2407\",\n \"runs\": \"api.civis.test/scripts/containers/2407/runs\"\n },\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n },\n \"notifications\": {\n \"urls\": [\n\n ],\n \"successEmailSubject\": null,\n \"successEmailBody\": null,\n \"successEmailAddresses\": [\n\n ],\n \"successEmailFromName\": null,\n \"successEmailReplyTo\": null,\n \"failureEmailAddresses\": [\n\n ],\n \"stallWarningMinutes\": null,\n \"successOn\": true,\n \"failureOn\": true\n },\n \"runningAs\": {\n \"id\": 2464,\n \"name\": \"User devuserfactory1994 1994\",\n \"username\": \"devuserfactory1994\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"requiredResources\": {\n \"cpu\": 500,\n \"memory\": 2000,\n \"diskSpace\": 3.0\n },\n \"repoHttpUri\": \"github.com/new_repo\",\n \"repoRef\": \"cool-branch\",\n \"remoteHostCredentialId\": null,\n \"gitCredentialId\": null,\n \"dockerCommand\": \"python3 new_main.py\",\n \"dockerImageName\": \"new_docker_image\",\n \"dockerImageTag\": \"mock_latest_tag\",\n \"instanceType\": null,\n \"cancelTimeout\": 0,\n \"lastRun\": null,\n \"timeZone\": \"America/Chicago\",\n \"partitionLabel\": null,\n \"myPermissionLevel\": \"manage\",\n \"hidden\": false,\n \"archived\": false,\n \"targetProjectId\": null,\n \"runningAsId\": 2464\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"71864f567daea252ebc7cc3f79b4fe49\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"bb348ea9-027a-4751-baca-27e87c8ab0d8","X-Runtime":"0.091974","Content-Length":"1675"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/scripts/containers/2407\" -d '{\"name\":\"My updated Container script\",\"repo_http_uri\":\"github.com/new_repo\",\"repo_ref\":\"cool-branch\",\"docker_command\":\"python3 new_main.py\",\"docker_image_name\":\"new_docker_image\",\"required_resources\":{\"cpu\":500,\"memory\":2000,\"disk_space\":3}}' -X PATCH \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer _TkRemGqzGrPTq9r_pnGIdEIye8r7Uo3nKf1NpVmyhc\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Scripts","resource_explanation":null,"http_method":"PATCH","route":"http://api.civis.test/scripts/containers/:container_id","description":"Update a Container Script via Patch","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"PATCH","request_path":"http://api.civis.test/scripts/containers/2471","request_body":"{\n \"id\": 2471,\n \"name\": \"My patched Container script\"\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer pFgtu0eNzOi7PkCDzxiGY0Z9HQA-fX8u1HHFHWXU-gY","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 2471,\n \"fromTemplateAliases\": [\n\n ],\n \"name\": \"My patched Container script\",\n \"type\": \"Container\",\n \"createdAt\": \"2024-12-03T19:46:08.000Z\",\n \"updatedAt\": \"2024-12-03T19:46:08.000Z\",\n \"author\": {\n \"id\": 2528,\n \"name\": \"User devuserfactory2049 2049\",\n \"username\": \"devuserfactory2049\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"state\": \"idle\",\n \"finishedAt\": null,\n \"category\": \"script\",\n \"projects\": [\n\n ],\n \"parentId\": null,\n \"userContext\": \"runner\",\n \"params\": [\n\n ],\n \"arguments\": {\n },\n \"isTemplate\": false,\n \"templateDependentsCount\": null,\n \"publishedAsTemplateId\": null,\n \"fromTemplateId\": null,\n \"templateScriptName\": null,\n \"links\": {\n \"details\": \"api.civis.test/scripts/containers/2471\",\n \"runs\": \"api.civis.test/scripts/containers/2471/runs\"\n },\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n },\n \"notifications\": {\n \"urls\": [\n\n ],\n \"successEmailSubject\": null,\n \"successEmailBody\": null,\n \"successEmailAddresses\": [\n\n ],\n \"successEmailFromName\": null,\n \"successEmailReplyTo\": null,\n \"failureEmailAddresses\": [\n\n ],\n \"stallWarningMinutes\": null,\n \"successOn\": true,\n \"failureOn\": true\n },\n \"runningAs\": {\n \"id\": 2528,\n \"name\": \"User devuserfactory2049 2049\",\n \"username\": \"devuserfactory2049\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"requiredResources\": {\n \"cpu\": null,\n \"memory\": null,\n \"diskSpace\": 1.0\n },\n \"repoHttpUri\": \"git_repo_url\",\n \"repoRef\": \"git_repo_ref\",\n \"remoteHostCredentialId\": null,\n \"gitCredentialId\": null,\n \"dockerCommand\": \"command\",\n \"dockerImageName\": \"docker_image_name\",\n \"dockerImageTag\": \"mock_latest_tag\",\n \"instanceType\": null,\n \"cancelTimeout\": 0,\n \"lastRun\": null,\n \"timeZone\": \"America/Chicago\",\n \"partitionLabel\": null,\n \"myPermissionLevel\": \"manage\",\n \"hidden\": false,\n \"archived\": false,\n \"targetProjectId\": null,\n \"runningAsId\": 2528\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"c394e0c47b856bec0ac2dd9ad586d213\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"69d950b1-7d8f-4097-8a84-1f03c374bc74","X-Runtime":"0.084713","Content-Length":"1659"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/scripts/containers/2471\" -d '{\"id\":2471,\"name\":\"My patched Container script\"}' -X PATCH \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer pFgtu0eNzOi7PkCDzxiGY0Z9HQA-fX8u1HHFHWXU-gY\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"delete":{"summary":"Archive a container (deprecated, use archive endpoints)","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID for the script.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/containers/{id}/runs/{run_id}/logs":{"post":{"summary":"Add log messages","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the script.","type":"integer"},{"name":"run_id","in":"path","required":true,"description":"The ID of the script run.","type":"integer"},{"name":"Object540","in":"body","schema":{"$ref":"#/definitions/Object540"},"required":false}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null},"get":{"summary":"Get the logs for a run","description":"Get the logs for a run.","deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Container job.","type":"integer"},{"name":"run_id","in":"path","required":true,"description":"The ID of the run.","type":"integer"},{"name":"last_id","in":"query","required":false,"description":"The ID of the last log message received. Log entries with this ID value or lower will be omitted.Logs are sorted by ID if this value is provided, and are otherwise sorted by createdAt.","type":"integer"},{"name":"limit","in":"query","required":false,"description":"The maximum number of log messages to return. Default of 10000.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object117"}}}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/sql":{"post":{"summary":"Create a SQL Script","description":null,"deprecated":false,"parameters":[{"name":"Object543","in":"body","schema":{"$ref":"#/definitions/Object543"},"required":true}],"responses":{"201":{"description":"success","schema":{"$ref":"#/definitions/Object545"}}},"x-examples":[{"resource":"Scripts","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/scripts/sql","description":"Create a sql script","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/scripts/sql","request_body":"{\n \"name\": \"My new sql script\",\n \"remote_host_id\": 227,\n \"credential_id\": 622,\n \"sql\": \"select * from tablename\",\n \"notifications\": {\n \"success_email_addresses\": \"test1@civisanalytics.com\",\n \"failure_email_addresses\": \"test2@civisanalytics.com\",\n \"urls\": \"civisanalytics.com\",\n \"successEmailSubject\": \"test subject\",\n \"successEmailBody\": \"test body\",\n \"stallWarningMinutes\": 15,\n \"successOn\": true,\n \"failureOn\": true\n }\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer 8Spt7ZjttIYIyzDpi1ZCBtW5YhXbtKfQryrBjoEbznk","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":201,"response_status_text":"Created","response_body":"{\n \"id\": 2298,\n \"name\": \"My new sql script\",\n \"type\": \"SQL\",\n \"createdAt\": \"2024-12-03T19:45:47.000Z\",\n \"updatedAt\": \"2024-12-03T19:45:47.000Z\",\n \"author\": {\n \"id\": 2352,\n \"name\": \"User devuserfactory1900 1900\",\n \"username\": \"devuserfactory1900\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"state\": \"idle\",\n \"finishedAt\": null,\n \"category\": \"script\",\n \"projects\": [\n\n ],\n \"parentId\": null,\n \"userContext\": \"runner\",\n \"params\": [\n\n ],\n \"arguments\": {\n },\n \"isTemplate\": false,\n \"publishedAsTemplateId\": null,\n \"fromTemplateId\": null,\n \"templateDependentsCount\": null,\n \"templateScriptName\": null,\n \"links\": {\n \"details\": \"api.civis.test/scripts/sql/2298\",\n \"runs\": \"api.civis.test/scripts/sql/2298/runs\"\n },\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n },\n \"notifications\": {\n \"urls\": [\n \"civisanalytics.com\"\n ],\n \"successEmailSubject\": \"test subject\",\n \"successEmailBody\": \"test body\",\n \"successEmailAddresses\": [\n \"test1@civisanalytics.com\"\n ],\n \"successEmailFromName\": null,\n \"successEmailReplyTo\": null,\n \"failureEmailAddresses\": [\n \"test2@civisanalytics.com\"\n ],\n \"stallWarningMinutes\": 15,\n \"successOn\": true,\n \"failureOn\": true\n },\n \"runningAs\": {\n \"id\": 2352,\n \"name\": \"User devuserfactory1900 1900\",\n \"username\": \"devuserfactory1900\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"nextRunAt\": null,\n \"timeZone\": \"America/Chicago\",\n \"lastRun\": null,\n \"myPermissionLevel\": \"manage\",\n \"hidden\": false,\n \"targetProjectId\": null,\n \"archived\": false,\n \"sql\": \"select * from tablename\",\n \"expandedArguments\": {\n },\n \"remoteHostId\": 227,\n \"credentialId\": 622,\n \"codePreview\": \"select * from tablename\",\n \"csvSettings\": {\n \"includeHeader\": true,\n \"compression\": \"gzip\",\n \"columnDelimiter\": \"comma\",\n \"unquoted\": false,\n \"forceMultifile\": false,\n \"filenamePrefix\": null,\n \"maxFileSize\": null\n },\n \"runningAsId\": 2352\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"cfd060f1c741a1fa3bd0c2327ed7820e\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"406cac50-5af9-457d-b057-eb2d981e0ca6","X-Runtime":"0.143285","Content-Length":"1677"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/scripts/sql\" -d '{\"name\":\"My new sql script\",\"remote_host_id\":227,\"credential_id\":622,\"sql\":\"select * from tablename\",\"notifications\":{\"success_email_addresses\":\"test1@civisanalytics.com\",\"failure_email_addresses\":\"test2@civisanalytics.com\",\"urls\":\"civisanalytics.com\",\"successEmailSubject\":\"test subject\",\"successEmailBody\":\"test body\",\"stallWarningMinutes\":15,\"successOn\":true,\"failureOn\":true}}' -X POST \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer 8Spt7ZjttIYIyzDpi1ZCBtW5YhXbtKfQryrBjoEbznk\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Scripts","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/scripts/sql","description":"Create a sql script with custom export settings","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/scripts/sql","request_body":"{\n \"name\": \"My new export settings sql script\",\n \"remote_host_id\": 230,\n \"credential_id\": 631,\n \"sql\": \"select * from tablename\",\n \"csv_settings\": {\n \"include_header\": false,\n \"compression\": \"none\",\n \"column_delimiter\": \"tab\",\n \"unquoted\": true,\n \"force_multifile\": true,\n \"filename_prefix\": \"test_prefix_\"\n }\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer WVQOX-IGzXjr4iq0A-JaHrftLulo8y4-tmnKb--FMfY","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":201,"response_status_text":"Created","response_body":"{\n \"id\": 2305,\n \"name\": \"My new export settings sql script\",\n \"type\": \"SQL\",\n \"createdAt\": \"2024-12-03T19:45:48.000Z\",\n \"updatedAt\": \"2024-12-03T19:45:48.000Z\",\n \"author\": {\n \"id\": 2359,\n \"name\": \"User devuserfactory1906 1906\",\n \"username\": \"devuserfactory1906\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"state\": \"idle\",\n \"finishedAt\": null,\n \"category\": \"script\",\n \"projects\": [\n\n ],\n \"parentId\": null,\n \"userContext\": \"runner\",\n \"params\": [\n\n ],\n \"arguments\": {\n },\n \"isTemplate\": false,\n \"publishedAsTemplateId\": null,\n \"fromTemplateId\": null,\n \"templateDependentsCount\": null,\n \"templateScriptName\": null,\n \"links\": {\n \"details\": \"api.civis.test/scripts/sql/2305\",\n \"runs\": \"api.civis.test/scripts/sql/2305/runs\"\n },\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n },\n \"notifications\": {\n \"urls\": [\n\n ],\n \"successEmailSubject\": null,\n \"successEmailBody\": null,\n \"successEmailAddresses\": [\n\n ],\n \"successEmailFromName\": null,\n \"successEmailReplyTo\": null,\n \"failureEmailAddresses\": [\n\n ],\n \"stallWarningMinutes\": null,\n \"successOn\": true,\n \"failureOn\": true\n },\n \"runningAs\": {\n \"id\": 2359,\n \"name\": \"User devuserfactory1906 1906\",\n \"username\": \"devuserfactory1906\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"nextRunAt\": null,\n \"timeZone\": \"America/Chicago\",\n \"lastRun\": null,\n \"myPermissionLevel\": \"manage\",\n \"hidden\": false,\n \"targetProjectId\": null,\n \"archived\": false,\n \"sql\": \"select * from tablename\",\n \"expandedArguments\": {\n },\n \"remoteHostId\": 230,\n \"credentialId\": 631,\n \"codePreview\": \"select * from tablename\",\n \"csvSettings\": {\n \"includeHeader\": false,\n \"compression\": \"none\",\n \"columnDelimiter\": \"tab\",\n \"unquoted\": true,\n \"forceMultifile\": true,\n \"filenamePrefix\": \"test_prefix_\",\n \"maxFileSize\": null\n },\n \"runningAsId\": 2359\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"9cc1b31525ed03eda86504448658ad49\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"9969d52c-a836-4c3b-b400-6ebaadc9adba","X-Runtime":"0.123811","Content-Length":"1613"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/scripts/sql\" -d '{\"name\":\"My new export settings sql script\",\"remote_host_id\":230,\"credential_id\":631,\"sql\":\"select * from tablename\",\"csv_settings\":{\"include_header\":false,\"compression\":\"none\",\"column_delimiter\":\"tab\",\"unquoted\":true,\"force_multifile\":true,\"filename_prefix\":\"test_prefix_\"}}' -X POST \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer WVQOX-IGzXjr4iq0A-JaHrftLulo8y4-tmnKb--FMfY\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Scripts","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/scripts/sql","description":"Create a parameterized sql script","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/scripts/sql","request_body":"{\n \"name\": \"My new parameterized sql script\",\n \"remote_host_id\": 233,\n \"credential_id\": 640,\n \"sql\": \"select * from {{schema}}.{{table}}\",\n \"params\": [\n {\n \"name\": \"schema\",\n \"label\": \"Schema\",\n \"description\": \"the schema of the table\",\n \"type\": \"string\",\n \"required\": true,\n \"value\": null,\n \"default\": null,\n \"allowedValues\": []\n },\n {\n \"name\": \"credential\",\n \"label\": \"Credential\",\n \"description\": \"the credential to use\",\n \"type\": \"credential_redshift\",\n \"required\": true,\n \"value\": null,\n \"default\": null,\n \"allowedValues\": []\n },\n {\n \"name\": \"table\",\n \"label\": \"Table\",\n \"description\": \"the name of the table\",\n \"type\": \"string\",\n \"required\": true,\n \"value\": null,\n \"default\": null,\n \"allowedValues\": []\n }\n ]\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer 5fcOxqt6r9F1MrLGbf_Lr2un-OviQjCeLtda9NfIJOI","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":201,"response_status_text":"Created","response_body":"{\n \"id\": 2312,\n \"name\": \"My new parameterized sql script\",\n \"type\": \"SQL\",\n \"createdAt\": \"2024-12-03T19:45:49.000Z\",\n \"updatedAt\": \"2024-12-03T19:45:49.000Z\",\n \"author\": {\n \"id\": 2366,\n \"name\": \"User devuserfactory1912 1912\",\n \"username\": \"devuserfactory1912\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"state\": \"idle\",\n \"finishedAt\": null,\n \"category\": \"script\",\n \"projects\": [\n\n ],\n \"parentId\": null,\n \"userContext\": \"runner\",\n \"params\": [\n {\n \"name\": \"schema\",\n \"label\": \"Schema\",\n \"description\": \"the schema of the table\",\n \"type\": \"string\",\n \"required\": true,\n \"value\": null,\n \"default\": null,\n \"allowedValues\": [\n\n ]\n },\n {\n \"name\": \"credential\",\n \"label\": \"Credential\",\n \"description\": \"the credential to use\",\n \"type\": \"credential_redshift\",\n \"required\": true,\n \"value\": null,\n \"default\": null,\n \"allowedValues\": [\n\n ]\n },\n {\n \"name\": \"table\",\n \"label\": \"Table\",\n \"description\": \"the name of the table\",\n \"type\": \"string\",\n \"required\": true,\n \"value\": null,\n \"default\": null,\n \"allowedValues\": [\n\n ]\n }\n ],\n \"arguments\": {\n },\n \"isTemplate\": false,\n \"publishedAsTemplateId\": null,\n \"fromTemplateId\": null,\n \"templateDependentsCount\": null,\n \"templateScriptName\": null,\n \"links\": {\n \"details\": \"api.civis.test/scripts/sql/2312\",\n \"runs\": \"api.civis.test/scripts/sql/2312/runs\"\n },\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n },\n \"notifications\": {\n \"urls\": [\n\n ],\n \"successEmailSubject\": null,\n \"successEmailBody\": null,\n \"successEmailAddresses\": [\n\n ],\n \"successEmailFromName\": null,\n \"successEmailReplyTo\": null,\n \"failureEmailAddresses\": [\n\n ],\n \"stallWarningMinutes\": null,\n \"successOn\": true,\n \"failureOn\": true\n },\n \"runningAs\": {\n \"id\": 2366,\n \"name\": \"User devuserfactory1912 1912\",\n \"username\": \"devuserfactory1912\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"nextRunAt\": null,\n \"timeZone\": \"America/Chicago\",\n \"lastRun\": null,\n \"myPermissionLevel\": \"manage\",\n \"hidden\": false,\n \"targetProjectId\": null,\n \"archived\": false,\n \"sql\": \"select * from {{schema}}.{{table}}\",\n \"expandedArguments\": {\n \"schema\": null,\n \"schema.literal\": null,\n \"schema.identifier\": null,\n \"schema.shell_escaped\": null,\n \"credential.id\": \"[redacted Credential id]\",\n \"credential.username\": \"[redacted Credential username]\",\n \"credential.password\": \"[redacted Credential password]\",\n \"table\": null,\n \"table.literal\": null,\n \"table.identifier\": null,\n \"table.shell_escaped\": null\n },\n \"remoteHostId\": 233,\n \"credentialId\": 640,\n \"codePreview\": \"select * from {{schema}}.{{table}}\",\n \"csvSettings\": {\n \"includeHeader\": true,\n \"compression\": \"gzip\",\n \"columnDelimiter\": \"comma\",\n \"unquoted\": false,\n \"forceMultifile\": false,\n \"filenamePrefix\": null,\n \"maxFileSize\": null\n },\n \"runningAsId\": 2366\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"dd8661f8b7371202726f64a39bbda46e\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"042a95f6-340a-469e-8f06-2f2eebc373f3","X-Runtime":"0.136057","Content-Length":"2428"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/scripts/sql\" -d '{\"name\":\"My new parameterized sql script\",\"remote_host_id\":233,\"credential_id\":640,\"sql\":\"select * from {{schema}}.{{table}}\",\"params\":[{\"name\":\"schema\",\"label\":\"Schema\",\"description\":\"the schema of the table\",\"type\":\"string\",\"required\":true,\"value\":null,\"default\":null,\"allowedValues\":[]},{\"name\":\"credential\",\"label\":\"Credential\",\"description\":\"the credential to use\",\"type\":\"credential_redshift\",\"required\":true,\"value\":null,\"default\":null,\"allowedValues\":[]},{\"name\":\"table\",\"label\":\"Table\",\"description\":\"the name of the table\",\"type\":\"string\",\"required\":true,\"value\":null,\"default\":null,\"allowedValues\":[]}]}' -X POST \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer 5fcOxqt6r9F1MrLGbf_Lr2un-OviQjCeLtda9NfIJOI\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Scripts","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/scripts/sql","description":"Create a parameterized sql script with default params","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/scripts/sql","request_body":"{\n \"name\": \"My new parameterized sql script\",\n \"remote_host_id\": 236,\n \"credential_id\": 649,\n \"sql\": \"select * from {{schema}}.{{table}} where \\\"{{colName}}\\\" = {{coolBool}} limit {{limit}}\",\n \"params\": [\n {\n \"name\": \"schema\",\n \"label\": \"Schema\",\n \"description\": \"the schema of the table\",\n \"type\": \"string\",\n \"required\": false,\n \"value\": null,\n \"default\": \"my_schema\",\n \"allowedValues\": []\n },\n {\n \"name\": \"table\",\n \"label\": \"Table\",\n \"description\": \"the name of the table\",\n \"type\": \"string\",\n \"required\": false,\n \"value\": null,\n \"default\": \"my_table\",\n \"allowedValues\": []\n },\n {\n \"name\": \"coolBool\",\n \"label\": \"Cool Bool\",\n \"description\": \"bool val for the column\",\n \"type\": \"bool\",\n \"required\": false,\n \"value\": null,\n \"default\": true,\n \"allowedValues\": []\n },\n {\n \"name\": \"colName\",\n \"label\": \"Column Name\",\n \"description\": \"column to select on\",\n \"type\": \"string\",\n \"required\": false,\n \"value\": null,\n \"default\": \"foo\",\n \"allowedValues\": []\n },\n {\n \"name\": \"limit\",\n \"label\": \"Limit\",\n \"description\": \"the limit\",\n \"type\": \"integer\",\n \"required\": false,\n \"value\": null,\n \"default\": null,\n \"allowedValues\": []\n }\n ]\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer wND6z5XyB4IDSSed33bI279iZ6Sj1kPhUh8ranZWQ6U","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":201,"response_status_text":"Created","response_body":"{\n \"id\": 2319,\n \"name\": \"My new parameterized sql script\",\n \"type\": \"SQL\",\n \"createdAt\": \"2024-12-03T19:45:49.000Z\",\n \"updatedAt\": \"2024-12-03T19:45:49.000Z\",\n \"author\": {\n \"id\": 2373,\n \"name\": \"User devuserfactory1918 1918\",\n \"username\": \"devuserfactory1918\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"state\": \"idle\",\n \"finishedAt\": null,\n \"category\": \"script\",\n \"projects\": [\n\n ],\n \"parentId\": null,\n \"userContext\": \"runner\",\n \"params\": [\n {\n \"name\": \"schema\",\n \"label\": \"Schema\",\n \"description\": \"the schema of the table\",\n \"type\": \"string\",\n \"required\": false,\n \"value\": null,\n \"default\": \"my_schema\",\n \"allowedValues\": [\n\n ]\n },\n {\n \"name\": \"table\",\n \"label\": \"Table\",\n \"description\": \"the name of the table\",\n \"type\": \"string\",\n \"required\": false,\n \"value\": null,\n \"default\": \"my_table\",\n \"allowedValues\": [\n\n ]\n },\n {\n \"name\": \"coolBool\",\n \"label\": \"Cool Bool\",\n \"description\": \"bool val for the column\",\n \"type\": \"bool\",\n \"required\": false,\n \"value\": null,\n \"default\": true,\n \"allowedValues\": [\n\n ]\n },\n {\n \"name\": \"colName\",\n \"label\": \"Column Name\",\n \"description\": \"column to select on\",\n \"type\": \"string\",\n \"required\": false,\n \"value\": null,\n \"default\": \"foo\",\n \"allowedValues\": [\n\n ]\n },\n {\n \"name\": \"limit\",\n \"label\": \"Limit\",\n \"description\": \"the limit\",\n \"type\": \"integer\",\n \"required\": false,\n \"value\": null,\n \"default\": null,\n \"allowedValues\": [\n\n ]\n }\n ],\n \"arguments\": {\n },\n \"isTemplate\": false,\n \"publishedAsTemplateId\": null,\n \"fromTemplateId\": null,\n \"templateDependentsCount\": null,\n \"templateScriptName\": null,\n \"links\": {\n \"details\": \"api.civis.test/scripts/sql/2319\",\n \"runs\": \"api.civis.test/scripts/sql/2319/runs\"\n },\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n },\n \"notifications\": {\n \"urls\": [\n\n ],\n \"successEmailSubject\": null,\n \"successEmailBody\": null,\n \"successEmailAddresses\": [\n\n ],\n \"successEmailFromName\": null,\n \"successEmailReplyTo\": null,\n \"failureEmailAddresses\": [\n\n ],\n \"stallWarningMinutes\": null,\n \"successOn\": true,\n \"failureOn\": true\n },\n \"runningAs\": {\n \"id\": 2373,\n \"name\": \"User devuserfactory1918 1918\",\n \"username\": \"devuserfactory1918\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"nextRunAt\": null,\n \"timeZone\": \"America/Chicago\",\n \"lastRun\": null,\n \"myPermissionLevel\": \"manage\",\n \"hidden\": false,\n \"targetProjectId\": null,\n \"archived\": false,\n \"sql\": \"select * from {{schema}}.{{table}} where \\\"{{colName}}\\\" = {{coolBool}} limit {{limit}}\",\n \"expandedArguments\": {\n \"schema\": \"my_schema\",\n \"schema.literal\": \"'my_schema'\",\n \"schema.identifier\": \"\\\"my_schema\\\"\",\n \"schema.shell_escaped\": \"my_schema\",\n \"table\": \"my_table\",\n \"table.literal\": \"'my_table'\",\n \"table.identifier\": \"\\\"my_table\\\"\",\n \"table.shell_escaped\": \"my_table\",\n \"coolBool\": true,\n \"colName\": \"foo\",\n \"colName.literal\": \"'foo'\",\n \"colName.identifier\": \"\\\"foo\\\"\",\n \"colName.shell_escaped\": \"foo\",\n \"limit\": 0\n },\n \"remoteHostId\": 236,\n \"credentialId\": 649,\n \"codePreview\": \"select * from my_schema.my_table where \\\"foo\\\" = true limit 0\",\n \"csvSettings\": {\n \"includeHeader\": true,\n \"compression\": \"gzip\",\n \"columnDelimiter\": \"comma\",\n \"unquoted\": false,\n \"forceMultifile\": false,\n \"filenamePrefix\": null,\n \"maxFileSize\": null\n },\n \"runningAsId\": 2373\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"465e4e73de53a42f8a5ff44b2784fddf\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"d9798f2c-1fbe-42dd-910d-92a0312687d7","X-Runtime":"0.117033","Content-Length":"2846"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/scripts/sql\" -d '{\"name\":\"My new parameterized sql script\",\"remote_host_id\":236,\"credential_id\":649,\"sql\":\"select * from {{schema}}.{{table}} where \\\"{{colName}}\\\" = {{coolBool}} limit {{limit}}\",\"params\":[{\"name\":\"schema\",\"label\":\"Schema\",\"description\":\"the schema of the table\",\"type\":\"string\",\"required\":false,\"value\":null,\"default\":\"my_schema\",\"allowedValues\":[]},{\"name\":\"table\",\"label\":\"Table\",\"description\":\"the name of the table\",\"type\":\"string\",\"required\":false,\"value\":null,\"default\":\"my_table\",\"allowedValues\":[]},{\"name\":\"coolBool\",\"label\":\"Cool Bool\",\"description\":\"bool val for the column\",\"type\":\"bool\",\"required\":false,\"value\":null,\"default\":true,\"allowedValues\":[]},{\"name\":\"colName\",\"label\":\"Column Name\",\"description\":\"column to select on\",\"type\":\"string\",\"required\":false,\"value\":null,\"default\":\"foo\",\"allowedValues\":[]},{\"name\":\"limit\",\"label\":\"Limit\",\"description\":\"the limit\",\"type\":\"integer\",\"required\":false,\"value\":null,\"default\":null,\"allowedValues\":[]}]}' -X POST \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer wND6z5XyB4IDSSed33bI279iZ6Sj1kPhUh8ranZWQ6U\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/scripts/sql/{id}":{"get":{"summary":"Get a SQL Script","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object545"}}},"x-examples":[{"resource":"Scripts","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/scripts/sql/:id","description":"View a SQL script's details","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/scripts/sql/2188","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer JYsAzWYgM7gt5K04849zxfafVwx0xDvM7VB25Xpqk-E","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 2188,\n \"name\": \"Script #2188\",\n \"type\": \"SQL\",\n \"createdAt\": \"2024-12-03T19:45:34.000Z\",\n \"updatedAt\": \"2024-12-03T19:45:34.000Z\",\n \"author\": {\n \"id\": 2245,\n \"name\": \"User devuserfactory1811 1811\",\n \"username\": \"devuserfactory1811\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"state\": \"running\",\n \"finishedAt\": \"2024-12-03T19:45:34.000Z\",\n \"category\": \"script\",\n \"projects\": [\n {\n \"id\": 16,\n \"name\": \"Test Project\"\n }\n ],\n \"parentId\": null,\n \"userContext\": \"runner\",\n \"params\": [\n {\n \"name\": \"id\",\n \"label\": \"ID\",\n \"description\": null,\n \"type\": \"integer\",\n \"required\": true,\n \"value\": null,\n \"default\": null,\n \"allowedValues\": [\n\n ]\n },\n {\n \"name\": \"state\",\n \"label\": \"State\",\n \"description\": null,\n \"type\": \"string\",\n \"required\": true,\n \"value\": null,\n \"default\": null,\n \"allowedValues\": [\n\n ]\n },\n {\n \"name\": \"table\",\n \"label\": \"Table\",\n \"description\": null,\n \"type\": \"string\",\n \"required\": false,\n \"value\": null,\n \"default\": null,\n \"allowedValues\": [\n\n ]\n },\n {\n \"name\": \"abool\",\n \"label\": \"A Bool\",\n \"description\": null,\n \"type\": \"bool\",\n \"required\": false,\n \"value\": null,\n \"default\": false,\n \"allowedValues\": [\n\n ]\n },\n {\n \"name\": \"afloat\",\n \"label\": \"A Float\",\n \"description\": null,\n \"type\": \"float\",\n \"required\": false,\n \"value\": null,\n \"default\": null,\n \"allowedValues\": [\n\n ]\n },\n {\n \"name\": \"optionalstr\",\n \"label\": \"Optional String\",\n \"description\": null,\n \"type\": \"string\",\n \"required\": false,\n \"value\": null,\n \"default\": null,\n \"allowedValues\": [\n\n ]\n },\n {\n \"name\": \"cred\",\n \"label\": \"Cred\",\n \"description\": null,\n \"type\": \"credential_redshift\",\n \"required\": false,\n \"value\": null,\n \"default\": null,\n \"allowedValues\": [\n\n ]\n },\n {\n \"name\": \"cred2\",\n \"label\": \"Cred AWS\",\n \"description\": null,\n \"type\": \"credential_aws\",\n \"required\": false,\n \"value\": null,\n \"default\": null,\n \"allowedValues\": [\n\n ]\n }\n ],\n \"arguments\": {\n \"id\": 2,\n \"state\": \"IL\",\n \"table\": \"test.test\"\n },\n \"isTemplate\": false,\n \"publishedAsTemplateId\": null,\n \"fromTemplateId\": null,\n \"templateDependentsCount\": null,\n \"templateScriptName\": null,\n \"links\": {\n \"details\": \"api.civis.test/scripts/sql/2188\",\n \"runs\": \"api.civis.test/scripts/sql/2188/runs\"\n },\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n },\n \"notifications\": {\n \"urls\": [\n\n ],\n \"successEmailSubject\": \"success email subject\",\n \"successEmailBody\": \"success_email_template\",\n \"successEmailAddresses\": [\n \"script_spec_user@civisanalytics.com\"\n ],\n \"successEmailFromName\": null,\n \"successEmailReplyTo\": null,\n \"failureEmailAddresses\": [\n \"script_spec_user@civisanalytics.com\"\n ],\n \"stallWarningMinutes\": null,\n \"successOn\": true,\n \"failureOn\": true\n },\n \"runningAs\": {\n \"id\": 2245,\n \"name\": \"User devuserfactory1811 1811\",\n \"username\": \"devuserfactory1811\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"nextRunAt\": null,\n \"timeZone\": \"America/Chicago\",\n \"lastRun\": {\n \"id\": 184,\n \"state\": \"running\",\n \"createdAt\": \"2024-12-03T19:45:34.000Z\",\n \"startedAt\": null,\n \"finishedAt\": \"2024-12-03T19:45:34.000Z\",\n \"error\": null\n },\n \"myPermissionLevel\": \"manage\",\n \"hidden\": false,\n \"targetProjectId\": null,\n \"archived\": false,\n \"sql\": \"SELECT * FROM table LIMIT 10;\",\n \"expandedArguments\": {\n \"id\": 2,\n \"state\": \"IL\",\n \"state.literal\": \"'IL'\",\n \"state.identifier\": \"\\\"IL\\\"\",\n \"state.shell_escaped\": \"IL\",\n \"table\": \"test.test\",\n \"table.literal\": \"'test.test'\",\n \"table.identifier\": \"\\\"test.test\\\"\",\n \"table.shell_escaped\": \"test.test\",\n \"abool\": false,\n \"afloat\": 0,\n \"optionalstr\": \"\",\n \"optionalstr.literal\": \"''\",\n \"optionalstr.identifier\": \"\\\"\\\"\",\n \"optionalstr.shell_escaped\": \"''\",\n \"cred.id\": \"\",\n \"cred.username\": \"\",\n \"cred.password\": \"\",\n \"cred2.id\": \"\",\n \"cred2.access_key_id\": \"\",\n \"cred2.secret_access_key\": \"\"\n },\n \"remoteHostId\": 179,\n \"credentialId\": 483,\n \"codePreview\": \"SELECT * FROM table LIMIT 10;\",\n \"csvSettings\": {\n \"includeHeader\": true,\n \"compression\": \"gzip\",\n \"columnDelimiter\": \"comma\",\n \"unquoted\": false,\n \"forceMultifile\": false,\n \"filenamePrefix\": null,\n \"maxFileSize\": null\n },\n \"runningAsId\": 2245\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"628c9aac010017356b0e857052e0f863\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"3c54b232-de41-4af4-b140-b19e67fcee89","X-Runtime":"0.056800","Content-Length":"3495"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/scripts/sql/2188\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer JYsAzWYgM7gt5K04849zxfafVwx0xDvM7VB25Xpqk-E\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Scripts","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/scripts/sql/:script_dependent_id","description":"View a script's details that is a template dependent","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/scripts/sql/2239","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer aph4cNq-95RGmzkibsECPJUkLpICMIB2Kp-tfnUaBmw","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 2239,\n \"name\": \"awesome sql template #2239\",\n \"type\": \"Custom\",\n \"createdAt\": \"2024-12-03T19:45:39.000Z\",\n \"updatedAt\": \"2024-12-03T19:45:39.000Z\",\n \"author\": {\n \"id\": 2287,\n \"name\": \"User devuserfactory1848 1848\",\n \"username\": \"devuserfactory1848\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"state\": \"idle\",\n \"finishedAt\": null,\n \"category\": \"script\",\n \"projects\": [\n\n ],\n \"parentId\": null,\n \"userContext\": \"runner\",\n \"params\": [\n {\n \"name\": \"id\",\n \"label\": \"ID\",\n \"description\": null,\n \"type\": \"integer\",\n \"required\": true,\n \"value\": null,\n \"default\": null,\n \"allowedValues\": [\n\n ]\n },\n {\n \"name\": \"state\",\n \"label\": \"State\",\n \"description\": null,\n \"type\": \"string\",\n \"required\": true,\n \"value\": null,\n \"default\": null,\n \"allowedValues\": [\n\n ]\n },\n {\n \"name\": \"table\",\n \"label\": \"Table\",\n \"description\": null,\n \"type\": \"string\",\n \"required\": false,\n \"value\": null,\n \"default\": null,\n \"allowedValues\": [\n\n ]\n }\n ],\n \"arguments\": {\n \"id\": 2,\n \"state\": \"IL\",\n \"table\": \"test.test\"\n },\n \"isTemplate\": false,\n \"publishedAsTemplateId\": null,\n \"fromTemplateId\": 164,\n \"templateDependentsCount\": null,\n \"templateScriptName\": \"Script #2236\",\n \"links\": {\n \"details\": \"api.civis.test/scripts/custom/2239\",\n \"runs\": \"api.civis.test/scripts/custom/2239/runs\"\n },\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n },\n \"notifications\": {\n \"urls\": [\n\n ],\n \"successEmailSubject\": null,\n \"successEmailBody\": null,\n \"successEmailAddresses\": [\n\n ],\n \"successEmailFromName\": null,\n \"successEmailReplyTo\": null,\n \"failureEmailAddresses\": [\n\n ],\n \"stallWarningMinutes\": null,\n \"successOn\": true,\n \"failureOn\": true\n },\n \"runningAs\": {\n \"id\": 2287,\n \"name\": \"User devuserfactory1848 1848\",\n \"username\": \"devuserfactory1848\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"nextRunAt\": null,\n \"timeZone\": \"America/Chicago\",\n \"lastRun\": null,\n \"myPermissionLevel\": \"manage\",\n \"hidden\": false,\n \"targetProjectId\": null,\n \"archived\": false,\n \"sql\": \"select * from {{table}} where id = {{id}} and state = '{{state}}'\",\n \"expandedArguments\": {\n \"id\": 2,\n \"state\": \"IL\",\n \"state.literal\": \"'IL'\",\n \"state.identifier\": \"\\\"IL\\\"\",\n \"state.shell_escaped\": \"IL\",\n \"table\": \"test.test\",\n \"table.literal\": \"'test.test'\",\n \"table.identifier\": \"\\\"test.test\\\"\",\n \"table.shell_escaped\": \"test.test\"\n },\n \"remoteHostId\": 197,\n \"credentialId\": 535,\n \"codePreview\": \"select * from test.test where id = 2 and state = 'IL'\",\n \"csvSettings\": {\n \"includeHeader\": true,\n \"compression\": \"gzip\",\n \"columnDelimiter\": \"comma\",\n \"unquoted\": false,\n \"forceMultifile\": false,\n \"filenamePrefix\": null,\n \"maxFileSize\": null\n },\n \"runningAsId\": 2287\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"34c30851b2b0967eeb20095785c525c8\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"877f723b-f18e-49d7-9725-199588782937","X-Runtime":"0.071346","Content-Length":"2332"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/scripts/sql/2239\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer aph4cNq-95RGmzkibsECPJUkLpICMIB2Kp-tfnUaBmw\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Scripts","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/scripts/sql/:script_template_id","description":"View a script's details that is a template dependent","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/scripts/sql/2249","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer MCBMXCmq2XladYDSiXWy-JnuyuLHiWKNb4QK8SUKo5E","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 2249,\n \"name\": \"Script #2249\",\n \"type\": \"SQL\",\n \"createdAt\": \"2024-12-03T19:45:41.000Z\",\n \"updatedAt\": \"2024-12-03T19:45:41.000Z\",\n \"author\": {\n \"id\": 2300,\n \"name\": \"User devuserfactory1858 1858\",\n \"username\": \"devuserfactory1858\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"state\": \"idle\",\n \"finishedAt\": null,\n \"category\": \"script\",\n \"projects\": [\n\n ],\n \"parentId\": null,\n \"userContext\": \"runner\",\n \"params\": [\n {\n \"name\": \"id\",\n \"label\": \"ID\",\n \"description\": null,\n \"type\": \"integer\",\n \"required\": true,\n \"value\": null,\n \"default\": null,\n \"allowedValues\": [\n\n ]\n },\n {\n \"name\": \"state\",\n \"label\": \"State\",\n \"description\": null,\n \"type\": \"string\",\n \"required\": true,\n \"value\": null,\n \"default\": null,\n \"allowedValues\": [\n\n ]\n },\n {\n \"name\": \"table\",\n \"label\": \"Table\",\n \"description\": null,\n \"type\": \"string\",\n \"required\": false,\n \"value\": null,\n \"default\": null,\n \"allowedValues\": [\n\n ]\n }\n ],\n \"arguments\": {\n },\n \"isTemplate\": true,\n \"publishedAsTemplateId\": 165,\n \"fromTemplateId\": null,\n \"templateDependentsCount\": 1,\n \"templateScriptName\": null,\n \"links\": {\n \"details\": \"api.civis.test/scripts/sql/2249\",\n \"runs\": \"api.civis.test/scripts/sql/2249/runs\"\n },\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n },\n \"notifications\": {\n \"urls\": [\n\n ],\n \"successEmailSubject\": null,\n \"successEmailBody\": null,\n \"successEmailAddresses\": [\n\n ],\n \"successEmailFromName\": null,\n \"successEmailReplyTo\": null,\n \"failureEmailAddresses\": [\n\n ],\n \"stallWarningMinutes\": null,\n \"successOn\": true,\n \"failureOn\": true\n },\n \"runningAs\": {\n \"id\": 2300,\n \"name\": \"User devuserfactory1858 1858\",\n \"username\": \"devuserfactory1858\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"nextRunAt\": null,\n \"timeZone\": \"America/Chicago\",\n \"lastRun\": null,\n \"myPermissionLevel\": \"manage\",\n \"hidden\": false,\n \"targetProjectId\": null,\n \"archived\": false,\n \"sql\": \"select * from {{table}} where id = {{id}} and state = '{{state}}'\",\n \"expandedArguments\": {\n \"id\": null,\n \"state\": null,\n \"state.literal\": null,\n \"state.identifier\": null,\n \"state.shell_escaped\": null,\n \"table\": \"\",\n \"table.literal\": \"''\",\n \"table.identifier\": \"\\\"\\\"\",\n \"table.shell_escaped\": \"''\"\n },\n \"remoteHostId\": 205,\n \"credentialId\": 557,\n \"codePreview\": \"select * from where id = {{id}} and state = '{{state}}'\",\n \"csvSettings\": {\n \"includeHeader\": true,\n \"compression\": \"gzip\",\n \"columnDelimiter\": \"comma\",\n \"unquoted\": false,\n \"forceMultifile\": false,\n \"filenamePrefix\": null,\n \"maxFileSize\": null\n },\n \"runningAsId\": 2300\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"ff0b6d58310e576966c57043e47d54d3\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"585563e0-bb5d-488a-847e-7a015a599c6d","X-Runtime":"0.049912","Content-Length":"2222"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/scripts/sql/2249\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer MCBMXCmq2XladYDSiXWy-JnuyuLHiWKNb4QK8SUKo5E\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"put":{"summary":"Replace all attributes of this SQL Script","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID for the script.","type":"integer"},{"name":"Object547","in":"body","schema":{"$ref":"#/definitions/Object547"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object545"}}},"x-examples":[{"resource":"Scripts","resource_explanation":null,"http_method":"PUT","route":"http://api.civis.test/scripts/sql/:id","description":"Update a SQL Script via Put","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"PUT","request_path":"http://api.civis.test/scripts/sql/2451","request_body":"{\n \"name\": \"My updated SQL script\",\n \"parent_id\": null,\n \"sql\": \"select * from a_new.table\",\n \"remote_host_id\": 298,\n \"credential_id\": 830,\n \"running_as_id\": 2512,\n \"notifications\": {\n \"success_email_addresses\": \"test3@civisanalytics.com\",\n \"failure_email_addresses\": \"test4@civisanalytics.com\",\n \"urls\": \"civisanalytics2.com\",\n \"successEmailSubject\": \"new test subject\",\n \"successEmailBody\": \"new test body\",\n \"stallWarningMinutes\": 30,\n \"successOn\": true,\n \"failureOn\": false\n }\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer yIQLLjRRu2YmWo-Go9kjUcZkKozl7WPBCpXVmlBV_ro","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 2451,\n \"name\": \"My updated SQL script\",\n \"type\": \"SQL\",\n \"createdAt\": \"2024-12-03T19:46:06.000Z\",\n \"updatedAt\": \"2024-12-03T19:46:06.000Z\",\n \"author\": {\n \"id\": 2512,\n \"name\": \"User devuserfactory2035 2035\",\n \"username\": \"devuserfactory2035\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"state\": \"running\",\n \"finishedAt\": \"2024-12-03T19:46:06.000Z\",\n \"category\": \"script\",\n \"projects\": [\n {\n \"id\": 47,\n \"name\": \"Test Project\"\n }\n ],\n \"parentId\": null,\n \"userContext\": \"runner\",\n \"params\": [\n\n ],\n \"arguments\": {\n },\n \"isTemplate\": false,\n \"publishedAsTemplateId\": null,\n \"fromTemplateId\": null,\n \"templateDependentsCount\": null,\n \"templateScriptName\": null,\n \"links\": {\n \"details\": \"api.civis.test/scripts/sql/2451\",\n \"runs\": \"api.civis.test/scripts/sql/2451/runs\"\n },\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n },\n \"notifications\": {\n \"urls\": [\n \"civisanalytics2.com\"\n ],\n \"successEmailSubject\": \"new test subject\",\n \"successEmailBody\": \"new test body\",\n \"successEmailAddresses\": [\n \"test3@civisanalytics.com\"\n ],\n \"successEmailFromName\": null,\n \"successEmailReplyTo\": null,\n \"failureEmailAddresses\": [\n \"test4@civisanalytics.com\"\n ],\n \"stallWarningMinutes\": 30,\n \"successOn\": true,\n \"failureOn\": false\n },\n \"runningAs\": {\n \"id\": 2512,\n \"name\": \"User devuserfactory2035 2035\",\n \"username\": \"devuserfactory2035\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"nextRunAt\": null,\n \"timeZone\": \"America/Chicago\",\n \"lastRun\": {\n \"id\": 216,\n \"state\": \"running\",\n \"createdAt\": \"2024-12-03T19:46:06.000Z\",\n \"startedAt\": null,\n \"finishedAt\": \"2024-12-03T19:46:06.000Z\",\n \"error\": null\n },\n \"myPermissionLevel\": \"manage\",\n \"hidden\": false,\n \"targetProjectId\": null,\n \"archived\": false,\n \"sql\": \"select * from a_new.table\",\n \"expandedArguments\": {\n },\n \"remoteHostId\": 298,\n \"credentialId\": 830,\n \"codePreview\": \"select * from a_new.table\",\n \"csvSettings\": {\n \"includeHeader\": true,\n \"compression\": \"gzip\",\n \"columnDelimiter\": \"comma\",\n \"unquoted\": false,\n \"forceMultifile\": false,\n \"filenamePrefix\": null,\n \"maxFileSize\": null\n },\n \"runningAsId\": 2512\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"44195027e42e8c57a769ce1e91879427\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"95730af5-8d96-4171-a509-80f1017a3d2c","X-Runtime":"0.159517","Content-Length":"1884"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/scripts/sql/2451\" -d '{\"name\":\"My updated SQL script\",\"parent_id\":null,\"sql\":\"select * from a_new.table\",\"remote_host_id\":298,\"credential_id\":830,\"running_as_id\":2512,\"notifications\":{\"success_email_addresses\":\"test3@civisanalytics.com\",\"failure_email_addresses\":\"test4@civisanalytics.com\",\"urls\":\"civisanalytics2.com\",\"successEmailSubject\":\"new test subject\",\"successEmailBody\":\"new test body\",\"stallWarningMinutes\":30,\"successOn\":true,\"failureOn\":false}}' -X PUT \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer yIQLLjRRu2YmWo-Go9kjUcZkKozl7WPBCpXVmlBV_ro\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"patch":{"summary":"Update some attributes of this SQL Script","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID for the script.","type":"integer"},{"name":"Object548","in":"body","schema":{"$ref":"#/definitions/Object548"},"required":false}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object545"}}},"x-examples":[{"resource":"Scripts","resource_explanation":null,"http_method":"PATCH","route":"http://api.civis.test/scripts/sql/:id","description":"Update a SQL Script via Patch","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"PATCH","request_path":"http://api.civis.test/scripts/sql/2396","request_body":"{\n \"name\": \"My updated SQL script\",\n \"sql\": \"select * from a_new.table\",\n \"schedule\": {\n \"scheduled\": true,\n \"scheduledDays\": [\n 1\n ],\n \"scheduledHours\": [\n 0,\n 4\n ],\n \"scheduledMinutes\": [\n 15\n ],\n \"scheduledRunsPerHour\": null\n },\n \"notifications\": {\n \"success_email_addresses\": \"test3@civisanalytics.com\",\n \"failure_email_addresses\": \"test4@civisanalytics.com\",\n \"urls\": \"civisanalytics2.com\",\n \"successEmailSubject\": \"new test subject\",\n \"successEmailBody\": \"new test body\",\n \"stallWarningMinutes\": 30,\n \"successOn\": true,\n \"failureOn\": false\n }\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer q311ZYywFiHXp9D6930aV69ZRm1jeoxLUM8boRSL4A0","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 2396,\n \"name\": \"My updated SQL script\",\n \"type\": \"SQL\",\n \"createdAt\": \"2024-12-03T19:45:59.000Z\",\n \"updatedAt\": \"2024-12-03T19:46:00.000Z\",\n \"author\": {\n \"id\": 2457,\n \"name\": \"User devuserfactory1988 1988\",\n \"username\": \"devuserfactory1988\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"state\": \"running\",\n \"finishedAt\": \"2024-12-03T19:45:59.000Z\",\n \"category\": \"script\",\n \"projects\": [\n {\n \"id\": 41,\n \"name\": \"Test Project\"\n }\n ],\n \"parentId\": null,\n \"userContext\": \"runner\",\n \"params\": [\n {\n \"name\": \"id\",\n \"label\": \"ID\",\n \"description\": null,\n \"type\": \"integer\",\n \"required\": true,\n \"value\": null,\n \"default\": null,\n \"allowedValues\": [\n\n ]\n },\n {\n \"name\": \"state\",\n \"label\": \"State\",\n \"description\": null,\n \"type\": \"string\",\n \"required\": true,\n \"value\": null,\n \"default\": null,\n \"allowedValues\": [\n\n ]\n },\n {\n \"name\": \"table\",\n \"label\": \"Table\",\n \"description\": null,\n \"type\": \"string\",\n \"required\": false,\n \"value\": null,\n \"default\": null,\n \"allowedValues\": [\n\n ]\n },\n {\n \"name\": \"abool\",\n \"label\": \"A Bool\",\n \"description\": null,\n \"type\": \"bool\",\n \"required\": false,\n \"value\": null,\n \"default\": false,\n \"allowedValues\": [\n\n ]\n },\n {\n \"name\": \"afloat\",\n \"label\": \"A Float\",\n \"description\": null,\n \"type\": \"float\",\n \"required\": false,\n \"value\": null,\n \"default\": null,\n \"allowedValues\": [\n\n ]\n },\n {\n \"name\": \"optionalstr\",\n \"label\": \"Optional String\",\n \"description\": null,\n \"type\": \"string\",\n \"required\": false,\n \"value\": null,\n \"default\": null,\n \"allowedValues\": [\n\n ]\n },\n {\n \"name\": \"cred\",\n \"label\": \"Cred\",\n \"description\": null,\n \"type\": \"credential_redshift\",\n \"required\": false,\n \"value\": null,\n \"default\": null,\n \"allowedValues\": [\n\n ]\n },\n {\n \"name\": \"cred2\",\n \"label\": \"Cred AWS\",\n \"description\": null,\n \"type\": \"credential_aws\",\n \"required\": false,\n \"value\": null,\n \"default\": null,\n \"allowedValues\": [\n\n ]\n }\n ],\n \"arguments\": {\n \"id\": 2,\n \"state\": \"IL\",\n \"table\": \"test.test\"\n },\n \"isTemplate\": false,\n \"publishedAsTemplateId\": null,\n \"fromTemplateId\": null,\n \"templateDependentsCount\": null,\n \"templateScriptName\": null,\n \"links\": {\n \"details\": \"api.civis.test/scripts/sql/2396\",\n \"runs\": \"api.civis.test/scripts/sql/2396/runs\"\n },\n \"schedule\": {\n \"scheduled\": true,\n \"scheduledDays\": [\n 1\n ],\n \"scheduledHours\": [\n 0,\n 4\n ],\n \"scheduledMinutes\": [\n 15\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n },\n \"notifications\": {\n \"urls\": [\n \"civisanalytics2.com\"\n ],\n \"successEmailSubject\": \"new test subject\",\n \"successEmailBody\": \"new test body\",\n \"successEmailAddresses\": [\n \"test3@civisanalytics.com\"\n ],\n \"successEmailFromName\": null,\n \"successEmailReplyTo\": null,\n \"failureEmailAddresses\": [\n \"test4@civisanalytics.com\"\n ],\n \"stallWarningMinutes\": 30,\n \"successOn\": true,\n \"failureOn\": false\n },\n \"runningAs\": {\n \"id\": 2457,\n \"name\": \"User devuserfactory1988 1988\",\n \"username\": \"devuserfactory1988\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"nextRunAt\": \"2024-12-09T06:15:00.000Z\",\n \"timeZone\": \"America/Chicago\",\n \"lastRun\": {\n \"id\": 210,\n \"state\": \"running\",\n \"createdAt\": \"2024-12-03T19:45:59.000Z\",\n \"startedAt\": null,\n \"finishedAt\": \"2024-12-03T19:45:59.000Z\",\n \"error\": null\n },\n \"myPermissionLevel\": \"manage\",\n \"hidden\": false,\n \"targetProjectId\": null,\n \"archived\": false,\n \"sql\": \"select * from a_new.table\",\n \"expandedArguments\": {\n \"id\": 2,\n \"state\": \"IL\",\n \"state.literal\": \"'IL'\",\n \"state.identifier\": \"\\\"IL\\\"\",\n \"state.shell_escaped\": \"IL\",\n \"table\": \"test.test\",\n \"table.literal\": \"'test.test'\",\n \"table.identifier\": \"\\\"test.test\\\"\",\n \"table.shell_escaped\": \"test.test\",\n \"abool\": false,\n \"afloat\": 0,\n \"optionalstr\": \"\",\n \"optionalstr.literal\": \"''\",\n \"optionalstr.identifier\": \"\\\"\\\"\",\n \"optionalstr.shell_escaped\": \"''\",\n \"cred.id\": \"\",\n \"cred.username\": \"\",\n \"cred.password\": \"\",\n \"cred2.id\": \"\",\n \"cred2.access_key_id\": \"\",\n \"cred2.secret_access_key\": \"\"\n },\n \"remoteHostId\": 275,\n \"credentialId\": 761,\n \"codePreview\": \"select * from a_new.table\",\n \"csvSettings\": {\n \"includeHeader\": true,\n \"compression\": \"gzip\",\n \"columnDelimiter\": \"comma\",\n \"unquoted\": false,\n \"forceMultifile\": false,\n \"filenamePrefix\": null,\n \"maxFileSize\": null\n },\n \"runningAsId\": 2457\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"b76af624eead8f1bf54ca6a766e48174\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"dfcb99b9-bc32-46a7-bd33-f203337037c2","X-Runtime":"0.128779","Content-Length":"3508"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/scripts/sql/2396\" -d '{\"name\":\"My updated SQL script\",\"sql\":\"select * from a_new.table\",\"schedule\":{\"scheduled\":true,\"scheduledDays\":[1],\"scheduledHours\":[0,4],\"scheduledMinutes\":[15],\"scheduledRunsPerHour\":null},\"notifications\":{\"success_email_addresses\":\"test3@civisanalytics.com\",\"failure_email_addresses\":\"test4@civisanalytics.com\",\"urls\":\"civisanalytics2.com\",\"successEmailSubject\":\"new test subject\",\"successEmailBody\":\"new test body\",\"stallWarningMinutes\":30,\"successOn\":true,\"failureOn\":false}}' -X PATCH \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer q311ZYywFiHXp9D6930aV69ZRm1jeoxLUM8boRSL4A0\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"delete":{"summary":"Archive a SQL Script (deprecated, use archiving endpoints instead)","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/python3":{"post":{"summary":"Create a Python Script","description":null,"deprecated":false,"parameters":[{"name":"Object549","in":"body","schema":{"$ref":"#/definitions/Object549"},"required":true}],"responses":{"201":{"description":"success","schema":{"$ref":"#/definitions/Object550"}}},"x-examples":[{"resource":"Scripts","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/scripts/python3","description":"Create a python script","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/scripts/python3","request_body":"{\n \"name\": \"My new python script\",\n \"source\": \"print('Hello World')\"\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer ved9CeroAsKrCSAF0pjMhA6MsoSihWPfpC2oVTRkUD4","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":201,"response_status_text":"Created","response_body":"{\n \"id\": 2353,\n \"name\": \"My new python script\",\n \"type\": \"Python\",\n \"createdAt\": \"2024-12-03T19:45:54.000Z\",\n \"updatedAt\": \"2024-12-03T19:45:54.000Z\",\n \"author\": {\n \"id\": 2410,\n \"name\": \"User devuserfactory1948 1948\",\n \"username\": \"devuserfactory1948\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"state\": \"idle\",\n \"finishedAt\": null,\n \"category\": \"script\",\n \"projects\": [\n\n ],\n \"parentId\": null,\n \"userContext\": \"runner\",\n \"params\": [\n\n ],\n \"arguments\": {\n },\n \"isTemplate\": false,\n \"publishedAsTemplateId\": null,\n \"fromTemplateId\": null,\n \"templateDependentsCount\": null,\n \"templateScriptName\": null,\n \"links\": {\n \"details\": \"api.civis.test/scripts/python3/2353\",\n \"runs\": \"api.civis.test/scripts/python3/2353/runs\"\n },\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n },\n \"notifications\": {\n \"urls\": [\n\n ],\n \"successEmailSubject\": null,\n \"successEmailBody\": null,\n \"successEmailAddresses\": [\n\n ],\n \"successEmailFromName\": null,\n \"successEmailReplyTo\": null,\n \"failureEmailAddresses\": [\n\n ],\n \"stallWarningMinutes\": null,\n \"successOn\": true,\n \"failureOn\": true\n },\n \"runningAs\": {\n \"id\": 2410,\n \"name\": \"User devuserfactory1948 1948\",\n \"username\": \"devuserfactory1948\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"nextRunAt\": null,\n \"timeZone\": \"America/Chicago\",\n \"lastRun\": null,\n \"myPermissionLevel\": \"manage\",\n \"hidden\": false,\n \"targetProjectId\": null,\n \"archived\": false,\n \"requiredResources\": {\n \"cpu\": null,\n \"memory\": null,\n \"diskSpace\": null\n },\n \"instanceType\": null,\n \"cancelTimeout\": 0,\n \"dockerImageTag\": \"mock_latest_tag\",\n \"partitionLabel\": null,\n \"runningAsId\": 2410,\n \"source\": \"print('Hello World')\"\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"fef3cd0247ee95158d97d325aa0148a9\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"3031aa31-833a-4358-8d2e-ccc5e680b83b","X-Runtime":"0.103710","Content-Length":"1497"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/scripts/python3\" -d '{\"name\":\"My new python script\",\"source\":\"print(\\u0027Hello World\\u0027)\"}' -X POST \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer ved9CeroAsKrCSAF0pjMhA6MsoSihWPfpC2oVTRkUD4\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Scripts","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/scripts/python3","description":"Fails if provides a default param value to required param","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/scripts/python3","request_body":"{\n \"name\": \"My new python script\",\n \"params\": [\n {\n \"name\": \"schema\",\n \"label\": \"Schema\",\n \"description\": \"the schema of the table\",\n \"type\": \"string\",\n \"required\": true,\n \"value\": null,\n \"default\": \"cool_schema\",\n \"allowedValues\": []\n },\n {\n \"name\": \"table\",\n \"label\": \"Table\",\n \"description\": \"the name of the table\",\n \"type\": \"string\",\n \"required\": true,\n \"value\": null,\n \"default\": \"cool_table\",\n \"allowedValues\": []\n }\n ],\n \"source\": \"print(\\\"Hello world\\\")\"\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer QjONc9qGRoPCo7bD9mhj5R4yHCDXEYdj9l6IHMY_yok","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":400,"response_status_text":"Bad Request","response_body":"{\n \"error\": \"bad_request\",\n \"errorDescription\": \"The given request was not as expected: Validation failed: Code.Parameters schema cannot have a default value since it is required., Code.Parameters table cannot have a default value since it is required.\",\n \"code\": 400\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"100fb2be-9940-4c25-a365-f832d04dc32b","X-Runtime":"0.066173","Content-Length":"259"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/scripts/python3\" -d '{\"name\":\"My new python script\",\"params\":[{\"name\":\"schema\",\"label\":\"Schema\",\"description\":\"the schema of the table\",\"type\":\"string\",\"required\":true,\"value\":null,\"default\":\"cool_schema\",\"allowedValues\":[]},{\"name\":\"table\",\"label\":\"Table\",\"description\":\"the name of the table\",\"type\":\"string\",\"required\":true,\"value\":null,\"default\":\"cool_table\",\"allowedValues\":[]}],\"source\":\"print(\\\"Hello world\\\")\"}' -X POST \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer QjONc9qGRoPCo7bD9mhj5R4yHCDXEYdj9l6IHMY_yok\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/scripts/python3/{id}":{"get":{"summary":"Get a Python Script","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object550"}}},"x-examples":[{"resource":"Scripts","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/scripts/python3/:python_id","description":"View a Python script's details","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/scripts/python3/2199","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer nvHi8XEhuCaAEcuihEUAIEt8fdzF7AOL3REq4dALf_k","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 2199,\n \"name\": \"Script #2199\",\n \"type\": \"Python\",\n \"createdAt\": \"2024-12-03T19:45:35.000Z\",\n \"updatedAt\": \"2024-12-03T19:45:35.000Z\",\n \"author\": {\n \"id\": 2252,\n \"name\": \"User devuserfactory1817 1817\",\n \"username\": \"devuserfactory1817\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"state\": \"idle\",\n \"finishedAt\": null,\n \"category\": \"script\",\n \"projects\": [\n\n ],\n \"parentId\": null,\n \"userContext\": \"runner\",\n \"params\": [\n\n ],\n \"arguments\": {\n },\n \"isTemplate\": false,\n \"publishedAsTemplateId\": null,\n \"fromTemplateId\": null,\n \"templateDependentsCount\": null,\n \"templateScriptName\": null,\n \"links\": {\n \"details\": \"api.civis.test/scripts/python3/2199\",\n \"runs\": \"api.civis.test/scripts/python3/2199/runs\"\n },\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n },\n \"notifications\": {\n \"urls\": [\n\n ],\n \"successEmailSubject\": null,\n \"successEmailBody\": null,\n \"successEmailAddresses\": [\n\n ],\n \"successEmailFromName\": null,\n \"successEmailReplyTo\": null,\n \"failureEmailAddresses\": [\n\n ],\n \"stallWarningMinutes\": null,\n \"successOn\": true,\n \"failureOn\": true\n },\n \"runningAs\": {\n \"id\": 2252,\n \"name\": \"User devuserfactory1817 1817\",\n \"username\": \"devuserfactory1817\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"nextRunAt\": null,\n \"timeZone\": \"America/Chicago\",\n \"lastRun\": null,\n \"myPermissionLevel\": \"manage\",\n \"hidden\": false,\n \"targetProjectId\": null,\n \"archived\": false,\n \"requiredResources\": {\n \"cpu\": null,\n \"memory\": null,\n \"diskSpace\": 1.0\n },\n \"instanceType\": null,\n \"cancelTimeout\": 0,\n \"dockerImageTag\": \"mock_latest_tag\",\n \"partitionLabel\": null,\n \"runningAsId\": 2252,\n \"source\": \"print 'Hello World'\"\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"cd3b7f74d115e82dc598b0384d35b63a\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"3938e5b4-2d27-4751-8d2e-1500caa96505","X-Runtime":"0.060167","Content-Length":"1487"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/scripts/python3/2199\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer nvHi8XEhuCaAEcuihEUAIEt8fdzF7AOL3REq4dALf_k\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"put":{"summary":"Replace all attributes of this Python Script","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID for the script.","type":"integer"},{"name":"Object551","in":"body","schema":{"$ref":"#/definitions/Object551"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object550"}}},"x-examples":[{"resource":"Scripts","resource_explanation":null,"http_method":"PUT","route":"http://api.civis.test/scripts/python3/:python_id","description":"Update a Python Script via Put","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"PUT","request_path":"http://api.civis.test/scripts/python3/2480","request_body":"{\n \"id\": 2480,\n \"name\": \"My updated Python script\",\n \"parent_id\": null,\n \"running_as_id\": 2537,\n \"source\": \"print('Hello New World')\"\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer rNnLbjnOruBUsnujgDLRIHiXqvcFIL35R9JEmm7L3TQ","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 2480,\n \"name\": \"My updated Python script\",\n \"type\": \"Python\",\n \"createdAt\": \"2024-12-03T19:46:09.000Z\",\n \"updatedAt\": \"2024-12-03T19:46:09.000Z\",\n \"author\": {\n \"id\": 2537,\n \"name\": \"User devuserfactory2057 2057\",\n \"username\": \"devuserfactory2057\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"state\": \"idle\",\n \"finishedAt\": null,\n \"category\": \"script\",\n \"projects\": [\n\n ],\n \"parentId\": null,\n \"userContext\": \"runner\",\n \"params\": [\n\n ],\n \"arguments\": {\n },\n \"isTemplate\": false,\n \"publishedAsTemplateId\": null,\n \"fromTemplateId\": null,\n \"templateDependentsCount\": null,\n \"templateScriptName\": null,\n \"links\": {\n \"details\": \"api.civis.test/scripts/python3/2480\",\n \"runs\": \"api.civis.test/scripts/python3/2480/runs\"\n },\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n },\n \"notifications\": {\n \"urls\": [\n\n ],\n \"successEmailSubject\": null,\n \"successEmailBody\": null,\n \"successEmailAddresses\": [\n\n ],\n \"successEmailFromName\": null,\n \"successEmailReplyTo\": null,\n \"failureEmailAddresses\": [\n\n ],\n \"stallWarningMinutes\": null,\n \"successOn\": true,\n \"failureOn\": true\n },\n \"runningAs\": {\n \"id\": 2537,\n \"name\": \"User devuserfactory2057 2057\",\n \"username\": \"devuserfactory2057\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"nextRunAt\": null,\n \"timeZone\": \"America/Chicago\",\n \"lastRun\": null,\n \"myPermissionLevel\": \"manage\",\n \"hidden\": false,\n \"targetProjectId\": null,\n \"archived\": false,\n \"requiredResources\": {\n \"cpu\": null,\n \"memory\": null,\n \"diskSpace\": 1.0\n },\n \"instanceType\": null,\n \"cancelTimeout\": 0,\n \"dockerImageTag\": null,\n \"partitionLabel\": null,\n \"runningAsId\": 2537,\n \"source\": \"print('Hello New World')\"\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"be82b2aaf9720a3b768de45dbe0ef541\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"f81edff0-2644-468c-af70-48425ad3bbff","X-Runtime":"0.089531","Content-Length":"1491"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/scripts/python3/2480\" -d '{\"id\":2480,\"name\":\"My updated Python script\",\"parent_id\":null,\"running_as_id\":2537,\"source\":\"print(\\u0027Hello New World\\u0027)\"}' -X PUT \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer rNnLbjnOruBUsnujgDLRIHiXqvcFIL35R9JEmm7L3TQ\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"patch":{"summary":"Update some attributes of this Python Script","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID for the script.","type":"integer"},{"name":"Object552","in":"body","schema":{"$ref":"#/definitions/Object552"},"required":false}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object550"}}},"x-examples":[{"resource":"Scripts","resource_explanation":null,"http_method":"PATCH","route":"http://api.civis.test/scripts/python3/:python_id","description":"Update a Python Script via Patch","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"PATCH","request_path":"http://api.civis.test/scripts/python3/2416","request_body":"{\n \"name\": \"My updated Python script\",\n \"source\": \"print('Hello New World')\"\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer 4mPqJKQSV_pa8qnwsgmW85ILwxJHZf6Be6-bamE3Sn4","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 2416,\n \"name\": \"My updated Python script\",\n \"type\": \"Python\",\n \"createdAt\": \"2024-12-03T19:46:01.000Z\",\n \"updatedAt\": \"2024-12-03T19:46:02.000Z\",\n \"author\": {\n \"id\": 2473,\n \"name\": \"User devuserfactory2002 2002\",\n \"username\": \"devuserfactory2002\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"state\": \"idle\",\n \"finishedAt\": null,\n \"category\": \"script\",\n \"projects\": [\n\n ],\n \"parentId\": null,\n \"userContext\": \"runner\",\n \"params\": [\n\n ],\n \"arguments\": {\n },\n \"isTemplate\": false,\n \"publishedAsTemplateId\": null,\n \"fromTemplateId\": null,\n \"templateDependentsCount\": null,\n \"templateScriptName\": null,\n \"links\": {\n \"details\": \"api.civis.test/scripts/python3/2416\",\n \"runs\": \"api.civis.test/scripts/python3/2416/runs\"\n },\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n },\n \"notifications\": {\n \"urls\": [\n\n ],\n \"successEmailSubject\": null,\n \"successEmailBody\": null,\n \"successEmailAddresses\": [\n\n ],\n \"successEmailFromName\": null,\n \"successEmailReplyTo\": null,\n \"failureEmailAddresses\": [\n\n ],\n \"stallWarningMinutes\": null,\n \"successOn\": true,\n \"failureOn\": true\n },\n \"runningAs\": {\n \"id\": 2473,\n \"name\": \"User devuserfactory2002 2002\",\n \"username\": \"devuserfactory2002\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"nextRunAt\": null,\n \"timeZone\": \"America/Chicago\",\n \"lastRun\": null,\n \"myPermissionLevel\": \"manage\",\n \"hidden\": false,\n \"targetProjectId\": null,\n \"archived\": false,\n \"requiredResources\": {\n \"cpu\": null,\n \"memory\": null,\n \"diskSpace\": 1.0\n },\n \"instanceType\": null,\n \"cancelTimeout\": 0,\n \"dockerImageTag\": \"mock_latest_tag\",\n \"partitionLabel\": null,\n \"runningAsId\": 2473,\n \"source\": \"print('Hello New World')\"\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"eddd20f58c2b72428d9b2e67589a65e2\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"263e3b61-8273-4585-aaa2-e3b34229b15c","X-Runtime":"0.097011","Content-Length":"1504"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/scripts/python3/2416\" -d '{\"name\":\"My updated Python script\",\"source\":\"print(\\u0027Hello New World\\u0027)\"}' -X PATCH \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer 4mPqJKQSV_pa8qnwsgmW85ILwxJHZf6Be6-bamE3Sn4\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"delete":{"summary":"Archive a Python Script (deprecated, use archiving endpoints instead)","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/r":{"post":{"summary":"Create an R Script","description":null,"deprecated":false,"parameters":[{"name":"Object553","in":"body","schema":{"$ref":"#/definitions/Object553"},"required":true}],"responses":{"201":{"description":"success","schema":{"$ref":"#/definitions/Object554"}}},"x-examples":[{"resource":"Scripts","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/scripts/r","description":"Create an R script","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/scripts/r","request_body":"{\n \"name\": \"My new R script\",\n \"source\": \"cat('Hello World')\"\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer sO2S-TUqogDM6lYVKivJNE0oECaQKJuwAK2m_SiiHFw","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":201,"response_status_text":"Created","response_body":"{\n \"id\": 2366,\n \"name\": \"My new R script\",\n \"type\": \"R\",\n \"createdAt\": \"2024-12-03T19:45:55.000Z\",\n \"updatedAt\": \"2024-12-03T19:45:55.000Z\",\n \"author\": {\n \"id\": 2424,\n \"name\": \"User devuserfactory1960 1960\",\n \"username\": \"devuserfactory1960\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"state\": \"idle\",\n \"finishedAt\": null,\n \"category\": \"script\",\n \"projects\": [\n\n ],\n \"parentId\": null,\n \"userContext\": \"runner\",\n \"params\": [\n\n ],\n \"arguments\": {\n },\n \"isTemplate\": false,\n \"publishedAsTemplateId\": null,\n \"fromTemplateId\": null,\n \"templateDependentsCount\": null,\n \"templateScriptName\": null,\n \"links\": {\n \"details\": \"api.civis.test/scripts/r/2366\",\n \"runs\": \"api.civis.test/scripts/r/2366/runs\"\n },\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n },\n \"notifications\": {\n \"urls\": [\n\n ],\n \"successEmailSubject\": null,\n \"successEmailBody\": null,\n \"successEmailAddresses\": [\n\n ],\n \"successEmailFromName\": null,\n \"successEmailReplyTo\": null,\n \"failureEmailAddresses\": [\n\n ],\n \"stallWarningMinutes\": null,\n \"successOn\": true,\n \"failureOn\": true\n },\n \"runningAs\": {\n \"id\": 2424,\n \"name\": \"User devuserfactory1960 1960\",\n \"username\": \"devuserfactory1960\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"nextRunAt\": null,\n \"timeZone\": \"America/Chicago\",\n \"lastRun\": null,\n \"myPermissionLevel\": \"manage\",\n \"hidden\": false,\n \"targetProjectId\": null,\n \"archived\": false,\n \"requiredResources\": {\n \"cpu\": null,\n \"memory\": null,\n \"diskSpace\": null\n },\n \"instanceType\": null,\n \"cancelTimeout\": 0,\n \"dockerImageTag\": \"mock_latest_tag\",\n \"partitionLabel\": null,\n \"runningAsId\": 2424,\n \"source\": \"cat('Hello World')\"\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"b2568a2883e18d732ded793d8ad471e6\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"c8f8553a-d1ab-4dce-b001-4a3fe1a9e1c6","X-Runtime":"0.141476","Content-Length":"1473"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/scripts/r\" -d '{\"name\":\"My new R script\",\"source\":\"cat(\\u0027Hello World\\u0027)\"}' -X POST \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer sO2S-TUqogDM6lYVKivJNE0oECaQKJuwAK2m_SiiHFw\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Scripts","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/scripts/r","description":"Fails if provides a default param value to required param","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/scripts/r","request_body":"{\n \"name\": \"My new R script\",\n \"params\": [\n {\n \"name\": \"schema\",\n \"label\": \"Schema\",\n \"description\": \"the schema of the table\",\n \"type\": \"string\",\n \"required\": true,\n \"value\": null,\n \"default\": \"cool_schema\",\n \"allowedValues\": []\n },\n {\n \"name\": \"table\",\n \"label\": \"Table\",\n \"description\": \"the name of the table\",\n \"type\": \"string\",\n \"required\": true,\n \"value\": null,\n \"default\": \"cool_table\",\n \"allowedValues\": []\n }\n ],\n \"source\": \"cat(\\\"Hello world\\\")\"\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer 7jwjdtpRuTKp4KTpSIXLi8n1sJxxCdPfQY1013SFQwU","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":400,"response_status_text":"Bad Request","response_body":"{\n \"error\": \"bad_request\",\n \"errorDescription\": \"The given request was not as expected: Validation failed: Code.Parameters schema cannot have a default value since it is required., Code.Parameters table cannot have a default value since it is required.\",\n \"code\": 400\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"f41b9f68-15ff-4f5a-a2d3-364ea3a95e9a","X-Runtime":"0.055710","Content-Length":"259"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/scripts/r\" -d '{\"name\":\"My new R script\",\"params\":[{\"name\":\"schema\",\"label\":\"Schema\",\"description\":\"the schema of the table\",\"type\":\"string\",\"required\":true,\"value\":null,\"default\":\"cool_schema\",\"allowedValues\":[]},{\"name\":\"table\",\"label\":\"Table\",\"description\":\"the name of the table\",\"type\":\"string\",\"required\":true,\"value\":null,\"default\":\"cool_table\",\"allowedValues\":[]}],\"source\":\"cat(\\\"Hello world\\\")\"}' -X POST \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer 7jwjdtpRuTKp4KTpSIXLi8n1sJxxCdPfQY1013SFQwU\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/scripts/r/{id}":{"get":{"summary":"Get an R Script","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object554"}}},"x-examples":[{"resource":"Scripts","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/scripts/r/:r_id","description":"View an R script's details","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/scripts/r/2208","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer x1RwnT3IxT4aVs4tDC8YDlFky18rDBLr-Nb-0OqsOZA","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 2208,\n \"name\": \"Script #2208\",\n \"type\": \"R\",\n \"createdAt\": \"2024-12-03T19:45:36.000Z\",\n \"updatedAt\": \"2024-12-03T19:45:36.000Z\",\n \"author\": {\n \"id\": 2261,\n \"name\": \"User devuserfactory1825 1825\",\n \"username\": \"devuserfactory1825\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"state\": \"idle\",\n \"finishedAt\": null,\n \"category\": \"script\",\n \"projects\": [\n\n ],\n \"parentId\": null,\n \"userContext\": \"runner\",\n \"params\": [\n\n ],\n \"arguments\": {\n },\n \"isTemplate\": false,\n \"publishedAsTemplateId\": null,\n \"fromTemplateId\": null,\n \"templateDependentsCount\": null,\n \"templateScriptName\": null,\n \"links\": {\n \"details\": \"api.civis.test/scripts/r/2208\",\n \"runs\": \"api.civis.test/scripts/r/2208/runs\"\n },\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n },\n \"notifications\": {\n \"urls\": [\n\n ],\n \"successEmailSubject\": null,\n \"successEmailBody\": null,\n \"successEmailAddresses\": [\n\n ],\n \"successEmailFromName\": null,\n \"successEmailReplyTo\": null,\n \"failureEmailAddresses\": [\n\n ],\n \"stallWarningMinutes\": null,\n \"successOn\": true,\n \"failureOn\": true\n },\n \"runningAs\": {\n \"id\": 2261,\n \"name\": \"User devuserfactory1825 1825\",\n \"username\": \"devuserfactory1825\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"nextRunAt\": null,\n \"timeZone\": \"America/Chicago\",\n \"lastRun\": null,\n \"myPermissionLevel\": \"manage\",\n \"hidden\": false,\n \"targetProjectId\": null,\n \"archived\": false,\n \"requiredResources\": {\n \"cpu\": null,\n \"memory\": null,\n \"diskSpace\": 1.0\n },\n \"instanceType\": null,\n \"cancelTimeout\": 0,\n \"dockerImageTag\": \"mock_latest_tag\",\n \"partitionLabel\": null,\n \"runningAsId\": 2261,\n \"source\": \"cat('Hello World')\"\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"e54aaa517930589b3070911d34cf1a5e\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"3a788de8-c88b-417e-ac83-a7e45f2942ef","X-Runtime":"0.039921","Content-Length":"1469"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/scripts/r/2208\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer x1RwnT3IxT4aVs4tDC8YDlFky18rDBLr-Nb-0OqsOZA\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"put":{"summary":"Replace all attributes of this R Script","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID for the script.","type":"integer"},{"name":"Object555","in":"body","schema":{"$ref":"#/definitions/Object555"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object554"}}},"x-examples":[{"resource":"Scripts","resource_explanation":null,"http_method":"PUT","route":"http://api.civis.test/scripts/r/:r_id","description":"Update an R Script via Put","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"PUT","request_path":"http://api.civis.test/scripts/r/2489","request_body":"{\n \"id\": 2489,\n \"name\": \"My updated R script\",\n \"parent_id\": null,\n \"running_as_id\": 2546,\n \"source\": \"cat('Hello New World')\"\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer B5gQ7spUoWTu6oMxmunI-WWqVi3xxuHzUV2OEAUiBhI","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 2489,\n \"name\": \"My updated R script\",\n \"type\": \"R\",\n \"createdAt\": \"2024-12-03T19:46:10.000Z\",\n \"updatedAt\": \"2024-12-03T19:46:10.000Z\",\n \"author\": {\n \"id\": 2546,\n \"name\": \"User devuserfactory2065 2065\",\n \"username\": \"devuserfactory2065\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"state\": \"idle\",\n \"finishedAt\": null,\n \"category\": \"script\",\n \"projects\": [\n\n ],\n \"parentId\": null,\n \"userContext\": \"runner\",\n \"params\": [\n\n ],\n \"arguments\": {\n },\n \"isTemplate\": false,\n \"publishedAsTemplateId\": null,\n \"fromTemplateId\": null,\n \"templateDependentsCount\": null,\n \"templateScriptName\": null,\n \"links\": {\n \"details\": \"api.civis.test/scripts/r/2489\",\n \"runs\": \"api.civis.test/scripts/r/2489/runs\"\n },\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n },\n \"notifications\": {\n \"urls\": [\n\n ],\n \"successEmailSubject\": null,\n \"successEmailBody\": null,\n \"successEmailAddresses\": [\n\n ],\n \"successEmailFromName\": null,\n \"successEmailReplyTo\": null,\n \"failureEmailAddresses\": [\n\n ],\n \"stallWarningMinutes\": null,\n \"successOn\": true,\n \"failureOn\": true\n },\n \"runningAs\": {\n \"id\": 2546,\n \"name\": \"User devuserfactory2065 2065\",\n \"username\": \"devuserfactory2065\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"nextRunAt\": null,\n \"timeZone\": \"America/Chicago\",\n \"lastRun\": null,\n \"myPermissionLevel\": \"manage\",\n \"hidden\": false,\n \"targetProjectId\": null,\n \"archived\": false,\n \"requiredResources\": {\n \"cpu\": null,\n \"memory\": null,\n \"diskSpace\": 1.0\n },\n \"instanceType\": null,\n \"cancelTimeout\": 0,\n \"dockerImageTag\": null,\n \"partitionLabel\": null,\n \"runningAsId\": 2546,\n \"source\": \"cat('Hello New World')\"\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"5dc0e626e207c778088524910fb9cf6c\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"39182e10-1b0b-4cb5-b70f-026c43a5e84e","X-Runtime":"0.093974","Content-Length":"1467"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/scripts/r/2489\" -d '{\"id\":2489,\"name\":\"My updated R script\",\"parent_id\":null,\"running_as_id\":2546,\"source\":\"cat(\\u0027Hello New World\\u0027)\"}' -X PUT \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer B5gQ7spUoWTu6oMxmunI-WWqVi3xxuHzUV2OEAUiBhI\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"patch":{"summary":"Update some attributes of this R Script","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID for the script.","type":"integer"},{"name":"Object556","in":"body","schema":{"$ref":"#/definitions/Object556"},"required":false}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object554"}}},"x-examples":[{"resource":"Scripts","resource_explanation":null,"http_method":"PATCH","route":"http://api.civis.test/scripts/r/:r_id","description":"Update an R Script via Patch","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"PATCH","request_path":"http://api.civis.test/scripts/r/2425","request_body":"{\n \"name\": \"My updated R script\",\n \"source\": \"cat('Hello New World')\"\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer a-lGknPYK8ywZoM83c0Dcp2SvZDpfUjpMRNS6tHw40Y","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 2425,\n \"name\": \"My updated R script\",\n \"type\": \"R\",\n \"createdAt\": \"2024-12-03T19:46:02.000Z\",\n \"updatedAt\": \"2024-12-03T19:46:03.000Z\",\n \"author\": {\n \"id\": 2482,\n \"name\": \"User devuserfactory2010 2010\",\n \"username\": \"devuserfactory2010\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"state\": \"idle\",\n \"finishedAt\": null,\n \"category\": \"script\",\n \"projects\": [\n\n ],\n \"parentId\": null,\n \"userContext\": \"runner\",\n \"params\": [\n\n ],\n \"arguments\": {\n },\n \"isTemplate\": false,\n \"publishedAsTemplateId\": null,\n \"fromTemplateId\": null,\n \"templateDependentsCount\": null,\n \"templateScriptName\": null,\n \"links\": {\n \"details\": \"api.civis.test/scripts/r/2425\",\n \"runs\": \"api.civis.test/scripts/r/2425/runs\"\n },\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n },\n \"notifications\": {\n \"urls\": [\n\n ],\n \"successEmailSubject\": null,\n \"successEmailBody\": null,\n \"successEmailAddresses\": [\n\n ],\n \"successEmailFromName\": null,\n \"successEmailReplyTo\": null,\n \"failureEmailAddresses\": [\n\n ],\n \"stallWarningMinutes\": null,\n \"successOn\": true,\n \"failureOn\": true\n },\n \"runningAs\": {\n \"id\": 2482,\n \"name\": \"User devuserfactory2010 2010\",\n \"username\": \"devuserfactory2010\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"nextRunAt\": null,\n \"timeZone\": \"America/Chicago\",\n \"lastRun\": null,\n \"myPermissionLevel\": \"manage\",\n \"hidden\": false,\n \"targetProjectId\": null,\n \"archived\": false,\n \"requiredResources\": {\n \"cpu\": null,\n \"memory\": null,\n \"diskSpace\": 1.0\n },\n \"instanceType\": null,\n \"cancelTimeout\": 0,\n \"dockerImageTag\": \"mock_latest_tag\",\n \"partitionLabel\": null,\n \"runningAsId\": 2482,\n \"source\": \"cat('Hello New World')\"\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"6926cc54eacb4084668801df02aa07a1\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"23f63c49-37b8-4cb5-b011-4c51af026961","X-Runtime":"0.118605","Content-Length":"1480"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/scripts/r/2425\" -d '{\"name\":\"My updated R script\",\"source\":\"cat(\\u0027Hello New World\\u0027)\"}' -X PATCH \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer a-lGknPYK8ywZoM83c0Dcp2SvZDpfUjpMRNS6tHw40Y\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"delete":{"summary":"Archive an R Script (deprecated, use archiving endpoints instead)","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/dbt":{"post":{"summary":"Create a dbt Script","description":null,"deprecated":false,"parameters":[{"name":"Object557","in":"body","schema":{"$ref":"#/definitions/Object557"},"required":true}],"responses":{"201":{"description":"success","schema":{"$ref":"#/definitions/Object560"}}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/dbt/{id}":{"get":{"summary":"Get a dbt Script","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object560"}}},"x-examples":null,"x-deprecation-warning":null},"put":{"summary":"Replace all attributes of this dbt Script","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID for the script.","type":"integer"},{"name":"Object563","in":"body","schema":{"$ref":"#/definitions/Object563"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object560"}}},"x-examples":null,"x-deprecation-warning":null},"patch":{"summary":"Update some attributes of this dbt Script","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID for the script.","type":"integer"},{"name":"Object564","in":"body","schema":{"$ref":"#/definitions/Object564"},"required":false}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object560"}}},"x-examples":null,"x-deprecation-warning":null},"delete":{"summary":"Archive a dbt Script (deprecated, use archiving endpoints instead)","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/javascript":{"post":{"summary":"Create a JavaScript Script","description":null,"deprecated":false,"parameters":[{"name":"Object566","in":"body","schema":{"$ref":"#/definitions/Object566"},"required":true}],"responses":{"201":{"description":"success","schema":{"$ref":"#/definitions/Object567"}}},"x-examples":[{"resource":"Scripts","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/scripts/javascript","description":"Create a JavaScript script","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/scripts/javascript","request_body":"{\n \"name\": \"My new JavaScript script\",\n \"remoteHostId\": 268,\n \"credentialId\": 741,\n \"source\": \"log('Hello World')\"\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer hb9OF-tY7UXfWaQ8k6s8w7s5SvBujLrfJpAXEhsSmSQ","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":201,"response_status_text":"Created","response_body":"{\n \"id\": 2381,\n \"name\": \"My new JavaScript script\",\n \"type\": \"JavaScript\",\n \"createdAt\": \"2024-12-03T19:45:57.000Z\",\n \"updatedAt\": \"2024-12-03T19:45:57.000Z\",\n \"author\": {\n \"id\": 2438,\n \"name\": \"User devuserfactory1972 1972\",\n \"username\": \"devuserfactory1972\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"state\": \"idle\",\n \"finishedAt\": null,\n \"category\": \"script\",\n \"projects\": [\n\n ],\n \"parentId\": null,\n \"userContext\": \"runner\",\n \"params\": [\n\n ],\n \"arguments\": {\n },\n \"isTemplate\": false,\n \"publishedAsTemplateId\": null,\n \"fromTemplateId\": null,\n \"templateDependentsCount\": null,\n \"templateScriptName\": null,\n \"links\": {\n \"details\": \"api.civis.test/scripts/javascript/2381\",\n \"runs\": \"api.civis.test/scripts/javascript/2381/runs\"\n },\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n },\n \"notifications\": {\n \"urls\": [\n\n ],\n \"successEmailSubject\": null,\n \"successEmailBody\": null,\n \"successEmailAddresses\": [\n\n ],\n \"successEmailFromName\": null,\n \"successEmailReplyTo\": null,\n \"failureEmailAddresses\": [\n\n ],\n \"stallWarningMinutes\": null,\n \"successOn\": true,\n \"failureOn\": true\n },\n \"runningAs\": {\n \"id\": 2438,\n \"name\": \"User devuserfactory1972 1972\",\n \"username\": \"devuserfactory1972\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"nextRunAt\": null,\n \"timeZone\": \"America/Chicago\",\n \"lastRun\": null,\n \"myPermissionLevel\": \"manage\",\n \"hidden\": false,\n \"targetProjectId\": null,\n \"archived\": false,\n \"source\": \"log('Hello World')\",\n \"remoteHostId\": 268,\n \"credentialId\": 741,\n \"runningAsId\": 2438\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"37c91e60ba2a786bc93fff253f438812\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"a5259877-cad3-40be-b783-31b22da5855b","X-Runtime":"0.109764","Content-Length":"1388"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/scripts/javascript\" -d '{\"name\":\"My new JavaScript script\",\"remoteHostId\":268,\"credentialId\":741,\"source\":\"log(\\u0027Hello World\\u0027)\"}' -X POST \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer hb9OF-tY7UXfWaQ8k6s8w7s5SvBujLrfJpAXEhsSmSQ\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/scripts/javascript/{id}":{"get":{"summary":"Get a JavaScript Script","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object567"}}},"x-examples":[{"resource":"Scripts","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/scripts/javascript/:job_id","description":"View a JavaScript script's details","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/scripts/javascript/2216","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer tNTd98rQSbwU8Gfpzsix-1yArOur4YjgKXamVTj0lVE","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 2216,\n \"name\": \"Script #2216\",\n \"type\": \"JavaScript\",\n \"createdAt\": \"2024-12-03T19:45:37.000Z\",\n \"updatedAt\": \"2024-12-03T19:45:37.000Z\",\n \"author\": {\n \"id\": 2270,\n \"name\": \"User devuserfactory1833 1833\",\n \"username\": \"devuserfactory1833\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"state\": \"idle\",\n \"finishedAt\": null,\n \"category\": \"script\",\n \"projects\": [\n\n ],\n \"parentId\": null,\n \"userContext\": \"runner\",\n \"params\": [\n\n ],\n \"arguments\": {\n },\n \"isTemplate\": false,\n \"publishedAsTemplateId\": null,\n \"fromTemplateId\": null,\n \"templateDependentsCount\": null,\n \"templateScriptName\": null,\n \"links\": {\n \"details\": \"api.civis.test/scripts/javascript/2216\",\n \"runs\": \"api.civis.test/scripts/javascript/2216/runs\"\n },\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n },\n \"notifications\": {\n \"urls\": [\n\n ],\n \"successEmailSubject\": \"success email subject\",\n \"successEmailBody\": \"success_email_template\",\n \"successEmailAddresses\": [\n \"script_spec_user@civisanalytics.com\"\n ],\n \"successEmailFromName\": null,\n \"successEmailReplyTo\": null,\n \"failureEmailAddresses\": [\n \"script_spec_user@civisanalytics.com\"\n ],\n \"stallWarningMinutes\": null,\n \"successOn\": true,\n \"failureOn\": true\n },\n \"runningAs\": {\n \"id\": 2270,\n \"name\": \"User devuserfactory1833 1833\",\n \"username\": \"devuserfactory1833\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"nextRunAt\": null,\n \"timeZone\": \"America/Chicago\",\n \"lastRun\": null,\n \"myPermissionLevel\": \"manage\",\n \"hidden\": false,\n \"targetProjectId\": null,\n \"archived\": false,\n \"source\": \"log('hello world')\",\n \"remoteHostId\": 190,\n \"credentialId\": 515,\n \"runningAsId\": 2270\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"5d3137953aa65409751de977e8b4f3c9\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"432057a0-ca57-431b-868e-eda59cb8cb0f","X-Runtime":"0.045108","Content-Length":"1489"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/scripts/javascript/2216\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer tNTd98rQSbwU8Gfpzsix-1yArOur4YjgKXamVTj0lVE\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"put":{"summary":"Replace all attributes of this JavaScript Script","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID for the script.","type":"integer"},{"name":"Object568","in":"body","schema":{"$ref":"#/definitions/Object568"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object567"}}},"x-examples":[{"resource":"Scripts","resource_explanation":null,"http_method":"PUT","route":"http://api.civis.test/scripts/javascript/:job_id","description":"Update a JavaScript Script via Put","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"PUT","request_path":"http://api.civis.test/scripts/javascript/2497","request_body":"{\n \"id\": {\n \"id\": 2497,\n \"name\": \"Script #2497\",\n \"cron\": null,\n \"next_run_at\": null,\n \"created_at\": \"2024-12-03T19:46:11.000Z\",\n \"updated_at\": \"2024-12-03T19:46:11.000Z\",\n \"user_id\": 2555,\n \"success_emails\": \"script_spec_user@civisanalytics.com\",\n \"failure_emails\": \"script_spec_user@civisanalytics.com\",\n \"scheduled\": null,\n \"scheduled_days\": [],\n \"scheduled_hours\": [],\n \"scheduled_runs_per_hour\": null,\n \"ancestry\": null,\n \"parent_run_id\": null,\n \"inherited_traits\": {},\n \"waits_for_descendants\": null,\n \"job_priority\": null,\n \"post_hooks\": \"\",\n \"api_token\": null,\n \"success_email_template\": \"success_email_template\",\n \"success_email_subject\": \"success email subject\",\n \"scheduled_minutes\": [],\n \"stall_warning_minutes\": null,\n \"success_on\": true,\n \"failure_on\": true,\n \"owners_user_set_id\": 5173,\n \"writers_user_set_id\": 5174,\n \"readers_user_set_id\": 5174,\n \"last_run_id\": null,\n \"running_as_id\": null,\n \"archived_at\": null,\n \"time_zone\": \"America/Chicago\",\n \"hidden\": false,\n \"last_run_finished_at\": null,\n \"last_run_updated_at\": null,\n \"last_run_state\": null,\n \"archived\": false,\n \"category\": \"script\",\n \"success_email_from_name\": null,\n \"success_email_reply_to\": null,\n \"warning_on\": true,\n \"warning_emails\": null,\n \"scheduled_days_of_month\": []\n },\n \"name\": \"My updated JavaScript script\",\n \"parentId\": null,\n \"source\": \"log('Hello New World')\",\n \"running_as_id\": 2555,\n \"remoteHostId\": 315,\n \"credentialId\": 877\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer R1yzOCsGFtCvJZ9oHa5Kku3p2taQzZGc9rcAXkBZjXg","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 2497,\n \"name\": \"My updated JavaScript script\",\n \"type\": \"JavaScript\",\n \"createdAt\": \"2024-12-03T19:46:11.000Z\",\n \"updatedAt\": \"2024-12-03T19:46:11.000Z\",\n \"author\": {\n \"id\": 2555,\n \"name\": \"User devuserfactory2073 2073\",\n \"username\": \"devuserfactory2073\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"state\": \"idle\",\n \"finishedAt\": null,\n \"category\": \"script\",\n \"projects\": [\n\n ],\n \"parentId\": null,\n \"userContext\": \"runner\",\n \"params\": [\n\n ],\n \"arguments\": {\n },\n \"isTemplate\": false,\n \"publishedAsTemplateId\": null,\n \"fromTemplateId\": null,\n \"templateDependentsCount\": null,\n \"templateScriptName\": null,\n \"links\": {\n \"details\": \"api.civis.test/scripts/javascript/2497\",\n \"runs\": \"api.civis.test/scripts/javascript/2497/runs\"\n },\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n },\n \"notifications\": {\n \"urls\": [\n\n ],\n \"successEmailSubject\": \"success email subject\",\n \"successEmailBody\": \"success_email_template\",\n \"successEmailAddresses\": [\n \"script_spec_user@civisanalytics.com\"\n ],\n \"successEmailFromName\": null,\n \"successEmailReplyTo\": null,\n \"failureEmailAddresses\": [\n \"script_spec_user@civisanalytics.com\"\n ],\n \"stallWarningMinutes\": null,\n \"successOn\": true,\n \"failureOn\": true\n },\n \"runningAs\": {\n \"id\": 2555,\n \"name\": \"User devuserfactory2073 2073\",\n \"username\": \"devuserfactory2073\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"nextRunAt\": null,\n \"timeZone\": \"America/Chicago\",\n \"lastRun\": null,\n \"myPermissionLevel\": \"manage\",\n \"hidden\": false,\n \"targetProjectId\": null,\n \"archived\": false,\n \"source\": \"log('Hello New World')\",\n \"remoteHostId\": 315,\n \"credentialId\": 877,\n \"runningAsId\": 2555\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"76c9666c5082af90e96028124f47d651\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"71da5e15-fcf7-4d35-b471-6ef3e6ce2b7d","X-Runtime":"0.137095","Content-Length":"1509"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/scripts/javascript/2497\" -d '{\"id\":{\"id\":2497,\"name\":\"Script #2497\",\"cron\":null,\"next_run_at\":null,\"created_at\":\"2024-12-03T19:46:11.000Z\",\"updated_at\":\"2024-12-03T19:46:11.000Z\",\"user_id\":2555,\"success_emails\":\"script_spec_user@civisanalytics.com\",\"failure_emails\":\"script_spec_user@civisanalytics.com\",\"scheduled\":null,\"scheduled_days\":[],\"scheduled_hours\":[],\"scheduled_runs_per_hour\":null,\"ancestry\":null,\"parent_run_id\":null,\"inherited_traits\":{},\"waits_for_descendants\":null,\"job_priority\":null,\"post_hooks\":\"\",\"api_token\":null,\"success_email_template\":\"success_email_template\",\"success_email_subject\":\"success email subject\",\"scheduled_minutes\":[],\"stall_warning_minutes\":null,\"success_on\":true,\"failure_on\":true,\"owners_user_set_id\":5173,\"writers_user_set_id\":5174,\"readers_user_set_id\":5174,\"last_run_id\":null,\"running_as_id\":null,\"archived_at\":null,\"time_zone\":\"America/Chicago\",\"hidden\":false,\"last_run_finished_at\":null,\"last_run_updated_at\":null,\"last_run_state\":null,\"archived\":false,\"category\":\"script\",\"success_email_from_name\":null,\"success_email_reply_to\":null,\"warning_on\":true,\"warning_emails\":null,\"scheduled_days_of_month\":[]},\"name\":\"My updated JavaScript script\",\"parentId\":null,\"source\":\"log(\\u0027Hello New World\\u0027)\",\"running_as_id\":2555,\"remoteHostId\":315,\"credentialId\":877}' -X PUT \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer R1yzOCsGFtCvJZ9oHa5Kku3p2taQzZGc9rcAXkBZjXg\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"patch":{"summary":"Update some attributes of this JavaScript Script","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID for the script.","type":"integer"},{"name":"Object569","in":"body","schema":{"$ref":"#/definitions/Object569"},"required":false}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object567"}}},"x-examples":[{"resource":"Scripts","resource_explanation":null,"http_method":"PATCH","route":"http://api.civis.test/scripts/javascript/:job_id","description":"Update a JavaScript Script via Patch","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"PATCH","request_path":"http://api.civis.test/scripts/javascript/2433","request_body":"{\n \"name\": \"My updated JavaScript script\",\n \"source\": \"log('Hello New World')\"\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer TM6Gm8sKROeRN8snhp7lb5AAq_63CF80Djbs1dL4z8s","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 2433,\n \"name\": \"My updated JavaScript script\",\n \"type\": \"JavaScript\",\n \"createdAt\": \"2024-12-03T19:46:04.000Z\",\n \"updatedAt\": \"2024-12-03T19:46:04.000Z\",\n \"author\": {\n \"id\": 2491,\n \"name\": \"User devuserfactory2018 2018\",\n \"username\": \"devuserfactory2018\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"state\": \"idle\",\n \"finishedAt\": null,\n \"category\": \"script\",\n \"projects\": [\n\n ],\n \"parentId\": null,\n \"userContext\": \"runner\",\n \"params\": [\n\n ],\n \"arguments\": {\n },\n \"isTemplate\": false,\n \"publishedAsTemplateId\": null,\n \"fromTemplateId\": null,\n \"templateDependentsCount\": null,\n \"templateScriptName\": null,\n \"links\": {\n \"details\": \"api.civis.test/scripts/javascript/2433\",\n \"runs\": \"api.civis.test/scripts/javascript/2433/runs\"\n },\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n },\n \"notifications\": {\n \"urls\": [\n\n ],\n \"successEmailSubject\": \"success email subject\",\n \"successEmailBody\": \"success_email_template\",\n \"successEmailAddresses\": [\n \"script_spec_user@civisanalytics.com\"\n ],\n \"successEmailFromName\": null,\n \"successEmailReplyTo\": null,\n \"failureEmailAddresses\": [\n \"script_spec_user@civisanalytics.com\"\n ],\n \"stallWarningMinutes\": null,\n \"successOn\": true,\n \"failureOn\": true\n },\n \"runningAs\": {\n \"id\": 2491,\n \"name\": \"User devuserfactory2018 2018\",\n \"username\": \"devuserfactory2018\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"nextRunAt\": null,\n \"timeZone\": \"America/Chicago\",\n \"lastRun\": null,\n \"myPermissionLevel\": \"manage\",\n \"hidden\": false,\n \"targetProjectId\": null,\n \"archived\": false,\n \"source\": \"log('Hello New World')\",\n \"remoteHostId\": 289,\n \"credentialId\": 802,\n \"runningAsId\": 2491\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"82770927bf373979d70ffe31e9466766\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"5724e130-3e7b-4348-a535-efcb178fb304","X-Runtime":"0.109469","Content-Length":"1509"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/scripts/javascript/2433\" -d '{\"name\":\"My updated JavaScript script\",\"source\":\"log(\\u0027Hello New World\\u0027)\"}' -X PATCH \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer TM6Gm8sKROeRN8snhp7lb5AAq_63CF80Djbs1dL4z8s\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"delete":{"summary":"Archive a JavaScript Script (deprecated, use archiving endpoints instead)","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/custom":{"get":{"summary":"List Custom Scripts","description":null,"deprecated":false,"parameters":[{"name":"from_template_id","in":"query","required":false,"description":"If specified, return scripts based on the template with this ID. Specify multiple IDs as a comma-separated list.","type":"string"},{"name":"author","in":"query","required":false,"description":"If specified, return items from any of these authors. It accepts a comma-separated list of user IDs.","type":"string"},{"name":"status","in":"query","required":false,"description":"If specified, returns items with one of these statuses. It accepts a comma-separated list, possible values are 'running', 'failed', 'succeeded', 'idle', 'scheduled'.","type":"string"},{"name":"hidden","in":"query","required":false,"description":"If specified to be true, returns hidden items. Defaults to false, returning non-hidden items.","type":"boolean"},{"name":"archived","in":"query","required":false,"description":"The archival status of the requested item(s).","type":"string"},{"name":"limit","in":"query","required":false,"description":"Number of results to return. Defaults to its maximum of 50.","type":"integer"},{"name":"page_num","in":"query","required":false,"description":"Page number of the results to return. Defaults to the first page, 1.","type":"integer"},{"name":"order","in":"query","required":false,"description":"The field on which to order the result set. Defaults to updated_at. Must be one of: updated_at, name, created_at.","type":"string"},{"name":"order_dir","in":"query","required":false,"description":"Direction in which to sort, either asc (ascending) or desc (descending) defaulting to asc.","type":"string"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object570"}}}},"x-examples":[{"resource":"Scripts","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/scripts/custom","description":"List all custom scripts","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/scripts/custom","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer SMGOHksF6ZVWtwG5qLMNuUi7fm0_4iEqFolmSmWf_xw","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 2112,\n \"name\": \"awesome sql template #2112\",\n \"type\": \"Custom\",\n \"backingScriptType\": \"SQL\",\n \"createdAt\": \"2024-12-03T19:45:26.000Z\",\n \"updatedAt\": \"2024-12-03T19:45:26.000Z\",\n \"author\": {\n \"id\": 2168,\n \"name\": \"User devuserfactory1754 1754\",\n \"username\": \"devuserfactory1754\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"state\": \"idle\",\n \"finishedAt\": null,\n \"projects\": [\n\n ],\n \"parentId\": null,\n \"fromTemplateId\": 157,\n \"timeZone\": \"America/Chicago\",\n \"lastRun\": null,\n \"archived\": false,\n \"lastSuccessfulRun\": null\n },\n {\n \"id\": 2120,\n \"name\": \"awesome sql template #2120\",\n \"type\": \"Custom\",\n \"backingScriptType\": \"SQL\",\n \"createdAt\": \"2024-12-03T19:45:27.000Z\",\n \"updatedAt\": \"2024-12-03T19:45:27.000Z\",\n \"author\": {\n \"id\": 2175,\n \"name\": \"User devuserfactory1759 1759\",\n \"username\": \"devuserfactory1759\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"state\": \"idle\",\n \"finishedAt\": null,\n \"projects\": [\n\n ],\n \"parentId\": null,\n \"fromTemplateId\": 158,\n \"timeZone\": \"America/Chicago\",\n \"lastRun\": null,\n \"archived\": false,\n \"lastSuccessfulRun\": null\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","X-Pagination-Per-Page":"50","Access-Control-Expose-Headers":"X-Pagination-Per-Page, X-Pagination-Current-Page, X-Pagination-Total-Pages, X-Pagination-Total-Entries","X-Pagination-Current-Page":"1","X-Pagination-Total-Pages":"1","X-Pagination-Total-Entries":"2","Content-Type":"application/json; charset=utf-8","ETag":"W/\"40cef94fe9f3e5688c14aec7e42aa31c\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"cc79235f-151e-4c31-8e52-bc63dfba1990","X-Runtime":"0.036182","Content-Length":"919"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/scripts/custom\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer SMGOHksF6ZVWtwG5qLMNuUi7fm0_4iEqFolmSmWf_xw\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Scripts","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/scripts/custom","description":"Filter custom scripts by template id","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/scripts/custom?fromTemplateId=160","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer VCOdYaaT5vrY_bTwDzCsmwRT8HXU7bEDHnQ_D3eVavQ","Host":"api.civis.test","Cookie":""},"request_query_parameters":{"fromTemplateId":"160"},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 2144,\n \"name\": \"awesome sql template #2144\",\n \"type\": \"Custom\",\n \"backingScriptType\": \"SQL\",\n \"createdAt\": \"2024-12-03T19:45:29.000Z\",\n \"updatedAt\": \"2024-12-03T19:45:29.000Z\",\n \"author\": {\n \"id\": 2198,\n \"name\": \"User devuserfactory1776 1776\",\n \"username\": \"devuserfactory1776\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"state\": \"idle\",\n \"finishedAt\": null,\n \"projects\": [\n\n ],\n \"parentId\": null,\n \"fromTemplateId\": 160,\n \"timeZone\": \"America/Chicago\",\n \"lastRun\": null,\n \"archived\": false,\n \"lastSuccessfulRun\": null\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","X-Pagination-Per-Page":"50","Access-Control-Expose-Headers":"X-Pagination-Per-Page, X-Pagination-Current-Page, X-Pagination-Total-Pages, X-Pagination-Total-Entries","X-Pagination-Current-Page":"1","X-Pagination-Total-Pages":"1","X-Pagination-Total-Entries":"1","Content-Type":"application/json; charset=utf-8","ETag":"W/\"ef92904a47147e88bf2ead40988bf282\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"50677d03-58db-4962-9801-a06721a56f49","X-Runtime":"0.031310","Content-Length":"460"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/scripts/custom?fromTemplateId=160\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer VCOdYaaT5vrY_bTwDzCsmwRT8HXU7bEDHnQ_D3eVavQ\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"post":{"summary":"Create a Custom Script","description":null,"deprecated":false,"parameters":[{"name":"Object571","in":"body","schema":{"$ref":"#/definitions/Object571"},"required":true}],"responses":{"201":{"description":"success","schema":{"$ref":"#/definitions/Object573"}}},"x-examples":[{"resource":"Scripts","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/scripts/custom","description":"Create a custom script","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/scripts/custom","request_body":"{\n \"name\": \"My appified sql script\",\n \"fromTemplateId\": 168,\n \"arguments\": {\n \"id\": 2,\n \"state\": \"IL\",\n \"table\": \"test.test\"\n },\n \"remote_host_id\": 270,\n \"credential_id\": 750\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer 8Ox644yBxgvelgyHlTIj-otbacfTMJPFUs2MNU0gNzs","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":201,"response_status_text":"Created","response_body":"{\n \"id\": 2392,\n \"fromTemplateAliases\": [\n\n ],\n \"name\": \"My appified sql script\",\n \"type\": \"Custom\",\n \"backingScriptType\": \"SQL\",\n \"createdAt\": \"2024-12-03T19:45:59.000Z\",\n \"updatedAt\": \"2024-12-03T19:45:59.000Z\",\n \"author\": {\n \"id\": 2446,\n \"name\": \"User devuserfactory1979 1979\",\n \"username\": \"devuserfactory1979\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"state\": \"idle\",\n \"finishedAt\": null,\n \"category\": \"script\",\n \"projects\": [\n\n ],\n \"parentId\": null,\n \"params\": [\n {\n \"name\": \"id\",\n \"label\": \"ID\",\n \"description\": null,\n \"type\": \"integer\",\n \"required\": true,\n \"value\": null,\n \"default\": null,\n \"allowedValues\": [\n\n ]\n },\n {\n \"name\": \"state\",\n \"label\": \"State\",\n \"description\": null,\n \"type\": \"string\",\n \"required\": true,\n \"value\": null,\n \"default\": null,\n \"allowedValues\": [\n\n ]\n },\n {\n \"name\": \"table\",\n \"label\": \"Table\",\n \"description\": null,\n \"type\": \"string\",\n \"required\": false,\n \"value\": null,\n \"default\": null,\n \"allowedValues\": [\n\n ]\n }\n ],\n \"arguments\": {\n \"id\": 2,\n \"state\": \"IL\",\n \"table\": \"test.test\"\n },\n \"isTemplate\": false,\n \"publishedAsTemplateId\": null,\n \"fromTemplateId\": 168,\n \"uiReportUrl\": null,\n \"uiReportId\": null,\n \"uiReportProvideAPIKey\": null,\n \"templateScriptName\": \"Script #2391\",\n \"templateNote\": null,\n \"remoteHostId\": 270,\n \"credentialId\": 750,\n \"codePreview\": \"select * from test.test where id = 2 and state = 'IL'\",\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n },\n \"notifications\": {\n \"urls\": [\n\n ],\n \"successEmailSubject\": null,\n \"successEmailBody\": null,\n \"successEmailAddresses\": [\n\n ],\n \"successEmailFromName\": null,\n \"successEmailReplyTo\": null,\n \"failureEmailAddresses\": [\n\n ],\n \"stallWarningMinutes\": null,\n \"successOn\": true,\n \"failureOn\": true\n },\n \"runningAs\": {\n \"id\": 2446,\n \"name\": \"User devuserfactory1979 1979\",\n \"username\": \"devuserfactory1979\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"timeZone\": \"America/Chicago\",\n \"lastRun\": null,\n \"myPermissionLevel\": \"manage\",\n \"hidden\": false,\n \"archived\": false,\n \"targetProjectId\": null,\n \"lastSuccessfulRun\": null,\n \"requiredResources\": null,\n \"partitionLabel\": null,\n \"runningAsId\": 2446\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"56b5588cd97b9cd6d7fb294853c7f601\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"f8bc9a13-f445-4c96-a523-b23243d46daf","X-Runtime":"0.384251","Content-Length":"1882"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/scripts/custom\" -d '{\"name\":\"My appified sql script\",\"fromTemplateId\":168,\"arguments\":{\"id\":2,\"state\":\"IL\",\"table\":\"test.test\"},\"remote_host_id\":270,\"credential_id\":750}' -X POST \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer 8Ox644yBxgvelgyHlTIj-otbacfTMJPFUs2MNU0gNzs\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/scripts/custom/{id}":{"get":{"summary":"Get a Custom Script","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object573"}}},"x-examples":[{"resource":"Scripts","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/scripts/custom/:custom_script","description":"View a custom script's details","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/scripts/custom/2271","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer r0ixSC-5rv0CI6ukTbGtphhbutObkDJ9cYCed_AWbrg","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 2271,\n \"fromTemplateAliases\": [\n\n ],\n \"name\": \"awesome sql template #2271\",\n \"type\": \"Custom\",\n \"backingScriptType\": \"SQL\",\n \"createdAt\": \"2024-12-03T19:45:43.000Z\",\n \"updatedAt\": \"2024-12-03T19:45:43.000Z\",\n \"author\": {\n \"id\": 2317,\n \"name\": \"User devuserfactory1871 1871\",\n \"username\": \"devuserfactory1871\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"state\": \"idle\",\n \"finishedAt\": null,\n \"category\": \"script\",\n \"projects\": [\n\n ],\n \"parentId\": null,\n \"params\": [\n {\n \"name\": \"id\",\n \"label\": \"ID\",\n \"description\": null,\n \"type\": \"integer\",\n \"required\": true,\n \"value\": null,\n \"default\": null,\n \"allowedValues\": [\n\n ]\n },\n {\n \"name\": \"state\",\n \"label\": \"State\",\n \"description\": null,\n \"type\": \"string\",\n \"required\": true,\n \"value\": null,\n \"default\": null,\n \"allowedValues\": [\n\n ]\n },\n {\n \"name\": \"table\",\n \"label\": \"Table\",\n \"description\": null,\n \"type\": \"string\",\n \"required\": false,\n \"value\": null,\n \"default\": null,\n \"allowedValues\": [\n\n ]\n }\n ],\n \"arguments\": {\n \"id\": 2,\n \"state\": \"IL\",\n \"table\": \"test.test\"\n },\n \"isTemplate\": false,\n \"publishedAsTemplateId\": null,\n \"fromTemplateId\": 167,\n \"uiReportUrl\": null,\n \"uiReportId\": null,\n \"uiReportProvideAPIKey\": null,\n \"templateScriptName\": \"Script #2268\",\n \"templateNote\": null,\n \"remoteHostId\": 213,\n \"credentialId\": 578,\n \"codePreview\": \"select * from test.test where id = 2 and state = 'IL'\",\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n },\n \"notifications\": {\n \"urls\": [\n\n ],\n \"successEmailSubject\": null,\n \"successEmailBody\": null,\n \"successEmailAddresses\": [\n\n ],\n \"successEmailFromName\": null,\n \"successEmailReplyTo\": null,\n \"failureEmailAddresses\": [\n\n ],\n \"stallWarningMinutes\": null,\n \"successOn\": true,\n \"failureOn\": true\n },\n \"runningAs\": {\n \"id\": 2317,\n \"name\": \"User devuserfactory1871 1871\",\n \"username\": \"devuserfactory1871\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"timeZone\": \"America/Chicago\",\n \"lastRun\": null,\n \"myPermissionLevel\": \"manage\",\n \"hidden\": false,\n \"archived\": false,\n \"targetProjectId\": null,\n \"lastSuccessfulRun\": null,\n \"requiredResources\": null,\n \"partitionLabel\": null,\n \"runningAsId\": 2317\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"e21f83e7cdaa2dd5fd12620d66b22694\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"26348fa5-855d-4010-bf70-e9148d013ed3","X-Runtime":"0.064247","Content-Length":"1886"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/scripts/custom/2271\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer r0ixSC-5rv0CI6ukTbGtphhbutObkDJ9cYCed_AWbrg\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"put":{"summary":"Replace all attributes of this Custom Script","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID for the script.","type":"integer"},{"name":"Object575","in":"body","schema":{"$ref":"#/definitions/Object575"},"required":false}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object573"}}},"x-examples":[{"resource":"Scripts","resource_explanation":null,"http_method":"PUT","route":"http://api.civis.test/scripts/custom/:custom_script_id","description":"Update a Custom Script via Put","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"PUT","request_path":"http://api.civis.test/scripts/custom/2511","request_body":"{\n \"id\": 2511,\n \"name\": \"My updated custom script\",\n \"parent_id\": null,\n \"arguments\": {\n \"id\": 3,\n \"state\": \"FL\",\n \"table\": \"test_new.test_new\"\n },\n \"running_as_id\": 2563,\n \"remote_host_id\": 317,\n \"credential_id\": 886\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer Clf8b4cQTtZMcHcQnPgwMLATKw-V1BiiToOoyXRrFgY","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 2511,\n \"fromTemplateAliases\": [\n\n ],\n \"name\": \"My updated custom script\",\n \"type\": \"Custom\",\n \"backingScriptType\": \"SQL\",\n \"createdAt\": \"2024-12-03T19:46:12.000Z\",\n \"updatedAt\": \"2024-12-03T19:46:12.000Z\",\n \"author\": {\n \"id\": 2563,\n \"name\": \"User devuserfactory2080 2080\",\n \"username\": \"devuserfactory2080\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"state\": \"idle\",\n \"finishedAt\": null,\n \"category\": \"script\",\n \"projects\": [\n\n ],\n \"parentId\": null,\n \"params\": [\n {\n \"name\": \"id\",\n \"label\": \"ID\",\n \"description\": null,\n \"type\": \"integer\",\n \"required\": true,\n \"value\": null,\n \"default\": null,\n \"allowedValues\": [\n\n ]\n },\n {\n \"name\": \"state\",\n \"label\": \"State\",\n \"description\": null,\n \"type\": \"string\",\n \"required\": true,\n \"value\": null,\n \"default\": null,\n \"allowedValues\": [\n\n ]\n },\n {\n \"name\": \"table\",\n \"label\": \"Table\",\n \"description\": null,\n \"type\": \"string\",\n \"required\": false,\n \"value\": null,\n \"default\": null,\n \"allowedValues\": [\n\n ]\n }\n ],\n \"arguments\": {\n \"id\": 3,\n \"state\": \"FL\",\n \"table\": \"test_new.test_new\"\n },\n \"isTemplate\": false,\n \"publishedAsTemplateId\": null,\n \"fromTemplateId\": 170,\n \"uiReportUrl\": null,\n \"uiReportId\": null,\n \"uiReportProvideAPIKey\": null,\n \"templateScriptName\": \"Script #2508\",\n \"templateNote\": null,\n \"remoteHostId\": 317,\n \"credentialId\": 886,\n \"codePreview\": \"select * from test_new.test_new where id = 3 and state = 'FL'\",\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n },\n \"notifications\": {\n \"urls\": [\n\n ],\n \"successEmailSubject\": null,\n \"successEmailBody\": null,\n \"successEmailAddresses\": [\n\n ],\n \"successEmailFromName\": null,\n \"successEmailReplyTo\": null,\n \"failureEmailAddresses\": [\n\n ],\n \"stallWarningMinutes\": null,\n \"successOn\": true,\n \"failureOn\": true\n },\n \"runningAs\": {\n \"id\": 2563,\n \"name\": \"User devuserfactory2080 2080\",\n \"username\": \"devuserfactory2080\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"timeZone\": \"America/Chicago\",\n \"lastRun\": null,\n \"myPermissionLevel\": \"manage\",\n \"hidden\": false,\n \"archived\": false,\n \"targetProjectId\": null,\n \"lastSuccessfulRun\": null,\n \"requiredResources\": null,\n \"partitionLabel\": null,\n \"runningAsId\": 2563\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"2c2aebf1ead782eeb4ffd6c9c385c899\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"8b397963-6a44-4b00-8ff5-dafab97965e7","X-Runtime":"0.177368","Content-Length":"1900"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/scripts/custom/2511\" -d '{\"id\":2511,\"name\":\"My updated custom script\",\"parent_id\":null,\"arguments\":{\"id\":3,\"state\":\"FL\",\"table\":\"test_new.test_new\"},\"running_as_id\":2563,\"remote_host_id\":317,\"credential_id\":886}' -X PUT \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer Clf8b4cQTtZMcHcQnPgwMLATKw-V1BiiToOoyXRrFgY\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"patch":{"summary":"Update some attributes of this Custom Script","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID for the script.","type":"integer"},{"name":"Object575","in":"body","schema":{"$ref":"#/definitions/Object575"},"required":false}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object573"}}},"x-examples":[{"resource":"Scripts","resource_explanation":null,"http_method":"PATCH","route":"http://api.civis.test/scripts/custom/:custom_script_id","description":"Update a Custom Script via Patch","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"PATCH","request_path":"http://api.civis.test/scripts/custom/2447","request_body":"{\n \"name\": \"My updated Custom Script\",\n \"arguments\": {\n \"id\": 3,\n \"state\": \"FL\",\n \"table\": \"test_new.test_new\"\n }\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer DbN-Z9xILkkqbzSo35MuH12PU55BXzWt0prPo0ftuWY","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 2447,\n \"fromTemplateAliases\": [\n\n ],\n \"name\": \"My updated Custom Script\",\n \"type\": \"Custom\",\n \"backingScriptType\": \"SQL\",\n \"createdAt\": \"2024-12-03T19:46:05.000Z\",\n \"updatedAt\": \"2024-12-03T19:46:05.000Z\",\n \"author\": {\n \"id\": 2499,\n \"name\": \"User devuserfactory2025 2025\",\n \"username\": \"devuserfactory2025\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"state\": \"idle\",\n \"finishedAt\": null,\n \"category\": \"script\",\n \"projects\": [\n\n ],\n \"parentId\": null,\n \"params\": [\n {\n \"name\": \"id\",\n \"label\": \"ID\",\n \"description\": null,\n \"type\": \"integer\",\n \"required\": true,\n \"value\": null,\n \"default\": null,\n \"allowedValues\": [\n\n ]\n },\n {\n \"name\": \"state\",\n \"label\": \"State\",\n \"description\": null,\n \"type\": \"string\",\n \"required\": true,\n \"value\": null,\n \"default\": null,\n \"allowedValues\": [\n\n ]\n },\n {\n \"name\": \"table\",\n \"label\": \"Table\",\n \"description\": null,\n \"type\": \"string\",\n \"required\": false,\n \"value\": null,\n \"default\": null,\n \"allowedValues\": [\n\n ]\n }\n ],\n \"arguments\": {\n \"id\": 3,\n \"state\": \"FL\",\n \"table\": \"test_new.test_new\"\n },\n \"isTemplate\": false,\n \"publishedAsTemplateId\": null,\n \"fromTemplateId\": 169,\n \"uiReportUrl\": null,\n \"uiReportId\": null,\n \"uiReportProvideAPIKey\": null,\n \"templateScriptName\": \"Script #2444\",\n \"templateNote\": null,\n \"remoteHostId\": 293,\n \"credentialId\": 813,\n \"codePreview\": \"select * from test_new.test_new where id = 3 and state = 'FL'\",\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n },\n \"notifications\": {\n \"urls\": [\n\n ],\n \"successEmailSubject\": null,\n \"successEmailBody\": null,\n \"successEmailAddresses\": [\n\n ],\n \"successEmailFromName\": null,\n \"successEmailReplyTo\": null,\n \"failureEmailAddresses\": [\n\n ],\n \"stallWarningMinutes\": null,\n \"successOn\": true,\n \"failureOn\": true\n },\n \"runningAs\": {\n \"id\": 2499,\n \"name\": \"User devuserfactory2025 2025\",\n \"username\": \"devuserfactory2025\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"timeZone\": \"America/Chicago\",\n \"lastRun\": null,\n \"myPermissionLevel\": \"manage\",\n \"hidden\": false,\n \"archived\": false,\n \"targetProjectId\": null,\n \"lastSuccessfulRun\": null,\n \"requiredResources\": null,\n \"partitionLabel\": null,\n \"runningAsId\": 2499\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"655cf00273c44de03ff33e120ced7c25\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"0592ffef-f6c4-4f3d-be20-0e2f8b19f0fb","X-Runtime":"0.130173","Content-Length":"1900"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/scripts/custom/2447\" -d '{\"name\":\"My updated Custom Script\",\"arguments\":{\"id\":3,\"state\":\"FL\",\"table\":\"test_new.test_new\"}}' -X PATCH \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer DbN-Z9xILkkqbzSo35MuH12PU55BXzWt0prPo0ftuWY\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"delete":{"summary":"Archive a Custom Script (deprecated, use archiving endpoints instead)","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/sql/{id}/runs":{"post":{"summary":"Start a run","description":"Start a run and provide a URI for checking its status. The response will provide a 'Location' header which will contain a URI which may be polled to monitor the status of the run.","deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the SQL job.","type":"integer"}],"responses":{"202":{"description":"success","schema":{"$ref":"#/definitions/Object577"}}},"x-examples":[{"resource":"Scripts","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/scripts/sql/:script_to_run_id/runs","description":"Create a sql run","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/scripts/sql/2592/runs","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer QI0bYitY2h4rbklQadH7h3n1YkXSndhdaaIF9G76xz8","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":202,"response_status_text":"Accepted","response_body":"{\n \"id\": 233,\n \"sqlId\": 2592,\n \"state\": \"queued\",\n \"isCancelRequested\": false,\n \"createdAt\": \"2024-12-03T19:46:22.000Z\",\n \"startedAt\": null,\n \"finishedAt\": null,\n \"error\": null,\n \"output\": [\n\n ],\n \"outputCachedOn\": null\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Location":"http://api.civis.test/scripts/sql/2592/runs/233","Content-Type":"application/json; charset=utf-8","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"2135f131-4bb3-40f0-9e80-5e37c9d199ee","X-Runtime":"0.170022","Content-Length":"187"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/scripts/sql/2592/runs\" -d '' -X POST \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer QI0bYitY2h4rbklQadH7h3n1YkXSndhdaaIF9G76xz8\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"get":{"summary":"List runs for the given SQL job","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the SQL job.","type":"integer"},{"name":"limit","in":"query","required":false,"description":"Number of results to return. Defaults to 20. Maximum allowed is 100.","type":"integer"},{"name":"page_num","in":"query","required":false,"description":"Page number of the results to return. Defaults to the first page, 1.","type":"integer"},{"name":"order","in":"query","required":false,"description":"The field on which to order the result set. Defaults to id. Must be one of: id.","type":"string"},{"name":"order_dir","in":"query","required":false,"description":"Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc.","type":"string"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object577"}}}},"x-examples":[{"resource":"Scripts","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/scripts/sql/:id/runs","description":"View a SQL script's runs","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/scripts/sql/2799/runs","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer VPLWGpLYUHn2DoNnjuYN1AFEz6CsqD4jhA-TYU54HVw","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 292,\n \"sqlId\": 2799,\n \"state\": \"failed\",\n \"isCancelRequested\": false,\n \"createdAt\": \"2024-12-03T19:46:48.000Z\",\n \"startedAt\": \"2024-12-03T19:45:48.000Z\",\n \"finishedAt\": \"2024-12-04T05:46:48.000Z\",\n \"error\": \"err\",\n \"output\": [\n\n ],\n \"outputCachedOn\": null\n },\n {\n \"id\": 291,\n \"sqlId\": 2799,\n \"state\": \"running\",\n \"isCancelRequested\": false,\n \"createdAt\": \"2024-12-03T19:46:47.000Z\",\n \"startedAt\": null,\n \"finishedAt\": \"2024-12-03T19:46:47.000Z\",\n \"error\": null,\n \"output\": [\n {\n \"outputName\": \"output_file\",\n \"fileId\": 139,\n \"path\": \"http://aws/file.csv\"\n }\n ],\n \"outputCachedOn\": null\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","X-Pagination-Per-Page":"20","Access-Control-Expose-Headers":"X-Pagination-Per-Page, X-Pagination-Current-Page, X-Pagination-Total-Pages, X-Pagination-Total-Entries","X-Pagination-Current-Page":"1","X-Pagination-Total-Pages":"1","X-Pagination-Total-Entries":"2","Content-Type":"application/json; charset=utf-8","ETag":"W/\"7e610181c91b734f69634b94f9a4457b\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"732470ff-e1b8-4b46-abc6-43d7d74a88b8","X-Runtime":"0.042590","Content-Length":"515"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/scripts/sql/2799/runs\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer VPLWGpLYUHn2DoNnjuYN1AFEz6CsqD4jhA-TYU54HVw\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/scripts/sql/{id}/runs/{run_id}":{"get":{"summary":"Check status of a run","description":"View the status of a run. This endpoint may be polled to monitor the status of the run. When the 'state' field is no longer 'queued' or 'running' the run has reached its final state.","deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the SQL job.","type":"integer"},{"name":"run_id","in":"path","required":true,"description":"The ID of the run.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object577"}}},"x-examples":[{"resource":"Scripts","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/scripts/sql/:id/runs/:script_run_id","description":"View a SQL script's run details","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/scripts/sql/2643/runs/244","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer lUWmWA4R60fQAO-Eckj-wWnZA0GHNNdHYOaKlHYaTgM","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 244,\n \"sqlId\": 2643,\n \"state\": \"running\",\n \"isCancelRequested\": false,\n \"createdAt\": \"2024-12-03T19:46:28.000Z\",\n \"startedAt\": null,\n \"finishedAt\": \"2024-12-03T19:46:28.000Z\",\n \"error\": null,\n \"output\": [\n {\n \"outputName\": \"output_file\",\n \"fileId\": 90,\n \"path\": \"http://aws/file.csv\"\n }\n ],\n \"outputCachedOn\": null\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"c26ad3cde0d8fa6c2f9746e8598006dd\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"9502d31a-d365-4dc0-b30f-ec652ca83e77","X-Runtime":"0.036413","Content-Length":"279"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/scripts/sql/2643/runs/244\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer lUWmWA4R60fQAO-Eckj-wWnZA0GHNNdHYOaKlHYaTgM\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"delete":{"summary":"Cancel a run","description":"Cancel a currently active run.","deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the SQL job.","type":"integer"},{"name":"run_id","in":"path","required":true,"description":"The ID of the run.","type":"integer"}],"responses":{"202":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null},"patch":{"summary":"Update the given run","description":"Update the run.","deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"ID of the Job","type":"integer"},{"name":"run_id","in":"path","required":true,"description":"ID of the Run","type":"integer"},{"name":"Object599","in":"body","schema":{"$ref":"#/definitions/Object599"},"required":false}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/sql/{id}/runs/{run_id}/logs":{"get":{"summary":"Get the logs for a run","description":"Get the logs for a run.","deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the SQL job.","type":"integer"},{"name":"run_id","in":"path","required":true,"description":"The ID of the run.","type":"integer"},{"name":"last_id","in":"query","required":false,"description":"The ID of the last log message received. Log entries with this ID value or lower will be omitted.Logs are sorted by ID if this value is provided, and are otherwise sorted by createdAt.","type":"integer"},{"name":"limit","in":"query","required":false,"description":"The maximum number of log messages to return. Default of 10000.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object117"}}}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/containers/{id}/runs":{"post":{"summary":"Start a run","description":"Start a run and provide a URI for checking its status. The response will provide a 'Location' header which will contain a URI which may be polled to monitor the status of the run.","deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Container job.","type":"integer"}],"responses":{"202":{"description":"success","schema":{"$ref":"#/definitions/Object578"}}},"x-examples":[{"resource":"Scripts","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/scripts/containers/:script_to_run_id/runs","description":"Create a container run","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/scripts/containers/2601/runs","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer 29_XgsepCJlbJwe1TSq5aiWoWLcV1Yoxwpfc4KCVMVU","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":202,"response_status_text":"Accepted","response_body":"{\n \"id\": 235,\n \"containerId\": 2601,\n \"state\": \"queued\",\n \"isCancelRequested\": false,\n \"createdAt\": \"2024-12-03T19:46:23.000Z\",\n \"startedAt\": null,\n \"finishedAt\": null,\n \"error\": null,\n \"maxMemoryUsage\": null,\n \"maxCpuUsage\": null\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Location":"http://api.civis.test/scripts/containers/2601/runs/235","Content-Type":"application/json; charset=utf-8","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"0ceb52cc-d001-4773-8c15-84f184e8a0f4","X-Runtime":"0.133217","Content-Length":"200"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/scripts/containers/2601/runs\" -d '' -X POST \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer 29_XgsepCJlbJwe1TSq5aiWoWLcV1Yoxwpfc4KCVMVU\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"get":{"summary":"List runs for the given Container job","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Container job.","type":"integer"},{"name":"limit","in":"query","required":false,"description":"Number of results to return. Defaults to 20. Maximum allowed is 100.","type":"integer"},{"name":"page_num","in":"query","required":false,"description":"Page number of the results to return. Defaults to the first page, 1.","type":"integer"},{"name":"order","in":"query","required":false,"description":"The field on which to order the result set. Defaults to id. Must be one of: id.","type":"string"},{"name":"order_dir","in":"query","required":false,"description":"Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc.","type":"string"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object578"}}}},"x-examples":[{"resource":"Scripts","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/scripts/containers/:script_job_id/runs","description":"View a Container script's runs","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/scripts/containers/2811/runs","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer a4ahf8ZM_Kpn81YaZbup988ZYcxpslWTvb-xiCMUpVc","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 295,\n \"containerId\": 2811,\n \"state\": \"running\",\n \"isCancelRequested\": false,\n \"createdAt\": \"2024-12-03T19:46:49.000Z\",\n \"startedAt\": \"2024-12-03T19:45:49.000Z\",\n \"finishedAt\": \"2024-12-04T05:46:49.000Z\",\n \"error\": null,\n \"maxMemoryUsage\": null,\n \"maxCpuUsage\": null\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","X-Pagination-Per-Page":"20","Access-Control-Expose-Headers":"X-Pagination-Per-Page, X-Pagination-Current-Page, X-Pagination-Total-Pages, X-Pagination-Total-Entries","X-Pagination-Current-Page":"1","X-Pagination-Total-Pages":"1","X-Pagination-Total-Entries":"1","Content-Type":"application/json; charset=utf-8","ETag":"W/\"5c9e6e284fbbaab3b1ea11755fa82516\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"936db003-6a2b-4d73-9d07-f5de43babef4","X-Runtime":"0.030857","Content-Length":"247"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/scripts/containers/2811/runs\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer a4ahf8ZM_Kpn81YaZbup988ZYcxpslWTvb-xiCMUpVc\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/scripts/containers/{id}/runs/{run_id}":{"get":{"summary":"Check status of a run","description":"View the status of a run. This endpoint may be polled to monitor the status of the run. When the 'state' field is no longer 'queued' or 'running' the run has reached its final state.","deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Container job.","type":"integer"},{"name":"run_id","in":"path","required":true,"description":"The ID of the run.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object578"}}},"x-examples":[{"resource":"Scripts","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/scripts/containers/:script_with_run_id/runs/:script_run_id","description":"View a Container script's run details","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/scripts/containers/2652/runs/246","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer FeOkE9dAMJj70jbuGhwOgXbd0Mxbj2-qkOmjzyPzVB8","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 246,\n \"containerId\": 2652,\n \"state\": \"running\",\n \"isCancelRequested\": false,\n \"createdAt\": \"2024-12-03T19:46:29.000Z\",\n \"startedAt\": \"2024-12-03T19:45:29.000Z\",\n \"finishedAt\": \"2024-12-03T19:46:29.000Z\",\n \"error\": null,\n \"maxMemoryUsage\": null,\n \"maxCpuUsage\": null\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"4a11ea26cd8f63e0bf689fc144674ded\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"ba5dcef7-b42e-479b-907c-418f923e5453","X-Runtime":"0.030767","Content-Length":"245"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/scripts/containers/2652/runs/246\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer FeOkE9dAMJj70jbuGhwOgXbd0Mxbj2-qkOmjzyPzVB8\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"delete":{"summary":"Cancel a run","description":"Cancel a currently active run.","deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Container job.","type":"integer"},{"name":"run_id","in":"path","required":true,"description":"The ID of the run.","type":"integer"}],"responses":{"202":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/python3/{id}/runs":{"post":{"summary":"Start a run","description":"Start a run and provide a URI for checking its status. The response will provide a 'Location' header which will contain a URI which may be polled to monitor the status of the run.","deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Python job.","type":"integer"}],"responses":{"202":{"description":"success","schema":{"$ref":"#/definitions/Object579"}}},"x-examples":[{"resource":"Scripts","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/scripts/python3/:script_to_run_id/runs","description":"Create a python run","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/scripts/python3/2610/runs","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer bF7ULpw066ofQlCt4rINb5JWauIo_jvZoNcaDPktUTU","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":202,"response_status_text":"Accepted","response_body":"{\n \"id\": 237,\n \"pythonId\": 2610,\n \"state\": \"queued\",\n \"isCancelRequested\": false,\n \"createdAt\": \"2024-12-03T19:46:24.000Z\",\n \"startedAt\": null,\n \"finishedAt\": null,\n \"error\": null,\n \"maxMemoryUsage\": null,\n \"maxCpuUsage\": null\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Location":"http://api.civis.test/scripts/python3/2610/runs/237","Content-Type":"application/json; charset=utf-8","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"fd9b5a22-938e-4553-980a-826b5e2cd728","X-Runtime":"0.110186","Content-Length":"197"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/scripts/python3/2610/runs\" -d '' -X POST \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer bF7ULpw066ofQlCt4rINb5JWauIo_jvZoNcaDPktUTU\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"get":{"summary":"List runs for the given Python job","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Python job.","type":"integer"},{"name":"limit","in":"query","required":false,"description":"Number of results to return. Defaults to 20. Maximum allowed is 100.","type":"integer"},{"name":"page_num","in":"query","required":false,"description":"Page number of the results to return. Defaults to the first page, 1.","type":"integer"},{"name":"order","in":"query","required":false,"description":"The field on which to order the result set. Defaults to id. Must be one of: id.","type":"string"},{"name":"order_dir","in":"query","required":false,"description":"Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc.","type":"string"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object579"}}}},"x-examples":[{"resource":"Scripts","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/scripts/python3/:script_job_id/runs","description":"View a Python script's runs","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/scripts/python3/2820/runs","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer m6_Ih1jfN7frs5V81aABO3-ERHvqbe-ntFP14sspIj4","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 298,\n \"pythonId\": 2820,\n \"state\": \"running\",\n \"isCancelRequested\": false,\n \"createdAt\": \"2024-12-03T19:46:50.000Z\",\n \"startedAt\": \"2024-12-03T19:45:50.000Z\",\n \"finishedAt\": \"2024-12-04T05:46:50.000Z\",\n \"error\": null,\n \"maxMemoryUsage\": null,\n \"maxCpuUsage\": null\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","X-Pagination-Per-Page":"20","Access-Control-Expose-Headers":"X-Pagination-Per-Page, X-Pagination-Current-Page, X-Pagination-Total-Pages, X-Pagination-Total-Entries","X-Pagination-Current-Page":"1","X-Pagination-Total-Pages":"1","X-Pagination-Total-Entries":"1","Content-Type":"application/json; charset=utf-8","ETag":"W/\"93cdedb8c0de207982d1916e3c06f4a0\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"69db4347-3817-44be-b74c-a2e4c3f356fb","X-Runtime":"0.033654","Content-Length":"244"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/scripts/python3/2820/runs\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer m6_Ih1jfN7frs5V81aABO3-ERHvqbe-ntFP14sspIj4\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/scripts/python3/{id}/runs/{run_id}":{"get":{"summary":"Check status of a run","description":"View the status of a run. This endpoint may be polled to monitor the status of the run. When the 'state' field is no longer 'queued' or 'running' the run has reached its final state.","deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Python job.","type":"integer"},{"name":"run_id","in":"path","required":true,"description":"The ID of the run.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object579"}}},"x-examples":[{"resource":"Scripts","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/scripts/python3/:script_with_run_id/runs/:script_run_id","description":"View a Python script's run details","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/scripts/python3/2661/runs/248","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer _N1FlBu87ZAbQAmnoN3VHOAo9BMLERG998Ee7HqT2UI","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 248,\n \"pythonId\": 2661,\n \"state\": \"running\",\n \"isCancelRequested\": false,\n \"createdAt\": \"2024-12-03T19:46:30.000Z\",\n \"startedAt\": \"2024-12-03T19:45:30.000Z\",\n \"finishedAt\": \"2024-12-03T19:46:30.000Z\",\n \"error\": null,\n \"maxMemoryUsage\": null,\n \"maxCpuUsage\": null\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"34c6f1b582b4c6a4a9985e60088df969\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"b8cf0d77-0f13-4d9d-b51f-143ae9507fb4","X-Runtime":"0.029178","Content-Length":"242"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/scripts/python3/2661/runs/248\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer _N1FlBu87ZAbQAmnoN3VHOAo9BMLERG998Ee7HqT2UI\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"delete":{"summary":"Cancel a run","description":"Cancel a currently active run.","deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Python job.","type":"integer"},{"name":"run_id","in":"path","required":true,"description":"The ID of the run.","type":"integer"}],"responses":{"202":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null},"patch":{"summary":"Update the given run","description":"Update the run.","deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"ID of the Job","type":"integer"},{"name":"run_id","in":"path","required":true,"description":"ID of the Run","type":"integer"},{"name":"Object597","in":"body","schema":{"$ref":"#/definitions/Object597"},"required":false}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/python3/{id}/runs/{run_id}/logs":{"get":{"summary":"Get the logs for a run","description":"Get the logs for a run.","deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Python job.","type":"integer"},{"name":"run_id","in":"path","required":true,"description":"The ID of the run.","type":"integer"},{"name":"last_id","in":"query","required":false,"description":"The ID of the last log message received. Log entries with this ID value or lower will be omitted.Logs are sorted by ID if this value is provided, and are otherwise sorted by createdAt.","type":"integer"},{"name":"limit","in":"query","required":false,"description":"The maximum number of log messages to return. Default of 10000.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object117"}}}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/r/{id}/runs":{"post":{"summary":"Start a run","description":"Start a run and provide a URI for checking its status. The response will provide a 'Location' header which will contain a URI which may be polled to monitor the status of the run.","deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the R job.","type":"integer"}],"responses":{"202":{"description":"success","schema":{"$ref":"#/definitions/Object580"}}},"x-examples":[{"resource":"Scripts","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/scripts/r/:script_to_run_id/runs","description":"Create an R run","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/scripts/r/2619/runs","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer ZwNAsRTVcEAen6W2yFeEM5a5xZOXeuzNpNlsPpQx8z4","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":202,"response_status_text":"Accepted","response_body":"{\n \"id\": 239,\n \"rId\": 2619,\n \"state\": \"queued\",\n \"isCancelRequested\": false,\n \"createdAt\": \"2024-12-03T19:46:25.000Z\",\n \"startedAt\": null,\n \"finishedAt\": null,\n \"error\": null,\n \"maxMemoryUsage\": null,\n \"maxCpuUsage\": null\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Location":"http://api.civis.test/scripts/r/2619/runs/239","Content-Type":"application/json; charset=utf-8","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"467ab180-b812-42ef-8d1e-27f569f663f9","X-Runtime":"0.114546","Content-Length":"192"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/scripts/r/2619/runs\" -d '' -X POST \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer ZwNAsRTVcEAen6W2yFeEM5a5xZOXeuzNpNlsPpQx8z4\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"get":{"summary":"List runs for the given R job","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the R job.","type":"integer"},{"name":"limit","in":"query","required":false,"description":"Number of results to return. Defaults to 20. Maximum allowed is 100.","type":"integer"},{"name":"page_num","in":"query","required":false,"description":"Page number of the results to return. Defaults to the first page, 1.","type":"integer"},{"name":"order","in":"query","required":false,"description":"The field on which to order the result set. Defaults to id. Must be one of: id.","type":"string"},{"name":"order_dir","in":"query","required":false,"description":"Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc.","type":"string"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object580"}}}},"x-examples":[{"resource":"Scripts","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/scripts/r/:script_job_id/runs","description":"View an R script's runs","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/scripts/r/2829/runs","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer 1Rl6ICeurTLW6jUypCMfvJLtK0hjaJPWblBJN09zbeo","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 301,\n \"rId\": 2829,\n \"state\": \"running\",\n \"isCancelRequested\": false,\n \"createdAt\": \"2024-12-03T19:46:50.000Z\",\n \"startedAt\": \"2024-12-03T19:45:50.000Z\",\n \"finishedAt\": \"2024-12-04T05:46:50.000Z\",\n \"error\": null,\n \"maxMemoryUsage\": null,\n \"maxCpuUsage\": null\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","X-Pagination-Per-Page":"20","Access-Control-Expose-Headers":"X-Pagination-Per-Page, X-Pagination-Current-Page, X-Pagination-Total-Pages, X-Pagination-Total-Entries","X-Pagination-Current-Page":"1","X-Pagination-Total-Pages":"1","X-Pagination-Total-Entries":"1","Content-Type":"application/json; charset=utf-8","ETag":"W/\"b7cff832e0bbb40e6e09c4b36916a10e\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"016b07d9-ec76-4adf-b28a-16f19f5eec9e","X-Runtime":"0.035974","Content-Length":"239"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/scripts/r/2829/runs\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer 1Rl6ICeurTLW6jUypCMfvJLtK0hjaJPWblBJN09zbeo\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/scripts/r/{id}/runs/{run_id}":{"get":{"summary":"Check status of a run","description":"View the status of a run. This endpoint may be polled to monitor the status of the run. When the 'state' field is no longer 'queued' or 'running' the run has reached its final state.","deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the R job.","type":"integer"},{"name":"run_id","in":"path","required":true,"description":"The ID of the run.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object580"}}},"x-examples":[{"resource":"Scripts","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/scripts/r/:script_with_run_id/runs/:script_run_id","description":"View an R script's run details","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/scripts/r/2670/runs/250","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer ng1hnUZKTS-TE7YWt67rVP6FyS1KGVaKLvpIjiAhbvY","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 250,\n \"rId\": 2670,\n \"state\": \"running\",\n \"isCancelRequested\": false,\n \"createdAt\": \"2024-12-03T19:46:31.000Z\",\n \"startedAt\": \"2024-12-03T19:45:31.000Z\",\n \"finishedAt\": \"2024-12-03T19:46:31.000Z\",\n \"error\": null,\n \"maxMemoryUsage\": null,\n \"maxCpuUsage\": null\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"a2a5058e6d02647d67080fce30ede2d4\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"542a3ae8-c9d0-43c4-a89e-baea92762f15","X-Runtime":"0.033584","Content-Length":"237"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/scripts/r/2670/runs/250\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer ng1hnUZKTS-TE7YWt67rVP6FyS1KGVaKLvpIjiAhbvY\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"delete":{"summary":"Cancel a run","description":"Cancel a currently active run.","deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the R job.","type":"integer"},{"name":"run_id","in":"path","required":true,"description":"The ID of the run.","type":"integer"}],"responses":{"202":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null},"patch":{"summary":"Update the given run","description":"Update the run.","deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"ID of the Job","type":"integer"},{"name":"run_id","in":"path","required":true,"description":"ID of the Run","type":"integer"},{"name":"Object600","in":"body","schema":{"$ref":"#/definitions/Object600"},"required":false}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/r/{id}/runs/{run_id}/logs":{"get":{"summary":"Get the logs for a run","description":"Get the logs for a run.","deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the R job.","type":"integer"},{"name":"run_id","in":"path","required":true,"description":"The ID of the run.","type":"integer"},{"name":"last_id","in":"query","required":false,"description":"The ID of the last log message received. Log entries with this ID value or lower will be omitted.Logs are sorted by ID if this value is provided, and are otherwise sorted by createdAt.","type":"integer"},{"name":"limit","in":"query","required":false,"description":"The maximum number of log messages to return. Default of 10000.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object117"}}}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/dbt/{id}/runs":{"post":{"summary":"Start a run","description":"Start a run and provide a URI for checking its status. The response will provide a 'Location' header which will contain a URI which may be polled to monitor the status of the run.","deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the dbt job.","type":"integer"}],"responses":{"202":{"description":"success","schema":{"$ref":"#/definitions/Object581"}}},"x-examples":null,"x-deprecation-warning":null},"get":{"summary":"List runs for the given dbt job","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the dbt job.","type":"integer"},{"name":"limit","in":"query","required":false,"description":"Number of results to return. Defaults to 20. Maximum allowed is 100.","type":"integer"},{"name":"page_num","in":"query","required":false,"description":"Page number of the results to return. Defaults to the first page, 1.","type":"integer"},{"name":"order","in":"query","required":false,"description":"The field on which to order the result set. Defaults to id. Must be one of: id.","type":"string"},{"name":"order_dir","in":"query","required":false,"description":"Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc.","type":"string"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object581"}}}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/dbt/{id}/runs/{run_id}":{"get":{"summary":"Check status of a run","description":"View the status of a run. This endpoint may be polled to monitor the status of the run. When the 'state' field is no longer 'queued' or 'running' the run has reached its final state.","deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the dbt job.","type":"integer"},{"name":"run_id","in":"path","required":true,"description":"The ID of the run.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object581"}}},"x-examples":null,"x-deprecation-warning":null},"delete":{"summary":"Cancel a run","description":"Cancel a currently active run.","deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the dbt job.","type":"integer"},{"name":"run_id","in":"path","required":true,"description":"The ID of the run.","type":"integer"}],"responses":{"202":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null},"patch":{"summary":"Update the given run","description":"Update the run.","deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"ID of the Job","type":"integer"},{"name":"run_id","in":"path","required":true,"description":"ID of the Run","type":"integer"},{"name":"Object601","in":"body","schema":{"$ref":"#/definitions/Object601"},"required":false}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/dbt/{id}/runs/{run_id}/logs":{"get":{"summary":"Get the logs for a run","description":"Get the logs for a run.","deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the dbt job.","type":"integer"},{"name":"run_id","in":"path","required":true,"description":"The ID of the run.","type":"integer"},{"name":"last_id","in":"query","required":false,"description":"The ID of the last log message received. Log entries with this ID value or lower will be omitted.Logs are sorted by ID if this value is provided, and are otherwise sorted by createdAt.","type":"integer"},{"name":"limit","in":"query","required":false,"description":"The maximum number of log messages to return. Default of 10000.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object117"}}}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/javascript/{id}/runs":{"post":{"summary":"Start a run","description":"Start a run and provide a URI for checking its status. The response will provide a 'Location' header which will contain a URI which may be polled to monitor the status of the run.","deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Javascript job.","type":"integer"}],"responses":{"202":{"description":"success","schema":{"$ref":"#/definitions/Object582"}}},"x-examples":[{"resource":"Scripts","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/scripts/javascript/:script_to_run_id/runs","description":"Create a JavaScript run","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/scripts/javascript/2627/runs","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer zo_BhlOzHiQRE7_2H2RG-Y_dGlbnNKJ01UkbLZ1vmrU","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":202,"response_status_text":"Accepted","response_body":"{\n \"id\": 241,\n \"javascriptId\": 2627,\n \"state\": \"queued\",\n \"isCancelRequested\": false,\n \"createdAt\": \"2024-12-03T19:46:26.000Z\",\n \"startedAt\": null,\n \"finishedAt\": null,\n \"error\": null\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Location":"http://api.civis.test/scripts/javascript/2627/runs/241","Content-Type":"application/json; charset=utf-8","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"b9f8430d-2a58-472e-aa84-ac64d6f517e3","X-Runtime":"0.143685","Content-Length":"160"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/scripts/javascript/2627/runs\" -d '' -X POST \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer zo_BhlOzHiQRE7_2H2RG-Y_dGlbnNKJ01UkbLZ1vmrU\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"get":{"summary":"List runs for the given Javascript job","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Javascript job.","type":"integer"},{"name":"limit","in":"query","required":false,"description":"Number of results to return. Defaults to 20. Maximum allowed is 100.","type":"integer"},{"name":"page_num","in":"query","required":false,"description":"Page number of the results to return. Defaults to the first page, 1.","type":"integer"},{"name":"order","in":"query","required":false,"description":"The field on which to order the result set. Defaults to id. Must be one of: id.","type":"string"},{"name":"order_dir","in":"query","required":false,"description":"Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc.","type":"string"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object582"}}}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/javascript/{id}/runs/{run_id}":{"get":{"summary":"Check status of a run","description":"View the status of a run. This endpoint may be polled to monitor the status of the run. When the 'state' field is no longer 'queued' or 'running' the run has reached its final state.","deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Javascript job.","type":"integer"},{"name":"run_id","in":"path","required":true,"description":"The ID of the run.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object582"}}},"x-examples":null,"x-deprecation-warning":null},"delete":{"summary":"Cancel a run","description":"Cancel a currently active run.","deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Javascript job.","type":"integer"},{"name":"run_id","in":"path","required":true,"description":"The ID of the run.","type":"integer"}],"responses":{"202":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null},"patch":{"summary":"Update the given run","description":"Update the run.","deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"ID of the Job","type":"integer"},{"name":"run_id","in":"path","required":true,"description":"ID of the Run","type":"integer"},{"name":"Object598","in":"body","schema":{"$ref":"#/definitions/Object598"},"required":false}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/javascript/{id}/runs/{run_id}/logs":{"get":{"summary":"Get the logs for a run","description":"Get the logs for a run.","deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Javascript job.","type":"integer"},{"name":"run_id","in":"path","required":true,"description":"The ID of the run.","type":"integer"},{"name":"last_id","in":"query","required":false,"description":"The ID of the last log message received. Log entries with this ID value or lower will be omitted.Logs are sorted by ID if this value is provided, and are otherwise sorted by createdAt.","type":"integer"},{"name":"limit","in":"query","required":false,"description":"The maximum number of log messages to return. Default of 10000.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object117"}}}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/custom/{id}/runs":{"post":{"summary":"Start a run","description":"Start a run and provide a URI for checking its status. The response will provide a 'Location' header which will contain a URI which may be polled to monitor the status of the run.","deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Custom job.","type":"integer"}],"responses":{"202":{"description":"success","schema":{"$ref":"#/definitions/Object583"}}},"x-examples":[{"resource":"Scripts","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/scripts/custom/:custom_script_to_run_id/runs","description":"Create a Custom run","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/scripts/custom/2639/runs","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer fWXdUQQazI-TsC7bVZZTpGEvvS7A9YA2qi4Foz8Turc","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":202,"response_status_text":"Accepted","response_body":"{\n \"id\": 243,\n \"customId\": 2639,\n \"state\": \"queued\",\n \"isCancelRequested\": false,\n \"createdAt\": \"2024-12-03T19:46:27.000Z\",\n \"startedAt\": null,\n \"finishedAt\": null,\n \"error\": null,\n \"maxMemoryUsage\": null,\n \"maxCpuUsage\": null\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Location":"http://api.civis.test/scripts/custom/2639/runs/243","Content-Type":"application/json; charset=utf-8","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"f8b3460d-a5ff-4600-9ae8-25a2e4f7f123","X-Runtime":"0.144289","Content-Length":"197"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/scripts/custom/2639/runs\" -d '' -X POST \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer fWXdUQQazI-TsC7bVZZTpGEvvS7A9YA2qi4Foz8Turc\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"get":{"summary":"List runs for the given Custom job","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Custom job.","type":"integer"},{"name":"limit","in":"query","required":false,"description":"Number of results to return. Defaults to 20. Maximum allowed is 100.","type":"integer"},{"name":"page_num","in":"query","required":false,"description":"Page number of the results to return. Defaults to the first page, 1.","type":"integer"},{"name":"order","in":"query","required":false,"description":"The field on which to order the result set. Defaults to id. Must be one of: id.","type":"string"},{"name":"order_dir","in":"query","required":false,"description":"Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc.","type":"string"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object583"}}}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/custom/{id}/runs/{run_id}":{"get":{"summary":"Check status of a run","description":"View the status of a run. This endpoint may be polled to monitor the status of the run. When the 'state' field is no longer 'queued' or 'running' the run has reached its final state.","deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Custom job.","type":"integer"},{"name":"run_id","in":"path","required":true,"description":"The ID of the run.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object583"}}},"x-examples":null,"x-deprecation-warning":null},"delete":{"summary":"Cancel a run","description":"Cancel a currently active run.","deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Custom job.","type":"integer"},{"name":"run_id","in":"path","required":true,"description":"The ID of the run.","type":"integer"}],"responses":{"202":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/custom/{id}/runs/{run_id}/logs":{"get":{"summary":"Get the logs for a run","description":"Get the logs for a run.","deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Custom job.","type":"integer"},{"name":"run_id","in":"path","required":true,"description":"The ID of the run.","type":"integer"},{"name":"last_id","in":"query","required":false,"description":"The ID of the last log message received. Log entries with this ID value or lower will be omitted.Logs are sorted by ID if this value is provided, and are otherwise sorted by createdAt.","type":"integer"},{"name":"limit","in":"query","required":false,"description":"The maximum number of log messages to return. Default of 10000.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object117"}}}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/sql/{id}/runs/{run_id}/outputs":{"get":{"summary":"List the outputs for a run","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the sql script.","type":"integer"},{"name":"run_id","in":"path","required":true,"description":"The ID of the run.","type":"integer"},{"name":"limit","in":"query","required":false,"description":"Number of results to return. Defaults to its maximum of 50.","type":"integer"},{"name":"page_num","in":"query","required":false,"description":"Page number of the results to return. Defaults to the first page, 1.","type":"integer"},{"name":"order","in":"query","required":false,"description":"The field on which to order the result set. Defaults to created_at. Must be one of: created_at, id.","type":"string"},{"name":"order_dir","in":"query","required":false,"description":"Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc.","type":"string"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object584"}}}},"x-examples":[{"resource":"Scripts","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/scripts/sql/:job_with_run_id/runs/:job_run_id/outputs","description":"View a SQL Script's outputs","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/scripts/sql/2680/runs/254/outputs","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer lG6vUe8ioyXb9z4FO76lTaOROFvxRtQjt8Ky7TeXzn4","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"objectType\": \"File\",\n \"objectId\": 96,\n \"name\": \"my output file\",\n \"link\": \"api.civis.test/files/96\",\n \"value\": null\n },\n {\n \"objectType\": \"Report\",\n \"objectId\": 11,\n \"name\": \"my output report\",\n \"link\": \"api.civis.test/reports/11\",\n \"value\": null\n },\n {\n \"objectType\": \"Report\",\n \"objectId\": 12,\n \"name\": \"my output tableau report\",\n \"link\": \"api.civis.test/reports/12\",\n \"value\": null\n },\n {\n \"objectType\": \"Table\",\n \"objectId\": 129,\n \"name\": \"output.table\",\n \"link\": \"api.civis.test/tables/129\",\n \"value\": null\n },\n {\n \"objectType\": \"Project\",\n \"objectId\": 73,\n \"name\": \"my output project\",\n \"link\": \"api.civis.test/projects/73\",\n \"value\": null\n },\n {\n \"objectType\": \"Credential\",\n \"objectId\": 1088,\n \"name\": \"my output credential\",\n \"link\": \"api.civis.test/credentials/1088\",\n \"value\": null\n },\n {\n \"objectType\": \"JSONValue\",\n \"objectId\": 6,\n \"name\": \"my awesome JSON value\",\n \"link\": \"api.civis.test/json_values/6\",\n \"value\": {\n \"foo\": \"bar\"\n }\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","X-Pagination-Per-Page":"50","Access-Control-Expose-Headers":"X-Pagination-Per-Page, X-Pagination-Current-Page, X-Pagination-Total-Pages, X-Pagination-Total-Entries","X-Pagination-Current-Page":"1","X-Pagination-Total-Pages":"1","X-Pagination-Total-Entries":"7","Content-Type":"application/json; charset=utf-8","ETag":"W/\"4f233250402813384d29fe524a914cb3\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"90610251-5d89-4ef5-9857-7a9f9f6bf6d2","X-Runtime":"0.085389","Content-Length":"821"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/scripts/sql/2680/runs/254/outputs\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer lG6vUe8ioyXb9z4FO76lTaOROFvxRtQjt8Ky7TeXzn4\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/scripts/containers/{id}/runs/{run_id}/outputs":{"get":{"summary":"List the outputs for a run","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the container script.","type":"integer"},{"name":"run_id","in":"path","required":true,"description":"The ID of the run.","type":"integer"},{"name":"limit","in":"query","required":false,"description":"Number of results to return. Defaults to its maximum of 50.","type":"integer"},{"name":"page_num","in":"query","required":false,"description":"Page number of the results to return. Defaults to the first page, 1.","type":"integer"},{"name":"order","in":"query","required":false,"description":"The field on which to order the result set. Defaults to created_at. Must be one of: created_at, id.","type":"string"},{"name":"order_dir","in":"query","required":false,"description":"Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc.","type":"string"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object585"}}}},"x-examples":[{"resource":"Scripts","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/scripts/containers/:job_with_run_id/runs/:job_run_id/outputs","description":"View a Container script's outputs","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/scripts/containers/2709/runs/263/outputs","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer HoJI1sBTqWZHvfJOEkiXX5jX9E2sm__6sdQtGCAuF64","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"objectType\": \"File\",\n \"objectId\": 106,\n \"name\": \"my output file\",\n \"link\": \"api.civis.test/files/106\",\n \"value\": null\n },\n {\n \"objectType\": \"Report\",\n \"objectId\": 13,\n \"name\": \"my output report\",\n \"link\": \"api.civis.test/reports/13\",\n \"value\": null\n },\n {\n \"objectType\": \"Report\",\n \"objectId\": 14,\n \"name\": \"my output tableau report\",\n \"link\": \"api.civis.test/reports/14\",\n \"value\": null\n },\n {\n \"objectType\": \"Table\",\n \"objectId\": 130,\n \"name\": \"output.table\",\n \"link\": \"api.civis.test/tables/130\",\n \"value\": null\n },\n {\n \"objectType\": \"Project\",\n \"objectId\": 77,\n \"name\": \"my output project\",\n \"link\": \"api.civis.test/projects/77\",\n \"value\": null\n },\n {\n \"objectType\": \"Credential\",\n \"objectId\": 1119,\n \"name\": \"my output credential\",\n \"link\": \"api.civis.test/credentials/1119\",\n \"value\": null\n },\n {\n \"objectType\": \"JSONValue\",\n \"objectId\": 8,\n \"name\": \"my awesome JSON value\",\n \"link\": \"api.civis.test/json_values/8\",\n \"value\": {\n \"foo\": \"bar\"\n }\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","X-Pagination-Per-Page":"50","Access-Control-Expose-Headers":"X-Pagination-Per-Page, X-Pagination-Current-Page, X-Pagination-Total-Pages, X-Pagination-Total-Entries","X-Pagination-Current-Page":"1","X-Pagination-Total-Pages":"1","X-Pagination-Total-Entries":"7","Content-Type":"application/json; charset=utf-8","ETag":"W/\"309f37d0db812828fda4a489f2ea9704\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"2e02288e-0769-42cd-bdbe-2c3f1d030663","X-Runtime":"0.073609","Content-Length":"823"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/scripts/containers/2709/runs/263/outputs\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer HoJI1sBTqWZHvfJOEkiXX5jX9E2sm__6sdQtGCAuF64\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"post":{"summary":"Add an output for a run","description":"Publish the given object as an output of the run. If the script is running in author context, this will transfer ownership of the object to the job runner.","deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the container script.","type":"integer"},{"name":"run_id","in":"path","required":true,"description":"The ID of the run.","type":"integer"},{"name":"Object586","in":"body","schema":{"$ref":"#/definitions/Object586"},"required":true}],"responses":{"202":{"description":"success","schema":{"$ref":"#/definitions/Object585"}}},"x-examples":[{"resource":"Scripts","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/scripts/containers/:job_with_run_id/runs/:job_run_id/outputs","description":"Add an output to a Container script","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/scripts/containers/2691/runs/257/outputs","request_body":"{\n \"objectType\": \"File\",\n \"objectId\": 100\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer 9Y6JowBhAZ8YzylwO76OTRozo0jcMDndGWNlEvN97xc","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":202,"response_status_text":"Accepted","response_body":"{\n \"objectType\": \"File\",\n \"objectId\": 100,\n \"name\": \"My output file\",\n \"link\": \"api.civis.test/files/100\",\n \"value\": null\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"18a491fc-cba4-43a2-a3b4-568c3ef03a10","X-Runtime":"0.073109","Content-Length":"107"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/scripts/containers/2691/runs/257/outputs\" -d '{\"objectType\":\"File\",\"objectId\":100}' -X POST \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer 9Y6JowBhAZ8YzylwO76OTRozo0jcMDndGWNlEvN97xc\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Scripts","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/scripts/containers/:job_with_run_id/runs/:job_run_id/outputs","description":"Add a JSONValue output to a Container script","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/scripts/containers/2700/runs/260/outputs","request_body":"{\n \"objectType\": \"JSONValue\",\n \"objectId\": 7\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer 9udspgxWBUNnVygZ6vCdGXebPVYYPGLAZskTjd8uvxw","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":202,"response_status_text":"Accepted","response_body":"{\n \"objectType\": \"JSONValue\",\n \"objectId\": 7,\n \"name\": \"my awesome JSON Value\",\n \"link\": \"api.civis.test/json_values/7\",\n \"value\": {\n \"foo\": \"bar\"\n }\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"9f48760d-1e7d-466a-8a72-a693220dae20","X-Runtime":"0.039850","Content-Length":"130"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/scripts/containers/2700/runs/260/outputs\" -d '{\"objectType\":\"JSONValue\",\"objectId\":7}' -X POST \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer 9udspgxWBUNnVygZ6vCdGXebPVYYPGLAZskTjd8uvxw\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/scripts/python3/{id}/runs/{run_id}/outputs":{"get":{"summary":"List the outputs for a run","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the python script.","type":"integer"},{"name":"run_id","in":"path","required":true,"description":"The ID of the run.","type":"integer"},{"name":"limit","in":"query","required":false,"description":"Number of results to return. Defaults to its maximum of 50.","type":"integer"},{"name":"page_num","in":"query","required":false,"description":"Page number of the results to return. Defaults to the first page, 1.","type":"integer"},{"name":"order","in":"query","required":false,"description":"The field on which to order the result set. Defaults to created_at. Must be one of: created_at, id.","type":"string"},{"name":"order_dir","in":"query","required":false,"description":"Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc.","type":"string"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object587"}}}},"x-examples":[{"resource":"Scripts","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/scripts/python3/:job_with_run_id/runs/:job_run_id/outputs","description":"View a Python Script's outputs","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/scripts/python3/2738/runs/272/outputs","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer z2Pfzl26wyx9IAMmcxHCYgrLBFjyVXl7rScyGHTmUPI","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"objectType\": \"File\",\n \"objectId\": 116,\n \"name\": \"my output file\",\n \"link\": \"api.civis.test/files/116\",\n \"value\": null\n },\n {\n \"objectType\": \"Report\",\n \"objectId\": 15,\n \"name\": \"my output report\",\n \"link\": \"api.civis.test/reports/15\",\n \"value\": null\n },\n {\n \"objectType\": \"Report\",\n \"objectId\": 16,\n \"name\": \"my output tableau report\",\n \"link\": \"api.civis.test/reports/16\",\n \"value\": null\n },\n {\n \"objectType\": \"Table\",\n \"objectId\": 131,\n \"name\": \"output.table\",\n \"link\": \"api.civis.test/tables/131\",\n \"value\": null\n },\n {\n \"objectType\": \"Project\",\n \"objectId\": 81,\n \"name\": \"my output project\",\n \"link\": \"api.civis.test/projects/81\",\n \"value\": null\n },\n {\n \"objectType\": \"Credential\",\n \"objectId\": 1150,\n \"name\": \"my output credential\",\n \"link\": \"api.civis.test/credentials/1150\",\n \"value\": null\n },\n {\n \"objectType\": \"JSONValue\",\n \"objectId\": 10,\n \"name\": \"my awesome JSON value\",\n \"link\": \"api.civis.test/json_values/10\",\n \"value\": {\n \"foo\": \"bar\"\n }\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","X-Pagination-Per-Page":"50","Access-Control-Expose-Headers":"X-Pagination-Per-Page, X-Pagination-Current-Page, X-Pagination-Total-Pages, X-Pagination-Total-Entries","X-Pagination-Current-Page":"1","X-Pagination-Total-Pages":"1","X-Pagination-Total-Entries":"7","Content-Type":"application/json; charset=utf-8","ETag":"W/\"c36682b45cfe6a321780d14c42d9f386\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"52e2acb5-0f0e-4b06-a357-43b89fdaf1b0","X-Runtime":"0.081386","Content-Length":"825"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/scripts/python3/2738/runs/272/outputs\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer z2Pfzl26wyx9IAMmcxHCYgrLBFjyVXl7rScyGHTmUPI\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"post":{"summary":"Add an output for a run","description":"Publish the given object as an output of the run. If the script is running in author context, this will transfer ownership of the object to the job runner.","deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the python script.","type":"integer"},{"name":"run_id","in":"path","required":true,"description":"The ID of the run.","type":"integer"},{"name":"Object588","in":"body","schema":{"$ref":"#/definitions/Object588"},"required":true}],"responses":{"202":{"description":"success","schema":{"$ref":"#/definitions/Object587"}}},"x-examples":[{"resource":"Scripts","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/scripts/python3/:job_with_run_id/runs/:job_run_id/outputs","description":"Add an output to a Python Script","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/scripts/python3/2720/runs/266/outputs","request_body":"{\n \"objectType\": \"File\",\n \"objectId\": 110\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer bH_p6bJP42T55vW-4Ug2nkkvMH8uOwt8o_LFIQetr0Y","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":202,"response_status_text":"Accepted","response_body":"{\n \"objectType\": \"File\",\n \"objectId\": 110,\n \"name\": \"My output file\",\n \"link\": \"api.civis.test/files/110\",\n \"value\": null\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"ea4f03ac-3533-4f76-b640-34c9e7f0ab55","X-Runtime":"0.042757","Content-Length":"107"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/scripts/python3/2720/runs/266/outputs\" -d '{\"objectType\":\"File\",\"objectId\":110}' -X POST \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer bH_p6bJP42T55vW-4Ug2nkkvMH8uOwt8o_LFIQetr0Y\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Scripts","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/scripts/python3/:job_with_run_id/runs/:job_run_id/outputs","description":"Add a JSONValue output to a Python Script","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/scripts/python3/2729/runs/269/outputs","request_body":"{\n \"objectType\": \"JSONValue\",\n \"objectId\": 9\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer PmzcvjDHGUsPJxOfYl3ptWUkCkyeoah9nHlVsBx_jU0","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":202,"response_status_text":"Accepted","response_body":"{\n \"objectType\": \"JSONValue\",\n \"objectId\": 9,\n \"name\": \"my awesome JSON Value\",\n \"link\": \"api.civis.test/json_values/9\",\n \"value\": {\n \"foo\": \"bar\"\n }\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"6960a358-1ccc-4f8e-8cd9-127041d796f7","X-Runtime":"0.040194","Content-Length":"130"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/scripts/python3/2729/runs/269/outputs\" -d '{\"objectType\":\"JSONValue\",\"objectId\":9}' -X POST \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer PmzcvjDHGUsPJxOfYl3ptWUkCkyeoah9nHlVsBx_jU0\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/scripts/r/{id}/runs/{run_id}/outputs":{"get":{"summary":"List the outputs for a run","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the r script.","type":"integer"},{"name":"run_id","in":"path","required":true,"description":"The ID of the run.","type":"integer"},{"name":"limit","in":"query","required":false,"description":"Number of results to return. Defaults to its maximum of 50.","type":"integer"},{"name":"page_num","in":"query","required":false,"description":"Page number of the results to return. Defaults to the first page, 1.","type":"integer"},{"name":"order","in":"query","required":false,"description":"The field on which to order the result set. Defaults to created_at. Must be one of: created_at, id.","type":"string"},{"name":"order_dir","in":"query","required":false,"description":"Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc.","type":"string"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object589"}}}},"x-examples":[{"resource":"Scripts","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/scripts/r/:job_with_run_id/runs/:job_run_id/outputs","description":"View an R Script's outputs","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/scripts/r/2767/runs/281/outputs","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer 7Xa5PM4lm5JnQU3ncmMjZtPtiHFQXY9sw13jdL1cGdQ","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"objectType\": \"File\",\n \"objectId\": 126,\n \"name\": \"my output file\",\n \"link\": \"api.civis.test/files/126\",\n \"value\": null\n },\n {\n \"objectType\": \"Report\",\n \"objectId\": 17,\n \"name\": \"my output report\",\n \"link\": \"api.civis.test/reports/17\",\n \"value\": null\n },\n {\n \"objectType\": \"Report\",\n \"objectId\": 18,\n \"name\": \"my output tableau report\",\n \"link\": \"api.civis.test/reports/18\",\n \"value\": null\n },\n {\n \"objectType\": \"Table\",\n \"objectId\": 132,\n \"name\": \"output.table\",\n \"link\": \"api.civis.test/tables/132\",\n \"value\": null\n },\n {\n \"objectType\": \"Project\",\n \"objectId\": 85,\n \"name\": \"my output project\",\n \"link\": \"api.civis.test/projects/85\",\n \"value\": null\n },\n {\n \"objectType\": \"Credential\",\n \"objectId\": 1181,\n \"name\": \"my output credential\",\n \"link\": \"api.civis.test/credentials/1181\",\n \"value\": null\n },\n {\n \"objectType\": \"JSONValue\",\n \"objectId\": 12,\n \"name\": \"my awesome JSON value\",\n \"link\": \"api.civis.test/json_values/12\",\n \"value\": {\n \"foo\": \"bar\"\n }\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","X-Pagination-Per-Page":"50","Access-Control-Expose-Headers":"X-Pagination-Per-Page, X-Pagination-Current-Page, X-Pagination-Total-Pages, X-Pagination-Total-Entries","X-Pagination-Current-Page":"1","X-Pagination-Total-Pages":"1","X-Pagination-Total-Entries":"7","Content-Type":"application/json; charset=utf-8","ETag":"W/\"1b0d5849c0da74085c68fe0a3718aa59\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"668e0807-43e6-43ef-983d-57e8bb97d9fb","X-Runtime":"0.101572","Content-Length":"825"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/scripts/r/2767/runs/281/outputs\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer 7Xa5PM4lm5JnQU3ncmMjZtPtiHFQXY9sw13jdL1cGdQ\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"post":{"summary":"Add an output for a run","description":"Publish the given object as an output of the run. If the script is running in author context, this will transfer ownership of the object to the job runner.","deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the r script.","type":"integer"},{"name":"run_id","in":"path","required":true,"description":"The ID of the run.","type":"integer"},{"name":"Object590","in":"body","schema":{"$ref":"#/definitions/Object590"},"required":true}],"responses":{"202":{"description":"success","schema":{"$ref":"#/definitions/Object589"}}},"x-examples":[{"resource":"Scripts","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/scripts/r/:job_with_run_id/runs/:job_run_id/outputs","description":"Add an output to an R Script","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/scripts/r/2749/runs/275/outputs","request_body":"{\n \"objectType\": \"File\",\n \"objectId\": 120\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer gwxgIWGJ2I_JL6vbgHyZzle8KTt4mkeL0GuHswc7edM","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":202,"response_status_text":"Accepted","response_body":"{\n \"objectType\": \"File\",\n \"objectId\": 120,\n \"name\": \"My output file\",\n \"link\": \"api.civis.test/files/120\",\n \"value\": null\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"d1749ebb-9b59-46fa-8927-f8625f41a6c3","X-Runtime":"0.039823","Content-Length":"107"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/scripts/r/2749/runs/275/outputs\" -d '{\"objectType\":\"File\",\"objectId\":120}' -X POST \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer gwxgIWGJ2I_JL6vbgHyZzle8KTt4mkeL0GuHswc7edM\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Scripts","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/scripts/r/:job_with_run_id/runs/:job_run_id/outputs","description":"Add a JSONValue output to an R Script","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/scripts/r/2758/runs/278/outputs","request_body":"{\n \"objectType\": \"JSONValue\",\n \"objectId\": 11\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer -1aEeXJJUInCcn8f6Aam9PvCjMoJT1G_7QKeXep_dSM","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":202,"response_status_text":"Accepted","response_body":"{\n \"objectType\": \"JSONValue\",\n \"objectId\": 11,\n \"name\": \"my awesome JSON Value\",\n \"link\": \"api.civis.test/json_values/11\",\n \"value\": {\n \"foo\": \"bar\"\n }\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"432e2797-e0d2-4cef-a007-53513ede0c15","X-Runtime":"0.043603","Content-Length":"132"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/scripts/r/2758/runs/278/outputs\" -d '{\"objectType\":\"JSONValue\",\"objectId\":11}' -X POST \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer -1aEeXJJUInCcn8f6Aam9PvCjMoJT1G_7QKeXep_dSM\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/scripts/dbt/{id}/runs/{run_id}/outputs":{"get":{"summary":"List the outputs for a run","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the dbt script.","type":"integer"},{"name":"run_id","in":"path","required":true,"description":"The ID of the run.","type":"integer"},{"name":"limit","in":"query","required":false,"description":"Number of results to return. Defaults to its maximum of 50.","type":"integer"},{"name":"page_num","in":"query","required":false,"description":"Page number of the results to return. Defaults to the first page, 1.","type":"integer"},{"name":"order","in":"query","required":false,"description":"The field on which to order the result set. Defaults to created_at. Must be one of: created_at, id.","type":"string"},{"name":"order_dir","in":"query","required":false,"description":"Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc.","type":"string"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object591"}}}},"x-examples":null,"x-deprecation-warning":null},"post":{"summary":"Add an output for a run","description":"Publish the given object as an output of the run. If the script is running in author context, this will transfer ownership of the object to the job runner.","deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the dbt script.","type":"integer"},{"name":"run_id","in":"path","required":true,"description":"The ID of the run.","type":"integer"},{"name":"Object592","in":"body","schema":{"$ref":"#/definitions/Object592"},"required":true}],"responses":{"202":{"description":"success","schema":{"$ref":"#/definitions/Object591"}}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/javascript/{id}/runs/{run_id}/outputs":{"get":{"summary":"List the outputs for a run","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the javascript script.","type":"integer"},{"name":"run_id","in":"path","required":true,"description":"The ID of the run.","type":"integer"},{"name":"limit","in":"query","required":false,"description":"Number of results to return. Defaults to its maximum of 50.","type":"integer"},{"name":"page_num","in":"query","required":false,"description":"Page number of the results to return. Defaults to the first page, 1.","type":"integer"},{"name":"order","in":"query","required":false,"description":"The field on which to order the result set. Defaults to created_at. Must be one of: created_at, id.","type":"string"},{"name":"order_dir","in":"query","required":false,"description":"Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc.","type":"string"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object593"}}}},"x-examples":[{"resource":"Scripts","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/scripts/javascript/:job_with_run_id/runs/:job_run_id/outputs","description":"View a JavaScript Script's outputs","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/scripts/javascript/2793/runs/290/outputs","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer oT5hPWPQiaU9AIEWfgXdB4FhzIOsZUD6MdDwqG7zzic","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"objectType\": \"File\",\n \"objectId\": 136,\n \"name\": \"my output file\",\n \"link\": \"api.civis.test/files/136\",\n \"value\": null\n },\n {\n \"objectType\": \"Report\",\n \"objectId\": 19,\n \"name\": \"my output report\",\n \"link\": \"api.civis.test/reports/19\",\n \"value\": null\n },\n {\n \"objectType\": \"Report\",\n \"objectId\": 20,\n \"name\": \"my output tableau report\",\n \"link\": \"api.civis.test/reports/20\",\n \"value\": null\n },\n {\n \"objectType\": \"Table\",\n \"objectId\": 133,\n \"name\": \"output.table\",\n \"link\": \"api.civis.test/tables/133\",\n \"value\": null\n },\n {\n \"objectType\": \"Project\",\n \"objectId\": 89,\n \"name\": \"my output project\",\n \"link\": \"api.civis.test/projects/89\",\n \"value\": null\n },\n {\n \"objectType\": \"Credential\",\n \"objectId\": 1218,\n \"name\": \"my output credential\",\n \"link\": \"api.civis.test/credentials/1218\",\n \"value\": null\n },\n {\n \"objectType\": \"JSONValue\",\n \"objectId\": 14,\n \"name\": \"my awesome JSON value\",\n \"link\": \"api.civis.test/json_values/14\",\n \"value\": {\n \"foo\": \"bar\"\n }\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","X-Pagination-Per-Page":"50","Access-Control-Expose-Headers":"X-Pagination-Per-Page, X-Pagination-Current-Page, X-Pagination-Total-Pages, X-Pagination-Total-Entries","X-Pagination-Current-Page":"1","X-Pagination-Total-Pages":"1","X-Pagination-Total-Entries":"7","Content-Type":"application/json; charset=utf-8","ETag":"W/\"4a6a96da299607720fb5b917e2e61525\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"d75b1122-a9b4-4d26-ae8e-2c9a699c2556","X-Runtime":"0.076189","Content-Length":"825"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/scripts/javascript/2793/runs/290/outputs\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer oT5hPWPQiaU9AIEWfgXdB4FhzIOsZUD6MdDwqG7zzic\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"post":{"summary":"Add an output for a run","description":"Publish the given object as an output of the run. If the script is running in author context, this will transfer ownership of the object to the job runner.","deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the javascript script.","type":"integer"},{"name":"run_id","in":"path","required":true,"description":"The ID of the run.","type":"integer"},{"name":"Object594","in":"body","schema":{"$ref":"#/definitions/Object594"},"required":true}],"responses":{"202":{"description":"success","schema":{"$ref":"#/definitions/Object593"}}},"x-examples":[{"resource":"Scripts","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/scripts/javascript/:job_with_run_id/runs/:job_run_id/outputs","description":"Add an output to a JavaScript Script","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/scripts/javascript/2777/runs/284/outputs","request_body":"{\n \"objectType\": \"File\",\n \"objectId\": 130\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer Zh9h1QxHaJMuWhvnUUCY_UFBLP4HOO9bV-5WmklT7w0","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":202,"response_status_text":"Accepted","response_body":"{\n \"objectType\": \"File\",\n \"objectId\": 130,\n \"name\": \"My output file\",\n \"link\": \"api.civis.test/files/130\",\n \"value\": null\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"e34e7c32-2bc0-4e03-a5e7-e48195c4a326","X-Runtime":"0.039072","Content-Length":"107"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/scripts/javascript/2777/runs/284/outputs\" -d '{\"objectType\":\"File\",\"objectId\":130}' -X POST \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer Zh9h1QxHaJMuWhvnUUCY_UFBLP4HOO9bV-5WmklT7w0\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Scripts","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/scripts/javascript/:job_with_run_id/runs/:job_run_id/outputs","description":"Add a JSONValue output to a JavaScript Script","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/scripts/javascript/2785/runs/287/outputs","request_body":"{\n \"objectType\": \"JSONValue\",\n \"objectId\": 13\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer n9Jdc4avCMw9mKipZdjF-hpqjSVMC6v7BDiqlg0Jc34","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":202,"response_status_text":"Accepted","response_body":"{\n \"objectType\": \"JSONValue\",\n \"objectId\": 13,\n \"name\": \"my awesome JSON Value\",\n \"link\": \"api.civis.test/json_values/13\",\n \"value\": {\n \"foo\": \"bar\"\n }\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"7bef3491-f721-4f5b-86c7-bed89111112e","X-Runtime":"0.040510","Content-Length":"132"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/scripts/javascript/2785/runs/287/outputs\" -d '{\"objectType\":\"JSONValue\",\"objectId\":13}' -X POST \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer n9Jdc4avCMw9mKipZdjF-hpqjSVMC6v7BDiqlg0Jc34\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/scripts/custom/{id}/runs/{run_id}/outputs":{"get":{"summary":"List the outputs for a run","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the custom script.","type":"integer"},{"name":"run_id","in":"path","required":true,"description":"The ID of the run.","type":"integer"},{"name":"limit","in":"query","required":false,"description":"Number of results to return. Defaults to its maximum of 50.","type":"integer"},{"name":"page_num","in":"query","required":false,"description":"Page number of the results to return. Defaults to the first page, 1.","type":"integer"},{"name":"order","in":"query","required":false,"description":"The field on which to order the result set. Defaults to created_at. Must be one of: created_at, id.","type":"string"},{"name":"order_dir","in":"query","required":false,"description":"Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc.","type":"string"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object595"}}}},"x-examples":null,"x-deprecation-warning":null},"post":{"summary":"Add an output for a run","description":"Publish the given object as an output of the run. If the script is running in author context, this will transfer ownership of the object to the job runner.","deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the custom script.","type":"integer"},{"name":"run_id","in":"path","required":true,"description":"The ID of the run.","type":"integer"},{"name":"Object596","in":"body","schema":{"$ref":"#/definitions/Object596"},"required":true}],"responses":{"202":{"description":"success","schema":{"$ref":"#/definitions/Object595"}}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/container/{id}/runs/{run_id}":{"patch":{"summary":"Update the given run","description":"Update the run.","deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"ID of the Job","type":"integer"},{"name":"run_id","in":"path","required":true,"description":"ID of the Run","type":"integer"},{"name":"Object602","in":"body","schema":{"$ref":"#/definitions/Object602"},"required":false}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/sql/{id}/git":{"get":{"summary":"Get the git metadata attached to an item","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the item.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object403"}}},"x-examples":null,"x-deprecation-warning":null},"put":{"summary":"Attach an item to a file in a git repo","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the item.","type":"integer"},{"name":"Object404","in":"body","schema":{"$ref":"#/definitions/Object404"},"required":false}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object403"}}},"x-examples":null,"x-deprecation-warning":null},"patch":{"summary":"Update an attached git file","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the item.","type":"integer"},{"name":"Object404","in":"body","schema":{"$ref":"#/definitions/Object404"},"required":false}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object403"}}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/sql/{id}/git/commits":{"get":{"summary":"Get the git commits for an item on the current branch","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the item.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object405"}}},"x-examples":null,"x-deprecation-warning":null},"post":{"summary":"Commit and push a new version of the file","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the item.","type":"integer"},{"name":"Object406","in":"body","schema":{"$ref":"#/definitions/Object406"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object407"}}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/sql/{id}/git/commits/{commit_hash}":{"get":{"summary":"Get file contents at git ref","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the item.","type":"integer"},{"name":"commit_hash","in":"path","required":true,"description":"The SHA (full or shortened) of the desired git commit.","type":"string"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object407"}}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/sql/{id}/git/checkout-latest":{"post":{"summary":"Checkout latest commit on the current branch of a script or workflow","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the item.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object407"}}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/sql/{id}/git/checkout":{"post":{"summary":"Checkout content that the existing git_ref points to and save to the object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the item.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object407"}}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/javascript/{id}/git":{"get":{"summary":"Get the git metadata attached to an item","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the item.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object403"}}},"x-examples":null,"x-deprecation-warning":null},"put":{"summary":"Attach an item to a file in a git repo","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the item.","type":"integer"},{"name":"Object404","in":"body","schema":{"$ref":"#/definitions/Object404"},"required":false}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object403"}}},"x-examples":null,"x-deprecation-warning":null},"patch":{"summary":"Update an attached git file","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the item.","type":"integer"},{"name":"Object404","in":"body","schema":{"$ref":"#/definitions/Object404"},"required":false}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object403"}}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/javascript/{id}/git/commits":{"get":{"summary":"Get the git commits for an item on the current branch","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the item.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object405"}}},"x-examples":null,"x-deprecation-warning":null},"post":{"summary":"Commit and push a new version of the file","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the item.","type":"integer"},{"name":"Object406","in":"body","schema":{"$ref":"#/definitions/Object406"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object407"}}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/javascript/{id}/git/commits/{commit_hash}":{"get":{"summary":"Get file contents at git ref","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the item.","type":"integer"},{"name":"commit_hash","in":"path","required":true,"description":"The SHA (full or shortened) of the desired git commit.","type":"string"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object407"}}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/javascript/{id}/git/checkout-latest":{"post":{"summary":"Checkout latest commit on the current branch of a script or workflow","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the item.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object407"}}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/javascript/{id}/git/checkout":{"post":{"summary":"Checkout content that the existing git_ref points to and save to the object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the item.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object407"}}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/python3/{id}/git":{"get":{"summary":"Get the git metadata attached to an item","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the item.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object403"}}},"x-examples":null,"x-deprecation-warning":null},"put":{"summary":"Attach an item to a file in a git repo","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the item.","type":"integer"},{"name":"Object404","in":"body","schema":{"$ref":"#/definitions/Object404"},"required":false}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object403"}}},"x-examples":null,"x-deprecation-warning":null},"patch":{"summary":"Update an attached git file","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the item.","type":"integer"},{"name":"Object404","in":"body","schema":{"$ref":"#/definitions/Object404"},"required":false}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object403"}}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/python3/{id}/git/commits":{"get":{"summary":"Get the git commits for an item on the current branch","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the item.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object405"}}},"x-examples":null,"x-deprecation-warning":null},"post":{"summary":"Commit and push a new version of the file","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the item.","type":"integer"},{"name":"Object406","in":"body","schema":{"$ref":"#/definitions/Object406"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object407"}}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/python3/{id}/git/commits/{commit_hash}":{"get":{"summary":"Get file contents at git ref","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the item.","type":"integer"},{"name":"commit_hash","in":"path","required":true,"description":"The SHA (full or shortened) of the desired git commit.","type":"string"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object407"}}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/python3/{id}/git/checkout-latest":{"post":{"summary":"Checkout latest commit on the current branch of a script or workflow","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the item.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object407"}}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/python3/{id}/git/checkout":{"post":{"summary":"Checkout content that the existing git_ref points to and save to the object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the item.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object407"}}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/r/{id}/git":{"get":{"summary":"Get the git metadata attached to an item","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the item.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object403"}}},"x-examples":null,"x-deprecation-warning":null},"put":{"summary":"Attach an item to a file in a git repo","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the item.","type":"integer"},{"name":"Object404","in":"body","schema":{"$ref":"#/definitions/Object404"},"required":false}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object403"}}},"x-examples":null,"x-deprecation-warning":null},"patch":{"summary":"Update an attached git file","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the item.","type":"integer"},{"name":"Object404","in":"body","schema":{"$ref":"#/definitions/Object404"},"required":false}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object403"}}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/r/{id}/git/commits":{"get":{"summary":"Get the git commits for an item on the current branch","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the item.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object405"}}},"x-examples":null,"x-deprecation-warning":null},"post":{"summary":"Commit and push a new version of the file","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the item.","type":"integer"},{"name":"Object406","in":"body","schema":{"$ref":"#/definitions/Object406"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object407"}}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/r/{id}/git/commits/{commit_hash}":{"get":{"summary":"Get file contents at git ref","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the item.","type":"integer"},{"name":"commit_hash","in":"path","required":true,"description":"The SHA (full or shortened) of the desired git commit.","type":"string"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object407"}}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/r/{id}/git/checkout-latest":{"post":{"summary":"Checkout latest commit on the current branch of a script or workflow","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the item.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object407"}}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/r/{id}/git/checkout":{"post":{"summary":"Checkout content that the existing git_ref points to and save to the object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the item.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object407"}}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/sql/{id}/shares":{"get":{"summary":"List users and groups permissioned on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object9"}}}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/sql/{id}/shares/users":{"put":{"summary":"Set the permissions users have on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"Object603","in":"body","schema":{"$ref":"#/definitions/Object603"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object9"}}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/sql/{id}/shares/users/{user_id}":{"delete":{"summary":"Revoke the permissions a user has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"user_id","in":"path","required":true,"description":"The ID of the user.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/sql/{id}/shares/groups":{"put":{"summary":"Set the permissions groups has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"Object604","in":"body","schema":{"$ref":"#/definitions/Object604"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object9"}}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/sql/{id}/shares/groups/{group_id}":{"delete":{"summary":"Revoke the permissions a group has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"group_id","in":"path","required":true,"description":"The ID of the group.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/sql/{id}/dependencies":{"get":{"summary":"List dependent objects for this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"user_id","in":"query","required":false,"description":"ID of target user","type":"integer"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object15"}}}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/sql/{id}/transfer":{"put":{"summary":"Transfer ownership of this object to another user","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"Object605","in":"body","schema":{"$ref":"#/definitions/Object605"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object17"}}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/sql/{id}/projects":{"get":{"summary":"List the projects a SQL Script belongs to","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the SQL Script.","type":"integer"},{"name":"hidden","in":"query","required":false,"description":"If specified to be true, returns hidden items. Defaults to false, returning non-hidden items.","type":"boolean"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object85"}}}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/sql/{id}/projects/{project_id}":{"put":{"summary":"Add a SQL Script to a project","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the SQL Script.","type":"integer"},{"name":"project_id","in":"path","required":true,"description":"The ID of the project.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null},"delete":{"summary":"Remove a SQL Script from a project","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the SQL Script.","type":"integer"},{"name":"project_id","in":"path","required":true,"description":"The ID of the project.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/sql/{id}/archive":{"put":{"summary":"Update the archive status of this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the object.","type":"integer"},{"name":"Object606","in":"body","schema":{"$ref":"#/definitions/Object606"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object545"}}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/containers/{id}/shares":{"get":{"summary":"List users and groups permissioned on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object9"}}}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/containers/{id}/shares/users":{"put":{"summary":"Set the permissions users have on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"Object607","in":"body","schema":{"$ref":"#/definitions/Object607"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object9"}}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/containers/{id}/shares/users/{user_id}":{"delete":{"summary":"Revoke the permissions a user has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"user_id","in":"path","required":true,"description":"The ID of the user.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/containers/{id}/shares/groups":{"put":{"summary":"Set the permissions groups has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"Object608","in":"body","schema":{"$ref":"#/definitions/Object608"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object9"}}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/containers/{id}/shares/groups/{group_id}":{"delete":{"summary":"Revoke the permissions a group has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"group_id","in":"path","required":true,"description":"The ID of the group.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/containers/{id}/dependencies":{"get":{"summary":"List dependent objects for this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"user_id","in":"query","required":false,"description":"ID of target user","type":"integer"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object15"}}}},"x-examples":[{"resource":"Scripts","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/scripts/containers/:id/dependencies","description":"Get all container dependencies","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/scripts/containers/2844/dependencies","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer aVO77axANNLehy4wrRGSbK9cIMQP2gj2D6Doj4Efi44","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"objectType\": \"Credential\",\n \"fcoType\": \"credentials\",\n \"id\": 1273,\n \"name\": \"Custom\",\n \"permissionLevel\": null,\n \"description\": null,\n \"shareable\": true\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"8206155baeeff2084d873904e4929ed8\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"8b2a857e-eb0d-46c4-acf0-a06d549af162","X-Runtime":"0.039390","Content-Length":"138"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/scripts/containers/2844/dependencies\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer aVO77axANNLehy4wrRGSbK9cIMQP2gj2D6Doj4Efi44\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Scripts","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/scripts/containers/:id/dependencies","description":"Get all container dependencies using a target user","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/scripts/containers/2853/dependencies?userId=2950","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer kU0a9Ev6DiFULVV2KDCcKx1gGc9dWlLLJDjrDqImAH4","Host":"api.civis.test","Cookie":""},"request_query_parameters":{"userId":"2950"},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"objectType\": \"Credential\",\n \"fcoType\": \"credentials\",\n \"id\": 1283,\n \"name\": \"Custom\",\n \"permissionLevel\": \"manage\",\n \"description\": null,\n \"shareable\": true\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"5b398e4a126401fb914a152cde3dc6ac\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"51037b69-dcd9-405f-ae8a-71bcc3b9af96","X-Runtime":"0.053699","Content-Length":"142"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/scripts/containers/2853/dependencies?userId=2950\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer kU0a9Ev6DiFULVV2KDCcKx1gGc9dWlLLJDjrDqImAH4\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/scripts/containers/{id}/transfer":{"put":{"summary":"Transfer ownership of this object to another user","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"Object609","in":"body","schema":{"$ref":"#/definitions/Object609"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object17"}}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/containers/{id}/projects":{"get":{"summary":"List the projects a Container Script belongs to","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Container Script.","type":"integer"},{"name":"hidden","in":"query","required":false,"description":"If specified to be true, returns hidden items. Defaults to false, returning non-hidden items.","type":"boolean"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object85"}}}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/containers/{id}/projects/{project_id}":{"put":{"summary":"Add a Container Script to a project","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Container Script.","type":"integer"},{"name":"project_id","in":"path","required":true,"description":"The ID of the project.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null},"delete":{"summary":"Remove a Container Script from a project","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Container Script.","type":"integer"},{"name":"project_id","in":"path","required":true,"description":"The ID of the project.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/containers/{id}/archive":{"put":{"summary":"Update the archive status of this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the object.","type":"integer"},{"name":"Object610","in":"body","schema":{"$ref":"#/definitions/Object610"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object532"}}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/python3/{id}/shares":{"get":{"summary":"List users and groups permissioned on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object9"}}}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/python3/{id}/shares/users":{"put":{"summary":"Set the permissions users have on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"Object611","in":"body","schema":{"$ref":"#/definitions/Object611"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object9"}}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/python3/{id}/shares/users/{user_id}":{"delete":{"summary":"Revoke the permissions a user has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"user_id","in":"path","required":true,"description":"The ID of the user.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/python3/{id}/shares/groups":{"put":{"summary":"Set the permissions groups has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"Object612","in":"body","schema":{"$ref":"#/definitions/Object612"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object9"}}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/python3/{id}/shares/groups/{group_id}":{"delete":{"summary":"Revoke the permissions a group has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"group_id","in":"path","required":true,"description":"The ID of the group.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/python3/{id}/dependencies":{"get":{"summary":"List dependent objects for this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"user_id","in":"query","required":false,"description":"ID of target user","type":"integer"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object15"}}}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/python3/{id}/transfer":{"put":{"summary":"Transfer ownership of this object to another user","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"Object613","in":"body","schema":{"$ref":"#/definitions/Object613"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object17"}}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/python3/{id}/projects":{"get":{"summary":"List the projects a Python Script belongs to","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Python Script.","type":"integer"},{"name":"hidden","in":"query","required":false,"description":"If specified to be true, returns hidden items. Defaults to false, returning non-hidden items.","type":"boolean"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object85"}}}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/python3/{id}/projects/{project_id}":{"put":{"summary":"Add a Python Script to a project","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Python Script.","type":"integer"},{"name":"project_id","in":"path","required":true,"description":"The ID of the project.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null},"delete":{"summary":"Remove a Python Script from a project","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Python Script.","type":"integer"},{"name":"project_id","in":"path","required":true,"description":"The ID of the project.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/python3/{id}/archive":{"put":{"summary":"Update the archive status of this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the object.","type":"integer"},{"name":"Object614","in":"body","schema":{"$ref":"#/definitions/Object614"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object550"}}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/r/{id}/shares":{"get":{"summary":"List users and groups permissioned on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object9"}}}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/r/{id}/shares/users":{"put":{"summary":"Set the permissions users have on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"Object615","in":"body","schema":{"$ref":"#/definitions/Object615"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object9"}}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/r/{id}/shares/users/{user_id}":{"delete":{"summary":"Revoke the permissions a user has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"user_id","in":"path","required":true,"description":"The ID of the user.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/r/{id}/shares/groups":{"put":{"summary":"Set the permissions groups has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"Object616","in":"body","schema":{"$ref":"#/definitions/Object616"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object9"}}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/r/{id}/shares/groups/{group_id}":{"delete":{"summary":"Revoke the permissions a group has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"group_id","in":"path","required":true,"description":"The ID of the group.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/r/{id}/dependencies":{"get":{"summary":"List dependent objects for this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"user_id","in":"query","required":false,"description":"ID of target user","type":"integer"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object15"}}}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/r/{id}/transfer":{"put":{"summary":"Transfer ownership of this object to another user","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"Object617","in":"body","schema":{"$ref":"#/definitions/Object617"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object17"}}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/r/{id}/projects":{"get":{"summary":"List the projects an R Script belongs to","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the R Script.","type":"integer"},{"name":"hidden","in":"query","required":false,"description":"If specified to be true, returns hidden items. Defaults to false, returning non-hidden items.","type":"boolean"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object85"}}}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/r/{id}/projects/{project_id}":{"put":{"summary":"Add an R Script to a project","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the R Script.","type":"integer"},{"name":"project_id","in":"path","required":true,"description":"The ID of the project.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null},"delete":{"summary":"Remove an R Script from a project","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the R Script.","type":"integer"},{"name":"project_id","in":"path","required":true,"description":"The ID of the project.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/r/{id}/archive":{"put":{"summary":"Update the archive status of this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the object.","type":"integer"},{"name":"Object618","in":"body","schema":{"$ref":"#/definitions/Object618"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object554"}}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/dbt/{id}/shares":{"get":{"summary":"List users and groups permissioned on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object9"}}}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/dbt/{id}/shares/users":{"put":{"summary":"Set the permissions users have on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"Object619","in":"body","schema":{"$ref":"#/definitions/Object619"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object9"}}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/dbt/{id}/shares/users/{user_id}":{"delete":{"summary":"Revoke the permissions a user has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"user_id","in":"path","required":true,"description":"The ID of the user.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/dbt/{id}/shares/groups":{"put":{"summary":"Set the permissions groups has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"Object620","in":"body","schema":{"$ref":"#/definitions/Object620"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object9"}}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/dbt/{id}/shares/groups/{group_id}":{"delete":{"summary":"Revoke the permissions a group has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"group_id","in":"path","required":true,"description":"The ID of the group.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/dbt/{id}/dependencies":{"get":{"summary":"List dependent objects for this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"user_id","in":"query","required":false,"description":"ID of target user","type":"integer"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object15"}}}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/dbt/{id}/transfer":{"put":{"summary":"Transfer ownership of this object to another user","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"Object621","in":"body","schema":{"$ref":"#/definitions/Object621"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object17"}}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/dbt/{id}/projects":{"get":{"summary":"List the projects a dbt Script belongs to","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the dbt Script.","type":"integer"},{"name":"hidden","in":"query","required":false,"description":"If specified to be true, returns hidden items. Defaults to false, returning non-hidden items.","type":"boolean"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object85"}}}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/dbt/{id}/projects/{project_id}":{"put":{"summary":"Add a dbt Script to a project","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the dbt Script.","type":"integer"},{"name":"project_id","in":"path","required":true,"description":"The ID of the project.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null},"delete":{"summary":"Remove a dbt Script from a project","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the dbt Script.","type":"integer"},{"name":"project_id","in":"path","required":true,"description":"The ID of the project.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/dbt/{id}/archive":{"put":{"summary":"Update the archive status of this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the object.","type":"integer"},{"name":"Object622","in":"body","schema":{"$ref":"#/definitions/Object622"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object560"}}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/javascript/{id}/shares":{"get":{"summary":"List users and groups permissioned on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object9"}}}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/javascript/{id}/shares/users":{"put":{"summary":"Set the permissions users have on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"Object623","in":"body","schema":{"$ref":"#/definitions/Object623"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object9"}}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/javascript/{id}/shares/users/{user_id}":{"delete":{"summary":"Revoke the permissions a user has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"user_id","in":"path","required":true,"description":"The ID of the user.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/javascript/{id}/shares/groups":{"put":{"summary":"Set the permissions groups has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"Object624","in":"body","schema":{"$ref":"#/definitions/Object624"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object9"}}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/javascript/{id}/shares/groups/{group_id}":{"delete":{"summary":"Revoke the permissions a group has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"group_id","in":"path","required":true,"description":"The ID of the group.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/javascript/{id}/dependencies":{"get":{"summary":"List dependent objects for this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"user_id","in":"query","required":false,"description":"ID of target user","type":"integer"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object15"}}}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/javascript/{id}/transfer":{"put":{"summary":"Transfer ownership of this object to another user","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"Object625","in":"body","schema":{"$ref":"#/definitions/Object625"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object17"}}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/javascript/{id}/projects":{"get":{"summary":"List the projects a JavaScript Script belongs to","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the JavaScript Script.","type":"integer"},{"name":"hidden","in":"query","required":false,"description":"If specified to be true, returns hidden items. Defaults to false, returning non-hidden items.","type":"boolean"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object85"}}}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/javascript/{id}/projects/{project_id}":{"put":{"summary":"Add a JavaScript Script to a project","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the JavaScript Script.","type":"integer"},{"name":"project_id","in":"path","required":true,"description":"The ID of the project.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null},"delete":{"summary":"Remove a JavaScript Script from a project","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the JavaScript Script.","type":"integer"},{"name":"project_id","in":"path","required":true,"description":"The ID of the project.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/javascript/{id}/archive":{"put":{"summary":"Update the archive status of this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the object.","type":"integer"},{"name":"Object626","in":"body","schema":{"$ref":"#/definitions/Object626"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object567"}}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/custom/{id}/shares":{"get":{"summary":"List users and groups permissioned on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object9"}}}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/custom/{id}/shares/users":{"put":{"summary":"Set the permissions users have on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"Object627","in":"body","schema":{"$ref":"#/definitions/Object627"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object9"}}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/custom/{id}/shares/users/{user_id}":{"delete":{"summary":"Revoke the permissions a user has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"user_id","in":"path","required":true,"description":"The ID of the user.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/custom/{id}/shares/groups":{"put":{"summary":"Set the permissions groups has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"Object628","in":"body","schema":{"$ref":"#/definitions/Object628"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object9"}}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/custom/{id}/shares/groups/{group_id}":{"delete":{"summary":"Revoke the permissions a group has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"group_id","in":"path","required":true,"description":"The ID of the group.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/custom/{id}/dependencies":{"get":{"summary":"List dependent objects for this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"user_id","in":"query","required":false,"description":"ID of target user","type":"integer"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object15"}}}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/custom/{id}/transfer":{"put":{"summary":"Transfer ownership of this object to another user","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"Object629","in":"body","schema":{"$ref":"#/definitions/Object629"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object17"}}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/custom/{id}/projects":{"get":{"summary":"List the projects a Custom Script belongs to","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Custom Script.","type":"integer"},{"name":"hidden","in":"query","required":false,"description":"If specified to be true, returns hidden items. Defaults to false, returning non-hidden items.","type":"boolean"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object85"}}}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/custom/{id}/projects/{project_id}":{"put":{"summary":"Add a Custom Script to a project","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Custom Script.","type":"integer"},{"name":"project_id","in":"path","required":true,"description":"The ID of the project.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null},"delete":{"summary":"Remove a Custom Script from a project","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Custom Script.","type":"integer"},{"name":"project_id","in":"path","required":true,"description":"The ID of the project.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/custom/{id}/archive":{"put":{"summary":"Update the archive status of this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the object.","type":"integer"},{"name":"Object630","in":"body","schema":{"$ref":"#/definitions/Object630"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object573"}}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/sql/{id}/clone":{"post":{"summary":"Clone this SQL Script","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID for the script.","type":"integer"},{"name":"Object631","in":"body","schema":{"$ref":"#/definitions/Object631"},"required":false}],"responses":{"201":{"description":"success","schema":{"$ref":"#/definitions/Object545"}}},"x-examples":[{"resource":"Scripts","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/scripts/sql/:id/clone","description":"Clone a sql script","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/scripts/sql/2515/clone","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer yGn-uk325qI1cj6FWIVBUwNET2w6a-TEbl4k4vuPhF8","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":201,"response_status_text":"Created","response_body":"{\n \"id\": 2518,\n \"name\": \"Clone of Script 2515 Script #2515\",\n \"type\": \"SQL\",\n \"createdAt\": \"2024-12-03T19:46:13.000Z\",\n \"updatedAt\": \"2024-12-03T19:46:13.000Z\",\n \"author\": {\n \"id\": 2576,\n \"name\": \"User devuserfactory2090 2090\",\n \"username\": \"devuserfactory2090\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"state\": \"idle\",\n \"finishedAt\": null,\n \"category\": \"script\",\n \"projects\": [\n\n ],\n \"parentId\": null,\n \"userContext\": \"runner\",\n \"params\": [\n {\n \"name\": \"id\",\n \"label\": \"ID\",\n \"description\": null,\n \"type\": \"integer\",\n \"required\": true,\n \"value\": null,\n \"default\": null,\n \"allowedValues\": [\n\n ]\n },\n {\n \"name\": \"state\",\n \"label\": \"State\",\n \"description\": null,\n \"type\": \"string\",\n \"required\": true,\n \"value\": null,\n \"default\": null,\n \"allowedValues\": [\n\n ]\n },\n {\n \"name\": \"table\",\n \"label\": \"Table\",\n \"description\": null,\n \"type\": \"string\",\n \"required\": false,\n \"value\": null,\n \"default\": null,\n \"allowedValues\": [\n\n ]\n },\n {\n \"name\": \"abool\",\n \"label\": \"A Bool\",\n \"description\": null,\n \"type\": \"bool\",\n \"required\": false,\n \"value\": null,\n \"default\": false,\n \"allowedValues\": [\n\n ]\n },\n {\n \"name\": \"afloat\",\n \"label\": \"A Float\",\n \"description\": null,\n \"type\": \"float\",\n \"required\": false,\n \"value\": null,\n \"default\": null,\n \"allowedValues\": [\n\n ]\n },\n {\n \"name\": \"optionalstr\",\n \"label\": \"Optional String\",\n \"description\": null,\n \"type\": \"string\",\n \"required\": false,\n \"value\": null,\n \"default\": null,\n \"allowedValues\": [\n\n ]\n },\n {\n \"name\": \"cred\",\n \"label\": \"Cred\",\n \"description\": null,\n \"type\": \"credential_redshift\",\n \"required\": false,\n \"value\": null,\n \"default\": null,\n \"allowedValues\": [\n\n ]\n },\n {\n \"name\": \"cred2\",\n \"label\": \"Cred AWS\",\n \"description\": null,\n \"type\": \"credential_aws\",\n \"required\": false,\n \"value\": null,\n \"default\": null,\n \"allowedValues\": [\n\n ]\n }\n ],\n \"arguments\": {\n \"id\": 2,\n \"state\": \"IL\",\n \"table\": \"test.test\"\n },\n \"isTemplate\": false,\n \"publishedAsTemplateId\": null,\n \"fromTemplateId\": null,\n \"templateDependentsCount\": null,\n \"templateScriptName\": null,\n \"links\": {\n \"details\": \"api.civis.test/scripts/sql/2518\",\n \"runs\": \"api.civis.test/scripts/sql/2518/runs\"\n },\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n },\n \"notifications\": {\n \"urls\": [\n\n ],\n \"successEmailSubject\": null,\n \"successEmailBody\": null,\n \"successEmailAddresses\": [\n \"script_spec_user@civisanalytics.com\"\n ],\n \"successEmailFromName\": null,\n \"successEmailReplyTo\": null,\n \"failureEmailAddresses\": [\n \"script_spec_user@civisanalytics.com\"\n ],\n \"stallWarningMinutes\": null,\n \"successOn\": true,\n \"failureOn\": true\n },\n \"runningAs\": {\n \"id\": 2576,\n \"name\": \"User devuserfactory2090 2090\",\n \"username\": \"devuserfactory2090\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"nextRunAt\": null,\n \"timeZone\": \"America/Chicago\",\n \"lastRun\": null,\n \"myPermissionLevel\": \"manage\",\n \"hidden\": false,\n \"targetProjectId\": null,\n \"archived\": false,\n \"sql\": \"SELECT * FROM table LIMIT 10;\",\n \"expandedArguments\": {\n \"id\": 2,\n \"state\": \"IL\",\n \"state.literal\": \"'IL'\",\n \"state.identifier\": \"\\\"IL\\\"\",\n \"state.shell_escaped\": \"IL\",\n \"table\": \"test.test\",\n \"table.literal\": \"'test.test'\",\n \"table.identifier\": \"\\\"test.test\\\"\",\n \"table.shell_escaped\": \"test.test\",\n \"abool\": false,\n \"afloat\": 0,\n \"optionalstr\": \"\",\n \"optionalstr.literal\": \"''\",\n \"optionalstr.identifier\": \"\\\"\\\"\",\n \"optionalstr.shell_escaped\": \"''\",\n \"cred.id\": \"\",\n \"cred.username\": \"\",\n \"cred.password\": \"\",\n \"cred2.id\": \"\",\n \"cred2.access_key_id\": \"\",\n \"cred2.secret_access_key\": \"\"\n },\n \"remoteHostId\": 324,\n \"credentialId\": 900,\n \"codePreview\": \"SELECT * FROM table LIMIT 10;\",\n \"csvSettings\": {\n \"includeHeader\": true,\n \"compression\": \"gzip\",\n \"columnDelimiter\": \"comma\",\n \"unquoted\": false,\n \"forceMultifile\": false,\n \"filenamePrefix\": null,\n \"maxFileSize\": null\n },\n \"runningAsId\": 2576\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"843ac9897b58f493926f79924ce34642\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"17b140d6-94ce-43ad-93f0-579747f3dfc7","X-Runtime":"0.161162","Content-Length":"3288"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/scripts/sql/2515/clone\" -d '' -X POST \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer yGn-uk325qI1cj6FWIVBUwNET2w6a-TEbl4k4vuPhF8\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/scripts/javascript/{id}/clone":{"post":{"summary":"Clone this JavaScript Script","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID for the script.","type":"integer"},{"name":"Object631","in":"body","schema":{"$ref":"#/definitions/Object631"},"required":false}],"responses":{"201":{"description":"success","schema":{"$ref":"#/definitions/Object567"}}},"x-examples":[{"resource":"Scripts","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/scripts/javascript/:id/clone","description":"Clone a javascript script","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/scripts/javascript/2526/clone","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer oJOsn73xDYMsRGoiI7E-DbMnYnYR6y0Mmc27cdqrcpo","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":201,"response_status_text":"Created","response_body":"{\n \"id\": 2527,\n \"name\": \"Clone of Script 2526 Script #2526\",\n \"type\": \"JavaScript\",\n \"createdAt\": \"2024-12-03T19:46:15.000Z\",\n \"updatedAt\": \"2024-12-03T19:46:15.000Z\",\n \"author\": {\n \"id\": 2583,\n \"name\": \"User devuserfactory2096 2096\",\n \"username\": \"devuserfactory2096\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"state\": \"idle\",\n \"finishedAt\": null,\n \"category\": \"script\",\n \"projects\": [\n\n ],\n \"parentId\": null,\n \"userContext\": \"runner\",\n \"params\": [\n\n ],\n \"arguments\": {\n },\n \"isTemplate\": false,\n \"publishedAsTemplateId\": null,\n \"fromTemplateId\": null,\n \"templateDependentsCount\": null,\n \"templateScriptName\": null,\n \"links\": {\n \"details\": \"api.civis.test/scripts/javascript/2527\",\n \"runs\": \"api.civis.test/scripts/javascript/2527/runs\"\n },\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n },\n \"notifications\": {\n \"urls\": [\n\n ],\n \"successEmailSubject\": null,\n \"successEmailBody\": null,\n \"successEmailAddresses\": [\n \"script_spec_user@civisanalytics.com\"\n ],\n \"successEmailFromName\": null,\n \"successEmailReplyTo\": null,\n \"failureEmailAddresses\": [\n \"script_spec_user@civisanalytics.com\"\n ],\n \"stallWarningMinutes\": null,\n \"successOn\": true,\n \"failureOn\": true\n },\n \"runningAs\": {\n \"id\": 2583,\n \"name\": \"User devuserfactory2096 2096\",\n \"username\": \"devuserfactory2096\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"nextRunAt\": null,\n \"timeZone\": \"America/Chicago\",\n \"lastRun\": null,\n \"myPermissionLevel\": \"manage\",\n \"hidden\": false,\n \"targetProjectId\": null,\n \"archived\": false,\n \"source\": \"log('hello world')\",\n \"remoteHostId\": 329,\n \"credentialId\": 909,\n \"runningAsId\": 2583\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"36852e8bdd376b698a061d757eeac4bb\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"d2ab88c7-ea3d-4bd4-92f5-d26becc3d666","X-Runtime":"0.112563","Content-Length":"1471"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/scripts/javascript/2526/clone\" -d '' -X POST \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer oJOsn73xDYMsRGoiI7E-DbMnYnYR6y0Mmc27cdqrcpo\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/scripts/python3/{id}/clone":{"post":{"summary":"Clone this Python Script","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID for the script.","type":"integer"},{"name":"Object631","in":"body","schema":{"$ref":"#/definitions/Object631"},"required":false}],"responses":{"201":{"description":"success","schema":{"$ref":"#/definitions/Object550"}}},"x-examples":[{"resource":"Scripts","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/scripts/python3/:id/clone","description":"Clone a python script","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/scripts/python3/2536/clone","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer 6Se5Pta4H5eokN84P2-Vx080TmxG1nja8Jt0Jm0w3Cw","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":201,"response_status_text":"Created","response_body":"{\n \"id\": 2537,\n \"name\": \"Clone of Script 2536 Script #2536\",\n \"type\": \"Python\",\n \"createdAt\": \"2024-12-03T19:46:16.000Z\",\n \"updatedAt\": \"2024-12-03T19:46:16.000Z\",\n \"author\": {\n \"id\": 2591,\n \"name\": \"User devuserfactory2103 2103\",\n \"username\": \"devuserfactory2103\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"state\": \"idle\",\n \"finishedAt\": null,\n \"category\": \"script\",\n \"projects\": [\n\n ],\n \"parentId\": null,\n \"userContext\": \"runner\",\n \"params\": [\n\n ],\n \"arguments\": {\n },\n \"isTemplate\": false,\n \"publishedAsTemplateId\": null,\n \"fromTemplateId\": null,\n \"templateDependentsCount\": null,\n \"templateScriptName\": null,\n \"links\": {\n \"details\": \"api.civis.test/scripts/python3/2537\",\n \"runs\": \"api.civis.test/scripts/python3/2537/runs\"\n },\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n },\n \"notifications\": {\n \"urls\": [\n\n ],\n \"successEmailSubject\": null,\n \"successEmailBody\": null,\n \"successEmailAddresses\": [\n \"script_spec_user@civisanalytics.com\"\n ],\n \"successEmailFromName\": null,\n \"successEmailReplyTo\": null,\n \"failureEmailAddresses\": [\n \"script_spec_user@civisanalytics.com\"\n ],\n \"stallWarningMinutes\": null,\n \"successOn\": true,\n \"failureOn\": true\n },\n \"runningAs\": {\n \"id\": 2591,\n \"name\": \"User devuserfactory2103 2103\",\n \"username\": \"devuserfactory2103\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"nextRunAt\": null,\n \"timeZone\": \"America/Chicago\",\n \"lastRun\": null,\n \"myPermissionLevel\": \"manage\",\n \"hidden\": false,\n \"targetProjectId\": null,\n \"archived\": false,\n \"requiredResources\": {\n \"cpu\": null,\n \"memory\": null,\n \"diskSpace\": 1.0\n },\n \"instanceType\": null,\n \"cancelTimeout\": 0,\n \"dockerImageTag\": \"mock_latest_tag\",\n \"partitionLabel\": null,\n \"runningAsId\": 2591,\n \"source\": \"print 'Hello World'\"\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"054f4171861385f317448fce3fa36bbc\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"cf7f8d17-be3c-4201-af95-f2d3dc586198","X-Runtime":"0.117039","Content-Length":"1582"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/scripts/python3/2536/clone\" -d '' -X POST \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer 6Se5Pta4H5eokN84P2-Vx080TmxG1nja8Jt0Jm0w3Cw\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/scripts/r/{id}/clone":{"post":{"summary":"Clone this R Script","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID for the script.","type":"integer"},{"name":"Object631","in":"body","schema":{"$ref":"#/definitions/Object631"},"required":false}],"responses":{"201":{"description":"success","schema":{"$ref":"#/definitions/Object554"}}},"x-examples":[{"resource":"Scripts","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/scripts/r/:id/clone","description":"Clone an R script","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/scripts/r/2546/clone","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer OmCXfzuHY8lO9nRACTaAE3PQBw6IsKcjooSI4HPguRo","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":201,"response_status_text":"Created","response_body":"{\n \"id\": 2547,\n \"name\": \"Clone of Script 2546 Script #2546\",\n \"type\": \"R\",\n \"createdAt\": \"2024-12-03T19:46:17.000Z\",\n \"updatedAt\": \"2024-12-03T19:46:17.000Z\",\n \"author\": {\n \"id\": 2600,\n \"name\": \"User devuserfactory2111 2111\",\n \"username\": \"devuserfactory2111\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"state\": \"idle\",\n \"finishedAt\": null,\n \"category\": \"script\",\n \"projects\": [\n\n ],\n \"parentId\": null,\n \"userContext\": \"runner\",\n \"params\": [\n\n ],\n \"arguments\": {\n },\n \"isTemplate\": false,\n \"publishedAsTemplateId\": null,\n \"fromTemplateId\": null,\n \"templateDependentsCount\": null,\n \"templateScriptName\": null,\n \"links\": {\n \"details\": \"api.civis.test/scripts/r/2547\",\n \"runs\": \"api.civis.test/scripts/r/2547/runs\"\n },\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n },\n \"notifications\": {\n \"urls\": [\n\n ],\n \"successEmailSubject\": null,\n \"successEmailBody\": null,\n \"successEmailAddresses\": [\n \"script_spec_user@civisanalytics.com\"\n ],\n \"successEmailFromName\": null,\n \"successEmailReplyTo\": null,\n \"failureEmailAddresses\": [\n \"script_spec_user@civisanalytics.com\"\n ],\n \"stallWarningMinutes\": null,\n \"successOn\": true,\n \"failureOn\": true\n },\n \"runningAs\": {\n \"id\": 2600,\n \"name\": \"User devuserfactory2111 2111\",\n \"username\": \"devuserfactory2111\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"nextRunAt\": null,\n \"timeZone\": \"America/Chicago\",\n \"lastRun\": null,\n \"myPermissionLevel\": \"manage\",\n \"hidden\": false,\n \"targetProjectId\": null,\n \"archived\": false,\n \"requiredResources\": {\n \"cpu\": null,\n \"memory\": null,\n \"diskSpace\": 1.0\n },\n \"instanceType\": null,\n \"cancelTimeout\": 0,\n \"dockerImageTag\": \"mock_latest_tag\",\n \"partitionLabel\": null,\n \"runningAsId\": 2600,\n \"source\": \"cat('Hello World')\"\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"8a70eb854a497b3a95e71a6989724bc3\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"f9f6f4aa-023c-409a-911c-433b747ea9b4","X-Runtime":"0.103020","Content-Length":"1564"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/scripts/r/2546/clone\" -d '' -X POST \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer OmCXfzuHY8lO9nRACTaAE3PQBw6IsKcjooSI4HPguRo\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/scripts/containers/{id}/clone":{"post":{"summary":"Clone this Container Script","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID for the script.","type":"integer"},{"name":"Object631","in":"body","schema":{"$ref":"#/definitions/Object631"},"required":false}],"responses":{"201":{"description":"success","schema":{"$ref":"#/definitions/Object532"}}},"x-examples":[{"resource":"Scripts","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/scripts/containers/:id/clone","description":"Clone a container script","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/scripts/containers/2556/clone","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer 9VWfqjAJ1m_yb9YpouszWnjEv0HJ8zTSYQAr0pMavA4","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":201,"response_status_text":"Created","response_body":"{\n \"id\": 2557,\n \"fromTemplateAliases\": [\n\n ],\n \"name\": \"Clone of Script 2556 Script #2556\",\n \"type\": \"Container\",\n \"createdAt\": \"2024-12-03T19:46:18.000Z\",\n \"updatedAt\": \"2024-12-03T19:46:18.000Z\",\n \"author\": {\n \"id\": 2609,\n \"name\": \"User devuserfactory2119 2119\",\n \"username\": \"devuserfactory2119\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"state\": \"idle\",\n \"finishedAt\": null,\n \"category\": \"script\",\n \"projects\": [\n\n ],\n \"parentId\": null,\n \"userContext\": \"runner\",\n \"params\": [\n\n ],\n \"arguments\": {\n },\n \"isTemplate\": false,\n \"templateDependentsCount\": null,\n \"publishedAsTemplateId\": null,\n \"fromTemplateId\": null,\n \"templateScriptName\": null,\n \"links\": {\n \"details\": \"api.civis.test/scripts/containers/2557\",\n \"runs\": \"api.civis.test/scripts/containers/2557/runs\"\n },\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n },\n \"notifications\": {\n \"urls\": [\n\n ],\n \"successEmailSubject\": null,\n \"successEmailBody\": null,\n \"successEmailAddresses\": [\n \"script_spec_user@civisanalytics.com\"\n ],\n \"successEmailFromName\": null,\n \"successEmailReplyTo\": null,\n \"failureEmailAddresses\": [\n \"script_spec_user@civisanalytics.com\"\n ],\n \"stallWarningMinutes\": null,\n \"successOn\": true,\n \"failureOn\": true\n },\n \"runningAs\": {\n \"id\": 2609,\n \"name\": \"User devuserfactory2119 2119\",\n \"username\": \"devuserfactory2119\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"requiredResources\": {\n \"cpu\": null,\n \"memory\": null,\n \"diskSpace\": 1.0\n },\n \"repoHttpUri\": \"git_repo_url\",\n \"repoRef\": \"git_repo_ref\",\n \"remoteHostCredentialId\": null,\n \"gitCredentialId\": null,\n \"dockerCommand\": \"command\",\n \"dockerImageName\": \"docker_image_name\",\n \"dockerImageTag\": \"mock_latest_tag\",\n \"instanceType\": null,\n \"cancelTimeout\": 0,\n \"lastRun\": null,\n \"timeZone\": \"America/Chicago\",\n \"partitionLabel\": null,\n \"myPermissionLevel\": \"manage\",\n \"hidden\": false,\n \"archived\": false,\n \"targetProjectId\": null,\n \"runningAsId\": 2609\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"d98266b7dc11d0192e857ee7644ec045\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"eb245cb0-08dd-4c90-b9f9-354aa1616c9f","X-Runtime":"0.099041","Content-Length":"1739"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/scripts/containers/2556/clone\" -d '' -X POST \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer 9VWfqjAJ1m_yb9YpouszWnjEv0HJ8zTSYQAr0pMavA4\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/scripts/dbt/{id}/clone":{"post":{"summary":"Clone this dbt Script","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID for the script.","type":"integer"},{"name":"Object631","in":"body","schema":{"$ref":"#/definitions/Object631"},"required":false}],"responses":{"201":{"description":"success","schema":{"$ref":"#/definitions/Object560"}}},"x-examples":null,"x-deprecation-warning":null}},"/scripts/custom/{id}/clone":{"post":{"summary":"Clone this Custom Script","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID for the script.","type":"integer"},{"name":"Object631","in":"body","schema":{"$ref":"#/definitions/Object631"},"required":false}],"responses":{"201":{"description":"success","schema":{"$ref":"#/definitions/Object573"}}},"x-examples":[{"resource":"Scripts","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/scripts/custom/:id/clone","description":"Clone a custom script","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/scripts/custom/2571/clone","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer eqd4UAgEWUqo9hQbNhfSjVELrUR3u4Lp2vG3cAVBfBw","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":201,"response_status_text":"Created","response_body":"{\n \"id\": 2572,\n \"fromTemplateAliases\": [\n\n ],\n \"name\": \"Clone of Script 2571 awesome sql template #2571\",\n \"type\": \"Custom\",\n \"backingScriptType\": \"SQL\",\n \"createdAt\": \"2024-12-03T19:46:19.000Z\",\n \"updatedAt\": \"2024-12-03T19:46:19.000Z\",\n \"author\": {\n \"id\": 2618,\n \"name\": \"User devuserfactory2127 2127\",\n \"username\": \"devuserfactory2127\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"state\": \"idle\",\n \"finishedAt\": null,\n \"category\": \"script\",\n \"projects\": [\n\n ],\n \"parentId\": null,\n \"params\": [\n {\n \"name\": \"id\",\n \"label\": \"ID\",\n \"description\": null,\n \"type\": \"integer\",\n \"required\": true,\n \"value\": null,\n \"default\": null,\n \"allowedValues\": [\n\n ]\n },\n {\n \"name\": \"state\",\n \"label\": \"State\",\n \"description\": null,\n \"type\": \"string\",\n \"required\": true,\n \"value\": null,\n \"default\": null,\n \"allowedValues\": [\n\n ]\n },\n {\n \"name\": \"table\",\n \"label\": \"Table\",\n \"description\": null,\n \"type\": \"string\",\n \"required\": false,\n \"value\": null,\n \"default\": null,\n \"allowedValues\": [\n\n ]\n }\n ],\n \"arguments\": {\n \"id\": 2,\n \"state\": \"IL\",\n \"table\": \"test.test\"\n },\n \"isTemplate\": false,\n \"publishedAsTemplateId\": null,\n \"fromTemplateId\": 171,\n \"uiReportUrl\": null,\n \"uiReportId\": null,\n \"uiReportProvideAPIKey\": null,\n \"templateScriptName\": \"Script #2568\",\n \"templateNote\": null,\n \"remoteHostId\": 342,\n \"credentialId\": 947,\n \"codePreview\": \"select * from test.test where id = 2 and state = 'IL'\",\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n },\n \"notifications\": {\n \"urls\": [\n\n ],\n \"successEmailSubject\": null,\n \"successEmailBody\": null,\n \"successEmailAddresses\": [\n \"script_spec_user@civisanalytics.com\"\n ],\n \"successEmailFromName\": null,\n \"successEmailReplyTo\": null,\n \"failureEmailAddresses\": [\n \"script_spec_user@civisanalytics.com\"\n ],\n \"stallWarningMinutes\": null,\n \"successOn\": true,\n \"failureOn\": true\n },\n \"runningAs\": {\n \"id\": 2618,\n \"name\": \"User devuserfactory2127 2127\",\n \"username\": \"devuserfactory2127\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"timeZone\": \"America/Chicago\",\n \"lastRun\": null,\n \"myPermissionLevel\": \"manage\",\n \"hidden\": false,\n \"archived\": false,\n \"targetProjectId\": null,\n \"lastSuccessfulRun\": null,\n \"requiredResources\": null,\n \"partitionLabel\": null,\n \"runningAsId\": 2618\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"b1a73ce5dbb7d796ef9a5ae7ae057299\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"2d31ef98-c410-486f-b030-fc13048c32f7","X-Runtime":"0.154233","Content-Length":"1981"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/scripts/custom/2571/clone\" -d '' -X POST \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer eqd4UAgEWUqo9hQbNhfSjVELrUR3u4Lp2vG3cAVBfBw\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/search/":{"get":{"summary":"Perform a search","description":null,"deprecated":false,"parameters":[{"name":"query","in":"query","required":false,"description":"The search query.","type":"string"},{"name":"type","in":"query","required":false,"description":"The type for the search. It accepts a comma-separated list. Valid arguments are listed on the \"GET /search/types\" endpoint.","type":"string"},{"name":"offset","in":"query","required":false,"description":"The offset for the search results.","type":"integer"},{"name":"order","in":"query","required":false,"description":"The field on which to order the result set.","type":"string"},{"name":"owner","in":"query","required":false,"description":"The owner for the search.","type":"string"},{"name":"limit","in":"query","required":false,"description":"Defaults to 10. Maximum allowed is 1000.","type":"integer"},{"name":"archived","in":"query","required":false,"description":"If specified, return only results with the chosen archived status; either 'true', 'false', or 'all'. Defaults to 'false'.","type":"string"},{"name":"last_run_state","in":"query","required":false,"description":"The last run state of the job being searched for; either: 'queued', 'running', 'succeeded', 'failed', or 'cancelled'.","type":"string"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object632"}}}},"x-examples":[{"resource":"Search","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/search?query=import","description":"Lists matching objects","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/search?query=import","request_body":null,"request_headers":{"Content-Type":"application/json","Authorization":"Bearer I2Hadh1gSKV7aBO4DaizFxOrWnJA9GDl4dLFvd3Hy_k","Host":"api.civis.test","Cookie":""},"request_query_parameters":{"query":"import"},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"totalResults\": 3,\n \"aggregations\": {\n \"owner\": {\n \"mine\": 3,\n \"all\": 3\n },\n \"archived\": {\n \"true\": 0,\n \"false\": 3\n },\n \"type\": {\n \"python_script\": 1,\n \"sql_script\": 2\n }\n },\n \"results\": [\n {\n \"score\": 0.36407673,\n \"type\": \"python_script\",\n \"id\": \"3239\",\n \"name\": \"Run Import\",\n \"typeName\": \"Python Script\",\n \"updatedAt\": \"2023-07-18T18:46:13.000Z\",\n \"owner\": \"User devuserfactory3025 3023\",\n \"useCount\": null,\n \"lastRunId\": null,\n \"lastRunState\": null,\n \"lastRunStart\": null,\n \"lastRunFinish\": null,\n \"public\": false,\n \"lastRunException\": null,\n \"autoShare\": null\n },\n {\n \"score\": 0.211529091,\n \"type\": \"sql_script\",\n \"id\": \"3241\",\n \"name\": \"Important Successful Script\",\n \"typeName\": \"SQL Runner\",\n \"updatedAt\": \"2023-07-18T18:46:13.000Z\",\n \"owner\": \"User devuserfactory3025 3023\",\n \"useCount\": null,\n \"lastRunId\": 448,\n \"lastRunState\": \"succeeded\",\n \"lastRunStart\": null,\n \"lastRunFinish\": null,\n \"public\": false,\n \"lastRunException\": null,\n \"autoShare\": null\n },\n {\n \"score\": 0.234571346,\n \"type\": \"sql_script\",\n \"id\": \"3243\",\n \"name\": \"Important Failed Script\",\n \"typeName\": \"SQL Runner\",\n \"updatedAt\": \"2023-07-18T18:46:13.000Z\",\n \"owner\": \"User devuserfactory3025 3023\",\n \"useCount\": null,\n \"lastRunId\": 449,\n \"lastRunState\": \"failed\",\n \"lastRunStart\": null,\n \"lastRunFinish\": null,\n \"public\": false,\n \"lastRunException\": \"Job::UserError: Error!\",\n \"autoShare\": null\n }\n ]\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"2f1536d38190e35439f25f22d5f1239b\"","X-Request-Id":"2f530326-bbda-448c-ac83-17f80c9e0a02","X-Runtime":"0.015210","Content-Length":"1190"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/search?query=import\" -X GET \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer I2Hadh1gSKV7aBO4DaizFxOrWnJA9GDl4dLFvd3Hy_k\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/search/types":{"get":{"summary":"List available search types","description":null,"deprecated":false,"parameters":[],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object634"}}}},"x-examples":[{"resource":"Search","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/search/types","description":"Lists search types","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/search/types","request_body":null,"request_headers":{"Content-Type":"application/json","Authorization":"Bearer wBVV5B6Uv9RlAN65GaVqCWU76LnoY09heEhW_K_uE_M","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"type\": \"column\"\n },\n {\n \"type\": \"csv_import\"\n },\n {\n \"type\": \"database_import\"\n },\n {\n \"type\": \"database_export\"\n },\n {\n \"type\": \"gdoc_import\"\n },\n {\n \"type\": \"salesforce_import\"\n },\n {\n \"type\": \"custom_import\"\n },\n {\n \"type\": \"template_import\"\n },\n {\n \"type\": \"gdoc_export\"\n },\n {\n \"type\": \"template_export\"\n },\n {\n \"type\": \"custom_export\"\n },\n {\n \"type\": \"custom_enhancement\"\n },\n {\n \"type\": \"template_enhancement\"\n },\n {\n \"type\": \"table\"\n },\n {\n \"type\": \"job\"\n },\n {\n \"type\": \"remote_host\"\n },\n {\n \"type\": \"cass_ncoa\"\n },\n {\n \"type\": \"container_script\"\n },\n {\n \"type\": \"geocode\"\n },\n {\n \"type\": \"python_script\"\n },\n {\n \"type\": \"r_script\"\n },\n {\n \"type\": \"javascript_script\"\n },\n {\n \"type\": \"sql_script\"\n },\n {\n \"type\": \"project\"\n },\n {\n \"type\": \"notebook\"\n },\n {\n \"type\": \"workflow\"\n },\n {\n \"type\": \"template_script\"\n },\n {\n \"type\": \"template_report\"\n },\n {\n \"type\": \"service\"\n },\n {\n \"type\": \"report\"\n },\n {\n \"type\": \"tableau\"\n },\n {\n \"type\": \"service_report\"\n },\n {\n \"type\": \"salesforce_export\"\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"5029da1ed6f5e83acd4e4b351aaca78c\"","X-Request-Id":"e07ae174-d0f6-4da7-aa8d-55be0ace74a8","X-Runtime":"0.008567","Content-Length":"779"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/search/types\" -X GET \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer wBVV5B6Uv9RlAN65GaVqCWU76LnoY09heEhW_K_uE_M\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/search/queries":{"get":{"summary":"Search queries that are not hidden","description":null,"deprecated":false,"parameters":[{"name":"search_string","in":"query","required":false,"description":"Space delimited search terms for searching queries by their SQL. Supports wild card characters \"?\" for any single character, and \"*\" for zero or more characters.","type":"string"},{"name":"database_id","in":"query","required":false,"description":"The database ID.","type":"integer"},{"name":"credential_id","in":"query","required":false,"description":"The credential ID.","type":"integer"},{"name":"author_id","in":"query","required":false,"description":"The author of the query.","type":"integer"},{"name":"archived","in":"query","required":false,"description":"The archival status of the requested item(s). Defaults to false.","type":"boolean"},{"name":"state","in":"query","required":false,"description":"The state of the last run. One or more of queued, running, succeeded, failed, and cancelled.","type":"array","items":{"type":"string"}},{"name":"started_before","in":"query","required":false,"description":"An upper bound for the start date of the last run.","type":"string","format":"time"},{"name":"started_after","in":"query","required":false,"description":"A lower bound for the start date of the last run.","type":"string","format":"time"},{"name":"limit","in":"query","required":false,"description":"Number of results to return. Defaults to 10. Maximum allowed is 50.","type":"integer"},{"name":"page_num","in":"query","required":false,"description":"Page number of the results to return. Defaults to the first page, 1.","type":"integer"},{"name":"order","in":"query","required":false,"description":"The field on which to order the result set. Defaults to last_run_started_at. Must be one of: last_run_started_at.","type":"string"},{"name":"order_dir","in":"query","required":false,"description":"Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc.","type":"string"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object635"}}}},"x-examples":[{"resource":"Search","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/search/queries","description":"Lists queries","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/search/queries?search_string=count+foo+bar","request_body":null,"request_headers":{"Content-Type":"application/json","Authorization":"Bearer pghRRVt2bneG9h9ZvvdovahKqllDPq_Naxivkx-n91I","Host":"api.civis.test","Cookie":""},"request_query_parameters":{"search_string":"count foo bar"},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 3244,\n \"database\": 1004,\n \"credential\": 2226,\n \"sql\": \"SELECT * FROM table LIMIT 10;\",\n \"authorId\": 4477,\n \"archived\": false,\n \"createdAt\": \"2023-07-18T18:46:13.000Z\",\n \"updatedAt\": \"2023-07-18T18:46:13.000Z\",\n \"lastRun\": {\n \"id\": 450,\n \"state\": \"succeeded\",\n \"startedAt\": \"2023-07-18T18:46:13.000Z\",\n \"finishedAt\": null,\n \"error\": null\n }\n },\n {\n \"id\": 3245,\n \"database\": 1005,\n \"credential\": 2228,\n \"sql\": \"SELECT * FROM table LIMIT 10;\",\n \"authorId\": 4477,\n \"archived\": false,\n \"createdAt\": \"2023-07-18T18:46:13.000Z\",\n \"updatedAt\": \"2023-07-18T18:46:13.000Z\",\n \"lastRun\": {\n \"id\": 451,\n \"state\": \"cancelled\",\n \"startedAt\": \"2023-07-18T18:46:08.000Z\",\n \"finishedAt\": null,\n \"error\": null\n }\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","X-Pagination-Current-Page":1,"Access-Control-Expose-Headers":"X-Pagination-Current-Page, X-Pagination-Per-Page, X-Pagination-Total-Pages, X-Pagination-Total-Entries","X-Pagination-Per-Page":"10","X-Pagination-Total-Pages":"1","X-Pagination-Total-Entries":"2","Content-Type":"application/json; charset=utf-8","ETag":"W/\"e8672285e2114b8c8d404d2c5eb2b4ef\"","X-Request-Id":"f9ced4a6-f859-4e3a-9502-3b58478ca1e5","X-Runtime":"0.011693","Content-Length":"613"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/search/queries?search_string=count+foo+bar\" -X GET \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer pghRRVt2bneG9h9ZvvdovahKqllDPq_Naxivkx-n91I\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/services/":{"get":{"summary":"List Services","description":null,"deprecated":false,"parameters":[{"name":"hidden","in":"query","required":false,"description":"If specified to be true, returns hidden items. Defaults to false, returning non-hidden items.","type":"boolean"},{"name":"archived","in":"query","required":false,"description":"The archival status of the requested item(s).","type":"string"},{"name":"author","in":"query","required":false,"description":"If specified, return items from any of these authors. It accepts a comma-separated list of user IDs.","type":"string"},{"name":"status","in":"query","required":false,"description":"If specified, returns Services with one of these statuses. It accepts a comma-separated list, possible values are 'running', 'idle'.","type":"string"},{"name":"limit","in":"query","required":false,"description":"Number of results to return. Defaults to 20. Maximum allowed is 50.","type":"integer"},{"name":"page_num","in":"query","required":false,"description":"Page number of the results to return. Defaults to the first page, 1.","type":"integer"},{"name":"order","in":"query","required":false,"description":"The field on which to order the result set. Defaults to updated_at. Must be one of: updated_at, name, created_at.","type":"string"},{"name":"order_dir","in":"query","required":false,"description":"Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc.","type":"string"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object637"}}}},"x-examples":[{"resource":"Services","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/services","description":"List all services","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/services","request_body":null,"request_headers":{"Content-Type":"application/json","Authorization":"Bearer 6cbNig9hL-3Qr3ygIAJMIcc-h5JE9HugZ_LzOaVeXlI","Accept":"application/vnd.civis-platform.v1","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 16,\n \"name\": \"Service #16\",\n \"description\": null,\n \"user\": {\n \"id\": 4480,\n \"name\": \"User devuserfactory3034 3032\",\n \"username\": \"devuserfactory3034\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"type\": \"App\",\n \"createdAt\": \"2023-07-18T18:46:14.000Z\",\n \"updatedAt\": \"2023-07-18T18:46:14.000Z\",\n \"gitRepoUrl\": \"https://github.com/acme_co/my_shiny_code.git\",\n \"gitRepoRef\": null,\n \"gitPathDir\": null,\n \"currentDeployment\": null,\n \"archived\": false\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","X-Pagination-Per-Page":"20","Access-Control-Expose-Headers":"X-Pagination-Per-Page, X-Pagination-Current-Page, X-Pagination-Total-Pages, X-Pagination-Total-Entries","X-Pagination-Current-Page":"1","X-Pagination-Total-Pages":"1","X-Pagination-Total-Entries":"1","Content-Type":"application/json; charset=utf-8","ETag":"W/\"d286d08b2b52dd5bc86887245a58d811\"","X-Request-Id":"104cbd1a-7516-4182-b3b4-69ac7783ca2d","X-Runtime":"0.023683","Content-Length":"399"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/services\" -X GET \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer 6cbNig9hL-3Qr3ygIAJMIcc-h5JE9HugZ_LzOaVeXlI\" \\\n\t-H \"Accept: application/vnd.civis-platform.v1\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"post":{"summary":"Create a Service","description":null,"deprecated":false,"parameters":[{"name":"Object639","in":"body","schema":{"$ref":"#/definitions/Object639"},"required":false}],"responses":{"201":{"description":"success","schema":{"$ref":"#/definitions/Object643"}}},"x-examples":[{"resource":"Services","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/services","description":"Create a service","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/services","request_body":null,"request_headers":{"Content-Type":"application/json","Authorization":"Bearer MAw6puYPXeaL8c2bjK_kuyx2A0T_8yhPqjz7gpeKiUs","Accept":"application/vnd.civis-platform.v1","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":201,"response_status_text":"Created","response_body":"{\n \"id\": 20,\n \"name\": \"Service #20\",\n \"description\": null,\n \"user\": {\n \"id\": 4484,\n \"name\": \"User devuserfactory3038 3036\",\n \"username\": \"devuserfactory3038\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"type\": \"App\",\n \"dockerImageName\": \"civisanalytics/civis-services-shiny\",\n \"dockerImageTag\": \"mock_latest_tag\",\n \"schedule\": {\n \"runtimePlan\": \"on_demand\",\n \"recurrences\": [\n\n ]\n },\n \"timeZone\": \"America/Chicago\",\n \"replicas\": 1,\n \"maxReplicas\": null,\n \"instanceType\": null,\n \"memory\": 3000,\n \"cpu\": 800,\n \"createdAt\": \"2023-07-18T18:46:14.000Z\",\n \"updatedAt\": \"2023-07-18T18:46:14.000Z\",\n \"credentials\": [\n\n ],\n \"permissionSetId\": null,\n \"gitRepoUrl\": null,\n \"gitRepoRef\": null,\n \"gitPathDir\": null,\n \"reportId\": null,\n \"currentDeployment\": null,\n \"currentUrl\": null,\n \"environmentVariables\": {\n },\n \"notifications\": {\n \"failureEmailAddresses\": [\n \"devuserfactory30382900user@localhost.test\"\n ],\n \"failureOn\": true\n },\n \"partitionLabel\": null,\n \"myPermissionLevel\": \"manage\",\n \"archived\": false,\n \"hidden\": false\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"f55b743cda8c58d2827b2b7ddd79bcf7\"","X-Request-Id":"3029b9d6-8ef1-4299-bc10-09c8e8930734","X-Runtime":"0.088780","Content-Length":"878"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/services\" -d '' -X POST \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer MAw6puYPXeaL8c2bjK_kuyx2A0T_8yhPqjz7gpeKiUs\" \\\n\t-H \"Accept: application/vnd.civis-platform.v1\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Services","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/services","description":"Create a service with non-default values","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/services","request_body":"{\n \"name\": \"Custom Name\",\n \"memory\": 3000,\n \"cpu\": 600,\n \"dockerImageName\": \"my_image\",\n \"dockerImageTag\": \"my_tag\",\n \"gitRepoUrl\": \"https://github.com/my_repository.git\",\n \"gitRepoRef\": \"my_ref\",\n \"gitPathDir\": \"path/to/app\",\n \"type\": \"App\",\n \"credentials\": [\n 2229\n ]\n}","request_headers":{"Content-Type":"application/json","Authorization":"Bearer JTG4zPEorVpdKk4XSKUJVMha9m_79TY7ztT_Rac_l3E","Accept":"application/vnd.civis-platform.v1","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":201,"response_status_text":"Created","response_body":"{\n \"id\": 22,\n \"name\": \"Custom Name\",\n \"description\": null,\n \"user\": {\n \"id\": 4485,\n \"name\": \"User devuserfactory3039 3037\",\n \"username\": \"devuserfactory3039\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"type\": \"App\",\n \"dockerImageName\": \"my_image\",\n \"dockerImageTag\": \"my_tag\",\n \"schedule\": {\n \"runtimePlan\": \"on_demand\",\n \"recurrences\": [\n\n ]\n },\n \"timeZone\": \"America/Chicago\",\n \"replicas\": 1,\n \"maxReplicas\": null,\n \"instanceType\": null,\n \"memory\": 3000,\n \"cpu\": 600,\n \"createdAt\": \"2023-07-18T18:46:14.000Z\",\n \"updatedAt\": \"2023-07-18T18:46:14.000Z\",\n \"credentials\": [\n {\n \"id\": 2229,\n \"name\": \"api-key-28\"\n }\n ],\n \"permissionSetId\": null,\n \"gitRepoUrl\": \"https://github.com/my_repository.git\",\n \"gitRepoRef\": \"my_ref\",\n \"gitPathDir\": \"path/to/app\",\n \"reportId\": null,\n \"currentDeployment\": null,\n \"currentUrl\": null,\n \"environmentVariables\": {\n },\n \"notifications\": {\n \"failureEmailAddresses\": [\n \"devuserfactory30392901user@localhost.test\"\n ],\n \"failureOn\": true\n },\n \"partitionLabel\": null,\n \"myPermissionLevel\": \"manage\",\n \"archived\": false,\n \"hidden\": false\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"0986afc20bd9463f45b9430545e81981\"","X-Request-Id":"efe8376b-77fb-48e9-8043-c686f698f474","X-Runtime":"0.093590","Content-Length":"920"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/services\" -d '{\"name\":\"Custom Name\",\"memory\":3000,\"cpu\":600,\"dockerImageName\":\"my_image\",\"dockerImageTag\":\"my_tag\",\"gitRepoUrl\":\"https://github.com/my_repository.git\",\"gitRepoRef\":\"my_ref\",\"gitPathDir\":\"path/to/app\",\"type\":\"App\",\"credentials\":[2229]}' -X POST \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer JTG4zPEorVpdKk4XSKUJVMha9m_79TY7ztT_Rac_l3E\" \\\n\t-H \"Accept: application/vnd.civis-platform.v1\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/services/{id}":{"get":{"summary":"Get a Service","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object643"}}},"x-examples":[{"resource":"Services","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/services/:id","description":"View a service's details","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/services/17","request_body":null,"request_headers":{"Content-Type":"application/json","Authorization":"Bearer 3jvbLGCcuNkQ20Dx6ViDRI2_svDuO4-Z-d9RhpXxVCo","Accept":"application/vnd.civis-platform.v1","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 17,\n \"name\": \"Service #17\",\n \"description\": null,\n \"user\": {\n \"id\": 4481,\n \"name\": \"User devuserfactory3035 3033\",\n \"username\": \"devuserfactory3035\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"type\": \"App\",\n \"dockerImageName\": \"civisanalytics/civis-services-shiny\",\n \"dockerImageTag\": \"mock_latest_tag\",\n \"schedule\": {\n \"runtimePlan\": \"on_demand\",\n \"recurrences\": [\n\n ]\n },\n \"timeZone\": \"America/Chicago\",\n \"replicas\": 1,\n \"maxReplicas\": null,\n \"instanceType\": null,\n \"memory\": 3000,\n \"cpu\": 800,\n \"createdAt\": \"2023-07-18T18:46:14.000Z\",\n \"updatedAt\": \"2023-07-18T18:46:14.000Z\",\n \"credentials\": [\n\n ],\n \"permissionSetId\": null,\n \"gitRepoUrl\": \"https://github.com/acme_co/my_shiny_code.git\",\n \"gitRepoRef\": null,\n \"gitPathDir\": null,\n \"reportId\": null,\n \"currentDeployment\": null,\n \"currentUrl\": null,\n \"environmentVariables\": {\n },\n \"notifications\": {\n \"failureEmailAddresses\": [\n \"devuserfactory30352897user@localhost.test\"\n ],\n \"failureOn\": true\n },\n \"partitionLabel\": null,\n \"myPermissionLevel\": \"manage\",\n \"archived\": false,\n \"hidden\": false\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"6a172f0fc37cf7e3567bfc4cfd548493\"","X-Request-Id":"457815bb-d26a-4e19-b896-d1e321a0eb7c","X-Runtime":"0.029845","Content-Length":"920"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/services/17\" -X GET \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer 3jvbLGCcuNkQ20Dx6ViDRI2_svDuO4-Z-d9RhpXxVCo\" \\\n\t-H \"Accept: application/vnd.civis-platform.v1\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Services","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/services/:id","description":"View details of a service including an active deployment","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/services/18","request_body":null,"request_headers":{"Content-Type":"application/json","Authorization":"Bearer c22V3jdPMnqIp6BXl8Q5qZ7yKQEgNY7IAfefgue1mrk","Accept":"application/vnd.civis-platform.v1","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 18,\n \"name\": \"Service #18\",\n \"description\": null,\n \"user\": {\n \"id\": 4482,\n \"name\": \"User devuserfactory3036 3034\",\n \"username\": \"devuserfactory3036\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"type\": \"App\",\n \"dockerImageName\": \"civisanalytics/civis-services-shiny\",\n \"dockerImageTag\": \"mock_latest_tag\",\n \"schedule\": {\n \"runtimePlan\": \"on_demand\",\n \"recurrences\": [\n\n ]\n },\n \"timeZone\": \"America/Chicago\",\n \"replicas\": 1,\n \"maxReplicas\": null,\n \"instanceType\": null,\n \"memory\": 3000,\n \"cpu\": 800,\n \"createdAt\": \"2023-07-18T18:46:14.000Z\",\n \"updatedAt\": \"2023-07-18T18:46:14.000Z\",\n \"credentials\": [\n\n ],\n \"permissionSetId\": null,\n \"gitRepoUrl\": \"https://github.com/acme_co/my_shiny_code.git\",\n \"gitRepoRef\": null,\n \"gitPathDir\": null,\n \"reportId\": null,\n \"currentDeployment\": {\n \"deploymentId\": 25,\n \"userId\": 4483,\n \"host\": \"deployment.foo.com\",\n \"name\": \"deployment\",\n \"dockerImageName\": \"civis-custom-image\",\n \"dockerImageTag\": \"1.1\",\n \"displayUrl\": \"https://deployment.foo.com/civis-platform-auth?token=bm9uY2UyMTNfWFhYWFhYXzI0X2J5dGVzS4wxkhRxPPl7gzQgJbX8ecYNx7-wIV72DLax9hUdZVwX_M0mfH6_BM9AgRtWBjzoyqAz3AxJRXM9EULOjaW_oix8yG9FlTjtJsaFgQXq4jp-V7aI3vq5CA4Som8yG2YMTecPPmLTN3JLZF6v15PtWcjSs7_K3SoTDtBzZXs7p3GbEzL9qgXAqE1b0AyoivnZp8kjmLG3CeYCKVNZHZoKtyotfj-gzJumlBS9K0to7Q_DkwujUU67p52I_EINU4owDqeO6Ca6nMrc9ZrvMMGpMR9ndmmIZrN0IUArciJSgUYpkn0_7_eXfj0P7ZrkeTsiVU_jr2nnttAQHpI_1LYjnhdaTH5xGW7300JYcGy34BuO3Wf-jOH33v0Ly4Sq2uWfu1VpvXm9vvpgdo48CnhUI4pxr_-05NycuDA=\",\n \"instanceType\": \"m4.xlarge\",\n \"memory\": 2008,\n \"cpu\": 500,\n \"state\": \"running\",\n \"stateMessage\": null,\n \"maxMemoryUsage\": null,\n \"maxCpuUsage\": null,\n \"createdAt\": \"2023-07-18T18:46:14.000Z\",\n \"updatedAt\": \"2023-07-18T18:46:14.000Z\",\n \"serviceId\": 18\n },\n \"currentUrl\": \"https://services--18--29e9a9449b2c--default.services.civis.test\",\n \"environmentVariables\": {\n },\n \"notifications\": {\n \"failureEmailAddresses\": [\n \"devuserfactory30362898user@localhost.test\"\n ],\n \"failureOn\": true\n },\n \"partitionLabel\": null,\n \"myPermissionLevel\": \"manage\",\n \"archived\": false,\n \"hidden\": false\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"30be119acef147bcf915c19905bd14d4\"","X-Request-Id":"3517ecad-d790-4db9-b71f-6c48401be2fa","X-Runtime":"0.032356","Content-Length":"1864"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/services/18\" -X GET \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer c22V3jdPMnqIp6BXl8Q5qZ7yKQEgNY7IAfefgue1mrk\" \\\n\t-H \"Accept: application/vnd.civis-platform.v1\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"put":{"summary":"Replace all attributes of this Service","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID for this Service.","type":"integer"},{"name":"Object648","in":"body","schema":{"$ref":"#/definitions/Object648"},"required":false}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object643"}}},"x-examples":null,"x-deprecation-warning":null},"patch":{"summary":"Update some attributes of this Service","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID for this Service.","type":"integer"},{"name":"Object648","in":"body","schema":{"$ref":"#/definitions/Object648"},"required":false}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object643"}}},"x-examples":null,"x-deprecation-warning":null},"delete":{"summary":"Archive a Service (deprecated, use archiving endpoints instead)","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/services/{id}/shares":{"get":{"summary":"List users and groups permissioned on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object9"}}}},"x-examples":null,"x-deprecation-warning":null}},"/services/{id}/shares/users":{"put":{"summary":"Set the permissions users have on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"Object649","in":"body","schema":{"$ref":"#/definitions/Object649"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object9"}}},"x-examples":null,"x-deprecation-warning":null}},"/services/{id}/shares/users/{user_id}":{"delete":{"summary":"Revoke the permissions a user has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"user_id","in":"path","required":true,"description":"The ID of the user.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/services/{id}/shares/groups":{"put":{"summary":"Set the permissions groups has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"Object650","in":"body","schema":{"$ref":"#/definitions/Object650"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object9"}}},"x-examples":null,"x-deprecation-warning":null}},"/services/{id}/shares/groups/{group_id}":{"delete":{"summary":"Revoke the permissions a group has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"group_id","in":"path","required":true,"description":"The ID of the group.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/services/{id}/dependencies":{"get":{"summary":"List dependent objects for this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"user_id","in":"query","required":false,"description":"ID of target user","type":"integer"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object15"}}}},"x-examples":null,"x-deprecation-warning":null}},"/services/{id}/transfer":{"put":{"summary":"Transfer ownership of this object to another user","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"Object651","in":"body","schema":{"$ref":"#/definitions/Object651"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object17"}}},"x-examples":null,"x-deprecation-warning":null}},"/services/{id}/archive":{"put":{"summary":"Update the archive status of this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the object.","type":"integer"},{"name":"Object652","in":"body","schema":{"$ref":"#/definitions/Object652"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object643"}}},"x-examples":null,"x-deprecation-warning":null}},"/services/{id}/projects":{"get":{"summary":"List the projects a Service belongs to","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Service.","type":"integer"},{"name":"hidden","in":"query","required":false,"description":"If specified to be true, returns hidden items. Defaults to false, returning non-hidden items.","type":"boolean"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object85"}}}},"x-examples":null,"x-deprecation-warning":null}},"/services/{id}/projects/{project_id}":{"put":{"summary":"Add a Service to a project","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Service.","type":"integer"},{"name":"project_id","in":"path","required":true,"description":"The ID of the project.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null},"delete":{"summary":"Remove a Service from a project","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Service.","type":"integer"},{"name":"project_id","in":"path","required":true,"description":"The ID of the project.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/services/{service_id}/deployments":{"get":{"summary":"List deployments for a Service","description":null,"deprecated":false,"parameters":[{"name":"service_id","in":"path","required":true,"description":"The ID of the owning Service","type":"integer"},{"name":"deployment_id","in":"query","required":false,"description":"The ID for this deployment","type":"integer"},{"name":"limit","in":"query","required":false,"description":"Number of results to return. Defaults to 20. Maximum allowed is 50.","type":"integer"},{"name":"page_num","in":"query","required":false,"description":"Page number of the results to return. Defaults to the first page, 1.","type":"integer"},{"name":"order","in":"query","required":false,"description":"The field on which to order the result set. Defaults to created_at. Must be one of: created_at.","type":"string"},{"name":"order_dir","in":"query","required":false,"description":"Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc.","type":"string"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object638"}}}},"x-examples":[{"resource":"Services","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/services/:service_id/deployments","description":"List all Deployments for a service","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/services/25/deployments","request_body":null,"request_headers":{"Content-Type":"application/json","Authorization":"Bearer SDmdnhF1nR8DGgY9vMrTEeAPZQ7bN5kwIwFiljS6Tmc","Accept":"application/vnd.civis-platform.v1","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"deploymentId\": 26,\n \"userId\": 4487,\n \"host\": \"deployment.foo.com\",\n \"name\": \"deployment\",\n \"dockerImageName\": \"civis-custom-image\",\n \"dockerImageTag\": \"1.1\",\n \"instanceType\": \"m4.xlarge\",\n \"memory\": 2008,\n \"cpu\": 500,\n \"state\": null,\n \"stateMessage\": null,\n \"maxMemoryUsage\": null,\n \"maxCpuUsage\": null,\n \"createdAt\": \"2023-07-18T18:46:15.000Z\",\n \"updatedAt\": \"2023-07-18T18:46:15.000Z\",\n \"serviceId\": 25\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","X-Pagination-Per-Page":"20","Access-Control-Expose-Headers":"X-Pagination-Per-Page, X-Pagination-Current-Page, X-Pagination-Total-Pages, X-Pagination-Total-Entries","X-Pagination-Current-Page":"1","X-Pagination-Total-Pages":"1","X-Pagination-Total-Entries":"1","Content-Type":"application/json; charset=utf-8","ETag":"W/\"480dc7984029d65de84c848b90c4c67d\"","X-Request-Id":"3af97aa0-bce8-4012-985d-1b9a2326dbf3","X-Runtime":"0.016759","Content-Length":"363"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/services/25/deployments\" -X GET \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer SDmdnhF1nR8DGgY9vMrTEeAPZQ7bN5kwIwFiljS6Tmc\" \\\n\t-H \"Accept: application/vnd.civis-platform.v1\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"post":{"summary":"Deploy a Service","description":null,"deprecated":false,"parameters":[{"name":"service_id","in":"path","required":true,"description":"The ID of the owning Service","type":"integer"},{"name":"Object653","in":"body","schema":{"$ref":"#/definitions/Object653"},"required":false}],"responses":{"201":{"description":"success","schema":{"$ref":"#/definitions/Object646"}}},"x-examples":[{"resource":"Services","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/services/:service_id/deployments","description":"Create a deployment for a service","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/services/28/deployments","request_body":null,"request_headers":{"Content-Type":"application/json","Authorization":"Bearer iAb7p9r8ewWD2l6pIpMreiOXRpDHU6WGqOpAzDkJw3I","Accept":"application/vnd.civis-platform.v1","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":201,"response_status_text":"Created","response_body":"{\n \"deploymentId\": 29,\n \"userId\": 4491,\n \"host\": \"deployment.foo.com\",\n \"name\": \"deployment\",\n \"dockerImageName\": \"civis-custom-image\",\n \"dockerImageTag\": \"1.1\",\n \"displayUrl\": \"https://deployment.foo.com/civis-platform-auth?token=bm9uY2UyMTNfWFhYWFhYXzI0X2J5dGVzOpnKM-p-OejO9Es9CVSjqtkFyum_3w9QmbwsABVVWAwKWb1kSqOa1ZWppf4iuhvpjx40bDQuyWEjKGCHDOiDtwZ1qgZs7vavMM4s-QhdPOZHMir1Grf7RAZ8M2WedUns_Xxa8ixQ0NiI3SHTOy7Laa01SmsdRWE7xhfVU8OLSvEa13HN_zn0iGW5Y2onSIU_vPSSZuj6jDfhQmjJL60AyIz0OOcwvubdyvyyx4MOqIlR-KrSuacfmQHk7Q8kmoeLIZ2uUS3yAt5I__yHH90Ae33sP4tRqST1dMveIhjzPpONHqTFGFgPVGBUHhqT0N3n62w7uIMVSQ4da7sEJFkVvj-TkXqnOTDXz6TafI-tK4xNQUELBRujhRO74VdugnGp5ZcqnoWo7ZnWsyae4KHixA68vZ4mt_aqMjI=\",\n \"instanceType\": \"m4.xlarge\",\n \"memory\": 2008,\n \"cpu\": 500,\n \"state\": null,\n \"stateMessage\": null,\n \"maxMemoryUsage\": null,\n \"maxCpuUsage\": null,\n \"createdAt\": \"2023-07-18T18:46:15.000Z\",\n \"updatedAt\": \"2023-07-18T18:46:15.000Z\",\n \"serviceId\": 28\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"9c37a3098370cab9d74f2742281de8ed\"","X-Request-Id":"0265ac34-f1c7-42b6-8aaa-fcb180782003","X-Runtime":"0.023747","Content-Length":"882"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/services/28/deployments\" -d '' -X POST \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer iAb7p9r8ewWD2l6pIpMreiOXRpDHU6WGqOpAzDkJw3I\" \\\n\t-H \"Accept: application/vnd.civis-platform.v1\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/services/{service_id}/deployments/{deployment_id}":{"get":{"summary":"Get details about a Service deployment","description":null,"deprecated":false,"parameters":[{"name":"service_id","in":"path","required":true,"description":"The ID of the owning Service","type":"integer"},{"name":"deployment_id","in":"path","required":true,"description":"The ID for this deployment","type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object646"}}},"x-examples":[{"resource":"Services","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/services/:service_id/deployments/:deployment_id","description":"View a service deployment's details","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/services/26/deployments/27","request_body":null,"request_headers":{"Content-Type":"application/json","Authorization":"Bearer Vo0p7XTBg7jd0b2avnSXsX63wTY6FfwAzZVjjHR54sE","Accept":"application/vnd.civis-platform.v1","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"deploymentId\": 27,\n \"userId\": 4489,\n \"host\": \"deployment.foo.com\",\n \"name\": \"deployment\",\n \"dockerImageName\": \"civis-custom-image\",\n \"dockerImageTag\": \"1.1\",\n \"displayUrl\": \"https://deployment.foo.com/civis-platform-auth?token=bm9uY2UyMTNfWFhYWFhYXzI0X2J5dGVzkKoxeWi-BQAa_BXSqo6kTu3Nsj0ip_wO2mBesFI_vJRTp10Y8SVh1WyiGPjhnW4Vfnkq423B35l_j2H2-TELUc--rOOUMM37D_Gutvogq2iz1pFA1_GhJdhSLP3V8Nx2ws_Ma2a5fZRyVJAcmOk81RK8PAV2B7An2X-hHg_kwovtOkTSsoDIaUdsLoiRrXw-K8CV9umd2vvvDZ37cvfqtkJbGCTR3F5pM68nuKpGPZRVZYcecs29ZWKGGpgA_P2N40njXcD0Luc31uN8edquhinggjw5iQ4rmHW2RSGla5G0dUDrjKkDDlLLVDOlUONMNIFVFDp5pXJUVlMGNfPUEgsWEiNUcZ06bsYy5_DwmfHL0AtPYhEten9y2PyFaVkIVxIenXsIR_K0XmvouDvmAqsM4pw6NEuhsNw=\",\n \"instanceType\": \"m4.xlarge\",\n \"memory\": 2008,\n \"cpu\": 500,\n \"state\": null,\n \"stateMessage\": null,\n \"maxMemoryUsage\": null,\n \"maxCpuUsage\": null,\n \"createdAt\": \"2023-07-18T18:46:15.000Z\",\n \"updatedAt\": \"2023-07-18T18:46:15.000Z\",\n \"serviceId\": 26\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"f1a503742f3cf25ea779ae60ab49c948\"","X-Request-Id":"54954672-5cc8-4cfd-9685-5f4686c39575","X-Runtime":"0.021562","Content-Length":"882"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/services/26/deployments/27\" -X GET \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer Vo0p7XTBg7jd0b2avnSXsX63wTY6FfwAzZVjjHR54sE\" \\\n\t-H \"Accept: application/vnd.civis-platform.v1\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"delete":{"summary":"Delete a Service deployment","description":null,"deprecated":false,"parameters":[{"name":"service_id","in":"path","required":true,"description":"The ID of the owning Service","type":"integer"},{"name":"deployment_id","in":"path","required":true,"description":"The ID for this deployment","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":[{"resource":"Services","resource_explanation":null,"http_method":"DELETE","route":"http://api.civis.test/services/:service_id/deployments/:deployment_id","description":"Delete a deployment for a service","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"DELETE","request_path":"http://api.civis.test/services/29/deployments/30","request_body":null,"request_headers":{"Content-Type":"application/json","Authorization":"Bearer 2MI8B3I9k-qPWwburffWJ6yHAMByEALEmgT1cJ1mwMg","Accept":"application/vnd.civis-platform.v1","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":204,"response_status_text":"No Content","response_body":null,"response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","X-Request-Id":"d299c580-9094-479a-81f2-8c4e943293ae","X-Runtime":"0.017120"},"response_content_type":null,"curl":"curl \"api.civis.testhttp://api.civis.test/services/29/deployments/30\" -d '' -X DELETE \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer 2MI8B3I9k-qPWwburffWJ6yHAMByEALEmgT1cJ1mwMg\" \\\n\t-H \"Accept: application/vnd.civis-platform.v1\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/services/{service_id}/redeploy":{"post":{"summary":"Redeploy a Service","description":null,"deprecated":false,"parameters":[{"name":"service_id","in":"path","required":true,"description":"The ID of the owning Service","type":"integer"},{"name":"Object653","in":"body","schema":{"$ref":"#/definitions/Object653"},"required":false}],"responses":{"201":{"description":"success","schema":{"$ref":"#/definitions/Object646"}}},"x-examples":null,"x-deprecation-warning":null}},"/services/{id}/deployments/{deployment_id}/logs":{"get":{"summary":"Get the logs for a Service deployment","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the owning Service.","type":"integer"},{"name":"deployment_id","in":"path","required":true,"description":"The ID for this deployment.","type":"integer"},{"name":"start_at","in":"query","required":false,"description":"Log entries with a lower timestamp will be omitted.","type":"string","format":"date-time"},{"name":"end_at","in":"query","required":false,"description":"Log entries with a higher timestamp will be omitted.","type":"string","format":"date-time"},{"name":"limit","in":"query","required":false,"description":"The maximum number of log messages to return. Default of 10000.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object57"}}}},"x-examples":null,"x-deprecation-warning":null}},"/services/{id}/clone":{"post":{"summary":"Clone this Service","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"type":"integer"}],"responses":{"201":{"description":"success","schema":{"$ref":"#/definitions/Object643"}}},"x-examples":[{"resource":"Services","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/services/:id/clone","description":"Make a clone of an existing service","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/services/23/clone","request_body":null,"request_headers":{"Content-Type":"application/json","Authorization":"Bearer lWh8Bb2-zQnlBKpZyY9nrH2ogc7SCaG3JFS2iIvA3SY","Accept":"application/vnd.civis-platform.v1","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":201,"response_status_text":"Created","response_body":"{\n \"id\": 24,\n \"name\": \"Clone of Service #23\",\n \"description\": null,\n \"user\": {\n \"id\": 4486,\n \"name\": \"User devuserfactory3040 3038\",\n \"username\": \"devuserfactory3040\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"type\": \"App\",\n \"dockerImageName\": \"civisanalytics/civis-services-shiny\",\n \"dockerImageTag\": \"mock_latest_tag\",\n \"schedule\": {\n \"runtimePlan\": \"on_demand\",\n \"recurrences\": [\n\n ]\n },\n \"timeZone\": \"America/Chicago\",\n \"replicas\": 1,\n \"maxReplicas\": null,\n \"instanceType\": null,\n \"memory\": 3000,\n \"cpu\": 800,\n \"createdAt\": \"2023-07-18T18:46:15.000Z\",\n \"updatedAt\": \"2023-07-18T18:46:15.000Z\",\n \"credentials\": [\n\n ],\n \"permissionSetId\": null,\n \"gitRepoUrl\": \"https://github.com/acme_co/my_shiny_code.git\",\n \"gitRepoRef\": null,\n \"gitPathDir\": null,\n \"reportId\": null,\n \"currentDeployment\": null,\n \"currentUrl\": null,\n \"environmentVariables\": {\n },\n \"notifications\": {\n \"failureEmailAddresses\": [\n \"devuserfactory30402902user@localhost.test\"\n ],\n \"failureOn\": true\n },\n \"partitionLabel\": null,\n \"myPermissionLevel\": \"manage\",\n \"archived\": false,\n \"hidden\": false\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"60af4428f2ac4969f5795224ccf4f5e2\"","X-Request-Id":"da7d2088-8178-4003-be3f-47a0d1cfe7c2","X-Runtime":"0.049360","Content-Length":"929"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/services/23/clone\" -d '' -X POST \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer lWh8Bb2-zQnlBKpZyY9nrH2ogc7SCaG3JFS2iIvA3SY\" \\\n\t-H \"Accept: application/vnd.civis-platform.v1\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/services/{id}/tokens":{"post":{"summary":"Create a new long-lived service token","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the service.","type":"integer"},{"name":"Object656","in":"body","schema":{"$ref":"#/definitions/Object656"},"required":true}],"responses":{"201":{"description":"success","schema":{"$ref":"#/definitions/Object657"}}},"x-examples":[{"resource":"Services","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/services/:service_id/tokens","description":"Create a token for a service","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/services/30/tokens","request_body":"{\n \"name\": \"new_token\"\n}","request_headers":{"Content-Type":"application/json","Authorization":"Bearer DGLuA7Z7y5UWqJ1cpBf3jwG_SacfEqETdmaBJcWaUAY","Accept":"application/vnd.civis-platform.v1","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":201,"response_status_text":"Created","response_body":"{\n \"id\": 1,\n \"name\": \"new_token\",\n \"user\": {\n \"id\": 4495,\n \"name\": \"User devuserfactory3049 3047\",\n \"username\": \"devuserfactory3049\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"machineToken\": false,\n \"expiresAt\": \"2023-07-19T18:46:15.000Z\",\n \"createdAt\": \"2023-07-18T18:46:15.000Z\",\n \"token\": \"bm9uY2UyMTNfWFhYWFhYXzI0X2J5dGVzf8IPlrsdLWkoEqLsa7iVE_Eb9izqn9vcproMb99azqC_IdU27Dt5A1hxVo3mPDI-Bo5p4fNvZhUuyF8cMhkgpPiBZJnRWtmbfHGonlxhBRFQ0GSvPT00wX0vPtUMcFHAu9EpsARF8jIGuyfKmQO8Z8ykvkuTnNulyqX_7_F_GGHYA2q3twu2myaF4Q2Evnup1iFsrY0e8GlESuhz-bKY1Ub60tFhV9egiFahYIpZL41SzIBLOgwFWxgRbx1zlgneAudHqz0Jh6PTgSLK3z1FcGuzXmTVt3r66jP8yEuT-YM0ofez5z-EeZMdxRyzOk7cz8oBh-HreF17g0yWpmC_X9sDrCe6bQnVlssk0rdOGq3GAZogLv0oIfXf1gK1Ec3jQ_zUplrrgVPxZ88yGllk4m45FOgR1qoktcQ=\"\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"14c96f5cba4b2f2d6fae7e7d11113a01\"","X-Request-Id":"4c1440ea-8a29-4e3e-b591-a1d3021933d5","X-Runtime":"0.038957","Content-Length":"708"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/services/30/tokens\" -d '{\"name\":\"new_token\"}' -X POST \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer DGLuA7Z7y5UWqJ1cpBf3jwG_SacfEqETdmaBJcWaUAY\" \\\n\t-H \"Accept: application/vnd.civis-platform.v1\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"get":{"summary":"List tokens","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the service.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object658"}}}},"x-examples":[{"resource":"Services","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/services/:service_id/tokens","description":"List tokens for a service","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/services/31/tokens","request_body":null,"request_headers":{"Content-Type":"application/json","Authorization":"Bearer jkc0h0IMJwbLy9qsE2DWD3S4OIaIcdmQ8z8fp7Haer0","Accept":"application/vnd.civis-platform.v1","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 2,\n \"name\": \"My Happy Token\",\n \"user\": {\n \"id\": 4499,\n \"name\": \"User devuserfactory3053 3051\",\n \"username\": \"devuserfactory3053\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"machineToken\": true,\n \"expiresAt\": \"2023-07-19T18:46:16.000Z\",\n \"createdAt\": \"2023-07-18T18:46:16.000Z\"\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"8b683d6fec5d380d6dface217e618005\"","X-Request-Id":"28707410-d977-49a4-a5bb-25a7689c5aa0","X-Runtime":"0.018048","Content-Length":"251"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/services/31/tokens\" -X GET \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer jkc0h0IMJwbLy9qsE2DWD3S4OIaIcdmQ8z8fp7Haer0\" \\\n\t-H \"Accept: application/vnd.civis-platform.v1\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/services/{id}/tokens/{token_id}":{"delete":{"summary":"Revoke a token by id","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the service.","type":"integer"},{"name":"token_id","in":"path","required":true,"description":"The ID of the token.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":[{"resource":"Services","resource_explanation":null,"http_method":"DELETE","route":"http://api.civis.test/services/:service_id/tokens/:token_id","description":"Revoke a service token","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"DELETE","request_path":"http://api.civis.test/services/32/tokens/3","request_body":null,"request_headers":{"Content-Type":"application/json","Authorization":"Bearer 9QVCV0zQFNWlNtyeZBVaHWrNuKnKXGg1jEJFq0VUxrQ","Accept":"application/vnd.civis-platform.v1","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":204,"response_status_text":"No Content","response_body":null,"response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","X-Request-Id":"fef9d5ad-a4d7-458c-bead-af9bcdb3bf42","X-Runtime":"0.021474"},"response_content_type":null,"curl":"curl \"api.civis.testhttp://api.civis.test/services/32/tokens/3\" -d '' -X DELETE \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer 9QVCV0zQFNWlNtyeZBVaHWrNuKnKXGg1jEJFq0VUxrQ\" \\\n\t-H \"Accept: application/vnd.civis-platform.v1\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/storage_hosts/":{"get":{"summary":"List the storage hosts","description":null,"deprecated":false,"parameters":[],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object659"}}}},"x-examples":[{"resource":"StorageHosts","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/storage_hosts","description":"List all cloud storage hosts for a user","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/storage_hosts","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer H61XfzpzDvLqjKxRBKejZbsEYtbvfOzo-uPkLIYvGDg","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 260,\n \"owner\": {\n \"id\": 527,\n \"name\": \"User devuserfactory344 344\",\n \"username\": \"devuserfactory344\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"name\": \"S3Storage\",\n \"provider\": \"s3\",\n \"bucket\": \"mybucket\",\n \"s3Options\": {\n \"region\": \"us-east-1\"\n }\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"a7cf18843f153c4f91e5cfb14a5bf66d\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"8571d33d-d632-4d0a-b63a-bf90d6d379fd","X-Runtime":"0.032331","Content-Length":"218"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/storage_hosts\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer H61XfzpzDvLqjKxRBKejZbsEYtbvfOzo-uPkLIYvGDg\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"post":{"summary":"Create a new storage host","description":null,"deprecated":false,"parameters":[{"name":"Object661","in":"body","schema":{"$ref":"#/definitions/Object661"},"required":true}],"responses":{"201":{"description":"success","schema":{"$ref":"#/definitions/Object659"}}},"x-examples":[{"resource":"StorageHosts","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/storage_hosts","description":"Create a cloud storage host","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/storage_hosts","request_body":"{\n \"name\": \"S3 Host\",\n \"provider\": \"s3\",\n \"bucket\": \"theres-a-hole-in-the-bucket\"\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer bsZebIoEAYP-sESVAXd_AmXdOPfXflKQg1cqJrA2yTM","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":201,"response_status_text":"Created","response_body":"{\n \"id\": 266,\n \"owner\": {\n \"id\": 529,\n \"name\": \"User devuserfactory346 346\",\n \"username\": \"devuserfactory346\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"name\": \"S3 Host\",\n \"provider\": \"s3\",\n \"bucket\": \"theres-a-hole-in-the-bucket\",\n \"s3Options\": {\n \"region\": \"us-east-1\"\n }\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"4b8dccfa62c5a30d9cef34a42cd88589\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"41199457-243e-4670-a14d-c24bf38a067d","X-Runtime":"0.057801","Content-Length":"233"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/storage_hosts\" -d '{\"name\":\"S3 Host\",\"provider\":\"s3\",\"bucket\":\"theres-a-hole-in-the-bucket\"}' -X POST \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer bsZebIoEAYP-sESVAXd_AmXdOPfXflKQg1cqJrA2yTM\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/storage_hosts/{id}":{"get":{"summary":"Get a storage host","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the storage host.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object659"}}},"x-examples":[{"resource":"StorageHosts","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/storage_hosts/:id","description":"View details for a cloud storage host","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/storage_hosts/262","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer V25hbRbBG-4_K3A-hMw-f9t6QLXmICaQNjZqT_-EYzY","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 262,\n \"owner\": {\n \"id\": 528,\n \"name\": \"User devuserfactory345 345\",\n \"username\": \"devuserfactory345\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"name\": \"S3Storage\",\n \"provider\": \"s3\",\n \"bucket\": \"mybucket\",\n \"s3Options\": {\n \"region\": \"us-east-1\"\n }\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"c3f69a825f3e6743844b46ba5f75e47a\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"886aa5e5-7f1e-4b34-b5f9-13102a980dd0","X-Runtime":"0.033787","Content-Length":"216"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/storage_hosts/262\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer V25hbRbBG-4_K3A-hMw-f9t6QLXmICaQNjZqT_-EYzY\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"put":{"summary":"Replace all attributes of this storage host","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the storage host.","type":"integer"},{"name":"Object663","in":"body","schema":{"$ref":"#/definitions/Object663"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object659"}}},"x-examples":[{"resource":"StorageHosts","resource_explanation":null,"http_method":"PUT","route":"http://api.civis.test/storage_hosts/:id","description":"Update a cloud storage host via PUT","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"PUT","request_path":"http://api.civis.test/storage_hosts/271","request_body":"{\n \"name\": \"Different S3 Host\",\n \"provider\": \"s3\",\n \"bucket\": \"theres-still-a-hole-in-the-bucket\"\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer 1l7myO--d8Hw3R2BXt-EP6yOOfaKb2uFT8Omp_fK3Nw","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 271,\n \"owner\": {\n \"id\": 532,\n \"name\": \"User devuserfactory349 349\",\n \"username\": \"devuserfactory349\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"name\": \"Different S3 Host\",\n \"provider\": \"s3\",\n \"bucket\": \"theres-still-a-hole-in-the-bucket\",\n \"s3Options\": {\n \"region\": \"us-east-1\"\n }\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"77ae135c94f22754faa94933c0c1f79f\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"2bb21bc9-07f3-45ad-891a-2a2eb513fc04","X-Runtime":"0.066749","Content-Length":"249"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/storage_hosts/271\" -d '{\"name\":\"Different S3 Host\",\"provider\":\"s3\",\"bucket\":\"theres-still-a-hole-in-the-bucket\"}' -X PUT \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer 1l7myO--d8Hw3R2BXt-EP6yOOfaKb2uFT8Omp_fK3Nw\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"patch":{"summary":"Update some attributes of this storage host","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the storage host.","type":"integer"},{"name":"Object664","in":"body","schema":{"$ref":"#/definitions/Object664"},"required":false}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object659"}}},"x-examples":[{"resource":"StorageHosts","resource_explanation":null,"http_method":"PATCH","route":"http://api.civis.test/storage_hosts/:id","description":"Update a cloud storage host via PATCH","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"PATCH","request_path":"http://api.civis.test/storage_hosts/267","request_body":"{\n \"name\": \"Renamed S3 Host\"\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer wSO5eg09Rbv6WpbuhYF4-2jrRhADPKppRUgLAbf22Bg","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 267,\n \"owner\": {\n \"id\": 530,\n \"name\": \"User devuserfactory347 347\",\n \"username\": \"devuserfactory347\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"name\": \"Renamed S3 Host\",\n \"provider\": \"s3\",\n \"bucket\": \"mybucket\",\n \"s3Options\": {\n \"region\": \"us-east-1\"\n }\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"5e72373144ed7991aef1360d57d137e7\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"019e6154-4000-4c91-9f47-d9755ab53337","X-Runtime":"0.058362","Content-Length":"222"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/storage_hosts/267\" -d '{\"name\":\"Renamed S3 Host\"}' -X PATCH \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer wSO5eg09Rbv6WpbuhYF4-2jrRhADPKppRUgLAbf22Bg\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"StorageHosts","resource_explanation":null,"http_method":"PATCH","route":"http://api.civis.test/storage_hosts/:id","description":"Update a cloud storage host connection attributes via PATCH","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"PATCH","request_path":"http://api.civis.test/storage_hosts/269","request_body":"{\n \"bucket\": \"theres-still-a-hole-in-the-bucket\"\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer 1YSuTVgvVWoNKM3lJ4WcfEcUV6klvamADidIAi6cIOw","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 269,\n \"owner\": {\n \"id\": 531,\n \"name\": \"User devuserfactory348 348\",\n \"username\": \"devuserfactory348\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"name\": \"S3Storage\",\n \"provider\": \"s3\",\n \"bucket\": \"theres-still-a-hole-in-the-bucket\",\n \"s3Options\": {\n \"region\": \"us-east-1\"\n }\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"226ce7dee4163e6d834fbe63de6fd6bb\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"c777adfe-a4cb-4b89-89ec-f3e2297eb998","X-Runtime":"0.044300","Content-Length":"241"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/storage_hosts/269\" -d '{\"bucket\":\"theres-still-a-hole-in-the-bucket\"}' -X PATCH \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer 1YSuTVgvVWoNKM3lJ4WcfEcUV6klvamADidIAi6cIOw\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"delete":{"summary":"Delete a storage host (deprecated)","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the storage host.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":[{"resource":"StorageHosts","resource_explanation":null,"http_method":"DELETE","route":"http://api.civis.test/storage_hosts/:id","description":"Delete a cloud storage host","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"DELETE","request_path":"http://api.civis.test/storage_hosts/273","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer hiyAxqsnKewsixoGOVzPNt1ChSzXPDE1Oz8EQ9dsaIc","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":204,"response_status_text":"No Content","response_body":null,"response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"530adeea-945a-44ee-86d3-39fe30ee5e12","X-Runtime":"0.039972"},"response_content_type":null,"curl":"curl \"api.civis.testhttp://api.civis.test/storage_hosts/273\" -d '' -X DELETE \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer hiyAxqsnKewsixoGOVzPNt1ChSzXPDE1Oz8EQ9dsaIc\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/storage_hosts/{id}/shares":{"get":{"summary":"List users and groups permissioned on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object9"}}}},"x-examples":null,"x-deprecation-warning":null}},"/storage_hosts/{id}/shares/users":{"put":{"summary":"Set the permissions users have on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"Object665","in":"body","schema":{"$ref":"#/definitions/Object665"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object9"}}},"x-examples":null,"x-deprecation-warning":null}},"/storage_hosts/{id}/shares/users/{user_id}":{"delete":{"summary":"Revoke the permissions a user has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"user_id","in":"path","required":true,"description":"The ID of the user.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/storage_hosts/{id}/shares/groups":{"put":{"summary":"Set the permissions groups has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"Object666","in":"body","schema":{"$ref":"#/definitions/Object666"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object9"}}},"x-examples":null,"x-deprecation-warning":null}},"/storage_hosts/{id}/shares/groups/{group_id}":{"delete":{"summary":"Revoke the permissions a group has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"group_id","in":"path","required":true,"description":"The ID of the group.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/storage_hosts/{id}/dependencies":{"get":{"summary":"List dependent objects for this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"user_id","in":"query","required":false,"description":"ID of target user","type":"integer"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object15"}}}},"x-examples":null,"x-deprecation-warning":null}},"/storage_hosts/{id}/transfer":{"put":{"summary":"Transfer ownership of this object to another user","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"Object667","in":"body","schema":{"$ref":"#/definitions/Object667"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object17"}}},"x-examples":null,"x-deprecation-warning":null}},"/table_tags/":{"get":{"summary":"List Table Tags","description":null,"deprecated":false,"parameters":[{"name":"name","in":"query","required":false,"description":"Name of the tag. If it is provided, the results will be filtered by name","type":"string"},{"name":"limit","in":"query","required":false,"description":"Number of results to return. Defaults to 50. Maximum allowed is 1000.","type":"integer"},{"name":"page_num","in":"query","required":false,"description":"Page number of the results to return. Defaults to the first page, 1.","type":"integer"},{"name":"order","in":"query","required":false,"description":"The field on which to order the result set. Defaults to name. Must be one of: name, user, table_count.","type":"string"},{"name":"order_dir","in":"query","required":false,"description":"Direction in which to sort, either asc (ascending) or desc (descending) defaulting to asc.","type":"string"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object668"}}}},"x-examples":[{"resource":"Table Tags","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/table_tags","description":"List table tags","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/table_tags","request_body":null,"request_headers":{"Content-Type":"application/json","Authorization":"Bearer svqoVQKyuTBh2Iovl1F4UTKeIsOtkjMIyFGzBgdjOmM","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 6,\n \"name\": \"Table Tag 5\",\n \"tableCount\": 0,\n \"user\": {\n \"id\": 4512,\n \"name\": \"User devuserfactory3066 3064\",\n \"username\": \"devuserfactory3066\",\n \"initials\": \"UD\",\n \"online\": null\n }\n },\n {\n \"id\": 7,\n \"name\": \"Table Tag 6\",\n \"tableCount\": 0,\n \"user\": {\n \"id\": 4512,\n \"name\": \"User devuserfactory3066 3064\",\n \"username\": \"devuserfactory3066\",\n \"initials\": \"UD\",\n \"online\": null\n }\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","X-Pagination-Per-Page":"50","Access-Control-Expose-Headers":"X-Pagination-Per-Page, X-Pagination-Current-Page, X-Pagination-Total-Pages, X-Pagination-Total-Entries","X-Pagination-Current-Page":"1","X-Pagination-Total-Pages":"1","X-Pagination-Total-Entries":"2","Content-Type":"application/json; charset=utf-8","ETag":"W/\"eb466ea4ef9eb3b7b58d8df490d4ba41\"","X-Request-Id":"4801856d-9756-4c31-a830-e6531e46c363","X-Runtime":"0.017729","Content-Length":"329"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/table_tags\" -X GET \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer svqoVQKyuTBh2Iovl1F4UTKeIsOtkjMIyFGzBgdjOmM\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Table Tags","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/table_tags","description":"List table tags and filter by name","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/table_tags?name=Table+Tag+7","request_body":null,"request_headers":{"Content-Type":"application/json","Authorization":"Bearer qfFxAfpD-D3S0fVdyX11ywaK29ljWfFn_IokM2W1jvk","Host":"api.civis.test","Cookie":""},"request_query_parameters":{"name":"Table Tag 7"},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 8,\n \"name\": \"Table Tag 7\",\n \"tableCount\": 0,\n \"user\": {\n \"id\": 4513,\n \"name\": \"User devuserfactory3067 3065\",\n \"username\": \"devuserfactory3067\",\n \"initials\": \"UD\",\n \"online\": null\n }\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","X-Pagination-Per-Page":"50","Access-Control-Expose-Headers":"X-Pagination-Per-Page, X-Pagination-Current-Page, X-Pagination-Total-Pages, X-Pagination-Total-Entries","X-Pagination-Current-Page":"1","X-Pagination-Total-Pages":"1","X-Pagination-Total-Entries":"1","Content-Type":"application/json; charset=utf-8","ETag":"W/\"ea9c57ce9f68b466ecace91a28f52d50\"","X-Request-Id":"62f9a31a-546b-4d6d-b8ae-9177e2218f5b","X-Runtime":"0.016589","Content-Length":"165"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/table_tags?name=Table+Tag+7\" -X GET \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer qfFxAfpD-D3S0fVdyX11ywaK29ljWfFn_IokM2W1jvk\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"post":{"summary":"Create a Table Tag","description":null,"deprecated":false,"parameters":[{"name":"Object669","in":"body","schema":{"$ref":"#/definitions/Object669"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object670"}}},"x-examples":null,"x-deprecation-warning":null}},"/table_tags/{id}":{"get":{"summary":"Get a Table Tag","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object670"}}},"x-examples":[{"resource":"Table Tags","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/table_tags/:id","description":"Get a table tag","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/table_tags/4","request_body":null,"request_headers":{"Content-Type":"application/json","Authorization":"Bearer _FYI4EMtyJgY3g63MqHpDGqQLqWXMkBfkR5q4e0ZiBY","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 4,\n \"name\": \"Table Tag 3\",\n \"createdAt\": \"2023-07-18T18:46:17.000Z\",\n \"updatedAt\": \"2023-07-18T18:46:17.000Z\",\n \"tableCount\": 0,\n \"user\": {\n \"id\": 4511,\n \"name\": \"User devuserfactory3065 3063\",\n \"username\": \"devuserfactory3065\",\n \"initials\": \"UD\",\n \"online\": null\n }\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"40440b81e816abeb5d5257ba718c33cb\"","X-Request-Id":"c1cdc3b0-e2f8-48eb-a608-52a2e1eae0b6","X-Runtime":"0.019004","Content-Length":"241"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/table_tags/4\" -X GET \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer _FYI4EMtyJgY3g63MqHpDGqQLqWXMkBfkR5q4e0ZiBY\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"delete":{"summary":"Delete a Table Tag","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":[{"resource":"Table Tags","resource_explanation":null,"http_method":"DELETE","route":"http://api.civis.test/table_tags/:id","description":"delete a table tag","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"DELETE","request_path":"http://api.civis.test/table_tags/10","request_body":null,"request_headers":{"Content-Type":"application/json","Authorization":"Bearer jquDV3uxSYIAFlliQKvVEUY-EYTg4NFwWIHiyzlHthg","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":204,"response_status_text":"No Content","response_body":null,"response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","X-Request-Id":"cd091a86-39c0-402b-8436-29f01620457b","X-Runtime":"0.068481"},"response_content_type":null,"curl":"curl \"api.civis.testhttp://api.civis.test/table_tags/10\" -d '' -X DELETE \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer jquDV3uxSYIAFlliQKvVEUY-EYTg4NFwWIHiyzlHthg\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/tables/{source_table_id}/enhancements/geocodings":{"post":{"summary":"Geocode a table","description":"Create a new table with additional census and geographic boundary information. The source table should either contain addresses, which will be geocoded into latitude/longitude coordinates in the output table, or latitude/longitude coordinates.Before using this endpoint, the source table must be provided with a mapping declaring either which columns in the table act as address columns or which columns in the table act as latitude/longitude coordinates. See the PATCH tables/:id endpoint for supplying this mapping.","deprecated":true,"parameters":[{"name":"source_table_id","in":"path","required":true,"description":"The ID of the table to be enhanced.","type":"integer"}],"responses":{"201":{"description":"success","schema":{"$ref":"#/definitions/Object671"}}},"x-examples":[{"resource":"Tables","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/tables/:id/enhancements/geocodings","description":"No column mapping present","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/tables/212/enhancements/geocodings","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer 8mpF9Z9gf-BeH7wZY2P9MEtajv_bxokZIKkogOZNEd0","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":409,"response_status_text":"Conflict","response_body":"{\n \"error\": \"conflict\",\n \"errorDescription\": \"Ontology must be mapped first for table 212. Please use the tables/:id endpoints to set an ontology mapping.\",\n \"code\": 409\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","X-Request-Id":"582017c3-532e-4ff5-a73c-6160086272f3","X-Runtime":"0.057870","Content-Length":"161"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/tables/212/enhancements/geocodings\" -d '' -X POST \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer 8mpF9Z9gf-BeH7wZY2P9MEtajv_bxokZIKkogOZNEd0\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Tables","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/tables/:id/enhancements/geocodings","description":"Create a geocoding enhancement","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/tables/213/enhancements/geocodings","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer A5c2J3z-BHqdBxLZolpmX4hzAgw8bbD9cS-3KCux2Z4","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":201,"response_status_text":"Created","response_body":"{\n \"id\": 2180,\n \"sourceTableId\": 213,\n \"state\": \"queued\",\n \"enhancedTableSchema\": \"schema_name\",\n \"enhancedTableName\": \"table_name236_geocoded_208\"\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"ec7bd18e30584ee2e1a428e241328705\"","X-Request-Id":"9695a2f7-3f2c-4a1c-bd65-5fb9a5c29885","X-Runtime":"0.339779","Content-Length":"133"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/tables/213/enhancements/geocodings\" -d '' -X POST \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer A5c2J3z-BHqdBxLZolpmX4hzAgw8bbD9cS-3KCux2Z4\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":"Warning: The tables/:source_table_id/enhancements/geocodings endpoint is deprecated and will be removed after January 1, 2021."}},"/tables/{source_table_id}/enhancements/cass-ncoa":{"post":{"summary":"Standardize addresses in a table","description":"Create a new table with USPS CASS-certified address standardization and (optionally) update addresses for records matching the National Change of Address (NCOA) database. Before using this endpoint, the source table must be provided with a mapping declaring which columns in the table act as address columns. See the PATCH tables/:id endpoint for supplying this mapping.","deprecated":true,"parameters":[{"name":"source_table_id","in":"path","required":true,"description":"The ID of the table to be enhanced.","type":"integer"},{"name":"Object672","in":"body","schema":{"$ref":"#/definitions/Object672"},"required":false}],"responses":{"201":{"description":"success","schema":{"$ref":"#/definitions/Object673"}}},"x-examples":[{"resource":"Tables","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/tables/:id/enhancements/cass-ncoa","description":"Create a CASS enhancement without NCOA","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/tables/223/enhancements/cass-ncoa","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer uDz5ERSPS-99iZpnWeJAVmq_V9yfiQGrZI0LQ3Umvt8","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":201,"response_status_text":"Created","response_body":"{\n \"id\": 2183,\n \"sourceTableId\": 223,\n \"state\": \"queued\",\n \"enhancedTableSchema\": \"schema_name\",\n \"enhancedTableName\": \"table_name247_cass_210\",\n \"performNcoa\": false,\n \"ncoaCredentialId\": null,\n \"outputLevel\": \"all\",\n \"batchSize\": 250000\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"99718231c8df7cbf8c38393889d881b2\"","X-Request-Id":"5db44689-1dd9-4063-95d6-69158c88bafc","X-Runtime":"0.321052","Content-Length":"212"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/tables/223/enhancements/cass-ncoa\" -d '' -X POST \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer uDz5ERSPS-99iZpnWeJAVmq_V9yfiQGrZI0LQ3Umvt8\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Tables","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/tables/:id/enhancements/cass-ncoa","description":"Create a CASS enhancement with NCOA","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/tables/230/enhancements/cass-ncoa","request_body":"{\n \"performNcoa\": true,\n \"batchSize\": 100000,\n \"ncoaCredentialId\": 539\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer i8zd-zc5ykLU0a90Wuv_1VQj0X8_a7xrSFMj2mb1hkQ","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":201,"response_status_text":"Created","response_body":"{\n \"id\": 2184,\n \"sourceTableId\": 230,\n \"state\": \"queued\",\n \"enhancedTableSchema\": \"schema_name\",\n \"enhancedTableName\": \"table_name254_cass_211\",\n \"performNcoa\": true,\n \"ncoaCredentialId\": 539,\n \"outputLevel\": \"all\",\n \"batchSize\": 100000\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"7e3a358cc498c4ff2b0bc13e3b3fc584\"","X-Request-Id":"c245058b-38fa-455d-8283-75d88184b8ef","X-Runtime":"0.334971","Content-Length":"210"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/tables/230/enhancements/cass-ncoa\" -d '{\"performNcoa\":true,\"batchSize\":100000,\"ncoaCredentialId\":539}' -X POST \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer i8zd-zc5ykLU0a90Wuv_1VQj0X8_a7xrSFMj2mb1hkQ\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":"Warning: The tables/:source_table_id/enhancements/cass-ncoa endpoint is deprecated and will be removed after January 1, 2021."}},"/tables/{source_table_id}/enhancements/geocodings/{id}":{"get":{"summary":"View the status of a geocoding table enhancement","description":"This endpoint may be polled to monitor the status of the geocoding table enhancement. When the 'state' field is no longer 'queued' or 'running' the geocoding table enhancement has reached its final state.","deprecated":true,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the enhancement.","type":"integer"},{"name":"source_table_id","in":"path","required":true,"description":"The ID of the table that was enhanced.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object671"}}},"x-examples":[{"resource":"Tables","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/tables/:id/enhancements/geocodings/:geo_id","description":"View a geocoding enhancement","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/tables/217/enhancements/geocodings/2182","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer uk73QBZjUdG3k-UA2IzbUZMONIjFySbTNIxCHCwDNxw","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 2182,\n \"sourceTableId\": 217,\n \"state\": \"queued\",\n \"enhancedTableSchema\": \"schema_name\",\n \"enhancedTableName\": \"table_name240_geocoded_209\"\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"f3e36571d298ff5aa3e4699cf0f795ac\"","X-Request-Id":"7f532d43-2fa4-42b9-af0d-1fb6641e3154","X-Runtime":"0.046586","Content-Length":"133"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/tables/217/enhancements/geocodings/2182\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer uk73QBZjUdG3k-UA2IzbUZMONIjFySbTNIxCHCwDNxw\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":"Warning: The tables/:source_table_id/enhancements/geocodings/:id endpoint is deprecated and will be removed after January 1, 2021."}},"/tables/{source_table_id}/enhancements/cass-ncoa/{id}":{"get":{"summary":"View the status of a CASS / NCOA table enhancement","description":"This endpoint may be polled to monitor the status of the cass-ncoa table enhancement. When the 'state' field is no longer 'queued' or 'running' the cass-ncoa table enhancement has reached its final state.","deprecated":true,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the enhancement.","type":"integer"},{"name":"source_table_id","in":"path","required":true,"description":"The ID of the table that was enhanced.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object673"}}},"x-examples":[{"resource":"Tables","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/tables/:id/enhancements/cass-ncoa/:cass_ncoa_id","description":"View a cass-ncoa enhancement","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/tables/237/enhancements/cass-ncoa/2185","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer C-5lot_RoMAYrzijXwZyBHEINq18v8qC0NTKFn72YVk","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 2185,\n \"sourceTableId\": 237,\n \"state\": \"queued\",\n \"enhancedTableSchema\": \"my_schema\",\n \"enhancedTableName\": \"my_table\",\n \"performNcoa\": true,\n \"ncoaCredentialId\": 549,\n \"outputLevel\": \"all\",\n \"batchSize\": 250000\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"083cbf4fd4d07da888c5b6e7ccd95e9d\"","X-Request-Id":"64da3088-4cc7-483b-aa1d-6cfe80293cc1","X-Runtime":"0.043069","Content-Length":"194"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/tables/237/enhancements/cass-ncoa/2185\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer C-5lot_RoMAYrzijXwZyBHEINq18v8qC0NTKFn72YVk\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":"Warning: The tables/:source_table_id/enhancements/cass-ncoa/:id endpoint is deprecated and will be removed after January 1, 2021."}},"/tables/scan":{"post":{"summary":"Creates and enqueues a single table scanner job on a new table","description":null,"deprecated":false,"parameters":[{"name":"Object674","in":"body","schema":{"$ref":"#/definitions/Object674"},"required":true}],"responses":{"201":{"description":"success","schema":{"$ref":"#/definitions/Object675"}}},"x-examples":[{"resource":"Tables","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/tables/scan","description":"Scan a table","explanation":null,"parameters":[{"required":true,"name":"databaseId","description":"The ID of the database."},{"required":true,"name":"schema","description":"The name of the schema containing the table."},{"required":true,"name":"tableName","description":"The name of the table."},{"required":false,"name":"statsPriority","description":"When to sync table statistics. Valid Options are the following. Option: 'flag' means to flag stats for the next scheduled run of a full table scan on the database. Option: 'block' means to block this job on stats syncing. Option: 'queue' means to queue a separate job for syncing stats and do not block this job on the queued job. Defaults to 'flag'"}],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/tables/scan","request_body":"{\n \"schema\": \"test_20240329145653263557656\",\n \"database_id\": 5,\n \"table_name\": \"table_name233\",\n \"stats_priority\": \"flag\"\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer Az9VbRRo-X2dLG5lxeV5rbvSGLyhobWLp3OL6LSSIJg","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":201,"response_status_text":"Created","response_body":"{\n \"jobId\": 2178,\n \"runId\": 206\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"68e84ff14c8ed9f7f889569c13e082a8\"","X-Request-Id":"02d5d944-e068-4cd8-942e-ce04095a3e9d","X-Runtime":"0.296324","Content-Length":"26"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/tables/scan\" -d '{\"schema\":\"test_20240329145653263557656\",\"database_id\":5,\"table_name\":\"table_name233\",\"stats_priority\":\"flag\"}' -X POST \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer Az9VbRRo-X2dLG5lxeV5rbvSGLyhobWLp3OL6LSSIJg\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/tables/{id}/refresh":{"post":{"summary":"Request a refresh for column and table statistics","description":null,"deprecated":true,"parameters":[{"name":"id","in":"path","required":true,"type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object74"}}},"x-examples":[{"resource":"Tables","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/tables/:id/refresh","description":"Refresh a table","explanation":null,"parameters":[{"required":true,"name":"id","description":"id"}],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/tables/211/refresh","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer tGeD3TvzxvzKQ0t4YO0Q4QK81U3KTP8Cv6W85vrixNk","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 211,\n \"databaseId\": 5,\n \"schema\": \"schema_name\",\n \"name\": \"table_name234\",\n \"description\": null,\n \"isView\": false,\n \"rowCount\": 1,\n \"columnCount\": 0,\n \"sizeMb\": null,\n \"owner\": \"dbadmin\",\n \"distkey\": null,\n \"sortkeys\": null,\n \"refreshStatus\": \"refreshing\",\n \"lastRefresh\": null,\n \"dataUpdatedAt\": \"2020-04-16T16:31:00.000Z\",\n \"schemaUpdatedAt\": \"2020-05-01T16:38:00.000Z\",\n \"refreshId\": 2179,\n \"lastRun\": {\n \"id\": 207,\n \"state\": \"queued\",\n \"createdAt\": \"2024-03-29T15:01:00.000Z\",\n \"startedAt\": null,\n \"finishedAt\": null,\n \"error\": null\n },\n \"primaryKeys\": [\n\n ],\n \"lastModifiedKeys\": [\n\n ],\n \"tableTags\": [\n {\n \"id\": 11,\n \"name\": \"Table Tag 11\"\n }\n ],\n \"ontologyMapping\": {\n },\n \"columns\": [\n\n ],\n \"joins\": [\n\n ],\n \"multipartKey\": [\n \"address_id\"\n ],\n \"enhancements\": [\n\n ],\n \"viewDef\": null,\n \"tableDef\": \"CREATE TABLE \\\"schema_name\\\".\\\"table_name234\\\" (\\n \\n)\\nDISTSTYLE AUTO;\\n\",\n \"outgoingTableMatches\": [\n\n ]\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"868f056bc5f58351d95ba76495940dfe\"","X-Request-Id":"fcf1ac65-b43f-45dd-b493-80dc5469dffe","X-Runtime":"0.390098","Content-Length":"784"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/tables/211/refresh\" -d '' -X POST \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer tGeD3TvzxvzKQ0t4YO0Q4QK81U3KTP8Cv6W85vrixNk\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""},{"request_method":"POST","request_path":"http://api.civis.test/tables/211/refresh","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer tGeD3TvzxvzKQ0t4YO0Q4QK81U3KTP8Cv6W85vrixNk","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":409,"response_status_text":"Conflict","response_body":"{\n \"error\": \"conflict\",\n \"errorDescription\": \"Already running\",\n \"code\": 409\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","X-Request-Id":"e0d9e678-1aea-4ec1-ac98-1c82b4a16020","X-Runtime":"0.175623","Content-Length":"68"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/tables/211/refresh\" -d '' -X POST \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer tGeD3TvzxvzKQ0t4YO0Q4QK81U3KTP8Cv6W85vrixNk\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":"Warning: The tables/:id/refresh endpoint is deprecated. Please use tables/scan from now on."}},"/tables/":{"get":{"summary":"List tables","description":null,"deprecated":false,"parameters":[{"name":"database_id","in":"query","required":false,"description":"The ID of the database.","type":"integer"},{"name":"schema","in":"query","required":false,"description":"If specified, will be used to filter the tables returned. Substring matching is supported with \"%\" and \"*\" wildcards (e.g., \"schema=%census%\" will return both \"client_census.table\" and \"census_2010.table\").","type":"string"},{"name":"name","in":"query","required":false,"description":"If specified, will be used to filter the tables returned. Substring matching is supported with \"%\" and \"*\" wildcards (e.g., \"name=%table%\" will return both \"table1\" and \"my table\").","type":"string"},{"name":"search","in":"query","required":false,"description":"If specified, will be used to filter the tables returned. Will search across schema and name (in the full form schema.name) and will return any full name containing the search string.","type":"string"},{"name":"table_tag_ids","in":"query","required":false,"description":"If specified, will be used to filter the tables returned. Will search across Table Tags and will return any tables that have one of the matching Table Tags.","type":"array","items":{"type":"integer"}},{"name":"credential_id","in":"query","required":false,"description":"If specified, will be used instead of the default credential to filter the tables returned.","type":"integer"},{"name":"limit","in":"query","required":false,"description":"Number of results to return. Defaults to 50. Maximum allowed is 1000.","type":"integer"},{"name":"page_num","in":"query","required":false,"description":"Page number of the results to return. Defaults to the first page, 1.","type":"integer"},{"name":"order","in":"query","required":false,"description":"The field on which to order the result set. Defaults to schema. Must be one of: schema, name, search, table_tag_ids, credential_id.","type":"string"},{"name":"order_dir","in":"query","required":false,"description":"Direction in which to sort, either asc (ascending) or desc (descending) defaulting to asc.","type":"string"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object88"}}}},"x-examples":[{"resource":"Tables","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/tables","description":"list tables","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/tables","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer Z84BSWpRGwlp8cd5AQhQXvM1WrbusaO0GUOsmLPRuXM","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 190,\n \"databaseId\": 5,\n \"schema\": \"schema_name\",\n \"name\": \"table_name195\",\n \"description\": null,\n \"isView\": false,\n \"rowCount\": 1,\n \"columnCount\": 0,\n \"sizeMb\": null,\n \"owner\": \"dbadmin\",\n \"distkey\": null,\n \"sortkeys\": null,\n \"refreshStatus\": \"stale\",\n \"lastRefresh\": null,\n \"refreshId\": null,\n \"lastRun\": null,\n \"tableTags\": [\n\n ]\n },\n {\n \"id\": 191,\n \"databaseId\": 5,\n \"schema\": \"schema_name\",\n \"name\": \"table_name196\",\n \"description\": null,\n \"isView\": false,\n \"rowCount\": 7,\n \"columnCount\": 2,\n \"sizeMb\": null,\n \"owner\": \"dbadmin\",\n \"distkey\": null,\n \"sortkeys\": null,\n \"refreshStatus\": \"stale\",\n \"lastRefresh\": null,\n \"refreshId\": null,\n \"lastRun\": null,\n \"tableTags\": [\n {\n \"id\": 1,\n \"name\": \"Table Tag 1\"\n }\n ]\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","X-Pagination-Per-Page":"50","Access-Control-Expose-Headers":"X-Pagination-Per-Page, X-Pagination-Current-Page, X-Pagination-Total-Pages, X-Pagination-Total-Entries","X-Pagination-Current-Page":"1","X-Pagination-Total-Pages":"1","X-Pagination-Total-Entries":"2","Content-Type":"application/json; charset=utf-8","ETag":"W/\"2e10419d45fb773ca661e0ddc204049b\"","X-Request-Id":"e5426f39-3aac-4882-b11d-b17b0b8e59bc","X-Runtime":"0.100209","Content-Length":"606"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/tables\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer Z84BSWpRGwlp8cd5AQhQXvM1WrbusaO0GUOsmLPRuXM\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Tables","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/tables?name=find_this%25","description":"filter tables by name with a \"%\" wildcard","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/tables?name=find_this%25","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer wT8EqcgYGG-_7jyXrL_NHiI2SBIBCN5x1NDWgs7BqSM","Host":"api.civis.test","Cookie":""},"request_query_parameters":{"name":"find_this%"},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 192,\n \"databaseId\": 5,\n \"schema\": \"schema_name\",\n \"name\": \"find_this_table\",\n \"description\": null,\n \"isView\": false,\n \"rowCount\": 1,\n \"columnCount\": 0,\n \"sizeMb\": null,\n \"owner\": \"dbadmin\",\n \"distkey\": null,\n \"sortkeys\": null,\n \"refreshStatus\": \"stale\",\n \"lastRefresh\": null,\n \"refreshId\": null,\n \"lastRun\": null,\n \"tableTags\": [\n\n ]\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","X-Pagination-Per-Page":"50","Access-Control-Expose-Headers":"X-Pagination-Per-Page, X-Pagination-Current-Page, X-Pagination-Total-Pages, X-Pagination-Total-Entries","X-Pagination-Current-Page":"1","X-Pagination-Total-Pages":"1","X-Pagination-Total-Entries":"1","Content-Type":"application/json; charset=utf-8","ETag":"W/\"29a336858989c32332cbf2a70466f3c9\"","X-Request-Id":"a21eaa26-d738-4b83-8166-09bcf71887ba","X-Runtime":"0.069924","Content-Length":"291"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/tables?name=find_this%25\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer wT8EqcgYGG-_7jyXrL_NHiI2SBIBCN5x1NDWgs7BqSM\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Tables","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/tables?name=find_this%2a","description":"filter tables by name with a \"*\" wildcard","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/tables?name=find_this%2a","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer aW-DxCYQR5ON_rmapIUfHxU9OnbogE-WPnbgz-3g0l8","Host":"api.civis.test","Cookie":""},"request_query_parameters":{"name":"find_this*"},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 194,\n \"databaseId\": 5,\n \"schema\": \"schema_name\",\n \"name\": \"find_this_table\",\n \"description\": null,\n \"isView\": false,\n \"rowCount\": 1,\n \"columnCount\": 0,\n \"sizeMb\": null,\n \"owner\": \"dbadmin\",\n \"distkey\": null,\n \"sortkeys\": null,\n \"refreshStatus\": \"stale\",\n \"lastRefresh\": null,\n \"refreshId\": null,\n \"lastRun\": null,\n \"tableTags\": [\n\n ]\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","X-Pagination-Per-Page":"50","Access-Control-Expose-Headers":"X-Pagination-Per-Page, X-Pagination-Current-Page, X-Pagination-Total-Pages, X-Pagination-Total-Entries","X-Pagination-Current-Page":"1","X-Pagination-Total-Pages":"1","X-Pagination-Total-Entries":"1","Content-Type":"application/json; charset=utf-8","ETag":"W/\"a7971ab2ca0c00f12bf63f6cac26206a\"","X-Request-Id":"24a566a1-60dd-4b81-aebb-d1c4a6a0cb31","X-Runtime":"0.064310","Content-Length":"291"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/tables?name=find_this%2a\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer aW-DxCYQR5ON_rmapIUfHxU9OnbogE-WPnbgz-3g0l8\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Tables","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/tables?name=find_this_table","description":"filter tables by exact name","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/tables?name=find_this_table","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer jU8DHVQ9u9iVY4AuRZkRNUIBUNPRn2r3aotpOoKki9A","Host":"api.civis.test","Cookie":""},"request_query_parameters":{"name":"find_this_table"},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 197,\n \"databaseId\": 5,\n \"schema\": \"schema_name\",\n \"name\": \"find_this_table\",\n \"description\": null,\n \"isView\": false,\n \"rowCount\": 7,\n \"columnCount\": 2,\n \"sizeMb\": null,\n \"owner\": \"dbadmin\",\n \"distkey\": null,\n \"sortkeys\": null,\n \"refreshStatus\": \"stale\",\n \"lastRefresh\": null,\n \"refreshId\": null,\n \"lastRun\": null,\n \"tableTags\": [\n {\n \"id\": 4,\n \"name\": \"Table Tag 4\"\n }\n ]\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","X-Pagination-Per-Page":"50","Access-Control-Expose-Headers":"X-Pagination-Per-Page, X-Pagination-Current-Page, X-Pagination-Total-Pages, X-Pagination-Total-Entries","X-Pagination-Current-Page":"1","X-Pagination-Total-Pages":"1","X-Pagination-Total-Entries":"1","Content-Type":"application/json; charset=utf-8","ETag":"W/\"87b62d143d83f41cba1cdbfbc1b31ad5\"","X-Request-Id":"8b961567-9e01-43e1-895d-2c8f8a144fc1","X-Runtime":"0.093006","Content-Length":"320"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/tables?name=find_this_table\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer jU8DHVQ9u9iVY4AuRZkRNUIBUNPRn2r3aotpOoKki9A\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Tables","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/tables?schema=%25census%25","description":"filter tables by schema","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/tables?schema=%25census%25","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer vo8RbEl1ot6bVJXpG0vbsiPAezwsy5YbLyHC8JxN4Xo","Host":"api.civis.test","Cookie":""},"request_query_parameters":{"schema":"%census%"},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 198,\n \"databaseId\": 5,\n \"schema\": \"census_2010\",\n \"name\": \"table_name211\",\n \"description\": null,\n \"isView\": false,\n \"rowCount\": 1,\n \"columnCount\": 0,\n \"sizeMb\": null,\n \"owner\": \"dbadmin\",\n \"distkey\": null,\n \"sortkeys\": null,\n \"refreshStatus\": \"stale\",\n \"lastRefresh\": null,\n \"refreshId\": null,\n \"lastRun\": null,\n \"tableTags\": [\n\n ]\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","X-Pagination-Per-Page":"50","Access-Control-Expose-Headers":"X-Pagination-Per-Page, X-Pagination-Current-Page, X-Pagination-Total-Pages, X-Pagination-Total-Entries","X-Pagination-Current-Page":"1","X-Pagination-Total-Pages":"1","X-Pagination-Total-Entries":"1","Content-Type":"application/json; charset=utf-8","ETag":"W/\"730b757127525b841e11f1a86f80a5a1\"","X-Request-Id":"9bb86d97-4444-4cee-bc1f-2ae5b26b7b14","X-Runtime":"0.065590","Content-Length":"289"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/tables?schema=%25census%25\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer vo8RbEl1ot6bVJXpG0vbsiPAezwsy5YbLyHC8JxN4Xo\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Tables","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/tables","description":"filter tables by database","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/tables?database_id=5","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer Ec4A-_rSC8tkzRSczijfxzJM08ZlNOdHPVBd34Wep3c","Host":"api.civis.test","Cookie":""},"request_query_parameters":{"database_id":"5"},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 200,\n \"databaseId\": 5,\n \"schema\": \"schema_name\",\n \"name\": \"table_name215\",\n \"description\": null,\n \"isView\": false,\n \"rowCount\": 1,\n \"columnCount\": 0,\n \"sizeMb\": null,\n \"owner\": \"dbadmin\",\n \"distkey\": null,\n \"sortkeys\": null,\n \"refreshStatus\": \"stale\",\n \"lastRefresh\": null,\n \"refreshId\": null,\n \"lastRun\": null,\n \"tableTags\": [\n\n ]\n },\n {\n \"id\": 201,\n \"databaseId\": 5,\n \"schema\": \"schema_name\",\n \"name\": \"table_name216\",\n \"description\": null,\n \"isView\": false,\n \"rowCount\": 7,\n \"columnCount\": 2,\n \"sizeMb\": null,\n \"owner\": \"dbadmin\",\n \"distkey\": null,\n \"sortkeys\": null,\n \"refreshStatus\": \"stale\",\n \"lastRefresh\": null,\n \"refreshId\": null,\n \"lastRun\": null,\n \"tableTags\": [\n {\n \"id\": 6,\n \"name\": \"Table Tag 6\"\n }\n ]\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","X-Pagination-Per-Page":"50","Access-Control-Expose-Headers":"X-Pagination-Per-Page, X-Pagination-Current-Page, X-Pagination-Total-Pages, X-Pagination-Total-Entries","X-Pagination-Current-Page":"1","X-Pagination-Total-Pages":"1","X-Pagination-Total-Entries":"2","Content-Type":"application/json; charset=utf-8","ETag":"W/\"e0dac9594fd85e56ae008af2955a6698\"","X-Request-Id":"97268a70-b22f-4605-93a3-f101d3921cfb","X-Runtime":"0.068956","Content-Length":"606"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/tables?database_id=5\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer Ec4A-_rSC8tkzRSczijfxzJM08ZlNOdHPVBd34Wep3c\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/tables/{id}":{"get":{"summary":"Show basic table info","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object74"}}},"x-examples":[{"resource":"Tables","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/tables/:id","description":"View a table","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/tables/203","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer GPdK3RrDWkysMRTR0m_O71ehYqz5rxs3_y15Xq7OU94","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 203,\n \"databaseId\": 5,\n \"schema\": \"schema_name\",\n \"name\": \"table_name220\",\n \"description\": null,\n \"isView\": false,\n \"rowCount\": 7,\n \"columnCount\": 2,\n \"sizeMb\": null,\n \"owner\": \"dbadmin\",\n \"distkey\": null,\n \"sortkeys\": null,\n \"refreshStatus\": \"stale\",\n \"lastRefresh\": null,\n \"dataUpdatedAt\": \"2020-04-16T16:31:00.000Z\",\n \"schemaUpdatedAt\": \"2020-05-01T16:38:00.000Z\",\n \"refreshId\": null,\n \"lastRun\": null,\n \"primaryKeys\": [\n\n ],\n \"lastModifiedKeys\": [\n\n ],\n \"tableTags\": [\n {\n \"id\": 7,\n \"name\": \"Table Tag 7\"\n }\n ],\n \"ontologyMapping\": {\n },\n \"columns\": [\n {\n \"name\": \"snakes\",\n \"civisDataType\": \"string\",\n \"sqlType\": \"character varying(256)\",\n \"sampleValues\": [\n\n ],\n \"encoding\": null,\n \"description\": \"this is not a pipe\",\n \"order\": 1,\n \"minValue\": \"apple\",\n \"maxValue\": \"banana\",\n \"avgValue\": null,\n \"stddev\": null,\n \"valueDistributionPercent\": {\n \"apple\": 28.57142857142857,\n \"banana\": 57.14285714285714,\n \"null\": 14.285714285714285\n },\n \"coverageCount\": 7,\n \"nullCount\": 0,\n \"possibleDependentVariableTypes\": [\n \"multinomial\",\n \"ordinal\"\n ],\n \"useableAsIndependentVariable\": true,\n \"useableAsPrimaryKey\": false,\n \"valueDistribution\": {\n \"apple\": 2,\n \"banana\": 4,\n \"null\": 1\n },\n \"distinctCount\": 3\n },\n {\n \"name\": \"ladders\",\n \"civisDataType\": \"string\",\n \"sqlType\": \"character varying(256)\",\n \"sampleValues\": [\n\n ],\n \"encoding\": null,\n \"description\": \"this is not a pipe\",\n \"order\": 2,\n \"minValue\": null,\n \"maxValue\": null,\n \"avgValue\": null,\n \"stddev\": null,\n \"valueDistributionPercent\": {\n },\n \"coverageCount\": null,\n \"nullCount\": null,\n \"possibleDependentVariableTypes\": [\n\n ],\n \"useableAsIndependentVariable\": false,\n \"useableAsPrimaryKey\": false,\n \"valueDistribution\": {\n },\n \"distinctCount\": 0\n }\n ],\n \"joins\": [\n\n ],\n \"multipartKey\": [\n \"address_id\"\n ],\n \"enhancements\": [\n\n ],\n \"viewDef\": null,\n \"tableDef\": \"CREATE TABLE \\\"schema_name\\\".\\\"table_name220\\\" (\\n \\\"snakes\\\" CHARACTER VARYING(256) NULL,\\n \\\"ladders\\\" CHARACTER VARYING(256) NULL\\n)\\nDISTSTYLE AUTO;\\n\",\n \"outgoingTableMatches\": [\n\n ]\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"5e0347b8071ab250bb1d0ec7c521b31f\"","X-Request-Id":"e0fd33e2-32af-40f2-acae-bbd82d4e7dc7","X-Runtime":"0.062746","Content-Length":"1739"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/tables/203\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer GPdK3RrDWkysMRTR0m_O71ehYqz5rxs3_y15Xq7OU94\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"patch":{"summary":"Update a table","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the table.","type":"integer"},{"name":"Object676","in":"body","schema":{"$ref":"#/definitions/Object676"},"required":false}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object677"}}},"x-examples":[{"resource":"Tables","resource_explanation":null,"http_method":"PATCH","route":"http://api.civis.test/tables/:id","description":"Update a table via PATCH","explanation":null,"parameters":[{"required":false,"name":"ontologyMapping","description":"The ontology-key to column-name mapping. See /ontology for the list of valid ontology keys."},{"required":true,"name":"id","description":"The ID of the table."},{"required":false,"name":"description","description":"The user-defined description of the table."},{"required":false,"name":"primaryKeys","description":"A list of column(s) which together uniquely identify a row in the data.These columns must not contain NULL values."},{"required":false,"name":"lastModifiedKeys","description":"The columns indicating when a row was last modified."}],"response_fields":[],"requests":[{"request_method":"PATCH","request_path":"http://api.civis.test/tables/208","request_body":"{\n \"ontology_mapping\": {\n \"primary_key\": \"MyString\"\n },\n \"primary_keys\": [\n \"MyString\"\n ],\n \"last_modified_keys\": [\n \"MyString\"\n ],\n \"description\": \"Custom table description text.\"\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer owg_tN08VIg5bbSL7FdoE_2uJ66vyiR5hb9SZYydwmg","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 208,\n \"databaseId\": 285,\n \"schema\": \"schema_name\",\n \"name\": \"table_name231\",\n \"description\": \"Custom table description text.\",\n \"isView\": false,\n \"rowCount\": 1,\n \"columnCount\": 1,\n \"sizeMb\": null,\n \"owner\": \"dbadmin\",\n \"distkey\": null,\n \"sortkeys\": null,\n \"refreshStatus\": \"current\",\n \"lastRefresh\": null,\n \"dataUpdatedAt\": null,\n \"schemaUpdatedAt\": null,\n \"refreshId\": null,\n \"lastRun\": null,\n \"primaryKeys\": [\n \"MyString\"\n ],\n \"lastModifiedKeys\": [\n \"MyString\"\n ],\n \"tableTags\": [\n\n ],\n \"ontologyMapping\": {\n \"primary_key\": \"MyString\"\n }\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"3fec011eb8951ee45d5a4a9b62762cf2\"","X-Request-Id":"bd5e8d6e-43ec-4a9a-9b52-d01116469bc8","X-Runtime":"0.036777","Content-Length":"467"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/tables/208\" -d '{\"ontology_mapping\":{\"primary_key\":\"MyString\"},\"primary_keys\":[\"MyString\"],\"last_modified_keys\":[\"MyString\"],\"description\":\"Custom table description text.\"}' -X PATCH \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer owg_tN08VIg5bbSL7FdoE_2uJ66vyiR5hb9SZYydwmg\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Tables","resource_explanation":null,"http_method":"PATCH","route":"http://api.civis.test/tables/:id","description":"Map a column to multiple ontologies","explanation":null,"parameters":[{"required":false,"name":"ontologyMapping","description":"The ontology-key to column-name mapping. See /ontology for the list of valid ontology keys."},{"required":true,"name":"id","description":"The ID of the table."},{"required":false,"name":"description","description":"The user-defined description of the table."},{"required":false,"name":"primaryKeys","description":"A list of column(s) which together uniquely identify a row in the data.These columns must not contain NULL values."},{"required":false,"name":"lastModifiedKeys","description":"The columns indicating when a row was last modified."}],"response_fields":[],"requests":[{"request_method":"PATCH","request_path":"http://api.civis.test/tables/209","request_body":"{\n \"ontology_mapping\": {\n \"primary_key\": \"MyString\",\n \"first_name\": \"MyString\"\n }\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer J7lTGoRcBUY_ICZbPVeDTUYq4okNvsQSHntguvrFWS4","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 209,\n \"databaseId\": 286,\n \"schema\": \"schema_name\",\n \"name\": \"table_name232\",\n \"description\": null,\n \"isView\": false,\n \"rowCount\": 1,\n \"columnCount\": 1,\n \"sizeMb\": null,\n \"owner\": \"dbadmin\",\n \"distkey\": null,\n \"sortkeys\": null,\n \"refreshStatus\": \"current\",\n \"lastRefresh\": null,\n \"dataUpdatedAt\": null,\n \"schemaUpdatedAt\": null,\n \"refreshId\": null,\n \"lastRun\": null,\n \"primaryKeys\": [\n\n ],\n \"lastModifiedKeys\": [\n\n ],\n \"tableTags\": [\n\n ],\n \"ontologyMapping\": {\n \"primary_key\": \"MyString\",\n \"first_name\": \"MyString\"\n }\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"506e51ba45bf9e3002d80fedab0ea797\"","X-Request-Id":"5845d18f-5ba0-467d-aeb0-6699c8bfb3cd","X-Runtime":"0.033189","Content-Length":"443"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/tables/209\" -d '{\"ontology_mapping\":{\"primary_key\":\"MyString\",\"first_name\":\"MyString\"}}' -X PATCH \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer J7lTGoRcBUY_ICZbPVeDTUYq4okNvsQSHntguvrFWS4\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/tables/{id}/columns":{"get":{"summary":"List columns in the specified table","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"type":"integer"},{"name":"name","in":"query","required":false,"description":"Search for columns with the given name, within the specified table.","type":"string"},{"name":"limit","in":"query","required":false,"description":"Number of results to return. Defaults to its maximum of 50.","type":"integer"},{"name":"page_num","in":"query","required":false,"description":"Page number of the results to return. Defaults to the first page, 1.","type":"integer"},{"name":"order","in":"query","required":false,"description":"The field on which to order the result set. Defaults to name. Must be one of: name, order.","type":"string"},{"name":"order_dir","in":"query","required":false,"description":"Direction in which to sort, either asc (ascending) or desc (descending) defaulting to asc.","type":"string"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object77"}}}},"x-examples":[{"resource":"Tables","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/tables/:id/columns","description":"List columns","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/tables/205/columns","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer s6Ops-F_C4-hsJqareQw0OYxIILV4rL_DvHEF_pd9_o","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"name\": \"snakes\",\n \"civisDataType\": \"string\",\n \"sqlType\": \"character varying(256)\",\n \"sampleValues\": [\n\n ],\n \"encoding\": null,\n \"description\": \"this is not a pipe\",\n \"order\": 1,\n \"minValue\": \"apple\",\n \"maxValue\": \"banana\",\n \"avgValue\": null,\n \"stddev\": null,\n \"valueDistributionPercent\": {\n \"apple\": 28.57142857142857,\n \"banana\": 57.14285714285714,\n \"null\": 14.285714285714285\n },\n \"coverageCount\": 7,\n \"nullCount\": 0,\n \"possibleDependentVariableTypes\": [\n \"multinomial\",\n \"ordinal\"\n ],\n \"useableAsIndependentVariable\": true,\n \"useableAsPrimaryKey\": false,\n \"valueDistribution\": {\n \"apple\": 2,\n \"banana\": 4,\n \"null\": 1\n },\n \"distinctCount\": 3\n },\n {\n \"name\": \"ladders\",\n \"civisDataType\": \"string\",\n \"sqlType\": \"character varying(256)\",\n \"sampleValues\": [\n\n ],\n \"encoding\": null,\n \"description\": \"this is not a pipe\",\n \"order\": 2,\n \"minValue\": null,\n \"maxValue\": null,\n \"avgValue\": null,\n \"stddev\": null,\n \"valueDistributionPercent\": {\n },\n \"coverageCount\": null,\n \"nullCount\": null,\n \"possibleDependentVariableTypes\": [\n\n ],\n \"useableAsIndependentVariable\": false,\n \"useableAsPrimaryKey\": false,\n \"valueDistribution\": {\n },\n \"distinctCount\": 0\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","X-Pagination-Per-Page":"50","Access-Control-Expose-Headers":"X-Pagination-Per-Page, X-Pagination-Current-Page, X-Pagination-Total-Pages, X-Pagination-Total-Entries","X-Pagination-Current-Page":"1","X-Pagination-Total-Pages":"1","X-Pagination-Total-Entries":"2","Content-Type":"application/json; charset=utf-8","ETag":"W/\"c0a0e503fccc7c7d6f2cbf4ddf9a1c71\"","X-Request-Id":"51f544bd-f010-482f-a753-e17b17747659","X-Runtime":"0.037745","Content-Length":"990"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/tables/205/columns\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer s6Ops-F_C4-hsJqareQw0OYxIILV4rL_DvHEF_pd9_o\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Tables","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/tables/:id/columns?name=ladders","description":"Filter columns","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/tables/207/columns?name=ladders","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer wwVGRodYSSs3mT8Mies_MmUbHQB0Zer6vikllEfjFLk","Host":"api.civis.test","Cookie":""},"request_query_parameters":{"name":"ladders"},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"name\": \"ladders\",\n \"civisDataType\": \"string\",\n \"sqlType\": \"character varying(256)\",\n \"sampleValues\": [\n\n ],\n \"encoding\": null,\n \"description\": \"this is not a pipe\",\n \"order\": 2,\n \"minValue\": null,\n \"maxValue\": null,\n \"avgValue\": null,\n \"stddev\": null,\n \"valueDistributionPercent\": {\n },\n \"coverageCount\": null,\n \"nullCount\": null,\n \"possibleDependentVariableTypes\": [\n\n ],\n \"useableAsIndependentVariable\": false,\n \"useableAsPrimaryKey\": false,\n \"valueDistribution\": {\n },\n \"distinctCount\": 0\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","X-Pagination-Per-Page":"50","Access-Control-Expose-Headers":"X-Pagination-Per-Page, X-Pagination-Current-Page, X-Pagination-Total-Pages, X-Pagination-Total-Entries","X-Pagination-Current-Page":"1","X-Pagination-Total-Pages":"1","X-Pagination-Total-Entries":"1","Content-Type":"application/json; charset=utf-8","ETag":"W/\"f9fac11c115beeeb2477dc0c62a677ab\"","X-Request-Id":"1e0a8079-9cd7-4398-8461-ed5aff43f1fd","X-Runtime":"0.030280","Content-Length":"431"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/tables/207/columns?name=ladders\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer wwVGRodYSSs3mT8Mies_MmUbHQB0Zer6vikllEfjFLk\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/tables/{id}/tags/{table_tag_id}":{"put":{"summary":"Add a tag to a table","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the table.","type":"integer"},{"name":"table_tag_id","in":"path","required":true,"description":"The ID of the tag.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object678"}}},"x-examples":[{"resource":"Tables","resource_explanation":null,"http_method":"PUT","route":"http://api.civis.test/tables/:id/tags/:table_tag_id","description":"Add a tag to a table","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"PUT","request_path":"http://api.civis.test/tables/221/tags/16","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer GI1fRnOteX6zdBYrvCfJ9ZgPLjIUIkuMk3dJl4IiOPw","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 221,\n \"tableTagId\": 16\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"fe6dcf164d11b3a6f9f5aaccff1e457f\"","X-Request-Id":"b4bb9b35-4052-460e-a7c7-729064f31edb","X-Runtime":"0.043556","Content-Length":"26"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/tables/221/tags/16\" -d '' -X PUT \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer GI1fRnOteX6zdBYrvCfJ9ZgPLjIUIkuMk3dJl4IiOPw\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"delete":{"summary":"Add a tag to a table","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the table.","type":"integer"},{"name":"table_tag_id","in":"path","required":true,"description":"The ID of the tag.","type":"integer"}],"responses":{"200":{"description":"success"}},"x-examples":[{"resource":"Tables","resource_explanation":null,"http_method":"DELETE","route":"http://api.civis.test/tables/:id/tags/:table_tag_id","description":"Remove a tag from a table","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"DELETE","request_path":"http://api.civis.test/tables/222/tags/18","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer ImlYbEc2vqFA4ophrEgrQ-v9cZKpFiHCMGc6JyZPyak","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":null,"response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"text/plain; charset=utf-8","X-Request-Id":"3e03f43f-a325-40b3-aa69-17ae51d87939","X-Runtime":"0.036939","Content-Length":"0"},"response_content_type":"text/plain; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/tables/222/tags/18\" -d '' -X DELETE \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer ImlYbEc2vqFA4ophrEgrQ-v9cZKpFiHCMGc6JyZPyak\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/tables/{id}/projects":{"get":{"summary":"List the projects a Table belongs to","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Table.","type":"integer"},{"name":"hidden","in":"query","required":false,"description":"If specified to be true, returns hidden items. Defaults to false, returning non-hidden items.","type":"boolean"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object85"}}}},"x-examples":null,"x-deprecation-warning":null}},"/tables/{id}/projects/{project_id}":{"put":{"summary":"Add a Table to a project","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Table.","type":"integer"},{"name":"project_id","in":"path","required":true,"description":"The ID of the project.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null},"delete":{"summary":"Remove a Table from a project","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Table.","type":"integer"},{"name":"project_id","in":"path","required":true,"description":"The ID of the project.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/templates/reports/{id}/shares":{"get":{"summary":"List users and groups permissioned on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object9"}}}},"x-examples":null,"x-deprecation-warning":null}},"/templates/reports/{id}/shares/users":{"put":{"summary":"Set the permissions users have on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"Object679","in":"body","schema":{"$ref":"#/definitions/Object679"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object9"}}},"x-examples":null,"x-deprecation-warning":null}},"/templates/reports/{id}/shares/users/{user_id}":{"delete":{"summary":"Revoke the permissions a user has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"user_id","in":"path","required":true,"description":"The ID of the user.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/templates/reports/{id}/shares/groups":{"put":{"summary":"Set the permissions groups has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"Object680","in":"body","schema":{"$ref":"#/definitions/Object680"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object9"}}},"x-examples":null,"x-deprecation-warning":null}},"/templates/reports/{id}/shares/groups/{group_id}":{"delete":{"summary":"Revoke the permissions a group has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"group_id","in":"path","required":true,"description":"The ID of the group.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/templates/reports/{id}/dependencies":{"get":{"summary":"List dependent objects for this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"user_id","in":"query","required":false,"description":"ID of target user","type":"integer"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object15"}}}},"x-examples":null,"x-deprecation-warning":null}},"/templates/reports/{id}/transfer":{"put":{"summary":"Transfer ownership of this object to another user","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"Object681","in":"body","schema":{"$ref":"#/definitions/Object681"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object17"}}},"x-examples":null,"x-deprecation-warning":null}},"/templates/reports/":{"get":{"summary":"List Report Templates","description":null,"deprecated":false,"parameters":[{"name":"hidden","in":"query","required":false,"description":"If specified to be true, returns hidden items. Defaults to false, returning non-hidden items.","type":"boolean"},{"name":"author","in":"query","required":false,"description":"If specified, return items from any of these authors. It accepts a comma-separated list of user IDs.","type":"string"},{"name":"category","in":"query","required":false,"description":"A category to filter results by, one of: dataset-viz","type":"string"},{"name":"limit","in":"query","required":false,"description":"Number of results to return. Defaults to 50. Maximum allowed is 1000.","type":"integer"},{"name":"page_num","in":"query","required":false,"description":"Page number of the results to return. Defaults to the first page, 1.","type":"integer"},{"name":"order","in":"query","required":false,"description":"The field on which to order the result set. Defaults to name. Must be one of: name, updated_at, created_at.","type":"string"},{"name":"order_dir","in":"query","required":false,"description":"Direction in which to sort, either asc (ascending) or desc (descending) defaulting to asc.","type":"string"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object682"}}}},"x-examples":[{"resource":"Template::Report","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/templates/reports","description":"List all templates","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/templates/reports","request_body":null,"request_headers":{"Content-Type":"application/json","Authorization":"Bearer XYCNnLSK_dJ5m1EAXU26j7hoUQZU9PyPTwuWCAsIHuo","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 167,\n \"name\": \"awesome HTML template\",\n \"category\": null,\n \"createdAt\": \"2016-01-01T00:00:00.000Z\",\n \"updatedAt\": \"2023-07-18T18:46:26.000Z\",\n \"useCount\": 0,\n \"archived\": false,\n \"techReviewed\": false,\n \"author\": {\n \"id\": 4584,\n \"name\": \"Manager devmanagerfactory1 1\",\n \"username\": \"devmanagerfactory1\",\n \"initials\": \"MD\",\n \"online\": null\n }\n },\n {\n \"id\": 168,\n \"name\": \"awesome HTML template\",\n \"category\": \"dataset-viz\",\n \"createdAt\": \"2016-02-01T00:00:00.000Z\",\n \"updatedAt\": \"2023-07-18T18:46:26.000Z\",\n \"useCount\": 0,\n \"archived\": false,\n \"techReviewed\": false,\n \"author\": {\n \"id\": 4584,\n \"name\": \"Manager devmanagerfactory1 1\",\n \"username\": \"devmanagerfactory1\",\n \"initials\": \"MD\",\n \"online\": null\n }\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","X-Pagination-Per-Page":"50","Access-Control-Expose-Headers":"X-Pagination-Per-Page, X-Pagination-Current-Page, X-Pagination-Total-Pages, X-Pagination-Total-Entries","X-Pagination-Current-Page":"1","X-Pagination-Total-Pages":"1","X-Pagination-Total-Entries":"2","Content-Type":"application/json; charset=utf-8","ETag":"W/\"c7b5d7634e7307c1d6acd75e1b447840\"","X-Request-Id":"df8fd844-b6d4-4552-adc1-423799c4344c","X-Runtime":"0.019160","Content-Length":"626"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/templates/reports\" -X GET \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer XYCNnLSK_dJ5m1EAXU26j7hoUQZU9PyPTwuWCAsIHuo\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Template::Report","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/templates/reports?category=dataset-viz","description":"List all dataset-viz templates","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/templates/reports?category=dataset-viz","request_body":null,"request_headers":{"Content-Type":"application/json","Authorization":"Bearer Xk_jHKBTegbrEjg0Pu3myS9YJDO4HBWKDMokdaz2aB4","Host":"api.civis.test","Cookie":""},"request_query_parameters":{"category":"dataset-viz"},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 169,\n \"name\": \"awesome HTML template\",\n \"category\": \"dataset-viz\",\n \"createdAt\": \"2016-02-01T00:00:00.000Z\",\n \"updatedAt\": \"2023-07-18T18:46:26.000Z\",\n \"useCount\": 0,\n \"archived\": false,\n \"techReviewed\": false,\n \"author\": {\n \"id\": 4585,\n \"name\": \"Manager devmanagerfactory2 2\",\n \"username\": \"devmanagerfactory2\",\n \"initials\": \"MD\",\n \"online\": null\n }\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","X-Pagination-Per-Page":"50","Access-Control-Expose-Headers":"X-Pagination-Per-Page, X-Pagination-Current-Page, X-Pagination-Total-Pages, X-Pagination-Total-Entries","X-Pagination-Current-Page":"1","X-Pagination-Total-Pages":"1","X-Pagination-Total-Entries":"1","Content-Type":"application/json; charset=utf-8","ETag":"W/\"154c6afd59a2d1c12ba68bacbfa6ed1d\"","X-Request-Id":"a2ed4578-7821-489f-ae4b-15a5c5d0bd2d","X-Runtime":"0.015982","Content-Length":"318"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/templates/reports?category=dataset-viz\" -X GET \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer Xk_jHKBTegbrEjg0Pu3myS9YJDO4HBWKDMokdaz2aB4\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"post":{"summary":"Create a Report Template","description":null,"deprecated":false,"parameters":[{"name":"Object683","in":"body","schema":{"$ref":"#/definitions/Object683"},"required":true}],"responses":{"201":{"description":"success","schema":{"$ref":"#/definitions/Object684"}}},"x-examples":[{"resource":"Template::Report","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/templates/reports","description":"Create a report template","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/templates/reports","request_body":"{\n \"code_body\": \"Report HTML\",\n \"name\": \"My new Report Template\"\n}","request_headers":{"Content-Type":"application/json","Authorization":"Bearer 4BVYAYHKsAhqub8Qx_IVsnxPjrAOrvEWTzOJnbRh_II","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":201,"response_status_text":"Created","response_body":"{\n \"id\": 170,\n \"name\": \"My new Report Template\",\n \"category\": null,\n \"createdAt\": \"2023-07-18T18:46:26.000Z\",\n \"updatedAt\": \"2023-07-18T18:46:26.000Z\",\n \"useCount\": 0,\n \"archived\": false,\n \"techReviewed\": false,\n \"author\": {\n \"id\": 4586,\n \"name\": \"Manager devmanagerfactory3 3\",\n \"username\": \"devmanagerfactory3\",\n \"initials\": \"MD\",\n \"online\": null\n },\n \"authCodeUrl\": \"auth_code_url\",\n \"provideAPIKey\": null,\n \"hidden\": false\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"5bee4f780214066ce954173b44690872\"","X-Request-Id":"3d2c7678-4448-47a9-b6b7-ed960140500e","X-Runtime":"0.281233","Content-Length":"374"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/templates/reports\" -d '{\"code_body\":\"\\u003cbody\\u003eReport HTML\\u003c/body\\u003e\",\"name\":\"My new Report Template\"}' -X POST \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer 4BVYAYHKsAhqub8Qx_IVsnxPjrAOrvEWTzOJnbRh_II\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/templates/reports/{id}":{"get":{"summary":"Get a Report Template","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object684"}}},"x-examples":[{"resource":"Template::Report","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/templates/reports/:id","description":"Show details of a report","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/templates/reports/175","request_body":null,"request_headers":{"Content-Type":"application/json","Authorization":"Bearer QUAbYLDdDkbyYINkH3lhrYakiElMlv7SKtKynFHTZmU","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 175,\n \"name\": \"awesome HTML template\",\n \"category\": null,\n \"createdAt\": \"2016-01-01T00:00:00.000Z\",\n \"updatedAt\": \"2023-07-18T18:46:28.000Z\",\n \"useCount\": 0,\n \"archived\": false,\n \"techReviewed\": false,\n \"author\": {\n \"id\": 4591,\n \"name\": \"Manager devmanagerfactory8 8\",\n \"username\": \"devmanagerfactory8\",\n \"initials\": \"MD\",\n \"online\": null\n },\n \"authCodeUrl\": \"auth_code_url\",\n \"provideAPIKey\": null,\n \"hidden\": false\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"ba9737618562644ca0d87bf7435400af\"","X-Request-Id":"2c2f017b-e3d1-425c-8e93-190e801cfd11","X-Runtime":"0.015639","Content-Length":"373"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/templates/reports/175\" -X GET \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer QUAbYLDdDkbyYINkH3lhrYakiElMlv7SKtKynFHTZmU\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"put":{"summary":"Replace all attributes of this Report Template","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"type":"integer"},{"name":"Object685","in":"body","schema":{"$ref":"#/definitions/Object685"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object684"}}},"x-examples":null,"x-deprecation-warning":null},"patch":{"summary":"Update some attributes of this Report Template","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"type":"integer"},{"name":"Object686","in":"body","schema":{"$ref":"#/definitions/Object686"},"required":false}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object684"}}},"x-examples":[{"resource":"Template::Report","resource_explanation":null,"http_method":"PATCH","route":"http://api.civis.test/templates/reports/:id","description":"Update a report template","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"PATCH","request_path":"http://api.civis.test/templates/reports/171","request_body":"{\n \"code_body\": \"Updated Report template body\",\n \"name\": \"My updated Report Template\"\n}","request_headers":{"Content-Type":"application/json","Authorization":"Bearer lrN34GNLaph2HtHTshT8oLHvQJuXeepXanVi09GhFXg","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 171,\n \"name\": \"My updated Report Template\",\n \"category\": null,\n \"createdAt\": \"2016-01-01T00:00:00.000Z\",\n \"updatedAt\": \"2023-07-18T18:46:27.000Z\",\n \"useCount\": 0,\n \"archived\": false,\n \"techReviewed\": false,\n \"author\": {\n \"id\": 4587,\n \"name\": \"Manager devmanagerfactory4 4\",\n \"username\": \"devmanagerfactory4\",\n \"initials\": \"MD\",\n \"online\": null\n },\n \"authCodeUrl\": \"auth_code_url\",\n \"provideAPIKey\": null,\n \"hidden\": false\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"1774fce90e110b2f807b3e8dcf9aafe2\"","X-Request-Id":"c49a5b14-8a56-48fe-9ad4-fc2630693330","X-Runtime":"0.099149","Content-Length":"378"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/templates/reports/171\" -d '{\"code_body\":\"\\u003cbody\\u003eUpdated Report template body\\u003c/body\\u003e\",\"name\":\"My updated Report Template\"}' -X PATCH \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer lrN34GNLaph2HtHTshT8oLHvQJuXeepXanVi09GhFXg\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Template::Report","resource_explanation":null,"http_method":"PATCH","route":"http://api.civis.test/templates/reports/:id","description":"Update a report template with invalid category","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"PATCH","request_path":"http://api.civis.test/templates/reports/172","request_body":"{\n \"code_body\": \"Updated Report template body\",\n \"name\": \"My updated Report Template\",\n \"category\": \"invalid\"\n}","request_headers":{"Content-Type":"application/json","Authorization":"Bearer TA-vjrhXEbhxO1kDiABXkE76zEhin1wuK3Rvii2cxHU","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":400,"response_status_text":"Bad Request","response_body":"{\n \"error\": \"bad_request\",\n \"errorDescription\": \"The given request was not as expected: Validation failed: Category is not included in the list\",\n \"code\": 400\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","X-Request-Id":"50457196-8e6d-429b-8a96-8c0467952ccd","X-Runtime":"0.015771","Content-Length":"150"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/templates/reports/172\" -d '{\"code_body\":\"\\u003cbody\\u003eUpdated Report template body\\u003c/body\\u003e\",\"name\":\"My updated Report Template\",\"category\":\"invalid\"}' -X PATCH \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer TA-vjrhXEbhxO1kDiABXkE76zEhin1wuK3Rvii2cxHU\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Template::Report","resource_explanation":null,"http_method":"PATCH","route":"http://api.civis.test/templates/reports/:id","description":"Archive a report template","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"PATCH","request_path":"http://api.civis.test/templates/reports/173","request_body":"{\n \"archived\": true\n}","request_headers":{"Content-Type":"application/json","Authorization":"Bearer x0bbidOO4HhemYiw8R2SKQgJbBxudTFoFVSatJSwLVY","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 173,\n \"name\": \"awesome HTML template\",\n \"category\": null,\n \"createdAt\": \"2016-01-01T00:00:00.000Z\",\n \"updatedAt\": \"2023-07-18T18:46:27.000Z\",\n \"useCount\": 0,\n \"archived\": true,\n \"techReviewed\": false,\n \"author\": {\n \"id\": 4589,\n \"name\": \"Manager devmanagerfactory6 6\",\n \"username\": \"devmanagerfactory6\",\n \"initials\": \"MD\",\n \"online\": null\n },\n \"authCodeUrl\": \"auth_code_url\",\n \"provideAPIKey\": null,\n \"hidden\": false\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"4e8f6867085f9b60fe2acf1bbd3c2168\"","X-Request-Id":"85cbdec2-0e86-423a-8813-4d0036e5e009","X-Runtime":"0.026794","Content-Length":"372"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/templates/reports/173\" -d '{\"archived\":true}' -X PATCH \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer x0bbidOO4HhemYiw8R2SKQgJbBxudTFoFVSatJSwLVY\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Template::Report","resource_explanation":null,"http_method":"PATCH","route":"http://api.civis.test/templates/reports/:id","description":"Unarchive a report template","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"PATCH","request_path":"http://api.civis.test/templates/reports/174","request_body":"{\n \"archived\": false\n}","request_headers":{"Content-Type":"application/json","Authorization":"Bearer LgvtT63TVIhamIBMycXAA1AqMXpx7DA7D7hm3m9KsSc","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 174,\n \"name\": \"awesome HTML template\",\n \"category\": null,\n \"createdAt\": \"2016-01-01T00:00:00.000Z\",\n \"updatedAt\": \"2023-07-18T18:46:27.000Z\",\n \"useCount\": 0,\n \"archived\": false,\n \"techReviewed\": false,\n \"author\": {\n \"id\": 4590,\n \"name\": \"Manager devmanagerfactory7 7\",\n \"username\": \"devmanagerfactory7\",\n \"initials\": \"MD\",\n \"online\": null\n },\n \"authCodeUrl\": \"auth_code_url\",\n \"provideAPIKey\": null,\n \"hidden\": false\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"24c74d86bca400fd0d47037737133deb\"","X-Request-Id":"96042f19-7275-404e-9c94-f1d63670d77c","X-Runtime":"0.026899","Content-Length":"373"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/templates/reports/174\" -d '{\"archived\":false}' -X PATCH \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer LgvtT63TVIhamIBMycXAA1AqMXpx7DA7D7hm3m9KsSc\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"delete":{"summary":"Archive a Report Template (deprecated, use archiving endpoints instead)","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/templates/scripts/{id}/shares":{"get":{"summary":"List users and groups permissioned on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object9"}}}},"x-examples":null,"x-deprecation-warning":null}},"/templates/scripts/{id}/shares/users":{"put":{"summary":"Set the permissions users have on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"Object688","in":"body","schema":{"$ref":"#/definitions/Object688"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object9"}}},"x-examples":null,"x-deprecation-warning":null}},"/templates/scripts/{id}/shares/users/{user_id}":{"delete":{"summary":"Revoke the permissions a user has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"user_id","in":"path","required":true,"description":"The ID of the user.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/templates/scripts/{id}/shares/groups":{"put":{"summary":"Set the permissions groups has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"Object689","in":"body","schema":{"$ref":"#/definitions/Object689"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object9"}}},"x-examples":null,"x-deprecation-warning":null}},"/templates/scripts/{id}/shares/groups/{group_id}":{"delete":{"summary":"Revoke the permissions a group has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"group_id","in":"path","required":true,"description":"The ID of the group.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/templates/scripts/{id}/dependencies":{"get":{"summary":"List dependent objects for this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"user_id","in":"query","required":false,"description":"ID of target user","type":"integer"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object15"}}}},"x-examples":null,"x-deprecation-warning":null}},"/templates/scripts/{id}/transfer":{"put":{"summary":"Transfer ownership of this object to another user","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"Object690","in":"body","schema":{"$ref":"#/definitions/Object690"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object17"}}},"x-examples":null,"x-deprecation-warning":null}},"/templates/scripts/{id}/projects":{"get":{"summary":"List the projects a Script Template belongs to","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Script Template.","type":"integer"},{"name":"hidden","in":"query","required":false,"description":"If specified to be true, returns hidden items. Defaults to false, returning non-hidden items.","type":"boolean"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object85"}}}},"x-examples":null,"x-deprecation-warning":null}},"/templates/scripts/{id}/projects/{project_id}":{"put":{"summary":"Add a Script Template to a project","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Script Template.","type":"integer"},{"name":"project_id","in":"path","required":true,"description":"The ID of the project.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null},"delete":{"summary":"Remove a Script Template from a project","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Script Template.","type":"integer"},{"name":"project_id","in":"path","required":true,"description":"The ID of the project.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/templates/scripts/":{"get":{"summary":"List Script Templates","description":null,"deprecated":false,"parameters":[{"name":"hidden","in":"query","required":false,"description":"If specified to be true, returns hidden items. Defaults to false, returning non-hidden items.","type":"boolean"},{"name":"author","in":"query","required":false,"description":"If specified, return items from any of these authors. It accepts a comma-separated list of user IDs.","type":"string"},{"name":"category","in":"query","required":false,"description":"A category to filter results by, one of: import, export, enhancement, model, and script","type":"string"},{"name":"limit","in":"query","required":false,"description":"Number of results to return. Defaults to 50. Maximum allowed is 1000.","type":"integer"},{"name":"page_num","in":"query","required":false,"description":"Page number of the results to return. Defaults to the first page, 1.","type":"integer"},{"name":"order","in":"query","required":false,"description":"The field on which to order the result set. Defaults to name. Must be one of: name, updated_at, created_at.","type":"string"},{"name":"order_dir","in":"query","required":false,"description":"Direction in which to sort, either asc (ascending) or desc (descending) defaulting to asc.","type":"string"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object691"}}}},"x-examples":[{"resource":"Template::Script","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/templates/scripts","description":"List all templates","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/templates/scripts","request_body":null,"request_headers":{"Content-Type":"application/json","Authorization":"Bearer RR4qrANSa0iTABK5HQLJr0fLyhpdh7ULtFWoSxeQkdw","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 177,\n \"public\": false,\n \"scriptId\": 3256,\n \"userContext\": \"runner\",\n \"name\": \"awesome sql template\",\n \"category\": \"script\",\n \"createdAt\": \"2023-07-18T18:46:29.000Z\",\n \"updatedAt\": \"2023-07-18T18:46:29.000Z\",\n \"useCount\": 0,\n \"uiReportId\": null,\n \"techReviewed\": false,\n \"archived\": false,\n \"author\": {\n \"id\": 4594,\n \"name\": \"User devuserfactory3091 3089\",\n \"username\": \"devuserfactory3091\",\n \"initials\": \"UD\",\n \"online\": null\n }\n },\n {\n \"id\": 179,\n \"public\": false,\n \"scriptId\": 3272,\n \"userContext\": \"runner\",\n \"name\": \"awesome sql template\",\n \"category\": \"import\",\n \"createdAt\": \"2023-07-18T18:46:30.000Z\",\n \"updatedAt\": \"2023-07-18T18:46:30.000Z\",\n \"useCount\": 0,\n \"uiReportId\": null,\n \"techReviewed\": false,\n \"archived\": false,\n \"author\": {\n \"id\": 4594,\n \"name\": \"User devuserfactory3091 3089\",\n \"username\": \"devuserfactory3091\",\n \"initials\": \"UD\",\n \"online\": null\n }\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","X-Pagination-Per-Page":"50","Access-Control-Expose-Headers":"X-Pagination-Per-Page, X-Pagination-Current-Page, X-Pagination-Total-Pages, X-Pagination-Total-Entries","X-Pagination-Current-Page":"1","X-Pagination-Total-Pages":"1","X-Pagination-Total-Entries":"2","Content-Type":"application/json; charset=utf-8","ETag":"W/\"cd816299653e31dc239bc225762d37a6\"","X-Request-Id":"34b14964-ae4c-4284-a31f-12051d785c81","X-Runtime":"0.023030","Content-Length":"767"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/templates/scripts\" -X GET \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer RR4qrANSa0iTABK5HQLJr0fLyhpdh7ULtFWoSxeQkdw\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Template::Script","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/templates/scripts","description":"Filter templates by category","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/templates/scripts?category=import","request_body":null,"request_headers":{"Content-Type":"application/json","Authorization":"Bearer b7n8iXZFKHgLdQRizyEAd8D3912FHHqBXY3W5Exy138","Host":"api.civis.test","Cookie":""},"request_query_parameters":{"category":"import"},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 182,\n \"public\": false,\n \"scriptId\": 3295,\n \"userContext\": \"runner\",\n \"name\": \"awesome sql template\",\n \"category\": \"import\",\n \"createdAt\": \"2023-07-18T18:46:32.000Z\",\n \"updatedAt\": \"2023-07-18T18:46:32.000Z\",\n \"useCount\": 0,\n \"uiReportId\": null,\n \"techReviewed\": false,\n \"archived\": false,\n \"author\": {\n \"id\": 4616,\n \"name\": \"User devuserfactory3106 3104\",\n \"username\": \"devuserfactory3106\",\n \"initials\": \"UD\",\n \"online\": null\n }\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","X-Pagination-Per-Page":"50","Access-Control-Expose-Headers":"X-Pagination-Per-Page, X-Pagination-Current-Page, X-Pagination-Total-Pages, X-Pagination-Total-Entries","X-Pagination-Current-Page":"1","X-Pagination-Total-Pages":"1","X-Pagination-Total-Entries":"1","Content-Type":"application/json; charset=utf-8","ETag":"W/\"b63f1005ff9112312696d2ce5711bcd9\"","X-Request-Id":"762522de-e2b2-44c7-8c05-e00f193ab9f7","X-Runtime":"0.019328","Content-Length":"384"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/templates/scripts?category=import\" -X GET \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer b7n8iXZFKHgLdQRizyEAd8D3912FHHqBXY3W5Exy138\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"post":{"summary":"Create a Script Template","description":null,"deprecated":false,"parameters":[{"name":"Object692","in":"body","schema":{"$ref":"#/definitions/Object692"},"required":true}],"responses":{"201":{"description":"success","schema":{"$ref":"#/definitions/Object693"}}},"x-examples":[{"resource":"Template::Script","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/templates/scripts","description":"Create a script template","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/templates/scripts","request_body":"{\n \"script_id\": 3315,\n \"name\": \"Script #3315\"\n}","request_headers":{"Content-Type":"application/json","Authorization":"Bearer d8K_u-QaG7nKWyihMvPe7I9Vcq3lNbKvdvUAAVxIlUI","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":201,"response_status_text":"Created","response_body":"{\n \"id\": 185,\n \"public\": false,\n \"scriptId\": 3315,\n \"scriptType\": \"R\",\n \"userContext\": \"runner\",\n \"params\": [\n {\n \"name\": \"id\",\n \"label\": \"ID\",\n \"description\": null,\n \"type\": \"integer\",\n \"required\": true,\n \"value\": null,\n \"default\": null,\n \"allowedValues\": [\n\n ]\n },\n {\n \"name\": \"state\",\n \"label\": \"State\",\n \"description\": null,\n \"type\": \"string\",\n \"required\": true,\n \"value\": null,\n \"default\": null,\n \"allowedValues\": [\n\n ]\n },\n {\n \"name\": \"a_multi_line_string\",\n \"label\": \"A Multi-line String\",\n \"description\": null,\n \"type\": \"multi_line_string\",\n \"required\": false,\n \"value\": null,\n \"default\": null,\n \"allowedValues\": [\n\n ]\n },\n {\n \"name\": \"abool\",\n \"label\": \"A Bool\",\n \"description\": null,\n \"type\": \"bool\",\n \"required\": false,\n \"value\": null,\n \"default\": false,\n \"allowedValues\": [\n\n ]\n },\n {\n \"name\": \"afloat\",\n \"label\": \"A Float\",\n \"description\": null,\n \"type\": \"float\",\n \"required\": false,\n \"value\": null,\n \"default\": null,\n \"allowedValues\": [\n\n ]\n },\n {\n \"name\": \"optionalstr\",\n \"label\": \"Optional String\",\n \"description\": null,\n \"type\": \"string\",\n \"required\": false,\n \"value\": null,\n \"default\": null,\n \"allowedValues\": [\n\n ]\n },\n {\n \"name\": \"cred\",\n \"label\": \"Cred\",\n \"description\": null,\n \"type\": \"credential_redshift\",\n \"required\": false,\n \"value\": null,\n \"default\": null,\n \"allowedValues\": [\n\n ]\n }\n ],\n \"name\": \"Script #3315\",\n \"category\": \"script\",\n \"note\": null,\n \"createdAt\": \"2023-07-18T18:46:33.000Z\",\n \"updatedAt\": \"2023-07-18T18:46:33.000Z\",\n \"useCount\": 0,\n \"uiReportId\": null,\n \"techReviewed\": false,\n \"archived\": false,\n \"hidden\": false,\n \"author\": {\n \"id\": 4638,\n \"name\": \"User devuserfactory3121 3119\",\n \"username\": \"devuserfactory3121\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"myPermissionLevel\": \"manage\"\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"4da20f0f61a283543cf2f263a031bf88\"","X-Request-Id":"68eb6b15-eb49-4d1e-a194-60107f719e71","X-Runtime":"0.038655","Content-Length":"1443"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/templates/scripts\" -d '{\"script_id\":3315,\"name\":\"Script #3315\"}' -X POST \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer d8K_u-QaG7nKWyihMvPe7I9Vcq3lNbKvdvUAAVxIlUI\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/templates/scripts/{id}":{"get":{"summary":"Get a Script Template","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object693"}}},"x-examples":null,"x-deprecation-warning":null},"put":{"summary":"Replace all attributes of this Script Template","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"type":"integer"},{"name":"Object694","in":"body","schema":{"$ref":"#/definitions/Object694"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object693"}}},"x-examples":null,"x-deprecation-warning":null},"patch":{"summary":"Update some attributes of this Script Template","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"type":"integer"},{"name":"Object695","in":"body","schema":{"$ref":"#/definitions/Object695"},"required":false}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object693"}}},"x-examples":[{"resource":"Template::Script","resource_explanation":null,"http_method":"PATCH","route":"http://api.civis.test/templates/scripts/:id","description":"Archive a script template","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"PATCH","request_path":"http://api.civis.test/templates/scripts/186","request_body":"{\n \"archived\": true\n}","request_headers":{"Content-Type":"application/json","Authorization":"Bearer yJs2SbKkQVsm-L0SjBIc4MVhS6ts1Dn0SpploC0syTg","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 186,\n \"public\": false,\n \"scriptId\": 3318,\n \"scriptType\": \"Python\",\n \"userContext\": \"runner\",\n \"params\": [\n {\n \"name\": \"id\",\n \"label\": \"ID\",\n \"description\": null,\n \"type\": \"integer\",\n \"required\": true,\n \"value\": null,\n \"default\": null,\n \"allowedValues\": [\n\n ]\n },\n {\n \"name\": \"state\",\n \"label\": \"State\",\n \"description\": null,\n \"type\": \"string\",\n \"required\": true,\n \"value\": null,\n \"default\": null,\n \"allowedValues\": [\n\n ]\n },\n {\n \"name\": \"a_multi_line_string\",\n \"label\": \"A Multi-line String\",\n \"description\": null,\n \"type\": \"multi_line_string\",\n \"required\": false,\n \"value\": null,\n \"default\": null,\n \"allowedValues\": [\n\n ]\n },\n {\n \"name\": \"abool\",\n \"label\": \"A Bool\",\n \"description\": null,\n \"type\": \"bool\",\n \"required\": false,\n \"value\": null,\n \"default\": false,\n \"allowedValues\": [\n\n ]\n },\n {\n \"name\": \"afloat\",\n \"label\": \"A Float\",\n \"description\": null,\n \"type\": \"float\",\n \"required\": false,\n \"value\": null,\n \"default\": null,\n \"allowedValues\": [\n\n ]\n },\n {\n \"name\": \"optionalstr\",\n \"label\": \"Optional String\",\n \"description\": null,\n \"type\": \"string\",\n \"required\": false,\n \"value\": null,\n \"default\": null,\n \"allowedValues\": [\n\n ]\n },\n {\n \"name\": \"cred\",\n \"label\": \"Cred\",\n \"description\": null,\n \"type\": \"credential_redshift\",\n \"required\": false,\n \"value\": null,\n \"default\": null,\n \"allowedValues\": [\n\n ]\n }\n ],\n \"name\": \"awesome sql template\",\n \"category\": \"script\",\n \"note\": null,\n \"createdAt\": \"2023-07-18T18:46:34.000Z\",\n \"updatedAt\": \"2023-07-18T18:46:34.000Z\",\n \"useCount\": 0,\n \"uiReportId\": null,\n \"techReviewed\": false,\n \"archived\": true,\n \"hidden\": false,\n \"author\": {\n \"id\": 4653,\n \"name\": \"User devuserfactory3132 3130\",\n \"username\": \"devuserfactory3132\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"myPermissionLevel\": \"manage\"\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"91656128b9ffc3d9374997f7a1583a37\"","X-Request-Id":"d61f7e6d-fb53-44bc-8a59-ed93e4f9b4e0","X-Runtime":"0.043112","Content-Length":"1455"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/templates/scripts/186\" -d '{\"archived\":true}' -X PATCH \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer yJs2SbKkQVsm-L0SjBIc4MVhS6ts1Dn0SpploC0syTg\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Template::Script","resource_explanation":null,"http_method":"PATCH","route":"http://api.civis.test/templates/scripts/:id","description":"Unarchive a script template","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"PATCH","request_path":"http://api.civis.test/templates/scripts/189","request_body":"{\n \"archived\": false\n}","request_headers":{"Content-Type":"application/json","Authorization":"Bearer fuEuAu-WvCJGp9QJAKGIE5RjC2QjXcAM5RJ6f9PSfDQ","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 189,\n \"public\": false,\n \"scriptId\": 3344,\n \"scriptType\": \"Python\",\n \"userContext\": \"runner\",\n \"params\": [\n {\n \"name\": \"id\",\n \"label\": \"ID\",\n \"description\": null,\n \"type\": \"integer\",\n \"required\": true,\n \"value\": null,\n \"default\": null,\n \"allowedValues\": [\n\n ]\n },\n {\n \"name\": \"state\",\n \"label\": \"State\",\n \"description\": null,\n \"type\": \"string\",\n \"required\": true,\n \"value\": null,\n \"default\": null,\n \"allowedValues\": [\n\n ]\n },\n {\n \"name\": \"abool\",\n \"label\": \"A Bool\",\n \"description\": null,\n \"type\": \"bool\",\n \"required\": false,\n \"value\": null,\n \"default\": false,\n \"allowedValues\": [\n\n ]\n },\n {\n \"name\": \"optionalstr\",\n \"label\": \"Optional String\",\n \"description\": null,\n \"type\": \"string\",\n \"required\": false,\n \"value\": null,\n \"default\": null,\n \"allowedValues\": [\n\n ]\n },\n {\n \"name\": \"table\",\n \"label\": \"Table\",\n \"description\": null,\n \"type\": \"string\",\n \"required\": false,\n \"value\": null,\n \"default\": null,\n \"allowedValues\": [\n\n ]\n },\n {\n \"name\": \"cred\",\n \"label\": \"Cred\",\n \"description\": null,\n \"type\": \"credential_redshift\",\n \"required\": false,\n \"value\": null,\n \"default\": null,\n \"allowedValues\": [\n\n ]\n },\n {\n \"name\": \"AWS\",\n \"label\": \"AWS Cred\",\n \"description\": null,\n \"type\": \"credential_aws\",\n \"required\": false,\n \"value\": null,\n \"default\": null,\n \"allowedValues\": [\n\n ]\n }\n ],\n \"name\": \"awesome python template\",\n \"category\": \"script\",\n \"note\": null,\n \"createdAt\": \"2023-07-18T18:46:36.000Z\",\n \"updatedAt\": \"2023-07-18T18:46:36.000Z\",\n \"useCount\": 0,\n \"uiReportId\": null,\n \"techReviewed\": false,\n \"archived\": false,\n \"hidden\": false,\n \"author\": {\n \"id\": 4668,\n \"name\": \"User devuserfactory3143 3141\",\n \"username\": \"devuserfactory3143\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"myPermissionLevel\": \"manage\"\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"no-cache, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"9aa4be64d7aa9cc45415391a366cdd34\"","X-Request-Id":"c132791e-5839-4bbb-8004-91d1835483c1","X-Runtime":"0.034526","Content-Length":"1427"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/templates/scripts/189\" -d '{\"archived\":false}' -X PATCH \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer fuEuAu-WvCJGp9QJAKGIE5RjC2QjXcAM5RJ6f9PSfDQ\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"delete":{"summary":"Archive a Script Template (deprecated, use archiving endpoints instead)","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/usage/matching":{"get":{"summary":"Get usage statistics for a given organization","description":null,"deprecated":false,"parameters":[{"name":"org_id","in":"query","required":false,"description":"The ID of the organization to get usage statistics for.","type":"integer"},{"name":"task","in":"query","required":false,"description":"The type of matching job contributing to this usage. One of [\"IDR\", \"CDM\"].","type":"string"},{"name":"start_date","in":"query","required":false,"description":"The start date of the range to get usage statistics for.","type":"string","format":"date-time"},{"name":"end_date","in":"query","required":false,"description":"The end date of the range to get usage statistics for.","type":"string","format":"date-time"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object696"}}}},"x-examples":null,"x-deprecation-warning":null}},"/usage/llm":{"get":{"summary":"Get a list of usage statistics for a given organization","description":null,"deprecated":false,"parameters":[{"name":"org_id","in":"query","required":false,"description":"The ID of the organization to get usage statistics for.","type":"integer"},{"name":"start_date","in":"query","required":false,"description":"The start date of the range to get usage statistics for.\"\\\n \"Defaults to the start of the current month if neither start_date nor end_date is specified.","type":"string","format":"date-time"},{"name":"end_date","in":"query","required":false,"description":"The end date of the range to get usage statistics for.\"\\\n \"Defaults to the end of the current day if neither start_date nor end_date is specified.","type":"string","format":"date-time"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object699"}}}},"x-examples":null,"x-deprecation-warning":null}},"/usage/llm/{id}":{"get":{"summary":"Get an individual usage statistic for a given organization","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the usage statistic to get.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object699"}}},"x-examples":null,"x-deprecation-warning":null}},"/usage/llm/organization/{org_id}/summary":{"get":{"summary":"Get summarized usage statistics for a given organization","description":null,"deprecated":false,"parameters":[{"name":"org_id","in":"path","required":true,"description":"The ID of the organization to get usage statistics for.","type":"integer"},{"name":"start_date","in":"query","required":false,"description":"The start date of the range to get usage statistics for.\"\\\n \"Defaults to the start of the current month if neither start_date nor end_date is specified.","type":"string","format":"date-time"},{"name":"end_date","in":"query","required":false,"description":"The end date of the range to get usage statistics for.\"\\\n \"Defaults to the end of the current day if neither start_date nor end_date is specified.","type":"string","format":"date-time"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object702"}}},"x-examples":null,"x-deprecation-warning":null}},"/usage_limits/matching":{"get":{"summary":"List Matching Usage Limits","description":null,"deprecated":false,"parameters":[{"name":"task","in":"query","required":false,"description":"If specified, return limits for this task type only. One of 'IDR' or 'CDM'.","type":"string"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object703"}}}},"x-examples":null,"x-deprecation-warning":null}},"/usage_limits/matching/{id}":{"get":{"summary":"Get a Matching Usage Limit","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID for the limit.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object703"}}},"x-examples":null,"x-deprecation-warning":null}},"/usage_limits/llm":{"get":{"summary":"List LLM Usage Limits","description":null,"deprecated":false,"parameters":[{"name":"organization_id","in":"query","required":false,"description":"If specified, return limits for this organization only.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object706"}}}},"x-examples":null,"x-deprecation-warning":null}},"/usage_limits/llm/{id}":{"get":{"summary":"Get a LLM Usage Limit","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID for the limit.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object706"}}},"x-examples":null,"x-deprecation-warning":null}},"/users/":{"get":{"summary":"List users","description":null,"deprecated":false,"parameters":[{"name":"feature_flag","in":"query","required":false,"description":"Return users that have a feature flag enabled.","type":"string"},{"name":"account_status","in":"query","required":false,"description":"The account status by which to filter users. May be one of \"active\", \"inactive\", or \"all\". Defaults to active.","type":"string"},{"name":"query","in":"query","required":false,"description":"Return users who match the given query, based on name, user, email, and id.","type":"string"},{"name":"group_id","in":"query","required":false,"description":"The ID of the group by which to filter users. Cannot be present if group_ids is.","type":"integer"},{"name":"group_ids","in":"query","required":false,"description":"The IDs of the groups by which to filter users. Cannot be present if group_id is.","type":"array","items":{"type":"integer"}},{"name":"organization_id","in":"query","required":false,"description":"The ID of the organization by which to filter users.","type":"integer"},{"name":"exclude_groups","in":"query","required":false,"description":"Whether or to exclude users' groups. Default: false.","type":"boolean"},{"name":"limit","in":"query","required":false,"description":"Number of results to return. Defaults to 20. Maximum allowed is 10000.","type":"integer"},{"name":"page_num","in":"query","required":false,"description":"Page number of the results to return. Defaults to the first page, 1.","type":"integer"},{"name":"order","in":"query","required":false,"description":"The field on which to order the result set. Defaults to name. Must be one of: name, user.","type":"string"},{"name":"order_dir","in":"query","required":false,"description":"Direction in which to sort, either asc (ascending) or desc (descending) defaulting to asc.","type":"string"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object708"}}}},"x-examples":[{"resource":"User","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/users","description":"List users","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/users","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer FnL3lg1m_pHGCpHZZIfut9vPdQYk7f9Al1kATBcqBDM","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 9,\n \"user\": \"devuserfactory2\",\n \"name\": \"User devuserfactory2 2\",\n \"email\": \"devuserfactory22user@localhost.test\",\n \"active\": true,\n \"primaryGroupId\": 58,\n \"groups\": [\n {\n \"id\": 58,\n \"name\": \"Group 3\",\n \"slug\": \"group_d\",\n \"organizationId\": 8,\n \"organizationName\": \"Organization 3\"\n }\n ],\n \"createdAt\": \"2025-01-28T16:52:56.000Z\",\n \"currentSignInAt\": \"2025-01-28T16:52:56.000Z\",\n \"updatedAt\": \"2025-01-28T16:52:56.000Z\",\n \"lastSeenAt\": null,\n \"suspended\": false,\n \"createdById\": null,\n \"lastUpdatedById\": null\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","X-Pagination-Per-Page":"20","Access-Control-Expose-Headers":"X-Pagination-Per-Page, X-Pagination-Current-Page, X-Pagination-Total-Pages, X-Pagination-Total-Entries","X-Pagination-Current-Page":"1","X-Pagination-Total-Pages":"1","X-Pagination-Total-Entries":"1","Content-Type":"application/json; charset=utf-8","ETag":"W/\"4ba352a173e32a0ed46aebab146738e7\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"e2eb92d7-f1d7-42e3-9971-2c24a66f8f1d","X-Runtime":"0.054013","Content-Length":"458"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/users\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer FnL3lg1m_pHGCpHZZIfut9vPdQYk7f9Al1kATBcqBDM\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"User","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/users?exclude_groups=true","description":"List users, excluding group information","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/users?exclude_groups=true","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer 0It0kENu-ZdeIHBpi0Pwr-1M1DhapY5L-NBTk_B1eeY","Host":"api.civis.test","Cookie":""},"request_query_parameters":{"exclude_groups":"true"},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 10,\n \"user\": \"devuserfactory3\",\n \"name\": \"User devuserfactory3 3\",\n \"email\": \"devuserfactory33user@localhost.test\",\n \"active\": true,\n \"primaryGroupId\": 65,\n \"groups\": [\n\n ],\n \"createdAt\": \"2025-01-28T16:52:56.000Z\",\n \"currentSignInAt\": \"2025-01-28T16:52:56.000Z\",\n \"updatedAt\": \"2025-01-28T16:52:56.000Z\",\n \"lastSeenAt\": null,\n \"suspended\": false,\n \"createdById\": null,\n \"lastUpdatedById\": null\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","X-Pagination-Per-Page":"20","Access-Control-Expose-Headers":"X-Pagination-Per-Page, X-Pagination-Current-Page, X-Pagination-Total-Pages, X-Pagination-Total-Entries","X-Pagination-Current-Page":"1","X-Pagination-Total-Pages":"1","X-Pagination-Total-Entries":"1","Content-Type":"application/json; charset=utf-8","ETag":"W/\"5534e78ff293ef9b32fae2d4c9cfab5f\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"c75abf85-be17-4e51-a754-fe1dcd6f7056","X-Runtime":"0.040110","Content-Length":"361"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/users?exclude_groups=true\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer 0It0kENu-ZdeIHBpi0Pwr-1M1DhapY5L-NBTk_B1eeY\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"User","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/users?feature_flag=add_table_to_project_ui","description":"List users that have a feature flag enabled","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/users?feature_flag=add_table_to_project_ui","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer et8nn3VYSkXBm3us3i0TdyKlWVWCqK9d8Ki6d0Lrl6I","Host":"api.civis.test","Cookie":""},"request_query_parameters":{"feature_flag":"add_table_to_project_ui"},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 11,\n \"user\": \"devuserfactory4\",\n \"name\": \"User devuserfactory4 4\",\n \"email\": \"devuserfactory44user@localhost.test\",\n \"active\": true,\n \"primaryGroupId\": 72,\n \"groups\": [\n {\n \"id\": 72,\n \"name\": \"Group 5\",\n \"slug\": \"group_f\",\n \"organizationId\": 10,\n \"organizationName\": \"Organization 5\"\n }\n ],\n \"createdAt\": \"2025-01-28T16:52:56.000Z\",\n \"currentSignInAt\": \"2025-01-28T16:52:56.000Z\",\n \"updatedAt\": \"2025-01-28T16:52:56.000Z\",\n \"lastSeenAt\": null,\n \"suspended\": false,\n \"createdById\": null,\n \"lastUpdatedById\": null\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","X-Pagination-Per-Page":"20","Access-Control-Expose-Headers":"X-Pagination-Per-Page, X-Pagination-Current-Page, X-Pagination-Total-Pages, X-Pagination-Total-Entries","X-Pagination-Current-Page":"1","X-Pagination-Total-Pages":"1","X-Pagination-Total-Entries":"1","Content-Type":"application/json; charset=utf-8","ETag":"W/\"ec6554a13674ef3ab932ac771f0573a6\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"293ab5c1-f3ba-45f5-b676-b3bd4ff34d8e","X-Runtime":"0.037339","Content-Length":"460"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/users?feature_flag=add_table_to_project_ui\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer et8nn3VYSkXBm3us3i0TdyKlWVWCqK9d8Ki6d0Lrl6I\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"post":{"summary":"Create a new user (must be a team or org admin)","description":null,"deprecated":false,"parameters":[{"name":"Object710","in":"body","schema":{"$ref":"#/definitions/Object710"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object711"}}},"x-examples":[{"resource":"User","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/users","description":"create a new user via POST","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/users","request_body":"{\n \"user\": \"createst\",\n \"name\": \"Test Create\",\n \"email\": \"create@localhost.test\",\n \"primary_group_id\": 44,\n \"send_email\": false,\n \"active\": true\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer VLfCNPTwjVP0vgsZLAeMNgoa2HVNPn63tP5hCcbN1U4","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 7,\n \"user\": \"createst\",\n \"name\": \"Test Create\",\n \"email\": \"create@localhost.test\",\n \"active\": true,\n \"primaryGroupId\": 44,\n \"groups\": [\n {\n \"id\": 44,\n \"name\": \"Group 1\",\n \"slug\": \"group_b\",\n \"organizationId\": 6,\n \"organizationName\": \"Organization 1\"\n }\n ],\n \"city\": null,\n \"state\": null,\n \"timeZone\": \"America/Chicago\",\n \"initials\": \"TC\",\n \"department\": null,\n \"title\": null,\n \"githubUsername\": null,\n \"prefersSmsOtp\": true,\n \"vpnEnabled\": null,\n \"ssoDisabled\": null,\n \"otpRequiredForLogin\": null,\n \"exemptFromOrgSmsOtpDisabled\": null,\n \"smsOtpAllowed\": true,\n \"robot\": false,\n \"phone\": null,\n \"organizationSlug\": \"organization_b\",\n \"organizationSSODisableCapable\": false,\n \"organizationLoginType\": \"password\",\n \"organizationSmsOtpDisabled\": false,\n \"myPermissionLevel\": \"manage\",\n \"createdAt\": \"2025-01-28T16:52:55.000Z\",\n \"updatedAt\": \"2025-01-28T16:52:55.000Z\",\n \"lastSeenAt\": null,\n \"suspended\": false,\n \"createdById\": 6,\n \"lastUpdatedById\": 6,\n \"unconfirmedEmail\": null,\n \"accountStatus\": \"Active\"\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"ec1a982911edd18d0cf1e441857f25bc\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"aafb1ba3-e6c2-4d26-9ac5-7a8cf2879efd","X-Runtime":"0.259716","Content-Length":"886"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/users\" -d '{\"user\":\"createst\",\"name\":\"Test Create\",\"email\":\"create@localhost.test\",\"primary_group_id\":44,\"send_email\":false,\"active\":true}' -X POST \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer VLfCNPTwjVP0vgsZLAeMNgoa2HVNPn63tP5hCcbN1U4\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/users/me":{"get":{"summary":"Show info about the logged-in user","description":null,"deprecated":false,"parameters":[],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object712"}}},"x-examples":[{"resource":"User","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/users/me","description":"Shows information about the logged-in user","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/users/me","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer FM3XW8lhCxVKr-4pMfLZKkrPj16jXZ1Irm6y-cCGRkA","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 12,\n \"name\": \"User devuserfactory5 5\",\n \"email\": \"devuserfactory55user@localhost.test\",\n \"username\": \"devuserfactory5\",\n \"initials\": \"UD\",\n \"lastCheckedAnnouncements\": \"2025-01-28T16:52:56.000Z\",\n \"featureFlags\": {\n \"add_table_to_project_ui\": false,\n \"ai_generation_table_metadata\": false,\n \"ai_query_completion\": false,\n \"ai_query_generation\": false,\n \"ai_support_agent\": false,\n \"cass_ncoa_configure_chunk_size\": false,\n \"cdm_usage_overview\": false,\n \"civis_ai_popsicle_top_nav\": false,\n \"enable_legacy_enhancements\": false,\n \"millenium_keys\": false,\n \"model_allow_unscanned\": false,\n \"model_thumbnails\": false,\n \"organization_favorites\": false,\n \"pendo_resource_center\": false,\n \"project_breadcrumbs\": false,\n \"salesforce_41\": false,\n \"service_report_links\": false,\n \"success_email_advanced_options\": false,\n \"sumologic_compute_metrics\": false,\n \"table_param\": false,\n \"themes_api\": false\n },\n \"roles\": [\n \"sdm\"\n ],\n \"preferences\": {\n \"default_success_notifications_on\": true,\n \"default_failure_notifications_on\": true,\n \"query_preview_rows\": 50\n },\n \"customBranding\": null,\n \"primaryGroupId\": 79,\n \"groups\": [\n {\n \"id\": 79,\n \"name\": \"Group 6\",\n \"slug\": \"group_g\",\n \"organizationId\": 11,\n \"organizationName\": \"Organization 6\"\n }\n ],\n \"organizationName\": \"Organization 6\",\n \"organizationSlug\": \"organization_g\",\n \"organizationDefaultThemeId\": null,\n \"createdAt\": \"2025-01-28T16:52:56.000Z\",\n \"signInCount\": 0,\n \"assumingRole\": false,\n \"assumingAdmin\": false,\n \"assumingAdminExpiration\": null,\n \"superadminModeExpiration\": null,\n \"disableNonCompliantFedrampFeatures\": false,\n \"personaRole\": null,\n \"createdById\": null,\n \"lastUpdatedById\": null\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"27ee62812f53b3ba011abd92ee7cf89f\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"fdb11aee-ec8d-426c-80f9-084aa88128a7","X-Runtime":"0.039910","Content-Length":"1478"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/users/me\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer FM3XW8lhCxVKr-4pMfLZKkrPj16jXZ1Irm6y-cCGRkA\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"patch":{"summary":"Update info about the logged-in user","description":null,"deprecated":false,"parameters":[{"name":"Object725","in":"body","schema":{"$ref":"#/definitions/Object725"},"required":false}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object712"}}},"x-examples":null,"x-deprecation-warning":null}},"/users/me/activity":{"get":{"summary":"Get recent activity for logged-in user","description":null,"deprecated":false,"parameters":[{"name":"status","in":"query","required":false,"description":"The status to filter objects by. One of \"all\", \"succeeded\", \"failed\", or \"running\".","type":"string"},{"name":"author","in":"query","required":false,"description":"A comma separated list of author IDs to filter objects by.","type":"string"},{"name":"order","in":"query","required":false,"description":"The order of the jobs. If set to \"name\", the order is DESC alphabetically. If set to \"newest\", the order is DESC by most recently updated.","type":"string"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object715"}}}},"x-examples":null,"x-deprecation-warning":null}},"/users/me/organization_admins":{"get":{"summary":"Get list of organization admins for logged-in user","description":null,"deprecated":false,"parameters":[],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object716"}}}},"x-examples":[{"resource":"User","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/users/me/organization_admins","description":"Shows organization admins for the logged-in user","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/users/me/organization_admins","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer B3KQTPUkCpCjcqq_jhwlCjkuUVunYoqxGbsu5i-NDKQ","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 14,\n \"name\": \"User devuserfactory7 7\",\n \"username\": \"devuserfactory7\",\n \"initials\": \"UD\",\n \"online\": null,\n \"email\": \"devuserfactory77user@localhost.test\"\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"d22d62f7ea6d83e708bb0d553491fba4\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"98d294a4-1e6e-4a45-a920-5a6e37318867","X-Runtime":"0.040005","Content-Length":"148"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/users/me/organization_admins\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer B3KQTPUkCpCjcqq_jhwlCjkuUVunYoqxGbsu5i-NDKQ\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/users/{id}":{"get":{"summary":"Show info about a user","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of this user.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object711"}}},"x-examples":[{"resource":"User","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/users/:id","description":"Shows information about another user","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/users/16","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer lwmjhWoC7j-Qp27eHt-q4-duXL1vrbz_Rh6x69kxO18","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 16,\n \"user\": \"devuserfactory9\",\n \"name\": \"User devuserfactory9 9\",\n \"email\": \"devuserfactory99user@localhost.test\",\n \"active\": true,\n \"primaryGroupId\": 94,\n \"groups\": [\n {\n \"id\": 94,\n \"name\": \"Group 8\",\n \"slug\": \"group_i\",\n \"organizationId\": 13,\n \"organizationName\": \"Organization 8\"\n }\n ],\n \"city\": null,\n \"state\": null,\n \"timeZone\": \"America/Chicago\",\n \"initials\": \"UD\",\n \"department\": null,\n \"title\": null,\n \"githubUsername\": null,\n \"prefersSmsOtp\": true,\n \"vpnEnabled\": null,\n \"ssoDisabled\": false,\n \"otpRequiredForLogin\": false,\n \"exemptFromOrgSmsOtpDisabled\": null,\n \"smsOtpAllowed\": true,\n \"robot\": false,\n \"phone\": null,\n \"organizationSlug\": \"organization_i\",\n \"organizationSSODisableCapable\": false,\n \"organizationLoginType\": \"password\",\n \"organizationSmsOtpDisabled\": null,\n \"myPermissionLevel\": \"manage\",\n \"createdAt\": \"2025-01-28T16:52:57.000Z\",\n \"updatedAt\": \"2025-01-28T16:52:57.000Z\",\n \"lastSeenAt\": null,\n \"suspended\": false,\n \"createdById\": null,\n \"lastUpdatedById\": null,\n \"unconfirmedEmail\": null,\n \"accountStatus\": \"Active\"\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"b5c8dacfee3151cd9204e0e07dbc175b\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"35a652fd-94bb-4cd8-8608-3e8322d635e8","X-Runtime":"0.051482","Content-Length":"927"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/users/16\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer lwmjhWoC7j-Qp27eHt-q4-duXL1vrbz_Rh6x69kxO18\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"patch":{"summary":"Update info about a user (must be a team or org admin)","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of this user.","type":"integer"},{"name":"Object727","in":"body","schema":{"$ref":"#/definitions/Object727"},"required":false}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object711"}}},"x-examples":[{"resource":"User","resource_explanation":null,"http_method":"PATCH","route":"http://api.civis.test/users/:id","description":"updates a user via PATCH","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"PATCH","request_path":"http://api.civis.test/users/8","request_body":"{\n \"name\": \"name updated\"\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer yrIbaMhc7nriEImpWmjdXfnhtCXyR8OFFjqG82-i90s","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 8,\n \"user\": \"devuserfactory1\",\n \"name\": \"name updated\",\n \"email\": \"devuserfactory11user@localhost.test\",\n \"active\": true,\n \"primaryGroupId\": 51,\n \"groups\": [\n {\n \"id\": 51,\n \"name\": \"Group 2\",\n \"slug\": \"group_c\",\n \"organizationId\": 7,\n \"organizationName\": \"Organization 2\"\n }\n ],\n \"city\": null,\n \"state\": null,\n \"timeZone\": \"America/Chicago\",\n \"initials\": \"NU\",\n \"department\": null,\n \"title\": null,\n \"githubUsername\": null,\n \"prefersSmsOtp\": true,\n \"vpnEnabled\": null,\n \"ssoDisabled\": false,\n \"otpRequiredForLogin\": false,\n \"exemptFromOrgSmsOtpDisabled\": null,\n \"smsOtpAllowed\": true,\n \"robot\": false,\n \"phone\": null,\n \"organizationSlug\": \"organization_c\",\n \"organizationSSODisableCapable\": false,\n \"organizationLoginType\": \"password\",\n \"organizationSmsOtpDisabled\": null,\n \"myPermissionLevel\": \"write\",\n \"createdAt\": \"2025-01-28T16:52:55.000Z\",\n \"updatedAt\": \"2025-01-28T16:52:55.000Z\",\n \"lastSeenAt\": null,\n \"suspended\": false,\n \"createdById\": null,\n \"lastUpdatedById\": 8,\n \"unconfirmedEmail\": null,\n \"accountStatus\": \"Active\"\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"8e4d97af4fa6e386adaabd503f5ce886\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"4dae3f01-fa34-469f-92b9-33e259e9dad5","X-Runtime":"0.093850","Content-Length":"911"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/users/8\" -d '{\"name\":\"name updated\"}' -X PATCH \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer yrIbaMhc7nriEImpWmjdXfnhtCXyR8OFFjqG82-i90s\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/users/{id}/api_keys":{"get":{"summary":"Show API keys belonging to the specified user","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the user or 'me'.","type":"string"},{"name":"limit","in":"query","required":false,"description":"Number of results to return. Defaults to its maximum of 50.","type":"integer"},{"name":"page_num","in":"query","required":false,"description":"Page number of the results to return. Defaults to the first page, 1.","type":"integer"},{"name":"order","in":"query","required":false,"description":"The field on which to order the result set. Defaults to id. Must be one of: id.","type":"string"},{"name":"order_dir","in":"query","required":false,"description":"Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc.","type":"string"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object718"}}}},"x-examples":[{"resource":"User","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/users/:id/api_keys","description":"Show API keys for the specified user","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/users/18/api_keys","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer xmsdCqfFAGIza5WCiQpGvnDAry_7djCvF9Z3L3k_7NY","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 10,\n \"name\": \"test_key\",\n \"expiresAt\": \"2025-01-28T17:01:17.000Z\",\n \"createdAt\": \"2025-01-28T16:52:57.000Z\",\n \"revokedAt\": null,\n \"lastUsedAt\": null,\n \"scopes\": [\n \"public\"\n ],\n \"useCount\": 0,\n \"expired\": false,\n \"active\": true,\n \"constraintCount\": 0\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","X-Pagination-Per-Page":"50","Access-Control-Expose-Headers":"X-Pagination-Per-Page, X-Pagination-Current-Page, X-Pagination-Total-Pages, X-Pagination-Total-Entries","X-Pagination-Current-Page":"1","X-Pagination-Total-Pages":"1","X-Pagination-Total-Entries":"1","Content-Type":"application/json; charset=utf-8","ETag":"W/\"d94465bee13e309053c4ce71a4d8039a\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"4ad62dd2-cea2-415e-a5ac-ac4d577c16bf","X-Runtime":"0.041420","Content-Length":"225"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/users/18/api_keys\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer xmsdCqfFAGIza5WCiQpGvnDAry_7djCvF9Z3L3k_7NY\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"User","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/users/:id/api_keys","description":"Show API keys for the logged-in user","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/users/me/api_keys","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer uT5Gg9E_LfhObmMgSUlG07hGp-r1tissp8rFDCvB5Qg","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 12,\n \"name\": \"test_key\",\n \"expiresAt\": \"2025-01-28T17:01:17.000Z\",\n \"createdAt\": \"2025-01-28T16:52:57.000Z\",\n \"revokedAt\": null,\n \"lastUsedAt\": null,\n \"scopes\": [\n \"public\"\n ],\n \"useCount\": 0,\n \"expired\": false,\n \"active\": true,\n \"constraintCount\": 1\n },\n {\n \"id\": 11,\n \"name\": \"test\",\n \"expiresAt\": \"2025-01-29T16:52:57.000Z\",\n \"createdAt\": \"2025-01-28T16:52:57.000Z\",\n \"revokedAt\": null,\n \"lastUsedAt\": \"2025-01-28T16:52:57.000Z\",\n \"scopes\": [\n \"public\"\n ],\n \"useCount\": 1,\n \"expired\": false,\n \"active\": true,\n \"constraintCount\": 0\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","X-Pagination-Per-Page":"50","Access-Control-Expose-Headers":"X-Pagination-Per-Page, X-Pagination-Current-Page, X-Pagination-Total-Pages, X-Pagination-Total-Entries","X-Pagination-Current-Page":"1","X-Pagination-Total-Pages":"1","X-Pagination-Total-Entries":"2","Content-Type":"application/json; charset=utf-8","ETag":"W/\"926837cb4df94105ebe06d1390e85d5f\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"9e13c1e3-eec7-4f36-a4a0-6b1d37de732f","X-Runtime":"0.025328","Content-Length":"467"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/users/me/api_keys\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer uT5Gg9E_LfhObmMgSUlG07hGp-r1tissp8rFDCvB5Qg\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"post":{"summary":"Create a new API key belonging to the logged-in user","description":"Constraint verb \"allowed\" parameters default to false if not specified. At least one verb must be specified. If constraintType is \"verb\", the constraint parameter must not be specified. A constraint parameter must be specified for all other constraintType values.","deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the user or 'me'.","type":"string"},{"name":"Object719","in":"body","schema":{"$ref":"#/definitions/Object719"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object721"}}},"x-examples":[{"resource":"User","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/users/:id/api_keys","description":"Create an API key for the current user","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/users/me/api_keys","request_body":"{\n \"name\": \"friendlyapp\",\n \"expires_in\": 1000\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer _vgRplm_sBc5BV_PunAOk5aEmvLutVCLbCRtItnSTsE","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 14,\n \"name\": \"friendlyapp\",\n \"expiresAt\": \"2025-01-28T17:09:38.000Z\",\n \"createdAt\": \"2025-01-28T16:52:58.000Z\",\n \"revokedAt\": null,\n \"lastUsedAt\": null,\n \"scopes\": [\n \"public\"\n ],\n \"useCount\": 0,\n \"expired\": false,\n \"active\": true,\n \"constraints\": [\n\n ],\n \"token\": \"mMWsCDTg0glpJj1n7zXniW0PKPotlTkxPhYhzIRtc0U\"\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"69e2b9c4344d94d810e655ab3d741b7a\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"bfea1590-ed7f-4381-8831-4f8f444483fd","X-Runtime":"0.044194","Content-Length":"277"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/users/me/api_keys\" -d '{\"name\":\"friendlyapp\",\"expires_in\":1000}' -X POST \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer _vgRplm_sBc5BV_PunAOk5aEmvLutVCLbCRtItnSTsE\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"User","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/users/:id/api_keys","description":"Creates an API key with constraints","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/users/21/api_keys","request_body":"{\n \"name\": \"friendlyapp\",\n \"expires_in\": 1000,\n \"constraints\": [\n {\n \"constraint\": \"reports/33\",\n \"constraint_type\": \"exact\",\n \"get_allowed\": true\n }\n ]\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer pPMMBtKDIK5cmJW-RUR7anDOcTuroULHvijzAHvBKuM","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 16,\n \"name\": \"friendlyapp\",\n \"expiresAt\": \"2025-01-28T17:09:38.000Z\",\n \"createdAt\": \"2025-01-28T16:52:58.000Z\",\n \"revokedAt\": null,\n \"lastUsedAt\": null,\n \"scopes\": [\n \"public\"\n ],\n \"useCount\": 0,\n \"expired\": false,\n \"active\": true,\n \"constraints\": [\n {\n \"constraint\": \"reports/33\",\n \"constraintType\": \"exact\",\n \"getAllowed\": true,\n \"headAllowed\": false,\n \"postAllowed\": false,\n \"putAllowed\": false,\n \"patchAllowed\": false,\n \"deleteAllowed\": false\n }\n ],\n \"token\": \"zI-D7iATYIsnmStGuBtS0bAoj3Lrgr7kpcSmI6XvsRM\"\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"7c1e6254f153de6716ac85d686ca9ef3\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"a31ab37e-7572-41d9-81bd-a3d9eaf99686","X-Runtime":"0.114690","Content-Length":"449"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/users/21/api_keys\" -d '{\"name\":\"friendlyapp\",\"expires_in\":1000,\"constraints\":[{\"constraint\":\"reports/33\",\"constraint_type\":\"exact\",\"get_allowed\":true}]}' -X POST \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer pPMMBtKDIK5cmJW-RUR7anDOcTuroULHvijzAHvBKuM\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"User","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/users/:id/api_keys","description":"Does not create an API key with different constraints if the call uses an API key with constraints","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/users/22/api_keys","request_body":"{\n \"name\": \"friendlyapp\",\n \"expires_in\": 1000,\n \"constraints\": [\n {\n \"constraint\": \"reports/33\",\n \"constraint_type\": \"exact\",\n \"get_allowed\": true\n }\n ]\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer FJPi2060YUCCWsz9tLdxAATu_pOBUoABfNtZwo0qWDM","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":400,"response_status_text":"Bad Request","response_body":"{\n \"error\": \"bad_request\",\n \"errorDescription\": \"Cannot create API Key with different constraints.\",\n \"code\": 400\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"1af0c1f8-8e80-4cd1-bee8-41139e6e154b","X-Runtime":"0.065131","Content-Length":"105"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/users/22/api_keys\" -d '{\"name\":\"friendlyapp\",\"expires_in\":1000,\"constraints\":[{\"constraint\":\"reports/33\",\"constraint_type\":\"exact\",\"get_allowed\":true}]}' -X POST \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer FJPi2060YUCCWsz9tLdxAATu_pOBUoABfNtZwo0qWDM\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/users/{id}/api_keys/{key_id}":{"get":{"summary":"Show the specified API key","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the user or 'me'.","type":"string"},{"name":"key_id","in":"path","required":true,"description":"The ID of the API key.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object724"}}},"x-examples":[{"resource":"User","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/users/:id/api_keys/:key_id","description":"Show details for an API key","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/users/me/api_keys/19","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer eD8sIuApf3Qe8JRLpNvbrXuD1EnpPpePDWOGLxwMW5k","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 19,\n \"name\": \"with_constraint\",\n \"expiresAt\": \"2025-01-28T16:56:18.000Z\",\n \"createdAt\": \"2025-01-28T16:52:58.000Z\",\n \"revokedAt\": null,\n \"lastUsedAt\": null,\n \"scopes\": [\n \"public\"\n ],\n \"useCount\": 0,\n \"expired\": false,\n \"active\": true,\n \"constraints\": [\n {\n \"constraint\": \"path\",\n \"constraintType\": \"exact\",\n \"getAllowed\": false,\n \"headAllowed\": false,\n \"postAllowed\": true,\n \"putAllowed\": false,\n \"patchAllowed\": false,\n \"deleteAllowed\": false\n }\n ]\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"93864a749bcf74f2f6439bc848fafe02\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"7ef9b772-fd5b-4496-aa0d-557fccd6df31","X-Runtime":"0.028142","Content-Length":"393"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/users/me/api_keys/19\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer eD8sIuApf3Qe8JRLpNvbrXuD1EnpPpePDWOGLxwMW5k\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"delete":{"summary":"Revoke the specified API key","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the user or 'me'.","type":"string"},{"name":"key_id","in":"path","required":true,"description":"The ID of the API key.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object724"}}},"x-examples":[{"resource":"User","resource_explanation":null,"http_method":"DELETE","route":"http://api.civis.test/users/:id/api_keys/:key_id","description":"Delete an API key","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"DELETE","request_path":"http://api.civis.test/users/me/api_keys/21","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer 1xgnNXaGd5K5dVSJ758QWCujy2Rh1EgFU7dMvz9TbGg","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 21,\n \"name\": \"test_key\",\n \"expiresAt\": \"2025-01-28T17:09:39.000Z\",\n \"createdAt\": \"2025-01-28T16:52:59.000Z\",\n \"revokedAt\": \"2025-01-28T16:52:59.000Z\",\n \"lastUsedAt\": null,\n \"scopes\": [\n \"public\"\n ],\n \"useCount\": 0,\n \"expired\": false,\n \"active\": false,\n \"constraints\": [\n\n ]\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"312b7c3c4e55286bb69926eec46d8719\"","Content-Security-Policy":"frame-ancestors 'self' *.civisanalytics.com","X-Request-Id":"bb3e9181-13a3-4eb5-9049-b7d395e23050","X-Runtime":"0.029934","Content-Length":"243"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/users/me/api_keys/21\" -d '' -X DELETE \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer 1xgnNXaGd5K5dVSJ758QWCujy2Rh1EgFU7dMvz9TbGg\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/users/{id}/sessions":{"delete":{"summary":"Terminate all of the user's active sessions (must be a team or org admin)","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of this user.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object711"}}},"x-examples":null,"x-deprecation-warning":null}},"/users/me/favorites":{"get":{"summary":"List Favorites","description":null,"deprecated":false,"parameters":[{"name":"object_id","in":"query","required":false,"description":"The id of the object. If specified as a query parameter, must also specify object_type parameter.","type":"integer"},{"name":"object_type","in":"query","required":false,"description":"The type of the object that is favorited. Valid options: Container Script, Identity Resolution, Import, Python Script, R Script, dbt Script, JavaScript Script, SQL Script, Template Script, Project, Workflow, Tableau Report, Service Report, HTML Report, SQL Report","type":"string"},{"name":"limit","in":"query","required":false,"description":"Number of results to return. Defaults to 50. Maximum allowed is 1000.","type":"integer"},{"name":"page_num","in":"query","required":false,"description":"Page number of the results to return. Defaults to the first page, 1.","type":"integer"},{"name":"order","in":"query","required":false,"description":"The field on which to order the result set. Defaults to position. Must be one of: position, created_at.","type":"string"},{"name":"order_dir","in":"query","required":false,"description":"Direction in which to sort, either asc (ascending) or desc (descending) defaulting to asc.","type":"string"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object413"}}}},"x-examples":null,"x-deprecation-warning":null},"post":{"summary":"Favorite an item","description":null,"deprecated":false,"parameters":[{"name":"Object414","in":"body","schema":{"$ref":"#/definitions/Object414"},"required":true}],"responses":{"201":{"description":"success","schema":{"$ref":"#/definitions/Object415"}}},"x-examples":null,"x-deprecation-warning":null}},"/users/me/favorites/{id}":{"delete":{"summary":"Unfavorite an item","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The id of the favorite.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/users/me/favorites/{id}/ranking/top":{"patch":{"summary":"Move a favorite to the top of the list","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The id of the favorite.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":[{"resource":"Favorites","resource_explanation":null,"http_method":"PATCH","route":"http://api.civis.test/users/me/favorites/:id/ranking/top","description":"Move a favorite to the top of the list via PATCH","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"PATCH","request_path":"http://api.civis.test/users/me/favorites/3/ranking/top","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer ETkWTQ407Xseoo64hwKj4sIbB7XtAvv2PlNhlg_0dPg","Accept":"application/vnd.civis-platform.v1","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":204,"response_status_text":"No Content","response_body":null,"response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","X-Request-Id":"e990c29e-ce41-4c55-9e34-7c2bf1e84dbf","X-Runtime":"0.541901"},"response_content_type":null,"curl":"curl \"api.civis.testhttp://api.civis.test/users/me/favorites/3/ranking/top\" -d '' -X PATCH \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer ETkWTQ407Xseoo64hwKj4sIbB7XtAvv2PlNhlg_0dPg\" \\\n\t-H \"Accept: application/vnd.civis-platform.v1\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/users/me/favorites/{id}/ranking/bottom":{"patch":{"summary":"Move a favorite to the bottom of the list","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The id of the favorite.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":[{"resource":"Favorites","resource_explanation":null,"http_method":"PATCH","route":"http://api.civis.test/users/me/favorites/:id/ranking/bottom","description":"Move a favorite to the bottom of the list via PATCH","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"PATCH","request_path":"http://api.civis.test/users/me/favorites/4/ranking/bottom","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer 95JhXu6SYqd8RsAuUQ3b0OfmAggde4obJXVeXh7CIxM","Accept":"application/vnd.civis-platform.v1","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":204,"response_status_text":"No Content","response_body":null,"response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","X-Request-Id":"43ab04d0-94ee-4068-92c1-57b1d8a4106e","X-Runtime":"0.086730"},"response_content_type":null,"curl":"curl \"api.civis.testhttp://api.civis.test/users/me/favorites/4/ranking/bottom\" -d '' -X PATCH \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer 95JhXu6SYqd8RsAuUQ3b0OfmAggde4obJXVeXh7CIxM\" \\\n\t-H \"Accept: application/vnd.civis-platform.v1\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/users/me/favorites/{id}/ranking/higher":{"patch":{"summary":"Move a favorite one position closer to the top of the list","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The id of the favorite.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":[{"resource":"Favorites","resource_explanation":null,"http_method":"PATCH","route":"http://api.civis.test/users/me/favorites/:id/ranking/higher","description":"Move a favorite up one position in the list via PATCH","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"PATCH","request_path":"http://api.civis.test/users/me/favorites/9/ranking/higher","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer 4rd7ZE8qrW7kKuxHXOdbd3rMWqm8eQcmpkxlAIQwTTI","Accept":"application/vnd.civis-platform.v1","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":204,"response_status_text":"No Content","response_body":null,"response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","X-Request-Id":"15260583-7abf-4ca7-9fda-d05c5152e31d","X-Runtime":"0.137856"},"response_content_type":null,"curl":"curl \"api.civis.testhttp://api.civis.test/users/me/favorites/9/ranking/higher\" -d '' -X PATCH \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer 4rd7ZE8qrW7kKuxHXOdbd3rMWqm8eQcmpkxlAIQwTTI\" \\\n\t-H \"Accept: application/vnd.civis-platform.v1\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/users/me/favorites/{id}/ranking/lower":{"patch":{"summary":"Move a favorite one position closer to the bottom of the list","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The id of the favorite.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":[{"resource":"Favorites","resource_explanation":null,"http_method":"PATCH","route":"http://api.civis.test/users/me/favorites/:id/ranking/lower","description":"Move a favorite down one position in the list via PATCH","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"PATCH","request_path":"http://api.civis.test/users/me/favorites/10/ranking/lower","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer WFFdVK7JyfTzuIZHbjdqS1a0abr5ylqmOEs6JEJQJe8","Accept":"application/vnd.civis-platform.v1","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":204,"response_status_text":"No Content","response_body":null,"response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","X-Request-Id":"7c573d5e-db45-4385-88b1-77e58b34c677","X-Runtime":"0.073916"},"response_content_type":null,"curl":"curl \"api.civis.testhttp://api.civis.test/users/me/favorites/10/ranking/lower\" -d '' -X PATCH \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer WFFdVK7JyfTzuIZHbjdqS1a0abr5ylqmOEs6JEJQJe8\" \\\n\t-H \"Accept: application/vnd.civis-platform.v1\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/users/{id}/unsuspend":{"post":{"summary":"Unsuspends user","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of this user.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object728"}}},"x-examples":null,"x-deprecation-warning":null}},"/users/{id}/2fa":{"delete":{"summary":"Wipes the user's current 2FA settings so that they must reset them upon next login","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of this user.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object711"}}},"x-examples":null,"x-deprecation-warning":null}},"/users/{id}/access_email":{"post":{"summary":"Sends the target user a 'Reset Password' or 'Welcome to Platform' email depending on the their status - Only available to Org and Team Admins","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of this user.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/workflows/":{"get":{"summary":"List Workflows","description":null,"deprecated":false,"parameters":[{"name":"hidden","in":"query","required":false,"description":"If specified to be true, returns hidden items. Defaults to false, returning non-hidden items.","type":"boolean"},{"name":"archived","in":"query","required":false,"description":"The archival status of the requested item(s).","type":"string"},{"name":"author","in":"query","required":false,"description":"If specified, return items from any of these authors. It accepts a comma-separated list of user IDs.","type":"string"},{"name":"state","in":"query","required":false,"description":"State of the most recent execution. One or more of queued, running, succeeded, failed, cancelled, idle, and scheduled. Note that the \"scheduled\" state applies only to scheduled workflows which have never been run. If you want to see all scheduled workflows, please use the \"scheduled\" filter instead.","type":"array","items":{"type":"string"}},{"name":"scheduled","in":"query","required":false,"description":"If the workflow is scheduled.","type":"boolean"},{"name":"limit","in":"query","required":false,"description":"Number of results to return. Defaults to 20. Maximum allowed is 50.","type":"integer"},{"name":"page_num","in":"query","required":false,"description":"Page number of the results to return. Defaults to the first page, 1.","type":"integer"},{"name":"order","in":"query","required":false,"description":"The field on which to order the result set. Defaults to updated_at. Must be one of: updated_at, name, created_at.","type":"string"},{"name":"order_dir","in":"query","required":false,"description":"Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc.","type":"string"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object325"}}}},"x-examples":[{"resource":"Workflows","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/workflows","description":"List all workflows","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/workflows","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer Zt1F4Dz-VFK7LxmpdggiVJv_6ysgRfqh1TIaHNkHUYU","Accept":"application/vnd.civis-platform.v1","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 3,\n \"name\": \"Test Workflow\",\n \"description\": null,\n \"valid\": true,\n \"fileId\": 3,\n \"user\": {\n \"id\": 6,\n \"name\": \"User devuserfactory1 1\",\n \"username\": \"devuserfactory1\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"state\": \"scheduled\",\n \"schedule\": {\n \"scheduled\": true,\n \"scheduledDays\": [\n 1\n ],\n \"scheduledHours\": [\n 2\n ],\n \"scheduledMinutes\": [\n 0\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n },\n \"allowConcurrentExecutions\": true,\n \"timeZone\": \"America/Chicago\",\n \"nextExecutionAt\": \"2024-05-27T07:00:00.000Z\",\n \"archived\": false,\n \"createdAt\": \"2024-05-22T22:51:30.000Z\",\n \"updatedAt\": \"2024-05-22T22:51:30.000Z\"\n },\n {\n \"id\": 2,\n \"name\": \"Test Workflow\",\n \"description\": null,\n \"valid\": true,\n \"fileId\": 2,\n \"user\": {\n \"id\": 6,\n \"name\": \"User devuserfactory1 1\",\n \"username\": \"devuserfactory1\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"state\": \"running\",\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n },\n \"allowConcurrentExecutions\": true,\n \"timeZone\": \"America/Chicago\",\n \"nextExecutionAt\": null,\n \"archived\": false,\n \"createdAt\": \"2024-05-22T22:51:29.000Z\",\n \"updatedAt\": \"2024-05-22T22:51:29.000Z\"\n },\n {\n \"id\": 1,\n \"name\": \"Test Workflow\",\n \"description\": null,\n \"valid\": true,\n \"fileId\": 1,\n \"user\": {\n \"id\": 6,\n \"name\": \"User devuserfactory1 1\",\n \"username\": \"devuserfactory1\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"state\": \"idle\",\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n },\n \"allowConcurrentExecutions\": true,\n \"timeZone\": \"America/Chicago\",\n \"nextExecutionAt\": null,\n \"archived\": false,\n \"createdAt\": \"2024-05-22T22:51:28.000Z\",\n \"updatedAt\": \"2024-05-22T22:51:28.000Z\"\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","X-Pagination-Per-Page":"20","Access-Control-Expose-Headers":"X-Pagination-Per-Page, X-Pagination-Current-Page, X-Pagination-Total-Pages, X-Pagination-Total-Entries","X-Pagination-Current-Page":"1","X-Pagination-Total-Pages":"1","X-Pagination-Total-Entries":"3","Content-Type":"application/json; charset=utf-8","ETag":"W/\"4533bf78e19596368d3029005fa6b5c9\"","X-Request-Id":"a30dd413-10d9-48c7-ac9f-e6314eef5e65","X-Runtime":"0.190029","Content-Length":"1600"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/workflows\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer Zt1F4Dz-VFK7LxmpdggiVJv_6ysgRfqh1TIaHNkHUYU\" \\\n\t-H \"Accept: application/vnd.civis-platform.v1\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Workflows","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/workflows","description":"List scheduled workflows","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/workflows?scheduled=true","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer gHbebBOMX8qB8aU1e5KUYsOa0uFx4RvmB0krEUmrEyg","Accept":"application/vnd.civis-platform.v1","Host":"api.civis.test","Cookie":""},"request_query_parameters":{"scheduled":"true"},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 6,\n \"name\": \"Test Workflow\",\n \"description\": null,\n \"valid\": true,\n \"fileId\": 6,\n \"user\": {\n \"id\": 7,\n \"name\": \"User devuserfactory2 2\",\n \"username\": \"devuserfactory2\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"state\": \"scheduled\",\n \"schedule\": {\n \"scheduled\": true,\n \"scheduledDays\": [\n 1\n ],\n \"scheduledHours\": [\n 2\n ],\n \"scheduledMinutes\": [\n 0\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n },\n \"allowConcurrentExecutions\": true,\n \"timeZone\": \"America/Chicago\",\n \"nextExecutionAt\": \"2024-05-27T07:00:00.000Z\",\n \"archived\": false,\n \"createdAt\": \"2024-05-22T22:51:30.000Z\",\n \"updatedAt\": \"2024-05-22T22:51:30.000Z\"\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","X-Pagination-Per-Page":"20","Access-Control-Expose-Headers":"X-Pagination-Per-Page, X-Pagination-Current-Page, X-Pagination-Total-Pages, X-Pagination-Total-Entries","X-Pagination-Current-Page":"1","X-Pagination-Total-Pages":"1","X-Pagination-Total-Entries":"1","Content-Type":"application/json; charset=utf-8","ETag":"W/\"a51aac1700e164fef3c9b04c52f11415\"","X-Request-Id":"c4ce36df-8d2a-46d4-82cb-396951b2d9b5","X-Runtime":"0.029855","Content-Length":"553"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/workflows?scheduled=true\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer gHbebBOMX8qB8aU1e5KUYsOa0uFx4RvmB0krEUmrEyg\" \\\n\t-H \"Accept: application/vnd.civis-platform.v1\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Workflows","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/workflows","description":"List workflows where the most recent execution is running","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/workflows?state[]=running","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer xwDV75DTa0KzHUgh78AYSa2V18YoPn_SR21QJHYXisE","Accept":"application/vnd.civis-platform.v1","Host":"api.civis.test","Cookie":""},"request_query_parameters":{"state":["running"]},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 8,\n \"name\": \"Test Workflow\",\n \"description\": null,\n \"valid\": true,\n \"fileId\": 8,\n \"user\": {\n \"id\": 8,\n \"name\": \"User devuserfactory3 3\",\n \"username\": \"devuserfactory3\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"state\": \"running\",\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n },\n \"allowConcurrentExecutions\": true,\n \"timeZone\": \"America/Chicago\",\n \"nextExecutionAt\": null,\n \"archived\": false,\n \"createdAt\": \"2024-05-22T22:51:29.000Z\",\n \"updatedAt\": \"2024-05-22T22:51:29.000Z\"\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","X-Pagination-Per-Page":"20","Access-Control-Expose-Headers":"X-Pagination-Per-Page, X-Pagination-Current-Page, X-Pagination-Total-Pages, X-Pagination-Total-Entries","X-Pagination-Current-Page":"1","X-Pagination-Total-Pages":"1","X-Pagination-Total-Entries":"1","Content-Type":"application/json; charset=utf-8","ETag":"W/\"5d1215b30433385509ecaee1db741939\"","X-Request-Id":"5b81aa6e-3a49-423e-9ea2-c160cb312988","X-Runtime":"0.028595","Content-Length":"526"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/workflows?state[]=running\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer xwDV75DTa0KzHUgh78AYSa2V18YoPn_SR21QJHYXisE\" \\\n\t-H \"Accept: application/vnd.civis-platform.v1\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"post":{"summary":"Create a Workflow","description":null,"deprecated":false,"parameters":[{"name":"Object729","in":"body","schema":{"$ref":"#/definitions/Object729"},"required":true}],"responses":{"201":{"description":"success","schema":{"$ref":"#/definitions/Object731"}}},"x-examples":[{"resource":"Workflows","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/workflows","description":"create a workflow from a definition","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/workflows","request_body":"{\n \"name\": \"wf\",\n \"definition\": \"---\\nversion: 2\\n\\nmy_workflow:\\n type: direct\\n tasks:\\n task_1: &run\\n action: civis.run_job\\n task_2:\\n <<: *run\\n\",\n \"description\": \"This workflow takes Obama campaign data and does things\"\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer CjAFvJ49PIPb97p1JFyJZrLvCFyDqbwGAP7paKL25b0","Accept":"application/vnd.civis-platform.v1","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":201,"response_status_text":"Created","response_body":"{\n \"id\": 16,\n \"name\": \"wf\",\n \"description\": \"This workflow takes Obama campaign data and does things\",\n \"definition\": \"---\\nversion: 2\\n\\nmy_workflow:\\n type: direct\\n tasks:\\n task_1: &run\\n action: civis.run_job\\n task_2:\\n <<: *run\\n\",\n \"valid\": true,\n \"validationErrors\": null,\n \"fileId\": 16,\n \"user\": {\n \"id\": 10,\n \"name\": \"User devuserfactory5 5\",\n \"username\": \"devuserfactory5\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"state\": \"idle\",\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n },\n \"allowConcurrentExecutions\": true,\n \"timeZone\": \"America/Chicago\",\n \"nextExecutionAt\": null,\n \"notifications\": {\n \"urls\": [\n\n ],\n \"successEmailSubject\": null,\n \"successEmailBody\": null,\n \"successEmailAddresses\": [\n\n ],\n \"failureEmailAddresses\": [\n\n ],\n \"stallWarningMinutes\": null,\n \"successOn\": true,\n \"failureOn\": true\n },\n \"archived\": false,\n \"hidden\": false,\n \"myPermissionLevel\": \"manage\",\n \"createdAt\": \"2024-05-22T22:51:29.000Z\",\n \"updatedAt\": \"2024-05-22T22:51:29.000Z\"\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"e5e0fcfb0d5ef5e1c6a1fab2cfca1eaf\"","X-Request-Id":"fc09e6cd-a162-4eb1-8cbc-28d528f2d73d","X-Runtime":"0.176015","Content-Length":"994"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/workflows\" -d '{\"name\":\"wf\",\"definition\":\"---\\nversion: 2\\n\\nmy_workflow:\\n type: direct\\n tasks:\\n task_1: \\u0026run\\n action: civis.run_job\\n task_2:\\n \\u003c\\u003c: *run\\n\",\"description\":\"This workflow takes Obama campaign data and does things\"}' -X POST \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer CjAFvJ49PIPb97p1JFyJZrLvCFyDqbwGAP7paKL25b0\" \\\n\t-H \"Accept: application/vnd.civis-platform.v1\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Workflows","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/workflows","description":"create a workflow from an existing job chain","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/workflows","request_body":"{\n \"name\": \"wf\",\n \"from_job_chain\": 1\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer OmVr97xtCmcCR2oqlLIztHNRYK8dFulSXbjdZPRHaZY","Accept":"application/vnd.civis-platform.v1","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":201,"response_status_text":"Created","response_body":"{\n \"id\": 20,\n \"name\": \"wf\",\n \"description\": null,\n \"definition\": \"---\\nversion: '2.0'\\nworkflow:\\n type: direct\\n tasks:\\n 0_seconds_1:\\n action: civis.run_job\\n input:\\n job_id: 1\\n\",\n \"valid\": true,\n \"validationErrors\": null,\n \"fileId\": 20,\n \"user\": {\n \"id\": 11,\n \"name\": \"User devuserfactory6 6\",\n \"username\": \"devuserfactory6\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"state\": \"idle\",\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n },\n \"allowConcurrentExecutions\": true,\n \"timeZone\": \"America/Chicago\",\n \"nextExecutionAt\": null,\n \"notifications\": {\n \"urls\": [\n\n ],\n \"successEmailSubject\": null,\n \"successEmailBody\": null,\n \"successEmailAddresses\": [\n\n ],\n \"failureEmailAddresses\": [\n\n ],\n \"stallWarningMinutes\": null,\n \"successOn\": true,\n \"failureOn\": true\n },\n \"archived\": false,\n \"hidden\": false,\n \"myPermissionLevel\": \"manage\",\n \"createdAt\": \"2024-05-22T22:51:30.000Z\",\n \"updatedAt\": \"2024-05-22T22:51:30.000Z\"\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"b9947b8a45d31b4f417fe86cd92713a4\"","X-Request-Id":"f668d07d-10c4-4201-9e78-09199f1a1341","X-Runtime":"0.134885","Content-Length":"929"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/workflows\" -d '{\"name\":\"wf\",\"from_job_chain\":1}' -X POST \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer OmVr97xtCmcCR2oqlLIztHNRYK8dFulSXbjdZPRHaZY\" \\\n\t-H \"Accept: application/vnd.civis-platform.v1\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Workflows","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/workflows","description":"create an invalid workflow","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/workflows","request_body":"{\n \"name\": \"wf\",\n \"definition\": \"---\\nversion: 2\\n\\nmy_workflow:\\n type: direct\\n tasks:\\n task_1: &run\\n action: civis.run_job\\n task_2:\\n <<: *run\\n\"\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer Y2bZR6lhgZJw3uMw1qogKc6xZOGaW5l8-ttxDedctgY","Accept":"application/vnd.civis-platform.v1","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":201,"response_status_text":"Created","response_body":"{\n \"id\": 24,\n \"name\": \"wf\",\n \"description\": null,\n \"definition\": \"---\\nversion: 2\\n\\nmy_workflow:\\n type: direct\\n tasks:\\n task_1: &run\\n action: civis.run_job\\n task_2:\\n <<: *run\\n\",\n \"valid\": true,\n \"validationErrors\": null,\n \"fileId\": 24,\n \"user\": {\n \"id\": 12,\n \"name\": \"User devuserfactory7 7\",\n \"username\": \"devuserfactory7\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"state\": \"idle\",\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n },\n \"allowConcurrentExecutions\": true,\n \"timeZone\": \"America/Chicago\",\n \"nextExecutionAt\": null,\n \"notifications\": {\n \"urls\": [\n\n ],\n \"successEmailSubject\": null,\n \"successEmailBody\": null,\n \"successEmailAddresses\": [\n\n ],\n \"failureEmailAddresses\": [\n\n ],\n \"stallWarningMinutes\": null,\n \"successOn\": true,\n \"failureOn\": true\n },\n \"archived\": false,\n \"hidden\": false,\n \"myPermissionLevel\": \"manage\",\n \"createdAt\": \"2024-05-22T22:51:30.000Z\",\n \"updatedAt\": \"2024-05-22T22:51:30.000Z\"\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"36c99af84741b55473ee3bd463823308\"","X-Request-Id":"0027adef-9942-4143-a1df-35316ed5af9f","X-Runtime":"0.113178","Content-Length":"941"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/workflows\" -d '{\"name\":\"wf\",\"definition\":\"---\\nversion: 2\\n\\nmy_workflow:\\n type: direct\\n tasks:\\n task_1: \\u0026run\\n action: civis.run_job\\n task_2:\\n \\u003c\\u003c: *run\\n\"}' -X POST \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer Y2bZR6lhgZJw3uMw1qogKc6xZOGaW5l8-ttxDedctgY\" \\\n\t-H \"Accept: application/vnd.civis-platform.v1\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/workflows/{id}":{"get":{"summary":"Get a Workflow","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object731"}}},"x-examples":[{"resource":"Workflows","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/workflows/:id","description":"View a workflow's details","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/workflows/10","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer GQNnU4-e8NmRdkcX5by3EbAh-grMd22nzy41QOd-ttg","Accept":"application/vnd.civis-platform.v1","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 10,\n \"name\": \"Test Workflow\",\n \"description\": null,\n \"definition\": \"---\\nversion: 2\\n\\nmy_workflow:\\n type: direct\\n tasks:\\n task_1: &run\\n action: civis.run_job\\n task_2:\\n <<: *run\\n\",\n \"valid\": true,\n \"validationErrors\": null,\n \"fileId\": 10,\n \"user\": {\n \"id\": 9,\n \"name\": \"User devuserfactory4 4\",\n \"username\": \"devuserfactory4\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"state\": \"idle\",\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n },\n \"allowConcurrentExecutions\": true,\n \"timeZone\": \"America/Chicago\",\n \"nextExecutionAt\": null,\n \"notifications\": {\n \"urls\": [\n\n ],\n \"successEmailSubject\": null,\n \"successEmailBody\": null,\n \"successEmailAddresses\": [\n\n ],\n \"failureEmailAddresses\": [\n\n ],\n \"stallWarningMinutes\": null,\n \"successOn\": true,\n \"failureOn\": true\n },\n \"archived\": false,\n \"hidden\": false,\n \"myPermissionLevel\": \"manage\",\n \"createdAt\": \"2024-05-22T22:51:29.000Z\",\n \"updatedAt\": \"2024-05-22T22:51:29.000Z\"\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"f1e9c8c16ca08a86bace76aade4b3f1c\"","X-Request-Id":"7f2447b3-e6ca-4495-8ba5-aa357a52de10","X-Runtime":"0.034994","Content-Length":"951"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/workflows/10\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer GQNnU4-e8NmRdkcX5by3EbAh-grMd22nzy41QOd-ttg\" \\\n\t-H \"Accept: application/vnd.civis-platform.v1\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"put":{"summary":"Replace all attributes of this Workflow","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID for this workflow.","type":"integer"},{"name":"Object733","in":"body","schema":{"$ref":"#/definitions/Object733"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object731"}}},"x-examples":null,"x-deprecation-warning":null},"patch":{"summary":"Update some attributes of this Workflow","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID for this workflow.","type":"integer"},{"name":"Object734","in":"body","schema":{"$ref":"#/definitions/Object734"},"required":false}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object731"}}},"x-examples":null,"x-deprecation-warning":null}},"/workflows/{id}/shares":{"get":{"summary":"List users and groups permissioned on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object9"}}}},"x-examples":null,"x-deprecation-warning":null}},"/workflows/{id}/shares/users":{"put":{"summary":"Set the permissions users have on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"Object735","in":"body","schema":{"$ref":"#/definitions/Object735"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object9"}}},"x-examples":null,"x-deprecation-warning":null}},"/workflows/{id}/shares/users/{user_id}":{"delete":{"summary":"Revoke the permissions a user has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"user_id","in":"path","required":true,"description":"The ID of the user.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/workflows/{id}/shares/groups":{"put":{"summary":"Set the permissions groups has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"Object736","in":"body","schema":{"$ref":"#/definitions/Object736"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object9"}}},"x-examples":null,"x-deprecation-warning":null}},"/workflows/{id}/shares/groups/{group_id}":{"delete":{"summary":"Revoke the permissions a group has on this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"group_id","in":"path","required":true,"description":"The ID of the group.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/workflows/{id}/dependencies":{"get":{"summary":"List dependent objects for this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"user_id","in":"query","required":false,"description":"ID of target user","type":"integer"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object15"}}}},"x-examples":[{"resource":"Workflows","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/workflows/:id/dependencies","description":"Get all workflow dependencies","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/workflows/32/dependencies","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer GejPR1MlITDj1pddk_FjXaN1uCk49S7hpcR-bwTEU-s","Accept":"application/vnd.civis-platform.v1","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"objectType\": \"JobTypes::PythonDocker\",\n \"fcoType\": \"scripts/python3\",\n \"id\": 4,\n \"name\": \"Script #4\",\n \"permissionLevel\": null,\n \"description\": null,\n \"shareable\": true\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"ec324f877544ba95e18f9b1c59590096\"","X-Request-Id":"f8b66b94-d2ba-4902-b8b3-1f13e9e78f92","X-Runtime":"0.042823","Content-Length":"154"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/workflows/32/dependencies\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer GejPR1MlITDj1pddk_FjXaN1uCk49S7hpcR-bwTEU-s\" \\\n\t-H \"Accept: application/vnd.civis-platform.v1\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Workflows","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/workflows/:id/dependencies","description":"Get all workflow dependencies using a target user","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/workflows/36/dependencies?user_id=18","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer kOUs9VRMxk9UdaOMq2OpLV6x1WnGq9QJKQgQkZseAvM","Accept":"application/vnd.civis-platform.v1","Host":"api.civis.test","Cookie":""},"request_query_parameters":{"user_id":"18"},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"objectType\": \"JobTypes::PythonDocker\",\n \"fcoType\": \"scripts/python3\",\n \"id\": 7,\n \"name\": \"Script #7\",\n \"permissionLevel\": \"write\",\n \"description\": null,\n \"shareable\": true\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"c6af09ea9769478cbc76e42f557bf86a\"","X-Request-Id":"fa26d2bf-9027-4cd8-8b80-a7899ab94fdd","X-Runtime":"0.048351","Content-Length":"157"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/workflows/36/dependencies?user_id=18\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer kOUs9VRMxk9UdaOMq2OpLV6x1WnGq9QJKQgQkZseAvM\" \\\n\t-H \"Accept: application/vnd.civis-platform.v1\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/workflows/{id}/transfer":{"put":{"summary":"Transfer ownership of this object to another user","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the resource that is shared.","type":"integer"},{"name":"Object737","in":"body","schema":{"$ref":"#/definitions/Object737"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object17"}}},"x-examples":[{"resource":"Workflows","resource_explanation":null,"http_method":"PUT","route":"http://api.civis.test/workflows/:id/transfer","description":"Transfer object to another user, without transfering dependencies","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"PUT","request_path":"http://api.civis.test/workflows/40/transfer","request_body":"{\n \"user_id\": 24,\n \"include_dependencies\": false\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer oHZwZD1PiV2NH3EqWPTJKkl_wSgYH5aCfcBswJyjzyY","Accept":"application/vnd.civis-platform.v1","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"dependencies\": [\n\n ]\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"81059fe6210ccee4e3349c0f34c12d18\"","X-Request-Id":"4de92ce1-2985-4d18-a1ea-565888da3194","X-Runtime":"0.251599","Content-Length":"19"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/workflows/40/transfer\" -d '{\"user_id\":24,\"include_dependencies\":false}' -X PUT \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer oHZwZD1PiV2NH3EqWPTJKkl_wSgYH5aCfcBswJyjzyY\" \\\n\t-H \"Accept: application/vnd.civis-platform.v1\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Workflows","resource_explanation":null,"http_method":"PUT","route":"http://api.civis.test/workflows/:id/transfer","description":"Transfer object to another user, including dependencies","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"PUT","request_path":"http://api.civis.test/workflows/44/transfer","request_body":"{\n \"user_id\": 28,\n \"include_dependencies\": true\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer ewHziGa4NqP4KBJJjqoBDbnpP05zqz0U_Qc1dw6BDDk","Accept":"application/vnd.civis-platform.v1","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"dependencies\": [\n {\n \"objectType\": \"JobTypes::PythonDocker\",\n \"fcoType\": \"scripts/python3\",\n \"id\": 13,\n \"name\": \"Script #13\",\n \"permissionLevel\": \"manage\",\n \"description\": null,\n \"shared\": true\n }\n ]\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"b19a6595337e726ea5632e5f999ebed9\"","X-Request-Id":"e46a197c-d539-48b7-8c8a-1325ba587f12","X-Runtime":"0.229748","Content-Length":"174"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/workflows/44/transfer\" -d '{\"user_id\":28,\"include_dependencies\":true}' -X PUT \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer ewHziGa4NqP4KBJJjqoBDbnpP05zqz0U_Qc1dw6BDDk\" \\\n\t-H \"Accept: application/vnd.civis-platform.v1\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/workflows/{id}/archive":{"put":{"summary":"Update the archive status of this object","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the object.","type":"integer"},{"name":"Object738","in":"body","schema":{"$ref":"#/definitions/Object738"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object731"}}},"x-examples":null,"x-deprecation-warning":null}},"/workflows/{id}/projects":{"get":{"summary":"List the projects a Workflow belongs to","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Workflow.","type":"integer"},{"name":"hidden","in":"query","required":false,"description":"If specified to be true, returns hidden items. Defaults to false, returning non-hidden items.","type":"boolean"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object85"}}}},"x-examples":null,"x-deprecation-warning":null}},"/workflows/{id}/projects/{project_id}":{"put":{"summary":"Add a Workflow to a project","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Workflow.","type":"integer"},{"name":"project_id","in":"path","required":true,"description":"The ID of the project.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null},"delete":{"summary":"Remove a Workflow from a project","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the Workflow.","type":"integer"},{"name":"project_id","in":"path","required":true,"description":"The ID of the project.","type":"integer"}],"responses":{"204":{"description":"success"}},"x-examples":null,"x-deprecation-warning":null}},"/workflows/{id}/git":{"get":{"summary":"Get the git metadata attached to an item","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the item.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object403"}}},"x-examples":null,"x-deprecation-warning":null},"put":{"summary":"Attach an item to a file in a git repo","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the item.","type":"integer"},{"name":"Object404","in":"body","schema":{"$ref":"#/definitions/Object404"},"required":false}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object403"}}},"x-examples":null,"x-deprecation-warning":null},"patch":{"summary":"Update an attached git file","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the item.","type":"integer"},{"name":"Object404","in":"body","schema":{"$ref":"#/definitions/Object404"},"required":false}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object403"}}},"x-examples":null,"x-deprecation-warning":null}},"/workflows/{id}/git/commits":{"get":{"summary":"Get the git commits for an item on the current branch","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the item.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object405"}}},"x-examples":null,"x-deprecation-warning":null},"post":{"summary":"Commit and push a new version of the file","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the item.","type":"integer"},{"name":"Object406","in":"body","schema":{"$ref":"#/definitions/Object406"},"required":true}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object407"}}},"x-examples":null,"x-deprecation-warning":null}},"/workflows/{id}/git/commits/{commit_hash}":{"get":{"summary":"Get file contents at git ref","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the item.","type":"integer"},{"name":"commit_hash","in":"path","required":true,"description":"The SHA (full or shortened) of the desired git commit.","type":"string"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object407"}}},"x-examples":null,"x-deprecation-warning":null}},"/workflows/{id}/git/checkout-latest":{"post":{"summary":"Checkout latest commit on the current branch of a script or workflow","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID of the item.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object407"}}},"x-examples":null,"x-deprecation-warning":null}},"/workflows/{id}/clone":{"post":{"summary":"Clone this Workflow","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID for the workflow.","type":"integer"},{"name":"Object739","in":"body","schema":{"$ref":"#/definitions/Object739"},"required":false}],"responses":{"201":{"description":"success","schema":{"$ref":"#/definitions/Object731"}}},"x-examples":[{"resource":"Workflows","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/workflows/:id/clone","description":"clone a workflow","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/workflows/25/clone","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer 2k57MsTZfCGXKYnA2FOsBuO9dG9oKxpWTCD_whFT2Q0","Accept":"application/vnd.civis-platform.v1","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":201,"response_status_text":"Created","response_body":"{\n \"id\": 28,\n \"name\": \"Clone of Workflow 25 Test Workflow\",\n \"description\": null,\n \"definition\": \"---\\nversion: 2\\n\\nmy_workflow:\\n type: direct\\n tasks:\\n task_1: &run\\n action: civis.run_job\\n task_2:\\n <<: *run\\n\",\n \"valid\": true,\n \"validationErrors\": null,\n \"fileId\": 28,\n \"user\": {\n \"id\": 13,\n \"name\": \"User devuserfactory8 8\",\n \"username\": \"devuserfactory8\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"state\": \"idle\",\n \"schedule\": {\n \"scheduled\": null,\n \"scheduledDays\": [\n\n ],\n \"scheduledHours\": [\n\n ],\n \"scheduledMinutes\": [\n\n ],\n \"scheduledRunsPerHour\": null,\n \"scheduledDaysOfMonth\": [\n\n ]\n },\n \"allowConcurrentExecutions\": true,\n \"timeZone\": \"America/Chicago\",\n \"nextExecutionAt\": null,\n \"notifications\": {\n \"urls\": [\n\n ],\n \"successEmailSubject\": null,\n \"successEmailBody\": null,\n \"successEmailAddresses\": [\n \"devuserfactory88user@localhost.test\"\n ],\n \"failureEmailAddresses\": [\n \"devuserfactory88user@localhost.test\"\n ],\n \"stallWarningMinutes\": null,\n \"successOn\": true,\n \"failureOn\": true\n },\n \"archived\": false,\n \"hidden\": false,\n \"myPermissionLevel\": \"manage\",\n \"createdAt\": \"2024-05-22T22:51:31.000Z\",\n \"updatedAt\": \"2024-05-22T22:51:31.000Z\"\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"fded054f9a569b67aa9e142e103fcf9e\"","X-Request-Id":"ff7668ee-df96-42c3-8894-0a273a70912e","X-Runtime":"0.115785","Content-Length":"1047"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/workflows/25/clone\" -d '' -X POST \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer 2k57MsTZfCGXKYnA2FOsBuO9dG9oKxpWTCD_whFT2Q0\" \\\n\t-H \"Accept: application/vnd.civis-platform.v1\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/workflows/{id}/executions":{"get":{"summary":"List workflow executions","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID for this workflow.","type":"integer"},{"name":"limit","in":"query","required":false,"description":"Number of results to return. Defaults to 20. Maximum allowed is 50.","type":"integer"},{"name":"page_num","in":"query","required":false,"description":"Page number of the results to return. Defaults to the first page, 1.","type":"integer"},{"name":"order","in":"query","required":false,"description":"The field on which to order the result set. Defaults to id. Must be one of: id, updated_at, created_at.","type":"string"},{"name":"order_dir","in":"query","required":false,"description":"Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc.","type":"string"}],"responses":{"200":{"description":"success","schema":{"type":"array","items":{"$ref":"#/definitions/Object740"}}}},"x-examples":[{"resource":"Workflows","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/workflows/:id/executions","description":"list workflow executions","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/workflows/48/executions","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer P7bjt9bkgOtv0Y8cK11wlvyS9lE0AzGlnWR51FC9EJc","Accept":"application/vnd.civis-platform.v1","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"[\n {\n \"id\": 3,\n \"state\": \"running\",\n \"mistralState\": \"running\",\n \"mistralStateInfo\": \"Execution is running\",\n \"user\": {\n \"id\": 30,\n \"name\": \"User devuserfactory25 25\",\n \"username\": \"devuserfactory25\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"startedAt\": \"2024-05-22T22:51:34.000Z\",\n \"finishedAt\": null,\n \"createdAt\": \"2024-05-22T22:51:35.000Z\",\n \"updatedAt\": \"2024-05-22T22:51:35.000Z\"\n },\n {\n \"id\": 2,\n \"state\": \"running\",\n \"mistralState\": \"running\",\n \"mistralStateInfo\": \"Execution is running\",\n \"user\": {\n \"id\": 30,\n \"name\": \"User devuserfactory25 25\",\n \"username\": \"devuserfactory25\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"startedAt\": \"2024-05-22T22:51:34.000Z\",\n \"finishedAt\": null,\n \"createdAt\": \"2024-05-22T22:51:34.000Z\",\n \"updatedAt\": \"2024-05-22T22:51:35.000Z\"\n }\n]","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","X-Pagination-Per-Page":"20","Access-Control-Expose-Headers":"X-Pagination-Per-Page, X-Pagination-Current-Page, X-Pagination-Total-Pages, X-Pagination-Total-Entries","X-Pagination-Current-Page":"1","X-Pagination-Total-Pages":"1","X-Pagination-Total-Entries":"2","Content-Type":"application/json; charset=utf-8","ETag":"W/\"4a1da96cfa849abc81045e11284bcd92\"","X-Request-Id":"39f9d9da-b612-4603-a440-73635e022fee","X-Runtime":"0.040623","Content-Length":"681"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/workflows/48/executions\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer P7bjt9bkgOtv0Y8cK11wlvyS9lE0AzGlnWR51FC9EJc\" \\\n\t-H \"Accept: application/vnd.civis-platform.v1\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null},"post":{"summary":"Execute a workflow","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID for the workflow.","type":"integer"},{"name":"Object745","in":"body","schema":{"$ref":"#/definitions/Object745"},"required":false}],"responses":{"201":{"description":"success","schema":{"$ref":"#/definitions/Object741"}}},"x-examples":[{"resource":"Workflows","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/workflows/:id/executions","description":"execute a workflow","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/workflows/45/executions","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer RmJmy4nVIQlPqGtz5-jUp12hMpvuwTT7BhILLwl5dak","Accept":"application/vnd.civis-platform.v1","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":201,"response_status_text":"Created","response_body":"{\n \"id\": 1,\n \"state\": \"running\",\n \"mistralState\": \"running\",\n \"mistralStateInfo\": \"Execution is running\",\n \"user\": {\n \"id\": 29,\n \"name\": \"User devuserfactory24 24\",\n \"username\": \"devuserfactory24\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"definition\": \"---\\nversion: 2\\nmy_workflow:\\n type: direct\\n tasks:\\n task_1:\\n action: civis.run_job\\n task_2:\\n action: civis.run_job\\n\",\n \"input\": {\n },\n \"includedTasks\": [\n\n ],\n \"tasks\": [\n\n ],\n \"startedAt\": \"2024-05-22T22:51:34.000Z\",\n \"finishedAt\": null,\n \"createdAt\": \"2024-05-22T22:51:34.000Z\",\n \"updatedAt\": \"2024-05-22T22:51:34.000Z\"\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"5d510e2db043744b95a0d7954ab24925\"","X-Request-Id":"9020dc3d-9934-48fb-a3cb-07365001a68a","X-Runtime":"0.122870","Content-Length":"537"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/workflows/45/executions\" -d '' -X POST \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer RmJmy4nVIQlPqGtz5-jUp12hMpvuwTT7BhILLwl5dak\" \\\n\t-H \"Accept: application/vnd.civis-platform.v1\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/workflows/{id}/executions/{execution_id}":{"get":{"summary":"Get a workflow execution","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID for the workflow.","type":"integer"},{"name":"execution_id","in":"path","required":true,"description":"The ID for the workflow execution.","type":"integer"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object741"}}},"x-examples":[{"resource":"Workflows","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/workflows/:id/executions/:execution_id","description":"get workflow execution","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/workflows/51/executions/4","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer P8xtiPH3qjHsNIoeLvh14KRGM04vsv0MjPDc9V1Jrq0","Accept":"application/vnd.civis-platform.v1","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"id\": 4,\n \"state\": \"running\",\n \"mistralState\": \"running\",\n \"mistralStateInfo\": \"Execution is running\",\n \"user\": {\n \"id\": 31,\n \"name\": \"User devuserfactory26 26\",\n \"username\": \"devuserfactory26\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"definition\": \"---\\nversion: 2\\nmy_workflow:\\n type: direct\\n tasks:\\n task_1:\\n action: civis.run_job\\n task_2:\\n action: civis.run_job\\n\",\n \"input\": {\n },\n \"includedTasks\": [\n\n ],\n \"tasks\": [\n {\n \"name\": \"load\",\n \"mistralState\": \"running\",\n \"mistralStateInfo\": null,\n \"runs\": [\n\n ],\n \"executions\": [\n\n ]\n }\n ],\n \"startedAt\": \"2024-05-22T22:51:35.000Z\",\n \"finishedAt\": null,\n \"createdAt\": \"2024-05-22T22:51:35.000Z\",\n \"updatedAt\": \"2024-05-22T22:51:35.000Z\"\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"6fa89a29ef9ea9ff52d6248c5cda36a7\"","X-Request-Id":"70cee414-1f5a-4e37-8e12-f690a8589c74","X-Runtime":"0.049116","Content-Length":"627"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/workflows/51/executions/4\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer P8xtiPH3qjHsNIoeLvh14KRGM04vsv0MjPDc9V1Jrq0\" \\\n\t-H \"Accept: application/vnd.civis-platform.v1\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/workflows/{id}/executions/{execution_id}/cancel":{"post":{"summary":"Cancel a workflow execution","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID for the workflow.","type":"integer"},{"name":"execution_id","in":"path","required":true,"description":"The ID for the workflow execution.","type":"integer"}],"responses":{"202":{"description":"success","schema":{"$ref":"#/definitions/Object741"}}},"x-examples":[{"resource":"Workflows","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/workflows/:id/executions/:execution_id/cancel","description":"cancel the workflow execution","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/workflows/57/executions/6/cancel","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer NRZOZ_HOFNynEe670P7Ft21RUWgmUy-Lj6Y2NC0jQT8","Accept":"application/vnd.civis-platform.v1","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":202,"response_status_text":"Accepted","response_body":"{\n \"id\": 6,\n \"state\": \"running\",\n \"mistralState\": \"running\",\n \"mistralStateInfo\": \"Execution is running\",\n \"user\": {\n \"id\": 35,\n \"name\": \"User devuserfactory30 30\",\n \"username\": \"devuserfactory30\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"definition\": \"---\\nversion: 2\\nmy_workflow:\\n type: direct\\n tasks:\\n task_1:\\n action: civis.run_job\\n task_2:\\n action: civis.run_job\\n\",\n \"input\": {\n },\n \"includedTasks\": [\n\n ],\n \"tasks\": [\n\n ],\n \"startedAt\": \"2024-05-22T22:51:36.000Z\",\n \"finishedAt\": null,\n \"createdAt\": \"2024-05-22T22:51:36.000Z\",\n \"updatedAt\": \"2024-05-22T22:51:36.000Z\"\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","X-Request-Id":"03fd7c5d-1bb7-4898-88db-3c800c5b1a46","X-Runtime":"0.057933","Content-Length":"537"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/workflows/57/executions/6/cancel\" -d '' -X POST \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer NRZOZ_HOFNynEe670P7Ft21RUWgmUy-Lj6Y2NC0jQT8\" \\\n\t-H \"Accept: application/vnd.civis-platform.v1\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/workflows/{id}/executions/{execution_id}/resume":{"post":{"summary":"Resume a paused workflow execution","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID for the workflow.","type":"integer"},{"name":"execution_id","in":"path","required":true,"description":"The ID for the workflow execution.","type":"integer"}],"responses":{"202":{"description":"success","schema":{"$ref":"#/definitions/Object741"}}},"x-examples":[{"resource":"Workflows","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/workflows/:id/executions/:execution_id/resume","description":"resume a paused workflow execution","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/workflows/60/executions/7/resume","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer 4Xr36FnrHDlRLeyrF5aZ1TLrE-J2jGlr6vtsoLCC3ic","Accept":"application/vnd.civis-platform.v1","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":202,"response_status_text":"Accepted","response_body":"{\n \"id\": 7,\n \"state\": \"running\",\n \"mistralState\": \"running\",\n \"mistralStateInfo\": \"Execution is running\",\n \"user\": {\n \"id\": 36,\n \"name\": \"User devuserfactory31 31\",\n \"username\": \"devuserfactory31\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"definition\": \"---\\nversion: 2\\nmy_workflow:\\n type: direct\\n tasks:\\n task_1:\\n action: civis.run_job\\n task_2:\\n action: civis.run_job\\n\",\n \"input\": {\n },\n \"includedTasks\": [\n\n ],\n \"tasks\": [\n\n ],\n \"startedAt\": \"2024-05-22T22:51:36.000Z\",\n \"finishedAt\": null,\n \"createdAt\": \"2024-05-22T22:51:36.000Z\",\n \"updatedAt\": \"2024-05-22T22:51:36.000Z\"\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","X-Request-Id":"39a57502-7ec5-40a5-aeff-b22b153b0031","X-Runtime":"0.060767","Content-Length":"537"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/workflows/60/executions/7/resume\" -d '' -X POST \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer 4Xr36FnrHDlRLeyrF5aZ1TLrE-J2jGlr6vtsoLCC3ic\" \\\n\t-H \"Accept: application/vnd.civis-platform.v1\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/workflows/{id}/executions/{execution_id}/retry":{"post":{"summary":"Retry a failed task, or all failed tasks in an execution","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID for the workflow.","type":"integer"},{"name":"execution_id","in":"path","required":true,"description":"The ID for the workflow execution.","type":"integer"},{"name":"Object747","in":"body","schema":{"$ref":"#/definitions/Object747"},"required":false}],"responses":{"202":{"description":"success","schema":{"$ref":"#/definitions/Object741"}}},"x-examples":[{"resource":"Workflows","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/workflows/:id/executions/:execution_id/retry","description":"retry all failed tasks in a workflow execution","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/workflows/63/executions/8/retry","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer X1BnSwJQRs8qSygJ7waYtwZ8IUy2wQXXLeYSmxnkaZQ","Accept":"application/vnd.civis-platform.v1","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":202,"response_status_text":"Accepted","response_body":"{\n \"id\": 8,\n \"state\": \"running\",\n \"mistralState\": \"running\",\n \"mistralStateInfo\": \"Execution is running\",\n \"user\": {\n \"id\": 37,\n \"name\": \"User devuserfactory32 32\",\n \"username\": \"devuserfactory32\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"definition\": \"---\\nversion: 2\\nmy_workflow:\\n type: direct\\n tasks:\\n task_1:\\n action: civis.run_job\\n task_2:\\n action: civis.run_job\\n\",\n \"input\": {\n },\n \"includedTasks\": [\n\n ],\n \"tasks\": [\n {\n \"name\": \"load\",\n \"mistralState\": \"running\",\n \"mistralStateInfo\": null,\n \"runs\": [\n\n ],\n \"executions\": [\n\n ]\n }\n ],\n \"startedAt\": \"2024-05-22T22:51:36.000Z\",\n \"finishedAt\": null,\n \"createdAt\": \"2024-05-22T22:51:36.000Z\",\n \"updatedAt\": \"2024-05-22T22:51:36.000Z\"\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","X-Request-Id":"bb31e148-0ecc-4b83-b405-64f298d34dc8","X-Runtime":"0.050723","Content-Length":"627"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/workflows/63/executions/8/retry\" -d '' -X POST \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer X1BnSwJQRs8qSygJ7waYtwZ8IUy2wQXXLeYSmxnkaZQ\" \\\n\t-H \"Accept: application/vnd.civis-platform.v1\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]},{"resource":"Workflows","resource_explanation":null,"http_method":"POST","route":"http://api.civis.test/workflows/:id/executions/:execution_id/retry","description":"retry one failed task in a workflow execution","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"POST","request_path":"http://api.civis.test/workflows/66/executions/9/retry","request_body":"{\n \"task_name\": \"load\"\n}","request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer XbPzJsExyJI6CQpUIjs_B-1aZds6SXYZ9fCYE2-TBM8","Accept":"application/vnd.civis-platform.v1","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":202,"response_status_text":"Accepted","response_body":"{\n \"id\": 9,\n \"state\": \"running\",\n \"mistralState\": \"running\",\n \"mistralStateInfo\": \"Execution is running\",\n \"user\": {\n \"id\": 38,\n \"name\": \"User devuserfactory33 33\",\n \"username\": \"devuserfactory33\",\n \"initials\": \"UD\",\n \"online\": null\n },\n \"definition\": \"---\\nversion: 2\\nmy_workflow:\\n type: direct\\n tasks:\\n task_1:\\n action: civis.run_job\\n task_2:\\n action: civis.run_job\\n\",\n \"input\": {\n },\n \"includedTasks\": [\n\n ],\n \"tasks\": [\n {\n \"name\": \"load\",\n \"mistralState\": \"running\",\n \"mistralStateInfo\": null,\n \"runs\": [\n\n ],\n \"executions\": [\n\n ]\n }\n ],\n \"startedAt\": \"2024-05-22T22:51:37.000Z\",\n \"finishedAt\": null,\n \"createdAt\": \"2024-05-22T22:51:37.000Z\",\n \"updatedAt\": \"2024-05-22T22:51:37.000Z\"\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","X-Request-Id":"58e327a0-d7f6-4b4f-b21c-8d795a1dfa54","X-Runtime":"0.048342","Content-Length":"627"},"response_content_type":"application/json; charset=utf-8","curl":"curl \"api.civis.testhttp://api.civis.test/workflows/66/executions/9/retry\" -d '{\"task_name\":\"load\"}' -X POST \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer XbPzJsExyJI6CQpUIjs_B-1aZds6SXYZ9fCYE2-TBM8\" \\\n\t-H \"Accept: application/vnd.civis-platform.v1\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}},"/workflows/{id}/executions/{execution_id}/tasks/{task_name}":{"get":{"summary":"Get a task of a workflow execution","description":null,"deprecated":false,"parameters":[{"name":"id","in":"path","required":true,"description":"The ID for the workflow.","type":"integer"},{"name":"execution_id","in":"path","required":true,"description":"The ID for the workflow execution.","type":"integer"},{"name":"task_name","in":"path","required":true,"description":"The URL-encoded name of the task.","type":"string"}],"responses":{"200":{"description":"success","schema":{"$ref":"#/definitions/Object748"}}},"x-examples":[{"resource":"Workflows","resource_explanation":null,"http_method":"GET","route":"http://api.civis.test/workflows/:id/executions/:execution_id/tasks/:task_name","description":"get details for a task in a workflow execution","explanation":null,"parameters":[],"response_fields":[],"requests":[{"request_method":"GET","request_path":"http://api.civis.test/workflows/54/executions/5/tasks/load","request_body":null,"request_headers":{"Version":"HTTP/1.0","Content-Type":"application/json","Authorization":"Bearer 6nzBTLbMFt6OMioBGBu3_UynvMJ2Q5aEPZ8qqhe27QY","Accept":"application/vnd.civis-platform.v1","Host":"api.civis.test","Cookie":""},"request_query_parameters":{},"request_content_type":"application/json","response_status":200,"response_status_text":"OK","response_body":"{\n \"name\": \"load\",\n \"mistralState\": \"running\",\n \"mistralStateInfo\": null,\n \"runs\": [\n\n ],\n \"executions\": [\n\n ]\n}","response_headers":{"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","X-Download-Options":"noopen","X-Permitted-Cross-Domain-Policies":"none","Referrer-Policy":"strict-origin-when-cross-origin","Access-Control-Allow-Origin":"null","Vary":"Origin","Cache-Control":"private, no-store","Pragma":"no-cache","Expires":"0","Content-Type":"application/json; charset=utf-8","ETag":"W/\"2238f441f0272f023c85ea5e6ce5f8ca\"","X-Request-Id":"7f679911-22eb-4fa3-950b-0436ed070aae","X-Runtime":"0.036737","Content-Length":"90"},"response_content_type":"application/json; charset=utf-8","curl":"curl -g \"api.civis.testhttp://api.civis.test/workflows/54/executions/5/tasks/load\" -X GET \\\n\t-H \"Version: HTTP/1.0\" \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Bearer 6nzBTLbMFt6OMioBGBu3_UynvMJ2Q5aEPZ8qqhe27QY\" \\\n\t-H \"Accept: application/vnd.civis-platform.v1\" \\\n\t-H \"Host: api.civis.test\" \\\n\t-H \"Cookie: \""}]}],"x-deprecation-warning":null}}},"definitions":{"Object0":{"type":"object","properties":{"id":{"description":"The ID of this announcement","type":"integer"},"subject":{"description":"The subject of this announcement.","type":"string"},"body":{"description":"The body of this announcement.","type":"string"},"releasedAt":{"description":"The date and time this announcement was released.","type":"string","format":"date-time"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}}},"Object8":{"type":"object","properties":{"dedicatedDjPoolEnabled":{"description":"If true, the Organization has a dedicated delayed jobs pool. Defaults to false.","type":"boolean"}}},"Object7":{"type":"object","properties":{"id":{"description":"The ID of this organization.","type":"integer"},"name":{"description":"The name of this organization.","type":"string"},"slug":{"description":"The slug of this organization.","type":"string"},"accountManagerId":{"description":"The user ID of the Account Manager.","type":"integer"},"csSpecialistId":{"description":"The user ID of the Client Success Specialist.","type":"integer"},"status":{"description":"The status of the organization (active/trial/inactive).","type":"string"},"orgType":{"description":"The organization type (platform/ads/survey_vendor/other).","type":"string"},"customBranding":{"description":"The custom branding settings.","type":"string"},"contractSize":{"description":"The monthly contract size.","type":"integer"},"maxAnalystUsers":{"description":"The max number of full platform users for the org.","type":"integer"},"maxReportUsers":{"description":"The max number of report-only platform users for the org.","type":"integer"},"vertical":{"description":"The business vertical that the organization belongs to.","type":"string"},"csMetadata":{"description":"Additional metadata about the organization in JSON format.","type":"string"},"removeFooterInEmails":{"description":"If true, emails sent by platform will not include Civis text.","type":"boolean"},"salesforceAccountId":{"description":"The Salesforce Account ID for this organization.","type":"string"},"tableauSiteId":{"description":"The Tableau Site ID for this organization.","type":"string"},"fedrampEnabled":{"description":"Flag denoting whether this organization is FedRAMP compliant.","type":"boolean"},"createdById":{"description":"The ID of the user who created this organization","type":"integer"},"lastUpdatedById":{"description":"The ID of the user who last updated this organization","type":"integer"},"advancedSettings":{"description":"The advanced settings for this organization.","$ref":"#/definitions/Object8"},"tableauRefreshHistory":{"description":"The number of tableau refreshes used this month.","type":"array","items":{"type":"object"}}}},"Object11":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"}}},"Object12":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"}}},"Object10":{"type":"object","properties":{"users":{"type":"array","items":{"$ref":"#/definitions/Object11"}},"groups":{"type":"array","items":{"$ref":"#/definitions/Object12"}}}},"Object9":{"type":"object","properties":{"readers":{"$ref":"#/definitions/Object10"},"writers":{"$ref":"#/definitions/Object10"},"owners":{"$ref":"#/definitions/Object10"},"totalUserShares":{"description":"For owners, the number of total users shared. For writers and readers, the number of visible users shared.","type":"integer"},"totalGroupShares":{"description":"For owners, the number of total groups shared. For writers and readers, the number of visible groups shared.","type":"integer"}}},"Object13":{"type":"object","properties":{"userIds":{"description":"An array of one or more user IDs.","type":"array","items":{"type":"integer"}},"permissionLevel":{"description":"Options are: \"read\", \"write\", or \"manage\".","type":"string"},"shareEmailBody":{"description":"Custom body text for e-mail sent on a share.","type":"string"},"sendSharedEmail":{"description":"Send email to the recipients of a share.","type":"boolean"}},"required":["userIds","permissionLevel"]},"Object14":{"type":"object","properties":{"groupIds":{"description":"An array of one or more group IDs.","type":"array","items":{"type":"integer"}},"permissionLevel":{"description":"Options are: \"read\", \"write\", or \"manage\".","type":"string"},"shareEmailBody":{"description":"Custom body text for e-mail sent on a share.","type":"string"},"sendSharedEmail":{"description":"Send email to the recipients of a share.","type":"boolean"}},"required":["groupIds","permissionLevel"]},"Object15":{"type":"object","properties":{"objectType":{"description":"Dependent object type","type":"string"},"fcoType":{"description":"Human readable dependent object type","type":"string"},"id":{"description":"Dependent object ID","type":"integer"},"name":{"description":"Dependent object name, or nil if the requesting user cannot read this object","type":"string"},"permissionLevel":{"description":"Permission level of target user (not user's groups) for dependent object. Null if no target user or not shareable (e.g. a database table).","type":"string"},"description":{"description":"Additional information about the dependency, if relevant","type":"string"},"shareable":{"description":"Whether or not the requesting user can share this object.","type":"boolean"}}},"Object16":{"type":"object","properties":{"userId":{"description":"ID of target user","type":"integer"},"includeDependencies":{"description":"Whether or not to give manage permissions on all dependencies","type":"boolean"},"emailBody":{"description":"Custom body text for e-mail sent on transfer.","type":"string"},"sendEmail":{"description":"Send email to the target user of the transfer?","type":"boolean"}},"required":["userId","includeDependencies"]},"Object18":{"type":"object","properties":{"objectType":{"description":"Dependent object type","type":"string"},"fcoType":{"description":"Human readable dependent object type","type":"string"},"id":{"description":"Dependent object ID","type":"integer"},"name":{"description":"Dependent object name, or nil if the requesting user cannot read this object","type":"string"},"permissionLevel":{"description":"Permission level of target user (not user's groups) for dependent object. Null if no target user or not shareable (e.g. a database table).","type":"string"},"description":{"description":"Additional information about the dependency, if relevant","type":"string"},"shared":{"description":"Whether dependent object was successfully shared with target user","type":"boolean"}}},"Object17":{"type":"object","properties":{"dependencies":{"description":"Dependent objects for this object","type":"array","items":{"$ref":"#/definitions/Object18"}}}},"Object19":{"type":"object","properties":{"id":{"description":"The id of the Alias object.","type":"integer"},"objectId":{"description":"The id of the object","type":"integer"},"objectType":{"description":"The type of the object. Valid types include: cass_ncoa, container_script, geocode, identity_resolution, dbt_script, python_script, r_script, javascript_script, sql_script, project, notebook, workflow, template_script, template_report, service, report, tableau and service_report.","type":"string"},"alias":{"description":"The alias of the object","type":"string"},"userId":{"description":"The id of the user who created the alias","type":"integer"},"displayName":{"description":"The display name of the Alias object. Defaults to object name if not provided.","type":"string"}}},"Object20":{"type":"object","properties":{"objectId":{"description":"The id of the object","type":"integer"},"objectType":{"description":"The type of the object. Valid types include: cass_ncoa, container_script, geocode, identity_resolution, dbt_script, python_script, r_script, javascript_script, sql_script, project, notebook, workflow, template_script, template_report, service, report, tableau and service_report.","type":"string"},"alias":{"description":"The alias of the object","type":"string"},"displayName":{"description":"The display name of the Alias object. Defaults to object name if not provided.","type":"string"}},"required":["objectId","objectType","alias"]},"Object21":{"type":"object","properties":{"objectId":{"description":"The id of the object","type":"integer"},"objectType":{"description":"The type of the object. Valid types include: cass_ncoa, container_script, geocode, identity_resolution, dbt_script, python_script, r_script, javascript_script, sql_script, project, notebook, workflow, template_script, template_report, service, report, tableau and service_report.","type":"string"},"alias":{"description":"The alias of the object","type":"string"},"displayName":{"description":"The display name of the Alias object. Defaults to object name if not provided.","type":"string"}},"required":["objectId","objectType","alias"]},"Object22":{"type":"object","properties":{"objectId":{"description":"The id of the object","type":"integer"},"objectType":{"description":"The type of the object. Valid types include: cass_ncoa, container_script, geocode, identity_resolution, dbt_script, python_script, r_script, javascript_script, sql_script, project, notebook, workflow, template_script, template_report, service, report, tableau and service_report.","type":"string"},"alias":{"description":"The alias of the object","type":"string"},"displayName":{"description":"The display name of the Alias object. Defaults to object name if not provided.","type":"string"}}},"Object27":{"type":"object","properties":{"pendingMemoryRequested":{"description":"The sum of memory requests (in MB) for pending deployments in this instance config.","type":"integer"},"pendingCpuRequested":{"description":"The sum of cpu requests (in millicores) for pending deployments in this instance config.","type":"integer"},"runningMemoryRequested":{"description":"The sum of memory requests (in MB) for running deployments in this instance config.","type":"integer"},"runningCpuRequested":{"description":"The sum of cpu requests (in millicores) for running deployments in this instance config.","type":"integer"},"pendingDeployments":{"description":"The number of pending deployments in this instance config.","type":"integer"},"runningDeployments":{"description":"The number of running deployments in this instance config.","type":"integer"}}},"Object26":{"type":"object","properties":{"instanceConfigId":{"description":"The ID of this InstanceConfig.","type":"integer"},"instanceType":{"description":"An EC2 instance type. Possible values include t2.large, m4.xlarge, m4.2xlarge, m4.4xlarge, m5.12xlarge, c5.18xlarge, and g6.2xlarge.","type":"string"},"minInstances":{"description":"The minimum number of instances of that type in this cluster.","type":"integer"},"maxInstances":{"description":"The maximum number of instances of that type in this cluster.","type":"integer"},"instanceMaxMemory":{"description":"The amount of memory (RAM) available to a single instance of that type in megabytes.","type":"integer"},"instanceMaxCpu":{"description":"The number of processor shares available to a single instance of that type in millicores.","type":"integer"},"instanceMaxDisk":{"description":"The amount of disk available to a single instance of that type in gigabytes.","type":"integer"},"usageStats":{"description":"Usage statistics for this instance config","$ref":"#/definitions/Object27"}}},"Object25":{"type":"object","properties":{"clusterPartitionId":{"description":"The ID of this cluster partition.","type":"integer"},"name":{"description":"The name of the cluster partition.","type":"string"},"labels":{"description":"Labels associated with this partition.","type":"array","items":{"type":"string"}},"instanceConfigs":{"description":"The instances configured for this cluster partition.","type":"array","items":{"$ref":"#/definitions/Object26"}},"defaultInstanceConfigId":{"description":"The id of the InstanceConfig that is the default for this partition.","type":"integer"}}},"Object24":{"type":"object","properties":{"id":{"description":"The ID of this cluster.","type":"integer"},"organizationId":{"description":"The id of this cluster's organization.","type":"string"},"organizationName":{"description":"The name of this cluster's organization.","type":"string"},"organizationSlug":{"description":"The slug of this cluster's organization.","type":"string"},"rawClusterSlug":{"description":"The slug of this cluster's raw configuration.","type":"string"},"customPartitions":{"description":"Whether this cluster has a custom partition configuration.","type":"boolean"},"clusterPartitions":{"description":"List of cluster partitions associated with this cluster.","type":"array","items":{"$ref":"#/definitions/Object25"}},"isNatEnabled":{"description":"Whether this cluster needs a NAT gateway or not.","type":"boolean"}}},"Object29":{"type":"object","properties":{"id":{"description":"The ID of this cluster.","type":"integer"},"organizationId":{"description":"The id of this cluster's organization.","type":"string"},"organizationName":{"description":"The name of this cluster's organization.","type":"string"},"organizationSlug":{"description":"The slug of this cluster's organization.","type":"string"},"rawClusterSlug":{"description":"The slug of this cluster's raw configuration.","type":"string"},"customPartitions":{"description":"Whether this cluster has a custom partition configuration.","type":"boolean"},"clusterPartitions":{"description":"List of cluster partitions associated with this cluster.","type":"array","items":{"$ref":"#/definitions/Object25"}},"isNatEnabled":{"description":"Whether this cluster needs a NAT gateway or not.","type":"boolean"},"hours":{"description":"The number of hours used this month for this cluster.","type":"number","format":"float"}}},"Object30":{"type":"object","properties":{"totalNormalizedHours":{"description":"The total number of normalized hours used by this cluster.","type":"integer"},"normalizedHoursByInstanceType":{"description":"Denotes the instance type the normalized hours are attributed to.","type":"string"},"updatedAt":{"type":"string","format":"time"},"monthAndYear":{"description":"The month and year the normalized hours are attributed to.","type":"string"}}},"Object33":{"type":"object","properties":{"id":{"description":"The ID of this user.","type":"integer"},"name":{"description":"This user's name.","type":"string"},"username":{"description":"This user's username.","type":"string"},"initials":{"description":"This user's initials.","type":"string"},"online":{"description":"Whether this user is online.","type":"boolean"}}},"Object32":{"type":"object","properties":{"id":{"description":"The id of this deployment.","type":"integer"},"name":{"description":"The name of the deployment.","type":"string"},"baseId":{"description":"The id of the base object associated with the deployment.","type":"integer"},"baseType":{"description":"The base type of this deployment.","type":"string"},"state":{"description":"The state of the deployment.","type":"string"},"cpu":{"description":"The CPU in millicores required by the deployment.","type":"integer"},"memory":{"description":"The memory in MB required by the deployment.","type":"integer"},"diskSpace":{"description":"The disk space in GB required by the deployment.","type":"integer"},"instanceType":{"description":"The EC2 instance type requested for the deployment.","type":"string"},"author":{"description":"The author/owner of the item.","$ref":"#/definitions/Object33"},"maxMemoryUsage":{"description":"If the deployment has finished, the maximum amount of memory used during the deployment, in MB.","type":"number","format":"float"},"maxCpuUsage":{"description":"If the deployment has finished, the maximum amount of cpu used during the deployment, in millicores.","type":"number","format":"float"},"createdAt":{"type":"string","format":"time"},"updatedAt":{"type":"string","format":"time"}}},"Object34":{"type":"object","properties":{"baseType":{"description":"The base type of this deployment","type":"string"},"state":{"description":"State of the deployment","type":"string"},"count":{"description":"Number of deployments of base type and state","type":"integer"},"totalCpu":{"description":"Total amount of CPU in millicores for deployments of base type and state","type":"integer"},"totalMemory":{"description":"Total amount of Memory in megabytes for deployments of base type and state","type":"integer"}}},"Object36":{"type":"object","properties":{"instanceType":{"description":"An EC2 instance type. Possible values include t2.large, m4.xlarge, m4.2xlarge, m4.4xlarge, m5.12xlarge, c5.18xlarge, and g6.2xlarge.","type":"string"},"minInstances":{"description":"The minimum number of instances of that type in this cluster.","type":"integer"},"maxInstances":{"description":"The maximum number of instances of that type in this cluster.","type":"integer"}},"required":["instanceType","minInstances","maxInstances"]},"Object35":{"type":"object","properties":{"instanceConfigs":{"description":"The instances configured for this cluster partition.","type":"array","items":{"$ref":"#/definitions/Object36"}},"name":{"description":"The name of the cluster partition.","type":"string"},"labels":{"description":"Labels associated with this partition.","type":"array","items":{"type":"string"}}},"required":["instanceConfigs","name","labels"]},"Object38":{"type":"object","properties":{"instanceType":{"description":"An EC2 instance type. Possible values include t2.large, m4.xlarge, m4.2xlarge, m4.4xlarge, m5.12xlarge, c5.18xlarge, and g6.2xlarge.","type":"string"},"minInstances":{"description":"The minimum number of instances of that type in this cluster.","type":"integer"},"maxInstances":{"description":"The maximum number of instances of that type in this cluster.","type":"integer"}}},"Object37":{"type":"object","properties":{"instanceConfigs":{"description":"The instances configured for this cluster partition.","type":"array","items":{"$ref":"#/definitions/Object38"}},"name":{"description":"The name of the cluster partition.","type":"string"},"labels":{"description":"Labels associated with this partition.","type":"array","items":{"type":"string"}}}},"Object39":{"type":"object","properties":{"instanceConfigId":{"description":"The ID of this InstanceConfig.","type":"integer"},"instanceType":{"description":"An EC2 instance type. Possible values include t2.large, m4.xlarge, m4.2xlarge, m4.4xlarge, m5.12xlarge, c5.18xlarge, and g6.2xlarge.","type":"string"},"minInstances":{"description":"The minimum number of instances of that type in this cluster.","type":"integer"},"maxInstances":{"description":"The maximum number of instances of that type in this cluster.","type":"integer"},"instanceMaxMemory":{"description":"The amount of memory (RAM) available to a single instance of that type in megabytes.","type":"integer"},"instanceMaxCpu":{"description":"The number of processor shares available to a single instance of that type in millicores.","type":"integer"},"instanceMaxDisk":{"description":"The amount of disk available to a single instance of that type in gigabytes.","type":"integer"},"usageStats":{"description":"Usage statistics for this instance config","$ref":"#/definitions/Object27"},"clusterPartitionId":{"description":"The ID of this InstanceConfig's cluster partition","type":"integer"},"clusterPartitionName":{"description":"The name of this InstanceConfig's cluster partition","type":"string"}}},"Object40":{"type":"object","properties":{"id":{"description":"The id of this deployment.","type":"integer"},"baseType":{"description":"The base type of this deployment.","type":"string"},"baseId":{"description":"The id of the base object associated with this deployment.","type":"integer"},"baseObjectName":{"description":"The name of the base object associated with this deployment. Null if you do not have permission to read the object.","type":"string"},"jobType":{"description":"If the base object is a job run you have permission to read, the type of the job. One of \"python_script\", \"r_script\", \"container_script\", or \"custom_script\".","type":"string"},"jobId":{"description":"If the base object is a job run you have permission to read, the id of the job.","type":"integer"},"jobCancelRequestedAt":{"description":"If the base object is a job run you have permission to read, and it was requested to be cancelled, the timestamp of that request.","type":"string","format":"time"},"state":{"description":"The state of this deployment.","type":"string"},"cpu":{"description":"The CPU in millicores requested by this deployment.","type":"integer"},"memory":{"description":"The memory in MB requested by this deployment.","type":"integer"},"diskSpace":{"description":"The disk space in GB requested by this deployment.","type":"integer"},"user":{"description":"The user who ran this deployment.","$ref":"#/definitions/Object33"},"createdAt":{"description":"The timestamp of when the deployment began.","type":"string","format":"time"},"cancellable":{"description":"True if you have permission to cancel this deployment.","type":"boolean"}}},"Object41":{"type":"object","properties":{"userId":{"description":"The owning user's ID","type":"string"},"userName":{"description":"The owning user's name","type":"string"},"pendingDeployments":{"description":"The number of deployments belonging to the owning user in \"pending\" state","type":"integer"},"pendingMemoryRequested":{"description":"The sum of memory requests (in MB) for deployments belonging to the owning user in \"pending\" state","type":"integer"},"pendingCpuRequested":{"description":"The sum of CPU requests (in millicores) for deployments belonging to the owning user in \"pending\" state","type":"integer"},"runningDeployments":{"description":"The number of deployments belonging to the owning user in \"running\" state","type":"integer"},"runningMemoryRequested":{"description":"The sum of memory requests (in MB) for deployments belonging to the owning user in \"running\" state","type":"integer"},"runningCpuRequested":{"description":"The sum of CPU requests (in millicores) for deployments belonging to the owning user in \"running\" state","type":"integer"}}},"Object42":{"type":"object","properties":{"cpuGraphUrl":{"description":"URL for the graph of historical CPU usage in this instance config.","type":"string"},"memGraphUrl":{"description":"URL for the graph of historical memory usage in this instance config.","type":"string"}}},"Object45":{"type":"object","properties":{"times":{"description":"The times associated with data points, in seconds since epoch.","type":"array","items":{"type":"integer"}},"values":{"description":"The values of the data points.","type":"array","items":{"type":"number","format":"float"}}}},"Object44":{"type":"object","properties":{"used":{"description":"The amount of a resource actually used.","$ref":"#/definitions/Object45"},"requested":{"description":"The amount of a resource requested.","$ref":"#/definitions/Object45"},"capacity":{"description":"The amount of a resource available.","$ref":"#/definitions/Object45"}}},"Object43":{"type":"object","properties":{"instanceConfigId":{"description":"The ID of this instance config.","type":"integer"},"metric":{"description":"URL for the graph of historical CPU usage in this instance config.","type":"string"},"timeframe":{"description":"The span of time that the graphs cover. Must be one of 1_day, 1_week.","type":"string"},"unit":{"description":"The unit of the values.","type":"string"},"metrics":{"description":"Metric times and values.","$ref":"#/definitions/Object44"}}},"Object57":{"type":"object","properties":{"message":{"description":"The log message.","type":"string"},"stream":{"description":"The stream of the log. One of \"stdout\", \"stderr\".","type":"string"},"createdAt":{"description":"The time the log was created.","type":"string","format":"date-time"},"source":{"description":"The source of the log. One of \"system\", \"user\".","type":"string"}}},"Object59":{"type":"object","properties":{"types":{"description":"list of acceptable credential types","type":"array","items":{"type":"string"}}}},"Object60":{"type":"object","properties":{"id":{"description":"The ID of the credential.","type":"integer"},"name":{"description":"The name identifying the credential","type":"string"},"type":{"description":"The credential's type.","type":"string"},"username":{"description":"The username for the credential.","type":"string"},"description":{"description":"A long description of the credential.","type":"string"},"owner":{"description":"The username of the user who this credential belongs to. Using user.username is preferred.","type":"string"},"user":{"description":"The user who this credential belongs to.","$ref":"#/definitions/Object33"},"remoteHostId":{"description":"The ID of the remote host associated with this credential.","type":"integer"},"remoteHostName":{"description":"The name of the remote host associated with this credential.","type":"string"},"state":{"description":"The U.S. state for the credential. Only for VAN credentials.","type":"string"},"createdAt":{"description":"The creation time for this credential.","type":"string","format":"time"},"updatedAt":{"description":"The last modification time for this credential.","type":"string","format":"time"},"default":{"description":"Whether or not the credential is a default. Only for Database credentials.","type":"boolean"},"oauth":{"description":"Whether or not the credential is an OAuth credential.","type":"boolean"}}},"Object61":{"type":"object","properties":{"name":{"description":"The name identifying the credential.","type":"string"},"type":{"description":"The type of credential. Note: only these credentials can be created or edited via this API [\"Amazon Web Services S3\", \"CASS/NCOA PAF\", \"Certificate\", \"Civis Platform\", \"Custom\", \"Database\", \"Google\", \"Salesforce User\", \"Salesforce Client\", \"TableauUser\"]","type":"string"},"description":{"description":"A long description of the credential.","type":"string"},"username":{"description":"The username for the credential.","type":"string"},"password":{"description":"The password for the credential.","type":"string"},"remoteHostId":{"description":"The ID of the remote host associated with the credential.","type":"integer"},"userId":{"description":"The ID of the user the credential is created for. Note: This attribute is only accepted if you are a Civis Admin User.","type":"integer"},"state":{"description":"The U.S. state for the credential. Only for VAN credentials.","type":"string"},"systemCredential":{"description":"Boolean flag that sets a credential to be a system credential. System credentials can only be created by Civis Admins and will create a credential owned by the Civis Robot user.","type":"boolean"},"default":{"description":"Whether or not the credential is a default. Only for Database credentials.","type":"boolean"},"oauth":{"description":"Whether or not the credential is an OAuth credential.","type":"boolean"}},"required":["type","username","password"]},"Object62":{"type":"object","properties":{"name":{"description":"The name identifying the credential.","type":"string"},"type":{"description":"The type of credential. Note: only these credentials can be created or edited via this API [\"Amazon Web Services S3\", \"CASS/NCOA PAF\", \"Certificate\", \"Civis Platform\", \"Custom\", \"Database\", \"Google\", \"Salesforce User\", \"Salesforce Client\", \"TableauUser\"]","type":"string"},"description":{"description":"A long description of the credential.","type":"string"},"username":{"description":"The username for the credential.","type":"string"},"password":{"description":"The password for the credential.","type":"string"},"remoteHostId":{"description":"The ID of the remote host associated with the credential.","type":"integer"},"userId":{"description":"The ID of the user the credential is created for. Note: This attribute is only accepted if you are a Civis Admin User.","type":"integer"},"state":{"description":"The U.S. state for the credential. Only for VAN credentials.","type":"string"},"systemCredential":{"description":"Boolean flag that sets a credential to be a system credential. System credentials can only be created by Civis Admins and will create a credential owned by the Civis Robot user.","type":"boolean"},"default":{"description":"Whether or not the credential is a default. Only for Database credentials.","type":"boolean"},"oauth":{"description":"Whether or not the credential is an OAuth credential.","type":"boolean"}},"required":["type","username","password"]},"Object63":{"type":"object","properties":{"name":{"description":"The name identifying the credential.","type":"string"},"type":{"description":"The type of credential. Note: only these credentials can be created or edited via this API [\"Amazon Web Services S3\", \"CASS/NCOA PAF\", \"Certificate\", \"Civis Platform\", \"Custom\", \"Database\", \"Google\", \"Salesforce User\", \"Salesforce Client\", \"TableauUser\"]","type":"string"},"description":{"description":"A long description of the credential.","type":"string"},"username":{"description":"The username for the credential.","type":"string"},"password":{"description":"The password for the credential.","type":"string"},"remoteHostId":{"description":"The ID of the remote host associated with the credential.","type":"integer"},"userId":{"description":"The ID of the user the credential is created for. Note: This attribute is only accepted if you are a Civis Admin User.","type":"integer"},"state":{"description":"The U.S. state for the credential. Only for VAN credentials.","type":"string"},"systemCredential":{"description":"Boolean flag that sets a credential to be a system credential. System credentials can only be created by Civis Admins and will create a credential owned by the Civis Robot user.","type":"boolean"},"default":{"description":"Whether or not the credential is a default. Only for Database credentials.","type":"boolean"},"oauth":{"description":"Whether or not the credential is an OAuth credential.","type":"boolean"}}},"Object64":{"type":"object","properties":{"url":{"description":"The URL to your host.","type":"string"},"remoteHostType":{"description":"The type of remote host. One of: RemoteHostTypes::Bigquery, RemoteHostTypes::Bitbucket, RemoteHostTypes::GitSSH, RemoteHostTypes::Github, RemoteHostTypes::GoogleDoc, RemoteHostTypes::JDBC, RemoteHostTypes::Postgres, RemoteHostTypes::Redshift, RemoteHostTypes::S3Storage, and RemoteHostTypes::Salesforce","type":"string"},"username":{"description":"The username for the credential.","type":"string"},"password":{"description":"The password for the credential.","type":"string"}},"required":["url","remoteHostType","username","password"]},"Object66":{"type":"object","properties":{"duration":{"description":"The number of seconds the temporary credential should be valid. Defaults to 15 minutes. Must not be less than 15 minutes or greater than 36 hours.","type":"integer"}}},"Object67":{"type":"object","properties":{"accessKey":{"description":"The identifier of the credential.","type":"string"},"secretAccessKey":{"description":"The secret part of the credential.","type":"string"},"sessionToken":{"description":"The session token identifier.","type":"string"}}},"Object68":{"type":"object","properties":{"userIds":{"description":"An array of one or more user IDs.","type":"array","items":{"type":"integer"}},"permissionLevel":{"description":"Options are: \"read\", \"write\", or \"manage\".","type":"string"},"shareEmailBody":{"description":"Custom body text for e-mail sent on a share.","type":"string"},"sendSharedEmail":{"description":"Send email to the recipients of a share.","type":"boolean"}},"required":["userIds","permissionLevel"]},"Object69":{"type":"object","properties":{"groupIds":{"description":"An array of one or more group IDs.","type":"array","items":{"type":"integer"}},"permissionLevel":{"description":"Options are: \"read\", \"write\", or \"manage\".","type":"string"},"shareEmailBody":{"description":"Custom body text for e-mail sent on a share.","type":"string"},"sendSharedEmail":{"description":"Send email to the recipients of a share.","type":"boolean"}},"required":["groupIds","permissionLevel"]},"Object70":{"type":"object","properties":{"userId":{"description":"ID of target user","type":"integer"},"includeDependencies":{"description":"Whether or not to give manage permissions on all dependencies","type":"boolean"},"emailBody":{"description":"Custom body text for e-mail sent on transfer.","type":"string"},"sendEmail":{"description":"Send email to the target user of the transfer?","type":"boolean"}},"required":["userId","includeDependencies"]},"Object71":{"type":"object","properties":{"id":{"description":"The ID for the database.","type":"integer"},"name":{"description":"The name of the database in Platform.","type":"string"},"adapter":{"description":"The type of the database.","type":"string"},"clusterIdentifier":{"description":"The cluster identifier of the database.","type":"string"},"host":{"description":"The host of the database server.","type":"string"},"port":{"description":"The port of the database.","type":"integer"},"databaseName":{"description":"The internal name of the database.","type":"string"},"managed":{"description":"True if the database is Civis-managed. False otherwise.","type":"boolean"}}},"Object72":{"type":"object","properties":{"schema":{"description":"The name of a schema.","type":"string"}}},"Object73":{"type":"object","properties":{"name":{"description":"The name of the table.","type":"string"},"schema":{"description":"The name of the schema containing the table.","type":"string"},"isView":{"description":"True if this table represents a view. False if it represents a regular table.","type":"boolean"},"databaseId":{"description":"The ID of the database server.","type":"integer"}}},"Object75":{"type":"object","properties":{"id":{"type":"integer"},"state":{"type":"string"},"createdAt":{"description":"The time that the run was queued.","type":"string","format":"time"},"startedAt":{"description":"The time that the run started.","type":"string","format":"time"},"finishedAt":{"description":"The time that the run completed.","type":"string","format":"time"},"error":{"description":"The error message for this run, if present.","type":"string"}}},"Object76":{"type":"object","properties":{"id":{"description":"Table Tag ID","type":"integer"},"name":{"description":"Table Tag Name","type":"string"}}},"Object77":{"type":"object","properties":{"name":{"description":"Name of the column.","type":"string"},"civisDataType":{"description":"The generic data type of the column (ex. \"string\"). Since this is database-agnostic, it may be helpful when loading data to R/Python.","type":"string"},"sqlType":{"description":"The database-specific SQL type of the column (ex. \"varchar(30)\").","type":"string"},"sampleValues":{"description":"A sample of values from the column.","type":"array","items":{"type":"string"}},"encoding":{"description":"The compression encoding for this columnSee: http://docs.aws.amazon.com/redshift/latest/dg/c_Compression_encodings.html","type":"string"},"description":{"description":"The description of the column, as specified by the table owner","type":"string"},"order":{"description":"Relative position of the column in the table.","type":"integer"},"minValue":{"description":"Smallest value in the column.","type":"string"},"maxValue":{"description":"Largest value in the column.","type":"string"},"avgValue":{"description":"This parameter is deprecated.","type":"number","format":"float"},"stddev":{"description":"This parameter is deprecated.","type":"number","format":"float"},"valueDistributionPercent":{"description":"A mapping between each value in the column and the percentage of rows with that value.Only present for tables with fewer than approximately 25,000,000 rows and for columns with fewer than twenty distinct values.","type":"object","additionalProperties":{"type":"number","format":"float"}},"coverageCount":{"description":"Number of non-null values in the column.","type":"integer"},"nullCount":{"description":"Number of null values in the column.","type":"integer"},"possibleDependentVariableTypes":{"description":"Possible dependent variable types the column may be used to model. Null if it may not be used as a dependent variable.","type":"array","items":{"type":"string"}},"useableAsIndependentVariable":{"description":"Whether the column may be used as an independent variable to train a model.","type":"boolean"},"useableAsPrimaryKey":{"description":"Whether the column may be used as an primary key to identify table rows.","type":"boolean"},"valueDistribution":{"description":"An object mapping distinct values in the column to the number of times they appear in the column","type":"object","additionalProperties":{"type":"integer"}},"distinctCount":{"description":"Number of distinct values in the column. NULL values are counted and treated as a single distinct value.","type":"integer"}}},"Object78":{"type":"object","properties":{"id":{"type":"integer"},"leftTableId":{"type":"integer"},"leftIdentifier":{"type":"string"},"rightTableId":{"type":"integer"},"rightIdentifier":{"type":"string"},"on":{"type":"string"},"leftJoin":{"type":"boolean"},"createdAt":{"type":"string","format":"time"},"updatedAt":{"type":"string","format":"time"}}},"Object79":{"type":"object","properties":{"type":{"type":"string"},"createdAt":{"type":"string","format":"time"},"updatedAt":{"type":"string","format":"time"},"joinId":{"type":"integer"}}},"Object81":{"type":"object","properties":{"name":{"type":"string"}}},"Object83":{"type":"object","properties":{"maxMatches":{"type":"integer"},"threshold":{"type":"string"}}},"Object82":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"type":{"type":"string"},"fromTemplateId":{"type":"integer"},"state":{"description":"Whether the job is idle, queued, running, cancelled, or failed.","type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"runs":{"description":"Information about the most recent runs of the job.","type":"array","items":{"$ref":"#/definitions/Object75"}},"lastRun":{"$ref":"#/definitions/Object75"},"hidden":{"description":"The hidden status of the item.","type":"boolean"},"matchOptions":{"$ref":"#/definitions/Object83"}}},"Object80":{"type":"object","properties":{"sourceTableId":{"description":"Source table","type":"integer"},"targetType":{"description":"Target type","type":"string"},"targetId":{"description":"Target ID","type":"integer"},"target":{"$ref":"#/definitions/Object81"},"job":{"description":"Matching job","$ref":"#/definitions/Object82"}}},"Object74":{"type":"object","properties":{"id":{"description":"The ID of the table.","type":"integer"},"databaseId":{"description":"The ID of the database.","type":"integer"},"schema":{"description":"The name of the schema containing the table.","type":"string"},"name":{"description":"Name of the table.","type":"string"},"description":{"description":"The description of the table, as specified by the table owner","type":"string"},"isView":{"description":"True if this table represents a view. False if it represents a regular table.","type":"boolean"},"rowCount":{"description":"The number of rows in the table.","type":"integer"},"columnCount":{"description":"The number of columns in the table.","type":"integer"},"sizeMb":{"description":"The size of the table in megabytes.","type":"number","format":"float"},"owner":{"description":"The database username of the table's owner.","type":"string"},"distkey":{"description":"The column used as the Amazon Redshift distkey.","type":"string"},"sortkeys":{"description":"The column used as the Amazon Redshift sortkey.","type":"string"},"refreshStatus":{"description":"How up-to-date the table's statistics on row counts, null counts, distinct counts, and values distributions are. One of: refreshing, stale, or current.","type":"string"},"lastRefresh":{"description":"The time of the last statistics refresh.","type":"string","format":"date-time"},"dataUpdatedAt":{"description":"The last time that Civis Platform captured a change in this table.Only applicable for Redshift tables; please see the Civis help desk for more info.","type":"string","format":"date-time"},"schemaUpdatedAt":{"description":"The last time that Civis Platform captured a change to the table attributes/structure.Only applicable for Redshift tables; please see the Civis help desk for more info.","type":"string","format":"date-time"},"refreshId":{"description":"The ID of the most recent statistics refresh.","type":"string"},"lastRun":{"description":"The last run of a refresh on this table.","$ref":"#/definitions/Object75"},"primaryKeys":{"description":"The primary keys for this table.","type":"array","items":{"type":"string"}},"lastModifiedKeys":{"description":"The columns indicating an entry's modification status for this table.","type":"array","items":{"type":"string"}},"tableTags":{"description":"The table tags associated with this table.","type":"array","items":{"$ref":"#/definitions/Object76"}},"ontologyMapping":{"description":"The ontology-key to column-name mapping. See /ontology for the list of valid ontology keys.","type":"object","additionalProperties":{"type":"string"}},"columns":{"type":"array","items":{"$ref":"#/definitions/Object77"}},"joins":{"type":"array","items":{"$ref":"#/definitions/Object78"}},"multipartKey":{"type":"array","items":{"type":"string"}},"enhancements":{"type":"array","items":{"$ref":"#/definitions/Object79"}},"viewDef":{"type":"string"},"tableDef":{"type":"string"},"outgoingTableMatches":{"type":"array","items":{"$ref":"#/definitions/Object80"}}}},"Object84":{"type":"object","properties":{"credentialId":{"description":"If provided, schemas will be filtered based on the given credential.","type":"integer"},"description":{"description":"The user-defined description of the table.","type":"string"}}},"Object85":{"type":"object","properties":{"id":{"description":"The ID for this project.","type":"integer"},"author":{"description":"The author/owner of the item.","$ref":"#/definitions/Object33"},"name":{"description":"The name of this project.","type":"string"},"description":{"description":"A description of the project.","type":"string"},"users":{"description":"Users who can see the project.","type":"array","items":{"$ref":"#/definitions/Object33"}},"autoShare":{"type":"boolean"},"createdAt":{"type":"string","format":"time"},"updatedAt":{"type":"string","format":"time"},"archived":{"description":"The archival status of the requested item(s).","type":"string"}}},"Object86":{"type":"object","properties":{"schema":{"description":"The name of the schema.","type":"string"},"statsPriority":{"description":"When to sync table statistics for every table in the schema. Valid options are the following. Option: 'flag' means to flag stats for the next scheduled run of a full table scan on the database. Option: 'block' means to block this job on stats syncing. Option: 'queue' means to queue a separate job for syncing stats and do not block this job on the queued job. Defaults to 'flag'","type":"string"}},"required":["schema"]},"Object87":{"type":"object","properties":{"jobId":{"description":"The ID of the job created.","type":"integer"},"runId":{"description":"The ID of the run created.","type":"integer"}}},"Object88":{"type":"object","properties":{"id":{"description":"The ID of the table.","type":"integer"},"databaseId":{"description":"The ID of the database.","type":"integer"},"schema":{"description":"The name of the schema containing the table.","type":"string"},"name":{"description":"Name of the table.","type":"string"},"description":{"description":"The description of the table, as specified by the table owner","type":"string"},"isView":{"description":"True if this table represents a view. False if it represents a regular table.","type":"boolean"},"rowCount":{"description":"The number of rows in the table.","type":"integer"},"columnCount":{"description":"The number of columns in the table.","type":"integer"},"sizeMb":{"description":"The size of the table in megabytes.","type":"number","format":"float"},"owner":{"description":"The database username of the table's owner.","type":"string"},"distkey":{"description":"The column used as the Amazon Redshift distkey.","type":"string"},"sortkeys":{"description":"The column used as the Amazon Redshift sortkey.","type":"string"},"refreshStatus":{"description":"How up-to-date the table's statistics on row counts, null counts, distinct counts, and values distributions are. One of: refreshing, stale, or current.","type":"string"},"lastRefresh":{"description":"The time of the last statistics refresh.","type":"string","format":"date-time"},"refreshId":{"description":"The ID of the most recent statistics refresh.","type":"string"},"lastRun":{"description":"The last run of a refresh on this table.","$ref":"#/definitions/Object75"},"tableTags":{"description":"The table tags associated with this table.","type":"array","items":{"$ref":"#/definitions/Object76"}}}},"Object89":{"type":"object","properties":{"id":{"description":"The ID of the table.","type":"integer"},"databaseId":{"description":"The ID of the database.","type":"integer"},"schema":{"description":"The name of the schema containing the table.","type":"string"},"name":{"description":"Name of the table.","type":"string"},"description":{"description":"The description of the table, as specified by the table owner","type":"string"},"isView":{"description":"True if this table represents a view. False if it represents a regular table.","type":"boolean"},"rowCount":{"description":"The number of rows in the table.","type":"integer"},"columnCount":{"description":"The number of columns in the table.","type":"integer"},"sizeMb":{"description":"The size of the table in megabytes.","type":"number","format":"float"},"owner":{"description":"The database username of the table's owner.","type":"string"},"distkey":{"description":"The column used as the Amazon Redshift distkey.","type":"string"},"sortkeys":{"description":"The column used as the Amazon Redshift sortkey.","type":"string"},"refreshStatus":{"description":"How up-to-date the table's statistics on row counts, null counts, distinct counts, and values distributions are. One of: refreshing, stale, or current.","type":"string"},"lastRefresh":{"description":"The time of the last statistics refresh.","type":"string","format":"date-time"},"refreshId":{"description":"The ID of the most recent statistics refresh.","type":"string"},"lastRun":{"description":"The last run of a refresh on this table.","$ref":"#/definitions/Object75"},"tableTags":{"description":"The table tags associated with this table.","type":"array","items":{"$ref":"#/definitions/Object76"}},"columnNames":{"description":"The names of each column in the table.","type":"array","items":{"type":"string"}}}},"Object90":{"type":"object","properties":{"grantee":{"description":"Name of the granted user or group","type":"string"},"granteeType":{"description":"User or group","type":"string"},"privileges":{"description":"Privileges that the grantee has on this resource","type":"array","items":{"type":"string"}},"grantablePrivileges":{"description":"Privileges that the grantee can grant to others for this resource","type":"array","items":{"type":"string"}}}},"Object91":{"type":"object","properties":{"username":{"description":"Username","type":"string"},"active":{"description":"Whether the user is active or deactivated","type":"boolean"}}},"Object92":{"type":"object","properties":{"groupName":{"description":"The name of the group.","type":"string"},"members":{"description":"The members of the group.","type":"array","items":{"type":"string"}}}},"Object93":{"type":"object","properties":{"id":{"description":"The ID of this whitelisted IP address.","type":"integer"},"remoteHostId":{"description":"The ID of the database this rule is applied to.","type":"integer"},"securityGroupId":{"description":"The ID of the security group this rule is applied to.","type":"string"},"subnetMask":{"description":"The subnet mask that is allowed by this rule.","type":"string"},"createdAt":{"description":"The time this rule was created.","type":"string","format":"time"},"updatedAt":{"description":"The time this rule was last updated.","type":"string","format":"time"}}},"Object94":{"type":"object","properties":{"id":{"description":"The ID of this whitelisted IP address.","type":"integer"},"remoteHostId":{"description":"The ID of the database this rule is applied to.","type":"integer"},"securityGroupId":{"description":"The ID of the security group this rule is applied to.","type":"string"},"subnetMask":{"description":"The subnet mask that is allowed by this rule.","type":"string"},"authorizedBy":{"description":"The user who authorized this rule.","type":"string"},"isActive":{"description":"True if the rule is applied, false if it has been revoked.","type":"boolean"},"createdAt":{"description":"The time this rule was created.","type":"string","format":"time"},"updatedAt":{"description":"The time this rule was last updated.","type":"string","format":"time"}}},"Object95":{"type":"object","properties":{"exportCachingEnabled":{"description":"Whether or not caching is enabled for export jobs run on this database server.","type":"boolean"}}},"Object96":{"type":"object","properties":{"exportCachingEnabled":{"description":"Whether or not caching is enabled for export jobs run on this database server.","type":"boolean"}}},"Object97":{"type":"object","properties":{"exportCachingEnabled":{"description":"Whether or not caching is enabled for export jobs run on this database server.","type":"boolean"}},"required":["exportCachingEnabled"]},"Object98":{"type":"object","properties":{"cpuGraphUrl":{"description":"URL for the aws redshift cpu utliization graph.","type":"string"},"diskGraphUrl":{"description":"URL for the aws redshift disk usage graph.","type":"string"},"queueLengthGraphUrl":{"description":"URL for the aws redshift queue length graph.","type":"string"},"statusGraphUrl":{"description":"URL for the aws redshift status graph.","type":"string"},"maintenanceGraphUrl":{"description":"URL for the aws redshift maintenance graph.","type":"string"},"queryDurationGraphUrl":{"description":"URL for the aws redshift table count graph.","type":"string"}}},"Object102":{"type":"object","properties":{"scheduled":{"description":"If the item is scheduled.","type":"boolean"},"scheduledDays":{"description":"Days of the week, based on numeric value starting at 0 for Sunday. Mutually exclusive with scheduledDaysOfMonth","type":"array","items":{"type":"integer"}},"scheduledHours":{"description":"Hours of the day it is scheduled on.","type":"array","items":{"type":"integer"}},"scheduledMinutes":{"description":"Minutes of the day it is scheduled on.","type":"array","items":{"type":"integer"}},"scheduledRunsPerHour":{"description":"Deprecated in favor of scheduled minutes.","type":"integer"},"scheduledDaysOfMonth":{"description":"Days of the month it is scheduled on, mutually exclusive with scheduledDays.","type":"array","items":{"type":"integer"}}}},"Object103":{"type":"object","properties":{"urls":{"description":"URLs to receive a POST request at job completion","type":"array","items":{"type":"string"}},"successEmailSubject":{"description":"Custom subject line for success e-mail.","type":"string"},"successEmailBody":{"description":"Custom body text for success e-mail, written in Markdown.","type":"string"},"successEmailAddresses":{"description":"Addresses to notify by e-mail when the job completes successfully.","type":"array","items":{"type":"string"}},"successEmailFromName":{"description":"Name from which success emails are sent; defaults to \"Civis.\"","type":"string"},"successEmailReplyTo":{"description":"Address for replies to success emails; defaults to the author of the job.","type":"string"},"failureEmailAddresses":{"description":"Addresses to notify by e-mail when the job fails.","type":"array","items":{"type":"string"}},"stallWarningMinutes":{"description":"Stall warning emails will be sent after this amount of minutes.","type":"integer"},"successOn":{"description":"If success email notifications are on. Defaults to user's preferences.","type":"boolean"},"failureOn":{"description":"If failure email notifications are on. Defaults to user's preferences.","type":"boolean"}}},"Object104":{"type":"object","properties":{"databaseName":{"description":"The Redshift database name for the table.","type":"string"},"schema":{"description":"The schema name for the table.","type":"string"},"table":{"description":"The table name.","type":"string"}},"required":["databaseName","schema","table"]},"Object105":{"type":"object","properties":{"databaseName":{"description":"The Redshift database name for the table.","type":"string"},"schema":{"description":"The schema name for the table.","type":"string"},"table":{"description":"The table name.","type":"string"}},"required":["databaseName","schema","table"]},"Object101":{"type":"object","properties":{"name":{"description":"The name of the enhancement job.","type":"string"},"schedule":{"description":"The schedule of when this enhancement will be run.","$ref":"#/definitions/Object102"},"notifications":{"description":"The notifications to send after the enhancement is run.","$ref":"#/definitions/Object103"},"inputFieldMapping":{"description":"The field (i.e., column) mapping for the input table. See https://api.civisanalytics.com/enhancements/field-mapping for a list of valid field types and descriptions. Each field type should be mapped to a string specifying a column name in the input table. For field types that support multiple values (e.g., the \"phone\" field), a list of column names can be provided (e.g., {\"phone\": [\"home_phone\", \"mobile_phone\"], ...}).","type":"object"},"inputTable":{"description":"The input table.","$ref":"#/definitions/Object104"},"matchTargetId":{"description":"The ID of the Civis Data match target. See /match_targets for IDs.","type":"integer"},"outputTable":{"description":"The output table.","$ref":"#/definitions/Object105"},"maxMatches":{"description":"The maximum number of matches per record in the input table to return. Must be between 0 and 10. 0 returns all matches.","type":"integer"},"threshold":{"description":"The score threshold (between 0 and 1). Matches below this threshold will not be returned. The default value is 0.5.","type":"number","format":"float"},"archived":{"description":"Whether the Civis Data Match Job has been archived.","type":"boolean"},"parentId":{"description":"Parent ID that triggers this enhancement.","type":"integer"}},"required":["name","inputFieldMapping","inputTable","matchTargetId","outputTable"]},"Object107":{"type":"object","properties":{"scheduled":{"description":"If the item is scheduled.","type":"boolean"},"scheduledDays":{"description":"Days of the week, based on numeric value starting at 0 for Sunday. Mutually exclusive with scheduledDaysOfMonth","type":"array","items":{"type":"integer"}},"scheduledHours":{"description":"Hours of the day it is scheduled on.","type":"array","items":{"type":"integer"}},"scheduledMinutes":{"description":"Minutes of the day it is scheduled on.","type":"array","items":{"type":"integer"}},"scheduledRunsPerHour":{"description":"Deprecated in favor of scheduled minutes.","type":"integer"},"scheduledDaysOfMonth":{"description":"Days of the month it is scheduled on, mutually exclusive with scheduledDays.","type":"array","items":{"type":"integer"}}}},"Object108":{"type":"object","properties":{"urls":{"description":"URLs to receive a POST request at job completion","type":"array","items":{"type":"string"}},"successEmailSubject":{"description":"Custom subject line for success e-mail.","type":"string"},"successEmailBody":{"description":"Custom body text for success e-mail, written in Markdown.","type":"string"},"successEmailAddresses":{"description":"Addresses to notify by e-mail when the job completes successfully.","type":"array","items":{"type":"string"}},"successEmailFromName":{"description":"Name from which success emails are sent; defaults to \"Civis.\"","type":"string"},"successEmailReplyTo":{"description":"Address for replies to success emails; defaults to the author of the job.","type":"string"},"failureEmailAddresses":{"description":"Addresses to notify by e-mail when the job fails.","type":"array","items":{"type":"string"}},"stallWarningMinutes":{"description":"Stall warning emails will be sent after this amount of minutes.","type":"integer"},"successOn":{"description":"If success email notifications are on. Defaults to user's preferences.","type":"boolean"},"failureOn":{"description":"If failure email notifications are on. Defaults to user's preferences.","type":"boolean"}}},"Object109":{"type":"object","properties":{"databaseName":{"description":"The Redshift database name for the table.","type":"string"},"schema":{"description":"The schema name for the table.","type":"string"},"table":{"description":"The table name.","type":"string"}}},"Object110":{"type":"object","properties":{"databaseName":{"description":"The Redshift database name for the table.","type":"string"},"schema":{"description":"The schema name for the table.","type":"string"},"table":{"description":"The table name.","type":"string"}}},"Object106":{"type":"object","properties":{"id":{"description":"The ID for the enhancement.","type":"integer"},"name":{"description":"The name of the enhancement job.","type":"string"},"type":{"description":"The type of the enhancement (e.g CASS-NCOA)","type":"string"},"createdAt":{"description":"The time this enhancement was created.","type":"string","format":"time"},"updatedAt":{"description":"The time the enhancement was last updated.","type":"string","format":"time"},"author":{"description":"The author/owner of the item.","$ref":"#/definitions/Object33"},"state":{"description":"The status of the enhancement's last run","type":"string"},"schedule":{"description":"The schedule of when this enhancement will be run.","$ref":"#/definitions/Object107"},"notifications":{"description":"The notifications to send after the enhancement is run.","$ref":"#/definitions/Object108"},"runningAs":{"description":"The user this enhancement will run as, defaults to the author of the enhancement.","$ref":"#/definitions/Object33"},"myPermissionLevel":{"description":"Your permission level on the object. One of \"read\", \"write\", or \"manage\".","type":"string"},"inputFieldMapping":{"description":"The field (i.e., column) mapping for the input table. See https://api.civisanalytics.com/enhancements/field-mapping for a list of valid field types and descriptions. Each field type should be mapped to a string specifying a column name in the input table. For field types that support multiple values (e.g., the \"phone\" field), a list of column names can be provided (e.g., {\"phone\": [\"home_phone\", \"mobile_phone\"], ...}).","type":"object"},"inputTable":{"description":"The input table.","$ref":"#/definitions/Object109"},"matchTargetId":{"description":"The ID of the Civis Data match target. See /match_targets for IDs.","type":"integer"},"outputTable":{"description":"The output table.","$ref":"#/definitions/Object110"},"maxMatches":{"description":"The maximum number of matches per record in the input table to return. Must be between 0 and 10. 0 returns all matches.","type":"integer"},"threshold":{"description":"The score threshold (between 0 and 1). Matches below this threshold will not be returned. The default value is 0.5.","type":"number","format":"float"},"archived":{"description":"Whether the Civis Data Match Job has been archived.","type":"boolean"},"lastRun":{"description":"The last run of this enhancement.","$ref":"#/definitions/Object75"},"parentId":{"description":"Parent ID that triggers this enhancement.","type":"integer"}}},"Object111":{"type":"object","properties":{"name":{"description":"The name of the enhancement job.","type":"string"},"schedule":{"description":"The schedule of when this enhancement will be run.","$ref":"#/definitions/Object102"},"notifications":{"description":"The notifications to send after the enhancement is run.","$ref":"#/definitions/Object103"},"inputFieldMapping":{"description":"The field (i.e., column) mapping for the input table. See https://api.civisanalytics.com/enhancements/field-mapping for a list of valid field types and descriptions. Each field type should be mapped to a string specifying a column name in the input table. For field types that support multiple values (e.g., the \"phone\" field), a list of column names can be provided (e.g., {\"phone\": [\"home_phone\", \"mobile_phone\"], ...}).","type":"object"},"inputTable":{"description":"The input table.","$ref":"#/definitions/Object104"},"matchTargetId":{"description":"The ID of the Civis Data match target. See /match_targets for IDs.","type":"integer"},"outputTable":{"description":"The output table.","$ref":"#/definitions/Object105"},"maxMatches":{"description":"The maximum number of matches per record in the input table to return. Must be between 0 and 10. 0 returns all matches.","type":"integer"},"threshold":{"description":"The score threshold (between 0 and 1). Matches below this threshold will not be returned. The default value is 0.5.","type":"number","format":"float"},"archived":{"description":"Whether the Civis Data Match Job has been archived.","type":"boolean"},"parentId":{"description":"Parent ID that triggers this enhancement.","type":"integer"}},"required":["name","inputFieldMapping","inputTable","matchTargetId","outputTable"]},"Object113":{"type":"object","properties":{"databaseName":{"description":"The Redshift database name for the table.","type":"string"},"schema":{"description":"The schema name for the table.","type":"string"},"table":{"description":"The table name.","type":"string"}}},"Object114":{"type":"object","properties":{"databaseName":{"description":"The Redshift database name for the table.","type":"string"},"schema":{"description":"The schema name for the table.","type":"string"},"table":{"description":"The table name.","type":"string"}}},"Object112":{"type":"object","properties":{"name":{"description":"The name of the enhancement job.","type":"string"},"schedule":{"description":"The schedule of when this enhancement will be run.","$ref":"#/definitions/Object102"},"notifications":{"description":"The notifications to send after the enhancement is run.","$ref":"#/definitions/Object103"},"inputFieldMapping":{"description":"The field (i.e., column) mapping for the input table. See https://api.civisanalytics.com/enhancements/field-mapping for a list of valid field types and descriptions. Each field type should be mapped to a string specifying a column name in the input table. For field types that support multiple values (e.g., the \"phone\" field), a list of column names can be provided (e.g., {\"phone\": [\"home_phone\", \"mobile_phone\"], ...}).","type":"object"},"inputTable":{"description":"The input table.","$ref":"#/definitions/Object113"},"matchTargetId":{"description":"The ID of the Civis Data match target. See /match_targets for IDs.","type":"integer"},"outputTable":{"description":"The output table.","$ref":"#/definitions/Object114"},"maxMatches":{"description":"The maximum number of matches per record in the input table to return. Must be between 0 and 10. 0 returns all matches.","type":"integer"},"threshold":{"description":"The score threshold (between 0 and 1). Matches below this threshold will not be returned. The default value is 0.5.","type":"number","format":"float"},"archived":{"description":"Whether the Civis Data Match Job has been archived.","type":"boolean"},"parentId":{"description":"Parent ID that triggers this enhancement.","type":"integer"}}},"Object115":{"type":"object","properties":{"cloneSchedule":{"description":"If true, also copy the schedule to the new enhancement.","type":"boolean"},"cloneTriggers":{"description":"If true, also copy the triggers to the new enhancement.","type":"boolean"},"cloneNotifications":{"description":"If true, also copy the notifications to the new enhancement.","type":"boolean"}}},"Object116":{"type":"object","properties":{"id":{"description":"The ID of the run.","type":"integer"},"civisDataMatchId":{"description":"The ID of the Civis Data Match job.","type":"integer"},"state":{"description":"The state of the run, one of 'queued' 'running' 'succeeded' 'failed' or 'cancelled'.","type":"string"},"isCancelRequested":{"description":"True if run cancel requested, else false.","type":"boolean"},"createdAt":{"description":"The time the run was created.","type":"string","format":"time"},"startedAt":{"description":"The time the run started at.","type":"string","format":"time"},"finishedAt":{"description":"The time the run completed.","type":"string","format":"time"},"error":{"description":"The error, if any, returned by the run.","type":"string"}}},"Object117":{"type":"object","properties":{"id":{"description":"The ID of the log.","type":"integer"},"createdAt":{"description":"The time the log was created.","type":"string","format":"date-time"},"message":{"description":"The log message.","type":"string"},"level":{"description":"The level of the log. One of unknown,fatal,error,warn,info,debug.","type":"string"}}},"Object118":{"type":"object","properties":{"id":{"description":"The ID of the run.","type":"integer"},"state":{"description":"The state of the run, one of 'queued', 'running' or 'cancelled'.","type":"string"},"isCancelRequested":{"description":"True if run cancel requested, else false.","type":"boolean"}}},"Object119":{"type":"object","properties":{"objectType":{"description":"The type of the output. Valid values are File, Table, Report, Project, Credential, or JSONValue","type":"string"},"objectId":{"description":"The ID of the output.","type":"integer"},"name":{"description":"The name of the output.","type":"string"},"link":{"description":"The hypermedia link to the output.","type":"string"},"value":{"type":"string"}}},"Object120":{"type":"object","properties":{"userIds":{"description":"An array of one or more user IDs.","type":"array","items":{"type":"integer"}},"permissionLevel":{"description":"Options are: \"read\", \"write\", or \"manage\".","type":"string"},"shareEmailBody":{"description":"Custom body text for e-mail sent on a share.","type":"string"},"sendSharedEmail":{"description":"Send email to the recipients of a share.","type":"boolean"}},"required":["userIds","permissionLevel"]},"Object121":{"type":"object","properties":{"groupIds":{"description":"An array of one or more group IDs.","type":"array","items":{"type":"integer"}},"permissionLevel":{"description":"Options are: \"read\", \"write\", or \"manage\".","type":"string"},"shareEmailBody":{"description":"Custom body text for e-mail sent on a share.","type":"string"},"sendSharedEmail":{"description":"Send email to the recipients of a share.","type":"boolean"}},"required":["groupIds","permissionLevel"]},"Object122":{"type":"object","properties":{"userId":{"description":"ID of target user","type":"integer"},"includeDependencies":{"description":"Whether or not to give manage permissions on all dependencies","type":"boolean"},"emailBody":{"description":"Custom body text for e-mail sent on transfer.","type":"string"},"sendEmail":{"description":"Send email to the target user of the transfer?","type":"boolean"}},"required":["userId","includeDependencies"]},"Object123":{"type":"object","properties":{"status":{"description":"The desired archived status of the object.","type":"boolean"}},"required":["status"]},"Object125":{"type":"object","properties":{"name":{"description":"A user-specified name for the source.","type":"string"}}},"Object127":{"type":"object","properties":{"numRecords":{"description":"The number of input records for this run.","type":"integer"},"uniqueIds":{"description":"The number of distinct unique IDs in the input records for this run.","type":"integer"},"uniqueDeduplicatedIds":{"description":"The number of resolved IDs associated with more than one unique ID in the input.","type":"integer"},"maxClusterSize":{"description":"The number of records in the largest cluster of resolved IDs.","type":"integer"},"avgClusterSize":{"description":"The average number of records with the same resolved ID.","type":"number","format":"float"},"clusterSizeFrequencies":{"description":"A mapping from numbers of records with the same resolved ID (i.e., sizes of clusters) to numbers of such clusters. For example, if there were 10 clusters with 2 records each, 2 would be a key in the mapping, and 10 would be its value.","type":"object"}}},"Object126":{"type":"object","properties":{"id":{"type":"integer"},"state":{"type":"string"},"createdAt":{"description":"The time that the run was queued.","type":"string","format":"time"},"startedAt":{"description":"The time that the run started.","type":"string","format":"time"},"finishedAt":{"description":"The time that the run completed.","type":"string","format":"time"},"error":{"description":"The error message for this run, if present.","type":"string"},"sampleRecordsQuery":{"description":"A SQL query to produce a sample of records to inspect.","type":"string"},"expandClusterQuery":{"description":"A customizable query to view PII associated with resolved ids.","type":"string"},"runMetrics":{"description":"Metrics from this run of the Identity Resolution job.","$ref":"#/definitions/Object127"}}},"Object124":{"type":"object","properties":{"id":{"description":"The ID for the enhancement.","type":"integer"},"name":{"description":"The name of the enhancement job.","type":"string"},"type":{"description":"The type of the enhancement (e.g CASS-NCOA)","type":"string"},"createdAt":{"description":"The time this enhancement was created.","type":"string","format":"time"},"updatedAt":{"description":"The time the enhancement was last updated.","type":"string","format":"time"},"author":{"description":"The author/owner of the item.","$ref":"#/definitions/Object33"},"state":{"description":"The status of the enhancement's last run","type":"string"},"archived":{"description":"The archival status of the requested item(s).","type":"string"},"sources":{"description":"The source(s) to resolve via a run of this job.","type":"array","items":{"$ref":"#/definitions/Object125"}},"lastRun":{"description":"The last run of this enhancement.","$ref":"#/definitions/Object126"}}},"Object129":{"type":"object","properties":{"name":{"description":"A user-specified name for the source.","type":"string"},"description":{"description":"A description of the source.","type":"string"},"databaseName":{"description":"The name of the source database.","type":"string"},"schemaName":{"description":"The name of the source schema.","type":"string"},"tableName":{"description":"The name of the source table.","type":"string"},"fieldMapping":{"description":"A mapping of PII fields to columns in this table. Valid keys are primary_key, first_name, middle_name, last_name, gender, phone, email, birth_date, birth_year, birth_month, birth_day, house_number, street, unit, full_address, city, state, state_code, zip, lat, lon, and name_suffix","type":"object"}},"required":["name","databaseName","schemaName","tableName","fieldMapping"]},"Object130":{"type":"object","properties":{"source1":{"description":"Name of the first source. Must be defined in Sources list.","type":"string"},"source1JoinCol":{"description":"Column from the first source to join on.","type":"string"},"source2":{"description":"Name of the second source. Must be defined in Sources list","type":"string"},"source2JoinCol":{"description":"Column from the second source to join on.","type":"string"}},"required":["source1","source1JoinCol","source2","source2JoinCol"]},"Object131":{"type":"object","properties":{"databaseName":{"description":"The name of the destination database.","type":"string"},"schemaName":{"description":"The name of the destination schema.","type":"string"},"tableName":{"description":"The name of the destination table.","type":"string"}},"required":["databaseName","schemaName","tableName"]},"Object134":{"type":"object","properties":{"sourceName":{"description":"The name of the source.","type":"string"},"ranking":{"description":"How preferred this source is for the given field. Rankings are zero-indexed and lower rank values are preferred to higher ones.","type":"integer"}},"required":["sourceName","ranking"]},"Object133":{"type":"object","properties":{"fieldName":{"description":"The name of the field. Must be one of: first_name, middle_name, last_name, name_suffix, email, phone, birth_month, birth_day, birth_year, gender, address, house_number, street, unit, city, state_code, and zip.","type":"string"},"ruleType":{"description":"One of [\"automatic\", \"preferred_source\"]. Determines how the system will choose the value for a record. \"automatic\" will use the most frequent well-formatted value. \"preferred_source\" allows the user to prioritize values from particular sources over others.","type":"string"},"sourcePreferences":{"description":"Rank order for sources, when rule_type is \"preferred_source\".","type":"array","items":{"$ref":"#/definitions/Object134"}}},"required":["fieldName","ruleType"]},"Object132":{"type":"object","properties":{"databaseName":{"description":"The name of the destination database.","type":"string"},"schemaName":{"description":"The name of the destination schema.","type":"string"},"tableName":{"description":"The name of the destination table.","type":"string"},"fields":{"type":"array","items":{"$ref":"#/definitions/Object133"}}},"required":["databaseName","schemaName","tableName"]},"Object128":{"type":"object","properties":{"name":{"description":"The name of the enhancement job.","type":"string"},"schedule":{"description":"The schedule of when this enhancement will be run.","$ref":"#/definitions/Object102"},"notifications":{"description":"The notifications to send after the enhancement is run.","$ref":"#/definitions/Object103"},"threshold":{"description":"A value that determines the extent to which similar records get assigned the same resolved ID. Must be within 0.5 and 1, inclusive. Defaults to 0.8 if unspecified.Higher values may result in fewer cases where records about different individuals erroneously receive the same resolved ID, but also more more cases where records about the same individual receive different resolved IDs.","type":"number","format":"float"},"sources":{"description":"The source(s) to resolve via a run of this job.","type":"array","items":{"$ref":"#/definitions/Object129"}},"matchTargetId":{"description":"The ID of the Civis Data (Custom) match target. See /match_targets for IDs.","type":"integer"},"enforcedLinks":{"description":"A specification of related columns in different sources. The IDR tool will ensure that records with the same values in the specified columns receive the same Resolved ID.","type":"array","items":{"$ref":"#/definitions/Object130"}},"customerGraph":{"description":"Definition of the destination table for Customer Graph information.","$ref":"#/definitions/Object131"},"goldenTable":{"description":"Definition of the destination table for Golden Table information. Requires Customer Graph to be generated.","$ref":"#/definitions/Object132"},"linkScores":{"description":"Definition of the destination table for Link Scores information.","$ref":"#/definitions/Object131"},"legacyId":{"description":"ID of this pipeline in the legacy IDR service application.","type":"integer"}},"required":["name","sources"]},"Object136":{"type":"object","properties":{"name":{"description":"A user-specified name for the source.","type":"string"},"description":{"description":"A description of the source.","type":"string"},"databaseName":{"description":"The name of the source database.","type":"string"},"schemaName":{"description":"The name of the source schema.","type":"string"},"tableName":{"description":"The name of the source table.","type":"string"},"fieldMapping":{"description":"A mapping of PII fields to columns in this table. Valid keys are primary_key, first_name, middle_name, last_name, gender, phone, email, birth_date, birth_year, birth_month, birth_day, house_number, street, unit, full_address, city, state, state_code, zip, lat, lon, and name_suffix","type":"object"}}},"Object137":{"type":"object","properties":{"source1":{"description":"Name of the first source. Must be defined in Sources list.","type":"string"},"source1JoinCol":{"description":"Column from the first source to join on.","type":"string"},"source2":{"description":"Name of the second source. Must be defined in Sources list","type":"string"},"source2JoinCol":{"description":"Column from the second source to join on.","type":"string"}}},"Object138":{"type":"object","properties":{"databaseName":{"description":"The name of the destination database.","type":"string"},"schemaName":{"description":"The name of the destination schema.","type":"string"},"tableName":{"description":"The name of the destination table.","type":"string"}}},"Object141":{"type":"object","properties":{"sourceName":{"description":"The name of the source.","type":"string"},"ranking":{"description":"How preferred this source is for the given field. Rankings are zero-indexed and lower rank values are preferred to higher ones.","type":"integer"}}},"Object140":{"type":"object","properties":{"fieldName":{"description":"The name of the field. Must be one of: first_name, middle_name, last_name, name_suffix, email, phone, birth_month, birth_day, birth_year, gender, address, house_number, street, unit, city, state_code, and zip.","type":"string"},"ruleType":{"description":"One of [\"automatic\", \"preferred_source\"]. Determines how the system will choose the value for a record. \"automatic\" will use the most frequent well-formatted value. \"preferred_source\" allows the user to prioritize values from particular sources over others.","type":"string"},"sourcePreferences":{"description":"Rank order for sources, when rule_type is \"preferred_source\".","type":"array","items":{"$ref":"#/definitions/Object141"}}}},"Object139":{"type":"object","properties":{"databaseName":{"description":"The name of the destination database.","type":"string"},"schemaName":{"description":"The name of the destination schema.","type":"string"},"tableName":{"description":"The name of the destination table.","type":"string"},"fields":{"type":"array","items":{"$ref":"#/definitions/Object140"}}}},"Object142":{"type":"object","properties":{"id":{"type":"integer"},"state":{"type":"string"},"createdAt":{"description":"The time that the run was queued.","type":"string","format":"time"},"startedAt":{"description":"The time that the run started.","type":"string","format":"time"},"finishedAt":{"description":"The time that the run completed.","type":"string","format":"time"},"error":{"description":"The error message for this run, if present.","type":"string"},"config":{"description":"How the Identity Resolution job was configured for this run.","type":"string"},"sampleRecordsQuery":{"description":"A SQL query to produce a sample of records to inspect.","type":"string"},"expandClusterQuery":{"description":"A customizable query to view PII associated with resolved ids.","type":"string"},"runMetrics":{"description":"Metrics from this run of the Identity Resolution job.","$ref":"#/definitions/Object127"},"errorSection":{"description":"If there was a failure, this will denote which section of the Identity Resolution job failed. One of: data_preparation, compute_setup or data_processing.","type":"string"}}},"Object135":{"type":"object","properties":{"id":{"description":"The ID for the enhancement.","type":"integer"},"name":{"description":"The name of the enhancement job.","type":"string"},"type":{"description":"The type of the enhancement (e.g CASS-NCOA)","type":"string"},"createdAt":{"description":"The time this enhancement was created.","type":"string","format":"time"},"updatedAt":{"description":"The time the enhancement was last updated.","type":"string","format":"time"},"author":{"description":"The author/owner of the item.","$ref":"#/definitions/Object33"},"state":{"description":"The status of the enhancement's last run","type":"string"},"schedule":{"description":"The schedule of when this enhancement will be run.","$ref":"#/definitions/Object107"},"notifications":{"description":"The notifications to send after the enhancement is run.","$ref":"#/definitions/Object108"},"runningAs":{"description":"The user this enhancement will run as, defaults to the author of the enhancement.","$ref":"#/definitions/Object33"},"myPermissionLevel":{"description":"Your permission level on the object. One of \"read\", \"write\", or \"manage\".","type":"string"},"archived":{"description":"The archival status of the requested item(s).","type":"string"},"threshold":{"description":"A value that determines the extent to which similar records get assigned the same resolved ID. Must be within 0.5 and 1, inclusive. Defaults to 0.8 if unspecified.Higher values may result in fewer cases where records about different individuals erroneously receive the same resolved ID, but also more more cases where records about the same individual receive different resolved IDs.","type":"number","format":"float"},"sources":{"description":"The source(s) to resolve via a run of this job.","type":"array","items":{"$ref":"#/definitions/Object136"}},"matchTargetId":{"description":"The ID of the Civis Data (Custom) match target. See /match_targets for IDs.","type":"integer"},"enforcedLinks":{"description":"A specification of related columns in different sources. The IDR tool will ensure that records with the same values in the specified columns receive the same Resolved ID.","type":"array","items":{"$ref":"#/definitions/Object137"}},"customerGraph":{"description":"Definition of the destination table for Customer Graph information.","$ref":"#/definitions/Object138"},"goldenTable":{"description":"Definition of the destination table for Golden Table information. Requires Customer Graph to be generated.","$ref":"#/definitions/Object139"},"linkScores":{"description":"Definition of the destination table for Link Scores information.","$ref":"#/definitions/Object138"},"legacyId":{"description":"ID of this pipeline in the legacy IDR service application.","type":"integer"},"lastRun":{"description":"The last run of this enhancement.","$ref":"#/definitions/Object142"}}},"Object143":{"type":"object","properties":{"name":{"description":"The name of the enhancement job.","type":"string"},"schedule":{"description":"The schedule of when this enhancement will be run.","$ref":"#/definitions/Object102"},"notifications":{"description":"The notifications to send after the enhancement is run.","$ref":"#/definitions/Object103"},"threshold":{"description":"A value that determines the extent to which similar records get assigned the same resolved ID. Must be within 0.5 and 1, inclusive. Defaults to 0.8 if unspecified.Higher values may result in fewer cases where records about different individuals erroneously receive the same resolved ID, but also more more cases where records about the same individual receive different resolved IDs.","type":"number","format":"float"},"sources":{"description":"The source(s) to resolve via a run of this job.","type":"array","items":{"$ref":"#/definitions/Object129"}},"matchTargetId":{"description":"The ID of the Civis Data (Custom) match target. See /match_targets for IDs.","type":"integer"},"enforcedLinks":{"description":"A specification of related columns in different sources. The IDR tool will ensure that records with the same values in the specified columns receive the same Resolved ID.","type":"array","items":{"$ref":"#/definitions/Object130"}},"customerGraph":{"description":"Definition of the destination table for Customer Graph information.","$ref":"#/definitions/Object131"},"goldenTable":{"description":"Definition of the destination table for Golden Table information. Requires Customer Graph to be generated.","$ref":"#/definitions/Object132"},"linkScores":{"description":"Definition of the destination table for Link Scores information.","$ref":"#/definitions/Object131"}},"required":["name","sources"]},"Object145":{"type":"object","properties":{"name":{"description":"A user-specified name for the source.","type":"string"},"description":{"description":"A description of the source.","type":"string"},"databaseName":{"description":"The name of the source database.","type":"string"},"schemaName":{"description":"The name of the source schema.","type":"string"},"tableName":{"description":"The name of the source table.","type":"string"},"fieldMapping":{"description":"A mapping of PII fields to columns in this table. Valid keys are primary_key, first_name, middle_name, last_name, gender, phone, email, birth_date, birth_year, birth_month, birth_day, house_number, street, unit, full_address, city, state, state_code, zip, lat, lon, and name_suffix","type":"object"}}},"Object146":{"type":"object","properties":{"source1":{"description":"Name of the first source. Must be defined in Sources list.","type":"string"},"source1JoinCol":{"description":"Column from the first source to join on.","type":"string"},"source2":{"description":"Name of the second source. Must be defined in Sources list","type":"string"},"source2JoinCol":{"description":"Column from the second source to join on.","type":"string"}}},"Object147":{"type":"object","properties":{"databaseName":{"description":"The name of the destination database.","type":"string"},"schemaName":{"description":"The name of the destination schema.","type":"string"},"tableName":{"description":"The name of the destination table.","type":"string"}}},"Object150":{"type":"object","properties":{"sourceName":{"description":"The name of the source.","type":"string"},"ranking":{"description":"How preferred this source is for the given field. Rankings are zero-indexed and lower rank values are preferred to higher ones.","type":"integer"}}},"Object149":{"type":"object","properties":{"fieldName":{"description":"The name of the field. Must be one of: first_name, middle_name, last_name, name_suffix, email, phone, birth_month, birth_day, birth_year, gender, address, house_number, street, unit, city, state_code, and zip.","type":"string"},"ruleType":{"description":"One of [\"automatic\", \"preferred_source\"]. Determines how the system will choose the value for a record. \"automatic\" will use the most frequent well-formatted value. \"preferred_source\" allows the user to prioritize values from particular sources over others.","type":"string"},"sourcePreferences":{"description":"Rank order for sources, when rule_type is \"preferred_source\".","type":"array","items":{"$ref":"#/definitions/Object150"}}}},"Object148":{"type":"object","properties":{"databaseName":{"description":"The name of the destination database.","type":"string"},"schemaName":{"description":"The name of the destination schema.","type":"string"},"tableName":{"description":"The name of the destination table.","type":"string"},"fields":{"type":"array","items":{"$ref":"#/definitions/Object149"}}}},"Object144":{"type":"object","properties":{"name":{"description":"The name of the enhancement job.","type":"string"},"schedule":{"description":"The schedule of when this enhancement will be run.","$ref":"#/definitions/Object102"},"notifications":{"description":"The notifications to send after the enhancement is run.","$ref":"#/definitions/Object103"},"threshold":{"description":"A value that determines the extent to which similar records get assigned the same resolved ID. Must be within 0.5 and 1, inclusive. Defaults to 0.8 if unspecified.Higher values may result in fewer cases where records about different individuals erroneously receive the same resolved ID, but also more more cases where records about the same individual receive different resolved IDs.","type":"number","format":"float"},"sources":{"description":"The source(s) to resolve via a run of this job.","type":"array","items":{"$ref":"#/definitions/Object145"}},"matchTargetId":{"description":"The ID of the Civis Data (Custom) match target. See /match_targets for IDs.","type":"integer"},"enforcedLinks":{"description":"A specification of related columns in different sources. The IDR tool will ensure that records with the same values in the specified columns receive the same Resolved ID.","type":"array","items":{"$ref":"#/definitions/Object146"}},"customerGraph":{"description":"Definition of the destination table for Customer Graph information.","$ref":"#/definitions/Object147"},"goldenTable":{"description":"Definition of the destination table for Golden Table information. Requires Customer Graph to be generated.","$ref":"#/definitions/Object148"},"linkScores":{"description":"Definition of the destination table for Link Scores information.","$ref":"#/definitions/Object147"}}},"Object151":{"type":"object","properties":{"id":{"description":"The ID of the run.","type":"integer"},"identityResolutionId":{"description":"The ID of the Identity Resolution job.","type":"integer"},"state":{"description":"The state of the run, one of 'queued' 'running' 'succeeded' 'failed' or 'cancelled'.","type":"string"},"isCancelRequested":{"description":"True if run cancel requested, else false.","type":"boolean"},"createdAt":{"description":"The time the run was created.","type":"string","format":"time"},"startedAt":{"description":"The time the run started at.","type":"string","format":"time"},"finishedAt":{"description":"The time the run completed.","type":"string","format":"time"},"error":{"description":"The error, if any, returned by the run.","type":"string"},"config":{"description":"How the Identity Resolution job was configured for this run.","type":"string"},"sampleRecordsQuery":{"description":"A SQL query to produce a sample of records to inspect.","type":"string"},"expandClusterQuery":{"description":"A customizable query to view PII associated with resolved ids.","type":"string"},"runMetrics":{"description":"Metrics from this run of the Identity Resolution job.","$ref":"#/definitions/Object127"},"errorSection":{"description":"If there was a failure, this will denote which section of the Identity Resolution job failed. One of: data_preparation, compute_setup or data_processing.","type":"string"}}},"Object152":{"type":"object","properties":{"id":{"description":"The ID of the run.","type":"integer"},"identityResolutionId":{"description":"The ID of the Identity Resolution job.","type":"integer"},"state":{"description":"The state of the run, one of 'queued' 'running' 'succeeded' 'failed' or 'cancelled'.","type":"string"},"isCancelRequested":{"description":"True if run cancel requested, else false.","type":"boolean"},"createdAt":{"description":"The time the run was created.","type":"string","format":"time"},"startedAt":{"description":"The time the run started at.","type":"string","format":"time"},"finishedAt":{"description":"The time the run completed.","type":"string","format":"time"},"error":{"description":"The error, if any, returned by the run.","type":"string"},"sampleRecordsQuery":{"description":"A SQL query to produce a sample of records to inspect.","type":"string"},"expandClusterQuery":{"description":"A customizable query to view PII associated with resolved ids.","type":"string"},"runMetrics":{"description":"Metrics from this run of the Identity Resolution job.","$ref":"#/definitions/Object127"}}},"Object153":{"type":"object","properties":{"id":{"description":"The ID of the run.","type":"integer"},"state":{"description":"The state of the run, one of 'queued', 'running' or 'cancelled'.","type":"string"},"isCancelRequested":{"description":"True if run cancel requested, else false.","type":"boolean"}}},"Object155":{"type":"object","properties":{"name":{"description":"The name of the type.","type":"string"}}},"Object156":{"type":"object","properties":{"field":{"description":"The name of the field.","type":"string"},"description":{"description":"The description of the field.","type":"string"}}},"Object157":{"type":"object","properties":{"id":{"description":"The ID for the enhancement.","type":"integer"},"name":{"description":"The name of the enhancement job.","type":"string"},"type":{"description":"The type of the enhancement (e.g CASS-NCOA)","type":"string"},"createdAt":{"description":"The time this enhancement was created.","type":"string","format":"time"},"updatedAt":{"description":"The time the enhancement was last updated.","type":"string","format":"time"},"author":{"description":"The author/owner of the item.","$ref":"#/definitions/Object33"},"state":{"description":"The status of the enhancement's last run","type":"string"},"archived":{"description":"The archival status of the requested item(s).","type":"string"}}},"Object160":{"type":"object","properties":{"schema":{"description":"The schema name of the source table.","type":"string"},"table":{"description":"The name of the source table.","type":"string"},"remoteHostId":{"description":"The ID of the database host for the table.","type":"integer"},"credentialId":{"description":"The id of the credentials to be used when performing the enhancement.","type":"integer"},"multipartKey":{"description":"The source table primary key.","type":"array","items":{"type":"string"}}},"required":["schema","table","remoteHostId","credentialId"]},"Object159":{"type":"object","properties":{"databaseTable":{"description":"The information about the source database table.","$ref":"#/definitions/Object160"}}},"Object162":{"type":"object","properties":{"schema":{"description":"The schema name for the output data.","type":"string"},"table":{"description":"The table name for the output data.","type":"string"}}},"Object161":{"type":"object","properties":{"databaseTable":{"description":"The information about the output database table.","$ref":"#/definitions/Object162"}}},"Object163":{"type":"object","properties":{"address1":{"description":"The first address line.","type":"string"},"address2":{"description":"The second address line.","type":"string"},"city":{"description":"The city of an address.","type":"string"},"state":{"description":"The state of an address.","type":"string"},"zip":{"description":"The zip code of an address.","type":"string"},"name":{"description":"The full name of the resident at this address. If needed, separate multiple columns with `+`, e.g. `first_name+last_name`","type":"string"},"company":{"description":"The name of the company located at this address.","type":"string"}}},"Object158":{"type":"object","properties":{"name":{"description":"The name of the enhancement job.","type":"string"},"schedule":{"description":"The schedule of when this enhancement will be run.","$ref":"#/definitions/Object102"},"notifications":{"description":"The notifications to send after the enhancement is run.","$ref":"#/definitions/Object103"},"source":{"description":"The information about the source data that will be enhanced. Specify exactly one source.","$ref":"#/definitions/Object159"},"destination":{"description":"The information about how to output the results of this enhancement. Specify exactly one destination.","$ref":"#/definitions/Object161"},"columnMapping":{"description":"A mapping of what columns in the source correspond to the required columns for a CASS/NCOA enhancement.","$ref":"#/definitions/Object163"},"useDefaultColumnMapping":{"description":"Defaults to true, where the existing column mapping on the input table will be used. If false, a custom column mapping must be provided.","type":"boolean"},"performNcoa":{"description":"Whether to update addresses for records matching the National Change of Address (NCOA) database.","type":"boolean"},"ncoaCredentialId":{"description":"Credential to use when performing NCOA updates. Required if 'performNcoa' is true.","type":"integer"},"outputLevel":{"description":"The set of fields persisted by a CASS or NCOA enhancement.For CASS enhancements, one of 'cass' or 'all.'For NCOA enhancements, one of 'cass', 'ncoa' , 'coalesced' or 'all'.By default, all fields will be returned.","type":"string"},"limitingSQL":{"description":"The limiting SQL for the source table. \"WHERE\" should be omitted (e.g. state='IL').","type":"string"},"batchSize":{"description":"The maximum number of records processed at a time. Note that this parameter is not available to all users.","type":"integer"},"parentId":{"description":"Parent ID that triggers this enhancement.","type":"integer"}},"required":["name","source"]},"Object166":{"type":"object","properties":{"schema":{"description":"The schema name of the source table.","type":"string"},"table":{"description":"The name of the source table.","type":"string"},"remoteHostId":{"description":"The ID of the database host for the table.","type":"integer"},"credentialId":{"description":"The id of the credentials to be used when performing the enhancement.","type":"integer"},"multipartKey":{"description":"The source table primary key.","type":"array","items":{"type":"string"}}}},"Object165":{"type":"object","properties":{"databaseTable":{"description":"The information about the source database table.","$ref":"#/definitions/Object166"}}},"Object168":{"type":"object","properties":{"schema":{"description":"The schema name for the output data.","type":"string"},"table":{"description":"The table name for the output data.","type":"string"}}},"Object167":{"type":"object","properties":{"databaseTable":{"description":"The information about the output database table.","$ref":"#/definitions/Object168"}}},"Object169":{"type":"object","properties":{"address1":{"description":"The first address line.","type":"string"},"address2":{"description":"The second address line.","type":"string"},"city":{"description":"The city of an address.","type":"string"},"state":{"description":"The state of an address.","type":"string"},"zip":{"description":"The zip code of an address.","type":"string"},"name":{"description":"The full name of the resident at this address. If needed, separate multiple columns with `+`, e.g. `first_name+last_name`","type":"string"},"company":{"description":"The name of the company located at this address.","type":"string"}}},"Object164":{"type":"object","properties":{"id":{"description":"The ID for the enhancement.","type":"integer"},"name":{"description":"The name of the enhancement job.","type":"string"},"type":{"description":"The type of the enhancement (e.g CASS-NCOA)","type":"string"},"createdAt":{"description":"The time this enhancement was created.","type":"string","format":"time"},"updatedAt":{"description":"The time the enhancement was last updated.","type":"string","format":"time"},"author":{"description":"The author/owner of the item.","$ref":"#/definitions/Object33"},"state":{"description":"The status of the enhancement's last run","type":"string"},"schedule":{"description":"The schedule of when this enhancement will be run.","$ref":"#/definitions/Object107"},"notifications":{"description":"The notifications to send after the enhancement is run.","$ref":"#/definitions/Object108"},"runningAs":{"description":"The user this enhancement will run as, defaults to the author of the enhancement.","$ref":"#/definitions/Object33"},"myPermissionLevel":{"description":"Your permission level on the object. One of \"read\", \"write\", or \"manage\".","type":"string"},"source":{"description":"The information about the source data that will be enhanced. Specify exactly one source.","$ref":"#/definitions/Object165"},"destination":{"description":"The information about how to output the results of this enhancement. Specify exactly one destination.","$ref":"#/definitions/Object167"},"columnMapping":{"description":"A mapping of what columns in the source correspond to the required columns for a CASS/NCOA enhancement.","$ref":"#/definitions/Object169"},"useDefaultColumnMapping":{"description":"Defaults to true, where the existing column mapping on the input table will be used. If false, a custom column mapping must be provided.","type":"boolean"},"performNcoa":{"description":"Whether to update addresses for records matching the National Change of Address (NCOA) database.","type":"boolean"},"ncoaCredentialId":{"description":"Credential to use when performing NCOA updates. Required if 'performNcoa' is true.","type":"integer"},"outputLevel":{"description":"The set of fields persisted by a CASS or NCOA enhancement.For CASS enhancements, one of 'cass' or 'all.'For NCOA enhancements, one of 'cass', 'ncoa' , 'coalesced' or 'all'.By default, all fields will be returned.","type":"string"},"limitingSQL":{"description":"The limiting SQL for the source table. \"WHERE\" should be omitted (e.g. state='IL').","type":"string"},"batchSize":{"description":"The maximum number of records processed at a time. Note that this parameter is not available to all users.","type":"integer"},"archived":{"description":"The archival status of the requested item(s).","type":"string"},"parentId":{"description":"Parent ID that triggers this enhancement.","type":"integer"}}},"Object170":{"type":"object","properties":{"name":{"description":"The name of the enhancement job.","type":"string"},"schedule":{"description":"The schedule of when this enhancement will be run.","$ref":"#/definitions/Object102"},"notifications":{"description":"The notifications to send after the enhancement is run.","$ref":"#/definitions/Object103"},"source":{"description":"The information about the source data that will be enhanced. Specify exactly one source.","$ref":"#/definitions/Object159"},"destination":{"description":"The information about how to output the results of this enhancement. Specify exactly one destination.","$ref":"#/definitions/Object161"},"columnMapping":{"description":"A mapping of what columns in the source correspond to the required columns for a CASS/NCOA enhancement.","$ref":"#/definitions/Object163"},"useDefaultColumnMapping":{"description":"Defaults to true, where the existing column mapping on the input table will be used. If false, a custom column mapping must be provided.","type":"boolean"},"performNcoa":{"description":"Whether to update addresses for records matching the National Change of Address (NCOA) database.","type":"boolean"},"ncoaCredentialId":{"description":"Credential to use when performing NCOA updates. Required if 'performNcoa' is true.","type":"integer"},"outputLevel":{"description":"The set of fields persisted by a CASS or NCOA enhancement.For CASS enhancements, one of 'cass' or 'all.'For NCOA enhancements, one of 'cass', 'ncoa' , 'coalesced' or 'all'.By default, all fields will be returned.","type":"string"},"limitingSQL":{"description":"The limiting SQL for the source table. \"WHERE\" should be omitted (e.g. state='IL').","type":"string"},"batchSize":{"description":"The maximum number of records processed at a time. Note that this parameter is not available to all users.","type":"integer"},"parentId":{"description":"Parent ID that triggers this enhancement.","type":"integer"}},"required":["name","source"]},"Object171":{"type":"object","properties":{"name":{"description":"The name of the enhancement job.","type":"string"},"schedule":{"description":"The schedule of when this enhancement will be run.","$ref":"#/definitions/Object102"},"notifications":{"description":"The notifications to send after the enhancement is run.","$ref":"#/definitions/Object103"},"source":{"description":"The information about the source data that will be enhanced. Specify exactly one source.","$ref":"#/definitions/Object159"},"destination":{"description":"The information about how to output the results of this enhancement. Specify exactly one destination.","$ref":"#/definitions/Object161"},"columnMapping":{"description":"A mapping of what columns in the source correspond to the required columns for a CASS/NCOA enhancement.","$ref":"#/definitions/Object163"},"useDefaultColumnMapping":{"description":"Defaults to true, where the existing column mapping on the input table will be used. If false, a custom column mapping must be provided.","type":"boolean"},"performNcoa":{"description":"Whether to update addresses for records matching the National Change of Address (NCOA) database.","type":"boolean"},"ncoaCredentialId":{"description":"Credential to use when performing NCOA updates. Required if 'performNcoa' is true.","type":"integer"},"outputLevel":{"description":"The set of fields persisted by a CASS or NCOA enhancement.For CASS enhancements, one of 'cass' or 'all.'For NCOA enhancements, one of 'cass', 'ncoa' , 'coalesced' or 'all'.By default, all fields will be returned.","type":"string"},"limitingSQL":{"description":"The limiting SQL for the source table. \"WHERE\" should be omitted (e.g. state='IL').","type":"string"},"batchSize":{"description":"The maximum number of records processed at a time. Note that this parameter is not available to all users.","type":"integer"},"parentId":{"description":"Parent ID that triggers this enhancement.","type":"integer"}}},"Object172":{"type":"object","properties":{"id":{"description":"The ID of the run.","type":"integer"},"cassNcoaId":{"description":"The ID of the CASS NCOA job.","type":"integer"},"state":{"description":"The state of the run, one of 'queued' 'running' 'succeeded' 'failed' or 'cancelled'.","type":"string"},"isCancelRequested":{"description":"True if run cancel requested, else false.","type":"boolean"},"createdAt":{"description":"The time the run was created.","type":"string","format":"time"},"startedAt":{"description":"The time the run started at.","type":"string","format":"time"},"finishedAt":{"description":"The time the run completed.","type":"string","format":"time"},"error":{"description":"The error, if any, returned by the run.","type":"string"}}},"Object173":{"type":"object","properties":{"id":{"description":"The ID of the run.","type":"integer"},"state":{"description":"The state of the run, one of 'queued', 'running' or 'cancelled'.","type":"string"},"isCancelRequested":{"description":"True if run cancel requested, else false.","type":"boolean"}}},"Object174":{"type":"object","properties":{"objectType":{"description":"The type of the output. Valid values are File, Table, Report, Project, Credential, or JSONValue","type":"string"},"objectId":{"description":"The ID of the output.","type":"integer"},"name":{"description":"The name of the output.","type":"string"},"link":{"description":"The hypermedia link to the output.","type":"string"},"value":{"type":"string"}}},"Object175":{"type":"object","properties":{"name":{"description":"The name of the enhancement job.","type":"string"},"schedule":{"description":"The schedule of when this enhancement will be run.","$ref":"#/definitions/Object102"},"notifications":{"description":"The notifications to send after the enhancement is run.","$ref":"#/definitions/Object103"},"remoteHostId":{"description":"The ID of the remote host.","type":"integer"},"credentialId":{"description":"The ID of the remote host credential.","type":"integer"},"sourceSchemaAndTable":{"description":"The source database schema and table.","type":"string"},"multipartKey":{"description":"The source table primary key.","type":"array","items":{"type":"string"}},"limitingSQL":{"description":"The limiting SQL for the source table. \"WHERE\" should be omitted (e.g. state='IL').","type":"string"},"targetSchema":{"description":"The output table schema.","type":"string"},"targetTable":{"description":"The output table name.","type":"string"},"country":{"description":"The country of the addresses to be geocoded; either 'us' or 'ca'.","type":"string"},"provider":{"description":"The geocoding provider; one of postgis and geocoder_ca.","type":"string"},"outputAddress":{"description":"Whether to output the parsed address. Only guaranteed for the 'postgis' provider.","type":"boolean"},"parentId":{"description":"Parent ID that triggers this enhancement.","type":"integer"}},"required":["name","remoteHostId","credentialId","sourceSchemaAndTable"]},"Object176":{"type":"object","properties":{"id":{"description":"The ID for the enhancement.","type":"integer"},"name":{"description":"The name of the enhancement job.","type":"string"},"type":{"description":"The type of the enhancement (e.g CASS-NCOA)","type":"string"},"createdAt":{"description":"The time this enhancement was created.","type":"string","format":"time"},"updatedAt":{"description":"The time the enhancement was last updated.","type":"string","format":"time"},"author":{"description":"The author/owner of the item.","$ref":"#/definitions/Object33"},"state":{"description":"The status of the enhancement's last run","type":"string"},"schedule":{"description":"The schedule of when this enhancement will be run.","$ref":"#/definitions/Object107"},"notifications":{"description":"The notifications to send after the enhancement is run.","$ref":"#/definitions/Object108"},"runningAs":{"description":"The user this enhancement will run as, defaults to the author of the enhancement.","$ref":"#/definitions/Object33"},"myPermissionLevel":{"description":"Your permission level on the object. One of \"read\", \"write\", or \"manage\".","type":"string"},"remoteHostId":{"description":"The ID of the remote host.","type":"integer"},"credentialId":{"description":"The ID of the remote host credential.","type":"integer"},"sourceSchemaAndTable":{"description":"The source database schema and table.","type":"string"},"multipartKey":{"description":"The source table primary key.","type":"array","items":{"type":"string"}},"limitingSQL":{"description":"The limiting SQL for the source table. \"WHERE\" should be omitted (e.g. state='IL').","type":"string"},"targetSchema":{"description":"The output table schema.","type":"string"},"targetTable":{"description":"The output table name.","type":"string"},"country":{"description":"The country of the addresses to be geocoded; either 'us' or 'ca'.","type":"string"},"provider":{"description":"The geocoding provider; one of postgis and geocoder_ca.","type":"string"},"outputAddress":{"description":"Whether to output the parsed address. Only guaranteed for the 'postgis' provider.","type":"boolean"},"archived":{"description":"The archival status of the requested item(s).","type":"string"},"parentId":{"description":"Parent ID that triggers this enhancement.","type":"integer"}}},"Object177":{"type":"object","properties":{"name":{"description":"The name of the enhancement job.","type":"string"},"schedule":{"description":"The schedule of when this enhancement will be run.","$ref":"#/definitions/Object102"},"notifications":{"description":"The notifications to send after the enhancement is run.","$ref":"#/definitions/Object103"},"remoteHostId":{"description":"The ID of the remote host.","type":"integer"},"credentialId":{"description":"The ID of the remote host credential.","type":"integer"},"sourceSchemaAndTable":{"description":"The source database schema and table.","type":"string"},"multipartKey":{"description":"The source table primary key.","type":"array","items":{"type":"string"}},"limitingSQL":{"description":"The limiting SQL for the source table. \"WHERE\" should be omitted (e.g. state='IL').","type":"string"},"targetSchema":{"description":"The output table schema.","type":"string"},"targetTable":{"description":"The output table name.","type":"string"},"country":{"description":"The country of the addresses to be geocoded; either 'us' or 'ca'.","type":"string"},"provider":{"description":"The geocoding provider; one of postgis and geocoder_ca.","type":"string"},"outputAddress":{"description":"Whether to output the parsed address. Only guaranteed for the 'postgis' provider.","type":"boolean"},"parentId":{"description":"Parent ID that triggers this enhancement.","type":"integer"}},"required":["name","remoteHostId","credentialId","sourceSchemaAndTable"]},"Object178":{"type":"object","properties":{"name":{"description":"The name of the enhancement job.","type":"string"},"schedule":{"description":"The schedule of when this enhancement will be run.","$ref":"#/definitions/Object102"},"notifications":{"description":"The notifications to send after the enhancement is run.","$ref":"#/definitions/Object103"},"remoteHostId":{"description":"The ID of the remote host.","type":"integer"},"credentialId":{"description":"The ID of the remote host credential.","type":"integer"},"sourceSchemaAndTable":{"description":"The source database schema and table.","type":"string"},"multipartKey":{"description":"The source table primary key.","type":"array","items":{"type":"string"}},"limitingSQL":{"description":"The limiting SQL for the source table. \"WHERE\" should be omitted (e.g. state='IL').","type":"string"},"targetSchema":{"description":"The output table schema.","type":"string"},"targetTable":{"description":"The output table name.","type":"string"},"country":{"description":"The country of the addresses to be geocoded; either 'us' or 'ca'.","type":"string"},"provider":{"description":"The geocoding provider; one of postgis and geocoder_ca.","type":"string"},"outputAddress":{"description":"Whether to output the parsed address. Only guaranteed for the 'postgis' provider.","type":"boolean"},"parentId":{"description":"Parent ID that triggers this enhancement.","type":"integer"}}},"Object179":{"type":"object","properties":{"id":{"description":"The ID of the run.","type":"integer"},"geocodeId":{"description":"The ID of the Geocode job.","type":"integer"},"state":{"description":"The state of the run, one of 'queued' 'running' 'succeeded' 'failed' or 'cancelled'.","type":"string"},"isCancelRequested":{"description":"True if run cancel requested, else false.","type":"boolean"},"createdAt":{"description":"The time the run was created.","type":"string","format":"time"},"startedAt":{"description":"The time the run started at.","type":"string","format":"time"},"finishedAt":{"description":"The time the run completed.","type":"string","format":"time"},"error":{"description":"The error, if any, returned by the run.","type":"string"}}},"Object180":{"type":"object","properties":{"id":{"description":"The ID of the run.","type":"integer"},"state":{"description":"The state of the run, one of 'queued', 'running' or 'cancelled'.","type":"string"},"isCancelRequested":{"description":"True if run cancel requested, else false.","type":"boolean"}}},"Object181":{"type":"object","properties":{"objectType":{"description":"The type of the output. Valid values are File, Table, Report, Project, Credential, or JSONValue","type":"string"},"objectId":{"description":"The ID of the output.","type":"integer"},"name":{"description":"The name of the output.","type":"string"},"link":{"description":"The hypermedia link to the output.","type":"string"},"value":{"type":"string"}}},"Object199":{"type":"object","properties":{"userIds":{"description":"An array of one or more user IDs.","type":"array","items":{"type":"integer"}},"permissionLevel":{"description":"Options are: \"read\", \"write\", or \"manage\".","type":"string"},"shareEmailBody":{"description":"Custom body text for e-mail sent on a share.","type":"string"},"sendSharedEmail":{"description":"Send email to the recipients of a share.","type":"boolean"}},"required":["userIds","permissionLevel"]},"Object200":{"type":"object","properties":{"groupIds":{"description":"An array of one or more group IDs.","type":"array","items":{"type":"integer"}},"permissionLevel":{"description":"Options are: \"read\", \"write\", or \"manage\".","type":"string"},"shareEmailBody":{"description":"Custom body text for e-mail sent on a share.","type":"string"},"sendSharedEmail":{"description":"Send email to the recipients of a share.","type":"boolean"}},"required":["groupIds","permissionLevel"]},"Object201":{"type":"object","properties":{"userId":{"description":"ID of target user","type":"integer"},"includeDependencies":{"description":"Whether or not to give manage permissions on all dependencies","type":"boolean"},"emailBody":{"description":"Custom body text for e-mail sent on transfer.","type":"string"},"sendEmail":{"description":"Send email to the target user of the transfer?","type":"boolean"}},"required":["userId","includeDependencies"]},"Object202":{"type":"object","properties":{"status":{"description":"The desired archived status of the object.","type":"boolean"}},"required":["status"]},"Object203":{"type":"object","properties":{"userIds":{"description":"An array of one or more user IDs.","type":"array","items":{"type":"integer"}},"permissionLevel":{"description":"Options are: \"read\", \"write\", or \"manage\".","type":"string"},"shareEmailBody":{"description":"Custom body text for e-mail sent on a share.","type":"string"},"sendSharedEmail":{"description":"Send email to the recipients of a share.","type":"boolean"}},"required":["userIds","permissionLevel"]},"Object204":{"type":"object","properties":{"groupIds":{"description":"An array of one or more group IDs.","type":"array","items":{"type":"integer"}},"permissionLevel":{"description":"Options are: \"read\", \"write\", or \"manage\".","type":"string"},"shareEmailBody":{"description":"Custom body text for e-mail sent on a share.","type":"string"},"sendSharedEmail":{"description":"Send email to the recipients of a share.","type":"boolean"}},"required":["groupIds","permissionLevel"]},"Object205":{"type":"object","properties":{"userId":{"description":"ID of target user","type":"integer"},"includeDependencies":{"description":"Whether or not to give manage permissions on all dependencies","type":"boolean"},"emailBody":{"description":"Custom body text for e-mail sent on transfer.","type":"string"},"sendEmail":{"description":"Send email to the target user of the transfer?","type":"boolean"}},"required":["userId","includeDependencies"]},"Object206":{"type":"object","properties":{"status":{"description":"The desired archived status of the object.","type":"boolean"}},"required":["status"]},"Object207":{"type":"object","properties":{"userIds":{"description":"An array of one or more user IDs.","type":"array","items":{"type":"integer"}},"permissionLevel":{"description":"Options are: \"read\", \"write\", or \"manage\".","type":"string"},"shareEmailBody":{"description":"Custom body text for e-mail sent on a share.","type":"string"},"sendSharedEmail":{"description":"Send email to the recipients of a share.","type":"boolean"}},"required":["userIds","permissionLevel"]},"Object208":{"type":"object","properties":{"groupIds":{"description":"An array of one or more group IDs.","type":"array","items":{"type":"integer"}},"permissionLevel":{"description":"Options are: \"read\", \"write\", or \"manage\".","type":"string"},"shareEmailBody":{"description":"Custom body text for e-mail sent on a share.","type":"string"},"sendSharedEmail":{"description":"Send email to the recipients of a share.","type":"boolean"}},"required":["groupIds","permissionLevel"]},"Object209":{"type":"object","properties":{"userId":{"description":"ID of target user","type":"integer"},"includeDependencies":{"description":"Whether or not to give manage permissions on all dependencies","type":"boolean"},"emailBody":{"description":"Custom body text for e-mail sent on transfer.","type":"string"},"sendEmail":{"description":"Send email to the target user of the transfer?","type":"boolean"}},"required":["userId","includeDependencies"]},"Object210":{"type":"object","properties":{"status":{"description":"The desired archived status of the object.","type":"boolean"}},"required":["status"]},"Object211":{"type":"object","properties":{"id":{"description":"The ID for this export.","type":"integer"},"name":{"description":"The name of this export.","type":"string"},"type":{"description":"The type of export.","type":"string"},"createdAt":{"description":"The creation time for this export.","type":"string","format":"time"},"updatedAt":{"description":"The last modification time for this export.","type":"string","format":"time"},"state":{"type":"string"},"lastRun":{"description":"The last run of this export.","$ref":"#/definitions/Object75"},"author":{"description":"The author/owner of the item.","$ref":"#/definitions/Object33"}}},"Object212":{"type":"object","properties":{"id":{"type":"integer"},"state":{"type":"string"},"createdAt":{"description":"The time that the run was queued.","type":"string","format":"time"},"startedAt":{"description":"The time that the run started.","type":"string","format":"time"},"finishedAt":{"description":"The time that the run completed.","type":"string","format":"time"},"error":{"description":"The error message for this run, if present.","type":"string"},"outputCachedOn":{"description":"The time that the output was originally exported, if a cache entry was used by the run.","type":"string","format":"time"}}},"Object213":{"type":"object","properties":{"id":{"type":"integer"},"state":{"type":"string"},"createdAt":{"description":"The time that the run was queued.","type":"string","format":"time"},"startedAt":{"description":"The time that the run started.","type":"string","format":"time"},"finishedAt":{"description":"The time that the run completed.","type":"string","format":"time"},"error":{"description":"The error message for this run, if present.","type":"string"}}},"Object214":{"type":"object","properties":{"objectType":{"description":"The type of the output. Valid values are File, Table, Report, Project, Credential, or JSONValue","type":"string"},"objectId":{"description":"The ID of the output.","type":"integer"},"name":{"description":"The name of the output.","type":"string"},"link":{"description":"The hypermedia link to the output.","type":"string"},"value":{"type":"string"}}},"Object216":{"type":"object","properties":{"sql":{"description":"The SQL query for this Csv Export job","type":"string"},"remoteHostId":{"description":"The ID of the destination database host.","type":"integer"},"credentialId":{"description":"The ID of the credentials for the destination database.","type":"integer"}},"required":["sql","remoteHostId","credentialId"]},"Object218":{"type":"object","properties":{"filePath":{"description":"The path within the bucket where the exported file will be saved. E.g. the file_path for \"s3://mybucket/files/all/\" would be \"/files/all/\"","type":"string"},"storageHostId":{"description":"The ID of the destination storage host.","type":"integer"},"credentialId":{"description":"The ID of the credentials for the destination storage host.","type":"integer"},"existingFiles":{"description":"Notifies the job of what to do in the case that the exported file already exists at the provided path.One of: fail, append, overwrite. Default: fail. If \"append\" is specified,the new file will always be added to the provided path. If \"overwrite\" is specifiedall existing files at the provided path will be deleted and the new file will be added.By default, or if \"fail\" is specified, the export will fail if a file exists at the provided path.","type":"string"}},"required":["filePath","storageHostId","credentialId"]},"Object217":{"type":"object","properties":{"filenamePrefix":{"description":"The prefix of the name of the file returned to the user.","type":"string"},"storagePath":{"description":"A user-provided storage path.","$ref":"#/definitions/Object218"}}},"Object215":{"type":"object","properties":{"name":{"description":"The name of this Csv Export job.","type":"string"},"source":{"$ref":"#/definitions/Object216"},"destination":{"$ref":"#/definitions/Object217"},"includeHeader":{"description":"A boolean value indicating whether or not the header should be included. Defaults to true.","type":"boolean"},"compression":{"description":"The compression of the output file. Valid arguments are \"gzip\" and \"none\". Defaults to \"gzip\".","type":"string"},"columnDelimiter":{"description":"The column delimiter for the output file. Valid arguments are \"comma\", \"tab\", and \"pipe\". Defaults to \"comma\".","type":"string"},"hidden":{"description":"A boolean value indicating whether or not this request should be hidden. Defaults to false.","type":"boolean"},"forceMultifile":{"description":"Whether or not the csv should be split into multiple files. Default: false","type":"boolean"},"maxFileSize":{"description":"The max file size, in MB, created files will be. Only available when force_multifile is true. ","type":"integer"}},"required":["source","destination"]},"Object220":{"type":"object","properties":{"sql":{"description":"The SQL query for this Csv Export job","type":"string"},"remoteHostId":{"description":"The ID of the destination database host.","type":"integer"},"credentialId":{"description":"The ID of the credentials for the destination database.","type":"integer"}}},"Object222":{"type":"object","properties":{"filePath":{"description":"The path within the bucket where the exported file will be saved. E.g. the file_path for \"s3://mybucket/files/all/\" would be \"/files/all/\"","type":"string"},"storageHostId":{"description":"The ID of the destination storage host.","type":"integer"},"credentialId":{"description":"The ID of the credentials for the destination storage host.","type":"integer"},"existingFiles":{"description":"Notifies the job of what to do in the case that the exported file already exists at the provided path.One of: fail, append, overwrite. Default: fail. If \"append\" is specified,the new file will always be added to the provided path. If \"overwrite\" is specifiedall existing files at the provided path will be deleted and the new file will be added.By default, or if \"fail\" is specified, the export will fail if a file exists at the provided path.","type":"string"}}},"Object221":{"type":"object","properties":{"filenamePrefix":{"description":"The prefix of the name of the file returned to the user.","type":"string"},"storagePath":{"description":"A user-provided storage path.","$ref":"#/definitions/Object222"}}},"Object219":{"type":"object","properties":{"id":{"description":"The ID of this Csv Export job.","type":"integer"},"name":{"description":"The name of this Csv Export job.","type":"string"},"source":{"$ref":"#/definitions/Object220"},"destination":{"$ref":"#/definitions/Object221"},"includeHeader":{"description":"A boolean value indicating whether or not the header should be included. Defaults to true.","type":"boolean"},"compression":{"description":"The compression of the output file. Valid arguments are \"gzip\" and \"none\". Defaults to \"gzip\".","type":"string"},"columnDelimiter":{"description":"The column delimiter for the output file. Valid arguments are \"comma\", \"tab\", and \"pipe\". Defaults to \"comma\".","type":"string"},"hidden":{"description":"A boolean value indicating whether or not this request should be hidden. Defaults to false.","type":"boolean"},"forceMultifile":{"description":"Whether or not the csv should be split into multiple files. Default: false","type":"boolean"},"maxFileSize":{"description":"The max file size, in MB, created files will be. Only available when force_multifile is true. ","type":"integer"},"myPermissionLevel":{"description":"Your permission level on the object. One of \"read\", \"write\", or \"manage\".","type":"string"}}},"Object223":{"type":"object","properties":{"name":{"description":"The name of this Csv Export job.","type":"string"},"source":{"$ref":"#/definitions/Object216"},"destination":{"$ref":"#/definitions/Object217"},"includeHeader":{"description":"A boolean value indicating whether or not the header should be included. Defaults to true.","type":"boolean"},"compression":{"description":"The compression of the output file. Valid arguments are \"gzip\" and \"none\". Defaults to \"gzip\".","type":"string"},"columnDelimiter":{"description":"The column delimiter for the output file. Valid arguments are \"comma\", \"tab\", and \"pipe\". Defaults to \"comma\".","type":"string"},"hidden":{"description":"A boolean value indicating whether or not this request should be hidden. Defaults to false.","type":"boolean"},"forceMultifile":{"description":"Whether or not the csv should be split into multiple files. Default: false","type":"boolean"},"maxFileSize":{"description":"The max file size, in MB, created files will be. Only available when force_multifile is true. ","type":"integer"}},"required":["source","destination"]},"Object225":{"type":"object","properties":{"sql":{"description":"The SQL query for this Csv Export job","type":"string"},"remoteHostId":{"description":"The ID of the destination database host.","type":"integer"},"credentialId":{"description":"The ID of the credentials for the destination database.","type":"integer"}}},"Object224":{"type":"object","properties":{"name":{"description":"The name of this Csv Export job.","type":"string"},"source":{"$ref":"#/definitions/Object225"},"destination":{"$ref":"#/definitions/Object217"},"includeHeader":{"description":"A boolean value indicating whether or not the header should be included. Defaults to true.","type":"boolean"},"compression":{"description":"The compression of the output file. Valid arguments are \"gzip\" and \"none\". Defaults to \"gzip\".","type":"string"},"columnDelimiter":{"description":"The column delimiter for the output file. Valid arguments are \"comma\", \"tab\", and \"pipe\". Defaults to \"comma\".","type":"string"},"hidden":{"description":"A boolean value indicating whether or not this request should be hidden. Defaults to false.","type":"boolean"},"forceMultifile":{"description":"Whether or not the csv should be split into multiple files. Default: false","type":"boolean"},"maxFileSize":{"description":"The max file size, in MB, created files will be. Only available when force_multifile is true. ","type":"integer"}}},"Object226":{"type":"object","properties":{"status":{"description":"The desired archived status of the object.","type":"boolean"}},"required":["status"]},"Object232":{"type":"object","properties":{"userIds":{"description":"An array of one or more user IDs.","type":"array","items":{"type":"integer"}},"permissionLevel":{"description":"Options are: \"read\", \"write\", or \"manage\".","type":"string"},"shareEmailBody":{"description":"Custom body text for e-mail sent on a share.","type":"string"},"sendSharedEmail":{"description":"Send email to the recipients of a share.","type":"boolean"}},"required":["userIds","permissionLevel"]},"Object233":{"type":"object","properties":{"groupIds":{"description":"An array of one or more group IDs.","type":"array","items":{"type":"integer"}},"permissionLevel":{"description":"Options are: \"read\", \"write\", or \"manage\".","type":"string"},"shareEmailBody":{"description":"Custom body text for e-mail sent on a share.","type":"string"},"sendSharedEmail":{"description":"Send email to the recipients of a share.","type":"boolean"}},"required":["groupIds","permissionLevel"]},"Object234":{"type":"object","properties":{"userId":{"description":"ID of target user","type":"integer"},"includeDependencies":{"description":"Whether or not to give manage permissions on all dependencies","type":"boolean"},"emailBody":{"description":"Custom body text for e-mail sent on transfer.","type":"string"},"sendEmail":{"description":"Send email to the target user of the transfer?","type":"boolean"}},"required":["userId","includeDependencies"]},"Object235":{"type":"object","properties":{"name":{"description":"The file name.","type":"string"},"expiresAt":{"description":"The date and time the file will expire. If not specified, the file will expire in 30 days. To keep a file indefinitely, specify null.","type":"string","format":"date-time"},"description":{"description":"The user-defined description of the file.","type":"string"}},"required":["name"]},"Object236":{"type":"object","properties":{"id":{"description":"The ID of the file.","type":"integer"},"name":{"description":"The file name.","type":"string"},"createdAt":{"description":"The date and time the file was created.","type":"string","format":"date-time"},"fileSize":{"description":"The file size.","type":"integer"},"expiresAt":{"description":"The date and time the file will expire. If not specified, the file will expire in 30 days. To keep a file indefinitely, specify null.","type":"string","format":"date-time"},"description":{"description":"The user-defined description of the file.","type":"string"},"uploadUrl":{"description":"The URL that may be used to upload a file. To use the upload URL, initiate a POST request to the given URL with the file you wish to import as the \"file\" form field.","type":"string"},"uploadFields":{"description":"A hash containing the form fields to be included with the POST request.","type":"object"},"myPermissionLevel":{"description":"Your permission level on the object. One of \"read\", \"write\", or \"manage\".","type":"string"}}},"Object237":{"type":"object","properties":{"name":{"description":"The file name.","type":"string"},"expiresAt":{"description":"The date and time the file will expire. If not specified, the file will expire in 30 days. To keep a file indefinitely, specify null.","type":"string","format":"date-time"},"description":{"description":"The user-defined description of the file.","type":"string"},"numParts":{"description":"The number of parts in which the file will be uploaded. This parameter determines the number of presigned URLs that are returned.","type":"integer"}},"required":["name","numParts"]},"Object238":{"type":"object","properties":{"id":{"description":"The ID of the file.","type":"integer"},"name":{"description":"The file name.","type":"string"},"createdAt":{"description":"The date and time the file was created.","type":"string","format":"date-time"},"fileSize":{"description":"The file size.","type":"integer"},"expiresAt":{"description":"The date and time the file will expire. If not specified, the file will expire in 30 days. To keep a file indefinitely, specify null.","type":"string","format":"date-time"},"description":{"description":"The user-defined description of the file.","type":"string"},"uploadUrls":{"description":"An array of URLs that may be used to upload file parts. Use separate PUT requests to complete the part uploads. Links expire after 12 hours.","type":"array","items":{"type":"string"}}}},"Object241":{"type":"object","properties":{"name":{"description":"The column name.","type":"string"},"sqlType":{"description":"The SQL type of the column.","type":"string"}}},"Object240":{"type":"object","properties":{"includeHeader":{"description":"A boolean value indicating whether or not the first row of the file is a header row.","type":"boolean"},"columnDelimiter":{"description":"The column delimiter for the file. One of \"comma\", \"tab\", or \"pipe\".","type":"string"},"compression":{"description":"The type of compression of the file. One of \"gzip\", or \"none\".","type":"string"},"tableColumns":{"description":"An array of hashes corresponding to the columns in the file. Each hash should have keys for column \"name\" and \"sql_type\"","type":"array","items":{"$ref":"#/definitions/Object241"}}}},"Object239":{"type":"object","properties":{"id":{"description":"The ID of the file.","type":"integer"},"name":{"description":"The file name.","type":"string"},"createdAt":{"description":"The date and time the file was created.","type":"string","format":"date-time"},"fileSize":{"description":"The file size.","type":"integer"},"expiresAt":{"description":"The date and time the file will expire. If not specified, the file will expire in 30 days. To keep a file indefinitely, specify null.","type":"string","format":"date-time"},"description":{"description":"The user-defined description of the file.","type":"string"},"author":{"description":"The author/owner of the item.","$ref":"#/definitions/Object33"},"downloadUrl":{"description":"A JSON string containing information about the URL of the file.","type":"string"},"fileUrl":{"description":"The URL that may be used to download the file.","type":"string"},"detectedInfo":{"description":"A hash corresponding to the information detected if the file was preprocessed by the \"/files/preprocess/csv\" endpoint.","$ref":"#/definitions/Object240"},"myPermissionLevel":{"description":"Your permission level on the object. One of \"read\", \"write\", or \"manage\".","type":"string"}}},"Object242":{"type":"object","properties":{"name":{"description":"The file name. The extension must match the previous extension.","type":"string"},"expiresAt":{"description":"The date and time the file will expire. ","type":"string","format":"date-time"},"description":{"description":"The user-defined description of the file.","type":"string"}},"required":["name","expiresAt"]},"Object243":{"type":"object","properties":{"name":{"description":"The file name. The extension must match the previous extension.","type":"string"},"expiresAt":{"description":"The date and time the file will expire. ","type":"string","format":"date-time"},"description":{"description":"The user-defined description of the file.","type":"string"}}},"Object244":{"type":"object","properties":{"fileId":{"description":"The ID of the file.","type":"integer"},"inPlace":{"description":"If true, the file is cleaned in place. If false, a new file ID is created. Defaults to true.","type":"boolean"},"detectTableColumns":{"description":"If true, detect the table columns in the file including the sql types. If false, skip table column detection.Defaults to false.","type":"boolean"},"forceCharacterSetConversion":{"description":"If true, the file will always be converted to UTF-8 and any character that cannot be converted will be discarded. If false, the character set conversion will only run if the detected character set is not compatible with UTF-8 (e.g., UTF-8, ASCII).","type":"boolean"},"includeHeader":{"description":"A boolean value indicating whether or not the first row of the file is a header row. If not provided, will attempt to auto-detect whether a header row is present.","type":"boolean"},"columnDelimiter":{"description":"The column delimiter for the file. One of \"comma\", \"tab\", or \"pipe\". If not provided, the column delimiter will be auto-detected.","type":"string"},"hidden":{"description":"The hidden status of the item.","type":"boolean"}},"required":["fileId"]},"Object245":{"type":"object","properties":{"id":{"description":"The ID of the job created.","type":"integer"},"fileId":{"description":"The ID of the file.","type":"integer"},"inPlace":{"description":"If true, the file is cleaned in place. If false, a new file ID is created. Defaults to true.","type":"boolean"},"detectTableColumns":{"description":"If true, detect the table columns in the file including the sql types. If false, skip table column detection.Defaults to false.","type":"boolean"},"forceCharacterSetConversion":{"description":"If true, the file will always be converted to UTF-8 and any character that cannot be converted will be discarded. If false, the character set conversion will only run if the detected character set is not compatible with UTF-8 (e.g., UTF-8, ASCII).","type":"boolean"},"includeHeader":{"description":"A boolean value indicating whether or not the first row of the file is a header row. If not provided, will attempt to auto-detect whether a header row is present.","type":"boolean"},"columnDelimiter":{"description":"The column delimiter for the file. One of \"comma\", \"tab\", or \"pipe\". If not provided, the column delimiter will be auto-detected.","type":"string"},"hidden":{"description":"The hidden status of the item.","type":"boolean"}}},"Object246":{"type":"object","properties":{"fileId":{"description":"The ID of the file.","type":"integer"},"inPlace":{"description":"If true, the file is cleaned in place. If false, a new file ID is created. Defaults to true.","type":"boolean"},"detectTableColumns":{"description":"If true, detect the table columns in the file including the sql types. If false, skip table column detection.Defaults to false.","type":"boolean"},"forceCharacterSetConversion":{"description":"If true, the file will always be converted to UTF-8 and any character that cannot be converted will be discarded. If false, the character set conversion will only run if the detected character set is not compatible with UTF-8 (e.g., UTF-8, ASCII).","type":"boolean"},"includeHeader":{"description":"A boolean value indicating whether or not the first row of the file is a header row. If not provided, will attempt to auto-detect whether a header row is present.","type":"boolean"},"columnDelimiter":{"description":"The column delimiter for the file. One of \"comma\", \"tab\", or \"pipe\". If not provided, the column delimiter will be auto-detected.","type":"string"}},"required":["fileId"]},"Object247":{"type":"object","properties":{"fileId":{"description":"The ID of the file.","type":"integer"},"inPlace":{"description":"If true, the file is cleaned in place. If false, a new file ID is created. Defaults to true.","type":"boolean"},"detectTableColumns":{"description":"If true, detect the table columns in the file including the sql types. If false, skip table column detection.Defaults to false.","type":"boolean"},"forceCharacterSetConversion":{"description":"If true, the file will always be converted to UTF-8 and any character that cannot be converted will be discarded. If false, the character set conversion will only run if the detected character set is not compatible with UTF-8 (e.g., UTF-8, ASCII).","type":"boolean"},"includeHeader":{"description":"A boolean value indicating whether or not the first row of the file is a header row. If not provided, will attempt to auto-detect whether a header row is present.","type":"boolean"},"columnDelimiter":{"description":"The column delimiter for the file. One of \"comma\", \"tab\", or \"pipe\". If not provided, the column delimiter will be auto-detected.","type":"string"}}},"Object248":{"type":"object","properties":{"status":{"description":"The desired archived status of the object.","type":"boolean"}},"required":["status"]},"Object249":{"type":"object","properties":{"id":{"description":"The ID for this git repository.","type":"integer"},"repoUrl":{"description":"The URL for this git repository.","type":"string"},"createdAt":{"type":"string","format":"time"},"updatedAt":{"type":"string","format":"time"}}},"Object250":{"type":"object","properties":{"repoUrl":{"description":"The URL for this git repository.","type":"string"}},"required":["repoUrl"]},"Object251":{"type":"object","properties":{"branches":{"description":"List of branch names of this git repository.","type":"array","items":{"type":"string"}},"tags":{"description":"List of tag names of this git repository.","type":"array","items":{"type":"string"}}}},"Object252":{"type":"object","properties":{"id":{"description":"The ID of this group.","type":"integer"},"name":{"description":"This group's name.","type":"string"},"createdAt":{"description":"The date and time when this group was created.","type":"string","format":"time"},"updatedAt":{"description":"The date and time when this group was last updated.","type":"string","format":"time"},"description":{"description":"The description of the group.","type":"string"},"slug":{"description":"The slug for this group.","type":"string"},"organizationId":{"description":"The ID of the organization this group belongs to.","type":"integer"},"organizationName":{"description":"The name of the organization this group belongs to.","type":"string"},"memberCount":{"description":"The number of active members in this group.","type":"integer"},"totalMemberCount":{"description":"The total number of members in this group.","type":"integer"},"lastUpdatedById":{"description":"The ID of the user who last updated this group.","type":"integer"},"createdById":{"description":"The ID of the user who created this group.","type":"integer"},"members":{"description":"The members of this group.","type":"array","items":{"$ref":"#/definitions/Object33"}}}},"Object253":{"type":"object","properties":{"name":{"description":"This group's name.","type":"string"},"description":{"description":"The description of the group.","type":"string"},"slug":{"description":"The slug for this group.","type":"string"},"organizationId":{"description":"The ID of the organization this group belongs to.","type":"integer"},"defaultOtpRequiredForLogin":{"description":"The two factor authentication requirement for this group.","type":"boolean"},"roleIds":{"description":"An array of ids of all the roles this group has.","type":"array","items":{"type":"integer"}},"defaultTimeZone":{"description":"The default time zone of this group.","type":"string"},"defaultJobsLabel":{"description":"The default partition label for jobs of this group.","type":"string"},"defaultNotebooksLabel":{"description":"The default partition label for notebooks of this group.","type":"string"},"defaultServicesLabel":{"description":"The default partition label for services of this group.","type":"string"}},"required":["name"]},"Object255":{"type":"object","properties":{"id":{"description":"The ID of this user.","type":"integer"},"name":{"description":"This user's name.","type":"string"},"username":{"description":"This user's username.","type":"string"},"initials":{"description":"This user's initials.","type":"string"},"online":{"description":"Whether this user is online.","type":"boolean"},"email":{"description":"This user's email address.","type":"string"},"primaryGroupId":{"description":"The ID of the primary group of this user.","type":"integer"},"active":{"description":"Whether this user account is active or deactivated.","type":"boolean"}}},"Object254":{"type":"object","properties":{"id":{"description":"The ID of this group.","type":"integer"},"name":{"description":"This group's name.","type":"string"},"createdAt":{"description":"The date and time when this group was created.","type":"string","format":"time"},"updatedAt":{"description":"The date and time when this group was last updated.","type":"string","format":"time"},"description":{"description":"The description of the group.","type":"string"},"slug":{"description":"The slug for this group.","type":"string"},"organizationId":{"description":"The ID of the organization this group belongs to.","type":"integer"},"organizationName":{"description":"The name of the organization this group belongs to.","type":"string"},"memberCount":{"description":"The number of active members in this group.","type":"integer"},"totalMemberCount":{"description":"The total number of members in this group.","type":"integer"},"defaultOtpRequiredForLogin":{"description":"The two factor authentication requirement for this group.","type":"boolean"},"roleIds":{"description":"An array of ids of all the roles this group has.","type":"array","items":{"type":"integer"}},"defaultTimeZone":{"description":"The default time zone of this group.","type":"string"},"defaultJobsLabel":{"description":"The default partition label for jobs of this group.","type":"string"},"defaultNotebooksLabel":{"description":"The default partition label for notebooks of this group.","type":"string"},"defaultServicesLabel":{"description":"The default partition label for services of this group.","type":"string"},"lastUpdatedById":{"description":"The ID of the user who last updated this group.","type":"integer"},"createdById":{"description":"The ID of the user who created this group.","type":"integer"},"members":{"description":"The members of this group.","type":"array","items":{"$ref":"#/definitions/Object255"}}}},"Object256":{"type":"object","properties":{"name":{"description":"This group's name.","type":"string"},"description":{"description":"The description of the group.","type":"string"},"slug":{"description":"The slug for this group.","type":"string"},"organizationId":{"description":"The ID of the organization this group belongs to.","type":"integer"},"defaultOtpRequiredForLogin":{"description":"The two factor authentication requirement for this group.","type":"boolean"},"roleIds":{"description":"An array of ids of all the roles this group has.","type":"array","items":{"type":"integer"}},"defaultTimeZone":{"description":"The default time zone of this group.","type":"string"},"defaultJobsLabel":{"description":"The default partition label for jobs of this group.","type":"string"},"defaultNotebooksLabel":{"description":"The default partition label for notebooks of this group.","type":"string"},"defaultServicesLabel":{"description":"The default partition label for services of this group.","type":"string"}},"required":["name"]},"Object257":{"type":"object","properties":{"name":{"description":"This group's name.","type":"string"},"description":{"description":"The description of the group.","type":"string"},"slug":{"description":"The slug for this group.","type":"string"},"organizationId":{"description":"The ID of the organization this group belongs to.","type":"integer"},"defaultOtpRequiredForLogin":{"description":"The two factor authentication requirement for this group.","type":"boolean"},"roleIds":{"description":"An array of ids of all the roles this group has.","type":"array","items":{"type":"integer"}},"defaultTimeZone":{"description":"The default time zone of this group.","type":"string"},"defaultJobsLabel":{"description":"The default partition label for jobs of this group.","type":"string"},"defaultNotebooksLabel":{"description":"The default partition label for notebooks of this group.","type":"string"},"defaultServicesLabel":{"description":"The default partition label for services of this group.","type":"string"}}},"Object258":{"type":"object","properties":{"userIds":{"description":"An array of one or more user IDs.","type":"array","items":{"type":"integer"}},"permissionLevel":{"description":"Options are: \"read\", \"write\", or \"manage\".","type":"string"},"shareEmailBody":{"description":"Custom body text for e-mail sent on a share.","type":"string"},"sendSharedEmail":{"description":"Send email to the recipients of a share.","type":"boolean"}},"required":["userIds","permissionLevel"]},"Object259":{"type":"object","properties":{"groupIds":{"description":"An array of one or more group IDs.","type":"array","items":{"type":"integer"}},"permissionLevel":{"description":"Options are: \"read\", \"write\", or \"manage\".","type":"string"},"shareEmailBody":{"description":"Custom body text for e-mail sent on a share.","type":"string"},"sendSharedEmail":{"description":"Send email to the recipients of a share.","type":"boolean"}},"required":["groupIds","permissionLevel"]},"Object261":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"}}},"Object260":{"type":"object","properties":{"manageable":{"type":"array","items":{"$ref":"#/definitions/Object261"}},"writeable":{"type":"array","items":{"$ref":"#/definitions/Object261"}},"readable":{"type":"array","items":{"$ref":"#/definitions/Object261"}}}},"Object262":{"type":"object","properties":{"userIds":{"description":"An array of one or more user IDs.","type":"array","items":{"type":"integer"}},"permissionLevel":{"description":"Options are: \"read\", \"write\", or \"manage\".","type":"string"},"shareEmailBody":{"description":"Custom body text for e-mail sent on a share.","type":"string"},"sendSharedEmail":{"description":"Send email to the recipients of a share.","type":"boolean"}},"required":["userIds","permissionLevel"]},"Object263":{"type":"object","properties":{"groupIds":{"description":"An array of one or more group IDs.","type":"array","items":{"type":"integer"}},"permissionLevel":{"description":"Options are: \"read\", \"write\", or \"manage\".","type":"string"},"shareEmailBody":{"description":"Custom body text for e-mail sent on a share.","type":"string"},"sendSharedEmail":{"description":"Send email to the recipients of a share.","type":"boolean"}},"required":["groupIds","permissionLevel"]},"Object264":{"type":"object","properties":{"userId":{"description":"ID of target user","type":"integer"},"includeDependencies":{"description":"Whether or not to give manage permissions on all dependencies","type":"boolean"},"emailBody":{"description":"Custom body text for e-mail sent on transfer.","type":"string"},"sendEmail":{"description":"Send email to the target user of the transfer?","type":"boolean"}},"required":["userId","includeDependencies"]},"Object265":{"type":"object","properties":{"status":{"description":"The desired archived status of the object.","type":"boolean"}},"required":["status"]},"Object267":{"type":"object","properties":{"remoteHostId":{"type":"integer"},"credentialId":{"type":"integer"},"additionalCredentials":{"description":"Array that holds additional credentials used for specific imports. For DB Syncs, the first element is an SSL private key credential id, and the second element is the corresponding public key credential id.","type":"array","items":{"type":"integer"}},"name":{"type":"string"}}},"Object270":{"type":"object","properties":{"schema":{"description":"The database schema name.","type":"string"},"table":{"description":"The database table name.","type":"string"},"useWithoutSchema":{"description":"This attribute is no longer available; defaults to false but cannot be used.","type":"boolean"}}},"Object271":{"type":"object","properties":{"id":{"description":"The file id.","type":"integer"}}},"Object272":{"type":"object","properties":{"spreadsheet":{"description":"The spreadsheet document name.","type":"string"},"spreadsheetId":{"description":"The spreadsheet document id.","type":"string"},"worksheet":{"description":"The worksheet tab name.","type":"string"},"worksheetId":{"description":"The worksheet tab id.","type":"integer"}}},"Object273":{"type":"object","properties":{"objectName":{"description":"This parameter is deprecated","type":"string"}}},"Object269":{"type":"object","properties":{"id":{"description":"The ID of the table or file, if available.","type":"integer"},"path":{"description":"The path of the dataset to sync from; for a database source, schema.tablename. If you are doing a Google Sheet export, this can be blank. This is a legacy parameter, it is recommended you use one of the following: databaseTable, file, googleWorksheet","type":"string"},"databaseTable":{"description":"The sync source is a database table.","$ref":"#/definitions/Object270"},"file":{"description":"The sync source is a file.","$ref":"#/definitions/Object271"},"googleWorksheet":{"description":"The sync source is a Google worksheet.","$ref":"#/definitions/Object272"},"salesforce":{"description":"The sync source is Salesforce. Deprecated. Please use the new version instead, see https://support.civisanalytics.com/hc/en-us/articles/8774034069261-Salesforce-Import for details.","$ref":"#/definitions/Object273"}}},"Object274":{"type":"object","properties":{"path":{"description":"The schema.tablename to sync to. If you are doing a Google Sheet export, this is the spreadsheet and sheet name separated by a period. i.e. if you have a spreadsheet named \"MySpreadsheet\" and a sheet called \"Sheet1\" this field would be \"MySpreadsheet.Sheet1\". This is a legacy parameter, it is recommended you use one of the following: databaseTable, googleWorksheet","type":"string"},"databaseTable":{"description":"The sync destination is a database table.","$ref":"#/definitions/Object270"},"googleWorksheet":{"description":"The sync destination is a Google worksheet.","$ref":"#/definitions/Object272"}}},"Object276":{"type":"object","properties":{"name":{"description":"The column name that will override the auto-detected name.","type":"string"},"type":{"description":"Declaration of SQL type that will override the auto-detected SQL type, including necessary properties such as length, precision, etc.","type":"string"}}},"Object275":{"type":"object","properties":{"maxErrors":{"description":"For Google Doc and Auto Imports. The maximum number of errors that can occur without the job failing.","type":"integer"},"existingTableRows":{"description":"For Google Doc and Auto Imports. The behavior if a table with the requested name already exists. One of \"fail\", \"truncate\", \"append\", or \"drop\". Defaults to \"fail\".","type":"string"},"firstRowIsHeader":{"description":"For Google Doc and Auto Imports. A boolean value indicating whether or not the first row is a header row.","type":"boolean"},"diststyle":{"description":"For Auto Imports. The diststyle to use for a Redshift table.","type":"string"},"distkey":{"description":"For Auto Imports. The distkey to use for a Redshift table.","type":"string"},"sortkey1":{"description":"For Auto Imports. The first sortkey to use for a Redshift table.","type":"string"},"sortkey2":{"description":"For Auto Imports. The second sortkey to use for a Redshift table.","type":"string"},"columnDelimiter":{"description":"For Auto Imports. The column delimiter for the file. Valid arguments are \"comma\", \"tab\", and \"pipe\". If column_delimiter is null or omitted, it will be auto-detected.","type":"string"},"columnOverrides":{"description":"For Auto Imports. Hash used for overriding auto-detected names and types, with keys being the index of the column being overridden.","type":"object","additionalProperties":{"$ref":"#/definitions/Object276"}},"escaped":{"description":"For Auto Imports. If true, escape quotes with a backslash; otherwise, escape quotes by double-quoting. Defaults to false.","type":"boolean"},"identityColumn":{"description":"For DB Syncs. The column or columns to use as primary key for incremental syncs. Should be a unique identifier. If blank, primary key columns will be auto-detected. If more than one identity column is specified, an identity column must be specified for each table. We recommend the primary key be a sequential data type such as an integer, double, timestamp, date, or float. If using a primary key that is a string data type, we recommend having a last_modified_column to ensure all data is synced to the destination table.","type":"string"},"lastModifiedColumn":{"description":"For DB Syncs. The column to use to detect recently modified data for incremental syncs. Defaults to \"Auto-Detect\", which will use the first column it finds containing either \"modif\" or \"update\" in the name. When specified, only rows where last_modified_column in the source >= last_modified_column in the destination will be synced.","type":"string"},"rowChunkSize":{"description":"For DB Syncs. If specified, will split the sync into chunks of this size.","type":"integer"},"wipeDestinationTable":{"description":"For DB Syncs. If true, will perform a full table refresh.","type":"boolean"},"truncateLongLines":{"description":"For DB Syncs to Redshift. When true, truncates column data to fit the column specification.","type":"boolean"},"invalidCharReplacement":{"description":"For DB Syncs to Redshift. If specified, will replace each invalid UTF-8 character with this character. Must be a single ASCII character.","type":"string"},"verifyTableRowCounts":{"description":"For DB Syncs. When true, an error will be raised if the destination table does not have the same number of rows as the source table after the sync.","type":"boolean"},"partitionColumnName":{"description":"This parameter is deprecated","type":"string"},"partitionSchemaName":{"description":"This parameter is deprecated","type":"string"},"partitionTableName":{"description":"This parameter is deprecated","type":"string"},"partitionTablePartitionColumnMinName":{"description":"This parameter is deprecated","type":"string"},"partitionTablePartitionColumnMaxName":{"description":"This parameter is deprecated","type":"string"},"mysqlCatalogMatchesSchema":{"description":"This attribute is no longer available; defaults to true but cannot be used.","type":"boolean"},"chunkingMethod":{"description":"This parameter is deprecated","type":"string"},"exportAction":{"description":"For Google Doc Exports. The kind of export action you want to have the export execute. Set to \"newsprsht\" if you want a new worksheet inside a new spreadsheet. Set to \"newwksht\" if you want a new worksheet inside an existing spreadsheet. Set to \"updatewksht\" if you want to overwrite an existing worksheet inside an existing spreadsheet. Set to \"appendwksht\" if you want to append to the end of an existing worksheet inside an existing spreadsheet. Default is set to \"newsprsht\"","type":"string"},"sqlQuery":{"description":"For Google Doc Exports. The SQL query for the export.","type":"string"},"contactLists":{"description":"This parameter is deprecated","type":"string"},"soqlQuery":{"description":"This parameter is deprecated","type":"string"},"includeDeletedRecords":{"description":"This parameter is deprecated","type":"boolean"}}},"Object268":{"type":"object","properties":{"id":{"type":"integer"},"source":{"$ref":"#/definitions/Object269"},"destination":{"$ref":"#/definitions/Object274"},"advancedOptions":{"description":"Additional sync configuration parameters. For examples of sync-specific parameters, see the Examples section of the API documentation.","$ref":"#/definitions/Object275"}}},"Object266":{"type":"object","properties":{"name":{"description":"The name of the import.","type":"string"},"syncType":{"description":"The type of sync to perform; one of Dbsync, AutoImport, GdocImport, and GdocExport.","type":"string"},"source":{"description":"The data source from which to import.","$ref":"#/definitions/Object267"},"destination":{"description":"The database into which to import.","$ref":"#/definitions/Object267"},"schedule":{"description":"The schedule when the import will run.","$ref":"#/definitions/Object107"},"notifications":{"description":"The notifications to send after the script is run.","$ref":"#/definitions/Object108"},"parentId":{"description":"Parent id to trigger this import from","type":"integer"},"id":{"description":"The ID for the import.","type":"integer"},"isOutbound":{"type":"boolean"},"jobType":{"description":"The job type of this import.","type":"string"},"syncs":{"description":"List of syncs.","type":"array","items":{"$ref":"#/definitions/Object268"}},"state":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"lastRun":{"description":"The last run of this import.","$ref":"#/definitions/Object75"},"user":{"$ref":"#/definitions/Object33"},"runningAs":{"description":"The user this job will run as, defaults to the author of the job.","$ref":"#/definitions/Object33"},"nextRunAt":{"description":"The time of the next scheduled run.","type":"string","format":"time"},"timeZone":{"description":"The time zone of this import.","type":"string"},"hidden":{"description":"The hidden status of the item.","type":"boolean"},"archived":{"description":"The archival status of the requested item(s).","type":"string"},"myPermissionLevel":{"description":"Your permission level on the object. One of \"read\", \"write\", or \"manage\".","type":"string"}}},"Object277":{"type":"object","properties":{"name":{"description":"The name of the import.","type":"string"},"syncType":{"description":"The type of sync to perform; one of Dbsync, AutoImport, GdocImport, and GdocExport.","type":"string"},"source":{"description":"The data source from which to import.","$ref":"#/definitions/Object267"},"destination":{"description":"The database into which to import.","$ref":"#/definitions/Object267"},"schedule":{"description":"The schedule when the import will run.","$ref":"#/definitions/Object107"},"id":{"description":"The ID for the import.","type":"integer"},"isOutbound":{"type":"boolean"},"jobType":{"description":"The job type of this import.","type":"string"},"state":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"lastRun":{"description":"The last run of this import.","$ref":"#/definitions/Object75"},"user":{"$ref":"#/definitions/Object33"},"timeZone":{"description":"The time zone of this import.","type":"string"},"archived":{"description":"The archival status of the requested item(s).","type":"string"}}},"Object279":{"type":"object","properties":{"remoteHostId":{"type":"integer"},"credentialId":{"type":"integer"},"additionalCredentials":{"description":"Array that holds additional credentials used for specific imports. For DB Syncs, the first element is an SSL private key credential id, and the second element is the corresponding public key credential id.","type":"array","items":{"type":"integer"}}},"required":["remoteHostId","credentialId"]},"Object278":{"type":"object","properties":{"name":{"description":"The name of the import.","type":"string"},"syncType":{"description":"The type of sync to perform; one of Dbsync, AutoImport, GdocImport, and GdocExport.","type":"string"},"source":{"description":"The data source from which to import.","$ref":"#/definitions/Object279"},"destination":{"description":"The database into which to import.","$ref":"#/definitions/Object279"},"schedule":{"description":"The schedule when the import will run.","$ref":"#/definitions/Object102"},"notifications":{"description":"The notifications to send after the script is run.","$ref":"#/definitions/Object103"},"parentId":{"description":"Parent id to trigger this import from","type":"integer"},"isOutbound":{"type":"boolean"},"nextRunAt":{"description":"The time of the next scheduled run.","type":"string","format":"time"},"timeZone":{"description":"The time zone of this import.","type":"string"},"hidden":{"description":"The hidden status of the item.","type":"boolean"}},"required":["name","syncType","isOutbound"]},"Object280":{"type":"object","properties":{"schema":{"description":"The schema of the destination table.","type":"string"},"name":{"description":"The name of the destination table.","type":"string"},"remoteHostId":{"description":"The id of the destination database host.","type":"integer"},"credentialId":{"description":"The id of the credentials to be used when performing the database import.","type":"integer"},"maxErrors":{"description":"The maximum number of rows with errors to remove from the import before failing.","type":"integer"},"existingTableRows":{"description":"The behaviour if a table with the requested name already exists. One of \"fail\", \"truncate\", \"append\", or \"drop\".Defaults to \"fail\".","type":"string"},"diststyle":{"description":"The diststyle to use for the table. One of \"even\", \"all\", or \"key\".","type":"string"},"distkey":{"description":"The column to use as the distkey for the table.","type":"string"},"sortkey1":{"description":"The column to use as the sort key for the table.","type":"string"},"sortkey2":{"description":"The second column in a compound sortkey for the table.","type":"string"},"columnDelimiter":{"description":"The column delimiter of the file. If column_delimiter is null or omitted, it will be auto-detected. Valid arguments are \"comma\", \"tab\", and \"pipe\".","type":"string"},"firstRowIsHeader":{"description":"A boolean value indicating whether or not the first row is a header row. If first_row_is_header is null or omitted, it will be auto-detected.","type":"boolean"},"multipart":{"description":"If true, the upload URI will require a `multipart/form-data` POST request. Defaults to false.","type":"boolean"},"escaped":{"description":"If true, escape quotes with a backslash; otherwise, escape quotes by double-quoting. Defaults to false.","type":"boolean"},"hidden":{"description":"The hidden status of the item.","type":"boolean"}},"required":["schema","name","remoteHostId","credentialId"]},"Object281":{"type":"object","properties":{"id":{"description":"The id of the import.","type":"integer"},"uploadUri":{"description":"The URI which may be used to upload a tabular file for import. You must use this URI to upload the file you wish imported and then inform the Civis API when your upload is complete using the URI given by the runUri field of this response.","type":"string"},"runUri":{"description":"The URI to POST to once the file upload is complete. After uploading the file using the URI given in the uploadUri attribute of the response, POST to this URI to initiate the import of your uploaded file into the platform.","type":"string"},"uploadFields":{"description":"If multipart was set to true, these fields should be included in the multipart upload.","type":"object","additionalProperties":{"type":"string"}}}},"Object282":{"type":"object","properties":{"id":{"description":"The ID of the run.","type":"integer"},"importId":{"description":"The ID of the Import job.","type":"integer"},"state":{"description":"The state of the run, one of 'queued' 'running' 'succeeded' 'failed' or 'cancelled'.","type":"string"},"isCancelRequested":{"description":"True if run cancel requested, else false.","type":"boolean"},"createdAt":{"description":"The time the run was created.","type":"string","format":"time"},"startedAt":{"description":"The time the run started at.","type":"string","format":"time"},"finishedAt":{"description":"The time the run completed.","type":"string","format":"time"},"error":{"description":"The error, if any, returned by the run.","type":"string"}}},"Object285":{"type":"object","properties":{"storageHostId":{"description":"The ID of the source storage host.","type":"integer"},"credentialId":{"description":"The ID of the credentials for the source storage host.","type":"integer"},"filePaths":{"description":"The file or directory path(s) within the bucket from which to import. E.g. the file_path for \"s3://mybucket/files/all/\" would be \"/files/all/\"If specifying a directory path, the job will import every file found under that path. All files must have the same column layout and file format (e.g., compression, columnDelimiter, etc.).","type":"array","items":{"type":"string"}}},"required":["storageHostId","credentialId","filePaths"]},"Object284":{"type":"object","properties":{"fileIds":{"description":"The file ID(s) to import, if importing Civis file(s).","type":"array","items":{"type":"integer"}},"storagePath":{"description":"The storage host file path to import, if importing files from an external storage provider (ex. S3).","$ref":"#/definitions/Object285"}}},"Object286":{"type":"object","properties":{"schema":{"description":"The destination schema name.","type":"string"},"table":{"description":"The destination table name.","type":"string"},"remoteHostId":{"description":"The ID of the destination database host.","type":"integer"},"credentialId":{"description":"The ID of the credentials for the destination database.","type":"integer"},"primaryKeys":{"description":"A list of column(s) which together uniquely identify a row in the destination table.These columns must not contain NULL values. If the import mode is \"upsert\", this field is required;see the Civis Helpdesk article on \"Advanced CSV Imports via the Civis API\" for more information.","type":"array","items":{"type":"string"}},"lastModifiedKeys":{"description":"A list of the columns indicating a record has been updated.If the destination table does not exist, and the import mode is \"upsert\", this field is required.","type":"array","items":{"type":"string"}}},"required":["schema","table","remoteHostId","credentialId"]},"Object287":{"type":"object","properties":{"name":{"description":"The column name.","type":"string"},"sqlType":{"description":"The SQL type of the column.","type":"string"}},"required":["name"]},"Object288":{"type":"object","properties":{"diststyle":{"description":"The diststyle to use for the table. One of \"even\", \"all\", or \"key\".","type":"string"},"distkey":{"description":"Distkey for this table in Redshift","type":"string"},"sortkeys":{"description":"Sortkeys for this table in Redshift. Please provide a maximum of two.","type":"array","items":{"type":"string"}}}},"Object283":{"type":"object","properties":{"name":{"description":"The name of the import.","type":"string"},"source":{"description":"The source file(s). Provide either an array of Civis file_ids or a storage path hash with an array of one or more file_paths.","$ref":"#/definitions/Object284"},"destination":{"description":"The destination table.","$ref":"#/definitions/Object286"},"firstRowIsHeader":{"description":"A boolean value indicating whether or not the first row of the source file is a header row.","type":"boolean"},"columnDelimiter":{"description":"The column delimiter for the file. Valid arguments are \"comma\", \"tab\", and \"pipe\". Defaults to \"comma\".","type":"string"},"escaped":{"description":"A boolean value indicating whether or not the source file has quotes escaped with a backslash.Defaults to false.","type":"boolean"},"compression":{"description":"The type of compression of the source file. Valid arguments are \"gzip\" and \"none\". Defaults to \"none\".","type":"string"},"existingTableRows":{"description":"The behavior if a destination table with the requested name already exists. One of \"fail\", \"truncate\", \"append\", \"drop\", or \"upsert\".Defaults to \"fail\".","type":"string"},"maxErrors":{"description":"The maximum number of rows with errors to ignore before failing. This option is not supported for Postgres databases.","type":"integer"},"tableColumns":{"description":"An array of hashes corresponding to the columns in the order they appear in the source file. Each hash should have keys for database column \"name\" and \"sqlType\".This parameter is required if the table does not exist, the table is being dropped, or the columns in the source file do not appear in the same order as in the destination table.The \"sqlType\" key is not required when appending to an existing table. ","type":"array","items":{"$ref":"#/definitions/Object287"}},"loosenTypes":{"description":"If true, SQL types with precisions/lengths will have these values increased to accommodate data growth in future loads. Type loosening only occurs on table creation. Defaults to false.","type":"boolean"},"execution":{"description":"In upsert mode, controls the movement of data in upsert mode. If set to \"delayed\", the data will be moved after a brief delay. If set to \"immediate\", the data will be moved immediately. In non-upsert modes, controls the speed at which detailed column stats appear in the data catalogue. Defaults to \"delayed\", to accommodate concurrent upserts to the same table and speedier non-upsert imports.","type":"string"},"redshiftDestinationOptions":{"description":"Additional options for imports whose destination is a Redshift table.","$ref":"#/definitions/Object288"},"hidden":{"description":"The hidden status of the item.","type":"boolean"}},"required":["source","destination","firstRowIsHeader"]},"Object291":{"type":"object","properties":{"storageHostId":{"description":"The ID of the source storage host.","type":"integer"},"credentialId":{"description":"The ID of the credentials for the source storage host.","type":"integer"},"filePaths":{"description":"The file or directory path(s) within the bucket from which to import. E.g. the file_path for \"s3://mybucket/files/all/\" would be \"/files/all/\"If specifying a directory path, the job will import every file found under that path. All files must have the same column layout and file format (e.g., compression, columnDelimiter, etc.).","type":"array","items":{"type":"string"}}}},"Object290":{"type":"object","properties":{"fileIds":{"description":"The file ID(s) to import, if importing Civis file(s).","type":"array","items":{"type":"integer"}},"storagePath":{"description":"The storage host file path to import, if importing files from an external storage provider (ex. S3).","$ref":"#/definitions/Object291"}}},"Object292":{"type":"object","properties":{"schema":{"description":"The destination schema name.","type":"string"},"table":{"description":"The destination table name.","type":"string"},"remoteHostId":{"description":"The ID of the destination database host.","type":"integer"},"credentialId":{"description":"The ID of the credentials for the destination database.","type":"integer"},"primaryKeys":{"description":"A list of column(s) which together uniquely identify a row in the destination table.These columns must not contain NULL values. If the import mode is \"upsert\", this field is required;see the Civis Helpdesk article on \"Advanced CSV Imports via the Civis API\" for more information.","type":"array","items":{"type":"string"}},"lastModifiedKeys":{"description":"A list of the columns indicating a record has been updated.If the destination table does not exist, and the import mode is \"upsert\", this field is required.","type":"array","items":{"type":"string"}}}},"Object293":{"type":"object","properties":{"name":{"description":"The column name.","type":"string"},"sqlType":{"description":"The SQL type of the column.","type":"string"}}},"Object294":{"type":"object","properties":{"diststyle":{"description":"The diststyle to use for the table. One of \"even\", \"all\", or \"key\".","type":"string"},"distkey":{"description":"Distkey for this table in Redshift","type":"string"},"sortkeys":{"description":"Sortkeys for this table in Redshift. Please provide a maximum of two.","type":"array","items":{"type":"string"}}}},"Object289":{"type":"object","properties":{"id":{"description":"The ID for the import.","type":"integer"},"name":{"description":"The name of the import.","type":"string"},"source":{"description":"The source file(s). Provide either an array of Civis file_ids or a storage path hash with an array of one or more file_paths.","$ref":"#/definitions/Object290"},"destination":{"description":"The destination table.","$ref":"#/definitions/Object292"},"firstRowIsHeader":{"description":"A boolean value indicating whether or not the first row of the source file is a header row.","type":"boolean"},"columnDelimiter":{"description":"The column delimiter for the file. Valid arguments are \"comma\", \"tab\", and \"pipe\". Defaults to \"comma\".","type":"string"},"escaped":{"description":"A boolean value indicating whether or not the source file has quotes escaped with a backslash.Defaults to false.","type":"boolean"},"compression":{"description":"The type of compression of the source file. Valid arguments are \"gzip\" and \"none\". Defaults to \"none\".","type":"string"},"existingTableRows":{"description":"The behavior if a destination table with the requested name already exists. One of \"fail\", \"truncate\", \"append\", \"drop\", or \"upsert\".Defaults to \"fail\".","type":"string"},"maxErrors":{"description":"The maximum number of rows with errors to ignore before failing. This option is not supported for Postgres databases.","type":"integer"},"tableColumns":{"description":"An array of hashes corresponding to the columns in the order they appear in the source file. Each hash should have keys for database column \"name\" and \"sqlType\".This parameter is required if the table does not exist, the table is being dropped, or the columns in the source file do not appear in the same order as in the destination table.The \"sqlType\" key is not required when appending to an existing table. ","type":"array","items":{"$ref":"#/definitions/Object293"}},"loosenTypes":{"description":"If true, SQL types with precisions/lengths will have these values increased to accommodate data growth in future loads. Type loosening only occurs on table creation. Defaults to false.","type":"boolean"},"execution":{"description":"In upsert mode, controls the movement of data in upsert mode. If set to \"delayed\", the data will be moved after a brief delay. If set to \"immediate\", the data will be moved immediately. In non-upsert modes, controls the speed at which detailed column stats appear in the data catalogue. Defaults to \"delayed\", to accommodate concurrent upserts to the same table and speedier non-upsert imports.","type":"string"},"redshiftDestinationOptions":{"description":"Additional options for imports whose destination is a Redshift table.","$ref":"#/definitions/Object294"},"hidden":{"description":"The hidden status of the item.","type":"boolean"},"myPermissionLevel":{"description":"Your permission level on the object. One of \"read\", \"write\", or \"manage\".","type":"string"}}},"Object295":{"type":"object","properties":{"name":{"description":"The name of the import.","type":"string"},"source":{"description":"The source file(s). Provide either an array of Civis file_ids or a storage path hash with an array of one or more file_paths.","$ref":"#/definitions/Object284"},"destination":{"description":"The destination table.","$ref":"#/definitions/Object286"},"firstRowIsHeader":{"description":"A boolean value indicating whether or not the first row of the source file is a header row.","type":"boolean"},"columnDelimiter":{"description":"The column delimiter for the file. Valid arguments are \"comma\", \"tab\", and \"pipe\". Defaults to \"comma\".","type":"string"},"escaped":{"description":"A boolean value indicating whether or not the source file has quotes escaped with a backslash.Defaults to false.","type":"boolean"},"compression":{"description":"The type of compression of the source file. Valid arguments are \"gzip\" and \"none\". Defaults to \"none\".","type":"string"},"existingTableRows":{"description":"The behavior if a destination table with the requested name already exists. One of \"fail\", \"truncate\", \"append\", \"drop\", or \"upsert\".Defaults to \"fail\".","type":"string"},"maxErrors":{"description":"The maximum number of rows with errors to ignore before failing. This option is not supported for Postgres databases.","type":"integer"},"tableColumns":{"description":"An array of hashes corresponding to the columns in the order they appear in the source file. Each hash should have keys for database column \"name\" and \"sqlType\".This parameter is required if the table does not exist, the table is being dropped, or the columns in the source file do not appear in the same order as in the destination table.The \"sqlType\" key is not required when appending to an existing table. ","type":"array","items":{"$ref":"#/definitions/Object287"}},"loosenTypes":{"description":"If true, SQL types with precisions/lengths will have these values increased to accommodate data growth in future loads. Type loosening only occurs on table creation. Defaults to false.","type":"boolean"},"execution":{"description":"In upsert mode, controls the movement of data in upsert mode. If set to \"delayed\", the data will be moved after a brief delay. If set to \"immediate\", the data will be moved immediately. In non-upsert modes, controls the speed at which detailed column stats appear in the data catalogue. Defaults to \"delayed\", to accommodate concurrent upserts to the same table and speedier non-upsert imports.","type":"string"},"redshiftDestinationOptions":{"description":"Additional options for imports whose destination is a Redshift table.","$ref":"#/definitions/Object288"}},"required":["source","destination","firstRowIsHeader"]},"Object297":{"type":"object","properties":{"schema":{"description":"The destination schema name.","type":"string"},"table":{"description":"The destination table name.","type":"string"},"remoteHostId":{"description":"The ID of the destination database host.","type":"integer"},"credentialId":{"description":"The ID of the credentials for the destination database.","type":"integer"},"primaryKeys":{"description":"A list of column(s) which together uniquely identify a row in the destination table.These columns must not contain NULL values. If the import mode is \"upsert\", this field is required;see the Civis Helpdesk article on \"Advanced CSV Imports via the Civis API\" for more information.","type":"array","items":{"type":"string"}},"lastModifiedKeys":{"description":"A list of the columns indicating a record has been updated.If the destination table does not exist, and the import mode is \"upsert\", this field is required.","type":"array","items":{"type":"string"}}}},"Object298":{"type":"object","properties":{"name":{"description":"The column name.","type":"string"},"sqlType":{"description":"The SQL type of the column.","type":"string"}}},"Object296":{"type":"object","properties":{"name":{"description":"The name of the import.","type":"string"},"source":{"description":"The source file(s). Provide either an array of Civis file_ids or a storage path hash with an array of one or more file_paths.","$ref":"#/definitions/Object284"},"destination":{"description":"The destination table.","$ref":"#/definitions/Object297"},"firstRowIsHeader":{"description":"A boolean value indicating whether or not the first row of the source file is a header row.","type":"boolean"},"columnDelimiter":{"description":"The column delimiter for the file. Valid arguments are \"comma\", \"tab\", and \"pipe\". Defaults to \"comma\".","type":"string"},"escaped":{"description":"A boolean value indicating whether or not the source file has quotes escaped with a backslash.Defaults to false.","type":"boolean"},"compression":{"description":"The type of compression of the source file. Valid arguments are \"gzip\" and \"none\". Defaults to \"none\".","type":"string"},"existingTableRows":{"description":"The behavior if a destination table with the requested name already exists. One of \"fail\", \"truncate\", \"append\", \"drop\", or \"upsert\".Defaults to \"fail\".","type":"string"},"maxErrors":{"description":"The maximum number of rows with errors to ignore before failing. This option is not supported for Postgres databases.","type":"integer"},"tableColumns":{"description":"An array of hashes corresponding to the columns in the order they appear in the source file. Each hash should have keys for database column \"name\" and \"sqlType\".This parameter is required if the table does not exist, the table is being dropped, or the columns in the source file do not appear in the same order as in the destination table.The \"sqlType\" key is not required when appending to an existing table. ","type":"array","items":{"$ref":"#/definitions/Object298"}},"loosenTypes":{"description":"If true, SQL types with precisions/lengths will have these values increased to accommodate data growth in future loads. Type loosening only occurs on table creation. Defaults to false.","type":"boolean"},"execution":{"description":"In upsert mode, controls the movement of data in upsert mode. If set to \"delayed\", the data will be moved after a brief delay. If set to \"immediate\", the data will be moved immediately. In non-upsert modes, controls the speed at which detailed column stats appear in the data catalogue. Defaults to \"delayed\", to accommodate concurrent upserts to the same table and speedier non-upsert imports.","type":"string"},"redshiftDestinationOptions":{"description":"Additional options for imports whose destination is a Redshift table.","$ref":"#/definitions/Object288"}}},"Object299":{"type":"object","properties":{"status":{"description":"The desired archived status of the object.","type":"boolean"}},"required":["status"]},"Object300":{"type":"object","properties":{"id":{"description":"The ID of the run.","type":"integer"},"csvImportId":{"description":"The ID of the CSV Import job.","type":"integer"},"state":{"description":"The state of the run, one of 'queued' 'running' 'succeeded' 'failed' or 'cancelled'.","type":"string"},"isCancelRequested":{"description":"True if run cancel requested, else false.","type":"boolean"},"createdAt":{"description":"The time the run was created.","type":"string","format":"time"},"startedAt":{"description":"The time the run started at.","type":"string","format":"time"},"finishedAt":{"description":"The time the run completed.","type":"string","format":"time"},"error":{"description":"The error, if any, returned by the run.","type":"string"}}},"Object301":{"type":"object","properties":{"id":{"description":"The ID for the import.","type":"integer"},"schema":{"description":"The destination schema name. This schema must already exist in Redshift.","type":"string"},"table":{"description":"The destination table name, without the schema prefix. This table must already exist in Redshift.","type":"string"},"remoteHostId":{"description":"The ID of the destination database host.","type":"integer"},"state":{"description":"The state of the run; one of \"queued\", \"running\", \"succeeded\", \"failed\", or \"cancelled\".","type":"string"},"startedAt":{"description":"The time the last run started at.","type":"string","format":"time"},"finishedAt":{"description":"The time the last run completed.","type":"string","format":"time"},"error":{"description":"The error returned by the run, if any.","type":"string"}}},"Object302":{"type":"object","properties":{"id":{"description":"The ID for the import.","type":"integer"},"schema":{"description":"The destination schema name. This schema must already exist in Redshift.","type":"string"},"table":{"description":"The destination table name, without the schema prefix. This table must already exist in Redshift.","type":"string"},"remoteHostId":{"description":"The ID of the destination database host.","type":"integer"},"state":{"description":"The state of the run; one of \"queued\", \"running\", \"succeeded\", \"failed\", or \"cancelled\".","type":"string"},"startedAt":{"description":"The time the last run started at.","type":"string","format":"time"},"finishedAt":{"description":"The time the last run completed.","type":"string","format":"time"},"error":{"description":"The error returned by the run, if any.","type":"string"},"hidden":{"description":"The hidden status of the item.","type":"boolean"}}},"Object303":{"type":"object","properties":{"fileIds":{"description":"The file IDs for the import.","type":"array","items":{"type":"integer"}},"schema":{"description":"The destination schema name. This schema must already exist in Redshift.","type":"string"},"table":{"description":"The destination table name, without the schema prefix. This table must already exist in Redshift.","type":"string"},"remoteHostId":{"description":"The ID of the destination database host.","type":"integer"},"credentialId":{"description":"The ID of the credentials to be used when performing the database import.","type":"integer"},"columnDelimiter":{"description":"The column delimiter for the file. Valid arguments are \"comma\", \"tab\", and \"pipe\". If unspecified, defaults to \"comma\".","type":"string"},"firstRowIsHeader":{"description":"A boolean value indicating whether or not the first row is a header row. If unspecified, defaults to false.","type":"boolean"},"compression":{"description":"The type of compression. Valid arguments are \"gzip\", \"zip\", and \"none\". If unspecified, defaults to \"gzip\".","type":"string"},"hidden":{"description":"The hidden status of the item.","type":"boolean"}},"required":["fileIds","schema","table","remoteHostId","credentialId"]},"Object304":{"type":"object","properties":{"name":{"description":"The name of the import.","type":"string"},"syncType":{"description":"The type of sync to perform; one of Dbsync, AutoImport, GdocImport, and GdocExport.","type":"string"},"source":{"description":"The data source from which to import.","$ref":"#/definitions/Object279"},"destination":{"description":"The database into which to import.","$ref":"#/definitions/Object279"},"schedule":{"description":"The schedule when the import will run.","$ref":"#/definitions/Object102"},"notifications":{"description":"The notifications to send after the script is run.","$ref":"#/definitions/Object103"},"parentId":{"description":"Parent id to trigger this import from","type":"integer"},"isOutbound":{"type":"boolean"},"nextRunAt":{"description":"The time of the next scheduled run.","type":"string","format":"time"},"timeZone":{"description":"The time zone of this import.","type":"string"}},"required":["name","syncType","isOutbound"]},"Object305":{"type":"object","properties":{"runId":{"description":"The ID of the new run triggered.","type":"integer"}}},"Object306":{"type":"object","properties":{"id":{"description":"The ID of the run.","type":"integer"},"state":{"description":"The state of the run, one of 'queued', 'running' or 'cancelled'.","type":"string"},"isCancelRequested":{"description":"True if run cancel requested, else false.","type":"boolean"}}},"Object309":{"type":"object","properties":{"schema":{"description":"The database schema name.","type":"string"},"table":{"description":"The database table name.","type":"string"},"useWithoutSchema":{"description":"This attribute is no longer available; defaults to false but cannot be used.","type":"boolean"}},"required":["schema","table"]},"Object310":{"type":"object","properties":{}},"Object311":{"type":"object","properties":{"spreadsheet":{"description":"The spreadsheet document name.","type":"string"},"spreadsheetId":{"description":"The spreadsheet document id.","type":"string"},"worksheet":{"description":"The worksheet tab name.","type":"string"},"worksheetId":{"description":"The worksheet tab id.","type":"integer"}},"required":["spreadsheet","worksheet"]},"Object312":{"type":"object","properties":{"objectName":{"description":"This parameter is deprecated","type":"string"}},"required":["objectName"]},"Object308":{"type":"object","properties":{"path":{"description":"The path of the dataset to sync from; for a database source, schema.tablename. If you are doing a Google Sheet export, this can be blank. This is a legacy parameter, it is recommended you use one of the following: databaseTable, file, googleWorksheet","type":"string"},"databaseTable":{"description":"The sync source is a database table.","$ref":"#/definitions/Object309"},"file":{"description":"The sync source is a file.","$ref":"#/definitions/Object310"},"googleWorksheet":{"description":"The sync source is a Google worksheet.","$ref":"#/definitions/Object311"},"salesforce":{"description":"The sync source is Salesforce. Deprecated. Please use the new version instead, see https://support.civisanalytics.com/hc/en-us/articles/8774034069261-Salesforce-Import for details.","$ref":"#/definitions/Object312"}}},"Object313":{"type":"object","properties":{"path":{"description":"The schema.tablename to sync to. If you are doing a Google Sheet export, this is the spreadsheet and sheet name separated by a period. i.e. if you have a spreadsheet named \"MySpreadsheet\" and a sheet called \"Sheet1\" this field would be \"MySpreadsheet.Sheet1\". This is a legacy parameter, it is recommended you use one of the following: databaseTable, googleWorksheet","type":"string"},"databaseTable":{"description":"The sync destination is a database table.","$ref":"#/definitions/Object309"},"googleWorksheet":{"description":"The sync destination is a Google worksheet.","$ref":"#/definitions/Object311"}}},"Object315":{"type":"object","properties":{"name":{"description":"The column name that will override the auto-detected name.","type":"string"},"type":{"description":"Declaration of SQL type that will override the auto-detected SQL type, including necessary properties such as length, precision, etc.","type":"string"}}},"Object314":{"type":"object","properties":{"maxErrors":{"description":"For Google Doc and Auto Imports. The maximum number of errors that can occur without the job failing.","type":"integer"},"existingTableRows":{"description":"For Google Doc and Auto Imports. The behavior if a table with the requested name already exists. One of \"fail\", \"truncate\", \"append\", or \"drop\". Defaults to \"fail\".","type":"string"},"firstRowIsHeader":{"description":"For Google Doc and Auto Imports. A boolean value indicating whether or not the first row is a header row.","type":"boolean"},"diststyle":{"description":"For Auto Imports. The diststyle to use for a Redshift table.","type":"string"},"distkey":{"description":"For Auto Imports. The distkey to use for a Redshift table.","type":"string"},"sortkey1":{"description":"For Auto Imports. The first sortkey to use for a Redshift table.","type":"string"},"sortkey2":{"description":"For Auto Imports. The second sortkey to use for a Redshift table.","type":"string"},"columnDelimiter":{"description":"For Auto Imports. The column delimiter for the file. Valid arguments are \"comma\", \"tab\", and \"pipe\". If column_delimiter is null or omitted, it will be auto-detected.","type":"string"},"columnOverrides":{"description":"For Auto Imports. Hash used for overriding auto-detected names and types, with keys being the index of the column being overridden.","type":"object","additionalProperties":{"$ref":"#/definitions/Object315"}},"escaped":{"description":"For Auto Imports. If true, escape quotes with a backslash; otherwise, escape quotes by double-quoting. Defaults to false.","type":"boolean"},"identityColumn":{"description":"For DB Syncs. The column or columns to use as primary key for incremental syncs. Should be a unique identifier. If blank, primary key columns will be auto-detected. If more than one identity column is specified, an identity column must be specified for each table. We recommend the primary key be a sequential data type such as an integer, double, timestamp, date, or float. If using a primary key that is a string data type, we recommend having a last_modified_column to ensure all data is synced to the destination table.","type":"string"},"lastModifiedColumn":{"description":"For DB Syncs. The column to use to detect recently modified data for incremental syncs. Defaults to \"Auto-Detect\", which will use the first column it finds containing either \"modif\" or \"update\" in the name. When specified, only rows where last_modified_column in the source >= last_modified_column in the destination will be synced.","type":"string"},"rowChunkSize":{"description":"For DB Syncs. If specified, will split the sync into chunks of this size.","type":"integer"},"wipeDestinationTable":{"description":"For DB Syncs. If true, will perform a full table refresh.","type":"boolean"},"truncateLongLines":{"description":"For DB Syncs to Redshift. When true, truncates column data to fit the column specification.","type":"boolean"},"invalidCharReplacement":{"description":"For DB Syncs to Redshift. If specified, will replace each invalid UTF-8 character with this character. Must be a single ASCII character.","type":"string"},"verifyTableRowCounts":{"description":"For DB Syncs. When true, an error will be raised if the destination table does not have the same number of rows as the source table after the sync.","type":"boolean"},"partitionColumnName":{"description":"This parameter is deprecated","type":"string"},"partitionSchemaName":{"description":"This parameter is deprecated","type":"string"},"partitionTableName":{"description":"This parameter is deprecated","type":"string"},"partitionTablePartitionColumnMinName":{"description":"This parameter is deprecated","type":"string"},"partitionTablePartitionColumnMaxName":{"description":"This parameter is deprecated","type":"string"},"mysqlCatalogMatchesSchema":{"description":"This attribute is no longer available; defaults to true but cannot be used.","type":"boolean"},"chunkingMethod":{"description":"This parameter is deprecated","type":"string"},"exportAction":{"description":"For Google Doc Exports. The kind of export action you want to have the export execute. Set to \"newsprsht\" if you want a new worksheet inside a new spreadsheet. Set to \"newwksht\" if you want a new worksheet inside an existing spreadsheet. Set to \"updatewksht\" if you want to overwrite an existing worksheet inside an existing spreadsheet. Set to \"appendwksht\" if you want to append to the end of an existing worksheet inside an existing spreadsheet. Default is set to \"newsprsht\"","type":"string"},"sqlQuery":{"description":"For Google Doc Exports. The SQL query for the export.","type":"string"},"contactLists":{"description":"This parameter is deprecated","type":"string"},"soqlQuery":{"description":"This parameter is deprecated","type":"string"},"includeDeletedRecords":{"description":"This parameter is deprecated","type":"boolean"}}},"Object307":{"type":"object","properties":{"source":{"$ref":"#/definitions/Object308"},"destination":{"$ref":"#/definitions/Object313"},"advancedOptions":{"description":"Additional sync configuration parameters. For examples of sync-specific parameters, see the Examples section of the API documentation.","$ref":"#/definitions/Object314"}},"required":["source","destination"]},"Object316":{"type":"object","properties":{"source":{"description":"The sync source. Should contain only one of the following objects:","$ref":"#/definitions/Object308"},"destination":{"description":"The sync destination. Should contain only one of the following objects:","$ref":"#/definitions/Object313"},"advancedOptions":{"$ref":"#/definitions/Object314"}},"required":["source","destination"]},"Object317":{"type":"object","properties":{"status":{"description":"The desired archived status of the sync.","type":"boolean"}}},"Object318":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"type":{"type":"string"},"fromTemplateId":{"type":"integer"},"state":{"description":"Whether the job is idle, queued, running, cancelled, or failed.","type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"lastRun":{"$ref":"#/definitions/Object75"},"archived":{"description":"The archival status of the requested item(s).","type":"string"},"author":{"description":"The author/owner of the item.","$ref":"#/definitions/Object33"},"schedule":{"description":"The schedule when the job will run.","$ref":"#/definitions/Object107"}}},"Object319":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"type":{"type":"string"},"fromTemplateId":{"type":"integer"},"state":{"description":"Whether the job is idle, queued, running, cancelled, or failed.","type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"runs":{"description":"Information about the most recent runs of the job.","type":"array","items":{"$ref":"#/definitions/Object75"}},"lastRun":{"$ref":"#/definitions/Object75"},"hidden":{"description":"The hidden status of the item.","type":"boolean"},"archived":{"description":"The archival status of the requested item(s).","type":"string"},"author":{"description":"The author/owner of the item.","$ref":"#/definitions/Object33"},"myPermissionLevel":{"description":"Your permission level on the object. One of \"read\", \"write\", or \"manage\".","type":"string"},"successEmailSubject":{"type":"string"},"successEmailBody":{"type":"string"},"runningAsUser":{"type":"string"},"runByUser":{"type":"string"},"schedule":{"description":"The schedule when the job will run.","$ref":"#/definitions/Object107"}}},"Object320":{"type":"object","properties":{"triggerEmail":{"description":"Email address which may be used to trigger this job to run.","type":"string"}}},"Object321":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"type":{"type":"string"},"fromTemplateId":{"type":"integer"},"state":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"runs":{"type":"array","items":{"$ref":"#/definitions/Object75"}},"lastRun":{"$ref":"#/definitions/Object75"},"children":{"type":"array","items":{"$ref":"#/definitions/Object321"}}}},"Object324":{"type":"object","properties":{"objectType":{"description":"The type of the output. Valid values are File, Table, Report, Project, Credential, or JSONValue","type":"string"},"objectId":{"description":"The ID of the output.","type":"integer"},"name":{"description":"The name of the output.","type":"string"},"link":{"description":"The hypermedia link to the output.","type":"string"},"value":{"type":"string"}}},"Object325":{"type":"object","properties":{"id":{"description":"The ID for this workflow.","type":"integer"},"name":{"description":"The name of this workflow.","type":"string"},"description":{"description":"A description of the workflow.","type":"string"},"valid":{"description":"The validity of the workflow definition.","type":"boolean"},"fileId":{"description":"The file id for the s3 file containing the workflow configuration.","type":"string"},"user":{"description":"The author of this workflow.","$ref":"#/definitions/Object33"},"state":{"description":"The state of the workflow. State is \"running\" if any execution is running, otherwise reflects most recent execution state.","type":"string"},"schedule":{"description":"The schedule of when this workflow will be run. Must not be specified if `fromJobChain` is specified.","$ref":"#/definitions/Object107"},"allowConcurrentExecutions":{"description":"Whether the workflow can execute when already running.","type":"boolean"},"timeZone":{"description":"The time zone of this workflow.","type":"string"},"nextExecutionAt":{"description":"The time of the next scheduled execution.","type":"string","format":"time"},"archived":{"description":"The archival status of the requested item(s).","type":"string"},"createdAt":{"type":"string","format":"time"},"updatedAt":{"type":"string","format":"time"}}},"Object329":{"type":"object","properties":{"userIds":{"description":"An array of one or more user IDs.","type":"array","items":{"type":"integer"}},"permissionLevel":{"description":"Options are: \"read\", \"write\", or \"manage\".","type":"string"},"shareEmailBody":{"description":"Custom body text for e-mail sent on a share.","type":"string"},"sendSharedEmail":{"description":"Send email to the recipients of a share.","type":"boolean"}},"required":["userIds","permissionLevel"]},"Object330":{"type":"object","properties":{"groupIds":{"description":"An array of one or more group IDs.","type":"array","items":{"type":"integer"}},"permissionLevel":{"description":"Options are: \"read\", \"write\", or \"manage\".","type":"string"},"shareEmailBody":{"description":"Custom body text for e-mail sent on a share.","type":"string"},"sendSharedEmail":{"description":"Send email to the recipients of a share.","type":"boolean"}},"required":["groupIds","permissionLevel"]},"Object331":{"type":"object","properties":{"userId":{"description":"ID of target user","type":"integer"},"includeDependencies":{"description":"Whether or not to give manage permissions on all dependencies","type":"boolean"},"emailBody":{"description":"Custom body text for e-mail sent on transfer.","type":"string"},"sendEmail":{"description":"Send email to the target user of the transfer?","type":"boolean"}},"required":["userId","includeDependencies"]},"Object332":{"type":"object","properties":{"status":{"description":"The desired archived status of the object.","type":"boolean"}},"required":["status"]},"Object333":{"type":"object","properties":{"name":{"description":"The name of the JSON Value.","type":"string"},"valueStr":{"description":"The JSON value to store. Should be a serialized JSON string. Limited to 1000000 bytes.","type":"string"}},"required":["valueStr"]},"Object334":{"type":"object","properties":{"id":{"description":"The ID of the JSON Value.","type":"integer"},"name":{"description":"The name of the JSON Value.","type":"string"},"value":{"description":"The deserialized JSON value.","type":"string"}}},"Object335":{"type":"object","properties":{"name":{"description":"The name of the JSON Value.","type":"string"},"valueStr":{"description":"The JSON value to store. Should be a serialized JSON string. Limited to 1000000 bytes.","type":"string"}}},"Object336":{"type":"object","properties":{"userIds":{"description":"An array of one or more user IDs.","type":"array","items":{"type":"integer"}},"permissionLevel":{"description":"Options are: \"read\", \"write\", or \"manage\".","type":"string"},"shareEmailBody":{"description":"Custom body text for e-mail sent on a share.","type":"string"},"sendSharedEmail":{"description":"Send email to the recipients of a share.","type":"boolean"}},"required":["userIds","permissionLevel"]},"Object337":{"type":"object","properties":{"groupIds":{"description":"An array of one or more group IDs.","type":"array","items":{"type":"integer"}},"permissionLevel":{"description":"Options are: \"read\", \"write\", or \"manage\".","type":"string"},"shareEmailBody":{"description":"Custom body text for e-mail sent on a share.","type":"string"},"sendSharedEmail":{"description":"Send email to the recipients of a share.","type":"boolean"}},"required":["groupIds","permissionLevel"]},"Object338":{"type":"object","properties":{"userId":{"description":"ID of target user","type":"integer"},"includeDependencies":{"description":"Whether or not to give manage permissions on all dependencies","type":"boolean"},"emailBody":{"description":"Custom body text for e-mail sent on transfer.","type":"string"},"sendEmail":{"description":"Send email to the target user of the transfer?","type":"boolean"}},"required":["userId","includeDependencies"]},"Object342":{"type":"object","properties":{"userIds":{"description":"An array of one or more user IDs.","type":"array","items":{"type":"integer"}},"permissionLevel":{"description":"Options are: \"read\", \"write\", or \"manage\".","type":"string"},"shareEmailBody":{"description":"Custom body text for e-mail sent on a share.","type":"string"},"sendSharedEmail":{"description":"Send email to the recipients of a share.","type":"boolean"}},"required":["userIds","permissionLevel"]},"Object343":{"type":"object","properties":{"groupIds":{"description":"An array of one or more group IDs.","type":"array","items":{"type":"integer"}},"permissionLevel":{"description":"Options are: \"read\", \"write\", or \"manage\".","type":"string"},"shareEmailBody":{"description":"Custom body text for e-mail sent on a share.","type":"string"},"sendSharedEmail":{"description":"Send email to the recipients of a share.","type":"boolean"}},"required":["groupIds","permissionLevel"]},"Object344":{"type":"object","properties":{"status":{"description":"The desired archived status of the object.","type":"boolean"}},"required":["status"]},"Object345":{"type":"object","properties":{"id":{"description":"The ID of the match target","type":"integer"},"name":{"description":"The name of the match target","type":"string"},"targetFileName":{"description":"The name of the target file","type":"string"},"createdAt":{"type":"string","format":"time"},"updatedAt":{"type":"string","format":"time"},"archived":{"description":"Whether the match target has been archived.","type":"boolean"}}},"Object346":{"type":"object","properties":{"name":{"description":"The name of the match target","type":"string"},"targetFileName":{"description":"The name of the target file","type":"string"},"archived":{"description":"Whether the match target has been archived.","type":"boolean"}},"required":["name"]},"Object347":{"type":"object","properties":{"name":{"description":"The name of the match target","type":"string"},"targetFileName":{"description":"The name of the target file","type":"string"},"archived":{"description":"Whether the match target has been archived.","type":"boolean"}}},"Object348":{"type":"object","properties":{"userIds":{"description":"An array of one or more user IDs.","type":"array","items":{"type":"integer"}},"permissionLevel":{"description":"Options are: \"read\", \"write\", or \"manage\".","type":"string"},"shareEmailBody":{"description":"Custom body text for e-mail sent on a share.","type":"string"},"sendSharedEmail":{"description":"Send email to the recipients of a share.","type":"boolean"}},"required":["userIds","permissionLevel"]},"Object349":{"type":"object","properties":{"groupIds":{"description":"An array of one or more group IDs.","type":"array","items":{"type":"integer"}},"permissionLevel":{"description":"Options are: \"read\", \"write\", or \"manage\".","type":"string"},"shareEmailBody":{"description":"Custom body text for e-mail sent on a share.","type":"string"},"sendSharedEmail":{"description":"Send email to the recipients of a share.","type":"boolean"}},"required":["groupIds","permissionLevel"]},"Object350":{"type":"object","properties":{"status":{"description":"The desired archived status of the object.","type":"boolean"}},"required":["status"]},"Object351":{"type":"object","properties":{"id":{"description":"The ID for the spot order.","type":"integer"},"archived":{"description":"The archival status of the requested item(s).","type":"string"},"csvS3Uri":{"description":"S3 URI for the spot order CSV file.","type":"string"},"jsonS3Uri":{"description":"S3 URI for the spot order JSON file.","type":"string"},"xmlArchiveS3Uri":{"description":"S3 URI for the spot order XML archive.","type":"string"},"lastTransformJobId":{"description":"ID of the spot order transformation job.","type":"integer"}}},"Object352":{"type":"object","properties":{"userIds":{"description":"An array of one or more user IDs.","type":"array","items":{"type":"integer"}},"permissionLevel":{"description":"Options are: \"read\", \"write\", or \"manage\".","type":"string"},"shareEmailBody":{"description":"Custom body text for e-mail sent on a share.","type":"string"},"sendSharedEmail":{"description":"Send email to the recipients of a share.","type":"boolean"}},"required":["userIds","permissionLevel"]},"Object353":{"type":"object","properties":{"groupIds":{"description":"An array of one or more group IDs.","type":"array","items":{"type":"integer"}},"permissionLevel":{"description":"Options are: \"read\", \"write\", or \"manage\".","type":"string"},"shareEmailBody":{"description":"Custom body text for e-mail sent on a share.","type":"string"},"sendSharedEmail":{"description":"Send email to the recipients of a share.","type":"boolean"}},"required":["groupIds","permissionLevel"]},"Object354":{"type":"object","properties":{"status":{"description":"The desired archived status of the object.","type":"boolean"}},"required":["status"]},"Object357":{"type":"object","properties":{"targets":{"description":"The targets to constrain.","type":"array","items":{"type":"string"}},"budget":{"description":"The maximum budget for these targets.","type":"number","format":"float"},"frequency":{"description":"The maximum frequency for these targets.","type":"number","format":"float"}}},"Object356":{"type":"object","properties":{"marketId":{"description":"The market ID.","type":"integer"},"startDate":{"description":"The start date for the media run.","type":"string","format":"date"},"endDate":{"description":"The end date for the media run.","type":"string","format":"date"},"forceCpm":{"description":"Whether to force optimization to use CPM data even if partition data is available.","type":"boolean"},"reachAlpha":{"description":"A tuning parameter used to adjust RF.","type":"number","format":"float"},"syscodes":{"description":"The syscodes for the media run.","type":"array","items":{"type":"integer"}},"rateCards":{"description":"The ratecards for the media run.","type":"array","items":{"type":"string"}},"constraints":{"description":"The constraints for the media run.","type":"array","items":{"$ref":"#/definitions/Object357"}}}},"Object355":{"type":"object","properties":{"id":{"description":"The optimization ID.","type":"integer"},"author":{"description":"The author/owner of the item.","$ref":"#/definitions/Object33"},"name":{"description":"The name of the optimization.","type":"string"},"createdAt":{"type":"string","format":"time"},"updatedAt":{"type":"string","format":"time"},"finishedAt":{"description":"The end time of the last run.","type":"string","format":"date-time"},"state":{"description":"The state of the last run.","type":"string"},"lastRunId":{"description":"The ID of the last run.","type":"integer"},"spotOrderId":{"description":"The ID for the spot order produced by the optimization.","type":"integer"},"archived":{"description":"The archival status of the requested item(s).","type":"string"},"reportLink":{"description":"A link to the visual report for the optimization.","type":"string"},"spotOrderLink":{"description":"A link to the json version of the spot order.","type":"string"},"fileLinks":{"description":"Links to the csv and xml versions of the spot order.","type":"array","items":{"type":"string"}},"runs":{"description":"The runs of the optimization.","type":"array","items":{"$ref":"#/definitions/Object356"}},"programs":{"description":"An array of programs that the Civis Media Optimizer either exclude or limit to.An error will be thrown if exclude_programs is not also set.","type":"array","items":{"type":"string"}},"networks":{"description":"An array of networks that the Civis Media Optimizer either exclude or limit to.An error will be thrown if exclude_networks is not also set.","type":"array","items":{"type":"string"}},"excludePrograms":{"description":"If Civis Media Optimizer should exclude the programs in the programs parameter.If this value is set to false, it will make the optimization limit itself to the programs supplied through the programs parameter.An error will be thrown if programs is not also set.","type":"boolean"},"excludeNetworks":{"description":"If Civis Media Optimizer should exclude the networks in the networks parameter.If this value is set to false, it will make the optimization limit itself to the networks supplied through the networks.An error will be thrown if networks is not also set.","type":"boolean"},"timeSlotPercentages":{"description":"The maximum amount of the budget spent on that particular day of the week, daypart, or specific time slot for broadcast and cable.","type":"object"}}},"Object358":{"type":"object","properties":{"userIds":{"description":"An array of one or more user IDs.","type":"array","items":{"type":"integer"}},"permissionLevel":{"description":"Options are: \"read\", \"write\", or \"manage\".","type":"string"},"shareEmailBody":{"description":"Custom body text for e-mail sent on a share.","type":"string"},"sendSharedEmail":{"description":"Send email to the recipients of a share.","type":"boolean"}},"required":["userIds","permissionLevel"]},"Object359":{"type":"object","properties":{"groupIds":{"description":"An array of one or more group IDs.","type":"array","items":{"type":"integer"}},"permissionLevel":{"description":"Options are: \"read\", \"write\", or \"manage\".","type":"string"},"shareEmailBody":{"description":"Custom body text for e-mail sent on a share.","type":"string"},"sendSharedEmail":{"description":"Send email to the recipients of a share.","type":"boolean"}},"required":["groupIds","permissionLevel"]},"Object360":{"type":"object","properties":{"status":{"description":"The desired archived status of the object.","type":"boolean"}},"required":["status"]},"Object361":{"type":"object","properties":{"id":{"description":"The ratecard ID.","type":"integer"},"filename":{"description":"Name of the ratecard file.","type":"string"},"startOn":{"description":"First day to which the ratecard applies.","type":"string","format":"date"},"endOn":{"description":"Last day to which the ratecard applies.","type":"string","format":"date"},"dmaNumber":{"description":"Number of the DMA associated with the ratecard.","type":"integer"},"archived":{"description":"The archival status of the requested item(s).","type":"string"}}},"Object362":{"type":"object","properties":{"id":{"description":"The optimization ID.","type":"integer"},"author":{"description":"The author/owner of the item.","$ref":"#/definitions/Object33"},"name":{"description":"The name of the optimization.","type":"string"},"createdAt":{"type":"string","format":"time"},"updatedAt":{"type":"string","format":"time"},"finishedAt":{"description":"The end time of the last run.","type":"string","format":"date-time"},"state":{"description":"The state of the last run.","type":"string"},"lastRunId":{"description":"The ID of the last run.","type":"integer"},"spotOrderId":{"description":"The ID for the spot order produced by the optimization.","type":"integer"},"archived":{"description":"The archival status of the requested item(s).","type":"string"}}},"Object365":{"type":"object","properties":{"targets":{"description":"The targets to constrain.","type":"array","items":{"type":"string"}},"budget":{"description":"The maximum budget for these targets.","type":"number","format":"float"},"frequency":{"description":"The maximum frequency for these targets.","type":"number","format":"float"}},"required":["targets"]},"Object364":{"type":"object","properties":{"marketId":{"description":"The market ID.","type":"integer"},"startDate":{"description":"The start date for the media run.","type":"string","format":"date"},"endDate":{"description":"The end date for the media run.","type":"string","format":"date"},"forceCpm":{"description":"Whether to force optimization to use CPM data even if partition data is available.","type":"boolean"},"reachAlpha":{"description":"A tuning parameter used to adjust RF.","type":"number","format":"float"},"syscodes":{"description":"The syscodes for the media run.","type":"array","items":{"type":"integer"}},"rateCards":{"description":"The ratecards for the media run.","type":"array","items":{"type":"string"}},"constraints":{"description":"The constraints for the media run.","type":"array","items":{"$ref":"#/definitions/Object365"}}},"required":["marketId","startDate","endDate","syscodes","rateCards","constraints"]},"Object363":{"type":"object","properties":{"name":{"description":"The name of the optimization.","type":"string"},"runs":{"description":"The runs of the optimization.","type":"array","items":{"$ref":"#/definitions/Object364"}},"programs":{"description":"An array of programs that the Civis Media Optimizer either exclude or limit to.An error will be thrown if exclude_programs is not also set.","type":"array","items":{"type":"string"}},"networks":{"description":"An array of networks that the Civis Media Optimizer either exclude or limit to.An error will be thrown if exclude_networks is not also set.","type":"array","items":{"type":"string"}},"excludePrograms":{"description":"If Civis Media Optimizer should exclude the programs in the programs parameter.If this value is set to false, it will make the optimization limit itself to the programs supplied through the programs parameter.An error will be thrown if programs is not also set.","type":"boolean"},"excludeNetworks":{"description":"If Civis Media Optimizer should exclude the networks in the networks parameter.If this value is set to false, it will make the optimization limit itself to the networks supplied through the networks.An error will be thrown if networks is not also set.","type":"boolean"},"timeSlotPercentages":{"description":"The maximum amount of the budget spent on that particular day of the week, daypart, or specific time slot for broadcast and cable.","type":"object"}},"required":["runs"]},"Object366":{"type":"object","properties":{"id":{"description":"The ID of the run.","type":"integer"},"optimizationId":{"description":"The ID of the Optimization job.","type":"integer"},"state":{"description":"The state of the run, one of 'queued' 'running' 'succeeded' 'failed' or 'cancelled'.","type":"string"},"isCancelRequested":{"description":"True if run cancel requested, else false.","type":"boolean"},"createdAt":{"description":"The time the run was created.","type":"string","format":"time"},"startedAt":{"description":"The time the run started at.","type":"string","format":"time"},"finishedAt":{"description":"The time the run completed.","type":"string","format":"time"},"error":{"description":"The error, if any, returned by the run.","type":"string"}}},"Object369":{"type":"object","properties":{"targets":{"description":"The targets to constrain.","type":"array","items":{"type":"string"}},"budget":{"description":"The maximum budget for these targets.","type":"number","format":"float"},"frequency":{"description":"The maximum frequency for these targets.","type":"number","format":"float"}}},"Object368":{"type":"object","properties":{"marketId":{"description":"The market ID.","type":"integer"},"startDate":{"description":"The start date for the media run.","type":"string","format":"date"},"endDate":{"description":"The end date for the media run.","type":"string","format":"date"},"forceCpm":{"description":"Whether to force optimization to use CPM data even if partition data is available.","type":"boolean"},"reachAlpha":{"description":"A tuning parameter used to adjust RF.","type":"number","format":"float"},"syscodes":{"description":"The syscodes for the media run.","type":"array","items":{"type":"integer"}},"rateCards":{"description":"The ratecards for the media run.","type":"array","items":{"type":"string"}},"constraints":{"description":"The constraints for the media run.","type":"array","items":{"$ref":"#/definitions/Object369"}}}},"Object367":{"type":"object","properties":{"name":{"description":"The name of the optimization.","type":"string"},"runs":{"description":"The runs of the optimization.","type":"array","items":{"$ref":"#/definitions/Object368"}},"programs":{"description":"An array of programs that the Civis Media Optimizer either exclude or limit to.An error will be thrown if exclude_programs is not also set.","type":"array","items":{"type":"string"}},"networks":{"description":"An array of networks that the Civis Media Optimizer either exclude or limit to.An error will be thrown if exclude_networks is not also set.","type":"array","items":{"type":"string"}},"excludePrograms":{"description":"If Civis Media Optimizer should exclude the programs in the programs parameter.If this value is set to false, it will make the optimization limit itself to the programs supplied through the programs parameter.An error will be thrown if programs is not also set.","type":"boolean"},"excludeNetworks":{"description":"If Civis Media Optimizer should exclude the networks in the networks parameter.If this value is set to false, it will make the optimization limit itself to the networks supplied through the networks.An error will be thrown if networks is not also set.","type":"boolean"},"timeSlotPercentages":{"description":"The maximum amount of the budget spent on that particular day of the week, daypart, or specific time slot for broadcast and cable.","type":"object"}}},"Object370":{"type":"object","properties":{"id":{"description":"The ID for the spot order.","type":"integer"},"archived":{"description":"The archival status of the requested item(s).","type":"string"}}},"Object371":{"type":"object","properties":{"body":{"description":"CSV body of a spot order.","type":"string"}}},"Object372":{"type":"object","properties":{"body":{"description":"CSV body of a spot order.","type":"string"}}},"Object373":{"type":"object","properties":{"filename":{"description":"Name of the ratecard file.","type":"string"},"startOn":{"description":"First day to which the ratecard applies.","type":"string","format":"date"},"endOn":{"description":"Last day to which the ratecard applies.","type":"string","format":"date"},"dmaNumber":{"description":"Number of the DMA associated with the ratecard.","type":"integer"}},"required":["filename","startOn","endOn","dmaNumber"]},"Object374":{"type":"object","properties":{"filename":{"description":"Name of the ratecard file.","type":"string"},"startOn":{"description":"First day to which the ratecard applies.","type":"string","format":"date"},"endOn":{"description":"Last day to which the ratecard applies.","type":"string","format":"date"},"dmaNumber":{"description":"Number of the DMA associated with the ratecard.","type":"integer"}},"required":["filename","startOn","endOn","dmaNumber"]},"Object375":{"type":"object","properties":{"filename":{"description":"Name of the ratecard file.","type":"string"},"startOn":{"description":"First day to which the ratecard applies.","type":"string","format":"date"},"endOn":{"description":"Last day to which the ratecard applies.","type":"string","format":"date"},"dmaNumber":{"description":"Number of the DMA associated with the ratecard.","type":"integer"}}},"Object376":{"type":"object","properties":{"name":{"description":"Name for the DMA region.","type":"string"},"number":{"description":"Identifier number for a DMA.","type":"integer"}}},"Object377":{"type":"object","properties":{"name":{"description":"The name of the target.","type":"string"},"identifier":{"description":"A unique identifier for this target.","type":"string"},"dataSource":{"description":"The source of viewership data for this target.","type":"string"}}},"Object378":{"type":"object","properties":{"id":{"description":"The ID of the model type.","type":"integer"},"algorithm":{"description":"The name of the algorithm used to train the model.","type":"string"},"dvType":{"description":"The type of dependent variable predicted by the model.","type":"string"},"fintAllowed":{"description":"Whether this model type supports searching for interaction terms.","type":"boolean"}}},"Object380":{"type":"object","properties":{"id":{"description":"The ID of the model build.","type":"integer"},"name":{"description":"The name of the model build.","type":"string"},"createdAt":{"description":"The time the model build was created.","type":"string"},"description":{"description":"A description of the model build.","type":"string"},"rootMeanSquaredError":{"description":"A key metric for continuous models. Nil for other model types.","type":"number","format":"float"},"rSquaredError":{"description":"A key metric for continuous models. Nil for other model types.","type":"number","format":"float"},"rocAuc":{"description":"A key metric for binary, multinomial, and ordinal models. Nil for other model types.","type":"number","format":"float"}}},"Object381":{"type":"object","properties":{"id":{"description":"The ID of the model to which to apply the prediction.","type":"integer"},"tableName":{"description":"The qualified name of the table on which to apply the predictive model.","type":"string"},"primaryKey":{"description":"The primary key or composite keys of the table being predicted.","type":"array","items":{"type":"string"}},"limitingSQL":{"description":"A SQL WHERE clause used to scope the rows to be predicted.","type":"string"},"outputTable":{"description":"The qualified name of the table to be created which will contain the model's predictions.","type":"string"},"state":{"description":"The status of the prediction. One of: \"succeeded\", \"failed\", \"queued\", or \"running,\"or \"idle\", if no build has been attempted.","type":"string"}}},"Object379":{"type":"object","properties":{"id":{"description":"The ID of the model.","type":"integer"},"tableName":{"description":"The qualified name of the table containing the training set from which to build the model.","type":"string"},"databaseId":{"description":"The ID of the database holding the training set table used to build the model.","type":"integer"},"credentialId":{"description":"The ID of the credential used to read the target table. Defaults to the user's default credential.","type":"integer"},"modelName":{"description":"The name of the model.","type":"string"},"description":{"description":"A description of the model.","type":"string"},"interactionTerms":{"description":"Whether to search for interaction terms.","type":"boolean"},"boxCoxTransformation":{"description":"Whether to transform data so that it assumes a normal distribution. Valid only with continuous models.","type":"boolean"},"modelTypeId":{"description":"The ID of the model's type.","type":"integer"},"primaryKey":{"description":"The unique ID (primary key) of the training dataset.","type":"string"},"dependentVariable":{"description":"The dependent variable of the training dataset.","type":"string"},"dependentVariableOrder":{"description":"The order of dependent variables, especially useful for Ordinal Modeling.","type":"array","items":{"type":"string"}},"excludedColumns":{"description":"A list of columns which will be considered ineligible to be independent variables.","type":"array","items":{"type":"string"}},"limitingSQL":{"description":"A custom SQL WHERE clause used to filter the rows used to build the model. (e.g., \"id > 105\").","type":"string"},"crossValidationParameters":{"description":"Cross validation parameter grid for tree methods, e.g. {\"n_estimators\": [100, 200, 500], \"learning_rate\": [0.01, 0.1], \"max_depth\": [2, 3]}.","type":"object"},"numberOfFolds":{"description":"Number of folds for cross validation. Default value is 5.","type":"integer"},"schedule":{"description":"The schedule when the model will be built.","$ref":"#/definitions/Object107"},"parentId":{"description":"The ID of the parent job that will trigger this model.","type":"integer"},"timeZone":{"description":"The time zone of this model.","type":"string"},"lastRun":{"description":"The last run of this model build.","$ref":"#/definitions/Object75"},"user":{"$ref":"#/definitions/Object33"},"createdAt":{"description":"The time the model was created.","type":"string","format":"date-time"},"updatedAt":{"description":"The time the model was updated.","type":"string","format":"date-time"},"currentBuildState":{"description":"The status of the current model build. One of \"succeeded\", \"failed\", \"queued\", or \"running,\"or \"idle\", if no build has been attempted.","type":"string"},"currentBuildException":{"description":"Exception message, if applicable, of the current model build.","type":"string"},"builds":{"description":"A list of trained models available for making predictions.","type":"array","items":{"$ref":"#/definitions/Object380"}},"predictions":{"description":"The tables upon which the model will be applied.","type":"array","items":{"$ref":"#/definitions/Object381"}},"lastOutputLocation":{"description":"The output JSON for the last build.","type":"string"},"archived":{"description":"The archival status of the requested item(s).","type":"string"}}},"Object383":{"type":"object","properties":{"id":{"description":"The ID of the model to which to apply the prediction.","type":"integer"},"tableName":{"description":"The qualified name of the table on which to apply the predictive model.","type":"string"},"primaryKey":{"description":"The primary key or composite keys of the table being predicted.","type":"array","items":{"type":"string"}},"limitingSQL":{"description":"A SQL WHERE clause used to scope the rows to be predicted.","type":"string"},"outputTable":{"description":"The qualified name of the table to be created which will contain the model's predictions.","type":"string"},"schedule":{"description":"The schedule of when the prediction will run.","$ref":"#/definitions/Object107"},"state":{"description":"The status of the prediction. One of: \"succeeded\", \"failed\", \"queued\", or \"running,\"or \"idle\", if no build has been attempted.","type":"string"}}},"Object382":{"type":"object","properties":{"id":{"description":"The ID of the model.","type":"integer"},"tableName":{"description":"The qualified name of the table containing the training set from which to build the model.","type":"string"},"databaseId":{"description":"The ID of the database holding the training set table used to build the model.","type":"integer"},"credentialId":{"description":"The ID of the credential used to read the target table. Defaults to the user's default credential.","type":"integer"},"modelName":{"description":"The name of the model.","type":"string"},"description":{"description":"A description of the model.","type":"string"},"interactionTerms":{"description":"Whether to search for interaction terms.","type":"boolean"},"boxCoxTransformation":{"description":"Whether to transform data so that it assumes a normal distribution. Valid only with continuous models.","type":"boolean"},"modelTypeId":{"description":"The ID of the model's type.","type":"integer"},"primaryKey":{"description":"The unique ID (primary key) of the training dataset.","type":"string"},"dependentVariable":{"description":"The dependent variable of the training dataset.","type":"string"},"dependentVariableOrder":{"description":"The order of dependent variables, especially useful for Ordinal Modeling.","type":"array","items":{"type":"string"}},"excludedColumns":{"description":"A list of columns which will be considered ineligible to be independent variables.","type":"array","items":{"type":"string"}},"limitingSQL":{"description":"A custom SQL WHERE clause used to filter the rows used to build the model. (e.g., \"id > 105\").","type":"string"},"activeBuildId":{"description":"The ID of the current active build, the build used to score predictions.","type":"integer"},"crossValidationParameters":{"description":"Cross validation parameter grid for tree methods, e.g. {\"n_estimators\": [100, 200, 500], \"learning_rate\": [0.01, 0.1], \"max_depth\": [2, 3]}.","type":"object"},"numberOfFolds":{"description":"Number of folds for cross validation. Default value is 5.","type":"integer"},"notifications":{"description":"The notifications to send after the script is run.","$ref":"#/definitions/Object108"},"schedule":{"description":"The schedule when the model will be built.","$ref":"#/definitions/Object107"},"parentId":{"description":"The ID of the parent job that will trigger this model.","type":"integer"},"runningAs":{"description":"The user this job will run as, defaults to the author of the job.","$ref":"#/definitions/Object33"},"timeZone":{"description":"The time zone of this model.","type":"string"},"lastRun":{"description":"The last run of this model build.","$ref":"#/definitions/Object75"},"hidden":{"description":"The hidden status of the item.","type":"boolean"},"user":{"$ref":"#/definitions/Object33"},"createdAt":{"description":"The time the model was created.","type":"string","format":"date-time"},"updatedAt":{"description":"The time the model was updated.","type":"string","format":"date-time"},"currentBuildState":{"description":"The status of the current model build. One of \"succeeded\", \"failed\", \"queued\", or \"running,\"or \"idle\", if no build has been attempted.","type":"string"},"currentBuildException":{"description":"Exception message, if applicable, of the current model build.","type":"string"},"builds":{"description":"A list of trained models available for making predictions.","type":"array","items":{"$ref":"#/definitions/Object380"}},"predictions":{"description":"The tables upon which the model will be applied.","type":"array","items":{"$ref":"#/definitions/Object383"}},"lastOutputLocation":{"description":"The output JSON for the last build.","type":"string"},"archived":{"description":"The archival status of the requested item(s).","type":"string"}}},"Object384":{"type":"object","properties":{"id":{"description":"The ID of the model build.","type":"integer"},"state":{"description":"The state of the model build.one of 'queued' 'running' 'succeeded' 'failed' or 'cancelled'.","type":"string"},"error":{"description":"The error, if any, returned by the build.","type":"string"},"name":{"description":"The name of the model build.","type":"string"},"createdAt":{"description":"The time the model build was created.","type":"string"},"description":{"description":"A description of the model build.","type":"string"},"rootMeanSquaredError":{"description":"A key metric for continuous models. Nil for other model types.","type":"number","format":"float"},"rSquaredError":{"description":"A key metric for continuous models. Nil for other model types.","type":"number","format":"float"},"rocAuc":{"description":"A key metric for binary, multinomial, and ordinal models. Nil for other model types.","type":"number","format":"float"},"transformationMetadata":{"description":"A string representing the full JSON output of the metadata for transformation of column names","type":"string"},"output":{"description":"A string representing the JSON output for the specified build. Only present when smaller than 10KB in size.","type":"string"},"outputLocation":{"description":"A URL representing the location of the full JSON output for the specified build.The URL link will be valid for 5 minutes.","type":"string"}}},"Object385":{"type":"object","properties":{"userIds":{"description":"An array of one or more user IDs.","type":"array","items":{"type":"integer"}},"permissionLevel":{"description":"Options are: \"read\", \"write\", or \"manage\".","type":"string"},"shareEmailBody":{"description":"Custom body text for e-mail sent on a share.","type":"string"},"sendSharedEmail":{"description":"Send email to the recipients of a share.","type":"boolean"}},"required":["userIds","permissionLevel"]},"Object386":{"type":"object","properties":{"groupIds":{"description":"An array of one or more group IDs.","type":"array","items":{"type":"integer"}},"permissionLevel":{"description":"Options are: \"read\", \"write\", or \"manage\".","type":"string"},"shareEmailBody":{"description":"Custom body text for e-mail sent on a share.","type":"string"},"sendSharedEmail":{"description":"Send email to the recipients of a share.","type":"boolean"}},"required":["groupIds","permissionLevel"]},"Object387":{"type":"object","properties":{"userId":{"description":"ID of target user","type":"integer"},"includeDependencies":{"description":"Whether or not to give manage permissions on all dependencies","type":"boolean"},"emailBody":{"description":"Custom body text for e-mail sent on transfer.","type":"string"},"sendEmail":{"description":"Send email to the target user of the transfer?","type":"boolean"}},"required":["userId","includeDependencies"]},"Object388":{"type":"object","properties":{"status":{"description":"The desired archived status of the object.","type":"boolean"}},"required":["status"]},"Object389":{"type":"object","properties":{"id":{"description":"The ID of the model associated with this schedule.","type":"integer"},"schedule":{"description":"The schedule of when the model will run.","$ref":"#/definitions/Object107"}}},"Object391":{"type":"object","properties":{"deploymentId":{"description":"The ID for this deployment.","type":"integer"},"userId":{"description":"The ID of the owner.","type":"integer"},"host":{"description":"Domain of the deployment.","type":"string"},"name":{"description":"Name of the deployment.","type":"string"},"dockerImageName":{"description":"The name of the docker image to pull from DockerHub.","type":"string"},"dockerImageTag":{"description":"The tag of the docker image to pull from DockerHub (default: latest).","type":"string"},"instanceType":{"description":"The EC2 instance type requested for the deployment.","type":"string"},"memory":{"description":"The memory allocated to the deployment, in MB.","type":"integer"},"cpu":{"description":"The cpu allocated to the deployment, in millicores.","type":"integer"},"state":{"description":"The state of the deployment.","type":"string"},"stateMessage":{"description":"A detailed description of the state.","type":"string"},"maxMemoryUsage":{"description":"If the deployment has finished, the maximum amount of memory used during the deployment, in MB.","type":"number","format":"float"},"maxCpuUsage":{"description":"If the deployment has finished, the maximum amount of cpu used during the deployment, in millicores.","type":"number","format":"float"},"createdAt":{"type":"string","format":"time"},"updatedAt":{"type":"string","format":"time"},"notebookId":{"description":"The ID of the owning Notebook","type":"integer"}}},"Object390":{"type":"object","properties":{"id":{"description":"The ID for this notebook.","type":"integer"},"name":{"description":"The name of this notebook.","type":"string"},"language":{"description":"The kernel language of this notebook (\"python3\" or \"r\"). Defaults to \"python3\".","type":"string"},"description":{"description":"The description of this notebook.","type":"string"},"user":{"description":"The author of this notebook.","$ref":"#/definitions/Object33"},"createdAt":{"type":"string","format":"time"},"updatedAt":{"type":"string","format":"time"},"mostRecentDeployment":{"$ref":"#/definitions/Object391"},"archived":{"description":"The archival status of the requested item(s).","type":"string"}}},"Object392":{"type":"object","properties":{"name":{"description":"The name of this notebook.","type":"string"},"language":{"description":"The kernel language of this notebook (\"python3\" or \"r\"). Defaults to \"python3\".","type":"string"},"description":{"description":"The description of this notebook.","type":"string"},"fileId":{"description":"The file ID for the S3 file containing the .ipynb file.","type":"string"},"requirementsFileId":{"description":"The file ID for the S3 file containing the requirements.txt file.","type":"string"},"requirements":{"description":"The requirements txt file.","type":"string"},"dockerImageName":{"description":"The name of the docker image to pull from DockerHub.","type":"string"},"dockerImageTag":{"description":"The tag of the docker image to pull from DockerHub (default: latest).","type":"string"},"instanceType":{"description":"The EC2 instance type to deploy to.","type":"string"},"memory":{"description":"The amount of memory allocated to the notebook.","type":"integer"},"cpu":{"description":"The amount of cpu allocated to the the notebook.","type":"integer"},"credentials":{"description":"A list of credential IDs to pass to the notebook.","type":"array","items":{"type":"integer"}},"environmentVariables":{"description":"Environment variables to be passed into the Notebook.","type":"object","additionalProperties":{"type":"string"}},"idleTimeout":{"description":"How long the notebook will stay alive without any kernel activity.","type":"integer"},"partitionLabel":{"description":"The partition label used to run this object.","type":"string"},"gitRepoUrl":{"description":"The URL of the git repository (e.g., https://github.com/organization/repo_name.git).","type":"string"},"gitRef":{"description":"The git reference if git repo is specified","type":"string"},"gitPath":{"description":"The path to the .ipynb file in the git repo that will be started up on notebook launch","type":"string"},"hidden":{"description":"The hidden status of the item.","type":"boolean"}}},"Object394":{"type":"object","properties":{"deploymentId":{"description":"The ID for this deployment.","type":"integer"},"userId":{"description":"The ID of the owner.","type":"integer"},"host":{"description":"Domain of the deployment.","type":"string"},"name":{"description":"Name of the deployment.","type":"string"},"dockerImageName":{"description":"The name of the docker image to pull from DockerHub.","type":"string"},"dockerImageTag":{"description":"The tag of the docker image to pull from DockerHub (default: latest).","type":"string"},"displayUrl":{"description":"A signed URL for viewing the deployed item.","type":"string"},"instanceType":{"description":"The EC2 instance type requested for the deployment.","type":"string"},"memory":{"description":"The memory allocated to the deployment, in MB.","type":"integer"},"cpu":{"description":"The cpu allocated to the deployment, in millicores.","type":"integer"},"state":{"description":"The state of the deployment.","type":"string"},"stateMessage":{"description":"A detailed description of the state.","type":"string"},"maxMemoryUsage":{"description":"If the deployment has finished, the maximum amount of memory used during the deployment, in MB.","type":"number","format":"float"},"maxCpuUsage":{"description":"If the deployment has finished, the maximum amount of cpu used during the deployment, in millicores.","type":"number","format":"float"},"createdAt":{"type":"string","format":"time"},"updatedAt":{"type":"string","format":"time"},"notebookId":{"description":"The ID of the owning Notebook","type":"integer"}}},"Object393":{"type":"object","properties":{"id":{"description":"The ID for this notebook.","type":"integer"},"name":{"description":"The name of this notebook.","type":"string"},"language":{"description":"The kernel language of this notebook (\"python3\" or \"r\"). Defaults to \"python3\".","type":"string"},"description":{"description":"The description of this notebook.","type":"string"},"notebookUrl":{"description":"Time-limited URL to get the .ipynb file for this notebook.","type":"string"},"notebookPreviewUrl":{"description":"Time-limited URL to get the .htm preview file for this notebook.","type":"string"},"requirementsUrl":{"description":"Time-limited URL to get the requirements.txt file for this notebook.","type":"string"},"fileId":{"description":"The file ID for the S3 file containing the .ipynb file.","type":"string"},"requirementsFileId":{"description":"The file ID for the S3 file containing the requirements.txt file.","type":"string"},"user":{"description":"The author of this notebook.","$ref":"#/definitions/Object33"},"dockerImageName":{"description":"The name of the docker image to pull from DockerHub.","type":"string"},"dockerImageTag":{"description":"The tag of the docker image to pull from DockerHub (default: latest).","type":"string"},"instanceType":{"description":"The EC2 instance type to deploy to.","type":"string"},"memory":{"description":"The amount of memory allocated to the notebook.","type":"integer"},"cpu":{"description":"The amount of cpu allocated to the the notebook.","type":"integer"},"createdAt":{"type":"string","format":"time"},"updatedAt":{"type":"string","format":"time"},"mostRecentDeployment":{"$ref":"#/definitions/Object394"},"credentials":{"description":"A list of credential IDs to pass to the notebook.","type":"array","items":{"type":"integer"}},"environmentVariables":{"description":"Environment variables to be passed into the Notebook.","type":"object","additionalProperties":{"type":"string"}},"idleTimeout":{"description":"How long the notebook will stay alive without any kernel activity.","type":"integer"},"partitionLabel":{"description":"The partition label used to run this object.","type":"string"},"gitRepoId":{"description":"The ID of the git repository.","type":"integer"},"gitRepoUrl":{"description":"The URL of the git repository (e.g., https://github.com/organization/repo_name.git).","type":"string"},"gitRef":{"description":"The git reference if git repo is specified","type":"string"},"gitPath":{"description":"The path to the .ipynb file in the git repo that will be started up on notebook launch","type":"string"},"myPermissionLevel":{"description":"Your permission level on the object. One of \"read\", \"write\", or \"manage\".","type":"string"},"archived":{"description":"The archival status of the requested item(s).","type":"string"},"hidden":{"description":"The hidden status of the item.","type":"boolean"}}},"Object395":{"type":"object","properties":{"name":{"description":"The name of this notebook.","type":"string"},"language":{"description":"The kernel language of this notebook (\"python3\" or \"r\"). Defaults to \"python3\".","type":"string"},"description":{"description":"The description of this notebook.","type":"string"},"fileId":{"description":"The file ID for the S3 file containing the .ipynb file.","type":"string"},"requirementsFileId":{"description":"The file ID for the S3 file containing the requirements.txt file.","type":"string"},"requirements":{"description":"The requirements txt file.","type":"string"},"dockerImageName":{"description":"The name of the docker image to pull from DockerHub.","type":"string"},"dockerImageTag":{"description":"The tag of the docker image to pull from DockerHub (default: latest).","type":"string"},"instanceType":{"description":"The EC2 instance type to deploy to.","type":"string"},"memory":{"description":"The amount of memory allocated to the notebook.","type":"integer"},"cpu":{"description":"The amount of cpu allocated to the the notebook.","type":"integer"},"credentials":{"description":"A list of credential IDs to pass to the notebook.","type":"array","items":{"type":"integer"}},"environmentVariables":{"description":"Environment variables to be passed into the Notebook.","type":"object","additionalProperties":{"type":"string"}},"idleTimeout":{"description":"How long the notebook will stay alive without any kernel activity.","type":"integer"},"partitionLabel":{"description":"The partition label used to run this object.","type":"string"},"gitRepoUrl":{"description":"The URL of the git repository (e.g., https://github.com/organization/repo_name.git).","type":"string"},"gitRef":{"description":"The git reference if git repo is specified","type":"string"},"gitPath":{"description":"The path to the .ipynb file in the git repo that will be started up on notebook launch","type":"string"}}},"Object396":{"type":"object","properties":{"updateUrl":{"description":"Time-limited URL to PUT new contents of the .ipynb file for this notebook.","type":"string"},"updatePreviewUrl":{"description":"Time-limited URL to PUT new contents of the .htm preview file for this notebook.","type":"string"}}},"Object397":{"type":"object","properties":{"userIds":{"description":"An array of one or more user IDs.","type":"array","items":{"type":"integer"}},"permissionLevel":{"description":"Options are: \"read\", \"write\", or \"manage\".","type":"string"},"shareEmailBody":{"description":"Custom body text for e-mail sent on a share.","type":"string"},"sendSharedEmail":{"description":"Send email to the recipients of a share.","type":"boolean"}},"required":["userIds","permissionLevel"]},"Object398":{"type":"object","properties":{"groupIds":{"description":"An array of one or more group IDs.","type":"array","items":{"type":"integer"}},"permissionLevel":{"description":"Options are: \"read\", \"write\", or \"manage\".","type":"string"},"shareEmailBody":{"description":"Custom body text for e-mail sent on a share.","type":"string"},"sendSharedEmail":{"description":"Send email to the recipients of a share.","type":"boolean"}},"required":["groupIds","permissionLevel"]},"Object399":{"type":"object","properties":{"userId":{"description":"ID of target user","type":"integer"},"includeDependencies":{"description":"Whether or not to give manage permissions on all dependencies","type":"boolean"},"emailBody":{"description":"Custom body text for e-mail sent on transfer.","type":"string"},"sendEmail":{"description":"Send email to the target user of the transfer?","type":"boolean"}},"required":["userId","includeDependencies"]},"Object400":{"type":"object","properties":{"status":{"description":"The desired archived status of the object.","type":"boolean"}},"required":["status"]},"Object401":{"type":"object","properties":{"deploymentId":{"description":"The ID for this deployment","type":"integer"}}},"Object403":{"type":"object","properties":{"gitRef":{"description":"A git reference specifying an unambiguous version of the file. Can be a branch name, tag or the full or shortened SHA of a commit.","type":"string"},"gitBranch":{"description":"The git branch that the file is on.","type":"string"},"gitPath":{"description":"The path of the file in the repository.","type":"string"},"gitRepo":{"$ref":"#/definitions/Object249"},"gitRefType":{"description":"Specifies if the file is versioned by branch or tag.","type":"string"},"pullFromGit":{"description":"Automatically pull latest commit from git. Only works for scripts and workflows (assuming you have the feature enabled)","type":"boolean"}}},"Object404":{"type":"object","properties":{"gitRef":{"description":"A git reference specifying an unambiguous version of the file. Can be a branch name, or the full or shortened SHA of a commit.","type":"string"},"gitBranch":{"description":"The git branch that the file is on.","type":"string"},"gitPath":{"description":"The path of the file in the repository.","type":"string"},"gitRepoUrl":{"description":"The URL of the git repository (e.g., https://github.com/organization/repo_name.git).","type":"string"},"gitRefType":{"description":"Specifies if the file is versioned by branch or tag.","type":"string"},"pullFromGit":{"description":"Automatically pull latest commit from git. Only works for scripts.","type":"boolean"}}},"Object405":{"type":"object","properties":{"commitHash":{"description":"The SHA of the commit.","type":"string"},"authorName":{"description":"The name of the commit's author.","type":"string"},"date":{"description":"The commit's timestamp.","type":"string","format":"time"},"message":{"description":"The commit message.","type":"string"}}},"Object406":{"type":"object","properties":{"content":{"description":"The contents to commit to the file.","type":"string"},"message":{"description":"A commit message describing the changes being made.","type":"string"},"fileHash":{"description":"The full SHA of the file being replaced.","type":"string"}},"required":["content","message","fileHash"]},"Object407":{"type":"object","properties":{"content":{"description":"The file's contents.","type":"string"},"type":{"description":"The file's type.","type":"string"},"size":{"description":"The file's size.","type":"integer"},"fileHash":{"description":"The SHA of the file.","type":"string"}}},"Object412":{"type":"object","properties":{"key":{"type":"string"},"title":{"type":"string"},"desc":{"description":"A description of this field.","type":"string"},"aliases":{"type":"array","items":{"type":"string"}}}},"Object413":{"type":"object","properties":{"id":{"description":"The id of the favorite.","type":"integer"},"objectId":{"description":"The id of the object. If specified as a query parameter, must also specify object_type parameter.","type":"integer"},"objectType":{"description":"The type of the object that is favorited. Valid options: Container Script, Identity Resolution, Import, Python Script, R Script, dbt Script, JavaScript Script, SQL Script, Template Script, Project, Workflow, Tableau Report, Service Report, HTML Report, SQL Report","type":"string"},"objectName":{"description":"The name of the object that is favorited.","type":"string"},"createdAt":{"description":"The time this favorite was created.","type":"string","format":"time"},"objectUpdatedAt":{"description":"The time the object that is favorited was last updated","type":"string","format":"time"},"objectAuthor":{"description":"The author/owner of the object that is favorited.","$ref":"#/definitions/Object33"},"position":{"description":"The rank position of this favorite. Use the patch users/me/favorites/:id/ranking/ endpoints to update.","type":"integer"}}},"Object414":{"type":"object","properties":{"objectId":{"description":"The id of the object. If specified as a query parameter, must also specify object_type parameter.","type":"integer"},"objectType":{"description":"The type of the object that is favorited. Valid options: Container Script, Identity Resolution, Import, Python Script, R Script, dbt Script, JavaScript Script, SQL Script, Template Script, Project, Workflow, Tableau Report, Service Report, HTML Report, SQL Report","type":"string"}},"required":["objectId","objectType"]},"Object415":{"type":"object","properties":{"id":{"description":"The id of the favorite.","type":"integer"},"objectId":{"description":"The id of the object. If specified as a query parameter, must also specify object_type parameter.","type":"integer"},"objectType":{"description":"The type of the object that is favorited. Valid options: Container Script, Identity Resolution, Import, Python Script, R Script, dbt Script, JavaScript Script, SQL Script, Template Script, Project, Workflow, Tableau Report, Service Report, HTML Report, SQL Report","type":"string"},"objectName":{"description":"The name of the object that is favorited.","type":"string"},"createdAt":{"description":"The time this favorite was created.","type":"string","format":"time"},"objectUpdatedAt":{"description":"The time the object that is favorited was last updated","type":"string","format":"time"},"objectAuthor":{"description":"The author/owner of the object that is favorited.","$ref":"#/definitions/Object33"}}},"Object416":{"type":"object","properties":{"id":{"description":"The ID for this permission set.","type":"integer"},"name":{"description":"The name of this permission set.","type":"string"},"description":{"description":"A description of this permission set.","type":"string"},"author":{"description":"The author/owner of the item.","$ref":"#/definitions/Object33"},"createdAt":{"type":"string","format":"time"},"updatedAt":{"type":"string","format":"time"},"archived":{"description":"The archival status of the requested item(s).","type":"string"}}},"Object417":{"type":"object","properties":{"name":{"description":"The name of this permission set.","type":"string"},"description":{"description":"A description of this permission set.","type":"string"}},"required":["name"]},"Object418":{"type":"object","properties":{"name":{"description":"The name of this permission set.","type":"string"},"description":{"description":"A description of this permission set.","type":"string"}},"required":["name"]},"Object419":{"type":"object","properties":{"name":{"description":"The name of this permission set.","type":"string"},"description":{"description":"A description of this permission set.","type":"string"}}},"Object420":{"type":"object","properties":{"userIds":{"description":"An array of one or more user IDs.","type":"array","items":{"type":"integer"}},"permissionLevel":{"description":"Options are: \"read\", \"write\", or \"manage\".","type":"string"},"shareEmailBody":{"description":"Custom body text for e-mail sent on a share.","type":"string"},"sendSharedEmail":{"description":"Send email to the recipients of a share.","type":"boolean"}},"required":["userIds","permissionLevel"]},"Object421":{"type":"object","properties":{"groupIds":{"description":"An array of one or more group IDs.","type":"array","items":{"type":"integer"}},"permissionLevel":{"description":"Options are: \"read\", \"write\", or \"manage\".","type":"string"},"shareEmailBody":{"description":"Custom body text for e-mail sent on a share.","type":"string"},"sendSharedEmail":{"description":"Send email to the recipients of a share.","type":"boolean"}},"required":["groupIds","permissionLevel"]},"Object422":{"type":"object","properties":{"userId":{"description":"ID of target user","type":"integer"},"includeDependencies":{"description":"Whether or not to give manage permissions on all dependencies","type":"boolean"},"emailBody":{"description":"Custom body text for e-mail sent on transfer.","type":"string"},"sendEmail":{"description":"Send email to the target user of the transfer?","type":"boolean"}},"required":["userId","includeDependencies"]},"Object423":{"type":"object","properties":{"status":{"description":"The desired archived status of the object.","type":"boolean"}},"required":["status"]},"Object424":{"type":"object","properties":{"resourceName":{"description":"The name of the resource.","type":"string"},"read":{"description":"If true, the user has read permission on this resource.","type":"boolean"},"write":{"description":"If true, the user has write permission on this resource.","type":"boolean"},"manage":{"description":"If true, the user has manage permission on this resource.","type":"boolean"}}},"Object425":{"type":"object","properties":{"permissionSetId":{"description":"The ID for the permission set this resource belongs to.","type":"integer"},"name":{"description":"The name of this resource.","type":"string"},"description":{"description":"A description of this resource.","type":"string"},"createdAt":{"type":"string","format":"time"},"updatedAt":{"type":"string","format":"time"}}},"Object426":{"type":"object","properties":{"name":{"description":"The name of this resource.","type":"string"},"description":{"description":"A description of this resource.","type":"string"}},"required":["name"]},"Object427":{"type":"object","properties":{"description":{"description":"A description of this resource.","type":"string"}}},"Object428":{"type":"object","properties":{"userIds":{"description":"An array of one or more user IDs.","type":"array","items":{"type":"integer"}},"permissionLevel":{"description":"Options are: \"read\", \"write\", or \"manage\".","type":"string"},"shareEmailBody":{"description":"Custom body text for e-mail sent on a share.","type":"string"},"sendSharedEmail":{"description":"Send email to the recipients of a share.","type":"boolean"}},"required":["userIds","permissionLevel"]},"Object429":{"type":"object","properties":{"groupIds":{"description":"An array of one or more group IDs.","type":"array","items":{"type":"integer"}},"permissionLevel":{"description":"Options are: \"read\", \"write\", or \"manage\".","type":"string"},"shareEmailBody":{"description":"Custom body text for e-mail sent on a share.","type":"string"},"sendSharedEmail":{"description":"Send email to the recipients of a share.","type":"boolean"}},"required":["groupIds","permissionLevel"]},"Object430":{"type":"object","properties":{"id":{"description":"The ID of the prediction.","type":"integer"},"modelId":{"description":"The ID of the model used for this prediction.","type":"integer"},"scoredTableId":{"description":"The ID of the source table for this prediction.","type":"integer"},"scoredTableName":{"description":"The name of the source table for this prediction.","type":"string"},"outputTableName":{"description":"The name of the output table for this prediction.","type":"string"},"state":{"description":"The state of the last run of this prediction.","type":"string"},"error":{"description":"The error, if any, of the last run of this prediction.","type":"string"},"startedAt":{"description":"The start time of the last run of this prediction.","type":"string","format":"date-time"},"finishedAt":{"description":"The end time of the last run of this prediction.","type":"string","format":"date-time"},"lastRun":{"description":"The last run of this prediction.","$ref":"#/definitions/Object75"}}},"Object433":{"type":"object","properties":{"scoreName":{"description":"The name of the score.","type":"string"},"histogram":{"description":"The histogram of the distribution of scores.","type":"array","items":{"type":"integer"}},"avgScore":{"description":"The average score.","type":"number","format":"float"},"minScore":{"description":"The minimum score.","type":"number","format":"float"},"maxScore":{"description":"The maximum score.","type":"number","format":"float"}}},"Object432":{"type":"object","properties":{"id":{"description":"The ID of the table with created predictions.","type":"integer"},"schema":{"description":"The schema of table with created predictions.","type":"string"},"name":{"description":"The name of table with created predictions.","type":"string"},"createdAt":{"description":"The time when the table with created predictions was created.","type":"string","format":"date-time"},"scoreStats":{"description":"An array of metrics on the created predictions.","type":"array","items":{"$ref":"#/definitions/Object433"}}}},"Object431":{"type":"object","properties":{"id":{"description":"The ID of the prediction.","type":"integer"},"modelId":{"description":"The ID of the model used for this prediction.","type":"integer"},"scoredTableId":{"description":"The ID of the source table for this prediction.","type":"integer"},"scoredTableName":{"description":"The name of the source table for this prediction.","type":"string"},"outputTableName":{"description":"The name of the output table for this prediction.","type":"string"},"state":{"description":"The state of the last run of this prediction.","type":"string"},"error":{"description":"The error, if any, of the last run of this prediction.","type":"string"},"startedAt":{"description":"The start time of the last run of this prediction.","type":"string","format":"date-time"},"finishedAt":{"description":"The end time of the last run of this prediction.","type":"string","format":"date-time"},"lastRun":{"description":"The last run of this prediction.","$ref":"#/definitions/Object75"},"scoredTables":{"description":"An array of created prediction tables.","type":"array","items":{"$ref":"#/definitions/Object432"}},"schedule":{"description":"The schedule when the prediction will be built.","$ref":"#/definitions/Object107"},"limitingSQL":{"description":"A SQL WHERE clause used to scope the rows to be predicted.","type":"string"},"primaryKey":{"description":"The primary key or composite keys of the table being predicted.","type":"array","items":{"type":"string"}}}},"Object434":{"type":"object","properties":{"id":{"description":"ID of the prediction associated with this schedule.","type":"integer"},"schedule":{"description":"Schedule when the prediction will run.","$ref":"#/definitions/Object107"},"scoreOnModelBuild":{"description":"Whether the prediction will run after a rebuild of the associated model.","type":"boolean"}}},"Object435":{"type":"object","properties":{"name":{"description":"The name of this project.","type":"string"},"description":{"description":"A description of the project.","type":"string"},"note":{"description":"Notes for the project.","type":"string"},"autoShare":{"description":"If true, objects within the project will be automatically shared when the project is shared or objects are added.","type":"boolean"},"hidden":{"description":"The hidden status of the item.","type":"boolean"}},"required":["name","description"]},"Object437":{"type":"object","properties":{"schema":{"type":"string"},"name":{"type":"string"},"rowCount":{"type":"integer"},"columnCount":{"type":"integer"},"createdAt":{"type":"string","format":"time"},"updatedAt":{"type":"string","format":"time"}}},"Object438":{"type":"object","properties":{"id":{"description":"The item's ID.","type":"integer"},"createdAt":{"type":"string","format":"time"},"updatedAt":{"type":"string","format":"time"}}},"Object440":{"type":"object","properties":{"state":{"type":"string"},"updatedAt":{"type":"string","format":"time"}}},"Object439":{"type":"object","properties":{"id":{"description":"The item's ID.","type":"integer"},"createdAt":{"type":"string","format":"time"},"updatedAt":{"type":"string","format":"time"},"name":{"type":"string"},"type":{"type":"string"},"finishedAt":{"type":"string","format":"time"},"state":{"type":"string"},"lastRun":{"$ref":"#/definitions/Object440"}}},"Object441":{"type":"object","properties":{"id":{"description":"The item's ID.","type":"integer"},"createdAt":{"type":"string","format":"time"},"updatedAt":{"type":"string","format":"time"},"name":{"type":"string"},"type":{"type":"string"},"finishedAt":{"type":"string","format":"time"},"state":{"type":"string"},"lastRun":{"$ref":"#/definitions/Object440"}}},"Object442":{"type":"object","properties":{"id":{"description":"The item's ID.","type":"integer"},"createdAt":{"type":"string","format":"time"},"updatedAt":{"type":"string","format":"time"},"name":{"type":"string"},"state":{"type":"string"}}},"Object443":{"type":"object","properties":{"id":{"description":"The item's ID.","type":"integer"},"createdAt":{"type":"string","format":"time"},"updatedAt":{"type":"string","format":"time"},"name":{"type":"string"},"currentDeploymentId":{"type":"integer"},"lastDeploy":{"$ref":"#/definitions/Object440"}}},"Object444":{"type":"object","properties":{"id":{"description":"The item's ID.","type":"integer"},"createdAt":{"type":"string","format":"time"},"updatedAt":{"type":"string","format":"time"},"name":{"type":"string"},"currentDeploymentId":{"type":"integer"},"lastDeploy":{"$ref":"#/definitions/Object440"}}},"Object445":{"type":"object","properties":{"id":{"description":"The item's ID.","type":"integer"},"createdAt":{"type":"string","format":"time"},"updatedAt":{"type":"string","format":"time"},"name":{"type":"string"},"state":{"type":"string"},"lastExecution":{"$ref":"#/definitions/Object440"}}},"Object446":{"type":"object","properties":{"id":{"description":"The item's ID.","type":"integer"},"createdAt":{"type":"string","format":"time"},"updatedAt":{"type":"string","format":"time"},"name":{"type":"string"},"state":{"type":"string"}}},"Object447":{"type":"object","properties":{"id":{"description":"The item's ID.","type":"integer"},"createdAt":{"type":"string","format":"time"},"updatedAt":{"type":"string","format":"time"},"name":{"type":"string"}}},"Object448":{"type":"object","properties":{"id":{"description":"The item's ID.","type":"integer"},"createdAt":{"type":"string","format":"time"},"updatedAt":{"type":"string","format":"time"},"fileName":{"type":"string"},"fileSize":{"type":"integer"},"expired":{"type":"boolean"}}},"Object449":{"type":"object","properties":{"id":{"description":"The item's ID.","type":"integer"},"createdAt":{"type":"string","format":"time"},"updatedAt":{"type":"string","format":"time"},"name":{"type":"string"},"lastRun":{"$ref":"#/definitions/Object440"}}},"Object450":{"type":"object","properties":{"id":{"description":"The item's ID.","type":"integer"},"createdAt":{"type":"string","format":"time"},"updatedAt":{"type":"string","format":"time"},"name":{"type":"string"},"description":{"type":"string"}}},"Object451":{"type":"object","properties":{"projectId":{"type":"integer"},"objectId":{"type":"integer"},"objectType":{"type":"string"},"fcoType":{"type":"string"},"subType":{"type":"string"},"name":{"type":"string"},"icon":{"type":"string"},"author":{"type":"string"},"updatedAt":{"type":"string","format":"time"},"autoShare":{"type":"boolean"},"archived":{"description":"The archival status of the requested item(s).","type":"string"},"hidden":{"description":"The hidden status of the item.","type":"boolean"},"myPermissionLevel":{"description":"Your permission level on the object. One of \"read\", \"write\", or \"manage\".","type":"string"}}},"Object452":{"type":"object","properties":{"id":{"description":"The parent project's ID.","type":"integer"},"name":{"description":"The parent project's name.","type":"integer"}}},"Object436":{"type":"object","properties":{"id":{"description":"The ID for this project.","type":"integer"},"author":{"description":"The author/owner of the item.","$ref":"#/definitions/Object33"},"name":{"description":"The name of this project.","type":"string"},"description":{"description":"A description of the project.","type":"string"},"users":{"description":"Users who can see the project.","type":"array","items":{"$ref":"#/definitions/Object33"}},"autoShare":{"type":"boolean"},"createdAt":{"type":"string","format":"time"},"updatedAt":{"type":"string","format":"time"},"tables":{"type":"array","items":{"$ref":"#/definitions/Object437"}},"surveys":{"type":"array","items":{"$ref":"#/definitions/Object438"}},"scripts":{"type":"array","items":{"$ref":"#/definitions/Object439"}},"imports":{"type":"array","items":{"$ref":"#/definitions/Object441"}},"exports":{"type":"array","items":{"$ref":"#/definitions/Object441"}},"models":{"type":"array","items":{"$ref":"#/definitions/Object442"}},"notebooks":{"type":"array","items":{"$ref":"#/definitions/Object443"}},"services":{"type":"array","items":{"$ref":"#/definitions/Object444"}},"workflows":{"type":"array","items":{"$ref":"#/definitions/Object445"}},"reports":{"type":"array","items":{"$ref":"#/definitions/Object446"}},"scriptTemplates":{"type":"array","items":{"$ref":"#/definitions/Object447"}},"files":{"type":"array","items":{"$ref":"#/definitions/Object448"}},"enhancements":{"type":"array","items":{"$ref":"#/definitions/Object449"}},"projects":{"type":"array","items":{"$ref":"#/definitions/Object450"}},"allObjects":{"type":"array","items":{"$ref":"#/definitions/Object451"}},"note":{"type":"string"},"canCurrentUserEnableAutoShare":{"description":"A flag for if the current user can enable auto-sharing mode for this project.","type":"boolean"},"hidden":{"description":"The hidden status of the item.","type":"boolean"},"archived":{"description":"The archival status of the requested item(s).","type":"string"},"parentProject":{"description":"The project that this project is a part of, if any. To add a project to another project, use the PUT /projects/:id/parent_projects endpoint","$ref":"#/definitions/Object452"},"myPermissionLevel":{"description":"Your permission level on the object. One of \"read\", \"write\", or \"manage\".","type":"string"}}},"Object453":{"type":"object","properties":{"cloneSchedule":{"description":"If true, also copy the schedule for all applicable project objects.","type":"boolean"},"cloneNotifications":{"description":"If true, also copy the notifications for all applicable project objects.","type":"boolean"}}},"Object454":{"type":"object","properties":{"name":{"description":"The name of this project.","type":"string"},"description":{"description":"A description of the project.","type":"string"},"note":{"description":"Notes for the project.","type":"string"}}},"Object455":{"type":"object","properties":{"autoShare":{"description":"A toggle for sharing the objects within the project when the project is shared or objects are added.","type":"boolean"}},"required":["autoShare"]},"Object456":{"type":"object","properties":{"userIds":{"description":"An array of one or more user IDs.","type":"array","items":{"type":"integer"}},"permissionLevel":{"description":"Options are: \"read\", \"write\", or \"manage\".","type":"string"},"shareEmailBody":{"description":"Custom body text for e-mail sent on a share.","type":"string"},"sendSharedEmail":{"description":"Send email to the recipients of a share.","type":"boolean"}},"required":["userIds","permissionLevel"]},"Object457":{"type":"object","properties":{"groupIds":{"description":"An array of one or more group IDs.","type":"array","items":{"type":"integer"}},"permissionLevel":{"description":"Options are: \"read\", \"write\", or \"manage\".","type":"string"},"shareEmailBody":{"description":"Custom body text for e-mail sent on a share.","type":"string"},"sendSharedEmail":{"description":"Send email to the recipients of a share.","type":"boolean"}},"required":["groupIds","permissionLevel"]},"Object458":{"type":"object","properties":{"userId":{"description":"ID of target user","type":"integer"},"includeDependencies":{"description":"Whether or not to give manage permissions on all dependencies","type":"boolean"},"emailBody":{"description":"Custom body text for e-mail sent on transfer.","type":"string"},"sendEmail":{"description":"Send email to the target user of the transfer?","type":"boolean"}},"required":["userId","includeDependencies"]},"Object459":{"type":"object","properties":{"status":{"description":"The desired archived status of the object.","type":"boolean"}},"required":["status"]},"Object460":{"type":"object","properties":{"id":{"description":"The query ID.","type":"integer"},"database":{"description":"The database ID.","type":"integer"},"sql":{"description":"The SQL to execute.","type":"string"},"credential":{"description":"The credential ID.","type":"integer"},"resultRows":{"description":"A preview of rows returned by the query.","type":"array","items":{"type":"array","items":{"type":"string"}}},"resultColumns":{"description":"A preview of columns returned by the query.","type":"array","items":{"type":"string"}},"error":{"description":"The error message for this run, if present.","type":"string"},"startedAt":{"description":"The start time of the last run.","type":"string","format":"date-time"},"finishedAt":{"description":"The end time of the last run.","type":"string","format":"date-time"},"state":{"description":"The state of the last run. One of queued, running, succeeded, failed, and cancelled.","type":"string"},"scriptId":{"description":"The ID of the script associated with this query.","type":"integer"},"exception":{"description":"Deprecated and not used.","type":"string"},"createdAt":{"type":"string","format":"time"},"updatedAt":{"type":"string","format":"time"},"lastRunId":{"description":"The ID of the last run.","type":"integer"},"archived":{"description":"The archival status of the requested item(s).","type":"string"},"previewRows":{"description":"The number of rows to save from the query's result (maximum: 1000).","type":"integer"},"reportId":{"description":"The ID of the report associated with this query.","type":"integer"}}},"Object461":{"type":"object","properties":{"id":{"description":"The ID of the run.","type":"integer"},"queryId":{"description":"The ID of the Query job.","type":"integer"},"state":{"description":"The state of the run, one of 'queued' 'running' 'succeeded' 'failed' or 'cancelled'.","type":"string"},"isCancelRequested":{"description":"True if run cancel requested, else false.","type":"boolean"},"createdAt":{"description":"The time the run was created.","type":"string","format":"time"},"startedAt":{"description":"The time the run started at.","type":"string","format":"time"},"finishedAt":{"description":"The time the run completed.","type":"string","format":"time"},"error":{"description":"The error, if any, returned by the run.","type":"string"}}},"Object462":{"type":"object","properties":{"database":{"description":"The database ID.","type":"integer"},"sql":{"description":"The SQL to execute.","type":"string"},"credential":{"description":"The credential ID.","type":"integer"},"hidden":{"description":"The hidden status of the item.","type":"boolean"},"interactive":{"description":"Deprecated and not used.","type":"boolean"},"previewRows":{"description":"The number of rows to save from the query's result (maximum: 1000).","type":"integer"},"includeHeader":{"description":"Whether the CSV output should include a header row [default: true].","type":"boolean"},"compression":{"description":"The type of compression. One of gzip or zip, or none [default: gzip].","type":"string"},"columnDelimiter":{"description":"The delimiter to use. One of comma or tab, or pipe [default: comma].","type":"string"},"unquoted":{"description":"If true, will not quote fields.","type":"boolean"},"filenamePrefix":{"description":"The output filename prefix.","type":"string"}},"required":["database","sql","previewRows"]},"Object463":{"type":"object","properties":{"id":{"description":"The query ID.","type":"integer"},"database":{"description":"The database ID.","type":"integer"},"sql":{"description":"The SQL to execute.","type":"string"},"credential":{"description":"The credential ID.","type":"integer"},"resultRows":{"description":"A preview of rows returned by the query.","type":"array","items":{"type":"array","items":{"type":"string"}}},"resultColumns":{"description":"A preview of columns returned by the query.","type":"array","items":{"type":"string"}},"error":{"description":"The error message for this run, if present.","type":"string"},"startedAt":{"description":"The start time of the last run.","type":"string","format":"date-time"},"finishedAt":{"description":"The end time of the last run.","type":"string","format":"date-time"},"state":{"description":"The state of the last run. One of queued, running, succeeded, failed, and cancelled.","type":"string"},"scriptId":{"description":"The ID of the script associated with this query.","type":"integer"},"exception":{"description":"Deprecated and not used.","type":"string"},"createdAt":{"type":"string","format":"time"},"updatedAt":{"type":"string","format":"time"},"lastRunId":{"description":"The ID of the last run.","type":"integer"},"hidden":{"description":"The hidden status of the item.","type":"boolean"},"archived":{"description":"The archival status of the requested item(s).","type":"string"},"myPermissionLevel":{"description":"Your permission level on the object. One of \"read\", \"write\", or \"manage\".","type":"string"},"interactive":{"description":"Deprecated and not used.","type":"boolean"},"previewRows":{"description":"The number of rows to save from the query's result (maximum: 1000).","type":"integer"},"includeHeader":{"description":"Whether the CSV output should include a header row [default: true].","type":"boolean"},"compression":{"description":"The type of compression. One of gzip or zip, or none [default: gzip].","type":"string"},"columnDelimiter":{"description":"The delimiter to use. One of comma or tab, or pipe [default: comma].","type":"string"},"unquoted":{"description":"If true, will not quote fields.","type":"boolean"},"filenamePrefix":{"description":"The output filename prefix.","type":"string"},"reportId":{"description":"The ID of the report associated with this query.","type":"integer"}}},"Object464":{"type":"object","properties":{"id":{"description":"The query ID.","type":"integer"},"database":{"description":"The database ID.","type":"integer"},"sql":{"description":"The SQL to execute.","type":"string"},"credential":{"description":"The credential ID.","type":"integer"},"resultRows":{"description":"A preview of rows returned by the query.","type":"array","items":{"type":"array","items":{"type":"string"}}},"resultColumns":{"description":"A preview of columns returned by the query.","type":"array","items":{"type":"string"}},"error":{"description":"The error message for this run, if present.","type":"string"},"startedAt":{"description":"The start time of the last run.","type":"string","format":"date-time"},"finishedAt":{"description":"The end time of the last run.","type":"string","format":"date-time"},"state":{"description":"The state of the last run. One of queued, running, succeeded, failed, and cancelled.","type":"string"},"scriptId":{"description":"The ID of the script associated with this query.","type":"integer"},"exception":{"description":"Deprecated and not used.","type":"string"},"createdAt":{"type":"string","format":"time"},"updatedAt":{"type":"string","format":"time"},"lastRunId":{"description":"The ID of the last run.","type":"integer"},"hidden":{"description":"The hidden status of the item.","type":"boolean"},"archived":{"description":"The archival status of the requested item(s).","type":"string"},"name":{"description":"The name of the query.","type":"string"},"author":{"description":"The author/owner of the item.","$ref":"#/definitions/Object33"},"reportId":{"description":"The ID of the report associated with this query.","type":"integer"}}},"Object465":{"type":"object","properties":{"id":{"description":"The ID of the remote host.","type":"integer"},"name":{"description":"The human readable name for the remote host.","type":"string"},"type":{"description":"The type of remote host. One of: RemoteHostTypes::Bigquery, RemoteHostTypes::Bitbucket, RemoteHostTypes::GitSSH, RemoteHostTypes::Github, RemoteHostTypes::GoogleDoc, RemoteHostTypes::JDBC, RemoteHostTypes::Postgres, RemoteHostTypes::Redshift, RemoteHostTypes::S3Storage, and RemoteHostTypes::Salesforce","type":"string"},"url":{"description":"The URL for the remote host.","type":"string"}}},"Object466":{"type":"object","properties":{"name":{"description":"The human readable name for the remote host.","type":"string"},"url":{"description":"The URL for the remote host.","type":"string"},"type":{"description":"The type of remote host. One of: RemoteHostTypes::Bigquery, RemoteHostTypes::Bitbucket, RemoteHostTypes::GitSSH, RemoteHostTypes::Github, RemoteHostTypes::GoogleDoc, RemoteHostTypes::JDBC, RemoteHostTypes::Postgres, RemoteHostTypes::Redshift, RemoteHostTypes::S3Storage, and RemoteHostTypes::Salesforce","type":"string"}},"required":["name","url","type"]},"Object467":{"type":"object","properties":{"id":{"description":"The ID of the remote host.","type":"integer"},"name":{"description":"The human readable name for the remote host.","type":"string"},"type":{"description":"The type of remote host. One of: RemoteHostTypes::Bigquery, RemoteHostTypes::Bitbucket, RemoteHostTypes::GitSSH, RemoteHostTypes::Github, RemoteHostTypes::GoogleDoc, RemoteHostTypes::JDBC, RemoteHostTypes::Postgres, RemoteHostTypes::Redshift, RemoteHostTypes::S3Storage, and RemoteHostTypes::Salesforce","type":"string"},"url":{"description":"The URL for the remote host.","type":"string"},"description":{"description":"The description of the remote host.","type":"string"},"myPermissionLevel":{"description":"Your permission level on the object. One of \"read\", \"write\", or \"manage\".","type":"string"},"user":{"description":"The owner of the remote host.","$ref":"#/definitions/Object33"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}}},"Object468":{"type":"object","properties":{"name":{"description":"The human readable name for the remote host.","type":"string"},"type":{"description":"The type of remote host. One of: RemoteHostTypes::Bigquery, RemoteHostTypes::Bitbucket, RemoteHostTypes::GitSSH, RemoteHostTypes::Github, RemoteHostTypes::GoogleDoc, RemoteHostTypes::JDBC, RemoteHostTypes::Postgres, RemoteHostTypes::Redshift, RemoteHostTypes::S3Storage, and RemoteHostTypes::Salesforce","type":"string"},"url":{"description":"The URL for the remote host.","type":"string"},"description":{"description":"The description of the remote host.","type":"string"}},"required":["name","type","url","description"]},"Object469":{"type":"object","properties":{"name":{"description":"The human readable name for the remote host.","type":"string"},"type":{"description":"The type of remote host. One of: RemoteHostTypes::Bigquery, RemoteHostTypes::Bitbucket, RemoteHostTypes::GitSSH, RemoteHostTypes::Github, RemoteHostTypes::GoogleDoc, RemoteHostTypes::JDBC, RemoteHostTypes::Postgres, RemoteHostTypes::Redshift, RemoteHostTypes::S3Storage, and RemoteHostTypes::Salesforce","type":"string"},"url":{"description":"The URL for the remote host.","type":"string"},"description":{"description":"The description of the remote host.","type":"string"}}},"Object470":{"type":"object","properties":{"userIds":{"description":"An array of one or more user IDs.","type":"array","items":{"type":"integer"}},"permissionLevel":{"description":"Options are: \"read\", \"write\", or \"manage\".","type":"string"},"shareEmailBody":{"description":"Custom body text for e-mail sent on a share.","type":"string"},"sendSharedEmail":{"description":"Send email to the recipients of a share.","type":"boolean"}},"required":["userIds","permissionLevel"]},"Object471":{"type":"object","properties":{"groupIds":{"description":"An array of one or more group IDs.","type":"array","items":{"type":"integer"}},"permissionLevel":{"description":"Options are: \"read\", \"write\", or \"manage\".","type":"string"},"shareEmailBody":{"description":"Custom body text for e-mail sent on a share.","type":"string"},"sendSharedEmail":{"description":"Send email to the recipients of a share.","type":"boolean"}},"required":["groupIds","permissionLevel"]},"Object472":{"type":"object","properties":{"credentialId":{"description":"The credential ID.","type":"integer"},"username":{"description":"The user name for remote host.","type":"string"},"password":{"description":"The password for remote host.","type":"string"}}},"Object473":{"type":"object","properties":{"name":{"description":"The path to a data_set.","type":"string"},"fullPath":{"description":"Boolean that indicates whether further querying needs to be done before the table can be selected.","type":"boolean"}}},"Object475":{"type":"object","properties":{"id":{"description":"The ID for the project.","type":"integer"},"name":{"description":"The name of the project.","type":"string"}}},"Object476":{"type":"object","properties":{"id":{"description":"The ID for the script.","type":"integer"},"name":{"description":"The name of the script.","type":"string"},"sql":{"description":"The raw SQL query for the script, if applicable.","type":"string"}}},"Object474":{"type":"object","properties":{"id":{"description":"The ID of this report.","type":"integer"},"name":{"description":"The name of the report.","type":"string"},"user":{"description":"The name of the author of this report.","$ref":"#/definitions/Object33"},"createdAt":{"description":"The creation time for this report.","type":"string","format":"time"},"updatedAt":{"description":"The last updated at time for this report.","type":"string","format":"time"},"type":{"description":"The type of the report. One of: ReportTypes::HTML, ReportTypes::Tableau, ReportTypes::ShinyApp, ReportTypes::SQL","type":"string"},"archived":{"description":"The archival status of the requested item(s).","type":"string"},"projects":{"description":"A list of projects containing the report.","type":"array","items":{"$ref":"#/definitions/Object475"}},"state":{"description":"The status of the report's last run.","type":"string"},"finishedAt":{"description":"The time that the report's last run finished.","type":"string","format":"time"},"vizUpdatedAt":{"description":"The time that the report's visualization was last updated.","type":"string","format":"time"},"script":{"description":"The ID, name, and raw SQL of the job (a script or a query) that backs this report.","$ref":"#/definitions/Object476"},"jobPath":{"description":"The link to details of the job that backs this report.","type":"string"},"tableauId":{"type":"integer"},"templateId":{"description":"The ID of the template used for this report.","type":"integer"},"authThumbnailUrl":{"description":"URL for a thumbnail of the report.","type":"string"},"lastRun":{"description":"The last run of the job backing this report.","$ref":"#/definitions/Object75"}}},"Object477":{"type":"object","properties":{"id":{"description":"The ID of this report.","type":"integer"},"name":{"description":"The name of the report.","type":"string"},"user":{"description":"The name of the author of this report.","$ref":"#/definitions/Object33"},"createdAt":{"description":"The creation time for this report.","type":"string","format":"time"},"updatedAt":{"description":"The last updated at time for this report.","type":"string","format":"time"},"type":{"description":"The type of the report. One of: ReportTypes::HTML, ReportTypes::Tableau, ReportTypes::ShinyApp, ReportTypes::SQL","type":"string"},"description":{"description":"The user-defined description of the report.","type":"string"},"myPermissionLevel":{"description":"Your permission level on the object. One of \"read\", \"write\", or \"manage\".","type":"string"},"archived":{"description":"The archival status of the requested item(s).","type":"string"},"projects":{"description":"A list of projects containing the report.","type":"array","items":{"$ref":"#/definitions/Object475"}},"state":{"description":"The status of the report's last run.","type":"string"},"finishedAt":{"description":"The time that the report's last run finished.","type":"string","format":"time"},"vizUpdatedAt":{"description":"The time that the report's visualization was last updated.","type":"string","format":"time"},"script":{"description":"The ID, name, and raw SQL of the job (a script or a query) that backs this report.","$ref":"#/definitions/Object476"},"jobPath":{"description":"The link to details of the job that backs this report.","type":"string"},"tableauId":{"type":"integer"},"templateId":{"description":"The ID of the template used for this report.","type":"integer"},"authThumbnailUrl":{"description":"URL for a thumbnail of the report.","type":"string"},"lastRun":{"description":"The last run of the job backing this report.","$ref":"#/definitions/Object75"},"hidden":{"description":"The hidden status of the item.","type":"boolean"},"authDataUrl":{"description":"DEPRECATED: For legacy reports","type":"string"},"authCodeUrl":{"description":"Link to code to render in the report.","type":"string"},"config":{"description":"Any configuration metadata for this report.","type":"string"},"validOutputFile":{"description":"Whether the job (a script or a query) that backs the report currently has a valid output file.","type":"boolean"},"provideAPIKey":{"description":"Whether the report requests an API Key from the report viewer.","type":"boolean"},"apiKey":{"description":"A Civis API key that can be used by this report.","type":"string"},"apiKeyId":{"description":"The ID of the API key. Can be used for auditing API use by this report.","type":"integer"},"appState":{"description":"Any application state blob for this report.","type":"object","additionalProperties":{"type":"string"}},"useViewersTableauUsername":{"description":"Apply user level filtering on Tableau reports.","type":"boolean"}}},"Object478":{"type":"object","properties":{"scriptId":{"description":"The ID of the job (a script or a query) used to create this report.","type":"integer"},"name":{"description":"The name of the report.","type":"string"},"codeBody":{"description":"The code for the report visualization.","type":"string"},"appState":{"description":"Any application state blob for this report.","type":"object","additionalProperties":{"type":"string"}},"provideAPIKey":{"description":"Allow the report to provide an API key to front-end code.","type":"boolean"},"templateId":{"description":"The ID of the template used for this report.","type":"integer"},"description":{"description":"The user-defined description of the report.","type":"string"},"hidden":{"description":"The hidden status of the item.","type":"boolean"}}},"Object479":{"type":"object","properties":{"name":{"description":"The name of the report.","type":"string"},"scriptId":{"description":"The ID of the job (a script or a query) used to create this report.","type":"integer"},"codeBody":{"description":"The code for the report visualization.","type":"string"},"config":{"type":"string"},"appState":{"description":"The application state blob for this report.","type":"object","additionalProperties":{"type":"string"}},"provideAPIKey":{"description":"Allow the report to provide an API key to front-end code.","type":"boolean"},"templateId":{"description":"The ID of the template used for this report. If null is passed, no template will back this report. Changes to the backing template will reset the report appState.","type":"integer"},"useViewersTableauUsername":{"description":"Apply user level filtering on Tableau reports.","type":"boolean"},"description":{"description":"The user-defined description of the report.","type":"string"}}},"Object480":{"type":"object","properties":{"userIds":{"description":"An array of one or more user IDs.","type":"array","items":{"type":"integer"}},"permissionLevel":{"description":"Options are: \"read\", \"write\", or \"manage\".","type":"string"},"shareEmailBody":{"description":"Custom body text for e-mail sent on a share.","type":"string"},"sendSharedEmail":{"description":"Send email to the recipients of a share.","type":"boolean"}},"required":["userIds","permissionLevel"]},"Object481":{"type":"object","properties":{"groupIds":{"description":"An array of one or more group IDs.","type":"array","items":{"type":"integer"}},"permissionLevel":{"description":"Options are: \"read\", \"write\", or \"manage\".","type":"string"},"shareEmailBody":{"description":"Custom body text for e-mail sent on a share.","type":"string"},"sendSharedEmail":{"description":"Send email to the recipients of a share.","type":"boolean"}},"required":["groupIds","permissionLevel"]},"Object482":{"type":"object","properties":{"userId":{"description":"ID of target user","type":"integer"},"includeDependencies":{"description":"Whether or not to give manage permissions on all dependencies","type":"boolean"},"emailBody":{"description":"Custom body text for e-mail sent on transfer.","type":"string"},"sendEmail":{"description":"Send email to the target user of the transfer?","type":"boolean"}},"required":["userId","includeDependencies"]},"Object483":{"type":"object","properties":{"status":{"description":"The desired archived status of the object.","type":"boolean"}},"required":["status"]},"Object484":{"type":"object","properties":{"id":{"description":"The ID of this report.","type":"integer"},"name":{"description":"The name of the report.","type":"string"},"user":{"description":"The name of the author of this report.","$ref":"#/definitions/Object33"},"createdAt":{"description":"The creation time for this report.","type":"string","format":"time"},"updatedAt":{"description":"The last updated at time for this report.","type":"string","format":"time"},"type":{"description":"The type of the report. One of: ReportTypes::HTML, ReportTypes::Tableau, ReportTypes::ShinyApp, ReportTypes::SQL","type":"string"},"description":{"description":"The user-defined description of the report.","type":"string"},"myPermissionLevel":{"description":"Your permission level on the object. One of \"read\", \"write\", or \"manage\".","type":"string"},"archived":{"description":"The archival status of the requested item(s).","type":"string"},"host":{"description":"The host for the service report","type":"string"},"displayUrl":{"description":"The URL to display the service report.","type":"string"},"serviceId":{"description":"The id of the backing service","type":"integer"},"provideAPIKey":{"description":"Whether the report requests an API Key from the report viewer.","type":"boolean"},"apiKey":{"description":"A Civis API key that can be used by this report.","type":"string"},"apiKeyId":{"description":"The ID of the API key. Can be used for auditing API use by this report.","type":"integer"}}},"Object485":{"type":"object","properties":{"serviceId":{"description":"The id of the backing service","type":"integer"},"provideAPIKey":{"description":"Whether the report requests an API Key from the report viewer.","type":"boolean"}},"required":["serviceId"]},"Object486":{"type":"object","properties":{"name":{"description":"The name of the service report.","type":"string"},"provideAPIKey":{"description":"Whether the report requests an API Key from the report viewer.","type":"boolean"}}},"Object487":{"type":"object","properties":{"userIds":{"description":"An array of one or more user IDs.","type":"array","items":{"type":"integer"}},"permissionLevel":{"description":"Options are: \"read\", \"write\", or \"manage\".","type":"string"},"shareEmailBody":{"description":"Custom body text for e-mail sent on a share.","type":"string"},"sendSharedEmail":{"description":"Send email to the recipients of a share.","type":"boolean"}},"required":["userIds","permissionLevel"]},"Object488":{"type":"object","properties":{"groupIds":{"description":"An array of one or more group IDs.","type":"array","items":{"type":"integer"}},"permissionLevel":{"description":"Options are: \"read\", \"write\", or \"manage\".","type":"string"},"shareEmailBody":{"description":"Custom body text for e-mail sent on a share.","type":"string"},"sendSharedEmail":{"description":"Send email to the recipients of a share.","type":"boolean"}},"required":["groupIds","permissionLevel"]},"Object489":{"type":"object","properties":{"userId":{"description":"ID of target user","type":"integer"},"includeDependencies":{"description":"Whether or not to give manage permissions on all dependencies","type":"boolean"},"emailBody":{"description":"Custom body text for e-mail sent on transfer.","type":"string"},"sendEmail":{"description":"Send email to the target user of the transfer?","type":"boolean"}},"required":["userId","includeDependencies"]},"Object490":{"type":"object","properties":{"status":{"description":"The desired archived status of the object.","type":"boolean"}},"required":["status"]},"Object492":{"type":"object","properties":{"id":{"description":"The ID of this organization.","type":"integer"},"tableauRefreshUsage":{"description":"The number of tableau refreshes used this month.","type":"integer"},"tableauRefreshLimit":{"description":"The number of monthly tableau refreshes permitted to this organization.","type":"integer"},"tableauRefreshHistory":{"description":"The number of tableau refreshes used this month.","type":"array","items":{"type":"object"}}}},"Object491":{"type":"object","properties":{"id":{"description":"The ID of this report.","type":"integer"},"organization":{"description":"Details for the organization of the user who owns this report","$ref":"#/definitions/Object492"}}},"Object493":{"type":"object","properties":{"queryId":{"description":"The ID of the query used to create this report.","type":"integer"},"name":{"description":"The name of the report.","type":"string"},"config":{"description":"The configuration of the report visualization.","type":"string"},"description":{"description":"The user-defined description of the report.","type":"string"}},"required":["queryId","name","config"]},"Object495":{"type":"object","properties":{"id":{"description":"The query ID.","type":"integer"},"database":{"description":"The database ID.","type":"integer"},"sql":{"description":"The SQL to execute.","type":"string"},"credential":{"description":"The credential ID.","type":"integer"},"resultRows":{"description":"A preview of rows returned by the query.","type":"array","items":{"type":"array","items":{"type":"string"}}},"resultColumns":{"description":"A preview of columns returned by the query.","type":"array","items":{"type":"string"}},"error":{"description":"The error message for this run, if present.","type":"string"},"startedAt":{"description":"The start time of the last run.","type":"string","format":"date-time"},"finishedAt":{"description":"The end time of the last run.","type":"string","format":"date-time"},"state":{"description":"The state of the last run. One of queued, running, succeeded, failed, and cancelled.","type":"string"},"runningAs":{"description":"The user this query will run as.","$ref":"#/definitions/Object33"}}},"Object494":{"type":"object","properties":{"id":{"description":"The ID of this report.","type":"integer"},"name":{"description":"The name of the report.","type":"string"},"user":{"description":"The name of the author of this report.","$ref":"#/definitions/Object33"},"createdAt":{"description":"The creation time for this report.","type":"string","format":"time"},"updatedAt":{"description":"The last updated at time for this report.","type":"string","format":"time"},"type":{"description":"The type of the report. One of: ReportTypes::HTML, ReportTypes::Tableau, ReportTypes::ShinyApp, ReportTypes::SQL","type":"string"},"description":{"description":"The user-defined description of the report.","type":"string"},"myPermissionLevel":{"description":"Your permission level on the object. One of \"read\", \"write\", or \"manage\".","type":"string"},"archived":{"description":"The archival status of the requested item(s).","type":"string"},"config":{"description":"The configuration of the report visualization.","type":"string"},"query":{"description":"The current query associated with this report.","$ref":"#/definitions/Object495"}}},"Object496":{"type":"object","properties":{"queryId":{"description":"The ID of the query used to create this report.","type":"integer"},"name":{"description":"The name of the report.","type":"string"},"config":{"description":"The configuration of the report visualization.","type":"string"},"description":{"description":"The user-defined description of the report.","type":"string"}}},"Object497":{"type":"object","properties":{"userIds":{"description":"An array of one or more user IDs.","type":"array","items":{"type":"integer"}},"permissionLevel":{"description":"Options are: \"read\", \"write\", or \"manage\".","type":"string"},"shareEmailBody":{"description":"Custom body text for e-mail sent on a share.","type":"string"},"sendSharedEmail":{"description":"Send email to the recipients of a share.","type":"boolean"}},"required":["userIds","permissionLevel"]},"Object498":{"type":"object","properties":{"groupIds":{"description":"An array of one or more group IDs.","type":"array","items":{"type":"integer"}},"permissionLevel":{"description":"Options are: \"read\", \"write\", or \"manage\".","type":"string"},"shareEmailBody":{"description":"Custom body text for e-mail sent on a share.","type":"string"},"sendSharedEmail":{"description":"Send email to the recipients of a share.","type":"boolean"}},"required":["groupIds","permissionLevel"]},"Object499":{"type":"object","properties":{"userId":{"description":"ID of target user","type":"integer"},"includeDependencies":{"description":"Whether or not to give manage permissions on all dependencies","type":"boolean"},"emailBody":{"description":"Custom body text for e-mail sent on transfer.","type":"string"},"sendEmail":{"description":"Send email to the target user of the transfer?","type":"boolean"}},"required":["userId","includeDependencies"]},"Object500":{"type":"object","properties":{"status":{"description":"The desired archived status of the object.","type":"boolean"}},"required":["status"]},"Object501":{"type":"object","properties":{"id":{"description":"ID of the Role.","type":"integer"},"name":{"description":"The name of the Role.","type":"string"},"slug":{"description":"The slug.","type":"string"},"description":{"description":"The description of the Role.","type":"string"}}},"Object520":{"type":"object","properties":{"name":{"description":"The name of the type.","type":"string"}}},"Object522":{"type":"object","properties":{"outputName":{"description":"The name of the output file.","type":"string"},"fileId":{"description":"The unique ID of the output file.","type":"integer"},"path":{"description":"The temporary link to download this output file, valid for 36 hours.","type":"string"}}},"Object521":{"type":"object","properties":{"id":{"description":"The ID of this run.","type":"integer"},"sqlId":{"description":"The ID of this sql.","type":"integer"},"state":{"description":"The state of this run.","type":"string"},"isCancelRequested":{"description":"True if run cancel requested, else false.","type":"boolean"},"finishedAt":{"description":"The time that this run finished.","type":"string","format":"time"},"error":{"description":"The error message for this run, if present.","type":"string"},"output":{"description":"A list of the outputs of this script.","type":"array","items":{"$ref":"#/definitions/Object522"}}}},"Object524":{"type":"object","properties":{"name":{"description":"The variable's name as used within your code.","type":"string"},"label":{"description":"The label to present to users when asking them for the value.","type":"string"},"description":{"description":"A short sentence or fragment describing this parameter to the end user.","type":"string"},"type":{"description":"The type of parameter. Valid options: string, multi_line_string, integer, float, bool, file, table, database, credential_aws, credential_redshift, or credential_custom","type":"string"},"required":{"description":"Whether this param is required.","type":"boolean"},"value":{"description":"The value you would like to set this param to. Setting this value makes this parameter a fixed param.","type":"string"},"default":{"description":"If an argument for this parameter is not defined, it will use this default value. Use true, True, t, y, yes, or 1 for true bool's or false, False, f, n, no, or 0 for false bool's. Cannot be used for parameters that are required or a credential type.","type":"string"},"allowedValues":{"description":"The possible values this parameter can take, effectively making this an enumerable parameter. Allowed values is an array of hashes of the following format: `{label: 'Import', 'value': 'import'}`","type":"array","items":{"type":"object"}}},"required":["name","type"]},"Object523":{"type":"object","properties":{"name":{"description":"The name of the script.","type":"string"},"remoteHostId":{"description":"The database ID.","type":"integer"},"credentialId":{"description":"The credential ID.","type":"integer"},"sql":{"description":"The raw SQL query for the script.","type":"string"},"params":{"description":"A definition of the parameters this script accepts in the arguments field. Cannot be set if this script uses a template script.","type":"array","items":{"$ref":"#/definitions/Object524"}},"arguments":{"description":"Parameter-value pairs to use when running this script. Only settable if this script has defined parameters.","type":"object"},"templateScriptId":{"description":"The ID of the template script, if any. A script cannot both have a template script and be a template for other scripts.","type":"integer"},"notifications":{"description":"The notifications to send after the script is run.","$ref":"#/definitions/Object103"},"hidden":{"description":"The hidden status of the item.","type":"boolean"}},"required":["name","remoteHostId","credentialId","sql"]},"Object526":{"type":"object","properties":{"id":{"description":"The ID for the project.","type":"integer"},"name":{"description":"The name of the project.","type":"string"}}},"Object527":{"type":"object","properties":{"name":{"description":"The variable's name as used within your code.","type":"string"},"label":{"description":"The label to present to users when asking them for the value.","type":"string"},"description":{"description":"A short sentence or fragment describing this parameter to the end user.","type":"string"},"type":{"description":"The type of parameter. Valid options: string, multi_line_string, integer, float, bool, file, table, database, credential_aws, credential_redshift, or credential_custom","type":"string"},"required":{"description":"Whether this param is required.","type":"boolean"},"value":{"description":"The value you would like to set this param to. Setting this value makes this parameter a fixed param.","type":"string"},"default":{"description":"If an argument for this parameter is not defined, it will use this default value. Use true, True, t, y, yes, or 1 for true bool's or false, False, f, n, no, or 0 for false bool's. Cannot be used for parameters that are required or a credential type.","type":"string"},"allowedValues":{"description":"The possible values this parameter can take, effectively making this an enumerable parameter. Allowed values is an array of hashes of the following format: `{label: 'Import', 'value': 'import'}`","type":"array","items":{"type":"object"}}}},"Object528":{"type":"object","properties":{"details":{"description":"The details link to get more information about the script.","type":"string"},"runs":{"description":"The runs link to get the run information list for this script.","type":"string"}}},"Object525":{"type":"object","properties":{"id":{"description":"The ID for the script.","type":"integer"},"name":{"description":"The name of the script.","type":"string"},"type":{"description":"The type of the script (e.g SQL, Container, Python, R, JavaScript, dbt)","type":"string"},"createdAt":{"description":"The time this script was created.","type":"string","format":"time"},"updatedAt":{"description":"The time the script was last updated.","type":"string","format":"time"},"author":{"description":"The author/owner of the item.","$ref":"#/definitions/Object33"},"state":{"description":"The status of the script's last run.","type":"string"},"finishedAt":{"description":"The time that the script's last run finished.","type":"string","format":"time"},"category":{"description":"The category of the script.","type":"string"},"projects":{"description":"A list of projects containing the script.","type":"array","items":{"$ref":"#/definitions/Object526"}},"parentId":{"description":"The ID of the parent job that will trigger this script","type":"integer"},"userContext":{"description":"\"runner\" or \"author\", who to execute the script as when run as a template.","type":"string"},"params":{"description":"A definition of the parameters this script accepts in the arguments field.","type":"array","items":{"$ref":"#/definitions/Object527"}},"arguments":{"description":"Parameter-value pairs to use when running this script. Only settable if this script has defined parameters.","type":"object"},"isTemplate":{"description":"Whether others scripts use this one as a template.","type":"boolean"},"publishedAsTemplateId":{"description":"The ID of the template that this script is backing.","type":"integer"},"fromTemplateId":{"description":"The ID of the template this script uses, if any.","type":"integer"},"templateDependentsCount":{"description":"How many other scripts use this one as a template.","type":"integer"},"templateScriptName":{"description":"The name of the template script.","type":"string"},"links":{"description":"Useful links for this script.","$ref":"#/definitions/Object528"},"schedule":{"description":"The schedule of when this script will be run.","$ref":"#/definitions/Object107"},"notifications":{"description":"The notifications to send after the script is run.","$ref":"#/definitions/Object108"},"runningAs":{"description":"The user this job will run as, defaults to the author of the job.","$ref":"#/definitions/Object33"},"nextRunAt":{"description":"The time of the next scheduled run.","type":"string","format":"time"},"timeZone":{"description":"The time zone of this script.","type":"string"},"lastRun":{"description":"The last run of this script.","$ref":"#/definitions/Object75"},"myPermissionLevel":{"description":"Your permission level on the object. One of \"read\", \"write\", or \"manage\".","type":"string"},"hidden":{"description":"The hidden status of the item.","type":"boolean"},"targetProjectId":{"description":"Target project to which script outputs will be added.","type":"integer"},"archived":{"description":"The archival status of the requested item(s).","type":"string"},"templateScriptId":{"description":"The ID of the template script, if any.","type":"integer"}}},"Object529":{"type":"object","properties":{"id":{"description":"The ID of the run.","type":"integer"},"state":{"description":"The state of the run, one of 'queued', 'running' or 'cancelled'.","type":"string"},"isCancelRequested":{"description":"True if run cancel requested, else false.","type":"boolean"}}},"Object531":{"type":"object","properties":{"cpu":{"description":"The number of CPU shares to allocate for the container. Each core has 1000 shares. Must be at least 2 shares.","type":"integer"},"memory":{"description":"The amount of RAM to allocate for the container (in MB). Must be at least 4 MB.","type":"integer"},"diskSpace":{"description":"The amount of disk space, in GB, to allocate for the container. This space will be used to hold the git repo configured for the container and anything your container writes to /tmp or /data. Fractional values (e.g. 0.25) are supported.","type":"number","format":"float"}},"required":["cpu","memory"]},"Object530":{"type":"object","properties":{"name":{"description":"The name of the container.","type":"string"},"parentId":{"description":"The ID of the parent job that will trigger this script","type":"integer"},"userContext":{"description":"\"runner\" or \"author\", who to execute the script as when run as a template.","type":"string"},"params":{"description":"A definition of the parameters this script accepts in the arguments field.","type":"array","items":{"$ref":"#/definitions/Object524"}},"arguments":{"description":"Parameter-value pairs to use when running this script. Only settable if this script has defined parameters.","type":"object"},"schedule":{"description":"The schedule of when this script will be run.","$ref":"#/definitions/Object102"},"notifications":{"description":"The notifications to send after the script is run.","$ref":"#/definitions/Object103"},"requiredResources":{"description":"Resources to allocate for the container.","$ref":"#/definitions/Object531"},"repoHttpUri":{"description":"The location of a github repo to clone into the container, e.g. github.com/my-user/my-repo.git.","type":"string"},"repoRef":{"description":"The tag or branch of the github repo to clone into the container.","type":"string"},"remoteHostCredentialId":{"description":"The id of the database credentials to pass into the environment of the container.","type":"integer"},"gitCredentialId":{"description":"The id of the git credential to be used when checking out the specified git repo. If not supplied, the first git credential you've submitted will be used. Unnecessary if no git repo is specified or the git repo is public.","type":"integer"},"dockerCommand":{"description":"The command to run on the container. Will be run via sh as: [\"sh\", \"-c\", dockerCommand]. Defaults to the Docker image's ENTRYPOINT/CMD.","type":"string"},"dockerImageName":{"description":"The name of the docker image to pull from DockerHub.","type":"string"},"dockerImageTag":{"description":"The tag of the docker image to pull from DockerHub.","type":"string"},"instanceType":{"description":"The EC2 instance type to deploy to. Only available for jobs running on kubernetes.","type":"string"},"cancelTimeout":{"description":"The amount of time (in seconds) to wait before forcibly terminating the script. When the script is cancelled, it is first sent a TERM signal. If the script is still running after the timeout, it is sent a KILL signal. Defaults to 0.","type":"integer"},"timeZone":{"description":"The time zone of this script.","type":"string"},"partitionLabel":{"description":"The partition label used to run this object. ","type":"string"},"hidden":{"description":"The hidden status of the item.","type":"boolean"},"targetProjectId":{"description":"Target project to which script outputs will be added.","type":"integer"},"runningAsId":{"description":"The ID of the runner of this script.","type":"integer"}},"required":["requiredResources"]},"Object533":{"type":"object","properties":{"id":{"description":"The id of the Alias object.","type":"integer"},"objectId":{"description":"The id of the object","type":"integer"},"alias":{"description":"The alias of the object","type":"string"}}},"Object534":{"type":"object","properties":{"cpu":{"description":"The number of CPU shares to allocate for the container. Each core has 1000 shares. Must be at least 2 shares.","type":"integer"},"memory":{"description":"The amount of RAM to allocate for the container (in MB). Must be at least 4 MB.","type":"integer"},"diskSpace":{"description":"The amount of disk space, in GB, to allocate for the container. This space will be used to hold the git repo configured for the container and anything your container writes to /tmp or /data. Fractional values (e.g. 0.25) are supported.","type":"number","format":"float"}}},"Object532":{"type":"object","properties":{"id":{"description":"The ID for the script.","type":"integer"},"fromTemplateAliases":{"description":"An array of the aliases of the template script.","type":"array","items":{"$ref":"#/definitions/Object533"}},"name":{"description":"The name of the container.","type":"string"},"type":{"description":"The type of the script (e.g Container)","type":"string"},"createdAt":{"description":"The time this script was created.","type":"string","format":"time"},"updatedAt":{"description":"The time the script was last updated.","type":"string","format":"time"},"author":{"description":"The author/owner of the item.","$ref":"#/definitions/Object33"},"state":{"description":"The status of the script's last run.","type":"string"},"finishedAt":{"description":"The time that the script's last run finished.","type":"string","format":"time"},"category":{"description":"The category of the script.","type":"string"},"projects":{"description":"A list of projects containing the script.","type":"array","items":{"$ref":"#/definitions/Object526"}},"parentId":{"description":"The ID of the parent job that will trigger this script","type":"integer"},"userContext":{"description":"\"runner\" or \"author\", who to execute the script as when run as a template.","type":"string"},"params":{"description":"A definition of the parameters this script accepts in the arguments field.","type":"array","items":{"$ref":"#/definitions/Object527"}},"arguments":{"description":"Parameter-value pairs to use when running this script. Only settable if this script has defined parameters.","type":"object"},"isTemplate":{"description":"Whether others scripts use this one as a template.","type":"boolean"},"templateDependentsCount":{"description":"How many other scripts use this one as a template.","type":"integer"},"publishedAsTemplateId":{"description":"The ID of the template that this script is backing.","type":"integer"},"fromTemplateId":{"description":"The ID of the template script.","type":"integer"},"templateScriptName":{"description":"The name of the template script.","type":"string"},"links":{"description":"Useful links for this script.","$ref":"#/definitions/Object528"},"schedule":{"description":"The schedule of when this script will be run.","$ref":"#/definitions/Object107"},"notifications":{"description":"The notifications to send after the script is run.","$ref":"#/definitions/Object108"},"runningAs":{"description":"The user this job will run as, defaults to the author of the job.","$ref":"#/definitions/Object33"},"requiredResources":{"description":"Resources to allocate for the container.","$ref":"#/definitions/Object534"},"repoHttpUri":{"description":"The location of a github repo to clone into the container, e.g. github.com/my-user/my-repo.git.","type":"string"},"repoRef":{"description":"The tag or branch of the github repo to clone into the container.","type":"string"},"remoteHostCredentialId":{"description":"The id of the database credentials to pass into the environment of the container.","type":"integer"},"gitCredentialId":{"description":"The id of the git credential to be used when checking out the specified git repo. If not supplied, the first git credential you've submitted will be used. Unnecessary if no git repo is specified or the git repo is public.","type":"integer"},"dockerCommand":{"description":"The command to run on the container. Will be run via sh as: [\"sh\", \"-c\", dockerCommand]. Defaults to the Docker image's ENTRYPOINT/CMD.","type":"string"},"dockerImageName":{"description":"The name of the docker image to pull from DockerHub.","type":"string"},"dockerImageTag":{"description":"The tag of the docker image to pull from DockerHub.","type":"string"},"instanceType":{"description":"The EC2 instance type to deploy to. Only available for jobs running on kubernetes.","type":"string"},"cancelTimeout":{"description":"The amount of time (in seconds) to wait before forcibly terminating the script. When the script is cancelled, it is first sent a TERM signal. If the script is still running after the timeout, it is sent a KILL signal. Defaults to 0.","type":"integer"},"lastRun":{"description":"The last run of this script.","$ref":"#/definitions/Object75"},"timeZone":{"description":"The time zone of this script.","type":"string"},"partitionLabel":{"description":"The partition label used to run this object. ","type":"string"},"myPermissionLevel":{"description":"Your permission level on the object. One of \"read\", \"write\", or \"manage\".","type":"string"},"hidden":{"description":"The hidden status of the item.","type":"boolean"},"archived":{"description":"The archival status of the requested item(s).","type":"string"},"targetProjectId":{"description":"Target project to which script outputs will be added.","type":"integer"},"runningAsId":{"description":"The ID of the runner of this script.","type":"integer"}}},"Object535":{"type":"object","properties":{"name":{"description":"The name of the container.","type":"string"},"parentId":{"description":"The ID of the parent job that will trigger this script","type":"integer"},"userContext":{"description":"\"runner\" or \"author\", who to execute the script as when run as a template.","type":"string"},"params":{"description":"A definition of the parameters this script accepts in the arguments field.","type":"array","items":{"$ref":"#/definitions/Object524"}},"arguments":{"description":"Parameter-value pairs to use when running this script. Only settable if this script has defined parameters.","type":"object"},"schedule":{"description":"The schedule of when this script will be run.","$ref":"#/definitions/Object102"},"notifications":{"description":"The notifications to send after the script is run.","$ref":"#/definitions/Object103"},"requiredResources":{"description":"Resources to allocate for the container.","$ref":"#/definitions/Object531"},"repoHttpUri":{"description":"The location of a github repo to clone into the container, e.g. github.com/my-user/my-repo.git.","type":"string"},"repoRef":{"description":"The tag or branch of the github repo to clone into the container.","type":"string"},"remoteHostCredentialId":{"description":"The id of the database credentials to pass into the environment of the container.","type":"integer"},"gitCredentialId":{"description":"The id of the git credential to be used when checking out the specified git repo. If not supplied, the first git credential you've submitted will be used. Unnecessary if no git repo is specified or the git repo is public.","type":"integer"},"dockerCommand":{"description":"The command to run on the container. Will be run via sh as: [\"sh\", \"-c\", dockerCommand]. Defaults to the Docker image's ENTRYPOINT/CMD.","type":"string"},"dockerImageName":{"description":"The name of the docker image to pull from DockerHub.","type":"string"},"dockerImageTag":{"description":"The tag of the docker image to pull from DockerHub.","type":"string"},"instanceType":{"description":"The EC2 instance type to deploy to. Only available for jobs running on kubernetes.","type":"string"},"cancelTimeout":{"description":"The amount of time (in seconds) to wait before forcibly terminating the script. When the script is cancelled, it is first sent a TERM signal. If the script is still running after the timeout, it is sent a KILL signal. Defaults to 0.","type":"integer"},"timeZone":{"description":"The time zone of this script.","type":"string"},"partitionLabel":{"description":"The partition label used to run this object. ","type":"string"},"targetProjectId":{"description":"Target project to which script outputs will be added.","type":"integer"},"runningAsId":{"description":"The ID of the runner of this script.","type":"integer"}},"required":["requiredResources"]},"Object537":{"type":"object","properties":{"name":{"description":"The variable's name as used within your code.","type":"string"},"label":{"description":"The label to present to users when asking them for the value.","type":"string"},"description":{"description":"A short sentence or fragment describing this parameter to the end user.","type":"string"},"type":{"description":"The type of parameter. Valid options: string, multi_line_string, integer, float, bool, file, table, database, credential_aws, credential_redshift, or credential_custom","type":"string"},"required":{"description":"Whether this param is required.","type":"boolean"},"value":{"description":"The value you would like to set this param to. Setting this value makes this parameter a fixed param.","type":"string"},"default":{"description":"If an argument for this parameter is not defined, it will use this default value. Use true, True, t, y, yes, or 1 for true bool's or false, False, f, n, no, or 0 for false bool's. Cannot be used for parameters that are required or a credential type.","type":"string"},"allowedValues":{"description":"The possible values this parameter can take, effectively making this an enumerable parameter. Allowed values is an array of hashes of the following format: `{label: 'Import', 'value': 'import'}`","type":"array","items":{"type":"object"}}}},"Object538":{"type":"object","properties":{"cpu":{"description":"The number of CPU shares to allocate for the container. Each core has 1000 shares. Must be at least 2 shares.","type":"integer"},"memory":{"description":"The amount of RAM to allocate for the container (in MB). Must be at least 4 MB.","type":"integer"},"diskSpace":{"description":"The amount of disk space, in GB, to allocate for the container. This space will be used to hold the git repo configured for the container and anything your container writes to /tmp or /data. Fractional values (e.g. 0.25) are supported.","type":"number","format":"float"}}},"Object536":{"type":"object","properties":{"name":{"description":"The name of the container.","type":"string"},"parentId":{"description":"The ID of the parent job that will trigger this script","type":"integer"},"userContext":{"description":"\"runner\" or \"author\", who to execute the script as when run as a template.","type":"string"},"params":{"description":"A definition of the parameters this script accepts in the arguments field.","type":"array","items":{"$ref":"#/definitions/Object537"}},"arguments":{"description":"Parameter-value pairs to use when running this script. Only settable if this script has defined parameters.","type":"object"},"schedule":{"description":"The schedule of when this script will be run.","$ref":"#/definitions/Object102"},"notifications":{"description":"The notifications to send after the script is run.","$ref":"#/definitions/Object103"},"requiredResources":{"description":"Resources to allocate for the container.","$ref":"#/definitions/Object538"},"repoHttpUri":{"description":"The location of a github repo to clone into the container, e.g. github.com/my-user/my-repo.git.","type":"string"},"repoRef":{"description":"The tag or branch of the github repo to clone into the container.","type":"string"},"remoteHostCredentialId":{"description":"The id of the database credentials to pass into the environment of the container.","type":"integer"},"gitCredentialId":{"description":"The id of the git credential to be used when checking out the specified git repo. If not supplied, the first git credential you've submitted will be used. Unnecessary if no git repo is specified or the git repo is public.","type":"integer"},"dockerCommand":{"description":"The command to run on the container. Will be run via sh as: [\"sh\", \"-c\", dockerCommand]. Defaults to the Docker image's ENTRYPOINT/CMD.","type":"string"},"dockerImageName":{"description":"The name of the docker image to pull from DockerHub.","type":"string"},"dockerImageTag":{"description":"The tag of the docker image to pull from DockerHub.","type":"string"},"instanceType":{"description":"The EC2 instance type to deploy to. Only available for jobs running on kubernetes.","type":"string"},"cancelTimeout":{"description":"The amount of time (in seconds) to wait before forcibly terminating the script. When the script is cancelled, it is first sent a TERM signal. If the script is still running after the timeout, it is sent a KILL signal. Defaults to 0.","type":"integer"},"timeZone":{"description":"The time zone of this script.","type":"string"},"partitionLabel":{"description":"The partition label used to run this object. ","type":"string"},"targetProjectId":{"description":"Target project to which script outputs will be added.","type":"integer"},"runningAsId":{"description":"The ID of the runner of this script.","type":"integer"}}},"Object541":{"type":"object","properties":{"message":{"description":"The log message to store.","type":"string"},"level":{"description":"The log level of this message [default: info]","type":"string"},"createdAt":{"description":"The timestamp of this message in ISO 8601 format. This is what logs are ordered by, so it is recommended to use timestamps with nanosecond precision. If absent, defaults to the time that the log was received by the API.","type":"string","format":"date-time"}},"required":["message"]},"Object540":{"type":"object","properties":{"message":{"description":"The log message to store.","type":"string"},"level":{"description":"The log level of this message [default: info]","type":"string"},"messages":{"description":"If specified, a batch of logs to store. If createdAt timestamps for the logs are supplied, the ordering of this list is not preserved, and the timestamps are used to sort the logs.If createdAt timestamps are not supplied, the ordering of this list is preserved and the logs are given the timestamp of when they were received.","type":"array","items":{"$ref":"#/definitions/Object541"}},"childJobId":{"description":"The ID of the child job the message came from.","type":"integer"}}},"Object542":{"type":"object","properties":{"id":{"description":"The ID for the script.","type":"integer"},"name":{"description":"The name of the script.","type":"string"},"type":{"description":"The type of the script (e.g SQL, Container, Python, R, JavaScript, dbt)","type":"string"},"createdAt":{"description":"The time this script was created.","type":"string","format":"time"},"updatedAt":{"description":"The time the script was last updated.","type":"string","format":"time"},"author":{"description":"The author/owner of the item.","$ref":"#/definitions/Object33"},"state":{"description":"The status of the script's last run.","type":"string"},"finishedAt":{"description":"The time that the script's last run finished.","type":"string","format":"time"},"projects":{"description":"A list of projects containing the script.","type":"array","items":{"$ref":"#/definitions/Object526"}},"parentId":{"description":"The ID of the parent job that will trigger this script","type":"integer"},"isTemplate":{"description":"Whether others scripts use this one as a template.","type":"boolean"},"fromTemplateId":{"description":"The ID of the template this script uses, if any.","type":"integer"},"links":{"description":"Useful links for this script.","$ref":"#/definitions/Object528"},"timeZone":{"description":"The time zone of this script.","type":"string"},"lastRun":{"description":"The last run of this script.","$ref":"#/definitions/Object75"},"archived":{"description":"The archival status of the requested item(s).","type":"string"},"templateScriptId":{"description":"The ID of the template script, if any.","type":"integer"}}},"Object544":{"type":"object","properties":{"includeHeader":{"description":"Whether or not to include headers in the output data. Default: true","type":"boolean"},"compression":{"description":"The type of compression to use, if any, one of \"none\", \"zip\", or \"gzip\". Default: gzip","type":"string"},"columnDelimiter":{"description":"Which delimiter to use, one of \"comma\", \"tab\", or \"pipe\". Default: comma","type":"string"},"unquoted":{"description":"Whether or not to quote fields. Default: false","type":"boolean"},"forceMultifile":{"description":"Whether or not the csv should be split into multiple files. Default: false","type":"boolean"},"filenamePrefix":{"description":"A user specified filename prefix for the output file to have. Default: null","type":"string"},"maxFileSize":{"description":"The max file size, in MB, created files will be. Only available when force_multifile is true. ","type":"integer"}}},"Object543":{"type":"object","properties":{"name":{"description":"The name of the script.","type":"string"},"parentId":{"description":"The ID of the parent job that will trigger this script","type":"integer"},"userContext":{"description":"\"runner\" or \"author\", who to execute the script as when run as a template.","type":"string"},"params":{"description":"A definition of the parameters this script accepts in the arguments field.","type":"array","items":{"$ref":"#/definitions/Object524"}},"arguments":{"description":"Parameter-value pairs to use when running this script. Only settable if this script has defined parameters.","type":"object"},"schedule":{"description":"The schedule of when this script will be run.","$ref":"#/definitions/Object102"},"notifications":{"description":"The notifications to send after the script is run.","$ref":"#/definitions/Object103"},"nextRunAt":{"description":"The time of the next scheduled run.","type":"string","format":"time"},"timeZone":{"description":"The time zone of this script.","type":"string"},"hidden":{"description":"The hidden status of the item.","type":"boolean"},"targetProjectId":{"description":"Target project to which script outputs will be added.","type":"integer"},"sql":{"description":"The raw SQL query for the script.","type":"string"},"remoteHostId":{"description":"The remote host ID that this script will connect to.","type":"integer"},"credentialId":{"description":"The credential that this script will use.","type":"integer"},"csvSettings":{"description":"Parameters that determine the format of the generated file.","$ref":"#/definitions/Object544"},"runningAsId":{"description":"The ID of the runner of this script.","type":"integer"}},"required":["name","sql","remoteHostId","credentialId"]},"Object546":{"type":"object","properties":{"includeHeader":{"description":"Whether or not to include headers in the output data. Default: true","type":"boolean"},"compression":{"description":"The type of compression to use, if any, one of \"none\", \"zip\", or \"gzip\". Default: gzip","type":"string"},"columnDelimiter":{"description":"Which delimiter to use, one of \"comma\", \"tab\", or \"pipe\". Default: comma","type":"string"},"unquoted":{"description":"Whether or not to quote fields. Default: false","type":"boolean"},"forceMultifile":{"description":"Whether or not the csv should be split into multiple files. Default: false","type":"boolean"},"filenamePrefix":{"description":"A user specified filename prefix for the output file to have. Default: null","type":"string"},"maxFileSize":{"description":"The max file size, in MB, created files will be. Only available when force_multifile is true. ","type":"integer"}}},"Object545":{"type":"object","properties":{"id":{"description":"The ID for the script.","type":"integer"},"name":{"description":"The name of the script.","type":"string"},"type":{"description":"The type of the script (e.g SQL, Container, Python, R, JavaScript, dbt)","type":"string"},"createdAt":{"description":"The time this script was created.","type":"string","format":"time"},"updatedAt":{"description":"The time the script was last updated.","type":"string","format":"time"},"author":{"description":"The author/owner of the item.","$ref":"#/definitions/Object33"},"state":{"description":"The status of the script's last run.","type":"string"},"finishedAt":{"description":"The time that the script's last run finished.","type":"string","format":"time"},"category":{"description":"The category of the script.","type":"string"},"projects":{"description":"A list of projects containing the script.","type":"array","items":{"$ref":"#/definitions/Object526"}},"parentId":{"description":"The ID of the parent job that will trigger this script","type":"integer"},"userContext":{"description":"\"runner\" or \"author\", who to execute the script as when run as a template.","type":"string"},"params":{"description":"A definition of the parameters this script accepts in the arguments field.","type":"array","items":{"$ref":"#/definitions/Object527"}},"arguments":{"description":"Parameter-value pairs to use when running this script. Only settable if this script has defined parameters.","type":"object"},"isTemplate":{"description":"Whether others scripts use this one as a template.","type":"boolean"},"publishedAsTemplateId":{"description":"The ID of the template that this script is backing.","type":"integer"},"fromTemplateId":{"description":"The ID of the template this script uses, if any.","type":"integer"},"templateDependentsCount":{"description":"How many other scripts use this one as a template.","type":"integer"},"templateScriptName":{"description":"The name of the template script.","type":"string"},"links":{"description":"Useful links for this script.","$ref":"#/definitions/Object528"},"schedule":{"description":"The schedule of when this script will be run.","$ref":"#/definitions/Object107"},"notifications":{"description":"The notifications to send after the script is run.","$ref":"#/definitions/Object108"},"runningAs":{"description":"The user this job will run as, defaults to the author of the job.","$ref":"#/definitions/Object33"},"nextRunAt":{"description":"The time of the next scheduled run.","type":"string","format":"time"},"timeZone":{"description":"The time zone of this script.","type":"string"},"lastRun":{"description":"The last run of this script.","$ref":"#/definitions/Object75"},"myPermissionLevel":{"description":"Your permission level on the object. One of \"read\", \"write\", or \"manage\".","type":"string"},"hidden":{"description":"The hidden status of the item.","type":"boolean"},"targetProjectId":{"description":"Target project to which script outputs will be added.","type":"integer"},"archived":{"description":"The archival status of the requested item(s).","type":"string"},"sql":{"description":"The raw SQL query for the script.","type":"string"},"expandedArguments":{"description":"Expanded arguments for use in injecting into different environments.","type":"object"},"remoteHostId":{"description":"The remote host ID that this script will connect to.","type":"integer"},"credentialId":{"description":"The credential that this script will use.","type":"integer"},"codePreview":{"description":"The code that this script will run with arguments inserted.","type":"string"},"csvSettings":{"description":"Parameters that determine the format of the generated file.","$ref":"#/definitions/Object546"},"runningAsId":{"description":"The ID of the runner of this script.","type":"integer"}}},"Object547":{"type":"object","properties":{"name":{"description":"The name of the script.","type":"string"},"parentId":{"description":"The ID of the parent job that will trigger this script","type":"integer"},"userContext":{"description":"\"runner\" or \"author\", who to execute the script as when run as a template.","type":"string"},"params":{"description":"A definition of the parameters this script accepts in the arguments field.","type":"array","items":{"$ref":"#/definitions/Object524"}},"arguments":{"description":"Parameter-value pairs to use when running this script. Only settable if this script has defined parameters.","type":"object"},"schedule":{"description":"The schedule of when this script will be run.","$ref":"#/definitions/Object102"},"notifications":{"description":"The notifications to send after the script is run.","$ref":"#/definitions/Object103"},"nextRunAt":{"description":"The time of the next scheduled run.","type":"string","format":"time"},"timeZone":{"description":"The time zone of this script.","type":"string"},"targetProjectId":{"description":"Target project to which script outputs will be added.","type":"integer"},"sql":{"description":"The raw SQL query for the script.","type":"string"},"remoteHostId":{"description":"The remote host ID that this script will connect to.","type":"integer"},"credentialId":{"description":"The credential that this script will use.","type":"integer"},"csvSettings":{"description":"Parameters that determine the format of the generated file.","$ref":"#/definitions/Object544"},"runningAsId":{"description":"The ID of the runner of this script.","type":"integer"}},"required":["name","sql","remoteHostId","credentialId"]},"Object548":{"type":"object","properties":{"name":{"description":"The name of the script.","type":"string"},"parentId":{"description":"The ID of the parent job that will trigger this script","type":"integer"},"userContext":{"description":"\"runner\" or \"author\", who to execute the script as when run as a template.","type":"string"},"params":{"description":"A definition of the parameters this script accepts in the arguments field.","type":"array","items":{"$ref":"#/definitions/Object537"}},"arguments":{"description":"Parameter-value pairs to use when running this script. Only settable if this script has defined parameters.","type":"object"},"schedule":{"description":"The schedule of when this script will be run.","$ref":"#/definitions/Object102"},"notifications":{"description":"The notifications to send after the script is run.","$ref":"#/definitions/Object103"},"nextRunAt":{"description":"The time of the next scheduled run.","type":"string","format":"time"},"timeZone":{"description":"The time zone of this script.","type":"string"},"targetProjectId":{"description":"Target project to which script outputs will be added.","type":"integer"},"sql":{"description":"The raw SQL query for the script.","type":"string"},"remoteHostId":{"description":"The remote host ID that this script will connect to.","type":"integer"},"credentialId":{"description":"The credential that this script will use.","type":"integer"},"csvSettings":{"description":"Parameters that determine the format of the generated file.","$ref":"#/definitions/Object544"},"runningAsId":{"description":"The ID of the runner of this script.","type":"integer"}}},"Object549":{"type":"object","properties":{"name":{"description":"The name of the script.","type":"string"},"parentId":{"description":"The ID of the parent job that will trigger this script","type":"integer"},"userContext":{"description":"\"runner\" or \"author\", who to execute the script as when run as a template.","type":"string"},"params":{"description":"A definition of the parameters this script accepts in the arguments field.","type":"array","items":{"$ref":"#/definitions/Object524"}},"arguments":{"description":"Parameter-value pairs to use when running this script. Only settable if this script has defined parameters.","type":"object"},"schedule":{"description":"The schedule of when this script will be run.","$ref":"#/definitions/Object102"},"notifications":{"description":"The notifications to send after the script is run.","$ref":"#/definitions/Object103"},"nextRunAt":{"description":"The time of the next scheduled run.","type":"string","format":"time"},"timeZone":{"description":"The time zone of this script.","type":"string"},"hidden":{"description":"The hidden status of the item.","type":"boolean"},"targetProjectId":{"description":"Target project to which script outputs will be added.","type":"integer"},"requiredResources":{"description":"Resources to allocate for the container.","$ref":"#/definitions/Object531"},"instanceType":{"description":"The EC2 instance type to deploy to. Only available for jobs running on kubernetes.","type":"string"},"cancelTimeout":{"description":"The amount of time (in seconds) to wait before forcibly terminating the script. When the script is cancelled, it is first sent a TERM signal. If the script is still running after the timeout, it is sent a KILL signal. Defaults to 0.","type":"integer"},"dockerImageTag":{"description":"The tag of the docker image to pull from DockerHub.","type":"string"},"partitionLabel":{"description":"The partition label used to run this object. ","type":"string"},"runningAsId":{"description":"The ID of the runner of this script.","type":"integer"},"source":{"description":"The body/text of the script.","type":"string"}},"required":["name","source"]},"Object550":{"type":"object","properties":{"id":{"description":"The ID for the script.","type":"integer"},"name":{"description":"The name of the script.","type":"string"},"type":{"description":"The type of the script (e.g SQL, Container, Python, R, JavaScript, dbt)","type":"string"},"createdAt":{"description":"The time this script was created.","type":"string","format":"time"},"updatedAt":{"description":"The time the script was last updated.","type":"string","format":"time"},"author":{"description":"The author/owner of the item.","$ref":"#/definitions/Object33"},"state":{"description":"The status of the script's last run.","type":"string"},"finishedAt":{"description":"The time that the script's last run finished.","type":"string","format":"time"},"category":{"description":"The category of the script.","type":"string"},"projects":{"description":"A list of projects containing the script.","type":"array","items":{"$ref":"#/definitions/Object526"}},"parentId":{"description":"The ID of the parent job that will trigger this script","type":"integer"},"userContext":{"description":"\"runner\" or \"author\", who to execute the script as when run as a template.","type":"string"},"params":{"description":"A definition of the parameters this script accepts in the arguments field.","type":"array","items":{"$ref":"#/definitions/Object527"}},"arguments":{"description":"Parameter-value pairs to use when running this script. Only settable if this script has defined parameters.","type":"object"},"isTemplate":{"description":"Whether others scripts use this one as a template.","type":"boolean"},"publishedAsTemplateId":{"description":"The ID of the template that this script is backing.","type":"integer"},"fromTemplateId":{"description":"The ID of the template this script uses, if any.","type":"integer"},"templateDependentsCount":{"description":"How many other scripts use this one as a template.","type":"integer"},"templateScriptName":{"description":"The name of the template script.","type":"string"},"links":{"description":"Useful links for this script.","$ref":"#/definitions/Object528"},"schedule":{"description":"The schedule of when this script will be run.","$ref":"#/definitions/Object107"},"notifications":{"description":"The notifications to send after the script is run.","$ref":"#/definitions/Object108"},"runningAs":{"description":"The user this job will run as, defaults to the author of the job.","$ref":"#/definitions/Object33"},"nextRunAt":{"description":"The time of the next scheduled run.","type":"string","format":"time"},"timeZone":{"description":"The time zone of this script.","type":"string"},"lastRun":{"description":"The last run of this script.","$ref":"#/definitions/Object75"},"myPermissionLevel":{"description":"Your permission level on the object. One of \"read\", \"write\", or \"manage\".","type":"string"},"hidden":{"description":"The hidden status of the item.","type":"boolean"},"targetProjectId":{"description":"Target project to which script outputs will be added.","type":"integer"},"archived":{"description":"The archival status of the requested item(s).","type":"string"},"requiredResources":{"description":"Resources to allocate for the container.","$ref":"#/definitions/Object534"},"instanceType":{"description":"The EC2 instance type to deploy to. Only available for jobs running on kubernetes.","type":"string"},"cancelTimeout":{"description":"The amount of time (in seconds) to wait before forcibly terminating the script. When the script is cancelled, it is first sent a TERM signal. If the script is still running after the timeout, it is sent a KILL signal. Defaults to 0.","type":"integer"},"dockerImageTag":{"description":"The tag of the docker image to pull from DockerHub.","type":"string"},"partitionLabel":{"description":"The partition label used to run this object. ","type":"string"},"runningAsId":{"description":"The ID of the runner of this script.","type":"integer"},"source":{"description":"The body/text of the script.","type":"string"}}},"Object551":{"type":"object","properties":{"name":{"description":"The name of the script.","type":"string"},"parentId":{"description":"The ID of the parent job that will trigger this script","type":"integer"},"userContext":{"description":"\"runner\" or \"author\", who to execute the script as when run as a template.","type":"string"},"params":{"description":"A definition of the parameters this script accepts in the arguments field.","type":"array","items":{"$ref":"#/definitions/Object524"}},"arguments":{"description":"Parameter-value pairs to use when running this script. Only settable if this script has defined parameters.","type":"object"},"schedule":{"description":"The schedule of when this script will be run.","$ref":"#/definitions/Object102"},"notifications":{"description":"The notifications to send after the script is run.","$ref":"#/definitions/Object103"},"nextRunAt":{"description":"The time of the next scheduled run.","type":"string","format":"time"},"timeZone":{"description":"The time zone of this script.","type":"string"},"targetProjectId":{"description":"Target project to which script outputs will be added.","type":"integer"},"requiredResources":{"description":"Resources to allocate for the container.","$ref":"#/definitions/Object531"},"instanceType":{"description":"The EC2 instance type to deploy to. Only available for jobs running on kubernetes.","type":"string"},"cancelTimeout":{"description":"The amount of time (in seconds) to wait before forcibly terminating the script. When the script is cancelled, it is first sent a TERM signal. If the script is still running after the timeout, it is sent a KILL signal. Defaults to 0.","type":"integer"},"dockerImageTag":{"description":"The tag of the docker image to pull from DockerHub.","type":"string"},"partitionLabel":{"description":"The partition label used to run this object. ","type":"string"},"runningAsId":{"description":"The ID of the runner of this script.","type":"integer"},"source":{"description":"The body/text of the script.","type":"string"}},"required":["name","source"]},"Object552":{"type":"object","properties":{"name":{"description":"The name of the script.","type":"string"},"parentId":{"description":"The ID of the parent job that will trigger this script","type":"integer"},"userContext":{"description":"\"runner\" or \"author\", who to execute the script as when run as a template.","type":"string"},"params":{"description":"A definition of the parameters this script accepts in the arguments field.","type":"array","items":{"$ref":"#/definitions/Object537"}},"arguments":{"description":"Parameter-value pairs to use when running this script. Only settable if this script has defined parameters.","type":"object"},"schedule":{"description":"The schedule of when this script will be run.","$ref":"#/definitions/Object102"},"notifications":{"description":"The notifications to send after the script is run.","$ref":"#/definitions/Object103"},"nextRunAt":{"description":"The time of the next scheduled run.","type":"string","format":"time"},"timeZone":{"description":"The time zone of this script.","type":"string"},"targetProjectId":{"description":"Target project to which script outputs will be added.","type":"integer"},"requiredResources":{"description":"Resources to allocate for the container.","$ref":"#/definitions/Object538"},"instanceType":{"description":"The EC2 instance type to deploy to. Only available for jobs running on kubernetes.","type":"string"},"cancelTimeout":{"description":"The amount of time (in seconds) to wait before forcibly terminating the script. When the script is cancelled, it is first sent a TERM signal. If the script is still running after the timeout, it is sent a KILL signal. Defaults to 0.","type":"integer"},"dockerImageTag":{"description":"The tag of the docker image to pull from DockerHub.","type":"string"},"partitionLabel":{"description":"The partition label used to run this object. ","type":"string"},"runningAsId":{"description":"The ID of the runner of this script.","type":"integer"},"source":{"description":"The body/text of the script.","type":"string"}}},"Object553":{"type":"object","properties":{"name":{"description":"The name of the script.","type":"string"},"parentId":{"description":"The ID of the parent job that will trigger this script","type":"integer"},"userContext":{"description":"\"runner\" or \"author\", who to execute the script as when run as a template.","type":"string"},"params":{"description":"A definition of the parameters this script accepts in the arguments field.","type":"array","items":{"$ref":"#/definitions/Object524"}},"arguments":{"description":"Parameter-value pairs to use when running this script. Only settable if this script has defined parameters.","type":"object"},"schedule":{"description":"The schedule of when this script will be run.","$ref":"#/definitions/Object102"},"notifications":{"description":"The notifications to send after the script is run.","$ref":"#/definitions/Object103"},"nextRunAt":{"description":"The time of the next scheduled run.","type":"string","format":"time"},"timeZone":{"description":"The time zone of this script.","type":"string"},"hidden":{"description":"The hidden status of the item.","type":"boolean"},"targetProjectId":{"description":"Target project to which script outputs will be added.","type":"integer"},"requiredResources":{"description":"Resources to allocate for the container.","$ref":"#/definitions/Object531"},"instanceType":{"description":"The EC2 instance type to deploy to. Only available for jobs running on kubernetes.","type":"string"},"cancelTimeout":{"description":"The amount of time (in seconds) to wait before forcibly terminating the script. When the script is cancelled, it is first sent a TERM signal. If the script is still running after the timeout, it is sent a KILL signal. Defaults to 0.","type":"integer"},"dockerImageTag":{"description":"The tag of the docker image to pull from DockerHub.","type":"string"},"partitionLabel":{"description":"The partition label used to run this object. ","type":"string"},"runningAsId":{"description":"The ID of the runner of this script.","type":"integer"},"source":{"description":"The body/text of the script.","type":"string"}},"required":["name","source"]},"Object554":{"type":"object","properties":{"id":{"description":"The ID for the script.","type":"integer"},"name":{"description":"The name of the script.","type":"string"},"type":{"description":"The type of the script (e.g SQL, Container, Python, R, JavaScript, dbt)","type":"string"},"createdAt":{"description":"The time this script was created.","type":"string","format":"time"},"updatedAt":{"description":"The time the script was last updated.","type":"string","format":"time"},"author":{"description":"The author/owner of the item.","$ref":"#/definitions/Object33"},"state":{"description":"The status of the script's last run.","type":"string"},"finishedAt":{"description":"The time that the script's last run finished.","type":"string","format":"time"},"category":{"description":"The category of the script.","type":"string"},"projects":{"description":"A list of projects containing the script.","type":"array","items":{"$ref":"#/definitions/Object526"}},"parentId":{"description":"The ID of the parent job that will trigger this script","type":"integer"},"userContext":{"description":"\"runner\" or \"author\", who to execute the script as when run as a template.","type":"string"},"params":{"description":"A definition of the parameters this script accepts in the arguments field.","type":"array","items":{"$ref":"#/definitions/Object527"}},"arguments":{"description":"Parameter-value pairs to use when running this script. Only settable if this script has defined parameters.","type":"object"},"isTemplate":{"description":"Whether others scripts use this one as a template.","type":"boolean"},"publishedAsTemplateId":{"description":"The ID of the template that this script is backing.","type":"integer"},"fromTemplateId":{"description":"The ID of the template this script uses, if any.","type":"integer"},"templateDependentsCount":{"description":"How many other scripts use this one as a template.","type":"integer"},"templateScriptName":{"description":"The name of the template script.","type":"string"},"links":{"description":"Useful links for this script.","$ref":"#/definitions/Object528"},"schedule":{"description":"The schedule of when this script will be run.","$ref":"#/definitions/Object107"},"notifications":{"description":"The notifications to send after the script is run.","$ref":"#/definitions/Object108"},"runningAs":{"description":"The user this job will run as, defaults to the author of the job.","$ref":"#/definitions/Object33"},"nextRunAt":{"description":"The time of the next scheduled run.","type":"string","format":"time"},"timeZone":{"description":"The time zone of this script.","type":"string"},"lastRun":{"description":"The last run of this script.","$ref":"#/definitions/Object75"},"myPermissionLevel":{"description":"Your permission level on the object. One of \"read\", \"write\", or \"manage\".","type":"string"},"hidden":{"description":"The hidden status of the item.","type":"boolean"},"targetProjectId":{"description":"Target project to which script outputs will be added.","type":"integer"},"archived":{"description":"The archival status of the requested item(s).","type":"string"},"requiredResources":{"description":"Resources to allocate for the container.","$ref":"#/definitions/Object534"},"instanceType":{"description":"The EC2 instance type to deploy to. Only available for jobs running on kubernetes.","type":"string"},"cancelTimeout":{"description":"The amount of time (in seconds) to wait before forcibly terminating the script. When the script is cancelled, it is first sent a TERM signal. If the script is still running after the timeout, it is sent a KILL signal. Defaults to 0.","type":"integer"},"dockerImageTag":{"description":"The tag of the docker image to pull from DockerHub.","type":"string"},"partitionLabel":{"description":"The partition label used to run this object. ","type":"string"},"runningAsId":{"description":"The ID of the runner of this script.","type":"integer"},"source":{"description":"The body/text of the script.","type":"string"}}},"Object555":{"type":"object","properties":{"name":{"description":"The name of the script.","type":"string"},"parentId":{"description":"The ID of the parent job that will trigger this script","type":"integer"},"userContext":{"description":"\"runner\" or \"author\", who to execute the script as when run as a template.","type":"string"},"params":{"description":"A definition of the parameters this script accepts in the arguments field.","type":"array","items":{"$ref":"#/definitions/Object524"}},"arguments":{"description":"Parameter-value pairs to use when running this script. Only settable if this script has defined parameters.","type":"object"},"schedule":{"description":"The schedule of when this script will be run.","$ref":"#/definitions/Object102"},"notifications":{"description":"The notifications to send after the script is run.","$ref":"#/definitions/Object103"},"nextRunAt":{"description":"The time of the next scheduled run.","type":"string","format":"time"},"timeZone":{"description":"The time zone of this script.","type":"string"},"targetProjectId":{"description":"Target project to which script outputs will be added.","type":"integer"},"requiredResources":{"description":"Resources to allocate for the container.","$ref":"#/definitions/Object531"},"instanceType":{"description":"The EC2 instance type to deploy to. Only available for jobs running on kubernetes.","type":"string"},"cancelTimeout":{"description":"The amount of time (in seconds) to wait before forcibly terminating the script. When the script is cancelled, it is first sent a TERM signal. If the script is still running after the timeout, it is sent a KILL signal. Defaults to 0.","type":"integer"},"dockerImageTag":{"description":"The tag of the docker image to pull from DockerHub.","type":"string"},"partitionLabel":{"description":"The partition label used to run this object. ","type":"string"},"runningAsId":{"description":"The ID of the runner of this script.","type":"integer"},"source":{"description":"The body/text of the script.","type":"string"}},"required":["name","source"]},"Object556":{"type":"object","properties":{"name":{"description":"The name of the script.","type":"string"},"parentId":{"description":"The ID of the parent job that will trigger this script","type":"integer"},"userContext":{"description":"\"runner\" or \"author\", who to execute the script as when run as a template.","type":"string"},"params":{"description":"A definition of the parameters this script accepts in the arguments field.","type":"array","items":{"$ref":"#/definitions/Object537"}},"arguments":{"description":"Parameter-value pairs to use when running this script. Only settable if this script has defined parameters.","type":"object"},"schedule":{"description":"The schedule of when this script will be run.","$ref":"#/definitions/Object102"},"notifications":{"description":"The notifications to send after the script is run.","$ref":"#/definitions/Object103"},"nextRunAt":{"description":"The time of the next scheduled run.","type":"string","format":"time"},"timeZone":{"description":"The time zone of this script.","type":"string"},"targetProjectId":{"description":"Target project to which script outputs will be added.","type":"integer"},"requiredResources":{"description":"Resources to allocate for the container.","$ref":"#/definitions/Object538"},"instanceType":{"description":"The EC2 instance type to deploy to. Only available for jobs running on kubernetes.","type":"string"},"cancelTimeout":{"description":"The amount of time (in seconds) to wait before forcibly terminating the script. When the script is cancelled, it is first sent a TERM signal. If the script is still running after the timeout, it is sent a KILL signal. Defaults to 0.","type":"integer"},"dockerImageTag":{"description":"The tag of the docker image to pull from DockerHub.","type":"string"},"partitionLabel":{"description":"The partition label used to run this object. ","type":"string"},"runningAsId":{"description":"The ID of the runner of this script.","type":"integer"},"source":{"description":"The body/text of the script.","type":"string"}}},"Object558":{"type":"object","properties":{"target":{"description":"Which profile target to use. Ignored when used in conjunction with generate_profiles.","type":"string"},"schema":{"description":"The output schema for dbt to use.","type":"string"},"projectDir":{"description":"The path to dbt_project.yml. Defaults to the root of the repository. Generates 'DBT_PROJECT_DIR' environment variable.","type":"string"},"profilesDir":{"description":"The path to the profiles.yml file to be used by dbt. Ignored when used in conjunction with generate_profiles. Generates 'DBT_PROFILES_DIR' environment variable.","type":"string"},"dbtVersion":{"description":"The version of dbt to use. Generates 'DBT_VERSION' environment variable.","type":"string"},"dbtCommand":{"description":"The primary dbt command to run. Valid commands are build, run, test, compile, and retry.","type":"string"},"dbtCommandLineArgs":{"description":"Additional command line arguments to pass to dbt. Ignored when dbt retry command is selected.","type":"string"},"docsReportId":{"description":"The ID of the HTML report hosting the static dbt docs for this job. Updates every time a run succeeds. This report will be automatically shared with all users who are shared on the job.","type":"string"},"skipDocsGeneration":{"description":"Whether to skip dbt docs generation. If true, the linked docs report will not be updated when the script runs. Defaults to false.","type":"boolean"},"generateProfiles":{"description":"Whether to generate the profiles.yml file when running the script. Defaults to false.","type":"boolean"}}},"Object559":{"type":"object","properties":{"remoteHostId":{"description":"The remote host ID that this script will connect to.","type":"integer"},"credentialId":{"description":"The credential that this script will use.","type":"integer"}},"required":["remoteHostId","credentialId"]},"Object557":{"type":"object","properties":{"name":{"description":"The name of the script.","type":"string"},"parentId":{"description":"The ID of the parent job that will trigger this script","type":"integer"},"userContext":{"description":"\"runner\" or \"author\", who to execute the script as when run as a template.","type":"string"},"params":{"description":"A definition of the parameters this script accepts in the arguments field.","type":"array","items":{"$ref":"#/definitions/Object524"}},"arguments":{"description":"Parameter-value pairs to use when running this script. Only settable if this script has defined parameters.","type":"object"},"schedule":{"description":"The schedule of when this script will be run.","$ref":"#/definitions/Object102"},"notifications":{"description":"The notifications to send after the script is run.","$ref":"#/definitions/Object103"},"nextRunAt":{"description":"The time of the next scheduled run.","type":"string","format":"time"},"timeZone":{"description":"The time zone of this script.","type":"string"},"hidden":{"description":"The hidden status of the item.","type":"boolean"},"targetProjectId":{"description":"Target project to which script outputs will be added.","type":"integer"},"requiredResources":{"description":"Resources to allocate for the container.","$ref":"#/definitions/Object531"},"instanceType":{"description":"The EC2 instance type to deploy to. Only available for jobs running on kubernetes.","type":"string"},"cancelTimeout":{"description":"The amount of time (in seconds) to wait before forcibly terminating the script. When the script is cancelled, it is first sent a TERM signal. If the script is still running after the timeout, it is sent a KILL signal. Defaults to 0.","type":"integer"},"dockerImageTag":{"description":"The tag of the docker image to pull from DockerHub.","type":"string"},"partitionLabel":{"description":"The partition label used to run this object. ","type":"string"},"runningAsId":{"description":"The ID of the runner of this script.","type":"integer"},"dbtProject":{"description":"Configuration for this dbt script.","$ref":"#/definitions/Object558"},"repoHttpUri":{"description":"The URL of the git repository (e.g., https://github.com/organization/repo_name.git).","type":"string"},"repoRef":{"description":"A git reference specifying an unambiguous version of the file. Can be a branch name, a tag, or the full or shortened SHA of a commit. Defaults to 'main'.","type":"string"},"targetDatabase":{"description":"The database to connect to.","$ref":"#/definitions/Object559"}},"required":["name","repoHttpUri"]},"Object561":{"type":"object","properties":{"target":{"description":"Which profile target to use. Ignored when used in conjunction with generate_profiles.","type":"string"},"schema":{"description":"The output schema for dbt to use.","type":"string"},"projectDir":{"description":"The path to dbt_project.yml. Defaults to the root of the repository. Generates 'DBT_PROJECT_DIR' environment variable.","type":"string"},"profilesDir":{"description":"The path to the profiles.yml file to be used by dbt. Ignored when used in conjunction with generate_profiles. Generates 'DBT_PROFILES_DIR' environment variable.","type":"string"},"dbtVersion":{"description":"The version of dbt to use. Generates 'DBT_VERSION' environment variable.","type":"string"},"dbtCommand":{"description":"The primary dbt command to run. Valid commands are build, run, test, compile, and retry.","type":"string"},"dbtCommandLineArgs":{"description":"Additional command line arguments to pass to dbt. Ignored when dbt retry command is selected.","type":"string"},"docsReportId":{"description":"The ID of the HTML report hosting the static dbt docs for this job. Updates every time a run succeeds. This report will be automatically shared with all users who are shared on the job.","type":"string"},"skipDocsGeneration":{"description":"Whether to skip dbt docs generation. If true, the linked docs report will not be updated when the script runs. Defaults to false.","type":"boolean"},"generateProfiles":{"description":"Whether to generate the profiles.yml file when running the script. Defaults to false.","type":"boolean"}}},"Object562":{"type":"object","properties":{"remoteHostId":{"description":"The remote host ID that this script will connect to.","type":"integer"},"credentialId":{"description":"The credential that this script will use.","type":"integer"}}},"Object560":{"type":"object","properties":{"id":{"description":"The ID for the script.","type":"integer"},"name":{"description":"The name of the script.","type":"string"},"type":{"description":"The type of the script (e.g SQL, Container, Python, R, JavaScript, dbt)","type":"string"},"createdAt":{"description":"The time this script was created.","type":"string","format":"time"},"updatedAt":{"description":"The time the script was last updated.","type":"string","format":"time"},"author":{"description":"The author/owner of the item.","$ref":"#/definitions/Object33"},"state":{"description":"The status of the script's last run.","type":"string"},"finishedAt":{"description":"The time that the script's last run finished.","type":"string","format":"time"},"category":{"description":"The category of the script.","type":"string"},"projects":{"description":"A list of projects containing the script.","type":"array","items":{"$ref":"#/definitions/Object526"}},"parentId":{"description":"The ID of the parent job that will trigger this script","type":"integer"},"userContext":{"description":"\"runner\" or \"author\", who to execute the script as when run as a template.","type":"string"},"params":{"description":"A definition of the parameters this script accepts in the arguments field.","type":"array","items":{"$ref":"#/definitions/Object527"}},"arguments":{"description":"Parameter-value pairs to use when running this script. Only settable if this script has defined parameters.","type":"object"},"isTemplate":{"description":"Whether others scripts use this one as a template.","type":"boolean"},"publishedAsTemplateId":{"description":"The ID of the template that this script is backing.","type":"integer"},"fromTemplateId":{"description":"The ID of the template this script uses, if any.","type":"integer"},"templateDependentsCount":{"description":"How many other scripts use this one as a template.","type":"integer"},"templateScriptName":{"description":"The name of the template script.","type":"string"},"links":{"description":"Useful links for this script.","$ref":"#/definitions/Object528"},"schedule":{"description":"The schedule of when this script will be run.","$ref":"#/definitions/Object107"},"notifications":{"description":"The notifications to send after the script is run.","$ref":"#/definitions/Object108"},"runningAs":{"description":"The user this job will run as, defaults to the author of the job.","$ref":"#/definitions/Object33"},"nextRunAt":{"description":"The time of the next scheduled run.","type":"string","format":"time"},"timeZone":{"description":"The time zone of this script.","type":"string"},"lastRun":{"description":"The last run of this script.","$ref":"#/definitions/Object75"},"myPermissionLevel":{"description":"Your permission level on the object. One of \"read\", \"write\", or \"manage\".","type":"string"},"hidden":{"description":"The hidden status of the item.","type":"boolean"},"targetProjectId":{"description":"Target project to which script outputs will be added.","type":"integer"},"archived":{"description":"The archival status of the requested item(s).","type":"string"},"requiredResources":{"description":"Resources to allocate for the container.","$ref":"#/definitions/Object534"},"instanceType":{"description":"The EC2 instance type to deploy to. Only available for jobs running on kubernetes.","type":"string"},"cancelTimeout":{"description":"The amount of time (in seconds) to wait before forcibly terminating the script. When the script is cancelled, it is first sent a TERM signal. If the script is still running after the timeout, it is sent a KILL signal. Defaults to 0.","type":"integer"},"dockerImageTag":{"description":"The tag of the docker image to pull from DockerHub.","type":"string"},"partitionLabel":{"description":"The partition label used to run this object. ","type":"string"},"runningAsId":{"description":"The ID of the runner of this script.","type":"integer"},"dbtProject":{"description":"Configuration for this dbt script.","$ref":"#/definitions/Object561"},"repoHttpUri":{"description":"The URL of the git repository (e.g., https://github.com/organization/repo_name.git).","type":"string"},"repoRef":{"description":"A git reference specifying an unambiguous version of the file. Can be a branch name, a tag, or the full or shortened SHA of a commit. Defaults to 'main'.","type":"string"},"targetDatabase":{"description":"The database to connect to.","$ref":"#/definitions/Object562"}}},"Object563":{"type":"object","properties":{"name":{"description":"The name of the script.","type":"string"},"parentId":{"description":"The ID of the parent job that will trigger this script","type":"integer"},"userContext":{"description":"\"runner\" or \"author\", who to execute the script as when run as a template.","type":"string"},"params":{"description":"A definition of the parameters this script accepts in the arguments field.","type":"array","items":{"$ref":"#/definitions/Object524"}},"arguments":{"description":"Parameter-value pairs to use when running this script. Only settable if this script has defined parameters.","type":"object"},"schedule":{"description":"The schedule of when this script will be run.","$ref":"#/definitions/Object102"},"notifications":{"description":"The notifications to send after the script is run.","$ref":"#/definitions/Object103"},"nextRunAt":{"description":"The time of the next scheduled run.","type":"string","format":"time"},"timeZone":{"description":"The time zone of this script.","type":"string"},"targetProjectId":{"description":"Target project to which script outputs will be added.","type":"integer"},"requiredResources":{"description":"Resources to allocate for the container.","$ref":"#/definitions/Object531"},"instanceType":{"description":"The EC2 instance type to deploy to. Only available for jobs running on kubernetes.","type":"string"},"cancelTimeout":{"description":"The amount of time (in seconds) to wait before forcibly terminating the script. When the script is cancelled, it is first sent a TERM signal. If the script is still running after the timeout, it is sent a KILL signal. Defaults to 0.","type":"integer"},"dockerImageTag":{"description":"The tag of the docker image to pull from DockerHub.","type":"string"},"partitionLabel":{"description":"The partition label used to run this object. ","type":"string"},"runningAsId":{"description":"The ID of the runner of this script.","type":"integer"},"dbtProject":{"description":"Configuration for this dbt script.","$ref":"#/definitions/Object558"},"repoHttpUri":{"description":"The URL of the git repository (e.g., https://github.com/organization/repo_name.git).","type":"string"},"repoRef":{"description":"A git reference specifying an unambiguous version of the file. Can be a branch name, a tag, or the full or shortened SHA of a commit. Defaults to 'main'.","type":"string"},"targetDatabase":{"description":"The database to connect to.","$ref":"#/definitions/Object559"}},"required":["name","repoHttpUri"]},"Object565":{"type":"object","properties":{"remoteHostId":{"description":"The remote host ID that this script will connect to.","type":"integer"},"credentialId":{"description":"The credential that this script will use.","type":"integer"}}},"Object564":{"type":"object","properties":{"name":{"description":"The name of the script.","type":"string"},"parentId":{"description":"The ID of the parent job that will trigger this script","type":"integer"},"userContext":{"description":"\"runner\" or \"author\", who to execute the script as when run as a template.","type":"string"},"params":{"description":"A definition of the parameters this script accepts in the arguments field.","type":"array","items":{"$ref":"#/definitions/Object537"}},"arguments":{"description":"Parameter-value pairs to use when running this script. Only settable if this script has defined parameters.","type":"object"},"schedule":{"description":"The schedule of when this script will be run.","$ref":"#/definitions/Object102"},"notifications":{"description":"The notifications to send after the script is run.","$ref":"#/definitions/Object103"},"nextRunAt":{"description":"The time of the next scheduled run.","type":"string","format":"time"},"timeZone":{"description":"The time zone of this script.","type":"string"},"targetProjectId":{"description":"Target project to which script outputs will be added.","type":"integer"},"requiredResources":{"description":"Resources to allocate for the container.","$ref":"#/definitions/Object538"},"instanceType":{"description":"The EC2 instance type to deploy to. Only available for jobs running on kubernetes.","type":"string"},"cancelTimeout":{"description":"The amount of time (in seconds) to wait before forcibly terminating the script. When the script is cancelled, it is first sent a TERM signal. If the script is still running after the timeout, it is sent a KILL signal. Defaults to 0.","type":"integer"},"dockerImageTag":{"description":"The tag of the docker image to pull from DockerHub.","type":"string"},"partitionLabel":{"description":"The partition label used to run this object. ","type":"string"},"runningAsId":{"description":"The ID of the runner of this script.","type":"integer"},"dbtProject":{"description":"Configuration for this dbt script.","$ref":"#/definitions/Object558"},"repoHttpUri":{"description":"The URL of the git repository (e.g., https://github.com/organization/repo_name.git).","type":"string"},"repoRef":{"description":"A git reference specifying an unambiguous version of the file. Can be a branch name, a tag, or the full or shortened SHA of a commit. Defaults to 'main'.","type":"string"},"targetDatabase":{"description":"The database to connect to.","$ref":"#/definitions/Object565"}}},"Object566":{"type":"object","properties":{"name":{"description":"The name of the script.","type":"string"},"parentId":{"description":"The ID of the parent job that will trigger this script","type":"integer"},"userContext":{"description":"\"runner\" or \"author\", who to execute the script as when run as a template.","type":"string"},"params":{"description":"A definition of the parameters this script accepts in the arguments field.","type":"array","items":{"$ref":"#/definitions/Object524"}},"arguments":{"description":"Parameter-value pairs to use when running this script. Only settable if this script has defined parameters.","type":"object"},"schedule":{"description":"The schedule of when this script will be run.","$ref":"#/definitions/Object102"},"notifications":{"description":"The notifications to send after the script is run.","$ref":"#/definitions/Object103"},"nextRunAt":{"description":"The time of the next scheduled run.","type":"string","format":"time"},"timeZone":{"description":"The time zone of this script.","type":"string"},"hidden":{"description":"The hidden status of the item.","type":"boolean"},"targetProjectId":{"description":"Target project to which script outputs will be added.","type":"integer"},"source":{"description":"The body/text of the script.","type":"string"},"remoteHostId":{"description":"The remote host ID that this script will connect to.","type":"integer"},"credentialId":{"description":"The credential that this script will use.","type":"integer"},"runningAsId":{"description":"The ID of the runner of this script.","type":"integer"}},"required":["name","source","remoteHostId","credentialId"]},"Object567":{"type":"object","properties":{"id":{"description":"The ID for the script.","type":"integer"},"name":{"description":"The name of the script.","type":"string"},"type":{"description":"The type of the script (e.g SQL, Container, Python, R, JavaScript, dbt)","type":"string"},"createdAt":{"description":"The time this script was created.","type":"string","format":"time"},"updatedAt":{"description":"The time the script was last updated.","type":"string","format":"time"},"author":{"description":"The author/owner of the item.","$ref":"#/definitions/Object33"},"state":{"description":"The status of the script's last run.","type":"string"},"finishedAt":{"description":"The time that the script's last run finished.","type":"string","format":"time"},"category":{"description":"The category of the script.","type":"string"},"projects":{"description":"A list of projects containing the script.","type":"array","items":{"$ref":"#/definitions/Object526"}},"parentId":{"description":"The ID of the parent job that will trigger this script","type":"integer"},"userContext":{"description":"\"runner\" or \"author\", who to execute the script as when run as a template.","type":"string"},"params":{"description":"A definition of the parameters this script accepts in the arguments field.","type":"array","items":{"$ref":"#/definitions/Object527"}},"arguments":{"description":"Parameter-value pairs to use when running this script. Only settable if this script has defined parameters.","type":"object"},"isTemplate":{"description":"Whether others scripts use this one as a template.","type":"boolean"},"publishedAsTemplateId":{"description":"The ID of the template that this script is backing.","type":"integer"},"fromTemplateId":{"description":"The ID of the template this script uses, if any.","type":"integer"},"templateDependentsCount":{"description":"How many other scripts use this one as a template.","type":"integer"},"templateScriptName":{"description":"The name of the template script.","type":"string"},"links":{"description":"Useful links for this script.","$ref":"#/definitions/Object528"},"schedule":{"description":"The schedule of when this script will be run.","$ref":"#/definitions/Object107"},"notifications":{"description":"The notifications to send after the script is run.","$ref":"#/definitions/Object108"},"runningAs":{"description":"The user this job will run as, defaults to the author of the job.","$ref":"#/definitions/Object33"},"nextRunAt":{"description":"The time of the next scheduled run.","type":"string","format":"time"},"timeZone":{"description":"The time zone of this script.","type":"string"},"lastRun":{"description":"The last run of this script.","$ref":"#/definitions/Object75"},"myPermissionLevel":{"description":"Your permission level on the object. One of \"read\", \"write\", or \"manage\".","type":"string"},"hidden":{"description":"The hidden status of the item.","type":"boolean"},"targetProjectId":{"description":"Target project to which script outputs will be added.","type":"integer"},"archived":{"description":"The archival status of the requested item(s).","type":"string"},"source":{"description":"The body/text of the script.","type":"string"},"remoteHostId":{"description":"The remote host ID that this script will connect to.","type":"integer"},"credentialId":{"description":"The credential that this script will use.","type":"integer"},"runningAsId":{"description":"The ID of the runner of this script.","type":"integer"}}},"Object568":{"type":"object","properties":{"name":{"description":"The name of the script.","type":"string"},"parentId":{"description":"The ID of the parent job that will trigger this script","type":"integer"},"userContext":{"description":"\"runner\" or \"author\", who to execute the script as when run as a template.","type":"string"},"params":{"description":"A definition of the parameters this script accepts in the arguments field.","type":"array","items":{"$ref":"#/definitions/Object524"}},"arguments":{"description":"Parameter-value pairs to use when running this script. Only settable if this script has defined parameters.","type":"object"},"schedule":{"description":"The schedule of when this script will be run.","$ref":"#/definitions/Object102"},"notifications":{"description":"The notifications to send after the script is run.","$ref":"#/definitions/Object103"},"nextRunAt":{"description":"The time of the next scheduled run.","type":"string","format":"time"},"timeZone":{"description":"The time zone of this script.","type":"string"},"targetProjectId":{"description":"Target project to which script outputs will be added.","type":"integer"},"source":{"description":"The body/text of the script.","type":"string"},"remoteHostId":{"description":"The remote host ID that this script will connect to.","type":"integer"},"credentialId":{"description":"The credential that this script will use.","type":"integer"},"runningAsId":{"description":"The ID of the runner of this script.","type":"integer"}},"required":["name","source","remoteHostId","credentialId"]},"Object569":{"type":"object","properties":{"name":{"description":"The name of the script.","type":"string"},"parentId":{"description":"The ID of the parent job that will trigger this script","type":"integer"},"userContext":{"description":"\"runner\" or \"author\", who to execute the script as when run as a template.","type":"string"},"params":{"description":"A definition of the parameters this script accepts in the arguments field.","type":"array","items":{"$ref":"#/definitions/Object537"}},"arguments":{"description":"Parameter-value pairs to use when running this script. Only settable if this script has defined parameters.","type":"object"},"schedule":{"description":"The schedule of when this script will be run.","$ref":"#/definitions/Object102"},"notifications":{"description":"The notifications to send after the script is run.","$ref":"#/definitions/Object103"},"nextRunAt":{"description":"The time of the next scheduled run.","type":"string","format":"time"},"timeZone":{"description":"The time zone of this script.","type":"string"},"targetProjectId":{"description":"Target project to which script outputs will be added.","type":"integer"},"source":{"description":"The body/text of the script.","type":"string"},"remoteHostId":{"description":"The remote host ID that this script will connect to.","type":"integer"},"credentialId":{"description":"The credential that this script will use.","type":"integer"},"runningAsId":{"description":"The ID of the runner of this script.","type":"integer"}}},"Object570":{"type":"object","properties":{"id":{"description":"The ID for the script.","type":"integer"},"name":{"description":"The name of the script.","type":"string"},"type":{"description":"The type of the script (e.g Custom)","type":"string"},"backingScriptType":{"description":"The type of the script backing this template (e.g Python)","type":"string"},"createdAt":{"description":"The time this script was created.","type":"string","format":"time"},"updatedAt":{"description":"The time the script was last updated.","type":"string","format":"time"},"author":{"description":"The author/owner of the item.","$ref":"#/definitions/Object33"},"state":{"description":"The status of the script's last run.","type":"string"},"finishedAt":{"description":"The time that the script's last run finished.","type":"string","format":"time"},"projects":{"description":"A list of projects containing the script.","type":"array","items":{"$ref":"#/definitions/Object526"}},"parentId":{"description":"The ID of the parent job that will trigger this script","type":"integer"},"fromTemplateId":{"description":"The ID of the template script.","type":"integer"},"timeZone":{"description":"The time zone of this script.","type":"string"},"lastRun":{"description":"The last run of this script.","$ref":"#/definitions/Object75"},"archived":{"description":"The archival status of the requested item(s).","type":"string"},"lastSuccessfulRun":{"description":"The last successful run of this script.","$ref":"#/definitions/Object75"}}},"Object572":{"type":"object","properties":{"cpu":{"description":"The number of CPU shares to allocate for the container. Each core has 1000 shares.","type":"integer"},"memory":{"description":"The amount of RAM to allocate for the container (in MB).","type":"integer"},"diskSpace":{"description":"The amount of disk space, in GB, to allocate for the container. This space will be used to hold the git repo configured for the container and anything your container writes to /tmp or /data. Fractional values (e.g. 0.25) are supported.","type":"number","format":"float"}}},"Object571":{"type":"object","properties":{"name":{"description":"The name of the script.","type":"string"},"parentId":{"description":"The ID of the parent job that will trigger this script","type":"integer"},"arguments":{"description":"Parameter-value pairs to use when running this script. Only settable if this script has defined parameters.","type":"object"},"fromTemplateId":{"description":"The ID of the template script.","type":"integer"},"remoteHostId":{"description":"The remote host ID that this script will connect to.","type":"integer"},"credentialId":{"description":"The credential that this script will use.","type":"integer"},"schedule":{"description":"The schedule of when this script will be run.","$ref":"#/definitions/Object102"},"notifications":{"description":"The notifications to send after the script is run.","$ref":"#/definitions/Object103"},"timeZone":{"description":"The time zone of this script.","type":"string"},"hidden":{"description":"The hidden status of the item.","type":"boolean"},"targetProjectId":{"description":"Target project to which script outputs will be added.","type":"integer"},"requiredResources":{"description":"Resources to allocate for the container.If set, overrides the required resources on the template backing script.Only applicable for jobs using Docker.","$ref":"#/definitions/Object572"},"partitionLabel":{"description":"The partition label used to run this object. Only applicable for jobs using Docker.","type":"string"},"runningAsId":{"description":"The ID of the runner of this script.","type":"integer"}},"required":["fromTemplateId"]},"Object574":{"type":"object","properties":{"cpu":{"description":"The number of CPU shares to allocate for the container. Each core has 1000 shares.","type":"integer"},"memory":{"description":"The amount of RAM to allocate for the container (in MB).","type":"integer"},"diskSpace":{"description":"The amount of disk space, in GB, to allocate for the container. This space will be used to hold the git repo configured for the container and anything your container writes to /tmp or /data. Fractional values (e.g. 0.25) are supported.","type":"number","format":"float"}}},"Object573":{"type":"object","properties":{"id":{"description":"The ID for the script.","type":"integer"},"fromTemplateAliases":{"description":"An array of the aliases of the template script.","type":"array","items":{"$ref":"#/definitions/Object533"}},"name":{"description":"The name of the script.","type":"string"},"type":{"description":"The type of the script (e.g Custom)","type":"string"},"backingScriptType":{"description":"The type of the script backing this template (e.g Python)","type":"string"},"createdAt":{"description":"The time this script was created.","type":"string","format":"time"},"updatedAt":{"description":"The time the script was last updated.","type":"string","format":"time"},"author":{"description":"The author/owner of the item.","$ref":"#/definitions/Object33"},"state":{"description":"The status of the script's last run.","type":"string"},"finishedAt":{"description":"The time that the script's last run finished.","type":"string","format":"time"},"category":{"type":"string"},"projects":{"description":"A list of projects containing the script.","type":"array","items":{"$ref":"#/definitions/Object526"}},"parentId":{"description":"The ID of the parent job that will trigger this script","type":"integer"},"params":{"description":"A definition of the parameters this script accepts in the arguments field.","type":"array","items":{"$ref":"#/definitions/Object527"}},"arguments":{"description":"Parameter-value pairs to use when running this script. Only settable if this script has defined parameters.","type":"object"},"isTemplate":{"description":"Whether others scripts use this one as a template.","type":"boolean"},"publishedAsTemplateId":{"description":"The ID of the template that this script is backing.","type":"integer"},"fromTemplateId":{"description":"The ID of the template script.","type":"integer"},"uiReportUrl":{"description":"The url of the custom HTML.","type":"integer"},"uiReportId":{"description":"The id of the report with the custom HTML.","type":"integer"},"uiReportProvideAPIKey":{"description":"Whether the ui report requests an API Key from the report viewer.","type":"boolean"},"templateScriptName":{"description":"The name of the template script.","type":"string"},"templateNote":{"description":"The template's note.","type":"string"},"remoteHostId":{"description":"The remote host ID that this script will connect to.","type":"integer"},"credentialId":{"description":"The credential that this script will use.","type":"integer"},"codePreview":{"description":"The code that this script will run with arguments inserted.","type":"string"},"schedule":{"description":"The schedule of when this script will be run.","$ref":"#/definitions/Object107"},"notifications":{"description":"The notifications to send after the script is run.","$ref":"#/definitions/Object108"},"runningAs":{"description":"The user this job will run as, defaults to the author of the job.","$ref":"#/definitions/Object33"},"timeZone":{"description":"The time zone of this script.","type":"string"},"lastRun":{"description":"The last run of this script.","$ref":"#/definitions/Object75"},"myPermissionLevel":{"description":"Your permission level on the object. One of \"read\", \"write\", or \"manage\".","type":"string"},"hidden":{"description":"The hidden status of the item.","type":"boolean"},"archived":{"description":"The archival status of the requested item(s).","type":"string"},"targetProjectId":{"description":"Target project to which script outputs will be added.","type":"integer"},"lastSuccessfulRun":{"description":"The last successful run of this script.","$ref":"#/definitions/Object75"},"requiredResources":{"description":"Resources to allocate for the container.If set, overrides the required resources on the template backing script.Only applicable for jobs using Docker.","$ref":"#/definitions/Object574"},"partitionLabel":{"description":"The partition label used to run this object. Only applicable for jobs using Docker.","type":"string"},"runningAsId":{"description":"The ID of the runner of this script.","type":"integer"}}},"Object575":{"type":"object","properties":{"name":{"description":"The name of the script.","type":"string"},"parentId":{"description":"The ID of the parent job that will trigger this script","type":"integer"},"arguments":{"description":"Parameter-value pairs to use when running this script. Only settable if this script has defined parameters.","type":"object"},"remoteHostId":{"description":"The remote host ID that this script will connect to.","type":"integer"},"credentialId":{"description":"The credential that this script will use.","type":"integer"},"schedule":{"description":"The schedule of when this script will be run.","$ref":"#/definitions/Object102"},"notifications":{"description":"The notifications to send after the script is run.","$ref":"#/definitions/Object103"},"timeZone":{"description":"The time zone of this script.","type":"string"},"targetProjectId":{"description":"Target project to which script outputs will be added.","type":"integer"},"requiredResources":{"description":"Resources to allocate for the container.If set, overrides the required resources on the template backing script.Only applicable for jobs using Docker.","$ref":"#/definitions/Object572"},"partitionLabel":{"description":"The partition label used to run this object. Only applicable for jobs using Docker.","type":"string"},"runningAsId":{"description":"The ID of the runner of this script.","type":"integer"}}},"Object576":{"type":"object","properties":{"id":{"description":"The ID for the script.","type":"integer"},"name":{"description":"The name of the script.","type":"string"},"type":{"description":"The type of script.","type":"string"},"createdAt":{"description":"The time this script was created.","type":"string","format":"time"},"updatedAt":{"description":"The time this script was last updated.","type":"string","format":"time"},"author":{"description":"The author/owner of the item.","$ref":"#/definitions/Object33"},"state":{"description":"The status of the script's last run.","type":"string"},"finishedAt":{"description":"The time that the script's last run finished.","type":"string","format":"time"},"category":{"description":"The category of the script.","type":"string"},"projects":{"description":"A list of projects containing the script.","type":"array","items":{"$ref":"#/definitions/Object526"}},"parentId":{"description":"The ID of the parent job that will trigger this script","type":"integer"},"userContext":{"description":"\"runner\" or \"author\", who to execute the script as when run as a template.","type":"string"},"params":{"description":"A definition of the parameters this script accepts in the arguments field.","type":"array","items":{"$ref":"#/definitions/Object527"}},"arguments":{"description":"Parameter-value pairs to use when running this script. Only settable if this script has defined parameters.","type":"object"},"isTemplate":{"description":"Whether others scripts use this one as a template.","type":"boolean"},"publishedAsTemplateId":{"description":"The ID of the template that this script is backing.","type":"integer"},"fromTemplateId":{"description":"The ID of the template this script uses, if any.","type":"integer"},"templateDependentsCount":{"description":"How many other scripts use this one as a template.","type":"integer"},"templateScriptName":{"description":"The name of the template script.","type":"string"},"links":{"description":"Useful links for this script.","$ref":"#/definitions/Object528"},"schedule":{"description":"The schedule of when this script will be run.","$ref":"#/definitions/Object107"},"notifications":{"description":"The notifications to send after the script is run.","$ref":"#/definitions/Object108"},"runningAs":{"description":"The user this job will run as, defaults to the author of the job.","$ref":"#/definitions/Object33"},"nextRunAt":{"description":"The time of the next scheduled run.","type":"string","format":"time"},"timeZone":{"description":"The time zone of this script.","type":"string"},"lastRun":{"description":"The last run of this script.","$ref":"#/definitions/Object75"},"myPermissionLevel":{"description":"Your permission level on the object. One of \"read\", \"write\", or \"manage\".","type":"string"},"hidden":{"description":"The hidden status of the item.","type":"boolean"},"targetProjectId":{"description":"Target project to which script outputs will be added.","type":"integer"},"archived":{"description":"The archival status of the requested item(s).","type":"string"},"sql":{"description":"The raw SQL query for the script.","type":"string"},"expandedArguments":{"description":"Expanded arguments for use in injecting into different environments.","type":"object"},"templateScriptId":{"description":"The ID of the template script, if any.","type":"integer"}}},"Object577":{"type":"object","properties":{"id":{"description":"The ID of the run.","type":"integer"},"sqlId":{"description":"The ID of the SQL job.","type":"integer"},"state":{"description":"The state of the run, one of 'queued' 'running' 'succeeded' 'failed' or 'cancelled'.","type":"string"},"isCancelRequested":{"description":"True if run cancel requested, else false.","type":"boolean"},"createdAt":{"description":"The time the run was created.","type":"string","format":"time"},"startedAt":{"description":"The time the run started at.","type":"string","format":"time"},"finishedAt":{"description":"The time the run completed.","type":"string","format":"time"},"error":{"description":"The error, if any, returned by the run.","type":"string"},"output":{"description":"A list of the outputs of this script.","type":"array","items":{"$ref":"#/definitions/Object522"}},"outputCachedOn":{"description":"The time that the output was originally exported, if a cache entry was used by the run.","type":"string","format":"time"}}},"Object578":{"type":"object","properties":{"id":{"description":"The ID of the run.","type":"integer"},"containerId":{"description":"The ID of the Container job.","type":"integer"},"state":{"description":"The state of the run, one of 'queued' 'running' 'succeeded' 'failed' or 'cancelled'.","type":"string"},"isCancelRequested":{"description":"True if run cancel requested, else false.","type":"boolean"},"createdAt":{"description":"The time the run was created.","type":"string","format":"time"},"startedAt":{"description":"The time the run started at.","type":"string","format":"time"},"finishedAt":{"description":"The time the run completed.","type":"string","format":"time"},"error":{"description":"The error, if any, returned by the run.","type":"string"},"maxMemoryUsage":{"description":"If the run has finished, the maximum amount of memory used during the run, in MB.","type":"number","format":"float"},"maxCpuUsage":{"description":"If the run has finished, the maximum amount of cpu used during the run, in millicores.","type":"number","format":"float"}}},"Object579":{"type":"object","properties":{"id":{"description":"The ID of the run.","type":"integer"},"pythonId":{"description":"The ID of the Python job.","type":"integer"},"state":{"description":"The state of the run, one of 'queued' 'running' 'succeeded' 'failed' or 'cancelled'.","type":"string"},"isCancelRequested":{"description":"True if run cancel requested, else false.","type":"boolean"},"createdAt":{"description":"The time the run was created.","type":"string","format":"time"},"startedAt":{"description":"The time the run started at.","type":"string","format":"time"},"finishedAt":{"description":"The time the run completed.","type":"string","format":"time"},"error":{"description":"The error, if any, returned by the run.","type":"string"},"maxMemoryUsage":{"description":"If the run has finished, the maximum amount of memory used during the run, in MB.","type":"number","format":"float"},"maxCpuUsage":{"description":"If the run has finished, the maximum amount of cpu used during the run, in millicores.","type":"number","format":"float"}}},"Object580":{"type":"object","properties":{"id":{"description":"The ID of the run.","type":"integer"},"rId":{"description":"The ID of the R job.","type":"integer"},"state":{"description":"The state of the run, one of 'queued' 'running' 'succeeded' 'failed' or 'cancelled'.","type":"string"},"isCancelRequested":{"description":"True if run cancel requested, else false.","type":"boolean"},"createdAt":{"description":"The time the run was created.","type":"string","format":"time"},"startedAt":{"description":"The time the run started at.","type":"string","format":"time"},"finishedAt":{"description":"The time the run completed.","type":"string","format":"time"},"error":{"description":"The error, if any, returned by the run.","type":"string"},"maxMemoryUsage":{"description":"If the run has finished, the maximum amount of memory used during the run, in MB.","type":"number","format":"float"},"maxCpuUsage":{"description":"If the run has finished, the maximum amount of cpu used during the run, in millicores.","type":"number","format":"float"}}},"Object581":{"type":"object","properties":{"id":{"description":"The ID of the run.","type":"integer"},"dbtId":{"description":"The ID of the dbt job.","type":"integer"},"state":{"description":"The state of the run, one of 'queued' 'running' 'succeeded' 'failed' or 'cancelled'.","type":"string"},"isCancelRequested":{"description":"True if run cancel requested, else false.","type":"boolean"},"createdAt":{"description":"The time the run was created.","type":"string","format":"time"},"startedAt":{"description":"The time the run started at.","type":"string","format":"time"},"finishedAt":{"description":"The time the run completed.","type":"string","format":"time"},"error":{"description":"The error, if any, returned by the run.","type":"string"},"maxMemoryUsage":{"description":"If the run has finished, the maximum amount of memory used during the run, in MB.","type":"number","format":"float"},"maxCpuUsage":{"description":"If the run has finished, the maximum amount of cpu used during the run, in millicores.","type":"number","format":"float"}}},"Object582":{"type":"object","properties":{"id":{"description":"The ID of the run.","type":"integer"},"javascriptId":{"description":"The ID of the Javascript job.","type":"integer"},"state":{"description":"The state of the run, one of 'queued' 'running' 'succeeded' 'failed' or 'cancelled'.","type":"string"},"isCancelRequested":{"description":"True if run cancel requested, else false.","type":"boolean"},"createdAt":{"description":"The time the run was created.","type":"string","format":"time"},"startedAt":{"description":"The time the run started at.","type":"string","format":"time"},"finishedAt":{"description":"The time the run completed.","type":"string","format":"time"},"error":{"description":"The error, if any, returned by the run.","type":"string"}}},"Object583":{"type":"object","properties":{"id":{"description":"The ID of the run.","type":"integer"},"customId":{"description":"The ID of the Custom job.","type":"integer"},"state":{"description":"The state of the run, one of 'queued' 'running' 'succeeded' 'failed' or 'cancelled'.","type":"string"},"isCancelRequested":{"description":"True if run cancel requested, else false.","type":"boolean"},"createdAt":{"description":"The time the run was created.","type":"string","format":"time"},"startedAt":{"description":"The time the run started at.","type":"string","format":"time"},"finishedAt":{"description":"The time the run completed.","type":"string","format":"time"},"error":{"description":"The error, if any, returned by the run.","type":"string"},"maxMemoryUsage":{"description":"If the run has finished, the maximum amount of memory used during the run, in MB. Only available if the backing script is a Python, R, or container script.","type":"number","format":"float"},"maxCpuUsage":{"description":"If the run has finished, the maximum amount of cpu used during the run, in millicores. Only available if the backing script is a Python, R, or container script.","type":"number","format":"float"}}},"Object584":{"type":"object","properties":{"objectType":{"description":"The type of the output. Valid values are File, Table, Report, Project, Credential, or JSONValue","type":"string"},"objectId":{"description":"The ID of the output.","type":"integer"},"name":{"description":"The name of the output.","type":"string"},"link":{"description":"The hypermedia link to the output.","type":"string"},"value":{"type":"string"}}},"Object585":{"type":"object","properties":{"objectType":{"description":"The type of the output. Valid values are File, Table, Report, Project, Credential, or JSONValue","type":"string"},"objectId":{"description":"The ID of the output.","type":"integer"},"name":{"description":"The name of the output.","type":"string"},"link":{"description":"The hypermedia link to the output.","type":"string"},"value":{"type":"string"}}},"Object586":{"type":"object","properties":{"objectType":{"description":"The type of the output. Valid values are File, Table, Report, Project, Credential, or JSONValue","type":"string"},"objectId":{"description":"The ID of the output.","type":"integer"}},"required":["objectType","objectId"]},"Object587":{"type":"object","properties":{"objectType":{"description":"The type of the output. Valid values are File, Table, Report, Project, Credential, or JSONValue","type":"string"},"objectId":{"description":"The ID of the output.","type":"integer"},"name":{"description":"The name of the output.","type":"string"},"link":{"description":"The hypermedia link to the output.","type":"string"},"value":{"type":"string"}}},"Object588":{"type":"object","properties":{"objectType":{"description":"The type of the output. Valid values are File, Table, Report, Project, Credential, or JSONValue","type":"string"},"objectId":{"description":"The ID of the output.","type":"integer"}},"required":["objectType","objectId"]},"Object589":{"type":"object","properties":{"objectType":{"description":"The type of the output. Valid values are File, Table, Report, Project, Credential, or JSONValue","type":"string"},"objectId":{"description":"The ID of the output.","type":"integer"},"name":{"description":"The name of the output.","type":"string"},"link":{"description":"The hypermedia link to the output.","type":"string"},"value":{"type":"string"}}},"Object590":{"type":"object","properties":{"objectType":{"description":"The type of the output. Valid values are File, Table, Report, Project, Credential, or JSONValue","type":"string"},"objectId":{"description":"The ID of the output.","type":"integer"}},"required":["objectType","objectId"]},"Object591":{"type":"object","properties":{"objectType":{"description":"The type of the output. Valid values are File, Table, Report, Project, Credential, or JSONValue","type":"string"},"objectId":{"description":"The ID of the output.","type":"integer"},"name":{"description":"The name of the output.","type":"string"},"link":{"description":"The hypermedia link to the output.","type":"string"},"value":{"type":"string"}}},"Object592":{"type":"object","properties":{"objectType":{"description":"The type of the output. Valid values are File, Table, Report, Project, Credential, or JSONValue","type":"string"},"objectId":{"description":"The ID of the output.","type":"integer"}},"required":["objectType","objectId"]},"Object593":{"type":"object","properties":{"objectType":{"description":"The type of the output. Valid values are File, Table, Report, Project, Credential, or JSONValue","type":"string"},"objectId":{"description":"The ID of the output.","type":"integer"},"name":{"description":"The name of the output.","type":"string"},"link":{"description":"The hypermedia link to the output.","type":"string"},"value":{"type":"string"}}},"Object594":{"type":"object","properties":{"objectType":{"description":"The type of the output. Valid values are File, Table, Report, Project, Credential, or JSONValue","type":"string"},"objectId":{"description":"The ID of the output.","type":"integer"}},"required":["objectType","objectId"]},"Object595":{"type":"object","properties":{"objectType":{"description":"The type of the output. Valid values are File, Table, Report, Project, Credential, or JSONValue","type":"string"},"objectId":{"description":"The ID of the output.","type":"integer"},"name":{"description":"The name of the output.","type":"string"},"link":{"description":"The hypermedia link to the output.","type":"string"},"value":{"type":"string"}}},"Object596":{"type":"object","properties":{"objectType":{"description":"The type of the output. Valid values are File, Table, Report, Project, Credential, or JSONValue","type":"string"},"objectId":{"description":"The ID of the output.","type":"integer"}},"required":["objectType","objectId"]},"Object597":{"type":"object","properties":{"error":{"description":"The error message to update","type":"string"}}},"Object598":{"type":"object","properties":{"error":{"description":"The error message to update","type":"string"}}},"Object599":{"type":"object","properties":{"error":{"description":"The error message to update","type":"string"}}},"Object600":{"type":"object","properties":{"error":{"description":"The error message to update","type":"string"}}},"Object601":{"type":"object","properties":{"error":{"description":"The error message to update","type":"string"}}},"Object602":{"type":"object","properties":{"error":{"description":"The error message to update","type":"string"}}},"Object603":{"type":"object","properties":{"userIds":{"description":"An array of one or more user IDs.","type":"array","items":{"type":"integer"}},"permissionLevel":{"description":"Options are: \"read\", \"write\", or \"manage\".","type":"string"},"shareEmailBody":{"description":"Custom body text for e-mail sent on a share.","type":"string"},"sendSharedEmail":{"description":"Send email to the recipients of a share.","type":"boolean"}},"required":["userIds","permissionLevel"]},"Object604":{"type":"object","properties":{"groupIds":{"description":"An array of one or more group IDs.","type":"array","items":{"type":"integer"}},"permissionLevel":{"description":"Options are: \"read\", \"write\", or \"manage\".","type":"string"},"shareEmailBody":{"description":"Custom body text for e-mail sent on a share.","type":"string"},"sendSharedEmail":{"description":"Send email to the recipients of a share.","type":"boolean"}},"required":["groupIds","permissionLevel"]},"Object605":{"type":"object","properties":{"userId":{"description":"ID of target user","type":"integer"},"includeDependencies":{"description":"Whether or not to give manage permissions on all dependencies","type":"boolean"},"emailBody":{"description":"Custom body text for e-mail sent on transfer.","type":"string"},"sendEmail":{"description":"Send email to the target user of the transfer?","type":"boolean"}},"required":["userId","includeDependencies"]},"Object606":{"type":"object","properties":{"status":{"description":"The desired archived status of the object.","type":"boolean"}},"required":["status"]},"Object607":{"type":"object","properties":{"userIds":{"description":"An array of one or more user IDs.","type":"array","items":{"type":"integer"}},"permissionLevel":{"description":"Options are: \"read\", \"write\", or \"manage\".","type":"string"},"shareEmailBody":{"description":"Custom body text for e-mail sent on a share.","type":"string"},"sendSharedEmail":{"description":"Send email to the recipients of a share.","type":"boolean"}},"required":["userIds","permissionLevel"]},"Object608":{"type":"object","properties":{"groupIds":{"description":"An array of one or more group IDs.","type":"array","items":{"type":"integer"}},"permissionLevel":{"description":"Options are: \"read\", \"write\", or \"manage\".","type":"string"},"shareEmailBody":{"description":"Custom body text for e-mail sent on a share.","type":"string"},"sendSharedEmail":{"description":"Send email to the recipients of a share.","type":"boolean"}},"required":["groupIds","permissionLevel"]},"Object609":{"type":"object","properties":{"userId":{"description":"ID of target user","type":"integer"},"includeDependencies":{"description":"Whether or not to give manage permissions on all dependencies","type":"boolean"},"emailBody":{"description":"Custom body text for e-mail sent on transfer.","type":"string"},"sendEmail":{"description":"Send email to the target user of the transfer?","type":"boolean"}},"required":["userId","includeDependencies"]},"Object610":{"type":"object","properties":{"status":{"description":"The desired archived status of the object.","type":"boolean"}},"required":["status"]},"Object611":{"type":"object","properties":{"userIds":{"description":"An array of one or more user IDs.","type":"array","items":{"type":"integer"}},"permissionLevel":{"description":"Options are: \"read\", \"write\", or \"manage\".","type":"string"},"shareEmailBody":{"description":"Custom body text for e-mail sent on a share.","type":"string"},"sendSharedEmail":{"description":"Send email to the recipients of a share.","type":"boolean"}},"required":["userIds","permissionLevel"]},"Object612":{"type":"object","properties":{"groupIds":{"description":"An array of one or more group IDs.","type":"array","items":{"type":"integer"}},"permissionLevel":{"description":"Options are: \"read\", \"write\", or \"manage\".","type":"string"},"shareEmailBody":{"description":"Custom body text for e-mail sent on a share.","type":"string"},"sendSharedEmail":{"description":"Send email to the recipients of a share.","type":"boolean"}},"required":["groupIds","permissionLevel"]},"Object613":{"type":"object","properties":{"userId":{"description":"ID of target user","type":"integer"},"includeDependencies":{"description":"Whether or not to give manage permissions on all dependencies","type":"boolean"},"emailBody":{"description":"Custom body text for e-mail sent on transfer.","type":"string"},"sendEmail":{"description":"Send email to the target user of the transfer?","type":"boolean"}},"required":["userId","includeDependencies"]},"Object614":{"type":"object","properties":{"status":{"description":"The desired archived status of the object.","type":"boolean"}},"required":["status"]},"Object615":{"type":"object","properties":{"userIds":{"description":"An array of one or more user IDs.","type":"array","items":{"type":"integer"}},"permissionLevel":{"description":"Options are: \"read\", \"write\", or \"manage\".","type":"string"},"shareEmailBody":{"description":"Custom body text for e-mail sent on a share.","type":"string"},"sendSharedEmail":{"description":"Send email to the recipients of a share.","type":"boolean"}},"required":["userIds","permissionLevel"]},"Object616":{"type":"object","properties":{"groupIds":{"description":"An array of one or more group IDs.","type":"array","items":{"type":"integer"}},"permissionLevel":{"description":"Options are: \"read\", \"write\", or \"manage\".","type":"string"},"shareEmailBody":{"description":"Custom body text for e-mail sent on a share.","type":"string"},"sendSharedEmail":{"description":"Send email to the recipients of a share.","type":"boolean"}},"required":["groupIds","permissionLevel"]},"Object617":{"type":"object","properties":{"userId":{"description":"ID of target user","type":"integer"},"includeDependencies":{"description":"Whether or not to give manage permissions on all dependencies","type":"boolean"},"emailBody":{"description":"Custom body text for e-mail sent on transfer.","type":"string"},"sendEmail":{"description":"Send email to the target user of the transfer?","type":"boolean"}},"required":["userId","includeDependencies"]},"Object618":{"type":"object","properties":{"status":{"description":"The desired archived status of the object.","type":"boolean"}},"required":["status"]},"Object619":{"type":"object","properties":{"userIds":{"description":"An array of one or more user IDs.","type":"array","items":{"type":"integer"}},"permissionLevel":{"description":"Options are: \"read\", \"write\", or \"manage\".","type":"string"},"shareEmailBody":{"description":"Custom body text for e-mail sent on a share.","type":"string"},"sendSharedEmail":{"description":"Send email to the recipients of a share.","type":"boolean"}},"required":["userIds","permissionLevel"]},"Object620":{"type":"object","properties":{"groupIds":{"description":"An array of one or more group IDs.","type":"array","items":{"type":"integer"}},"permissionLevel":{"description":"Options are: \"read\", \"write\", or \"manage\".","type":"string"},"shareEmailBody":{"description":"Custom body text for e-mail sent on a share.","type":"string"},"sendSharedEmail":{"description":"Send email to the recipients of a share.","type":"boolean"}},"required":["groupIds","permissionLevel"]},"Object621":{"type":"object","properties":{"userId":{"description":"ID of target user","type":"integer"},"includeDependencies":{"description":"Whether or not to give manage permissions on all dependencies","type":"boolean"},"emailBody":{"description":"Custom body text for e-mail sent on transfer.","type":"string"},"sendEmail":{"description":"Send email to the target user of the transfer?","type":"boolean"}},"required":["userId","includeDependencies"]},"Object622":{"type":"object","properties":{"status":{"description":"The desired archived status of the object.","type":"boolean"}},"required":["status"]},"Object623":{"type":"object","properties":{"userIds":{"description":"An array of one or more user IDs.","type":"array","items":{"type":"integer"}},"permissionLevel":{"description":"Options are: \"read\", \"write\", or \"manage\".","type":"string"},"shareEmailBody":{"description":"Custom body text for e-mail sent on a share.","type":"string"},"sendSharedEmail":{"description":"Send email to the recipients of a share.","type":"boolean"}},"required":["userIds","permissionLevel"]},"Object624":{"type":"object","properties":{"groupIds":{"description":"An array of one or more group IDs.","type":"array","items":{"type":"integer"}},"permissionLevel":{"description":"Options are: \"read\", \"write\", or \"manage\".","type":"string"},"shareEmailBody":{"description":"Custom body text for e-mail sent on a share.","type":"string"},"sendSharedEmail":{"description":"Send email to the recipients of a share.","type":"boolean"}},"required":["groupIds","permissionLevel"]},"Object625":{"type":"object","properties":{"userId":{"description":"ID of target user","type":"integer"},"includeDependencies":{"description":"Whether or not to give manage permissions on all dependencies","type":"boolean"},"emailBody":{"description":"Custom body text for e-mail sent on transfer.","type":"string"},"sendEmail":{"description":"Send email to the target user of the transfer?","type":"boolean"}},"required":["userId","includeDependencies"]},"Object626":{"type":"object","properties":{"status":{"description":"The desired archived status of the object.","type":"boolean"}},"required":["status"]},"Object627":{"type":"object","properties":{"userIds":{"description":"An array of one or more user IDs.","type":"array","items":{"type":"integer"}},"permissionLevel":{"description":"Options are: \"read\", \"write\", or \"manage\".","type":"string"},"shareEmailBody":{"description":"Custom body text for e-mail sent on a share.","type":"string"},"sendSharedEmail":{"description":"Send email to the recipients of a share.","type":"boolean"}},"required":["userIds","permissionLevel"]},"Object628":{"type":"object","properties":{"groupIds":{"description":"An array of one or more group IDs.","type":"array","items":{"type":"integer"}},"permissionLevel":{"description":"Options are: \"read\", \"write\", or \"manage\".","type":"string"},"shareEmailBody":{"description":"Custom body text for e-mail sent on a share.","type":"string"},"sendSharedEmail":{"description":"Send email to the recipients of a share.","type":"boolean"}},"required":["groupIds","permissionLevel"]},"Object629":{"type":"object","properties":{"userId":{"description":"ID of target user","type":"integer"},"includeDependencies":{"description":"Whether or not to give manage permissions on all dependencies","type":"boolean"},"emailBody":{"description":"Custom body text for e-mail sent on transfer.","type":"string"},"sendEmail":{"description":"Send email to the target user of the transfer?","type":"boolean"}},"required":["userId","includeDependencies"]},"Object630":{"type":"object","properties":{"status":{"description":"The desired archived status of the object.","type":"boolean"}},"required":["status"]},"Object631":{"type":"object","properties":{"cloneSchedule":{"description":"If true, also copy the schedule to the new script.","type":"boolean"},"cloneTriggers":{"description":"If true, also copy the triggers to the new script.","type":"boolean"},"cloneNotifications":{"description":"If true, also copy the notifications to the new script.","type":"boolean"}}},"Object633":{"type":"object","properties":{"score":{"description":"The relevance score from the search request.","type":"number","format":"float"},"type":{"description":"The type of the item.","type":"string"},"id":{"description":"The ID of the item.","type":"integer"},"name":{"description":"The name of the item.","type":"string"},"typeName":{"description":"The verbose name of the type.","type":"string"},"updatedAt":{"description":"The time the item was last updated.","type":"string","format":"time"},"owner":{"description":"The owner of the item.","type":"string"},"useCount":{"description":"The use count of the item, if the item is a template.","type":"integer"},"lastRunId":{"description":"The last run id of the item, if the item is a job.","type":"integer"},"lastRunState":{"description":"The last run state of the item, if the item is a job.","type":"string"},"lastRunStart":{"description":"The last run start time of the item, if the item is a job.","type":"string","format":"time"},"lastRunFinish":{"description":"The last run finish time of the item, if the item is a job.","type":"string","format":"time"},"public":{"description":"The flag that indicates a template is available to all users.","type":"boolean"},"lastRunException":{"description":"The exception of the item after the last run, if the item is a job.","type":"string"},"autoShare":{"description":"The flag that indicates if a project has Auto-Share enabled.","type":"boolean"}}},"Object632":{"type":"object","properties":{"totalResults":{"description":"The number of items matching the search query.","type":"integer"},"aggregations":{"description":"Aggregations by owner and type for the search results.","type":"object"},"results":{"description":"The items returned by the search.","type":"array","items":{"$ref":"#/definitions/Object633"}}}},"Object634":{"type":"object","properties":{"type":{"description":"The name of the item type.","type":"string"}}},"Object636":{"type":"object","properties":{"id":{"type":"integer"},"state":{"description":"The state of the run. One of queued, running, succeeded, failed, and cancelled.","type":"string"},"startedAt":{"description":"The time that the run started.","type":"string","format":"time"},"finishedAt":{"description":"The time that the run completed.","type":"string","format":"time"},"error":{"description":"The error message for this run, if present.","type":"string"}}},"Object635":{"type":"object","properties":{"id":{"description":"The query ID.","type":"integer"},"database":{"description":"The database ID.","type":"integer"},"credential":{"description":"The credential ID.","type":"integer"},"sql":{"description":"The SQL executed by the query.","type":"string"},"authorId":{"description":"The author of the query.","type":"integer"},"archived":{"description":"The archival status of the requested item(s).","type":"boolean"},"createdAt":{"type":"string","format":"time"},"updatedAt":{"type":"string","format":"time"},"lastRun":{"$ref":"#/definitions/Object636"}}},"Object638":{"type":"object","properties":{"deploymentId":{"description":"The ID for this deployment.","type":"integer"},"userId":{"description":"The ID of the owner.","type":"integer"},"host":{"description":"Domain of the deployment.","type":"string"},"name":{"description":"Name of the deployment.","type":"string"},"dockerImageName":{"description":"The name of the docker image to pull from DockerHub.","type":"string"},"dockerImageTag":{"description":"The tag of the docker image to pull from DockerHub (default: latest).","type":"string"},"instanceType":{"description":"The EC2 instance type requested for the deployment.","type":"string"},"memory":{"description":"The memory allocated to the deployment, in MB.","type":"integer"},"cpu":{"description":"The cpu allocated to the deployment, in millicores.","type":"integer"},"state":{"description":"The state of the deployment.","type":"string"},"stateMessage":{"description":"A detailed description of the state.","type":"string"},"maxMemoryUsage":{"description":"If the deployment has finished, the maximum amount of memory used during the deployment, in MB.","type":"number","format":"float"},"maxCpuUsage":{"description":"If the deployment has finished, the maximum amount of cpu used during the deployment, in millicores.","type":"number","format":"float"},"createdAt":{"type":"string","format":"time"},"updatedAt":{"type":"string","format":"time"},"serviceId":{"description":"The ID of owning Service","type":"integer"}}},"Object637":{"type":"object","properties":{"id":{"description":"The ID for this Service.","type":"integer"},"name":{"description":"The name of this Service.","type":"string"},"description":{"description":"The description of this Service.","type":"string"},"user":{"description":"The name of the author of this Service.","$ref":"#/definitions/Object33"},"type":{"description":"The type of this Service","type":"string"},"createdAt":{"type":"string","format":"time"},"updatedAt":{"type":"string","format":"time"},"gitRepoUrl":{"description":"The url for the git repo where the Service code lives.","type":"string"},"gitRepoRef":{"description":"The git reference to use when pulling code from the repo.","type":"string"},"gitPathDir":{"description":"The path to the Service code within the git repo. If unspecified, the root directory will be used.","type":"string"},"currentDeployment":{"$ref":"#/definitions/Object638"},"archived":{"description":"The archival status of the requested item(s).","type":"string"}}},"Object641":{"type":"object","properties":{"scheduledDays":{"description":"Days it is scheduled on, based on numeric value starting at 0 for Sunday","type":"array","items":{"type":"integer"}},"scheduledHours":{"description":"Hours it is scheduled on","type":"array","items":{"type":"integer"}}},"required":["scheduledDays","scheduledHours"]},"Object640":{"type":"object","properties":{"runtimePlan":{"description":"Only affects the service when deployed. On Demand means that the service will be turned on when viewed and automatically turned off after periods of inactivity. Specific Times means the service will be on when scheduled. Always On means the deployed service will always be on.","type":"string"},"recurrences":{"description":"List of day-hour combinations this item is scheduled for","type":"array","items":{"$ref":"#/definitions/Object641"}}},"required":["runtimePlan","recurrences"]},"Object642":{"type":"object","properties":{"failureEmailAddresses":{"description":"Addresses to notify by e-mail when the service fails.","type":"array","items":{"type":"string"}},"failureOn":{"description":"If failure email notifications are on","type":"boolean"}}},"Object639":{"type":"object","properties":{"name":{"description":"The name of this Service.","type":"string"},"description":{"description":"The description of this Service.","type":"string"},"type":{"description":"The type of this Service","type":"string"},"dockerImageName":{"description":"The name of the docker image to pull from DockerHub.","type":"string"},"dockerImageTag":{"description":"The tag of the docker image to pull from DockerHub (default: latest).","type":"string"},"schedule":{"description":"The schedule when the Service will run.","$ref":"#/definitions/Object640"},"replicas":{"description":"The number of Service replicas to deploy. When maxReplicas is set,\n this field defines the minimum number of replicas to deploy.","type":"integer"},"maxReplicas":{"description":"The maximum number of Service replicas to deploy. Defining this field enables autoscaling.","type":"integer"},"instanceType":{"description":"The EC2 instance type to deploy to.","type":"string"},"memory":{"description":"The amount of memory allocated to each replica of the Service.","type":"integer"},"cpu":{"description":"The amount of cpu allocated to each replica of the the Service.","type":"integer"},"credentials":{"description":"A list of credential IDs to pass to the Service.","type":"array","items":{"type":"integer"}},"permissionSetId":{"description":"The ID of the associated permission set, if any.","type":"integer"},"gitRepoUrl":{"description":"The url for the git repo where the Service code lives.","type":"string"},"gitRepoRef":{"description":"The git reference to use when pulling code from the repo.","type":"string"},"gitPathDir":{"description":"The path to the Service code within the git repo. If unspecified, the root directory will be used.","type":"string"},"environmentVariables":{"description":"Environment Variables to be passed into the Service.","type":"object","additionalProperties":{"type":"string"}},"notifications":{"description":"The notifications to send when the service fails.","$ref":"#/definitions/Object642"},"partitionLabel":{"description":"The partition label used to run this object.","type":"string"},"hidden":{"description":"The hidden status of the item.","type":"boolean"}}},"Object645":{"type":"object","properties":{"scheduledDays":{"description":"Days it is scheduled on, based on numeric value starting at 0 for Sunday","type":"array","items":{"type":"integer"}},"scheduledHours":{"description":"Hours it is scheduled on","type":"array","items":{"type":"integer"}}}},"Object644":{"type":"object","properties":{"runtimePlan":{"description":"Only affects the service when deployed. On Demand means that the service will be turned on when viewed and automatically turned off after periods of inactivity. Specific Times means the service will be on when scheduled. Always On means the deployed service will always be on.","type":"string"},"recurrences":{"description":"List of day-hour combinations this item is scheduled for","type":"array","items":{"$ref":"#/definitions/Object645"}}}},"Object646":{"type":"object","properties":{"deploymentId":{"description":"The ID for this deployment.","type":"integer"},"userId":{"description":"The ID of the owner.","type":"integer"},"host":{"description":"Domain of the deployment.","type":"string"},"name":{"description":"Name of the deployment.","type":"string"},"dockerImageName":{"description":"The name of the docker image to pull from DockerHub.","type":"string"},"dockerImageTag":{"description":"The tag of the docker image to pull from DockerHub (default: latest).","type":"string"},"displayUrl":{"description":"A signed URL for viewing the deployed item.","type":"string"},"instanceType":{"description":"The EC2 instance type requested for the deployment.","type":"string"},"memory":{"description":"The memory allocated to the deployment, in MB.","type":"integer"},"cpu":{"description":"The cpu allocated to the deployment, in millicores.","type":"integer"},"state":{"description":"The state of the deployment.","type":"string"},"stateMessage":{"description":"A detailed description of the state.","type":"string"},"maxMemoryUsage":{"description":"If the deployment has finished, the maximum amount of memory used during the deployment, in MB.","type":"number","format":"float"},"maxCpuUsage":{"description":"If the deployment has finished, the maximum amount of cpu used during the deployment, in millicores.","type":"number","format":"float"},"createdAt":{"type":"string","format":"time"},"updatedAt":{"type":"string","format":"time"},"serviceId":{"description":"The ID of owning Service","type":"integer"}}},"Object647":{"type":"object","properties":{"failureEmailAddresses":{"description":"Addresses to notify by e-mail when the service fails.","type":"array","items":{"type":"string"}},"failureOn":{"description":"If failure email notifications are on","type":"boolean"}}},"Object643":{"type":"object","properties":{"id":{"description":"The ID for this Service.","type":"integer"},"name":{"description":"The name of this Service.","type":"string"},"description":{"description":"The description of this Service.","type":"string"},"user":{"description":"The name of the author of this Service.","$ref":"#/definitions/Object33"},"type":{"description":"The type of this Service","type":"string"},"dockerImageName":{"description":"The name of the docker image to pull from DockerHub.","type":"string"},"dockerImageTag":{"description":"The tag of the docker image to pull from DockerHub (default: latest).","type":"string"},"schedule":{"description":"The schedule when the Service will run.","$ref":"#/definitions/Object644"},"timeZone":{"type":"string"},"replicas":{"description":"The number of Service replicas to deploy. When maxReplicas is set,\n this field defines the minimum number of replicas to deploy.","type":"integer"},"maxReplicas":{"description":"The maximum number of Service replicas to deploy. Defining this field enables autoscaling.","type":"integer"},"instanceType":{"description":"The EC2 instance type to deploy to.","type":"string"},"memory":{"description":"The amount of memory allocated to each replica of the Service.","type":"integer"},"cpu":{"description":"The amount of cpu allocated to each replica of the the Service.","type":"integer"},"createdAt":{"type":"string","format":"time"},"updatedAt":{"type":"string","format":"time"},"credentials":{"description":"A list of credential IDs to pass to the Service.","type":"array","items":{"type":"integer"}},"permissionSetId":{"description":"The ID of the associated permission set, if any.","type":"integer"},"gitRepoUrl":{"description":"The url for the git repo where the Service code lives.","type":"string"},"gitRepoRef":{"description":"The git reference to use when pulling code from the repo.","type":"string"},"gitPathDir":{"description":"The path to the Service code within the git repo. If unspecified, the root directory will be used.","type":"string"},"reportId":{"description":"The ID of the associated report.","type":"integer"},"currentDeployment":{"$ref":"#/definitions/Object646"},"currentUrl":{"description":"The URL that the service is hosted at.","type":"string"},"environmentVariables":{"description":"Environment Variables to be passed into the Service.","type":"object","additionalProperties":{"type":"string"}},"notifications":{"description":"The notifications to send when the service fails.","$ref":"#/definitions/Object647"},"partitionLabel":{"description":"The partition label used to run this object.","type":"string"},"myPermissionLevel":{"description":"Your permission level on the object. One of \"read\", \"write\", or \"manage\".","type":"string"},"archived":{"description":"The archival status of the requested item(s).","type":"string"},"hidden":{"description":"The hidden status of the item.","type":"boolean"}}},"Object648":{"type":"object","properties":{"name":{"description":"The name of this Service.","type":"string"},"description":{"description":"The description of this Service.","type":"string"},"dockerImageName":{"description":"The name of the docker image to pull from DockerHub.","type":"string"},"dockerImageTag":{"description":"The tag of the docker image to pull from DockerHub (default: latest).","type":"string"},"schedule":{"description":"The schedule when the Service will run.","$ref":"#/definitions/Object640"},"replicas":{"description":"The number of Service replicas to deploy. When maxReplicas is set,\n this field defines the minimum number of replicas to deploy.","type":"integer"},"maxReplicas":{"description":"The maximum number of Service replicas to deploy. Defining this field enables autoscaling.","type":"integer"},"instanceType":{"description":"The EC2 instance type to deploy to.","type":"string"},"memory":{"description":"The amount of memory allocated to each replica of the Service.","type":"integer"},"cpu":{"description":"The amount of cpu allocated to each replica of the the Service.","type":"integer"},"credentials":{"description":"A list of credential IDs to pass to the Service.","type":"array","items":{"type":"integer"}},"permissionSetId":{"description":"The ID of the associated permission set, if any.","type":"integer"},"gitRepoUrl":{"description":"The url for the git repo where the Service code lives.","type":"string"},"gitRepoRef":{"description":"The git reference to use when pulling code from the repo.","type":"string"},"gitPathDir":{"description":"The path to the Service code within the git repo. If unspecified, the root directory will be used.","type":"string"},"environmentVariables":{"description":"Environment Variables to be passed into the Service.","type":"object","additionalProperties":{"type":"string"}},"notifications":{"description":"The notifications to send when the service fails.","$ref":"#/definitions/Object642"},"partitionLabel":{"description":"The partition label used to run this object.","type":"string"}}},"Object649":{"type":"object","properties":{"userIds":{"description":"An array of one or more user IDs.","type":"array","items":{"type":"integer"}},"permissionLevel":{"description":"Options are: \"read\", \"write\", or \"manage\".","type":"string"},"shareEmailBody":{"description":"Custom body text for e-mail sent on a share.","type":"string"},"sendSharedEmail":{"description":"Send email to the recipients of a share.","type":"boolean"}},"required":["userIds","permissionLevel"]},"Object650":{"type":"object","properties":{"groupIds":{"description":"An array of one or more group IDs.","type":"array","items":{"type":"integer"}},"permissionLevel":{"description":"Options are: \"read\", \"write\", or \"manage\".","type":"string"},"shareEmailBody":{"description":"Custom body text for e-mail sent on a share.","type":"string"},"sendSharedEmail":{"description":"Send email to the recipients of a share.","type":"boolean"}},"required":["groupIds","permissionLevel"]},"Object651":{"type":"object","properties":{"userId":{"description":"ID of target user","type":"integer"},"includeDependencies":{"description":"Whether or not to give manage permissions on all dependencies","type":"boolean"},"emailBody":{"description":"Custom body text for e-mail sent on transfer.","type":"string"},"sendEmail":{"description":"Send email to the target user of the transfer?","type":"boolean"}},"required":["userId","includeDependencies"]},"Object652":{"type":"object","properties":{"status":{"description":"The desired archived status of the object.","type":"boolean"}},"required":["status"]},"Object653":{"type":"object","properties":{"deploymentId":{"description":"The ID for this deployment","type":"integer"}}},"Object656":{"type":"object","properties":{"name":{"description":"The name of the token.","type":"string"},"machineToken":{"description":"If true, create a compact token with no user information.","type":"boolean"},"expiresIn":{"description":"The number of seconds until the token should expire","type":"integer"}},"required":["name"]},"Object657":{"type":"object","properties":{"id":{"description":"The ID of the token.","type":"integer"},"name":{"description":"The name of the token.","type":"string"},"user":{"description":"The user that created the token.","$ref":"#/definitions/Object33"},"machineToken":{"description":"If true, this token is not tied to a particular user.","type":"boolean"},"expiresAt":{"description":"The date and time when the token expires.","type":"string","format":"date-time"},"createdAt":{"description":"The date and time when the token was created.","type":"string","format":"time"},"token":{"description":"The value of the token. Only returned when the token is first created.","type":"string"}}},"Object658":{"type":"object","properties":{"id":{"description":"The ID of the token.","type":"integer"},"name":{"description":"The name of the token.","type":"string"},"user":{"description":"The user that created the token.","$ref":"#/definitions/Object33"},"machineToken":{"description":"If true, this token is not tied to a particular user.","type":"boolean"},"expiresAt":{"description":"The date and time when the token expires.","type":"string","format":"date-time"},"createdAt":{"description":"The date and time when the token was created.","type":"string","format":"time"}}},"Object660":{"type":"object","properties":{"region":{"description":"The region for this storage host (ex. \"us-east-1\")","type":"string"}}},"Object659":{"type":"object","properties":{"id":{"description":"The ID of the storage host.","type":"integer"},"owner":{"description":"The user who created this storage host.","$ref":"#/definitions/Object33"},"name":{"description":"The human readable name for the storage host.","type":"string"},"provider":{"description":"The storage provider.One of: s3.","type":"string"},"bucket":{"description":"The bucket for this storage host.","type":"string"},"s3Options":{"description":"Additional s3-specific options for this storage host.","$ref":"#/definitions/Object660"}}},"Object662":{"type":"object","properties":{"region":{"description":"The region for this storage host (ex. \"us-east-1\")","type":"string"}}},"Object661":{"type":"object","properties":{"provider":{"description":"The storage provider.One of: s3.","type":"string"},"bucket":{"description":"The bucket for this storage host.","type":"string"},"s3Options":{"description":"Additional s3-specific options for this storage host.","$ref":"#/definitions/Object662"},"name":{"description":"The human readable name for the storage host.","type":"string"}},"required":["provider","bucket","name"]},"Object663":{"type":"object","properties":{"name":{"description":"The human readable name for the storage host.","type":"string"},"provider":{"description":"The storage provider.One of: s3.","type":"string"},"bucket":{"description":"The bucket for this storage host.","type":"string"},"s3Options":{"description":"Additional s3-specific options for this storage host.","$ref":"#/definitions/Object662"}},"required":["name","provider","bucket"]},"Object664":{"type":"object","properties":{"name":{"description":"The human readable name for the storage host.","type":"string"},"provider":{"description":"The storage provider.One of: s3.","type":"string"},"bucket":{"description":"The bucket for this storage host.","type":"string"},"s3Options":{"description":"Additional s3-specific options for this storage host.","$ref":"#/definitions/Object662"}}},"Object665":{"type":"object","properties":{"userIds":{"description":"An array of one or more user IDs.","type":"array","items":{"type":"integer"}},"permissionLevel":{"description":"Options are: \"read\", \"write\", or \"manage\".","type":"string"},"shareEmailBody":{"description":"Custom body text for e-mail sent on a share.","type":"string"},"sendSharedEmail":{"description":"Send email to the recipients of a share.","type":"boolean"}},"required":["userIds","permissionLevel"]},"Object666":{"type":"object","properties":{"groupIds":{"description":"An array of one or more group IDs.","type":"array","items":{"type":"integer"}},"permissionLevel":{"description":"Options are: \"read\", \"write\", or \"manage\".","type":"string"},"shareEmailBody":{"description":"Custom body text for e-mail sent on a share.","type":"string"},"sendSharedEmail":{"description":"Send email to the recipients of a share.","type":"boolean"}},"required":["groupIds","permissionLevel"]},"Object667":{"type":"object","properties":{"userId":{"description":"ID of target user","type":"integer"},"includeDependencies":{"description":"Whether or not to give manage permissions on all dependencies","type":"boolean"},"emailBody":{"description":"Custom body text for e-mail sent on transfer.","type":"string"},"sendEmail":{"description":"Send email to the target user of the transfer?","type":"boolean"}},"required":["userId","includeDependencies"]},"Object668":{"type":"object","properties":{"id":{"description":"Table Tag ID","type":"integer"},"name":{"description":"Table Tag Name","type":"string"},"tableCount":{"description":"The total number of tables associated with the tag.","type":"integer"},"user":{"description":"The creator of the table tag.","$ref":"#/definitions/Object33"}}},"Object669":{"type":"object","properties":{"name":{"description":"Table Tag Name","type":"string"}},"required":["name"]},"Object670":{"type":"object","properties":{"id":{"description":"Table Tag ID","type":"integer"},"name":{"description":"Table Tag Name","type":"string"},"createdAt":{"description":"The date the tag was created.","type":"string","format":"date-time"},"updatedAt":{"description":"The date the tag was recently updated on.","type":"string","format":"date-time"},"tableCount":{"description":"The total number of tables associated with the tag.","type":"integer"},"user":{"description":"The creator of the table tag.","$ref":"#/definitions/Object33"}}},"Object671":{"type":"object","properties":{"id":{"description":"The ID of the enhancement.","type":"integer"},"sourceTableId":{"description":"The ID of the table that was enhanced.","type":"integer"},"state":{"description":"The state of the enhancement, one of 'queued' 'running' 'succeeded' 'failed' or 'cancelled'.","type":"string"},"enhancedTableSchema":{"description":"The schema name of the table created by the enhancement.","type":"string"},"enhancedTableName":{"description":"The name of the table created by the enhancement.","type":"string"}}},"Object672":{"type":"object","properties":{"performNcoa":{"description":"Whether to update addresses for records matching the National Change of Address (NCOA) database.","type":"boolean"},"ncoaCredentialId":{"description":"Credential to use when performing NCOA updates. Required if 'performNcoa' is true.","type":"integer"},"outputLevel":{"description":"The set of fields persisted by a CASS or NCOA enhancement.For CASS enhancements, one of 'cass' or 'all.'For NCOA enhancements, one of 'cass', 'ncoa' , 'coalesced' or 'all'.By default, all fields will be returned.","type":"string"},"batchSize":{"description":"The maximum number of records processed at a time. Note that this parameter is not available to all users.","type":"integer"}}},"Object673":{"type":"object","properties":{"id":{"description":"The ID of the enhancement.","type":"integer"},"sourceTableId":{"description":"The ID of the table that was enhanced.","type":"integer"},"state":{"description":"The state of the enhancement, one of 'queued' 'running' 'succeeded' 'failed' or 'cancelled'.","type":"string"},"enhancedTableSchema":{"description":"The schema name of the table created by the enhancement.","type":"string"},"enhancedTableName":{"description":"The name of the table created by the enhancement.","type":"string"},"performNcoa":{"description":"Whether to update addresses for records matching the National Change of Address (NCOA) database.","type":"boolean"},"ncoaCredentialId":{"description":"Credential to use when performing NCOA updates. Required if 'performNcoa' is true.","type":"integer"},"outputLevel":{"description":"The set of fields persisted by a CASS or NCOA enhancement.For CASS enhancements, one of 'cass' or 'all.'For NCOA enhancements, one of 'cass', 'ncoa' , 'coalesced' or 'all'.By default, all fields will be returned.","type":"string"},"batchSize":{"description":"The maximum number of records processed at a time. Note that this parameter is not available to all users.","type":"integer"}}},"Object674":{"type":"object","properties":{"databaseId":{"description":"The ID of the database.","type":"integer"},"schema":{"description":"The name of the schema containing the table.","type":"string"},"tableName":{"description":"The name of the table.","type":"string"},"statsPriority":{"description":"When to sync table statistics. Valid Options are the following. Option: 'flag' means to flag stats for the next scheduled run of a full table scan on the database. Option: 'block' means to block this job on stats syncing. Option: 'queue' means to queue a separate job for syncing stats and do not block this job on the queued job. Defaults to 'flag'","type":"string"}},"required":["databaseId","schema","tableName"]},"Object675":{"type":"object","properties":{"jobId":{"description":"The ID of the job created.","type":"integer"},"runId":{"description":"The ID of the run created.","type":"integer"}}},"Object676":{"type":"object","properties":{"ontologyMapping":{"description":"The ontology-key to column-name mapping. See /ontology for the list of valid ontology keys.","type":"object","additionalProperties":{"type":"string"}},"description":{"description":"The user-defined description of the table.","type":"string"},"primaryKeys":{"description":"A list of column(s) which together uniquely identify a row in the data.These columns must not contain NULL values.","type":"array","items":{"type":"string"}},"lastModifiedKeys":{"description":"The columns indicating when a row was last modified.","type":"array","items":{"type":"string"}}}},"Object677":{"type":"object","properties":{"id":{"description":"The ID of the table.","type":"integer"},"databaseId":{"description":"The ID of the database.","type":"integer"},"schema":{"description":"The name of the schema containing the table.","type":"string"},"name":{"description":"Name of the table.","type":"string"},"description":{"description":"The description of the table, as specified by the table owner","type":"string"},"isView":{"description":"True if this table represents a view. False if it represents a regular table.","type":"boolean"},"rowCount":{"description":"The number of rows in the table.","type":"integer"},"columnCount":{"description":"The number of columns in the table.","type":"integer"},"sizeMb":{"description":"The size of the table in megabytes.","type":"number","format":"float"},"owner":{"description":"The database username of the table's owner.","type":"string"},"distkey":{"description":"The column used as the Amazon Redshift distkey.","type":"string"},"sortkeys":{"description":"The column used as the Amazon Redshift sortkey.","type":"string"},"refreshStatus":{"description":"How up-to-date the table's statistics on row counts, null counts, distinct counts, and values distributions are. One of: refreshing, stale, or current.","type":"string"},"lastRefresh":{"description":"The time of the last statistics refresh.","type":"string","format":"date-time"},"dataUpdatedAt":{"description":"The last time that Civis Platform captured a change in this table.Only applicable for Redshift tables; please see the Civis help desk for more info.","type":"string","format":"date-time"},"schemaUpdatedAt":{"description":"The last time that Civis Platform captured a change to the table attributes/structure.Only applicable for Redshift tables; please see the Civis help desk for more info.","type":"string","format":"date-time"},"refreshId":{"description":"The ID of the most recent statistics refresh.","type":"string"},"lastRun":{"description":"The last run of a refresh on this table.","$ref":"#/definitions/Object75"},"primaryKeys":{"description":"The primary keys for this table.","type":"array","items":{"type":"string"}},"lastModifiedKeys":{"description":"The columns indicating an entry's modification status for this table.","type":"array","items":{"type":"string"}},"tableTags":{"description":"The table tags associated with this table.","type":"array","items":{"$ref":"#/definitions/Object76"}},"ontologyMapping":{"description":"The ontology-key to column-name mapping. See /ontology for the list of valid ontology keys.","type":"object","additionalProperties":{"type":"string"}}}},"Object678":{"type":"object","properties":{"id":{"description":"The ID of the table.","type":"integer"},"tableTagId":{"description":"The ID of the tag.","type":"integer"}}},"Object679":{"type":"object","properties":{"userIds":{"description":"An array of one or more user IDs.","type":"array","items":{"type":"integer"}},"permissionLevel":{"description":"Options are: \"read\", \"write\", or \"manage\".","type":"string"},"shareEmailBody":{"description":"Custom body text for e-mail sent on a share.","type":"string"},"sendSharedEmail":{"description":"Send email to the recipients of a share.","type":"boolean"}},"required":["userIds","permissionLevel"]},"Object680":{"type":"object","properties":{"groupIds":{"description":"An array of one or more group IDs.","type":"array","items":{"type":"integer"}},"permissionLevel":{"description":"Options are: \"read\", \"write\", or \"manage\".","type":"string"},"shareEmailBody":{"description":"Custom body text for e-mail sent on a share.","type":"string"},"sendSharedEmail":{"description":"Send email to the recipients of a share.","type":"boolean"}},"required":["groupIds","permissionLevel"]},"Object681":{"type":"object","properties":{"userId":{"description":"ID of target user","type":"integer"},"includeDependencies":{"description":"Whether or not to give manage permissions on all dependencies","type":"boolean"},"emailBody":{"description":"Custom body text for e-mail sent on transfer.","type":"string"},"sendEmail":{"description":"Send email to the target user of the transfer?","type":"boolean"}},"required":["userId","includeDependencies"]},"Object682":{"type":"object","properties":{"id":{"type":"integer"},"name":{"description":"The name of the template.","type":"string"},"category":{"description":"The category of this report template. Can be left blank. Acceptable values are: dataset-viz","type":"string"},"createdAt":{"type":"string","format":"time"},"updatedAt":{"type":"string","format":"time"},"useCount":{"description":"The number of uses of this template.","type":"integer"},"archived":{"description":"Whether the template has been archived.","type":"boolean"},"techReviewed":{"description":"Whether this template has been audited by Civis for security vulnerability and correctness.","type":"boolean"},"author":{"description":"The author/owner of the item.","$ref":"#/definitions/Object33"}}},"Object683":{"type":"object","properties":{"name":{"description":"The name of the template.","type":"string"},"category":{"description":"The category of this report template. Can be left blank. Acceptable values are: dataset-viz","type":"string"},"archived":{"description":"Whether the template has been archived.","type":"boolean"},"codeBody":{"description":"The code for the Template body.","type":"string"},"provideAPIKey":{"description":"Whether reports based on this template request an API Key from the report viewer.","type":"boolean"},"hidden":{"description":"The hidden status of the item.","type":"boolean"}},"required":["name","codeBody"]},"Object684":{"type":"object","properties":{"id":{"type":"integer"},"name":{"description":"The name of the template.","type":"string"},"category":{"description":"The category of this report template. Can be left blank. Acceptable values are: dataset-viz","type":"string"},"createdAt":{"type":"string","format":"time"},"updatedAt":{"type":"string","format":"time"},"useCount":{"description":"The number of uses of this template.","type":"integer"},"archived":{"description":"Whether the template has been archived.","type":"boolean"},"techReviewed":{"description":"Whether this template has been audited by Civis for security vulnerability and correctness.","type":"boolean"},"author":{"description":"The author/owner of the item.","$ref":"#/definitions/Object33"},"authCodeUrl":{"description":"A URL to the template's stored code body.","type":"string"},"provideAPIKey":{"description":"Whether reports based on this template request an API Key from the report viewer.","type":"boolean"},"hidden":{"description":"The hidden status of the item.","type":"boolean"}}},"Object685":{"type":"object","properties":{"name":{"description":"The name of the template.","type":"string"},"category":{"description":"The category of this report template. Can be left blank. Acceptable values are: dataset-viz","type":"string"},"archived":{"description":"Whether the template has been archived.","type":"boolean"},"codeBody":{"description":"The code for the Template body.","type":"string"},"provideAPIKey":{"description":"Whether reports based on this template request an API Key from the report viewer.","type":"boolean"}},"required":["name","codeBody"]},"Object686":{"type":"object","properties":{"name":{"description":"The name of the template.","type":"string"},"category":{"description":"The category of this report template. Can be left blank. Acceptable values are: dataset-viz","type":"string"},"archived":{"description":"Whether the template has been archived.","type":"boolean"},"codeBody":{"description":"The code for the Template body.","type":"string"},"provideAPIKey":{"description":"Whether reports based on this template request an API Key from the report viewer.","type":"boolean"}}},"Object688":{"type":"object","properties":{"userIds":{"description":"An array of one or more user IDs.","type":"array","items":{"type":"integer"}},"permissionLevel":{"description":"Options are: \"read\", \"write\", or \"manage\".","type":"string"},"shareEmailBody":{"description":"Custom body text for e-mail sent on a share.","type":"string"},"sendSharedEmail":{"description":"Send email to the recipients of a share.","type":"boolean"}},"required":["userIds","permissionLevel"]},"Object689":{"type":"object","properties":{"groupIds":{"description":"An array of one or more group IDs.","type":"array","items":{"type":"integer"}},"permissionLevel":{"description":"Options are: \"read\", \"write\", or \"manage\".","type":"string"},"shareEmailBody":{"description":"Custom body text for e-mail sent on a share.","type":"string"},"sendSharedEmail":{"description":"Send email to the recipients of a share.","type":"boolean"}},"required":["groupIds","permissionLevel"]},"Object690":{"type":"object","properties":{"userId":{"description":"ID of target user","type":"integer"},"includeDependencies":{"description":"Whether or not to give manage permissions on all dependencies","type":"boolean"},"emailBody":{"description":"Custom body text for e-mail sent on transfer.","type":"string"},"sendEmail":{"description":"Send email to the target user of the transfer?","type":"boolean"}},"required":["userId","includeDependencies"]},"Object691":{"type":"object","properties":{"id":{"type":"integer"},"public":{"description":"If the template is public or not.","type":"boolean"},"scriptId":{"description":"The id of the script that this template uses.","type":"integer"},"userContext":{"description":"The user context of the script that this template uses.","type":"string"},"name":{"description":"The name of the template.","type":"string"},"category":{"description":"The category of this template.","type":"string"},"createdAt":{"type":"string","format":"time"},"updatedAt":{"type":"string","format":"time"},"useCount":{"description":"The number of uses of this template.","type":"integer"},"uiReportId":{"description":"The id of the report that this template uses.","type":"integer"},"techReviewed":{"description":"Whether this template has been audited by Civis for security vulnerability and correctness.","type":"boolean"},"archived":{"description":"Whether the template has been archived.","type":"boolean"},"author":{"description":"The author/owner of the item.","$ref":"#/definitions/Object33"}}},"Object692":{"type":"object","properties":{"scriptId":{"description":"The id of the script that this template uses.","type":"integer"},"name":{"description":"The name of the template.","type":"string"},"note":{"description":"A note describing what this template is used for; custom scripts created off this template will display this description.","type":"string"},"uiReportId":{"description":"The id of the report that this template uses.","type":"integer"},"archived":{"description":"Whether the template has been archived.","type":"boolean"},"hidden":{"description":"The hidden status of the item.","type":"boolean"}},"required":["scriptId","name"]},"Object693":{"type":"object","properties":{"id":{"type":"integer"},"public":{"description":"If the template is public or not.","type":"boolean"},"scriptId":{"description":"The id of the script that this template uses.","type":"integer"},"scriptType":{"description":"The type of the template's backing script (e.g SQL, Container, Python, R, JavaScript)","type":"string"},"userContext":{"description":"The user context of the script that this template uses.","type":"string"},"params":{"description":"A definition of the parameters that this template's backing script accepts in the arguments field.","type":"array","items":{"$ref":"#/definitions/Object527"}},"name":{"description":"The name of the template.","type":"string"},"category":{"description":"The category of this template.","type":"string"},"note":{"description":"A note describing what this template is used for; custom scripts created off this template will display this description.","type":"string"},"createdAt":{"type":"string","format":"time"},"updatedAt":{"type":"string","format":"time"},"useCount":{"description":"The number of uses of this template.","type":"integer"},"uiReportId":{"description":"The id of the report that this template uses.","type":"integer"},"techReviewed":{"description":"Whether this template has been audited by Civis for security vulnerability and correctness.","type":"boolean"},"archived":{"description":"Whether the template has been archived.","type":"boolean"},"hidden":{"description":"The hidden status of the item.","type":"boolean"},"author":{"description":"The author/owner of the item.","$ref":"#/definitions/Object33"},"myPermissionLevel":{"description":"Your permission level on the object. One of \"read\", \"write\", or \"manage\".","type":"string"}}},"Object694":{"type":"object","properties":{"name":{"description":"The name of the template.","type":"string"},"note":{"description":"A note describing what this template is used for; custom scripts created off this template will display this description.","type":"string"},"uiReportId":{"description":"The id of the report that this template uses.","type":"integer"},"archived":{"description":"Whether the template has been archived.","type":"boolean"}},"required":["name"]},"Object695":{"type":"object","properties":{"name":{"description":"The name of the template.","type":"string"},"note":{"description":"A note describing what this template is used for; custom scripts created off this template will display this description.","type":"string"},"uiReportId":{"description":"The id of the report that this template uses.","type":"integer"},"archived":{"description":"Whether the template has been archived.","type":"boolean"}}},"Object696":{"type":"object","properties":{"runId":{"description":"The ID of the run which contributed this usage.","type":"integer"},"jobId":{"description":"The ID of the job which contributed this usage.","type":"integer"},"userId":{"description":"The ID of the user who contributed this usage.","type":"integer"},"organizationId":{"description":"The organization of the user who contributed this usage.","type":"integer"},"runCreatedAt":{"description":"When the run was created at.","type":"string","format":"date-time"},"runTime":{"description":"The duration of the run in seconds.","type":"integer"},"numRecords":{"description":"The number of records matched by the run.","type":"integer"},"task":{"description":"The type of matching job contributing to this usage. One of [\"IDR\", \"CDM\"].","type":"string"}}},"Object699":{"type":"object","properties":{"id":{"description":"The ID of the usage statistic to get.","type":"integer"},"runId":{"description":"The ID of the run which contributed this usage.","type":"integer"},"jobId":{"description":"The ID of the job which contributed this usage.","type":"integer"},"userId":{"description":"The ID of the user who contributed this usage.","type":"integer"},"organizationId":{"description":"The organization of the user who contributed this usage.","type":"integer"},"runCreatedAt":{"description":"When the run was created at.","type":"string","format":"date-time"},"runTime":{"description":"The duration of the run in seconds.","type":"integer"},"credits":{"description":"The number of credits used.","type":"number","format":"float"},"inputTokens":{"description":"The number of tokens input to the run.","type":"integer"},"outputTokens":{"description":"The number of tokens output from the run.","type":"integer"},"modelId":{"description":"The ID of the LLM model used.","type":"string"}}},"Object702":{"type":"object","properties":{"credits":{"description":"The number of credits used.","type":"number","format":"float"},"organizationId":{"description":"The organization for which LLM usage statistics are summarized.","type":"integer"}}},"Object703":{"type":"object","properties":{"id":{"description":"The ID for the limit.","type":"integer"},"organizationId":{"description":"The ID of the organization to which this limit belongs.","type":"integer"},"createdAt":{"description":"The time this limit was created.","type":"string","format":"time"},"updatedAt":{"description":"The time the limit was last updated.","type":"string","format":"time"},"hardLimit":{"description":"The limit value. One of 50000000, 200000000, 500000000, 1000000000, and 2000000000.","type":"integer"},"task":{"description":"The category of this limit. One of 'IDR' or 'CDM'.","type":"string"},"notificationEmails":{"description":"Addresses to notify by e-mail when the limit is reached.","type":"array","items":{"type":"string"}}}},"Object706":{"type":"object","properties":{"id":{"description":"The ID for the limit.","type":"integer"},"organizationId":{"description":"The ID of the organization to which this limit belongs.","type":"integer"},"createdAt":{"description":"The time this limit was created.","type":"string","format":"time"},"updatedAt":{"description":"The time the limit was last updated.","type":"string","format":"time"},"hardLimit":{"description":"The limit value. One of 1000, 10000, 50000, and 100000.","type":"integer"}}},"Object709":{"type":"object","properties":{"id":{"description":"The ID of this group.","type":"integer"},"name":{"description":"The name of this group.","type":"string"},"slug":{"description":"The slug of this group.","type":"string"},"organizationId":{"description":"The ID of the organization associated with this group.","type":"integer"},"organizationName":{"description":"The name of the organization associated with this group.","type":"string"}}},"Object708":{"type":"object","properties":{"id":{"description":"The ID of this user.","type":"integer"},"user":{"description":"The username of this user.","type":"string"},"name":{"description":"The name of this user.","type":"string"},"email":{"description":"The email of this user.","type":"string"},"active":{"description":"Whether this user account is active or deactivated.","type":"boolean"},"primaryGroupId":{"description":"The ID of the primary group of this user.","type":"integer"},"groups":{"description":"An array of all the groups this user is in.","type":"array","items":{"$ref":"#/definitions/Object709"}},"createdAt":{"description":"The date and time when the user was created.","type":"string","format":"date-time"},"currentSignInAt":{"description":"The date and time when the user's current session began.","type":"string","format":"date-time"},"updatedAt":{"description":"The date and time when the user was last updated.","type":"string","format":"date-time"},"lastSeenAt":{"description":"The date and time when the user last visited Platform.","type":"string","format":"date-time"},"suspended":{"description":"Whether the user is suspended due to inactivity.","type":"boolean"},"createdById":{"description":"The ID of the user who created this user.","type":"integer"},"lastUpdatedById":{"description":"The ID of the user who last updated this user.","type":"integer"}}},"Object710":{"type":"object","properties":{"name":{"description":"The name of this user.","type":"string"},"email":{"description":"The email of this user.","type":"string"},"active":{"description":"Whether this user account is active or deactivated.","type":"boolean"},"primaryGroupId":{"description":"The ID of the primary group of this user.","type":"integer"},"city":{"description":"The city of this user.","type":"string"},"state":{"description":"The state of this user.","type":"string"},"timeZone":{"description":"The time zone of this user.","type":"string"},"initials":{"description":"The initials of this user.","type":"string"},"department":{"description":"The department of this user.","type":"string"},"title":{"description":"The title of this user.","type":"string"},"prefersSmsOtp":{"description":"The preference for phone authorization of this user","type":"boolean"},"groupIds":{"description":"An array of ids of all the groups this user is in.","type":"array","items":{"type":"integer"}},"vpnEnabled":{"description":"The availability of vpn for this user.","type":"boolean"},"ssoDisabled":{"description":"The availability of SSO for this user.","type":"boolean"},"otpRequiredForLogin":{"description":"The two factor authentication requirement for this user.","type":"boolean"},"exemptFromOrgSmsOtpDisabled":{"description":"Whether the user has SMS OTP enabled on an individual level. This field does not matter if the org does not have SMS OTP disabled.","type":"boolean"},"robot":{"description":"Whether the user is a robot.","type":"boolean"},"user":{"description":"The username of this user.","type":"string"},"sendEmail":{"description":"Whether the user will receive a welcome email. Defaults to false.","type":"boolean"}},"required":["name","email","primaryGroupId","user"]},"Object711":{"type":"object","properties":{"id":{"description":"The ID of this user.","type":"integer"},"user":{"description":"The username of this user.","type":"string"},"name":{"description":"The name of this user.","type":"string"},"email":{"description":"The email of this user.","type":"string"},"active":{"description":"Whether this user account is active or deactivated.","type":"boolean"},"primaryGroupId":{"description":"The ID of the primary group of this user.","type":"integer"},"groups":{"description":"An array of all the groups this user is in.","type":"array","items":{"$ref":"#/definitions/Object709"}},"city":{"description":"The city of this user.","type":"string"},"state":{"description":"The state of this user.","type":"string"},"timeZone":{"description":"The time zone of this user.","type":"string"},"initials":{"description":"The initials of this user.","type":"string"},"department":{"description":"The department of this user.","type":"string"},"title":{"description":"The title of this user.","type":"string"},"githubUsername":{"description":"The GitHub username of this user.","type":"string"},"prefersSmsOtp":{"description":"The preference for phone authorization of this user","type":"boolean"},"vpnEnabled":{"description":"The availability of vpn for this user.","type":"boolean"},"ssoDisabled":{"description":"The availability of SSO for this user.","type":"boolean"},"otpRequiredForLogin":{"description":"The two factor authentication requirement for this user.","type":"boolean"},"exemptFromOrgSmsOtpDisabled":{"description":"Whether the user has SMS OTP enabled on an individual level. This field does not matter if the org does not have SMS OTP disabled.","type":"boolean"},"smsOtpAllowed":{"description":"Whether the user is allowed to receive two factor authentication codes via SMS.","type":"boolean"},"robot":{"description":"Whether the user is a robot.","type":"boolean"},"phone":{"description":"The phone number of this user.","type":"string"},"organizationSlug":{"description":"The slug of the organization the user belongs to.","type":"string"},"organizationSSODisableCapable":{"description":"The user's organization's ability to disable sso for their users.","type":"boolean"},"organizationLoginType":{"description":"The user's organization's login type.","type":"string"},"organizationSmsOtpDisabled":{"description":"Whether the user's organization has SMS OTP disabled.","type":"boolean"},"myPermissionLevel":{"description":"Your permission level on the object. One of \"read\", \"write\", or \"manage\".","type":"string"},"createdAt":{"description":"The date and time when the user was created.","type":"string","format":"date-time"},"updatedAt":{"description":"The date and time when the user was last updated.","type":"string","format":"date-time"},"lastSeenAt":{"description":"The date and time when the user last visited Platform.","type":"string","format":"date-time"},"suspended":{"description":"Whether the user is suspended due to inactivity.","type":"boolean"},"createdById":{"description":"The ID of the user who created this user.","type":"integer"},"lastUpdatedById":{"description":"The ID of the user who last updated this user.","type":"integer"},"unconfirmedEmail":{"description":"The new email address awaiting confirmation from the user.","type":"string"},"accountStatus":{"description":"Account status of this user. One of: \"Active\", \"Deactivated\", \"Suspended\", \"Unsuspended\"","type":"string"}}},"Object712":{"type":"object","properties":{"id":{"description":"The ID of this user.","type":"integer"},"name":{"description":"This user's name.","type":"string"},"email":{"description":"This user's email address.","type":"string"},"username":{"description":"This user's username.","type":"string"},"initials":{"description":"This user's initials.","type":"string"},"lastCheckedAnnouncements":{"description":"The date and time at which the user last checked their announcements.","type":"string","format":"date-time"},"featureFlags":{"description":"The feature flag settings for this user.","type":"object","additionalProperties":{"type":"boolean"}},"roles":{"description":"The roles this user has, listed by slug.","type":"array","items":{"type":"string"}},"preferences":{"description":"This user's preferences.","type":"object","additionalProperties":{"type":"string"}},"customBranding":{"description":"The branding of Platform for this user.","type":"string"},"primaryGroupId":{"description":"The ID of the primary group of this user.","type":"integer"},"groups":{"description":"An array of all the groups this user is in.","type":"array","items":{"$ref":"#/definitions/Object709"}},"organizationName":{"description":"The name of the organization the user belongs to.","type":"string"},"organizationSlug":{"description":"The slug of the organization the user belongs to.","type":"string"},"organizationDefaultThemeId":{"description":"The ID of the organizations's default theme.","type":"integer"},"createdAt":{"description":"The date and time when the user was created.","type":"string","format":"date-time"},"signInCount":{"description":"The number of times the user has signed in.","type":"integer"},"assumingRole":{"description":"Whether the user is assuming this role or not.","type":"boolean"},"roleAssumer":{"description":"Details about the role assumer.","type":"object"},"assumingAdmin":{"description":"Whether the user is assuming admin.","type":"boolean"},"assumingAdminExpiration":{"description":"When the user's admin role is set to expire.","type":"string","format":"date-time"},"superadminModeExpiration":{"description":"The user is in superadmin mode when set to a DateTime. The user is not in superadmin mode when set to null.","type":"string","format":"date-time"},"disableNonCompliantFedrampFeatures":{"description":"Whether to disable non-compliant fedramp features.","type":"boolean"},"personaRole":{"description":"The high-level role representing the current user's main permissions.","type":"string"},"createdById":{"description":"The ID of the user who created this user.","type":"integer"},"lastUpdatedById":{"description":"The ID of the user who last updated this user.","type":"integer"}}},"Object715":{"type":"object","properties":{"id":{"description":"The ID of the object.","type":"string"},"name":{"description":"The name of the object.","type":"string"},"type":{"description":"The type of the object.","type":"string"},"user":{"description":"The user associated with the object.","type":"string"},"category":{"description":"The job category, if the object is a job.","type":"string"},"state":{"description":"The state of the object. One of \"succeeded\", \"failed\", or \"running\".","type":"string"},"updatedAt":{"description":"When the object was last updated.","type":"string","format":"date-time"},"nextRunAt":{"description":"When the job is next scheduled to run, if the object is a job.","type":"string","format":"date-time"},"lastRunId":{"description":"The ID of the last run, if the object is a job.","type":"string"},"lastRunState":{"description":"The state of the last run, if the object is a job. One of \"succeeded\", \"failed\", or \"running\".","type":"string"}}},"Object716":{"type":"object","properties":{"id":{"description":"The ID of this user.","type":"integer"},"name":{"description":"This user's name.","type":"string"},"username":{"description":"This user's username.","type":"string"},"initials":{"description":"This user's initials.","type":"string"},"online":{"description":"Whether this user is online.","type":"boolean"},"email":{"description":"This user's email address.","type":"string"}}},"Object718":{"type":"object","properties":{"id":{"description":"The ID of the API key.","type":"integer"},"name":{"description":"The name of the API key.","type":"string"},"expiresAt":{"description":"The date and time when the key expired.","type":"string","format":"date-time"},"createdAt":{"description":"The date and time when the key was created.","type":"string","format":"date-time"},"revokedAt":{"description":"The date and time when the key was revoked.","type":"string","format":"date-time"},"lastUsedAt":{"description":"The date and time when the key was last used.","type":"string","format":"date-time"},"scopes":{"description":"The scopes which the key is permissioned on.","type":"array","items":{"type":"string"}},"useCount":{"description":"The number of times the key has been used.","type":"integer"},"expired":{"description":"True if the key has expired.","type":"boolean"},"active":{"description":"True if the key has neither expired nor been revoked.","type":"boolean"},"constraintCount":{"description":"The number of constraints on the created key","type":"integer"}}},"Object720":{"type":"object","properties":{"constraint":{"description":"The path matcher of the constraint.","type":"string"},"constraintType":{"description":"The type of constraint (exact/prefix/regex/verb).","type":"string"},"getAllowed":{"description":"Whether the constraint allows GET requests.","type":"boolean"},"headAllowed":{"description":"Whether the constraint allows HEAD requests.","type":"boolean"},"postAllowed":{"description":"Whether the constraint allows POST requests.","type":"boolean"},"putAllowed":{"description":"Whether the constraint allows PUT requests.","type":"boolean"},"patchAllowed":{"description":"Whether the constraint allows PATCH requests.","type":"boolean"},"deleteAllowed":{"description":"Whether the constraint allows DELETE requests.","type":"boolean"}},"required":["constraintType"]},"Object719":{"type":"object","properties":{"expiresIn":{"description":"The number of seconds the key should last for.","type":"integer"},"constraints":{"description":"Constraints on the abilities of the created key.","type":"array","items":{"$ref":"#/definitions/Object720"}},"name":{"description":"The name of the API key.","type":"string"}},"required":["expiresIn","name"]},"Object722":{"type":"object","properties":{"constraint":{"description":"The path matcher of the constraint.","type":"string"},"constraintType":{"description":"The type of constraint (exact/prefix/regex/verb).","type":"string"},"getAllowed":{"description":"Whether the constraint allows GET requests.","type":"boolean"},"headAllowed":{"description":"Whether the constraint allows HEAD requests.","type":"boolean"},"postAllowed":{"description":"Whether the constraint allows POST requests.","type":"boolean"},"putAllowed":{"description":"Whether the constraint allows PUT requests.","type":"boolean"},"patchAllowed":{"description":"Whether the constraint allows PATCH requests.","type":"boolean"},"deleteAllowed":{"description":"Whether the constraint allows DELETE requests.","type":"boolean"}}},"Object721":{"type":"object","properties":{"id":{"description":"The ID of the API key.","type":"integer"},"name":{"description":"The name of the API key.","type":"string"},"expiresAt":{"description":"The date and time when the key expired.","type":"string","format":"date-time"},"createdAt":{"description":"The date and time when the key was created.","type":"string","format":"date-time"},"revokedAt":{"description":"The date and time when the key was revoked.","type":"string","format":"date-time"},"lastUsedAt":{"description":"The date and time when the key was last used.","type":"string","format":"date-time"},"scopes":{"description":"The scopes which the key is permissioned on.","type":"array","items":{"type":"string"}},"useCount":{"description":"The number of times the key has been used.","type":"integer"},"expired":{"description":"True if the key has expired.","type":"boolean"},"active":{"description":"True if the key has neither expired nor been revoked.","type":"boolean"},"constraints":{"description":"Constraints on the abilities of the created key","type":"array","items":{"$ref":"#/definitions/Object722"}},"token":{"description":"The API key.","type":"string"}}},"Object724":{"type":"object","properties":{"id":{"description":"The ID of the API key.","type":"integer"},"name":{"description":"The name of the API key.","type":"string"},"expiresAt":{"description":"The date and time when the key expired.","type":"string","format":"date-time"},"createdAt":{"description":"The date and time when the key was created.","type":"string","format":"date-time"},"revokedAt":{"description":"The date and time when the key was revoked.","type":"string","format":"date-time"},"lastUsedAt":{"description":"The date and time when the key was last used.","type":"string","format":"date-time"},"scopes":{"description":"The scopes which the key is permissioned on.","type":"array","items":{"type":"string"}},"useCount":{"description":"The number of times the key has been used.","type":"integer"},"expired":{"description":"True if the key has expired.","type":"boolean"},"active":{"description":"True if the key has neither expired nor been revoked.","type":"boolean"},"constraints":{"description":"Constraints on the abilities of the created key","type":"array","items":{"$ref":"#/definitions/Object722"}}}},"Object726":{"type":"object","properties":{"appIndexOrderField":{"description":"This attribute is deprecated","type":"string"},"appIndexOrderDir":{"description":"This attribute is deprecated","type":"string"},"resultIndexOrderField":{"description":"Order field for the reports index page.","type":"string"},"resultIndexOrderDir":{"description":"Order direction for the reports index page.","type":"string"},"resultIndexTypeFilter":{"description":"Type filter for the reports index page.","type":"string"},"resultIndexAuthorFilter":{"description":"Author filter for the reports index page.","type":"string"},"resultIndexArchivedFilter":{"description":"Archived filter for the reports index page.","type":"string"},"importIndexOrderField":{"description":"Order field for the imports index page.","type":"string"},"importIndexOrderDir":{"description":"Order direction for the imports index page.","type":"string"},"importIndexTypeFilter":{"description":"Type filter for the imports index page.","type":"string"},"importIndexAuthorFilter":{"description":"Author filter for the imports index page.","type":"string"},"importIndexDestFilter":{"description":"Destination filter for the imports index page.","type":"string"},"importIndexStatusFilter":{"description":"Status filter for the imports index page.","type":"string"},"importIndexArchivedFilter":{"description":"Archived filter for the imports index page.","type":"string"},"exportIndexOrderField":{"description":"Order field for the exports index page.","type":"string"},"exportIndexOrderDir":{"description":"Order direction for the exports index page.","type":"string"},"exportIndexTypeFilter":{"description":"Type filter for the exports index page.","type":"string"},"exportIndexAuthorFilter":{"description":"Author filter for the exports index page.","type":"string"},"exportIndexStatusFilter":{"description":"Status filter for the exports index page.","type":"string"},"modelIndexOrderField":{"description":"Order field for the models index page.","type":"string"},"modelIndexOrderDir":{"description":"Order direction for the models index page.","type":"string"},"modelIndexAuthorFilter":{"description":"Author filter for the models index page.","type":"string"},"modelIndexStatusFilter":{"description":"Status filter for the models index page.","type":"string"},"modelIndexArchivedFilter":{"description":"Archived filter for the models index page.","type":"string"},"modelIndexThumbnailView":{"description":"Thumbnail view for the models index page.","type":"string"},"scriptIndexOrderField":{"description":"Order field for the scripts index page.","type":"string"},"scriptIndexOrderDir":{"description":"Order direction for the scripts index page.","type":"string"},"scriptIndexTypeFilter":{"description":"Type filter for the scripts index page.","type":"string"},"scriptIndexAuthorFilter":{"description":"Author filter for the scripts index page.","type":"string"},"scriptIndexStatusFilter":{"description":"Status filter for the scripts index page.","type":"string"},"scriptIndexArchivedFilter":{"description":"Archived filter for the scripts index page.","type":"string"},"projectIndexOrderField":{"description":"Order field for the projects index page.","type":"string"},"projectIndexOrderDir":{"description":"Order direction for the projects index page.","type":"string"},"projectIndexAuthorFilter":{"description":"Author filter for the projects index page.","type":"string"},"projectIndexArchivedFilter":{"description":"Archived filter for the projects index page.","type":"string"},"reportIndexThumbnailView":{"description":"Thumbnail view for the reports index page.","type":"string"},"projectDetailOrderField":{"description":"Order field for projects detail pages.","type":"string"},"projectDetailOrderDir":{"description":"Order direction for projects detail pages.","type":"string"},"projectDetailAuthorFilter":{"description":"Author filter for projects detail pages.","type":"string"},"projectDetailTypeFilter":{"description":"Type filter for projects detail pages.","type":"string"},"projectDetailArchivedFilter":{"description":"Archived filter for the projects detail pages.","type":"string"},"enhancementIndexOrderField":{"description":"Order field for the enhancements index page.","type":"string"},"enhancementIndexOrderDir":{"description":"Order direction for the enhancements index page.","type":"string"},"enhancementIndexAuthorFilter":{"description":"Author filter for the enhancements index page.","type":"string"},"enhancementIndexArchivedFilter":{"description":"Archived filter for the enhancements index page.","type":"string"},"preferredServerId":{"description":"ID of preferred server.","type":"integer"},"civisExploreSkipIntro":{"description":"Whether the user is shown steps for each exploration.","type":"boolean"},"registrationIndexOrderField":{"description":"Order field for the registrations index page.","type":"string"},"registrationIndexOrderDir":{"description":"Order direction for the registrations index page.","type":"string"},"registrationIndexStatusFilter":{"description":"Status filter for the registrations index page.","type":"string"},"upgradeRequested":{"description":"Whether a free trial upgrade has been requested.","type":"string"},"welcomeOrderField":{"description":"Order direction for the welcome page.","type":"string"},"welcomeOrderDir":{"description":"Order direction for the welcome page.","type":"string"},"welcomeAuthorFilter":{"description":"Status filter for the welcome page.","type":"string"},"welcomeStatusFilter":{"description":"Status filter for the welcome page.","type":"string"},"welcomeArchivedFilter":{"description":"Status filter for the welcome page.","type":"string"},"dataPaneWidth":{"description":"Width of the data pane when expanded.","type":"string"},"dataPaneCollapsed":{"description":"Whether the data pane is collapsed.","type":"string"},"notebookOrderField":{"description":"Order field for the notebooks page.","type":"string"},"notebookOrderDir":{"description":"Order direction for the notebooks page.","type":"string"},"notebookAuthorFilter":{"description":"Author filter for the notebooks page.","type":"string"},"notebookArchivedFilter":{"description":"Archived filter for the notebooks page.","type":"string"},"notebookStatusFilter":{"description":"Status filter for the notebooks page.","type":"string"},"workflowIndexOrderField":{"description":"Order field for the workflows page.","type":"string"},"workflowIndexOrderDir":{"description":"Order direction for the workflows page.","type":"string"},"workflowIndexAuthorFilter":{"description":"Author filter for the workflows page.","type":"string"},"workflowIndexArchivedFilter":{"description":"Archived filter for the workflows page.","type":"string"},"serviceOrderField":{"description":"Order field for the services page.","type":"string"},"serviceOrderDir":{"description":"Order direction for the services page.","type":"string"},"serviceAuthorFilter":{"description":"Author filter for the services page.","type":"string"},"serviceArchivedFilter":{"description":"Archived filter for the services page.","type":"string"},"assumeRoleHistory":{"description":"JSON string of previously assumed roles.","type":"string"},"defaultSuccessNotificationsOn":{"description":"Whether email notifications for the success of all applicable jobs are on by default.","type":"boolean"},"defaultFailureNotificationsOn":{"description":"Whether email notifications for the failure of all applicable jobs are on by default.","type":"boolean"},"myActivityMetrics":{"description":"Whether the activity metrics are filtered to the current user.","type":"boolean"},"standardSQLAutocompleteDisabled":{"description":"Whether the query page includes standard SQL autocomplete.","type":"boolean"},"aiSQLAssistDisabled":{"description":"Whether the query page includes AI-powered SQL autocomplete.","type":"boolean"},"queryPreviewRows":{"description":"Number of preview rows query should return in the UI.","type":"integer"}}},"Object725":{"type":"object","properties":{"preferences":{"description":"A hash of user selected preferences. Values should be strings or null to indicate a key deletion.","$ref":"#/definitions/Object726"},"lastCheckedAnnouncements":{"description":"The date and time at which the user last checked their announcements.","type":"string","format":"date-time"}}},"Object727":{"type":"object","properties":{"name":{"description":"The name of this user.","type":"string"},"email":{"description":"The email of this user.","type":"string"},"active":{"description":"Whether this user account is active or deactivated.","type":"boolean"},"primaryGroupId":{"description":"The ID of the primary group of this user.","type":"integer"},"city":{"description":"The city of this user.","type":"string"},"state":{"description":"The state of this user.","type":"string"},"timeZone":{"description":"The time zone of this user.","type":"string"},"initials":{"description":"The initials of this user.","type":"string"},"department":{"description":"The department of this user.","type":"string"},"title":{"description":"The title of this user.","type":"string"},"prefersSmsOtp":{"description":"The preference for phone authorization of this user","type":"boolean"},"groupIds":{"description":"An array of ids of all the groups this user is in.","type":"array","items":{"type":"integer"}},"vpnEnabled":{"description":"The availability of vpn for this user.","type":"boolean"},"ssoDisabled":{"description":"The availability of SSO for this user.","type":"boolean"},"otpRequiredForLogin":{"description":"The two factor authentication requirement for this user.","type":"boolean"},"exemptFromOrgSmsOtpDisabled":{"description":"Whether the user has SMS OTP enabled on an individual level. This field does not matter if the org does not have SMS OTP disabled.","type":"boolean"},"robot":{"description":"Whether the user is a robot.","type":"boolean"},"phone":{"description":"The phone number of this user.","type":"string"},"password":{"description":"The password of this user.","type":"string"},"accountStatus":{"description":"Account status of this user. One of: \"Active\", \"Deactivated\", \"Suspended\", \"Unsuspended\"","type":"string"}}},"Object728":{"type":"object","properties":{"id":{"description":"The ID of this user.","type":"integer"},"user":{"description":"The username of this user.","type":"string"},"unlockedAt":{"description":"The time the user's account was unsuspended","type":"string","format":"date-time"}}},"Object730":{"type":"object","properties":{"urls":{"description":"URLs to receive a POST request at job completion","type":"array","items":{"type":"string"}},"successEmailSubject":{"description":"Custom subject line for success e-mail.","type":"string"},"successEmailBody":{"description":"Custom body text for success e-mail, written in Markdown.","type":"string"},"successEmailAddresses":{"description":"Addresses to notify by e-mail when the job completes successfully.","type":"array","items":{"type":"string"}},"failureEmailAddresses":{"description":"Addresses to notify by e-mail when the job fails.","type":"array","items":{"type":"string"}},"stallWarningMinutes":{"description":"Stall warning emails will be sent after this amount of minutes.","type":"integer"},"successOn":{"description":"If success email notifications are on","type":"boolean"},"failureOn":{"description":"If failure email notifications are on","type":"boolean"}}},"Object729":{"type":"object","properties":{"name":{"description":"The name of this workflow.","type":"string"},"description":{"description":"A description of the workflow.","type":"string"},"fromJobChain":{"description":"If specified, create a workflow from the job chain this job is in, and inherit the schedule from the root of the chain.","type":"integer"},"definition":{"description":"The definition of the workflow in YAML format. Must not be specified if `fromJobChain` is specified.","type":"string"},"schedule":{"description":"The schedule of when this workflow will be run. Must not be specified if `fromJobChain` is specified.","$ref":"#/definitions/Object102"},"allowConcurrentExecutions":{"description":"Whether the workflow can execute when already running.","type":"boolean"},"timeZone":{"description":"The time zone of this workflow.","type":"string"},"notifications":{"description":"The notifications to send after the workflow is executed.","$ref":"#/definitions/Object730"},"hidden":{"description":"The hidden status of the item.","type":"boolean"}},"required":["name"]},"Object732":{"type":"object","properties":{"urls":{"description":"URLs to receive a POST request at job completion","type":"array","items":{"type":"string"}},"successEmailSubject":{"description":"Custom subject line for success e-mail.","type":"string"},"successEmailBody":{"description":"Custom body text for success e-mail, written in Markdown.","type":"string"},"successEmailAddresses":{"description":"Addresses to notify by e-mail when the job completes successfully.","type":"array","items":{"type":"string"}},"failureEmailAddresses":{"description":"Addresses to notify by e-mail when the job fails.","type":"array","items":{"type":"string"}},"stallWarningMinutes":{"description":"Stall warning emails will be sent after this amount of minutes.","type":"integer"},"successOn":{"description":"If success email notifications are on","type":"boolean"},"failureOn":{"description":"If failure email notifications are on","type":"boolean"}}},"Object731":{"type":"object","properties":{"id":{"description":"The ID for this workflow.","type":"integer"},"name":{"description":"The name of this workflow.","type":"string"},"description":{"description":"A description of the workflow.","type":"string"},"definition":{"description":"The definition of the workflow in YAML format. Must not be specified if `fromJobChain` is specified.","type":"string"},"valid":{"description":"The validity of the workflow definition.","type":"boolean"},"validationErrors":{"description":"The errors encountered when validating the workflow definition.","type":"string"},"fileId":{"description":"The file id for the s3 file containing the workflow configuration.","type":"string"},"user":{"description":"The author of this workflow.","$ref":"#/definitions/Object33"},"state":{"description":"The state of the workflow. State is \"running\" if any execution is running, otherwise reflects most recent execution state.","type":"string"},"schedule":{"description":"The schedule of when this workflow will be run. Must not be specified if `fromJobChain` is specified.","$ref":"#/definitions/Object107"},"allowConcurrentExecutions":{"description":"Whether the workflow can execute when already running.","type":"boolean"},"timeZone":{"description":"The time zone of this workflow.","type":"string"},"nextExecutionAt":{"description":"The time of the next scheduled execution.","type":"string","format":"time"},"notifications":{"description":"The notifications to send after the workflow is executed.","$ref":"#/definitions/Object732"},"archived":{"description":"The archival status of the requested item(s).","type":"string"},"hidden":{"description":"The hidden status of the item.","type":"boolean"},"myPermissionLevel":{"description":"Your permission level on the object. One of \"read\", \"write\", or \"manage\".","type":"string"},"createdAt":{"type":"string","format":"time"},"updatedAt":{"type":"string","format":"time"}}},"Object733":{"type":"object","properties":{"name":{"description":"The name of this workflow.","type":"string"},"description":{"description":"A description of the workflow.","type":"string"},"definition":{"description":"The definition of the workflow in YAML format. Must not be specified if `fromJobChain` is specified.","type":"string"},"schedule":{"description":"The schedule of when this workflow will be run. Must not be specified if `fromJobChain` is specified.","$ref":"#/definitions/Object102"},"allowConcurrentExecutions":{"description":"Whether the workflow can execute when already running.","type":"boolean"},"timeZone":{"description":"The time zone of this workflow.","type":"string"},"notifications":{"description":"The notifications to send after the workflow is executed.","$ref":"#/definitions/Object730"}},"required":["name"]},"Object734":{"type":"object","properties":{"name":{"description":"The name of this workflow.","type":"string"},"description":{"description":"A description of the workflow.","type":"string"},"definition":{"description":"The definition of the workflow in YAML format. Must not be specified if `fromJobChain` is specified.","type":"string"},"schedule":{"description":"The schedule of when this workflow will be run. Must not be specified if `fromJobChain` is specified.","$ref":"#/definitions/Object102"},"allowConcurrentExecutions":{"description":"Whether the workflow can execute when already running.","type":"boolean"},"timeZone":{"description":"The time zone of this workflow.","type":"string"},"notifications":{"description":"The notifications to send after the workflow is executed.","$ref":"#/definitions/Object730"}}},"Object735":{"type":"object","properties":{"userIds":{"description":"An array of one or more user IDs.","type":"array","items":{"type":"integer"}},"permissionLevel":{"description":"Options are: \"read\", \"write\", or \"manage\".","type":"string"},"shareEmailBody":{"description":"Custom body text for e-mail sent on a share.","type":"string"},"sendSharedEmail":{"description":"Send email to the recipients of a share.","type":"boolean"}},"required":["userIds","permissionLevel"]},"Object736":{"type":"object","properties":{"groupIds":{"description":"An array of one or more group IDs.","type":"array","items":{"type":"integer"}},"permissionLevel":{"description":"Options are: \"read\", \"write\", or \"manage\".","type":"string"},"shareEmailBody":{"description":"Custom body text for e-mail sent on a share.","type":"string"},"sendSharedEmail":{"description":"Send email to the recipients of a share.","type":"boolean"}},"required":["groupIds","permissionLevel"]},"Object737":{"type":"object","properties":{"userId":{"description":"ID of target user","type":"integer"},"includeDependencies":{"description":"Whether or not to give manage permissions on all dependencies","type":"boolean"},"emailBody":{"description":"Custom body text for e-mail sent on transfer.","type":"string"},"sendEmail":{"description":"Send email to the target user of the transfer?","type":"boolean"}},"required":["userId","includeDependencies"]},"Object738":{"type":"object","properties":{"status":{"description":"The desired archived status of the object.","type":"boolean"}},"required":["status"]},"Object739":{"type":"object","properties":{"cloneSchedule":{"description":"If true, also copy the schedule to the new workflow.","type":"boolean"},"cloneNotifications":{"description":"If true, also copy the notifications to the new workflow.","type":"boolean"}}},"Object740":{"type":"object","properties":{"id":{"description":"The ID for this workflow execution.","type":"integer"},"state":{"description":"The state of this workflow execution.","type":"string"},"mistralState":{"description":"The state of this workflow as reported by mistral. One of running, paused, success, error, or cancelled","type":"string"},"mistralStateInfo":{"description":"The state info of this workflow as reported by mistral.","type":"string"},"user":{"description":"The user who created this execution.","$ref":"#/definitions/Object33"},"startedAt":{"description":"The time this execution started.","type":"string","format":"time"},"finishedAt":{"description":"The time this execution finished.","type":"string","format":"time"},"createdAt":{"description":"The time this execution was created.","type":"string","format":"time"},"updatedAt":{"description":"The time this execution was last updated.","type":"string","format":"time"}}},"Object743":{"type":"object","properties":{"id":{"description":"The ID of the run.","type":"integer"},"jobId":{"description":"The ID of the job associated with the run.","type":"integer"},"myPermissionLevel":{"description":"Your permission level on the job. One of \"read\", \"write\", \"manage\", or \"nil\".","type":"string"},"state":{"description":"The state of the run.","type":"string"},"createdAt":{"description":"The time that the run was queued.","type":"string","format":"time"},"startedAt":{"description":"The time that the run started.","type":"string","format":"time"},"finishedAt":{"description":"The time that the run completed.","type":"string","format":"time"}}},"Object744":{"type":"object","properties":{"id":{"description":"The ID of the execution.","type":"integer"},"workflowId":{"description":"The ID of the workflow associated with the execution.","type":"integer"},"myPermissionLevel":{"description":"Your permission level on the workflow. One of \"read\", \"write\", \"manage\", or \"nil\".","type":"string"},"state":{"description":"The state of this workflow execution.","type":"string"},"createdAt":{"description":"The time this execution was created.","type":"string","format":"time"},"startedAt":{"description":"The time this execution started.","type":"string","format":"time"},"finishedAt":{"description":"The time this execution finished.","type":"string","format":"time"}}},"Object742":{"type":"object","properties":{"name":{"description":"The name of the task.","type":"string"},"mistralState":{"description":"The state of this task. One of idle, waiting, running, delayed, success, error, or cancelled","type":"string"},"mistralStateInfo":{"description":"Extra info associated with the state of the task.","type":"string"},"runs":{"description":"The runs associated with this task, in descending order by id.","type":"array","items":{"$ref":"#/definitions/Object743"}},"executions":{"description":"The executions run by this task, in descending order by id.","type":"array","items":{"$ref":"#/definitions/Object744"}}}},"Object741":{"type":"object","properties":{"id":{"description":"The ID for this workflow execution.","type":"integer"},"state":{"description":"The state of this workflow execution.","type":"string"},"mistralState":{"description":"The state of this workflow as reported by mistral. One of running, paused, success, error, or cancelled","type":"string"},"mistralStateInfo":{"description":"The state info of this workflow as reported by mistral.","type":"string"},"user":{"description":"The user who created this execution.","$ref":"#/definitions/Object33"},"definition":{"description":"The definition of the workflow for this execution.","type":"string"},"input":{"description":"Key-value pairs defined for this execution.","type":"object"},"includedTasks":{"description":"The subset of workflow tasks selected to execute.","type":"array","items":{"type":"string"}},"tasks":{"description":"The tasks associated with this execution.","type":"array","items":{"$ref":"#/definitions/Object742"}},"startedAt":{"description":"The time this execution started.","type":"string","format":"time"},"finishedAt":{"description":"The time this execution finished.","type":"string","format":"time"},"createdAt":{"description":"The time this execution was created.","type":"string","format":"time"},"updatedAt":{"description":"The time this execution was last updated.","type":"string","format":"time"}}},"Object745":{"type":"object","properties":{"targetTask":{"description":"For a reverse workflow, the name of the task to target.","type":"string"},"input":{"description":"Key-value pairs to send to this execution as inputs.","type":"object"},"includedTasks":{"description":"If specified, executes only the subset of workflow tasks included as specified by task name.","type":"array","items":{"type":"string"}}}},"Object747":{"type":"object","properties":{"taskName":{"description":"If specified, the name of the task to be retried. If not specified, all failed tasks in the execution will be retried.","type":"string"}}},"Object748":{"type":"object","properties":{"name":{"description":"The name of the task.","type":"string"},"mistralState":{"description":"The state of this task. One of idle, waiting, running, delayed, success, error, or cancelled","type":"string"},"mistralStateInfo":{"description":"Extra info associated with the state of the task.","type":"string"},"runs":{"description":"The runs associated with this task, in descending order by id.","type":"array","items":{"$ref":"#/definitions/Object743"}},"executions":{"description":"The executions run by this task, in descending order by id.","type":"array","items":{"$ref":"#/definitions/Object744"}}}}},"securityDefinitions":{"api_key":{"type":"apiKey","name":"Authorization","in":"header"}},"security":[{"api_key":[]}]} \ No newline at end of file diff --git a/tests/test_io.py b/tests/test_io.py index 536547f3..cdd72008 100644 --- a/tests/test_io.py +++ b/tests/test_io.py @@ -14,7 +14,6 @@ import pytest import requests -from requests import ConnectionError, ConnectTimeout try: import pandas as pd @@ -33,7 +32,6 @@ import civis from civis.io import _files from civis._deprecation import DeprecatedKwargDefault -from civis.io._files import _retry from civis.io._tables import _File from civis.io._utils import maybe_get_random_name from civis.response import Response @@ -1416,6 +1414,60 @@ def mock_iter_content(_): ) +@mock.patch.object(_files, "requests", autospec=True) +def test_file_single_upload_retries(mock_requests): + mock_post_response = mock.Mock() + mock_post_response.content = "whatever" + failed_attempts = 2 + type(mock_post_response).ok = mock.PropertyMock( + side_effect=[False] * failed_attempts + [True] + ) + type(mock_post_response).status_code = mock.PropertyMock( + side_effect=[500] * failed_attempts + [200] + ) + mock_requests.post.return_value = mock_post_response + + mock_civis_response = mock.Mock() + mock_civis_response.upload_url = "https://fake.upload.url" + mock_civis_response.upload_fields.json.return_value = {"key": "value"} + mock_civis_response.id = 123 + mock_civis_client = create_client_mock() + mock_civis_client.files.post.return_value = mock_civis_response + + # Calling _single_upload should retry on failed attempts and eventually succeed. + _files._single_upload(io.BytesIO(b"abcdef"), "filename", mock_civis_client) + assert mock_requests.post.call_count == failed_attempts + 1 + + +@mock.patch.object(_files, "requests", autospec=True) +def test_file_multipart_upload_retries(mock_requests): + mock_post_response = mock.Mock() + mock_post_response.content = "whatever" + failed_attempts = 2 + type(mock_post_response).ok = mock.PropertyMock( + side_effect=[False] * failed_attempts + [True] + ) + type(mock_post_response).status_code = mock.PropertyMock( + side_effect=[500] * failed_attempts + [200] + ) + mock_requests.put.return_value = mock_post_response + + mock_civis_response = mock.Mock() + mock_civis_response.upload_urls = ["https://fake.upload.url"] + mock_civis_response.id = 123 + mock_civis_client = create_client_mock() + mock_civis_client.files.post_multipart.return_value = mock_civis_response + + with TemporaryDirectory() as temp_dir: + temp_path = os.path.join(temp_dir, "tempfile") + with open(temp_path, "wb") as f: + f.write(b"abcdef") + with open(temp_path, "rb") as f: + # _multipart_upload should retry on failed attempts and eventually succeed. + _files._multipart_upload(f, "filename", 6, mock_civis_client) + assert mock_requests.put.call_count == failed_attempts + 1 + + @pytest.mark.parametrize("input_filename", ["newname", None]) @mock.patch.object(_files, "requests", autospec=True) def test_file_to_civis(mock_requests, input_filename): @@ -1719,74 +1771,6 @@ def test_read_civis_sql_polars(): assert pl.read_csv(io.StringIO(expected_data)).equals(actual_data) -def test_io_no_retry(): - @_retry(ConnectionError, retries=4, delay=0.1) - def succeeds(): - counter["i"] += 1 - return "success" - - counter = dict(i=0) - test_result = succeeds() - - assert test_result == "success" - assert counter["i"] == 1 - - -def test_io_retry_once(): - @_retry(ConnectionError, retries=4, delay=0.1) - def fails_once(): - counter["i"] += 1 - if counter["i"] < 2: - raise ConnectionError("failed") - else: - return "success" - - counter = dict(i=0) - test_result = fails_once() - - assert test_result == "success" - assert counter["i"] == 2 - - -@mock.patch("civis.futures.time.sleep", side_effect=lambda x: None) -def test_io_retry_limit_reached(m_sleep): - @_retry(ConnectionError, retries=4, delay=0.1) - def always_fails(): - counter["i"] += 1 - raise ConnectionError("failed") - - counter = dict(i=0) - pytest.raises(ConnectionError, always_fails) - assert counter["i"] == 5 - - -@mock.patch("civis.futures.time.sleep", side_effect=lambda x: None) -def test_io_retry_multiple_exceptions(m_sleep): - @_retry((ConnectionError, ConnectTimeout), retries=4, delay=0.1) - def raise_multiple_exceptions(): - counter["i"] += 1 - if counter["i"] == 1: - raise ConnectionError("one error") - elif counter["i"] == 2: - raise requests.ConnectTimeout("another error") - else: - return "success" - - counter = dict(i=0) - test_result = raise_multiple_exceptions() - - assert test_result == "success" - assert counter["i"] == 3 - - -def test_io_retry_unexpected_exception(): - @_retry(ConnectionError, retries=4, delay=0.1) - def raise_unexpected_error(): - raise ValueError("unexpected error") - - pytest.raises(ValueError, raise_unexpected_error) - - @mock.patch("civis.io._utils.uuid") def test_maybe_random_name_random(mock_uuid): random_name = "11111" diff --git a/tests/test_utils.py b/tests/test_retries.py similarity index 82% rename from tests/test_utils.py rename to tests/test_retries.py index 6ad54b62..37cad2a2 100644 --- a/tests/test_utils.py +++ b/tests/test_retries.py @@ -1,19 +1,19 @@ -import copy import concurrent.futures as cf from datetime import datetime from math import floor from unittest import mock +import pytest import tenacity from requests import Request from requests import ConnectionError -from civis._utils import retry_request, DEFAULT_RETRYING -from civis._utils import _RETRY_VERBS, _RETRY_CODES, _POST_RETRY_CODES +from civis._retries import retry_request, get_default_retrying +from civis._retries import _RETRY_VERBS, _RETRY_CODES, _POST_RETRY_CODES def _get_retrying(retries: int): - retrying = copy.copy(DEFAULT_RETRYING) + retrying = get_default_retrying() stop = tenacity.stop_after_delay(600) | tenacity.stop_after_attempt(retries) retrying.stop = stop return retrying @@ -237,3 +237,43 @@ def test_retry_respect_retry_after_headers(): all_verbs = [v for v in (verbs + [v.lower() for v in verbs])] with cf.ThreadPoolExecutor() as executor: executor.map(_retry_respect_retry_after_headers, all_verbs) + + +@pytest.mark.parametrize( + "retrying, max_calls", + [ + # Simulate a user-provided tenacity.Retrying with limited max attempts. + (_get_retrying(3), 3), + # No user-provided tenacity.Retrying. Use civis-python's default retrying. + (None, 10), + ], +) +@mock.patch("civis.futures.time.sleep", side_effect=lambda x: None) +def test_no_recursion_in_retry_request(m_sleep, retrying, max_calls): + """Test that retry_request (used inside civis.APIClient) doesn't cause recursion.""" + + api_response = {"key": "value"} + mock_session = mock.MagicMock() + session_context = mock_session.return_value.__enter__.return_value + session_context.send.return_value.json.return_value = api_response + session_context.send.return_value.status_code = 429 + session_context.send.return_value.headers = {} + + # Simulate multiple API calls using the same `retrying` object. + iterations = 1001 # 1001 consecutive API calls to trigger deep recursion + for i in range(iterations): + request_info = dict( + params={"call_number": str(i)}, + json={}, + url="https://api.civisanalytics.com/test", + method="GET", + ) + request = Request(**request_info) + pre_request = session_context.prepare_request(request) + + # This should not cause recursion even after multiple calls + retry_request("GET", pre_request, session_context, retrying) + + # Verify that all calls completed without recursion error + # Each call should have attempted max_calls times + assert session_context.send.call_count == max_calls * iterations