---
id: config-list-agreement-revisions
title: "List data agreement revisions"
description: "This endpoint lists all revisions of a data agreement defined earlier in an organisation."
sidebar_label: "List data agreement revisions"
hide_title: true
hide_table_of_contents: true
api: eJztXN1yG7eSfpWuubGUIqkfW3bCOnVqZcuO6Ti2VpLj2kSuBJxpkohAYAJgJDEq3Z0n2UfbJ9nqBuaXI1mMnb04tblwRHLQaAD9+3VjbpIMXWpl7qXRyTg5W0gHqLPcSO1BSecdCKXA4qV00mgHZgYCMuEFiLlFXKL2kOFMaswAhVUSLUgNQoOxc6GlE0R6lAwSk6PlD5MsGSep0TM5fyudPyzpnJSTJIMkF1Ys0aN1yfiXmw6XH7T8o0CYHDE3Gsz0d0x9Mkgk/ZoLv0gGiRZLTMYJsVrNMMmSQWLxj0JazJKxtwUOEpcucCmS8U3iVzkNcd5KPU9ubwfdid8VyylamtViamzmwBtwFzKHmbGQi7nU1XKZlz8KtKuaGTObOfQtHmZCuT4mpPY4Rxu4iMOVXErfJd3m8EdxLZfFEnQfpxZ9YTXkyLziaCNGaKaZKJRPxnu7t7efaKzLjXbo6On93V36X2q0R+3pT5HnSqa8Hzu/O+LupkE9tyQPXobRrVNqTF6drJde0RdHrQe7qz/UDakkVoTUDvwCweWYyllkJwixk3quEPLC5sYh+IXwkAoNU6ShDrXHDLwZARxCa1qQDgotL9E6oUDorG8YTFfwzVLo1TcgdSYvZVYIRbxYU8wXINokT/iQRuc6GSTXQ238UOohbcpUOKzOpj6sX5LINqlK+OuosRMDPgdrlEL7warW53ckS4MkN0qmJD9KXM0K9Vw4SXq3RL8w2fvZByYtUi8v6Y+ZsXP0XkwVfVJyhukqVZh8GnQOUmbrisTDl8In4yQZJHgtljmf5dODJ8/29vf38dv0Wfp4On2c7qffPvluf+1Yk9tBQrstgxA9jPreaHe0u0bqbIEQSZEUeLJ3bdnwBq4WMqUjspiizFmSaA5HfNQbOeldanu6YKJIAOtxbSp0PJ8l8+HkLdFhs1sPha2lWJHcmaX0JHVyBtqEp6S+NOoSs+32bHz4n52OnvqS+aJsjbvm85i/h0JnaOMm8wG0tcstyONMEebmEq3GbATwcYEaUovCSz1fc0AD3mElPDoPYfJSJQsXtHEmleKnohGDS6EKHACrb9NTgciWUvPwDFOZIY1OF0LPEaQn18ZU2g5Q4SWqoL13Ga7jUt8ept46aGlh1dfXsWfPdvd6dUzfIR39pI/iTvJeVOakX5Joz+IjX0+Xf2rqcUkftmQw4zOjlLkKxh+Xl2gh0GYJLfq1rn/2hfe5G+/sxG9GqVnu5FZeinQ1vGPdx2iXQpNokOoK35T2S7Srtg1COG4JrUWRDcAtTKEy0MbTd4JWE2Q5SiNpB3i5RFrQ74WVLpOp32hfX35Y4/xNk9AtxRpZ4bxdnWLqjX046dcolF+kwuK6UYwkwQWatwP2/ydIkYM0+hitNNmRWLneMKR3vsdPD7rTkFWhkCcQpahHmowUOCPKt4NkjmZuRb6Q6QnSar58876vKIJtkLwdJM4bK+b41gQv80WznAZaoEpit4PEL6TNjoX1K1r26UIw0XqWqTEKhb5rmhAJr+UCNoOcaAYdd5Hq7W08sUPvrZwWHpsHJawVpBDS45K/F0q9n3EU37WNPeclKpJl/NZ2z5yA4LVIvVrBFYVskp5UClOP2WhT+9rk4OvHMgc9dra9SpgcbW54363z3ra0FfkB5yVSOy90inDOE50nYCycJ2KO52z2W4QeysSrQinQjUnrKHd9zfWnNRZZOVA76eWl9KuHi2w81I5q1JSqAKY1VSo8zo1dPXyhx2id0T2rehFJ9U/kUpNvcKZk8tcVnWhAKbZ8lt2JOD3s6lVbjBuW6F49vV87KVMP6WSD2n3a1mYitZgd4aw/Zr7Dgzw++rj344ePP6+eXxwfvP3+iT37r5PX48fjF2/H3+6Oy2x07VgsZmTyhQq4hGSxC3oW0s+vwMT++AWtja0SwvsZnOBcOh/wjfHT3nDllCdnTvi/T13V+yoW8JzdQZkdPjjULwfc9uaTnyXT0fAGtWZ6+eBdX5c+pgJTIlOZkCr8HpaZN+yAwrlQv5qpkvMQz++EDEak9Oul9EL9SrEEyTHsQF5MlUx/9cJdhMHSy6XwWD1DfOliST4jTkIJcGeSMsEWrDjtSThDryYJg9cmIVlopt5/fad+ZCq0R4VDGIImO73DduNXZwqbYvmpIADkV4f2UqZYL5MGBPcen0/ip/bzLL25FEfCfwm7ZyGZQjC6ipERjo4nh2AxN5ale46aoEPMQMw8WgJPjieHSeTgtFguhV09KJGm6T6cKMituZQZ5ZKN6RxlM2FWNwAXyAL6tIUNXaKVM4kZATxCr6A8QwyxEtk7sjRyroUvLO/N9XB2MVyaDBWZgeqXNQNR/sL4VOEXxkra8xiDmVknUd6qBjiImXm6EIzExjQ1FY6JLQvlZa4QKrbc9r3ZapPJB+JRYqUM+zDXGBs2KxiuIJmdL4+rYT3fvhZu0fmFGMPs+Yp5XaLzYpl//cjtoC9ye8+bVG11LhxhC1ORXpAoOLNEODyeVOi5gyvpF6bwhFDLDLaOf9geQIba+CB3wtMZrUBYBAHnSWbFzJ8nA5AjHIGAWhx8tPKUCq7QAyUT9SGXxxKgDK1WgNcM3NPvVlBANGK7Hrf6wTtzMxqNbntVaCa1UBAJVuw5PpsBG2Nvi5QV1oGAN6fv34FDK4UqURYzg5lElTm46Tn4MYxGowHcIRI9vwbZ6vnhkLy0SH3PT6Uo9fz05sq9RpGhHUAlZfGxsMiP4WiDSJzgDC3qFOMjQZvOVnn7i/ZjtyM4jTvS2iZKvUcwCS6uUqW2FZzizJDQ6JVfkCzR3veLxBbJxIKps/h5wtHoiQ5LJdjQAPdm1iwDrhKPeVp4htHCNGyJr4TN3GjN3j1MvHD1ZjH9PpXv5ZtXP788OfvP0zffjUaj+81iycxCuEWA/QLxMiiod6xeUQyfgslG6Rdoe4SHkqJeGYiIVdeOPTyDz/YPDva+q5axv7u/HhwewhUqNbzQ5kpDIFjbiuAYQ3zAxQdHoOhPQsks4JhuDGfPj0bA5bulnC8YMsLrXOgMMzZE4IqcPBtmrVVGqo7GosXSuAlYSi2XQoFD3tt6dBwAGlN0TtjVqLtBx1/H0EzIsWqh1Koh+q7WmQ6ElgW4Jwo0n3WtiME2dmR+yPJwzWEbw8q6ph9DA1lmXI61846Vsp968GrF3nQ/fZw9wYPZ0z557113ale5r8Alkv5y3SwAXHDCygKzB6l/NLM+U9pdTGkqvyCaO2zLlogUS7NEVGLtLRWa4pRwJAOQSzHHQUN70add/irX/2D+MpmNL3A1/vPpjxezvq1+jqko2HOC5KRxJtE+Is8ZCLKCiNUa4sqWJ1hlARoDLMsmODrDxvjg5nkYK5Kca6nnI5i0QzTROeJqKwYBNWZvWRq1KjGkoKPmnBECZcwFSW+RVxZtVQa6IRGBC1w17WUVYvYwpY0ePoSxtMWXAH5EqAYq9MgxXOQGhMQyohKL1APApZAKRJZZdA4dDONeCnBa5G5hfNjWqdShkN229F9ph6Pp8yG+maPNLTVBrMFbj1xrH7ndgQ+CJnIDEODNBeragRaOhWpyBA6d4/aAXtE+3CBDvg9tOzl8dQavJi/fHo3hNPq+UAW3qAKGsJA5TNFfYQwHmtlGY2N1FtcepmpkaKUfTo1O0WoXfY90NAdeCu1ZGF/EvDzUt90Ijo1zcqqw8lvnjaWcJ7BDgTBSfu3xPFnbqNopf4GRUmxfqbJdytK6e2/Hg2TgeTe6hxblZ060BLz5eNp0UMG4wdbJqxfPDvYOuPBUJy0PXsD+7v6T4e7ecO/gbG93/Hh3vLv783pUXtItNSBylhbWoiaoqKGs0ulHnlW+qp3F43QGpH8UMg2ihnaYW2NmZYh3V+T7hbDtRGeMpLmg511HfSUcKJx5mCqhL0pv0hMK8Gh6OvBKXNcxwCZgbGhEuhdkD1gicFrfz3ZMA6mF5KdK2quzKWH4crLzpAE1NTioI+tP1XL69v0vpLlPn/akuYfgVsslEshb2QvYCXluFV6VitOIsDp7P4KPyKltLYG/F86H/VKlnQlhl+GQvLY7WyIAGdu0Q9VjUPaHwVawQxGQEVV3WrTy0eaExqcBOfdGp0CsEqNPt0ehkhWbXB4swesWZa07KJBki6Hxqq/Vx1U9Q9TUEES12WTztbgJs5W+jSwrRZNX3E4R90kGpCKz4koPKNKV3gUIgU864g5VuM92XRSZ9GIqlfQh/k/NMheeLDsZiFiZ/zzQ3kLG7u/t+jg5HgcnE41Y22Ywdl4fQrnLpVMnHGSG1taJrXQANdeQkxCZwrWEifWcdL7FWoDY6yaoz6KOzPqLoAfwthwHzjPwGaZpzTCC7mOOdansZlkKTQVgGTMFuDL2YqbMlWOR63YOuKCR1AYhtJcpLFGQSrlwlEFW+/cv9LSUVokRqiQcNglSAIGFFx8ocDgNyPA9NaaHlYCLEIUEau3eHOJ3vf1m06JvbDsYJFUBfQ1A3Kwge6+fyO5fU6h/btZb0VN+oQZcFxsqypm706iNmw/unKgkdddUsT3mSLjF1Aib3QHObzhrpApZSRYKq/pZCOU1k6M+zOVps372+VLnWTOtiT2k74nS8aTTK5iZtIgd0ERgWuZZh8eTR3UftRsEr0e5AcEQZR90QM5IPk650PLFmhPrO/8eKtOzmP/Xlb9NV265QFD2r9/XgX1cP7VW5A8u7ljMm5LQbCBvFeqjQ6RW9AgFNJe2R9mS8UJNOg0Kd9E7o4cbje+sOiAuhVSxb7mivX9QEide/wpxYtpRPZryPA1lZ37dj8YRAn35edrvOiyX/fmt3di9HSQL4Y5jmNIbIN6VVMlZwKseEVxVBTrdKVj7wyzv8Nr/9Rk0Xvs16tRhxlJWXSXhQt1dzSeltJ3clYodwjeMjsr0mzpkC8lYKvJQFO1kifFuQrjDolcxg3vkypsA1lzVMAZXSlwRUnhvYG/7LviIjfr+doiJCXg61+f60FHrcAUBnSeuSCmANvY8oW6NYkmxds15Xa2gsFxmSJGqMunFJk1tksuvvKrYIxb2k6+9hD/JT7A9t/JPoeSfmJ1GiC1+G76Mlde/scTam3tWGV6zXeeunvU7MN97k4hSfdSKjoTJnyehskV+EtOFlqmg+07CUatN41gEV77OG0y1MvbuvHVj8Ho61sjkN+lFevB9CSrRHv9QGfsow1V+XmlEjY+wWHyFwnBzLtmdqgdAai3/qyFHk6wHMuoR+ZgHC5UWKtwsaGvAqKZHeaQrpg7/KAKYMcW6GBoqoD0q9YU7WqoDZiEk2oqlYipFbYeacSgXH+a5WoX68QuhDcuw/DNEHdx2Rlkg+5XJy7NXcPLqBXz77NuDEcCkcU9KxCsSsTDfxrnwOsXcgyuCFZtQg3prs5qfyw2I3Wgdu/KXKmX3/b22ca9jfazvzLdOXx8O9/7vwFiWsdLOk4wtRJ4jI2QT3zAwk9P38O3T3T34cPYitESVvf0RnP+Til+TCiwPqrOuDRGqnxzV7T3lhcY2qffksTeyP08OnuyJfXyKzw6efre7u7v35EBMd9eL2SdNmFCUV2qoDBK0lBoSIu4VgJgK7iRhKR1lYK2FEDWigc/cu5q1CQcUC5Shuk7ztlD5wCBgm8QwwV8VEyFAxwzDx83k92HSmz5eF6AAvVt0jML5upLKEUUDqwoQZ2pyWSJbHWVr83+6eZtGk9W+GupmvMLWFUJmqP5AvQ4xcFx7qsaRCQLWhm7tUPDYyo4bX8S4MdxM6OmprXvmqpCd9G3/2cHT3e3G7Wa68UxIWTj+WaEUufAFl5wo7CH6T8JN1/Y0U0GOIC+4rBJuLvcM3NvoimwztENrjX1hMo6p6e9me+6n9Ua+drBWj+7LRqqzfrJLWcYa+R5RqcXjec/Cub157Q6jro3P2tYcbHh7+N9ra8qODwYI0QJP09mjAH0Ulu9I/HKTHObyB6Q/P9ENgOcoLNrDwi/4G1q1mBNulLRxXdqP62ELxBqmtshUn4ntPphLOTR2WN7W4FsgFJP1POpS1MJKUxoTT2M45/vlJrkgvu9lY5BwebjJDq2yf+AaW/XowN7dQys26yEJbd4ytnglc76tz28UGCc74Z0FOxSLDSuTsnPTecXA7Y5tvMggHGnfWwyOcGniicebnvVVwwyXZihyOZJzK7QfSbNzuZ+sv5Dg1BMaM7+LjAs/91D6VItTCBBZGUqhqmHI8EV85UCQx/p1BodRoUs0qJOhH0+4Q4LUnjpUwp5zo1ndl0TG/7cWnd8gTANLKhdO2TfM5HXZxvZb4BF+gy1tfGjX8FbIUFLMRYrbA8DRfNQhO4Y48B8rU1jakeEFrv75G8fuTfW5Sab86VXpDd98PFtfG/uH2OgRO4GZvUAp8kxpR4sJqHaQTRnHCDygDmjo6NizUQ9RaRNjVxb3yZCtCc14/1EdaX0k8vv6q7Ys1A+v2Z9qEGz9z7/+ezu0NZ1eYSbdImQeeB1boLpNEFVNI3TUo+WotnAMsKrZ0FHPFMp52WDlV2VnBWFyFAXGyzrcOJPJOd2dgCtKtn1oyDPU5ZibLGTnRpm5pC4b1GKqQl2YSqx8A5shNLKlDLGH6iQTEYU3y5Dhce1K8nU4PrDYNjgvYmcM97YCe/6yyqmoLVJrtCN+90GKOtzQKLUgF+kCYZ+v/LT3/OrqaiT455Gx85041u28nbx4+e705ZDG3NZgV30OpDtlcaHUrurWNCcho8ejvXDX3vml0A1++KZW54J60yJ1rvtVPvdvfflLlG6P134nV0Lqxi3sYF5/ia+EiZDJsFmrGPe9xaVc0adBsjDOE4WbGwrvPlh1e0tfh1eksOWVjs4x60cRmpuwySteehcVPE31ppfarww2YWPT97jcw0qJTbc83KWwMjQabLQ7Wycx8NqGO1/C08tK6U/0qslJyWL3eLl4F21lHTGQ0c2bK1mLEVu++/uXZLdFNOq1Q7tghxb/aFTW2rx1fVtggf5t3LhsD/kHae0PuPpn9Xj45c4BlTcIT9NOUSXmfwFVVJRM
sidebar_class_name: "get api-method"
info_path: docs/consent-management-admin-api/igrant-io-api-documentation
custom_edit_url: null
---

