{"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"v0"},"servers":[{"url":"http://localhost","description":"Generated server url"}],"tags":[{"name":"Drafts API","description":"The API for saving, updating, finding or deleting draft case data"},{"name":"Elastic Based Search API","description":"Internal ElasticSearch based case search API, returning extra information required by the UI for display purposes on a UI."},{"name":"Elastic Based Search API","description":"ElasticSearch based search API"},{"name":"/","description":"Case access API"}],"paths":{"/internal/case-types/{ctid}/drafts/{did}":{"put":{"tags":["ui-drafts-controller"],"summary":"Update draft as a caseworker.","operationId":"updateDraft","parameters":[{"name":"ctid","in":"path","required":true,"schema":{"type":"string"}},{"name":"did","in":"path","required":true,"schema":{"type":"string"}},{"name":"experimental","in":"header","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CaseDataContent"}}},"required":true},"responses":{"200":{"description":"Draft updated","content":{"application/vnd.uk.gov.hmcts.ccd-data-store-api.ui-draft-update.v2+json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/DraftViewResource"}}}},"422":{"description":"One of: cannot find event in requested case type or unable to sanitize document for case field","content":{"application/vnd.uk.gov.hmcts.ccd-data-store-api.ui-draft-update.v2+json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/DraftViewResource"}}}},"500":{"description":"Draft store is down.","content":{"application/vnd.uk.gov.hmcts.ccd-data-store-api.ui-draft-update.v2+json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/DraftViewResource"}}}}}}},"/documentData/caseref/{caseRef}":{"put":{"tags":["case-file-view-controller"],"summary":"Document Data Endpoint","description":"Document Data Endpoint","operationId":"updateDocumentField","parameters":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentDataRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/CategoriesAndDocuments"}}}}}}},"/caseworkers/{uid}/jurisdictions/{jid}/case-types/{ctid}/event-trigger/{etid}/drafts/{did}":{"put":{"tags":["Drafts API"],"summary":"Update draft as a caseworker.","operationId":"updateDraftForCaseWorker","parameters":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CaseDataContent"}}},"required":true},"responses":{"200":{"description":"Draft updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DraftResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DraftResponse"}}}}}}},"/cases/{caseReference}/users/{userId}":{"put":{"tags":["case-user-controller"],"description":"Update a user's roles for a specific case. Grant access for added case roles and revoke access for removed case roles.","operationId":"putUser","parameters":[{"name":"caseReference","in":"path","required":true,"schema":{"type":"string"}},{"name":"userId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CaseUser"}}},"required":true},"responses":{"204":{"description":"Access granted"},"400":{"description":"Case role does not exist"},"403":{"description":"Grant action is reserved to users with entire jurisdiction access"},"404":{"description":"Case not found"}}}},"/searchCases":{"post":{"tags":["Elastic Based Search API"],"description":"Search cases according to the provided ElasticSearch query. Supports searching across multiple case types.","operationId":"searchCases","parameters":[{"name":"ctid","in":"query","description":"Comma separated list of case type ID(s) or '*' if the search should be applied on any existing case type. Note that using '*' is an expensive operation and might have low response times so always prefer explicitly listing the case types when known in advance","required":true,"schema":{"type":"array","items":{"type":"string"}}},{"name":"data_classification","in":"query","required":false,"schema":{"type":"boolean","default":true}},{"name":"global","in":"query","required":false,"schema":{"type":"boolean","default":false}}],"requestBody":{"content":{"application/json":{"schema":{"type":"string","description":"Native ElasticSearch Search API request. Please refer to the ElasticSearch official documentation. For cross case type search, the search results will contain only metadata by default (no case field data). To get case data in the search results, please state the alias fields to be returned in the _source property for e.g. \"_source\":[\"alias.customer\",\"alias.postcode\"]"}}},"required":true},"responses":{"200":{"description":"List of case data for the given search request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CaseSearchResult"}}}}}}},"/internal/searchCases":{"post":{"tags":["Elastic Based Search API"],"description":"Search cases according to the provided ElasticSearch query. Supports searching a single case type and a use case.","operationId":"searchCases_1","parameters":[{"name":"Case type ID for search.","in":"query","required":true,"schema":{"type":"string"}},{"name":"Use case for search. Examples include `WORKBASKET`, `SEARCH` or `orgCases`. Used when the list of fields to return is configured in the CCD definition.\nIf omitted, all case fields are returned.","in":"query","required":false,"schema":{"type":"string"}},{"name":"global","in":"query","required":false,"schema":{"type":"boolean","default":false}},{"name":"jsonSearchRequest","in":"query","description":"A wrapped native ElasticSearch Search API request as a JSON string. Please refer to the following for further information:\n- [Official ElasticSearch Documentation - Search APIs](https://www.elastic.co/guide/en/elasticsearch/reference/current/search.html)\n- [Official ElasticSearch Documentation - Query DSL](https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl.html)\n- [CCD ElasticSearch API LLD](https://tools.hmcts.net/confluence/pages/viewpage.action?pageId=843514186)\n\nNote that for backward compatibility this API also supports unwrapped native ElasticSearch requests (i.e. requests consisting of a native query instead of being wrapped in a `native_es_query` object).","required":true,"example":{"native_es_query":{"query":{"match_all":{}},"sort":[{"reference.keyword":"asc"}],"size":20,"from":1},"supplementary_data":["orgs_assigned_users"]}}],"requestBody":{"content":{"application/json":{"schema":{"type":"string","description":"A wrapped native ElasticSearch Search API request as a JSON string. Please refer to the following for further information:\n- [Official ElasticSearch Documentation - Search APIs](https://www.elastic.co/guide/en/elasticsearch/reference/current/search.html)\n- [Official ElasticSearch Documentation - Query DSL](https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl.html)\n- [CCD ElasticSearch API LLD](https://tools.hmcts.net/confluence/pages/viewpage.action?pageId=843514186)\n\nNote that for backward compatibility this API also supports unwrapped native ElasticSearch requests (i.e. requests consisting of a native query instead of being wrapped in a `native_es_query` object)."}}},"required":true},"responses":{"200":{"description":"Success.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CaseSearchResultViewResource"}}}},"400":{"description":"Request is invalid. For some other types HTTP code 500 is returned instead.\nExamples include:\n- Unsupported use case specified in `usecase` query parameter.\n- No case type query parameter `ctid` provided.\n- Query is missing required `query` field.\n- Query includes blacklisted type.\n- Query has failed in ElasticSearch - for example, a sort is attempted on an unknown/unmapped field.\n- Query includes supplementary_data which is NOT an array of text values.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CaseSearchResultViewResource"}}}},"401":{"description":"Request doesn't include a valid `Authorization` header. This applies to all missing, malformed & expired tokens.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CaseSearchResultViewResource"}}}},"403":{"description":"Request doesn't include a valid `ServiceAuthorization` header. This applies to all missing, malformed & expired tokens.\nA valid S2S token issued to the name of a non-permitted API Client will also return the same.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CaseSearchResultViewResource"}}}},"404":{"description":"Case type specified in `ctid` query parameter could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CaseSearchResultViewResource"}}}},"500":{"description":"An unexpected situation that is not attributable to the user or API Client; or request is invalid. For some other types HTTP code 400 is returned instead.\nInvalid request examples include:\n- Malformed JSON request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CaseSearchResultViewResource"}}}}}}},"/internal/case-types/{ctid}/drafts":{"post":{"tags":["ui-drafts-controller"],"summary":"Save draft as a caseworker.","operationId":"saveDraft","parameters":[{"name":"experimental","in":"header","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CaseDataContent"}}},"required":true},"responses":{"201":{"description":"Draft created","content":{"application/vnd.uk.gov.hmcts.ccd-data-store-api.ui-draft-create.v2+json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/DraftViewResource"}}}},"422":{"description":"One of: cannot find event in requested case type or unable to sanitize document for case field","content":{"application/vnd.uk.gov.hmcts.ccd-data-store-api.ui-draft-create.v2+json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/DraftViewResource"}}}},"500":{"description":"Draft store is down.","content":{"application/vnd.uk.gov.hmcts.ccd-data-store-api.ui-draft-create.v2+json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/DraftViewResource"}}}}}}},"/globalSearch":{"post":{"tags":["global-search-endpoint"],"summary":"Global Search Request","description":"Global Search Request","operationId":"searchForCases","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GlobalSearchRequestPayload"}}},"required":true},"responses":{"200":{"description":"Search Request Valid","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GlobalSearchResponsePayload"}}}},"400":{"description":"One or more of the following reasons:\n1) Date of death invalid format\n2) Sort by category invalid\n3) Sort direction invalid\n4) Max return record count must be between 1 and 10000\n5) At least one jurisdiction or case type must be provided in the search criteria\n6) Jurisdiction ID exceeds maximum length of 70\n7) State ID exceeds maximum length of 70\n8) Case type ID exceeds maximum length of 70\n9) Case reference invalid format\n10) Start record number must be 1 or more\n11) Date of birth invalid format","content":{"application/json":{"example":{"status":"400","error":"Bad Request","message":"Input not valid","path":"/globalSearch","details":["State ID exceeds maximum length of 70"]}}}}}}},"/citizens/{uid}/jurisdictions/{jid}/case-types/{ctid}/cases":{"get":{"tags":["Standard case API"],"summary":"Get case data for a given case type","operationId":"searchCasesForCitizens","parameters":[{"name":"uid","in":"path","required":true,"schema":{"type":"string"}},{"name":"jid","in":"path","required":true,"schema":{"type":"string"}},{"name":"ctid","in":"path","required":true,"schema":{"type":"string"}},{"name":"queryParameters","in":"query","required":true,"schema":{"type":"object","additionalProperties":{"type":"string"}}}],"responses":{"200":{"description":"List of case data for the given search criteria","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CaseDetails"}}}}}}},"post":{"tags":["Standard case API"],"summary":"Submit case creation as Citizen","description":"Complete the case creation process. This requires a valid event token to be provided, as generated by `startCaseForCitizen`.","operationId":"saveCaseDetailsForCitizen","parameters":[{"name":"Should `AboutToSubmit` callback warnings be ignored","in":"query","required":false,"schema":{"type":"boolean"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CaseDataContent"}}},"required":true},"responses":{"201":{"description":"Case created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CaseDetails"}}}},"422":{"description":"Case submission failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CaseDetails"}}}},"409":{"description":"Case reference not unique","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CaseDetails"}}}}}}},"/citizens/{uid}/jurisdictions/{jid}/case-types/{ctid}/cases/{cid}/events":{"post":{"tags":["Standard case API"],"summary":"Submit event creation as Citizen","description":"Complete the event creation process. This requires a valid event token to be provided, as generated by `startEventForCitizen`.","operationId":"createCaseEventForCitizen","parameters":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CaseDataContent"}}},"required":true},"responses":{"201":{"description":"Case event created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CaseDetails"}}}},"409":{"description":"Case altered outside of transaction","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CaseDetails"}}}},"422":{"description":"Event submission failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CaseDetails"}}}}}}},"/caseworkers/{uid}/jurisdictions/{jid}/case-types/{ctid}/validate":{"post":{"tags":["Standard case API"],"summary":"Validate a set of fields as Case worker","description":"Validate the case data entered during the case/event creation process.","operationId":"validateCaseDetails","parameters":[{"name":"Page ID","in":"query","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CaseDataContent"}}},"required":true},"responses":{"200":{"description":"Validation OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JsonNode"}}}},"422":{"description":"Field validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JsonNode"}}}},"409":{"description":"Case reference not unique","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JsonNode"}}}}}}},"/citizens/{uid}/jurisdictions/{jid}/case-types/{ctid}/validate":{"post":{"tags":["Standard case API"],"summary":"Validate a set of fields as Case worker","description":"Validate the case data entered during the case/event creation process.","operationId":"validateCaseDetails_1","parameters":[{"name":"Page ID","in":"query","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CaseDataContent"}}},"required":true},"responses":{"200":{"description":"Validation OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JsonNode"}}}},"422":{"description":"Field validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JsonNode"}}}},"409":{"description":"Case reference not unique","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JsonNode"}}}}}}},"/caseworkers/{uid}/jurisdictions/{jid}/case-types/{ctid}/event-trigger/{etid}/drafts":{"post":{"tags":["Drafts API"],"summary":"Save draft as a caseworker.","operationId":"saveDraftForCaseWorker","parameters":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CaseDataContent"}}},"required":true},"responses":{"201":{"description":"Draft created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DraftResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DraftResponse"}}}}}}},"/caseworkers/{uid}/jurisdictions/{jid}/case-types/{ctid}/cases":{"get":{"tags":["Standard case API"],"summary":"Get case data for a given case type","operationId":"searchCasesForCaseWorkers","parameters":[],"responses":{"200":{"description":"List of case data for the given search criteria","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CaseDetails"}}}}}}},"post":{"tags":["Standard case API"],"summary":"Submit case creation as Case worker","description":"Complete the case creation process. This requires a valid event token to be provided, as generated by `startCaseForCaseworker`.","operationId":"saveCaseDetailsForCaseWorker","parameters":[{"name":"Should `AboutToSubmit` callback warnings be ignored","in":"query","required":false,"schema":{"type":"boolean"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CaseDataContent"}}},"required":true},"responses":{"201":{"description":"Case created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CaseDetails"}}}},"422":{"description":"Case submission failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CaseDetails"}}}},"409":{"description":"Case reference not unique","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CaseDetails"}}}}}}},"/caseworkers/{uid}/jurisdictions/{jid}/case-types/{ctid}/cases/{cid}/users":{"post":{"tags":["/"],"summary":"Grant access to case","operationId":"grantAccessToCase","parameters":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserId"}}},"required":true},"responses":{"201":{"description":"Grant successful"},"400":{"description":"Invalid case ID"}}}},"/caseworkers/{uid}/jurisdictions/{jid}/case-types/{ctid}/cases/{cid}/events":{"get":{"tags":["Events API"],"summary":"Get events for case","description":"Retrieve all events for a case","operationId":"findEventDetailsForCase","parameters":[],"responses":{"200":{"description":"Events found for the given ID","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AuditEvent"}}}}},"400":{"description":"Invalid case ID","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AuditEvent"}}}}},"404":{"description":"No case found for the given ID","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AuditEvent"}}}}}}},"post":{"tags":["Standard case API"],"summary":"Submit event creation as Case worker","description":"Complete the event creation process. This requires a valid event token to be provided, as generated by `startEventForCaseworker`.","operationId":"createCaseEventForCaseWorker","parameters":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CaseDataContent"}}},"required":true},"responses":{"201":{"description":"Case event created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CaseDetails"}}}},"409":{"description":"Case altered outside of transaction","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CaseDetails"}}}},"422":{"description":"Event submission failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CaseDetails"}}}}}}},"/cases/{caseId}/supplementary-data":{"post":{"tags":["case-controller"],"summary":"Update Case Supplementary Data","operationId":"updateCaseSupplementaryData","parameters":[{"name":"caseId","in":"path","required":true,"schema":{"type":"string"}},{"name":"supplementaryDataUpdateRequest","in":"query","schema":{"$ref":"#/components/schemas/SupplementaryDataUpdateRequest","contentMediaType":"application/json"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SupplementaryDataUpdateRequest","contentMediaType":"application/json"}}},"required":true},"responses":{"200":{"description":"Updated","content":{"*/*":{"schema":{"$ref":"#/components/schemas/SupplementaryDataResource"}}}},"400":{"description":"Supplementary data properties with more than one nested level are currently not supported","content":{"*/*":{"schema":{"$ref":"#/components/schemas/SupplementaryDataResource"}}}},"404":{"description":"Case not found","content":{"*/*":{"schema":{"$ref":"#/components/schemas/SupplementaryDataResource"}}}},"403":{"description":"Not authorised to update case supplementary data","content":{"*/*":{"schema":{"$ref":"#/components/schemas/SupplementaryDataResource"}}}}}}},"/cases/{caseId}/events":{"get":{"tags":["case-controller"],"summary":"Retrieve audit events by case ID","description":"Experimental! Subject to change or removal, do not use in production!","operationId":"getCaseEvents","parameters":[{"name":"caseId","in":"path","required":true,"schema":{"type":"string"}},{"name":"experimental","in":"header","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/vnd.uk.gov.hmcts.ccd-data-store-api.case-events.v2+json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/CaseEventsResource"}}}},"400":{"description":"Case ID is not valid","content":{"application/vnd.uk.gov.hmcts.ccd-data-store-api.case-events.v2+json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/CaseEventsResource"}}}},"422":{"description":"Cannot find user roles or case roles for the case ID","content":{"application/vnd.uk.gov.hmcts.ccd-data-store-api.case-events.v2+json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/CaseEventsResource"}}}},"404":{"description":"Case audit events not found","content":{"application/vnd.uk.gov.hmcts.ccd-data-store-api.case-events.v2+json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/CaseEventsResource"}}}}}},"post":{"tags":["case-controller"],"summary":"Submit an event for a case","operationId":"createEvent","parameters":[{"name":"experimental","in":"header","description":"'true' to use this endpoint"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CaseDataContent"}}},"required":true},"responses":{"201":{"description":"Event has been created successfully","content":{"application/vnd.uk.gov.hmcts.ccd-data-store-api.create-event.v2+json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/CaseResource"}}}},"400":{"description":"Event trigger not found","content":{"application/vnd.uk.gov.hmcts.ccd-data-store-api.create-event.v2+json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/CaseResource"}}}},"404":{"description":"Case not found","content":{"application/vnd.uk.gov.hmcts.ccd-data-store-api.create-event.v2+json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/CaseResource"}}}},"422":{"description":"The event could not be processed, for example due to one of the following:\n- Data validation failed\n- Invalid event (e.g. event ID not provided/known)\n- Case does not comply with pre-state condition for event\n","content":{"application/vnd.uk.gov.hmcts.ccd-data-store-api.create-event.v2+json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/CaseResource"}}}},"504":{"description":"Unsuccessful callback","content":{"application/vnd.uk.gov.hmcts.ccd-data-store-api.create-event.v2+json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/CaseResource"}}}}}}},"/cases/supplementary-data":{"post":{"tags":["case-controller"],"summary":"Update Cases Supplementary Data","operationId":"updateCasesSupplementaryData","parameters":[{"name":"supplementaryDataCasesUpdateRequest","in":"query","content":{"*/*":{"schema":{"$ref":"#/components/schemas/SupplementaryDataCasesUpdateRequest"}}}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SupplementaryDataCasesUpdateRequest"},"encoding":{"supplementaryDataCasesUpdateRequest":{"contentType":"*/*"}}}},"required":true},"responses":{"200":{"description":"Cases Updated","content":{"*/*":{"schema":{"$ref":"#/components/schemas/SupplementaryDataResource"}}}},"400":{"description":"Supplementary data properties with more than one nested level are currently not supported","content":{"*/*":{"schema":{"$ref":"#/components/schemas/SupplementaryCasesDataResource"}}}},"404":{"description":"Case not found","content":{"*/*":{"schema":{"$ref":"#/components/schemas/SupplementaryCasesDataResource"}}}},"403":{"description":"Not authorised to update supplementary cases data","content":{"*/*":{"schema":{"$ref":"#/components/schemas/SupplementaryCasesDataResource"}}}}}}},"/case-users":{"get":{"tags":["case-assigned-user-roles-controller"],"summary":"Get Case-Assigned Users and Roles","description":"**Deprecated**: Use <a href='#/case-assigned-user-roles-controller/searchCaseUserRolesUsingPOST'>POST /case-users/search</a> instead: were query params have been moved into the request payload, to avoid hitting *414 URI Too Long* issues.","operationId":"getCaseUserRoles","parameters":[{"name":"case_ids","in":"query","required":true,"schema":{"type":"array","items":{"type":"string"}}},{"name":"user_ids","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Case-User-Role assignments returned successfully","content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/CaseAssignedUserRolesResponse"}},"application/json":{"schema":{"$ref":"#/components/schemas/CaseAssignedUserRolesResponse"}}}},"400":{"description":"One or more of the following reasons:\n1. Case ID is not valid, \n2. Case ID list is empty, \n3. User ID is not valid.","content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/CaseAssignedUserRolesResource"}},"application/json":{"schema":{"$ref":"#/components/schemas/CaseAssignedUserRolesResource"}}}},"403":{"description":"Access to other user's case role assignments not granted","content":{"application/hal+json":{"schema":{"$ref":"#/components/schemas/CaseAssignedUserRolesResource"}},"application/json":{"schema":{"$ref":"#/components/schemas/CaseAssignedUserRolesResource"}}}}},"deprecated":true},"post":{"tags":["case-assigned-user-roles-controller"],"summary":"Add Case-Assigned Users and Roles","operationId":"addCaseUserRoles","parameters":[{"name":"Valid Service-to-Service JWT token for an approved micro-service","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CaseAssignedUserRolesRequest"}}},"required":true},"responses":{"201":{"description":"Case-User-Role assignments created successfully","content":{"*/*":{"schema":{"$ref":"#/components/schemas/CaseAssignedUserRolesResponse"}}}},"400":{"description":"One or more of the following reasons:\n1. Case user roles list is empty, \n2. Case ID is not valid: has to be a valid 16-digit Luhn number, \n3. User ID is not valid: has to be a string of length > 0, \n4. Case role name format is invalid: has to be a none-empty string in square brackets, \n5. Organisation ID is not valid: has to be a non-empty string, when present.","content":{"*/*":{"schema":{"$ref":"#/components/schemas/CaseAssignedUserRolesResponse"}}}},"401":{"description":"Authentication failure due to invalid / expired tokens (IDAM / S2S).","content":{"*/*":{"schema":{"$ref":"#/components/schemas/CaseAssignedUserRolesResponse"}}}},"403":{"description":"One of the following reasons:\n1. Unauthorised S2S service\n2. Client service not authorised to perform operation.","content":{"*/*":{"schema":{"$ref":"#/components/schemas/CaseAssignedUserRolesResponse"}}}},"404":{"description":"Case not found","content":{"*/*":{"schema":{"$ref":"#/components/schemas/CaseAssignedUserRolesResponse"}}}}}},"delete":{"tags":["case-assigned-user-roles-controller"],"summary":"Remove Case-Assigned Users and Roles","operationId":"removeCaseUserRoles","parameters":[{"name":"Valid Service-to-Service JWT token for an approved micro-service","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CaseAssignedUserRolesRequest"}}},"required":true},"responses":{"200":{"description":"Case-User-Role assignments removed successfully","content":{"*/*":{"schema":{"$ref":"#/components/schemas/CaseAssignedUserRolesResponse"}}}},"400":{"description":"One or more of the following reasons:\n1. Case user roles list is empty, \n2. Case ID is not valid: has to be a valid 16-digit Luhn number, \n3. User ID is not valid: has to be a string of length > 0, \n4. Case role name format is invalid: has to be a none-empty string in square brackets, \n5. Organisation ID is not valid: has to be a non-empty string, when present.","content":{"*/*":{"schema":{"$ref":"#/components/schemas/CaseAssignedUserRolesResponse"}}}},"401":{"description":"Authentication failure due to invalid / expired tokens (IDAM / S2S).","content":{"*/*":{"schema":{"$ref":"#/components/schemas/CaseAssignedUserRolesResponse"}}}},"403":{"description":"One of the following reasons:\n1. Unauthorised S2S service \n2. Client service not authorised to perform operation.","content":{"*/*":{"schema":{"$ref":"#/components/schemas/CaseAssignedUserRolesResponse"}}}},"404":{"description":"Case not found","content":{"*/*":{"schema":{"$ref":"#/components/schemas/CaseAssignedUserRolesResponse"}}}}}}},"/case-users/search":{"post":{"tags":["case-assigned-user-roles-controller"],"summary":"Get Case-Assigned Users and Roles","operationId":"searchCaseUserRoles","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchCaseAssignedUserRolesRequest"}}},"required":true},"responses":{"200":{"description":"Case-User-Role assignments returned successfully","content":{"*/*":{"schema":{"$ref":"#/components/schemas/CaseAssignedUserRolesResponse"}}}},"400":{"description":"One or more of the following reasons:\n1. Case ID is not valid, \n2. Case ID list is empty, \n3. User ID is not valid.","content":{"*/*":{"schema":{"$ref":"#/components/schemas/CaseAssignedUserRolesResource"}}}},"403":{"description":"Access to other user's case role assignments not granted","content":{"*/*":{"schema":{"$ref":"#/components/schemas/CaseAssignedUserRolesResource"}}}}}}},"/case-types/{caseTypeId}/validate":{"post":{"tags":["case-data-validator-controller"],"summary":"Validate case data","description":"Experimental! Subject to change or removal, do not use in production!","operationId":"validate","parameters":[{"name":"caseTypeId","in":"path","required":true,"schema":{"type":"string"}},{"name":"pageId","in":"query","required":false,"schema":{"type":"string"}},{"name":"experimental","in":"header","description":"'true' to use this endpoint"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CaseDataContent"}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/vnd.uk.gov.hmcts.ccd-data-store-api.case-data-validate.v2+json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/CaseDataResource"}}}},"404":{"description":"Case type not found","content":{"application/vnd.uk.gov.hmcts.ccd-data-store-api.case-data-validate.v2+json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/CaseDataResource"}}}},"422":{"description":"One of: Event trigger not provided, case type does not exist or case data validation failed","content":{"application/vnd.uk.gov.hmcts.ccd-data-store-api.case-data-validate.v2+json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/CaseDataResource"}}}}}}},"/case-types/{caseTypeId}/cases":{"post":{"tags":["case-controller"],"summary":"Submit case creation","description":"Experimental! Subject to change or removal, do not use in production!","operationId":"createCase","parameters":[{"name":"caseTypeId","in":"path","required":true,"schema":{"type":"string"}},{"name":"ignore-warning","in":"query","required":false,"schema":{"type":"boolean"}},{"name":"experimental","in":"header","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CaseDataContent"}}},"required":true},"responses":{"201":{"description":"Created","content":{"application/vnd.uk.gov.hmcts.ccd-data-store-api.create-case.v2+json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/CaseResource"}}}},"400":{"description":"Missing event token","content":{"application/vnd.uk.gov.hmcts.ccd-data-store-api.create-case.v2+json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/CaseResource"}}}},"403":{"description":"Grant action is reserved to users with entire jurisdiction access","content":{"application/vnd.uk.gov.hmcts.ccd-data-store-api.create-case.v2+json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/CaseResource"}}}},"404":{"description":"Cannot find matching event trigger","content":{"application/vnd.uk.gov.hmcts.ccd-data-store-api.create-case.v2+json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/CaseResource"}}}},"409":{"description":"Case altered outside of transaction","content":{"application/vnd.uk.gov.hmcts.ccd-data-store-api.create-case.v2+json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/CaseResource"}}}},"422":{"description":"Cannot validate case field","content":{"application/vnd.uk.gov.hmcts.ccd-data-store-api.create-case.v2+json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/CaseResource"}}}},"504":{"description":"Unsuccessful callback","content":{"application/vnd.uk.gov.hmcts.ccd-data-store-api.create-case.v2+json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/CaseResource"}}}}}}},"/callback/jurisdictions/{jid}/case-types/{ctid}/documents":{"post":{"tags":["Default callbacks"],"summary":"Get printable documents","description":"Retrieve a list of printable documents for a case","operationId":"getPrintableDocuments","parameters":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CaseDetails"}}},"required":true},"responses":{"200":{"description":"Printable documents list retrieved","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Document"}}}}}}}},"/testing-support/case-link/{caseReference}":{"get":{"tags":["testing-support-controller"],"operationId":"getCaseLink","parameters":[{"name":"caseReference","in":"path","required":true,"schema":{"type":"string"}},{"name":"experimental","in":"header","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/CaseLinksResource"}}}}}}},"/internal/profile":{"get":{"tags":["ui-user-profile-controller"],"summary":"Validate case data","description":"Experimental! Subject to change or removal, do not use in production!","operationId":"getUserProfile","parameters":[{"name":"experimental","in":"header","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/vnd.uk.gov.hmcts.ccd-data-store-api.ui-user-profile.v2+json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/CaseViewResource"}}}}}}},"/internal/jurisdictions":{"get":{"tags":["ui-definition-controller"],"summary":"Get Jurisdictions information for the access type passed","description":"Experimental! Subject to change or removal, do not use in production!","operationId":"getJurisdictions","parameters":[{"name":"access","in":"query","required":true,"schema":{"type":"string"}},{"name":"experimental","in":"header","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/vnd.uk.gov.hmcts.ccd-data-store-api.ui-jurisdictions.v2+json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/JurisdictionViewResource"}}}},"404":{"description":"No jurisdictions found","content":{"application/vnd.uk.gov.hmcts.ccd-data-store-api.ui-jurisdictions.v2+json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/JurisdictionViewResource"}}}},"400":{"description":"Access can only be 'create', 'read' or 'update'","content":{"application/vnd.uk.gov.hmcts.ccd-data-store-api.ui-jurisdictions.v2+json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/JurisdictionViewResource"}}}}}}},"/internal/jurisdiction-ui-configs":{"get":{"tags":["ui-definition-controller"],"summary":"Get Jurisdiction UI config information for the jurisdictions","description":"Experimental! Subject to change or removal, do not use in production!","operationId":"getJurisdictionUiConfigs","parameters":[{"name":"ids","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"experimental","in":"header","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/vnd.uk.gov.hmcts.ccd-data-store-api.ui-jurisdiction-configs.v2+json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/JurisdictionConfigViewResource"}}}}}}},"/internal/drafts/{draftId}/event-trigger":{"get":{"tags":["ui-start-trigger-controller"],"summary":"Retrieve a start draft trigger by ID for dynamic display","description":"Experimental! Subject to change or removal, do not use in production!","operationId":"getStartDraftTrigger","parameters":[{"name":"draftId","in":"path","required":true,"schema":{"type":"string"}},{"name":"ignore-warning","in":"query","required":false,"schema":{"type":"boolean"}},{"name":"experimental","in":"header","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/vnd.uk.gov.hmcts.ccd-data-store-api.ui-start-draft-trigger.v2+json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/CaseUpdateViewEventResource"}}}},"422":{"description":"One of: Case event has no pre states, callback validation errors, unable to sanitize document for case field or missing user roles","content":{"application/vnd.uk.gov.hmcts.ccd-data-store-api.ui-start-draft-trigger.v2+json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/CaseUpdateViewEventResource"}}}},"404":{"description":"Trigger not found","content":{"application/vnd.uk.gov.hmcts.ccd-data-store-api.ui-start-draft-trigger.v2+json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/CaseUpdateViewEventResource"}}}}}}},"/internal/drafts/{did}":{"get":{"tags":["ui-drafts-controller"],"summary":"Fetch a draft for display","operationId":"findDraft","parameters":[{"name":"did","in":"path","required":true,"schema":{"type":"string"}},{"name":"experimental","in":"header","schema":{"type":"string"}}],"responses":{"200":{"description":"A displayable draft","content":{"application/vnd.uk.gov.hmcts.ccd-data-store-api.ui-draft-read.v2+json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/CaseViewResource"}}}},"500":{"description":"Draft store is down.","content":{"application/vnd.uk.gov.hmcts.ccd-data-store-api.ui-draft-read.v2+json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/CaseViewResource"}}}}}},"delete":{"tags":["ui-drafts-controller"],"summary":"Delete a given draft","operationId":"deleteDraft","parameters":[{"name":"did","in":"path","required":true,"schema":{"type":"string"}},{"name":"experimental","in":"header","schema":{"type":"string"}}],"responses":{"200":{"description":"A draft deleted successfully"},"500":{"description":"Draft store is down."}}}},"/internal/cases/{caseId}":{"get":{"tags":["ui-case-controller"],"summary":"Retrieve a case by ID for dynamic display","description":"Experimental! Subject to change or removal, do not use in production!","operationId":"getCaseView","parameters":[{"name":"caseId","in":"path","required":true,"schema":{"type":"string"}},{"name":"experimental","in":"header","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/vnd.uk.gov.hmcts.ccd-data-store-api.ui-case-view.v2+json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/CaseViewResource"}}}},"400":{"description":"Case ID is not valid","content":{"application/vnd.uk.gov.hmcts.ccd-data-store-api.ui-case-view.v2+json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/CaseViewResource"}}}},"404":{"description":"Case not found","content":{"application/vnd.uk.gov.hmcts.ccd-data-store-api.ui-case-view.v2+json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/CaseViewResource"}}}}}}},"/internal/cases/{caseId}/events/{eventId}":{"get":{"tags":["ui-case-controller"],"summary":"Retrieve an event by case and event IDs for dynamic display","description":"Experimental! Subject to change or removal, do not use in production!","operationId":"getCaseHistoryView","parameters":[{"name":"caseId","in":"path","required":true,"schema":{"type":"string"}},{"name":"eventId","in":"path","required":true,"schema":{"type":"string"}},{"name":"experimental","in":"header","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/vnd.uk.gov.hmcts.ccd-data-store-api.ui-event-view.v2+json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/CaseHistoryViewResource"}}}},"400":{"description":"Case ID is not valid","content":{"application/vnd.uk.gov.hmcts.ccd-data-store-api.ui-event-view.v2+json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/CaseHistoryViewResource"}}}},"404":{"description":"Case event not found","content":{"application/vnd.uk.gov.hmcts.ccd-data-store-api.ui-event-view.v2+json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/CaseHistoryViewResource"}}}}}}},"/internal/cases/{caseId}/event-triggers/{triggerId}":{"get":{"tags":["ui-start-trigger-controller"],"summary":"Retrieve a start event trigger by ID for dynamic display","description":"Experimental! Subject to change or removal, do not use in production!","operationId":"getCaseUpdateViewEvent","parameters":[{"name":"caseId","in":"path","required":true,"schema":{"type":"string"}},{"name":"triggerId","in":"path","required":true,"schema":{"type":"string"}},{"name":"ignore-warning","in":"query","required":false,"schema":{"type":"boolean"}},{"name":"experimental","in":"header","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/vnd.uk.gov.hmcts.ccd-data-store-api.ui-start-event-trigger.v2+json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/CaseUpdateViewEventResource"}}}},"422":{"description":"One of: Case event has no pre states, callback validation errors, unable to sanitize document for case field or missing user roles","content":{"application/vnd.uk.gov.hmcts.ccd-data-store-api.ui-start-event-trigger.v2+json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/CaseUpdateViewEventResource"}}}},"400":{"description":"Case ID is not valid","content":{"application/vnd.uk.gov.hmcts.ccd-data-store-api.ui-start-event-trigger.v2+json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/CaseUpdateViewEventResource"}}}},"404":{"description":"Trigger not found","content":{"application/vnd.uk.gov.hmcts.ccd-data-store-api.ui-start-event-trigger.v2+json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/CaseUpdateViewEventResource"}}}}}}},"/internal/cases/{caseId}/access-metadata":{"get":{"tags":["ui-case-controller"],"summary":"Retrieve access metadata for a given case ID","description":"Experimental! Subject to change or removal, do not use in production!","operationId":"getCaseAccessMetadata","parameters":[{"name":"caseId","in":"path","required":true,"schema":{"type":"string"}},{"name":"experimental","in":"header","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/vnd.uk.gov.hmcts.ccd-data-store-api.ui-case-access-metadata.v2+json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/CaseAccessMetadata"}}}},"400":{"description":"Case ID is not valid","content":{"application/vnd.uk.gov.hmcts.ccd-data-store-api.ui-case-access-metadata.v2+json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/CaseAccessMetadata"}}}},"404":{"description":"Case not found","content":{"application/vnd.uk.gov.hmcts.ccd-data-store-api.ui-case-access-metadata.v2+json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/CaseAccessMetadata"}}}}}}},"/internal/case-types/{caseTypeId}/work-basket-inputs":{"get":{"tags":["ui-definition-controller"],"summary":"Retrieve workbasket input details for dynamic display","description":"Experimental! Subject to change or removal, do not use in production!","operationId":"getWorkbasketInputsDetails","parameters":[{"name":"caseTypeId","in":"path","required":true,"schema":{"type":"string"}},{"name":"experimental","in":"header","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/vnd.uk.gov.hmcts.ccd-data-store-api.ui-workbasket-input-details.v2+json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/WorkbasketInputsViewResource"}}}},"404":{"description":"Case type not found","content":{"application/vnd.uk.gov.hmcts.ccd-data-store-api.ui-workbasket-input-details.v2+json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/WorkbasketInputsViewResource"}}}}}}},"/internal/case-types/{caseTypeId}/search-inputs":{"get":{"tags":["ui-definition-controller"],"summary":"Retrieve search input details for dynamic display","description":"Experimental! Subject to change or removal, do not use in production!","operationId":"getSearchInputsDetails","parameters":[{"name":"caseTypeId","in":"path","required":true,"schema":{"type":"string"}},{"name":"experimental","in":"header","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/vnd.uk.gov.hmcts.ccd-data-store-api.ui-search-input-details.v2+json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/SearchInputsViewResource"}}}},"404":{"description":"Case type not found","content":{"application/vnd.uk.gov.hmcts.ccd-data-store-api.ui-search-input-details.v2+json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/SearchInputsViewResource"}}}}}}},"/internal/case-types/{caseTypeId}/event-triggers/{triggerId}":{"get":{"tags":["ui-start-trigger-controller"],"summary":"Retrieve a start case trigger by ID for dynamic display","description":"Experimental! Subject to change or removal, do not use in production!","operationId":"getCaseUpdateViewEventByCaseType","parameters":[{"name":"caseTypeId","in":"path","required":true,"schema":{"type":"string"}},{"name":"triggerId","in":"path","required":true,"schema":{"type":"string"}},{"name":"ignore-warning","in":"query","required":false,"schema":{"type":"boolean"}},{"name":"experimental","in":"header","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/vnd.uk.gov.hmcts.ccd-data-store-api.ui-start-case-trigger.v2+json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/CaseUpdateViewEventResource"}}}},"422":{"description":"One of: Case event has no pre states, callback validation errors, unable to sanitize document for case field or missing user roles","content":{"application/vnd.uk.gov.hmcts.ccd-data-store-api.ui-start-case-trigger.v2+json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/CaseUpdateViewEventResource"}}}},"404":{"description":"Trigger not found","content":{"application/vnd.uk.gov.hmcts.ccd-data-store-api.ui-start-case-trigger.v2+json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/CaseUpdateViewEventResource"}}}}}}},"/internal/banners":{"get":{"tags":["ui-definition-controller"],"summary":"Get Banner information for the jurisdictions","description":"Experimental! Subject to change or removal, do not use in production!","operationId":"getBanners","parameters":[{"name":"ids","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"experimental","in":"header","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/vnd.uk.gov.hmcts.ccd-data-store-api.ui-banners.v2+json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/BannerViewResource"}}}}}}},"/getLinkedCases/{caseReference}":{"get":{"tags":["case-controller"],"summary":"Retrieve Linked Cases","operationId":"getLinkedCase","parameters":[{"name":"caseReference","in":"path","required":true,"schema":{"type":"string"}},{"name":"startRecordNumber","in":"query","required":false,"schema":{"type":"string","default":"1"}},{"name":"maxReturnRecordCount","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetLinkedCasesResponse"}}}},"400":{"description":"One or more of the following reasons:\n1) Case ID is not valid\n2) Parameter is not numeric","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetLinkedCasesResponse"}}}},"404":{"description":"Case not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetLinkedCasesResponse"}}}}}}},"/citizens/{uid}/jurisdictions/{jid}/case-types/{ctid}/event-triggers/{etid}/token":{"get":{"tags":["Standard case API"],"summary":"Start case creation as Citizen","description":"Start the case creation process for a new case. Triggers `AboutToStart` callback.","operationId":"startCaseForCitizen","parameters":[{"name":"Should `AboutToStart` callback warnings be ignored","in":"query","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"Case creation process started","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartEventResult"}}}},"422":{"description":"Process could not be started","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartEventResult"}}}}}}},"/citizens/{uid}/jurisdictions/{jid}/case-types/{ctid}/cases/{cid}":{"get":{"tags":["Standard case API"],"summary":"Get case","description":"Retrieve an existing case with its state and data","operationId":"findCaseDetailsForCitizen","parameters":[],"responses":{"200":{"description":"Case found for the given ID","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CaseDetails"}}}},"400":{"description":"Invalid case ID","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CaseDetails"}}}},"404":{"description":"No case found for the given ID","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CaseDetails"}}}}}}},"/citizens/{uid}/jurisdictions/{jid}/case-types/{ctid}/cases/{cid}/event-triggers/{etid}/token":{"get":{"tags":["Standard case API"],"summary":"Start event creation as Citizen","description":"Start the event creation process for an existing case. Triggers `AboutToStart` callback.","operationId":"startEventForCitizen","parameters":[{"name":"Should `AboutToStart` callback warnings be ignored","in":"query","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"Event creation process started","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartEventResult"}}}},"404":{"description":"No case found for the given ID","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartEventResult"}}}},"422":{"description":"Process could not be started","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartEventResult"}}}}}}},"/citizens/{uid}/jurisdictions/{jid}/case-types/{ctid}/cases/pagination_metadata":{"get":{"tags":["Standard case API"],"summary":"Get the pagination metadata for a case data search","operationId":"searchCasesMetadataForCitizens","parameters":[{"name":"uid","in":"path","required":true,"schema":{"type":"string"}},{"name":"jid","in":"path","required":true,"schema":{"type":"string"}},{"name":"ctid","in":"path","required":true,"schema":{"type":"string"}},{"name":"queryParameters","in":"query","required":true,"schema":{"type":"object","additionalProperties":{"type":"string"}}}],"responses":{"200":{"description":"Pagination metadata for the given search criteria","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedSearchMetadata"}}}}}}},"/categoriesAndDocuments/{caseRef}":{"get":{"tags":["case-file-view-controller"],"operationId":"getCategoriesAndDocuments","parameters":[{"name":"caseRef","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CategoriesAndDocuments"}}}},"400":{"description":"Case ID is not valid","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CategoriesAndDocuments"}}}},"404":{"description":"Case not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CategoriesAndDocuments"}}}}}}},"/caseworkers/{uid}/profile":{"get":{"tags":["user-profile-endpoint"],"summary":"Get default setting for user","operationId":"getUserProfile_1","responses":{"200":{"description":"User default settings","content":{"*/*":{"schema":{"$ref":"#/components/schemas/UserProfile"}}}}}}},"/caseworkers/{uid}/jurisdictions/{jid}/case-types/{ctid}/event-triggers/{etid}/token":{"get":{"tags":["Standard case API"],"summary":"Start case creation as Case worker","description":"Start the case creation process for a new case. Triggers `AboutToStart` callback.","operationId":"startCaseForCaseworker","parameters":[{"name":"Should `AboutToStart` callback warnings be ignored","in":"query","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"Case creation process started","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartEventResult"}}}},"422":{"description":"Process could not be started","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartEventResult"}}}}}}},"/caseworkers/{uid}/jurisdictions/{jid}/case-types/{ctid}/drafts/{did}":{"get":{"tags":["Drafts API"],"summary":"Fetch a draft for display","operationId":"findDraft_1","parameters":[{"name":"uid","in":"path","required":true,"schema":{"type":"string"}},{"name":"jid","in":"path","required":true,"schema":{"type":"string"}},{"name":"ctid","in":"path","required":true,"schema":{"type":"string"}},{"name":"did","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"A displayable draft","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CaseView"}}}}}},"delete":{"tags":["Drafts API"],"summary":"Delete a given draft","operationId":"deleteDraft_1","parameters":[{"name":"uid","in":"path","required":true,"schema":{"type":"string"}},{"name":"jid","in":"path","required":true,"schema":{"type":"string"}},{"name":"ctid","in":"path","required":true,"schema":{"type":"string"}},{"name":"did","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"A draft deleted successfully"}}}},"/caseworkers/{uid}/jurisdictions/{jid}/case-types/{ctid}/cases/{cid}":{"get":{"tags":["Standard case API"],"summary":"Get case","description":"Retrieve an existing case with its state and data","operationId":"findCaseDetailsForCaseworker","parameters":[],"responses":{"200":{"description":"Case found for the given ID","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CaseDetails"}}}},"400":{"description":"Invalid case ID","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CaseDetails"}}}},"404":{"description":"No case found for the given ID","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CaseDetails"}}}}}}},"/caseworkers/{uid}/jurisdictions/{jid}/case-types/{ctid}/cases/{cid}/event-triggers/{etid}/token":{"get":{"tags":["Standard case API"],"summary":"Start event creation as Case worker","description":"Start the event creation process for an existing case. Triggers `AboutToStart` callback.","operationId":"startEventForCaseworker","parameters":[{"name":"Should `AboutToStart` callback warnings be ignored","in":"query","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"Event creation process started","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartEventResult"}}}},"404":{"description":"No case found for the given ID","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartEventResult"}}}},"422":{"description":"Process could not be started","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartEventResult"}}}}}}},"/caseworkers/{uid}/jurisdictions/{jid}/case-types/{ctid}/cases/{cid}/documents":{"get":{"tags":["Standard case API"],"summary":"Get a list of printable documents for the given case id","description":"Deprecated. Use /{caseId}/documents instead.","operationId":"getDocumentsForCase","parameters":[{"name":"uid","in":"path","required":true,"schema":{"type":"string"}},{"name":"jid","in":"path","required":true,"schema":{"type":"string"}},{"name":"ctid","in":"path","required":true,"schema":{"type":"string"}},{"name":"cid","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Documents list for the given case id","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Document"}}}}}},"deprecated":true}},"/caseworkers/{uid}/jurisdictions/{jid}/case-types/{ctid}/cases/pagination_metadata":{"get":{"tags":["Standard case API"],"summary":"Get the pagination metadata for a case data search","operationId":"searchCasesMetadataForCaseworkers","parameters":[{"name":"uid","in":"path","required":true,"schema":{"type":"string"}},{"name":"jid","in":"path","required":true,"schema":{"type":"string"}},{"name":"ctid","in":"path","required":true,"schema":{"type":"string"}},{"name":"queryParameters","in":"query","required":true,"schema":{"type":"object","additionalProperties":{"type":"string"}}}],"responses":{"200":{"description":"Pagination metadata for the given search criteria","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedSearchMetadata"}}}}}}},"/caseworkers/{uid}/jurisdictions/{jid}/case-types/{ctid}/cases/ids":{"get":{"tags":["/"],"summary":"Get case ids","description":"Retrieve case ids for given users ids","operationId":"findCaseIdsGivenUserIdHasAccessTo","parameters":[{"name":"User id searching for","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"List of cases ids found","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}},"400":{"description":"Invalid case ID","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}}}}},"/cases/{caseId}":{"get":{"tags":["case-controller"],"summary":"Retrieve a case by ID","description":"Experimental! Subject to change or removal, do not use in production!","operationId":"getCase","parameters":[{"name":"caseId","in":"path","required":true,"schema":{"type":"string"}},{"name":"experimental","in":"header","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/vnd.uk.gov.hmcts.ccd-data-store-api.case.v2+json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/CaseResource"}}}},"400":{"description":"Case ID is not valid","content":{"application/vnd.uk.gov.hmcts.ccd-data-store-api.case.v2+json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/CaseResource"}}}},"404":{"description":"Case not found","content":{"application/vnd.uk.gov.hmcts.ccd-data-store-api.case.v2+json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/CaseResource"}}}}}}},"/cases/{caseId}/event-triggers/{eventId}":{"get":{"tags":["start-event-controller"],"summary":"Retrieve an Event Trigger for a Case by Event ID","description":"This operation creates an event token for a specific event to be started for a case and returns the token, along with the visible case details to the invoking user as per their configured access levels.","operationId":"getStartEventTrigger","parameters":[{"name":"caseId","in":"path","required":true,"schema":{"type":"string"}},{"name":"eventId","in":"path","required":true,"schema":{"type":"string"}},{"name":"ignore-warning","in":"query","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"Success","content":{"application/vnd.uk.gov.hmcts.ccd-data-store-api.start-event-trigger.v2+json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/StartEventResource"}}}},"400":{"description":"Case ID is not valid","content":{"application/vnd.uk.gov.hmcts.ccd-data-store-api.start-event-trigger.v2+json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/StartEventResource"}}}},"401":{"description":"Authentication failure due to invalid / expired tokens (IDAM / S2S).","content":{"application/vnd.uk.gov.hmcts.ccd-data-store-api.start-event-trigger.v2+json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/StartEventResource"}}}},"403":{"description":"Unauthorised S2S service","content":{"application/vnd.uk.gov.hmcts.ccd-data-store-api.start-event-trigger.v2+json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/StartEventResource"}}}},"404":{"description":"Event trigger not found","content":{"application/vnd.uk.gov.hmcts.ccd-data-store-api.start-event-trigger.v2+json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/StartEventResource"}}}},"422":{"description":"One of the following reasons:\n1. Case event has no pre states\n2. Callback validation errors\n3. Unable to sanitize document for case field\n4. Missing user roles","content":{"application/vnd.uk.gov.hmcts.ccd-data-store-api.start-event-trigger.v2+json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/StartEventResource"}}}}}}},"/cases/{caseId}/documents":{"get":{"tags":["document-controller"],"summary":"Retrieve case documents by case ID","description":"Experimental! Subject to change or removal, do not use in production!","operationId":"getDocuments","parameters":[{"name":"caseId","in":"path","required":true,"schema":{"type":"string"}},{"name":"experimental","in":"header","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/vnd.uk.gov.hmcts.ccd-data-store-api.case-documents.v2+json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/DocumentsResource"}}}},"400":{"description":"Case ID is not valid","content":{"application/vnd.uk.gov.hmcts.ccd-data-store-api.case-documents.v2+json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/DocumentsResource"}}}},"404":{"description":"Case not found","content":{"application/vnd.uk.gov.hmcts.ccd-data-store-api.case-documents.v2+json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/DocumentsResource"}}}},"500":{"description":"Print documents endpoint is down","content":{"application/vnd.uk.gov.hmcts.ccd-data-store-api.case-documents.v2+json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/DocumentsResource"}}}}}}},"/cases/{caseId}/documents/{documentId}":{"get":{"tags":["case-document-controller"],"summary":"Retrieve a case document metadata by case and document Id","operationId":"getCaseDocumentMetadata","parameters":[{"name":"caseId","in":"path","required":true,"schema":{"type":"string"}},{"name":"documentId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/vnd.uk.gov.hmcts.ccd-data-store-api.case-document+json;charset=UTF-8;version=1.0":{"schema":{"$ref":"#/components/schemas/CaseDocumentResource"}}}},"400":{"description":"Case document Id is not valid","content":{"application/vnd.uk.gov.hmcts.ccd-data-store-api.case-document+json;charset=UTF-8;version=1.0":{"schema":{"$ref":"#/components/schemas/CaseDocumentResource"}}}},"404":{"description":"Case document not found","content":{"application/vnd.uk.gov.hmcts.ccd-data-store-api.case-document+json;charset=UTF-8;version=1.0":{"schema":{"$ref":"#/components/schemas/CaseDocumentResource"}}}}}}},"/case-types/{caseTypeId}/event-triggers/{triggerId}":{"get":{"tags":["start-event-controller"],"summary":"Retrieve a trigger by ID","description":"Experimental! Subject to change or removal, do not use in production!","operationId":"getStartCaseEvent","parameters":[{"name":"caseTypeId","in":"path","required":true,"schema":{"type":"string"}},{"name":"triggerId","in":"path","required":true,"schema":{"type":"string"}},{"name":"ignore-warning","in":"query","required":false,"schema":{"type":"boolean"}},{"name":"experimental","in":"header","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/vnd.uk.gov.hmcts.ccd-data-store-api.start-case-trigger.v2+json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/StartEventResource"}}}},"422":{"description":"One of: Case event has no pre states, callback validation errors, unable to sanitize document for case field or missing user roles","content":{"application/vnd.uk.gov.hmcts.ccd-data-store-api.start-case-trigger.v2+json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/StartEventResource"}}}},"404":{"description":"Event trigger not found","content":{"application/vnd.uk.gov.hmcts.ccd-data-store-api.start-case-trigger.v2+json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/StartEventResource"}}}}}}},"/aggregated/caseworkers/{uid}/jurisdictions":{"get":{"tags":["query-endpoint"],"summary":"Get jurisdictions available to the user","operationId":"getJurisdictions_1","parameters":[{"name":"access","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"List of jurisdictions for the given access criteria","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/JurisdictionDisplayProperties"}}}}},"404":{"description":"No jurisdictions found for given access criteria","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/JurisdictionDisplayProperties"}}}}}}}},"/aggregated/caseworkers/{uid}/jurisdictions/{jid}/case-types":{"get":{"tags":["query-endpoint"],"summary":"Get case types","operationId":"getCaseTypes","parameters":[{"name":"jid","in":"path","required":true,"schema":{"type":"string"}},{"name":"access","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"List of case types for the given access criteria","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CaseTypeDefinition"}}}}},"404":{"description":"No case types found for given access criteria","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CaseTypeDefinition"}}}}}},"deprecated":true}},"/aggregated/caseworkers/{uid}/jurisdictions/{jid}/case-types/{ctid}/work-basket-inputs":{"get":{"tags":["query-endpoint"],"summary":"Get Workbasket Input details","operationId":"findWorkbasketInputDetails","parameters":[{"name":"uid","in":"path","required":true,"schema":{"type":"string"}},{"name":"jid","in":"path","required":true,"schema":{"type":"string"}},{"name":"ctid","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Workbasket Input data found for the given case type and jurisdiction","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/WorkbasketInput"}}}}},"404":{"description":"No Workbasket Input found for the given case type and jurisdiction","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/WorkbasketInput"}}}}}}}},"/aggregated/caseworkers/{uid}/jurisdictions/{jid}/case-types/{ctid}/inputs":{"get":{"tags":["query-endpoint"],"summary":"Get Search Input details","operationId":"findSearchInputDetails","parameters":[{"name":"uid","in":"path","required":true,"schema":{"type":"string"}},{"name":"jid","in":"path","required":true,"schema":{"type":"string"}},{"name":"ctid","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Search Input data found for the given case type and jurisdiction","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SearchInput"}}}}},"404":{"description":"No SearchInput found for the given case type and jurisdiction","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SearchInput"}}}}}}}},"/aggregated/caseworkers/{uid}/jurisdictions/{jid}/case-types/{ctid}/event-triggers/{etid}":{"get":{"tags":["query-endpoint"],"summary":"Fetch an event trigger in the context of a case type","operationId":"getEventTriggerForCaseType","parameters":[{"name":"uid","in":"path","required":true,"schema":{"type":"string"}},{"name":"jid","in":"path","required":true,"schema":{"type":"string"}},{"name":"ctid","in":"path","required":true,"schema":{"type":"string"}},{"name":"etid","in":"path","required":true,"schema":{"type":"string"}},{"name":"ignore-warning","in":"query","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"Empty pre-state conditions","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CaseUpdateViewEvent"}}}},"422":{"description":"The case status did not qualify for the event","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CaseUpdateViewEvent"}}}}}}},"/aggregated/caseworkers/{uid}/jurisdictions/{jid}/case-types/{ctid}/drafts/{did}/event-triggers/{etid}":{"get":{"tags":["query-endpoint"],"summary":"Fetch an event trigger in the context of a case","operationId":"getEventTriggerForDraft","parameters":[{"name":"uid","in":"path","required":true,"schema":{"type":"string"}},{"name":"jid","in":"path","required":true,"schema":{"type":"string"}},{"name":"ctid","in":"path","required":true,"schema":{"type":"string"}},{"name":"did","in":"path","required":true,"schema":{"type":"string"}},{"name":"etid","in":"path","required":true,"schema":{"type":"string"}},{"name":"ignore-warning","in":"query","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"Valid pre-state conditions","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CaseUpdateViewEvent"}}}}}}},"/aggregated/caseworkers/{uid}/jurisdictions/{jid}/case-types/{ctid}/cases":{"get":{"tags":["query-endpoint"],"summary":"Get case data with UI layout","operationId":"searchNew","parameters":[{"name":"jid","in":"path","required":true,"schema":{"type":"string"}},{"name":"ctid","in":"path","required":true,"schema":{"type":"string"}},{"name":"params","in":"query","required":true,"schema":{"type":"object","additionalProperties":{"type":"string"}}}],"responses":{"200":{"description":"List of case data for the given search criteria","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchResultView"}}}},"412":{"description":"Mismatch between case type and workbasket definitions","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchResultView"}}}}}}},"/aggregated/caseworkers/{uid}/jurisdictions/{jid}/case-types/{ctid}/cases/{cid}":{"get":{"tags":["query-endpoint"],"summary":"Fetch a case for display","operationId":"findCase","parameters":[{"name":"jid","in":"path","required":true,"schema":{"type":"string"}},{"name":"ctid","in":"path","required":true,"schema":{"type":"string"}},{"name":"cid","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"A displayable case","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CaseView"}}}}}}},"/aggregated/caseworkers/{uid}/jurisdictions/{jid}/case-types/{ctid}/cases/{cid}/events/{eventId}/case-history":{"get":{"tags":["query-endpoint"],"summary":"Fetch case history for the event","operationId":"getCaseHistoryForEvent","parameters":[{"name":"jid","in":"path","required":true,"schema":{"type":"string"}},{"name":"ctid","in":"path","required":true,"schema":{"type":"string"}},{"name":"cid","in":"path","required":true,"schema":{"type":"string"}},{"name":"eventId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Displayable case data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CaseHistoryView"}}}},"404":{"description":"Invalid jurisdiction/case type/case reference or event id","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CaseHistoryView"}}}}}}},"/aggregated/caseworkers/{uid}/jurisdictions/{jid}/case-types/{ctid}/cases/{cid}/event-triggers/{etid}":{"get":{"tags":["query-endpoint"],"summary":"Fetch an event trigger in the context of a case","operationId":"getEventTriggerForCase","parameters":[{"name":"uid","in":"path","required":true,"schema":{"type":"string"}},{"name":"jid","in":"path","required":true,"schema":{"type":"string"}},{"name":"ctid","in":"path","required":true,"schema":{"type":"string"}},{"name":"cid","in":"path","required":true,"schema":{"type":"string"}},{"name":"etid","in":"path","required":true,"schema":{"type":"string"}},{"name":"ignore-warning","in":"query","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"Valid pre-state conditions","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CaseUpdateViewEvent"}}}}}}},"/testing-support/cleanup-case-type/{changeId}":{"delete":{"tags":["testing-support-controller"],"summary":"Delete a list of Case Type Schemas","description":"Blank body response.\n","operationId":"dataCaseTypeIdDelete","parameters":[{"name":"Case Type ID","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Success"},"404":{"description":"Unable to find case type"},"500":{"description":"Unexpected error"}}}},"/caseworkers/{uid}/jurisdictions/{jid}/case-types/{ctid}/cases/{cid}/users/{idToDelete}":{"delete":{"tags":["/"],"summary":"Revoke access to case","operationId":"revokeAccessToCase","parameters":[],"responses":{"204":{"description":"Access revoked"},"400":{"description":"Invalid case ID"}}}}},"components":{"schemas":{"CaseDataContent":{"type":"object","properties":{"event":{"$ref":"#/components/schemas/Event"},"data":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/JsonNode"}},"event_data":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/JsonNode"}},"security_classification":{"type":"string"},"data_classification":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/JsonNode"}},"event_token":{"type":"string"},"ignore_warning":{"type":"boolean"},"draft_id":{"type":"string"},"case_reference":{"type":"string"},"on_behalf_of_token":{"type":"string"},"on_behalf_of_id":{"type":"string"},"supplementary_data_request":{"type":"object","additionalProperties":{"type":"object","additionalProperties":{}}}}},"Event":{"type":"object","properties":{"id":{"type":"string"},"summary":{"type":"string"},"description":{"type":"string"}}},"JsonNode":{},"CaseDraft":{"type":"object","properties":{"userId":{"type":"string"},"jurisdictionId":{"type":"string"},"caseTypeId":{"type":"string"},"eventId":{"type":"string"},"caseDataContent":{"$ref":"#/components/schemas/CaseDataContent"}}},"DraftResponse":{"type":"object","properties":{"id":{"type":"string"},"document":{"$ref":"#/components/schemas/CaseDraft"},"type":{"type":"string"},"created":{"type":"string","format":"date-time"},"updated":{"type":"string","format":"date-time"}}},"DraftViewResource":{"type":"object","properties":{"id":{"type":"string"},"document":{"$ref":"#/components/schemas/CaseDraft"},"type":{"type":"string"},"created":{"type":"string","format":"date-time"},"updated":{"type":"string","format":"date-time"},"_links":{"$ref":"#/components/schemas/Links"}}},"DocumentDataRequest":{"type":"object","properties":{"attribute_path":{"type":"string"},"case_version":{"type":"integer","format":"int32"},"category_id":{"type":"string"}}},"CategoriesAndDocuments":{"type":"object","properties":{"case_version":{"type":"integer","format":"int32"},"categories":{"type":"array","items":{"$ref":"#/components/schemas/Category"}},"uncategorised_documents":{"type":"array","items":{"$ref":"#/components/schemas/Document"}}}},"Category":{"type":"object","properties":{"category_id":{"type":"string"},"category_name":{"type":"string"},"category_order":{"type":"integer","format":"int32"},"documents":{"type":"array","items":{"$ref":"#/components/schemas/Document"}},"sub_categories":{"type":"array","items":{"$ref":"#/components/schemas/Category"}}}},"Document":{"type":"object","properties":{"url":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"},"description":{"type":"string"}}},"CaseUser":{"type":"object","properties":{"user_id":{"type":"string"},"case_roles":{"type":"array","items":{"type":"string"},"uniqueItems":true}}},"AfterSubmitCallbackResponse":{"type":"object","properties":{"confirmation_header":{"type":"string"},"confirmation_body":{"type":"string"}}},"CaseDetails":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"jurisdiction":{"type":"string"},"state":{"type":"string"},"version":{"type":"integer","format":"int32"},"case_type_id":{"type":"string"},"created_date":{"type":"string","format":"date-time"},"last_modified":{"type":"string","format":"date-time"},"last_state_modified_date":{"type":"string","format":"date-time"},"security_classification":{"type":"string","enum":["PUBLIC","PRIVATE","RESTRICTED"]},"case_data":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/JsonNode"},"description":"Case data as defined in case type definition. See `docs/api/case-data.md` for data structure."},"data_classification":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/JsonNode"},"description":"Same structure as `case_data` with classification (`PUBLIC`, `PRIVATE`, `RESTRICTED`) as field's value."},"supplementary_data":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/JsonNode"}},"after_submit_callback_response":{"$ref":"#/components/schemas/AfterSubmitCallbackResponse"},"callback_response_status_code":{"type":"integer","format":"int32"},"callback_response_status":{"type":"string"},"callback_error_message":{"type":"string"},"delete_draft_response_status_code":{"type":"integer","format":"int32"},"delete_draft_response_status":{"type":"string"}}},"CaseSearchResult":{"type":"object","properties":{"total":{"type":"integer","format":"int64"},"cases":{"type":"array","items":{"$ref":"#/components/schemas/CaseDetails"}},"case_types_results":{"type":"array","items":{"$ref":"#/components/schemas/CaseTypeResults"}}}},"CaseTypeResults":{"type":"object","properties":{"total":{"type":"integer","format":"int64"},"case_type_id":{"type":"string"}}},"AccessControlList":{"type":"object","properties":{"create":{"type":"boolean"},"read":{"type":"boolean"},"update":{"type":"boolean"},"delete":{"type":"boolean"},"role":{"type":"string"},"accessProfile":{"type":"string"}}},"CaseFieldDefinition":{"type":"object","properties":{"id":{"type":"string"},"label":{"type":"string"},"hidden":{"type":"boolean"},"order":{"type":"integer","format":"int32"},"metadata":{"type":"boolean"},"case_type_id":{"type":"string"},"hint_text":{"type":"string"},"field_type":{"$ref":"#/components/schemas/FieldTypeDefinition"},"security_classification":{"type":"string"},"live_from":{"type":"string"},"live_until":{"type":"string"},"show_condition":{"type":"string"},"acls":{"type":"array","items":{"$ref":"#/components/schemas/AccessControlList"}},"complexACLs":{"type":"array","items":{"$ref":"#/components/schemas/ComplexACL"}},"display_context":{"type":"string"},"display_context_parameter":{"type":"string"},"retain_hidden_value":{"type":"boolean"},"formatted_value":{},"category_id":{"type":"string"}}},"CaseSearchResultViewResource":{"type":"object","properties":{"headers":{"type":"array","description":"Headers for each case type","items":{"$ref":"#/components/schemas/SearchResultViewHeaderGroup"}},"cases":{"type":"array","description":"All cases across case types","items":{"$ref":"#/components/schemas/SearchResultViewItem"}},"total":{"type":"integer","format":"int64","description":"Total number of search results (including results not returned due to pagination)"},"_links":{"$ref":"#/components/schemas/Links"}}},"ComplexACL":{"type":"object","properties":{"create":{"type":"boolean"},"read":{"type":"boolean"},"update":{"type":"boolean"},"delete":{"type":"boolean"},"listElementCode":{"type":"string"},"role":{"type":"string"},"accessProfile":{"type":"string"}}},"FieldTypeDefinition":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string"},"min":{"type":"number"},"max":{"type":"number"},"regular_expression":{"type":"string"},"fixed_list_items":{"type":"array","items":{"$ref":"#/components/schemas/FixedListItemDefinition"}},"complex_fields":{"type":"array","items":{"$ref":"#/components/schemas/CaseFieldDefinition"}},"collection_field_type":{"$ref":"#/components/schemas/FieldTypeDefinition"}}},"FixedListItemDefinition":{"type":"object","properties":{"code":{"type":"string"},"label":{"type":"string"},"order":{"type":"string"}}},"HeaderGroupMetadata":{"type":"object","properties":{"jurisdiction":{"type":"string"},"case_type_id":{"type":"string"}}},"SearchResultViewHeader":{"type":"object","properties":{"label":{"type":"string"},"order":{"type":"integer","format":"int32"},"metadata":{"type":"boolean"},"case_field_id":{"type":"string"},"case_field_type":{"$ref":"#/components/schemas/FieldTypeDefinition"},"display_context_parameter":{"type":"string"}}},"SearchResultViewHeaderGroup":{"type":"object","description":"Definition of a case type in the context of the search","properties":{"metadata":{"$ref":"#/components/schemas/HeaderGroupMetadata","description":"Metadata for the case type"},"fields":{"type":"array","description":"Definition of the fields for the case type","items":{"$ref":"#/components/schemas/SearchResultViewHeader"}},"cases":{"type":"array","description":"Case references for the case type that are returned in the search","items":{"type":"string"}}}},"SearchResultViewItem":{"type":"object","properties":{"fields":{"type":"object","additionalProperties":{}},"case_id":{"type":"string"},"fields_formatted":{"type":"object","additionalProperties":{}},"supplementary_data":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/JsonNode"}}}},"GlobalSearchRequestPayload":{"type":"object","properties":{"maxReturnRecordCount":{"type":"integer","format":"int32"},"startRecordNumber":{"type":"integer","format":"int32","minimum":1},"sortCriteria":{"type":"array","items":{"$ref":"#/components/schemas/SortCriteria"}},"searchCriteria":{"$ref":"#/components/schemas/SearchCriteria"}}},"SearchCriteria":{"type":"object","properties":{"case_type_id":{"type":"string"},"other_case_reference":{"type":"string"},"live_from":{"type":"string","format":"date-time"},"live_to":{"type":"string","format":"date-time"}}},"SortCriteria":{"type":"object","properties":{"sortBy":{"type":"string"},"sortDirection":{"type":"string"}}},"GlobalSearchResponsePayload":{"type":"object","properties":{"resultInfo":{"$ref":"#/components/schemas/ResultInfo"},"results":{"type":"array","items":{"$ref":"#/components/schemas/Result"}}}},"Result":{"type":"object","properties":{"stateId":{"type":"string"},"processForAccess":{"type":"string"},"caseReference":{"type":"string"},"otherReferences":{"type":"array","items":{"type":"string"}},"caseNameHmctsInternal":{"type":"string"},"baseLocationId":{"type":"string"},"baseLocationName":{"type":"string"},"caseManagementCategoryId":{"type":"string"},"caseManagementCategoryName":{"type":"string"},"regionId":{"type":"string"},"regionName":{"type":"string"},"CCDJurisdictionId":{"type":"string"},"CCDJurisdictionName":{"type":"string"},"HMCTSServiceId":{"type":"string"},"HMCTSServiceShortDescription":{"type":"string"},"CCDCaseTypeId":{"type":"string"},"CCDCaseTypeName":{"type":"string"}}},"ResultInfo":{"type":"object","properties":{"casesReturned":{"type":"integer","format":"int32"},"caseStartRecord":{"type":"integer","format":"int32"},"moreResultsToGo":{"type":"boolean"}}},"UserId":{"type":"object","properties":{"id":{"type":"string"}}},"SupplementaryDataUpdateRequest":{"type":"object","properties":{"supplementary_data_updates":{"type":"object","additionalProperties":{"type":"object","additionalProperties":{}}}}},"SupplementaryDataResource":{"type":"object","properties":{"supplementary_data":{"type":"object","additionalProperties":{}}}},"CaseResource":{"type":"object","properties":{"_links":{"$ref":"#/components/schemas/Links"},"id":{"type":"string"},"jurisdiction":{"type":"string"},"case_type":{"type":"string"},"created_on":{"type":"string","format":"date-time"},"last_modified_on":{"type":"string","format":"date-time"},"last_state_modified_on":{"type":"string","format":"date-time"},"state":{"type":"string"},"security_classification":{"type":"string","enum":["PUBLIC","PRIVATE","RESTRICTED"]},"data":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/JsonNode"}},"data_classification":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/JsonNode"}},"after_submit_callback_response":{"$ref":"#/components/schemas/AfterSubmitCallbackResponse"},"callback_response_status_code":{"type":"integer","format":"int32"},"callback_response_status":{"type":"string"},"callback_error_message":{"type":"string"},"delete_draft_response_status_code":{"type":"integer","format":"int32"},"delete_draft_response_status":{"type":"string"}}},"SupplementaryDataCasesUpdateRequest":{"type":"object","properties":{"cases":{"type":"array","items":{"type":"string"}},"supplementary_data_updates":{"type":"object","additionalProperties":{"type":"object","additionalProperties":{}}}}},"SupplementaryCaseFailDataResource":{"type":"object","properties":{"caseId":{"type":"string"},"failure_reason":{"type":"string"}}},"SupplementaryCaseSuccessDataResource":{"type":"object","properties":{"caseId":{"type":"string"},"supplementary_data":{"type":"object","additionalProperties":{}}}},"SupplementaryCasesDataResource":{"type":"object","properties":{"successes":{"type":"array","items":{"$ref":"#/components/schemas/SupplementaryCaseSuccessDataResource"}},"failures":{"type":"array","items":{"$ref":"#/components/schemas/SupplementaryCaseFailDataResource"}}}},"CaseAssignedUserRoleWithOrganisation":{"type":"object","properties":{"case_id":{"type":"string"},"user_id":{"type":"string"},"case_role":{"type":"string"},"organisation_id":{"type":"string"}}},"CaseAssignedUserRolesRequest":{"type":"object","properties":{"case_users":{"type":"array","items":{"$ref":"#/components/schemas/CaseAssignedUserRoleWithOrganisation"}}}},"CaseAssignedUserRolesResponse":{"type":"object","description":"Add Case-Assigned User Roles Response","properties":{"status_message":{"type":"string","description":"Domain Status Message","example":"Case-User-Role assignments created successfully"}},"required":["status_message"]},"SearchCaseAssignedUserRolesRequest":{"type":"object","properties":{"case_ids":{"type":"array","items":{"type":"string"}},"user_ids":{"type":"array","items":{"type":"string"}}}},"CaseAssignedUserRole":{"type":"object","properties":{"case_id":{"type":"string"},"user_id":{"type":"string"},"case_role":{"type":"string"}}},"CaseAssignedUserRolesResource":{"type":"object","properties":{"case_users":{"type":"array","items":{"$ref":"#/components/schemas/CaseAssignedUserRole"}}}},"CaseDataResource":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/JsonNode"},"_links":{"$ref":"#/components/schemas/Links"}}},"CaseLink":{"type":"object","properties":{"CaseReference":{"type":"integer","format":"int64"},"LinkedCaseReference":{"type":"integer","format":"int64"},"CaseTypeId":{"type":"string"},"StandardLink":{"type":"boolean"}}},"CaseLinksResource":{"type":"object","properties":{"CaseLinks":{"type":"array","items":{"$ref":"#/components/schemas/CaseLink"}}}},"CaseViewActionableEvent":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"order":{"type":"integer","format":"int32"}}},"CaseViewEvent":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"timestamp":{"type":"string","format":"date-time"},"summary":{"type":"string"},"comment":{"type":"string"},"event_id":{"type":"string"},"event_name":{"type":"string"},"user_id":{"type":"string"},"user_last_name":{"type":"string"},"user_first_name":{"type":"string"},"state_name":{"type":"string"},"state_id":{"type":"string"},"significant_item":{"$ref":"#/components/schemas/SignificantItem"},"proxied_by":{"type":"string"},"proxied_by_last_name":{"type":"string"},"proxied_by_first_name":{"type":"string"}}},"CaseViewField":{"type":"object","properties":{"id":{"type":"string"},"label":{"type":"string"},"hidden":{"type":"boolean"},"value":{},"metadata":{"type":"boolean"},"hint_text":{"type":"string"},"field_type":{"$ref":"#/components/schemas/FieldTypeDefinition"},"validation_expr":{"type":"string"},"security_label":{"type":"string"},"order":{"type":"integer","format":"int32"},"formatted_value":{},"display_context":{"type":"string"},"display_context_parameter":{"type":"string"},"show_condition":{"type":"string"},"show_summary_change_option":{"type":"boolean"},"show_summary_content_option":{"type":"integer","format":"int32"},"retain_hidden_value":{"type":"boolean"},"publish":{"type":"boolean"},"publish_as":{"type":"string"},"acls":{"type":"array","items":{"$ref":"#/components/schemas/AccessControlList"}}}},"CaseViewJurisdiction":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"}}},"CaseViewResource":{"type":"object","properties":{"_links":{"$ref":"#/components/schemas/Links"},"case_id":{"type":"string"},"case_type":{"$ref":"#/components/schemas/CaseViewType"},"tabs":{"type":"array","items":{"$ref":"#/components/schemas/CaseViewTab"}},"metadataFields":{"type":"array","items":{"$ref":"#/components/schemas/CaseViewField"}},"state":{"$ref":"#/components/schemas/ProfileCaseState"},"triggers":{"type":"array","items":{"$ref":"#/components/schemas/CaseViewActionableEvent"}},"events":{"type":"array","items":{"$ref":"#/components/schemas/CaseViewEvent"}}}},"CaseViewTab":{"type":"object","properties":{"id":{"type":"string"},"label":{"type":"string"},"order":{"type":"integer","format":"int32"},"fields":{"type":"array","items":{"$ref":"#/components/schemas/CaseViewField"}},"role":{"type":"string"},"show_condition":{"type":"string"}}},"CaseViewType":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"jurisdiction":{"$ref":"#/components/schemas/CaseViewJurisdiction"},"printEnabled":{"type":"boolean"}}},"ProfileCaseState":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"title_display":{"type":"string"}}},"SignificantItem":{"type":"object","properties":{"type":{"type":"string"},"description":{"type":"string"},"url":{"type":"string"}}},"AccessTypeDefinition":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"access_mandatory":{"type":"boolean"},"access_default":{"type":"boolean"},"display":{"type":"boolean"},"description":{"type":"string"},"hint":{"type":"string"},"display_order":{"type":"integer","format":"int32"},"live_from":{"type":"string","format":"date"},"live_to":{"type":"string","format":"date"},"case_type_id":{"type":"string"},"access_type_id":{"type":"string"},"organisation_profile_id":{"type":"string"}}},"AccessTypeRoleDefinition":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"live_from":{"type":"string","format":"date"},"live_to":{"type":"string","format":"date"},"case_type_id":{"type":"string"},"access_type_id":{"type":"string"},"organisation_profile_id":{"type":"string"},"organisational_role_name":{"type":"string"},"group_role_name":{"type":"string"},"case_assigned_role_field":{"type":"string"},"group_access_enabled":{"type":"boolean"},"case_access_group_id_template":{"type":"string"}}},"CaseEventDefinition":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"order":{"type":"integer","format":"int32"},"case_fields":{"type":"array","items":{"$ref":"#/components/schemas/CaseEventFieldDefinition"}},"pre_states":{"type":"array","items":{"type":"string"}},"post_states":{"type":"array","items":{"$ref":"#/components/schemas/EventPostStateDefinition"}},"callback_url_about_to_start_event":{"type":"string"},"retries_timeout_about_to_start_event":{"type":"array","items":{"type":"integer","format":"int32"}},"callback_url_about_to_submit_event":{"type":"string"},"retries_timeout_url_about_to_submit_event":{"type":"array","items":{"type":"integer","format":"int32"}},"callback_url_submitted_event":{"type":"string"},"retries_timeout_url_submitted_event":{"type":"array","items":{"type":"integer","format":"int32"}},"security_classification":{"type":"string","enum":["PUBLIC","PRIVATE","RESTRICTED"]},"show_summary":{"type":"boolean"},"show_event_notes":{"type":"boolean"},"end_button_label":{"type":"string"},"can_save_draft":{"type":"boolean"},"publish":{"type":"boolean"},"acls":{"type":"array","items":{"$ref":"#/components/schemas/AccessControlList"}},"event_enabling_condition":{"type":"string"},"ttl_increment":{"type":"integer","format":"int32"}}},"CaseEventFieldComplexDefinition":{"type":"object","properties":{"reference":{"type":"string"},"order":{"type":"integer","format":"int32"},"displayContextParameter":{"type":"string"},"defaultValue":{"type":"string"},"retainHiddenValue":{"type":"boolean"},"publish":{"type":"boolean"},"publishAs":{"type":"string"}}},"CaseEventFieldDefinition":{"type":"object","properties":{"case_field_id":{"type":"string","description":"Foreign key to CaseField.id"},"display_context":{"type":"string","description":"whether this field is optional, mandatory or read only for this event"},"display_context_parameter":{"type":"string","description":"contain names of fields for list or table"},"show_condition":{"type":"string","description":"Show Condition expression for this field"},"show_summary_change_option":{"type":"boolean","description":"Show Summary Change Option"},"show_summary_content_option":{"type":"integer","format":"int32","description":"Show Summary Content Option"},"label":{"type":"string"},"hint_text":{"type":"string"},"retain_hidden_value":{"type":"boolean","description":"whether this field is data should be retained, dependant on show_condition being populated"},"publish":{"type":"boolean","description":"whether this field is data should be published"},"publish_as":{"type":"string","description":"Alias for field id if published is set to true"},"case_fields_complex":{"type":"array","items":{"$ref":"#/components/schemas/CaseEventFieldComplexDefinition"}},"default_value":{"type":"string","description":"Default value for the case field, if no existing value"},"nullify_by_default":{"type":"boolean","description":"Nullify By Default value for the case field"}},"required":["case_field_id"]},"CaseStateDefinition":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string","description":"Short name to display."},"description":{"type":"string"},"order":{"type":"integer","format":"int32"},"title_display":{"type":"string","description":"Title label to be displayed for state"},"acls":{"type":"array","description":"State Access Control Lists","items":{"$ref":"#/components/schemas/AccessControlList"}}},"required":["id"]},"CaseTypeDefinition":{"type":"object","properties":{"id":{"type":"string"},"description":{"type":"string"},"version":{"$ref":"#/components/schemas/Version"},"name":{"type":"string"},"events":{"type":"array","items":{"$ref":"#/components/schemas/CaseEventDefinition"}},"states":{"type":"array","items":{"$ref":"#/components/schemas/CaseStateDefinition"}},"searchAliasFields":{"type":"array","items":{"$ref":"#/components/schemas/SearchAliasField"}},"searchParties":{"type":"array","items":{"$ref":"#/components/schemas/SearchParty"}},"searchCriterias":{"type":"array","items":{"$ref":"#/components/schemas/SearchCriteria"}},"categories":{"type":"array","items":{"$ref":"#/components/schemas/CategoryDefinition"}},"jurisdiction":{"$ref":"#/components/schemas/JurisdictionDefinition"},"security_classification":{"type":"string","enum":["PUBLIC","PRIVATE","RESTRICTED"]},"case_fields":{"type":"array","items":{"$ref":"#/components/schemas/CaseFieldDefinition"}},"printable_document_url":{"type":"string"},"acls":{"type":"array","items":{"$ref":"#/components/schemas/AccessControlList"}},"callback_get_case_url":{"type":"string"},"retries_get_case_url":{"type":"array","items":{"type":"integer","format":"int32"}},"roleToAccessProfiles":{"type":"array","items":{"$ref":"#/components/schemas/RoleToAccessProfileDefinition"}},"accessTypes":{"type":"array","items":{"$ref":"#/components/schemas/AccessTypeDefinition"}},"accessTypeRoles":{"type":"array","items":{"$ref":"#/components/schemas/AccessTypeRoleDefinition"}}}},"CategoryDefinition":{"type":"object","properties":{"category_id":{"type":"string"},"category_label":{"type":"string"},"parent_category_id":{"type":"string"},"live_from":{"type":"string","format":"date"},"live_to":{"type":"string","format":"date"},"display_order":{"type":"integer","format":"int32"},"case_type_id":{"type":"string"}}},"EventPostStateDefinition":{"type":"object","properties":{"enabling_condition":{"type":"string"},"priority":{"type":"integer","format":"int32"},"post_state_reference":{"type":"string"}}},"JurisdictionDefinition":{"type":"object","properties":{"caseTypesIDs":{"type":"array","items":{"type":"string"}},"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"live_from":{"type":"string","format":"date-time"},"live_until":{"type":"string","format":"date-time"},"case_types":{"type":"array","items":{"$ref":"#/components/schemas/CaseTypeDefinition"}}},"required":["id","name"]},"JurisdictionView":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"caseTypeDefinitions":{"type":"array","items":{"$ref":"#/components/schemas/CaseTypeDefinition"}}}},"JurisdictionViewResource":{"type":"object","properties":{"jurisdictions":{"type":"array","items":{"$ref":"#/components/schemas/JurisdictionView"}},"_links":{"$ref":"#/components/schemas/Links"}}},"RoleToAccessProfileDefinition":{"type":"object","properties":{"disabled":{"type":"boolean"},"authorisations":{"type":"string"},"authorisationList":{"type":"array","items":{"type":"string"}},"accessProfileList":{"type":"array","items":{"type":"string"}},"case_type_id":{"type":"string"},"read_only":{"type":"boolean"},"access_profiles":{"type":"string"},"live_from":{"type":"string"},"live_to":{"type":"string"},"role_name":{"type":"string"},"case_access_categories":{"type":"string"}}},"SearchAliasField":{"type":"object","properties":{"id":{"type":"string"},"caseTypeId":{"type":"string"},"caseFieldPath":{"type":"string"},"fieldTypeDefinition":{"$ref":"#/components/schemas/FieldTypeDefinition"}}},"SearchParty":{"type":"object","properties":{"case_type_id":{"type":"string"},"search_party_dob":{"type":"string"},"search_party_dod":{"type":"string"},"search_party_post_code":{"type":"string"},"search_party_address_line1":{"type":"string"},"search_party_email_address":{"type":"string"},"live_from":{"type":"string","format":"date-time"},"live_to":{"type":"string","format":"date-time"},"search_party_name":{"type":"string"},"search_party_collection_field_name":{"type":"string"}}},"Version":{"type":"object","properties":{"number":{"type":"integer","format":"int32","description":"Sequantial version number"},"live_from":{"type":"string","format":"date-time","description":"Date and time from when this version is valid from"},"live_until":{"type":"string","format":"date-time","description":"Date and time this version is to be retired"}},"required":["live_from","number"]},"JurisdictionConfigViewResource":{"type":"object","properties":{"configs":{"type":"array","items":{"$ref":"#/components/schemas/JurisdictionUiConfigDefinition"}},"_links":{"$ref":"#/components/schemas/Links"}}},"JurisdictionUiConfigDefinition":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"shuttered":{"type":"boolean"}}},"CaseUpdateViewEvent":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"case_id":{"type":"string"},"case_fields":{"type":"array","items":{"$ref":"#/components/schemas/CaseViewField"}},"event_token":{"type":"string"},"wizard_pages":{"type":"array","items":{"$ref":"#/components/schemas/WizardPage"}},"show_summary":{"type":"boolean"},"show_event_notes":{"type":"boolean"},"end_button_label":{"type":"string"},"can_save_draft":{"type":"boolean"},"access_granted":{"type":"string"},"access_process":{"type":"string"},"title_display":{"type":"string"},"supplementary_data":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/JsonNode"}}}},"CaseUpdateViewEventResource":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"case_id":{"type":"string"},"case_fields":{"type":"array","items":{"$ref":"#/components/schemas/CaseViewField"}},"event_token":{"type":"string"},"wizard_pages":{"type":"array","items":{"$ref":"#/components/schemas/WizardPage"}},"show_summary":{"type":"boolean"},"show_event_notes":{"type":"boolean"},"end_button_label":{"type":"string"},"can_save_draft":{"type":"boolean"},"access_granted":{"type":"string"},"access_process":{"type":"string"},"title_display":{"type":"string"},"supplementary_data":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/JsonNode"}},"_links":{"$ref":"#/components/schemas/Links"}}},"WizardPage":{"type":"object","properties":{"id":{"type":"string"},"label":{"type":"string"},"order":{"type":"integer","format":"int32"},"wizard_page_fields":{"type":"array","items":{"$ref":"#/components/schemas/WizardPageField"}},"show_condition":{"type":"string"},"callback_url_mid_event":{"type":"string"},"retries_timeout_mid_event":{"type":"array","items":{"type":"integer","format":"int32"}}}},"WizardPageComplexFieldOverride":{"type":"object","properties":{"complex_field_element_id":{"type":"string"},"display_context":{"type":"string"},"label":{"type":"string"},"hint_text":{"type":"string"},"show_condition":{"type":"string"},"retain_hidden_value":{"type":"boolean"}}},"WizardPageField":{"type":"object","properties":{"case_field_id":{"type":"string"},"order":{"type":"integer","format":"int32"},"page_column_no":{"type":"integer","format":"int32"},"complex_field_overrides":{"type":"array","items":{"$ref":"#/components/schemas/WizardPageComplexFieldOverride"}}}},"CaseHistoryViewResource":{"type":"object","properties":{"tabs":{"type":"array","items":{"$ref":"#/components/schemas/CaseViewTab"}},"metadataFields":{"type":"array","items":{"$ref":"#/components/schemas/CaseViewField"}},"_links":{"$ref":"#/components/schemas/Links"},"case_id":{"type":"string"},"case_type":{"$ref":"#/components/schemas/CaseViewType"},"event":{"$ref":"#/components/schemas/CaseViewEvent"}}},"CaseAccessMetadata":{"type":"object","properties":{"accessGrants":{"type":"array","items":{"type":"string","enum":["BASIC","CHALLENGED","EXCLUDED","STANDARD","SPECIFIC"]}},"accessProcess":{"type":"string","enum":["CHALLENGED","SPECIFIC","NONE"]}}},"Field":{"type":"object","properties":{"id":{"type":"string"},"elementPath":{"type":"string"},"metadata":{"type":"boolean"},"field_type":{"$ref":"#/components/schemas/FieldTypeDefinition"},"show_condition":{"type":"string"}}},"WorkbasketInputView":{"type":"object","properties":{"label":{"type":"string"},"order":{"type":"integer","format":"int32"},"field":{"$ref":"#/components/schemas/Field"},"dataType":{"type":"string"},"display_context_parameter":{"type":"string"}}},"WorkbasketInputsViewResource":{"type":"object","properties":{"workbasketInputs":{"type":"array","items":{"$ref":"#/components/schemas/WorkbasketInputView"}},"_links":{"$ref":"#/components/schemas/Links"}}},"SearchInputView":{"type":"object","properties":{"label":{"type":"string"},"order":{"type":"integer","format":"int32"},"field":{"$ref":"#/components/schemas/Field"},"dataType":{"type":"string"},"display_context_parameter":{"type":"string"}}},"SearchInputsViewResource":{"type":"object","properties":{"searchInputs":{"type":"array","items":{"$ref":"#/components/schemas/SearchInputView"}},"_links":{"$ref":"#/components/schemas/Links"}}},"Banner":{"type":"object","properties":{"id":{"type":"string"},"bannerEnabled":{"type":"boolean"},"bannerDescription":{"type":"string"},"bannerUrlText":{"type":"string"},"bannerUrl":{"type":"string"},"jurisdictionDefinition":{"$ref":"#/components/schemas/JurisdictionDefinition"}}},"BannerViewResource":{"type":"object","properties":{"banners":{"type":"array","items":{"$ref":"#/components/schemas/Banner"}},"_links":{"$ref":"#/components/schemas/Links"}}},"CaseLinkDetails":{"type":"object","properties":{"createdDateTime":{"type":"string","format":"date-time"},"reasons":{"type":"array","items":{"$ref":"#/components/schemas/Reason"}}}},"CaseLinkInfo":{"type":"object","properties":{"caseNameHmctsInternal":{"type":"string"},"caseReference":{"type":"string"},"ccdCaseType":{"type":"string"},"ccdJurisdiction":{"type":"string"},"state":{"type":"string"},"linkDetails":{"type":"array","items":{"$ref":"#/components/schemas/CaseLinkDetails"}}}},"GetLinkedCasesResponse":{"type":"object","properties":{"hasMoreRecords":{"type":"boolean"},"linkedCases":{"type":"array","items":{"$ref":"#/components/schemas/CaseLinkInfo"}}}},"Reason":{"type":"object","properties":{"reasonCode":{"type":"string"},"otherDescription":{"type":"string"}}},"StartEventResult":{"type":"object","properties":{"token":{"type":"string"},"case_details":{"$ref":"#/components/schemas/CaseDetails"},"event_id":{"type":"string"}}},"PaginatedSearchMetadata":{"type":"object","properties":{"total_results_count":{"type":"integer","format":"int32"},"total_pages_count":{"type":"integer","format":"int32"}}},"DefaultSettings":{"type":"object","properties":{"workbasket":{"$ref":"#/components/schemas/WorkbasketDefault"}}},"IdamProperties":{"type":"object","properties":{"id":{"type":"string"},"email":{"type":"string"},"forename":{"type":"string"},"surname":{"type":"string"},"roles":{"type":"array","items":{"type":"string"}},"defaultService":{"type":"string"}}},"JurisdictionDisplayProperties":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"caseTypes":{"type":"array","items":{"$ref":"#/components/schemas/CaseTypeDefinition"}}}},"User":{"type":"object","properties":{"idam":{"$ref":"#/components/schemas/IdamProperties"}}},"UserProfile":{"type":"object","properties":{"user":{"$ref":"#/components/schemas/User"},"channels":{"type":"array","items":{"type":"string"}},"jurisdictions":{"type":"array","items":{"$ref":"#/components/schemas/JurisdictionDisplayProperties"}},"default":{"$ref":"#/components/schemas/DefaultSettings"}}},"WorkbasketDefault":{"type":"object","properties":{"jurisdiction_id":{"type":"string"},"case_type_id":{"type":"string"},"state_id":{"type":"string"}}},"CaseView":{"type":"object","properties":{"tabs":{"type":"array","items":{"$ref":"#/components/schemas/CaseViewTab"}},"metadataFields":{"type":"array","items":{"$ref":"#/components/schemas/CaseViewField"}},"state":{"$ref":"#/components/schemas/ProfileCaseState"},"channels":{"type":"array","items":{"type":"string"}},"case_id":{"type":"string"},"case_type":{"$ref":"#/components/schemas/CaseViewType"},"triggers":{"type":"array","items":{"$ref":"#/components/schemas/CaseViewActionableEvent"}},"events":{"type":"array","items":{"$ref":"#/components/schemas/CaseViewEvent"}}}},"AuditEvent":{"type":"object","properties":{"id":{"type":"string"},"summary":{"type":"string"},"description":{"type":"string"},"user_id":{"type":"string"},"user_last_name":{"type":"string"},"user_first_name":{"type":"string"},"event_name":{"type":"string"},"created_date":{"type":"string","format":"date-time"},"case_type_id":{"type":"string"},"case_type_version":{"type":"integer","format":"int32"},"state_id":{"type":"string"},"state_name":{"type":"string"},"data":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/JsonNode"},"description":"Case data as defined in case type definition. See `docs/api/case-data.md` for data structure."},"data_classification":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/JsonNode"},"description":"Same structure as `data` with classification (`PUBLIC`, `PRIVATE`, `RESTRICTED`) as field's value."},"security_classification":{"type":"string","enum":["PUBLIC","PRIVATE","RESTRICTED"]},"significant_item":{"$ref":"#/components/schemas/SignificantItem"},"proxied_by":{"type":"string"},"proxied_by_last_name":{"type":"string"},"proxied_by_first_name":{"type":"string"}}},"CaseEventsResource":{"type":"object","properties":{"auditEvents":{"type":"array","items":{"$ref":"#/components/schemas/AuditEvent"}},"_links":{"$ref":"#/components/schemas/Links"}}},"StartEventResource":{"type":"object","properties":{"token":{"type":"string"},"_links":{"$ref":"#/components/schemas/Links"},"case_details":{"$ref":"#/components/schemas/CaseDetails"},"event_id":{"type":"string"}}},"DocumentsResource":{"type":"object","properties":{"documentResources":{"type":"array","items":{"$ref":"#/components/schemas/Document"}},"_links":{"$ref":"#/components/schemas/Links"}}},"CaseDocumentMetadata":{"type":"object","properties":{"caseId":{"type":"string"},"documentPermissions":{"$ref":"#/components/schemas/DocumentPermissions"}}},"CaseDocumentResource":{"type":"object","properties":{"_links":{"$ref":"#/components/schemas/Links"},"documentMetadata":{"$ref":"#/components/schemas/CaseDocumentMetadata"}}},"DocumentPermissions":{"type":"object","properties":{"id":{"type":"string"},"permissions":{"type":"array","items":{"type":"string","enum":["CREATE","READ","UPDATE","DELETE"]}}}},"WorkbasketInput":{"type":"object","properties":{"label":{"type":"string"},"order":{"type":"integer","format":"int32"},"field":{"$ref":"#/components/schemas/Field"},"role":{"type":"string"},"display_context_parameter":{"type":"string"}}},"SearchInput":{"type":"object","properties":{"label":{"type":"string"},"order":{"type":"integer","format":"int32"},"field":{"$ref":"#/components/schemas/Field"},"role":{"type":"string"},"display_context_parameter":{"type":"string"}}},"SearchResultView":{"type":"object","properties":{"columns":{"type":"array","items":{"$ref":"#/components/schemas/SearchResultViewColumn"}},"results":{"type":"array","items":{"$ref":"#/components/schemas/SearchResultViewItem"}},"result_error":{"type":"string"}}},"SearchResultViewColumn":{"type":"object","properties":{"label":{"type":"string"},"order":{"type":"integer","format":"int32"},"metadata":{"type":"boolean"},"case_field_id":{"type":"string"},"case_field_type":{"$ref":"#/components/schemas/FieldTypeDefinition"},"display_context_parameter":{"type":"string"}}},"CaseHistoryView":{"type":"object","properties":{"tabs":{"type":"array","items":{"$ref":"#/components/schemas/CaseViewTab"}},"metadataFields":{"type":"array","items":{"$ref":"#/components/schemas/CaseViewField"}},"event":{"$ref":"#/components/schemas/CaseViewEvent"},"case_id":{"type":"string"},"case_type":{"$ref":"#/components/schemas/CaseViewType"}}},"Link":{"type":"object","properties":{"href":{"type":"string"},"hreflang":{"type":["string","null"]},"title":{"type":["string","null"]},"type":{"type":["string","null"]},"deprecation":{"type":["string","null"]},"profile":{"type":["string","null"]},"name":{"type":["string","null"]},"templated":{"type":"boolean"}}},"Links":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/Link"}}}}}