> **Build this with an AI coding agent.** Install the iGrant.io Agent Skills, then ask your agent to build the integration:
>
> ```bash
> npx skills add L3-iGrant/skills
> ```


import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>List data agreement revisions</h1>

<MethodEndpoint method={"get"} path={"/config/data-agreement/{dataAgreementId}/revisions"}></MethodEndpoint>



This endpoint lists all revisions of a data agreement defined earlier in an organisation.

## Request

<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"description":"Unique ID of an object","in":"path","name":"dataAgreementId","required":true,"schema":{"type":"string"}}}></ParamsItem></ul></div></details><details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Query Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"description":"Number of records to skip for pagination.","in":"query","name":"offset","required":false,"schema":{"type":"integer"}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"name":"limit","in":"query","description":"Maximum number of records to return per page.","required":false,"schema":{"type":"integer","default":10}}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

Data agreement (based on ISO 27560) revisions listed successfully

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>dataAgreement</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

An agreement contains the specification of a single purpose that can be consented to.  A DataAgreement is universal and can be consented to by *many* individuals through a DataAgreementRecord.


</div><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"65471222e8c7c3bb3c2c8492","description":""}}></SchemaItem><SchemaItem collapsible={false} name={"version"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"1.0.0","description":"The version of this specification to which a receipt conforms"}}></SchemaItem><SchemaItem collapsible={false} name={"controllerId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"ID of the controller"}}></SchemaItem><SchemaItem collapsible={false} name={"controllerUrl"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"URL of data controller (may be omitted if no data involved)"}}></SchemaItem><SchemaItem collapsible={false} name={"controllerName"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Name of data controller (may be omitted if no data involved)"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>policy</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Policy under which this DataAgreement shall be governed.  When creating a data agreement, the latest policy can be used to fill the default value,  and organisation admin can decide to change it in the data agreement level.


</div><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"65471222e8c7c3bb3c2c7701","description":""}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"Default data policy","description":"Name of the policy"}}></SchemaItem><SchemaItem collapsible={false} name={"version"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"1.0.0","description":"Version of the policy (it can follow the semver format)"}}></SchemaItem><SchemaItem collapsible={false} name={"url"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"https://example.com/privacy-policy","description":"Permanent URL at which this very version of the Policy can be read, should not be allowed to change over time"}}></SchemaItem><SchemaItem collapsible={false} name={"jurisdiction"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"EU","description":"Jurisdiction"}}></SchemaItem><SchemaItem collapsible={false} name={"industrySector"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"Healthcare","description":"Industry sector"}}></SchemaItem><SchemaItem collapsible={false} name={"dataRetentionPeriodDays"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","format":"","example":365,"description":"Data retention period in days"}}></SchemaItem><SchemaItem collapsible={false} name={"geographicRestriction"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"EU","description":"Geographic restriction"}}></SchemaItem><SchemaItem collapsible={false} name={"storageLocation"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"EU","description":"Storage location"}}></SchemaItem><SchemaItem collapsible={false} name={"thirdPartyDataSharing"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","format":"","example":true,"description":"Third party data sharing"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"dataAttributes"} required={false} schemaName={"object[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"allOf":[{"type":"object","description":"Data attributes contain specifications of exactly what is collected.","x-not-in-database":false,"required":["name","description"],"properties":{"id":{"type":"string","format":"","example":"65471222e8c7c3bb3c2c8501","description":"Data attribute ID"},"name":{"type":"string","format":"","example":"Name","description":"Name of the attribute, for instance \"name\" or \"age\""},"description":{"type":"string","format":"","example":"Full name of the individual","description":"Description of the attribute"},"sensitivity":{"type":"boolean","format":"","example":false,"description":"Sensitivity of data attribute"},"category":{"type":"string","format":"","example":"Personal","description":"Category of data attribute"},"scope":{"type":"string","format":"","example":"read","description":"Scope required for data attribute"}}},{"type":"object","properties":{"restrictions":{"type":"array","items":{"type":"object","description":"List of restrictions","x-not-in-database":false,"properties":{"credDefId":{"type":"string","format":"","example":"H3DW1MUWZyBkP5LG4rTYRH:3:CL:80:default","description":"Credential definition ID"},"schemaId":{"type":"string","format":"","example":"H3DW1MUWZyBkP5LG4rTYRH:2:Certificate Of Registration:6.0.0","description":"Schema ID"}}}}}}]},"description":"Data attributes contain specifications of exactly what is collected.\n"}}></SchemaItem><SchemaItem collapsible={false} name={"purpose"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Name of purpose"}}></SchemaItem><SchemaItem collapsible={false} name={"purposeDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Description of purpose"}}></SchemaItem><SchemaItem collapsible={false} name={"lawfulBasis"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`consent`, `legal_obligation`, `contract`, `vital_interest`, `public_task`, `legitimate_interest`]"} schema={{"type":"string","format":"","example":"","description":"Lawful basis of the agreement - consent / legal_obligation / contract / vital_interest / public_task / legitimate_interest","enum":["consent","legal_obligation","contract","vital_interest","public_task","legitimate_interest"]}}></SchemaItem><SchemaItem collapsible={false} name={"methodOfUse"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`null`, `data_source`, `data_using_service`]"} schema={{"type":"string","format":"","example":"","description":"Method of use - null / data_source / data_using_service","enum":[null,"data_source","data_using_service"]}}></SchemaItem><SchemaItem collapsible={false} name={"dpiaDate"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"","description":"The date on which the DPIA report is generated after a DPIA"}}></SchemaItem><SchemaItem collapsible={false} name={"dpiaSummaryUrl"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The URl providing the DPIA result reports, summary etc that can be verified by any interested parties"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>signature</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Signature of authorising party of DataAgreement (Signatures may be chained in the case of multiple signatures)


</div><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"65471222e8c7c3bb3c2c5501","description":"Objects may be passed back by some API endpoints without an id (PK), denoting that they are a \"draft\", i.e. a Signature that is not yet stored in the database and only exists in transit."}}></SchemaItem><SchemaItem collapsible={false} name={"payload"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"{...}","description":"The final payload that is signed, constructed as a JSON serialisation of fields {verificationPayload: ..., verificationPayloadHash: ..., verificationMethod: ..., verificationArtifact: ..., verificationSignedBy: ..., verificationJwsHeader, timestamp: ..., signedWithoutObjectReference: ..., objectType: ..., objectReference: ...}. Serialised as a JSON dict. If the signature is generated before anything is stored in the database (and has a PK), then the objectReference should be omitted from the payload but filled in afterwards."}}></SchemaItem><SchemaItem collapsible={false} name={"signature"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"eyJhbGciOiJFZERTQSJ9...","description":"Signature of payload hash, the format of the signature should be specified by either verificationMethod or verificationJwsHeader"}}></SchemaItem><SchemaItem collapsible={false} name={"verificationMethod"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"Ed25519Signature2020","description":"A well-known string denoting which method is used. Valid values: TBD. This might be expanded with supported verification methods. There may be a minimal set of supported methods necessary."}}></SchemaItem><SchemaItem collapsible={false} name={"verificationPayload"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"{...}","description":"Internally generated serialised version of the data referenced by objectType and objectReference - by extracting and serialising their data as JSON"}}></SchemaItem><SchemaItem collapsible={false} name={"verificationPayloadHash"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"a1b2c3d4e5f6...","description":"Internally generated cryptographic hash of the value to be signed, i.e. the value of verificationPayload"}}></SchemaItem><SchemaItem collapsible={false} name={"verificationArtifact"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"","description":"A verification artifact in the form of a scanned object, image, signature etc"}}></SchemaItem><SchemaItem collapsible={false} name={"verificationSignedBy"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"did:key:z6Mkf...","description":"Because an identifier's information may change over time, there is a need to store that information at the time of signing. In the case of a cryptographic signature, this field should contain some identifier for looking up or verifying the public key of the signing party. In the case of a non-cryptographic signature, this field could contain a natural individual's names, personal number, email addresses - store a snapshot that binds to the signature at the time of signing. In the case of a cryptographic signature, this may be the fingerprint of the individual's public key or in some cases, a token from the user's ID session."}}></SchemaItem><SchemaItem collapsible={false} name={"verificationSignedAs"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"individual","description":"DRAFT FIELD: Specifies the relationship between the authorising signature and the invidual which the payload concerns. This is relevant for Consent Records. Possible values: \"individual\" / \"delegate\"."}}></SchemaItem><SchemaItem collapsible={false} name={"verificationJwsHeader"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"","description":"Alternative to the verificationMethod, verificationHash and verificationSignature, give a JWS serialised object (RFC7515)"}}></SchemaItem><SchemaItem collapsible={false} name={"timestamp"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"2024-01-15T10:30:00Z","description":"Timestamp of signature, currently this field isn't part of the payload so it's not tamper-proof"}}></SchemaItem><SchemaItem collapsible={false} name={"signedWithoutObjectReference"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","format":"","example":false,"description":"Indicates that objectReference was left blank in the serialised version that was signed"}}></SchemaItem><SchemaItem collapsible={false} name={"objectType"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`revision`, `signature`]"} schema={{"type":"string","format":"","example":"revision","description":"Name of the schema model that objectReference points to. Values: \"signature\" or \"revision\"","enum":["revision","signature"]}}></SchemaItem><SchemaItem collapsible={false} name={"objectReference"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"65471222e8c7c3bb3c2c6601","description":"A symmetric relation / back reference to the objectType that was signed. We are currently just modelling signing another signature (a chain) or signing a Revision (which can be a revision of a consent record, an agreement, policy etc)."}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"active"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","format":"","example":"","description":"DataAgreement is active and new DataAgreementRecords can be created"}}></SchemaItem><SchemaItem collapsible={false} name={"forgettable"} required={true} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","format":"","example":"","description":"DataAgreementRecord may be deleted when consent is withdrawn, as its existence is not necessary for auditability."}}></SchemaItem><SchemaItem collapsible={false} name={"compatibleWithVersionId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","x-fk-model":"DataAgreement","description":"WIP: This field indicates that Data Agreement Records may be transferred from this  compatible previous revision of the same DataAgreement\n"}}></SchemaItem><SchemaItem collapsible={false} name={"lifecycle"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`draft`, `complete`]"} schema={{"type":"string","description":"WIP: Current Lifecycle state of the DataAgreement.  Lifecycle states are used to manage internal workflows and  should not be assigned semantic meanings for active Data Agreement Records.\n","enum":["draft","complete"]}}></SchemaItem><SchemaItem collapsible={false} name={"dataUsingServices"} required={false} schemaName={"undefined[]"} qualifierMessage={undefined} schema={{"type":"array","items":[{"type":"object","description":"Data using service organisation for the data agreement","x-not-in-database":false,"required":["name","sector","location"],"properties":{"name":{"type":"string","format":"","example":"","description":"Name of the data using service organisation"},"sector":{"type":"string","format":"","example":"","description":"Defines sector of the organisation"},"location":{"type":"string","format":"","example":"","description":"Defines location of the organisation"},"privacyDashboardUrl":{"type":"string","format":"","example":"","description":"Defines privacy dashboard url of the organisation"}}}]}}></SchemaItem><SchemaItem collapsible={false} name={"openApiSpecification"} required={false} schemaName={"object"} qualifierMessage={undefined} schema={{"type":"object","description":"This field contains OpenAPI specification document describing the API's endpoints, models, and operations."}}></SchemaItem><SchemaItem collapsible={false} name={"dataSources"} required={false} schemaName={"undefined[]"} qualifierMessage={undefined} schema={{"type":"array","items":[{"type":"object","description":"Data source organisation for the data agreement","x-not-in-database":false,"required":["name","sector","location"],"properties":{"name":{"type":"string","format":"","example":"","description":"Name of the data source organisation"},"sector":{"type":"string","format":"","example":"","description":"Defines sector of the organisation"},"location":{"type":"string","format":"","example":"","description":"Defines location of the organisation"},"privacyDashboardUrl":{"type":"string","format":"","example":"","description":"Defines privacy dashboard url of the organisation"}}}]}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>pagination</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"currentPage"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Current page number","example":1}}></SchemaItem><SchemaItem collapsible={false} name={"totalItems"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Total number of items available","example":25}}></SchemaItem><SchemaItem collapsible={false} name={"totalPages"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Total number of pages based on limit","example":3}}></SchemaItem><SchemaItem collapsible={false} name={"limit"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Number of items per page","example":10}}></SchemaItem><SchemaItem collapsible={false} name={"hasPrevious"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates if there's a previous page","example":false}}></SchemaItem><SchemaItem collapsible={false} name={"hasNext"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Indicates if there's a next page","example":true}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>revisions</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"65471222e8c7c3bb3c2c6601","description":"Revision ID"}}></SchemaItem><SchemaItem collapsible={false} name={"schemaName"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`dataAgreement`, `policy`, `dataAgreementRecord`]"} schema={{"type":"string","format":"","example":"dataAgreement","description":"Previously \"schema\" but for technical reasons should be called \"schemaName\"","enum":["dataAgreement","policy","dataAgreementRecord"]}}></SchemaItem><SchemaItem collapsible={false} name={"objectId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"65471222e8c7c3bb3c2c8492","description":"The PK of the object that was serialised"}}></SchemaItem><SchemaItem collapsible={false} name={"objectData"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"{...}","description":"The object that is serialised"}}></SchemaItem><SchemaItem collapsible={false} name={"signedWithoutObjectId"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","format":"","example":false,"description":"Indicates that objectId was left blank in serizalizedSnapshot when calculating serializedHash. objectId may subsequently be filled in."}}></SchemaItem><SchemaItem collapsible={false} name={"serizalizedSnapshot"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"{...}","description":"Revisioned data (sed as JSON) as a dict. Apply JSON Canonicalization Scheme as per IETF RFC 8785.  It contains all the fields of the schema except sucessorId, serializedHash, serializedSnapshot.\n"}}></SchemaItem><SchemaItem collapsible={false} name={"serializedHash"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2","description":"Hash of serizalizedSnapshot (SHA-1)"}}></SchemaItem><SchemaItem collapsible={false} name={"timestamp"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"2024-01-15T10:30:00Z","description":"Timestamp of when revisioning happened. It should be ISO 8601 UTC date time"}}></SchemaItem><SchemaItem collapsible={false} name={"authorizedByIndividualId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Individual ID","type":"string"}}></SchemaItem><SchemaItem collapsible={false} name={"authorizedByOtherId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"64541a2e6e7569000145ab00","description":"Reference to an admin user that has created this revision"}}></SchemaItem><SchemaItem collapsible={false} name={"successorId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"x-fk-model":"Revision","type":"string","description":"If this revision is no longer the latest revision, refer to its successor"}}></SchemaItem><SchemaItem collapsible={false} name={"predecessorHash"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3","description":"Tamper-resistent artifact from previous record, copied from serializedHash"}}></SchemaItem><SchemaItem collapsible={false} name={"predecessorSignature"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","format":"","example":"c3d4e5f6a1b2...","description":"Tamper-resistent artifact from previous record (we don't know if the previous record was signed or not)"}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"dataAgreement\": {\n    \"id\": \"65471222e8c7c3bb3c2c8492\",\n    \"version\": \"1.0.0\",\n    \"controllerId\": \"string\",\n    \"controllerUrl\": \"string\",\n    \"controllerName\": \"string\",\n    \"policy\": {\n      \"id\": \"65471222e8c7c3bb3c2c7701\",\n      \"name\": \"Default data policy\",\n      \"version\": \"1.0.0\",\n      \"url\": \"https://example.com/privacy-policy\",\n      \"jurisdiction\": \"EU\",\n      \"industrySector\": \"Healthcare\",\n      \"dataRetentionPeriodDays\": 365,\n      \"geographicRestriction\": \"EU\",\n      \"storageLocation\": \"EU\",\n      \"thirdPartyDataSharing\": true\n    },\n    \"dataAttributes\": [\n      {\n        \"id\": \"65471222e8c7c3bb3c2c8501\",\n        \"name\": \"Name\",\n        \"description\": \"Full name of the individual\",\n        \"sensitivity\": false,\n        \"category\": \"Personal\",\n        \"scope\": \"read\",\n        \"restrictions\": [\n          {\n            \"credDefId\": \"H3DW1MUWZyBkP5LG4rTYRH:3:CL:80:default\",\n            \"schemaId\": \"H3DW1MUWZyBkP5LG4rTYRH:2:Certificate Of Registration:6.0.0\"\n          }\n        ]\n      }\n    ],\n    \"purpose\": \"string\",\n    \"purposeDescription\": \"string\",\n    \"lawfulBasis\": \"\",\n    \"methodOfUse\": \"\",\n    \"dpiaDate\": \"\",\n    \"dpiaSummaryUrl\": \"string\",\n    \"signature\": {\n      \"id\": \"65471222e8c7c3bb3c2c5501\",\n      \"payload\": \"{...}\",\n      \"signature\": \"eyJhbGciOiJFZERTQSJ9...\",\n      \"verificationMethod\": \"Ed25519Signature2020\",\n      \"verificationPayload\": \"{...}\",\n      \"verificationPayloadHash\": \"a1b2c3d4e5f6...\",\n      \"verificationArtifact\": \"\",\n      \"verificationSignedBy\": \"did:key:z6Mkf...\",\n      \"verificationSignedAs\": \"individual\",\n      \"verificationJwsHeader\": \"\",\n      \"timestamp\": \"2024-01-15T10:30:00Z\",\n      \"signedWithoutObjectReference\": false,\n      \"objectType\": \"revision\",\n      \"objectReference\": \"65471222e8c7c3bb3c2c6601\"\n    },\n    \"active\": \"\",\n    \"forgettable\": \"\",\n    \"compatibleWithVersionId\": \"string\",\n    \"lifecycle\": \"draft\",\n    \"dataUsingServices\": [\n      null\n    ],\n    \"openApiSpecification\": {},\n    \"dataSources\": [\n      null\n    ]\n  },\n  \"pagination\": {\n    \"currentPage\": 1,\n    \"totalItems\": 25,\n    \"totalPages\": 3,\n    \"limit\": 10,\n    \"hasPrevious\": false,\n    \"hasNext\": true\n  },\n  \"revisions\": [\n    {\n      \"id\": \"65471222e8c7c3bb3c2c6601\",\n      \"schemaName\": \"dataAgreement\",\n      \"objectId\": \"65471222e8c7c3bb3c2c8492\",\n      \"objectData\": \"{...}\",\n      \"signedWithoutObjectId\": false,\n      \"serizalizedSnapshot\": \"{...}\",\n      \"serializedHash\": \"a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2\",\n      \"timestamp\": \"2024-01-15T10:30:00Z\",\n      \"authorizedByIndividualId\": \"string\",\n      \"authorizedByOtherId\": \"64541a2e6e7569000145ab00\",\n      \"successorId\": \"string\",\n      \"predecessorHash\": \"b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3\",\n      \"predecessorSignature\": \"c3d4e5f6a1b2...\"\n    }\n  ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>

bad input parameter

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal server error

</div><details style={{"textAlign":"left","marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collaposed={true} open={false}><summary style={{}}><strong>Response Headers</strong></summary><ul style={{"marginLeft":"1rem"}}></ul></details><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"errorCode"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":400}}></SchemaItem><SchemaItem collapsible={false} name={"errorDescription"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Bad input parameter"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"errorCode\": 400,\n  \"errorDescription\": \"Bad input parameter\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>