{"openapi":"3.0.0","info":{"title":"Cases","version":"1.0.0","description":"Cases are created within Alloy when a person, place, or thing meets some criteria that needs human review, escalation or resolution - usually in the form of marking the alert that opened the case as a \"false positive\" (this is nothing) OR taking action on the account in question (closing it, cancelling the transaction, declining to open it). There can only be one open case per (entity, category, environment) combination.  We expect many types of customers to only use one category, meaning for them only a single case can be open at a time, per customer."},"components":{"schemas":{"LinkReference":{"properties":{"href":{"type":"string"}}},"EmbeddedEntityComponent":{"properties":{"name":{"type":"string"},"entity_token":{"type":"string"},"external_entity_id":{"type":"number"},"type":{"type":"string"},"_links":{"type":"object","properties":{"self":{"$ref":"#/components/schemas/LinkReference"},"case":{"$ref":"#/components/schemas/LinkReference"}}}}},"EmbeddedComponent":{"properties":{"entity":{"$ref":"#/components/schemas/EmbeddedEntityComponent"}}},"TransactionSummary":{"properties":{"transaction_id":{"type":"number"},"amount":{"type":"number"}}},"CaseAlert":{"properties":{"customvalue":{"type":"string"}}},"EvidencesLinksSummary":{"properties":{"case":{"$ref":"#/components/schemas/LinkReference"},"self":{"$ref":"#/components/schemas/LinkReference"}}},"Case":{"properties":{"status_code":{"type":"number"},"error":{"type":"string"},"case_token":{"type":"string"},"entity_token":{"type":"string"},"status":{"type":"string"},"closed":{"type":"boolean"},"sandbox":{"type":"boolean"},"unread":{"type":"boolean"},"created_at":{"type":"number"},"updated_at":{"type":"number"},"closed_at":{"type":"number"},"alerts":{"type":"array","items":{"$ref":"#/components/schemas/CaseAlert"}},"_embedded":{"$ref":"#/components/schemas/EmbeddedComponent"},"_links":{"type":"object","properties":{"cases":{"$ref":"#/components/schemas/LinkReference"},"self":{"$ref":"#/components/schemas/LinkReference"},"evidences":{"$ref":"#/components/schemas/LinkReference"},"works":{"$ref":"#/components/schemas/LinkReference"}}}}},"EvidenceComponent":{"properties":{"created_at":{"type":"number"},"occurred_at":{"type":"number"},"transaction_id":{"type":"number"},"evaluation_token":{"type":"string"},"alerts":{"type":"array","items":{"$ref":"#/components/schemas/CaseAlert"}},"_embedded":{"type":"object","properties":{"transaction":{"$ref":"#/components/schemas/TransactionSummary"}}}}},"CaseEvidence":{"properties":{"status_code":{"type":"number"},"error":{"type":"string"},"_embedded":{"properties":{"evidences":{"type":"array","items":{"$ref":"#/components/schemas/EvidenceComponent"}}}},"_links":{"$ref":"#/components/schemas/EvidencesLinksSummary"}}},"WorkComponent":{"properties":{"type":{"type":"string","enum":["note","closure","status"]},"note":{"type":"string"},"status":{"type":"string"},"closed":{"type":"boolean"},"reasons":{"type":"array"},"created_at":{"type":"number"},"_embedded":{"type":"object","properties":{"created_by":{"type":"object","properties":{"name":{"type":"string"},"email":{"type":"string"}}}}}}},"CaseWorks":{"properties":{"status_code":{"type":"number"},"error":{"type":"string"},"_embedded":{"type":"object","properties":{"works":{"type":"array","items":{"$ref":"#/components/schemas/WorkComponent"}}}},"_links":{"type":"object","properties":{"self":{"$ref":"#/components/schemas/LinkReference"},"case":{"$ref":"#/components/schemas/LinkReference"}}}}}}},"paths":{"/cases":{"get":{"tags":["Cases"],"summary":"Get a list of all possible cases created using Alloy Case Management.","description":"Retrieves the list of all cases created. Note that this is a long-running query and needs to be paginated.","responses":{"200":{"x-summary":"OK","description":"Case","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Case"}}}}}}}},"/cases/{case_token}":{"get":{"tags":["Cases"],"summary":"Get a case by a uniquely defined case token","description":"Retrieves a single case uniquely defined by a case token. Case tokens are alphanumeric characters that start with a prefix \"C-\".","parameters":[{"in":"path","name":"case_token","schema":{"type":"string"},"required":true,"description":"Token of case to get."}],"responses":{"200":{"x-summary":"OK","description":"Case","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/Case"}}}}}}},"/cases/{case_token}/evidences":{"get":{"tags":["Cases"],"summary":"Get case evidences by case token","description":"Retrieves a list of case evidences uniquely defined by a case token. Case tokens are alphanumeric characters that start with a prefix \"C-\".","parameters":[{"in":"path","name":"case_token","schema":{"type":"string"},"required":true,"description":"Token of case to get evidence for."}],"responses":{"200":{"x-summary":"OK","description":"CaseEvidence","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/CaseEvidence"}}}}}}},"/cases/{case_token}/works":{"get":{"tags":["Cases"],"summary":"Get case works for a case","description":"Retrieves a list of case works defined for a given case by a case token. Case work is any action an agent takes on a case. The three main types of work are `closure` (close a case), `status` (change case status), or `note` (leave a note on a case). All three types of case works can have a note.\n","parameters":[{"in":"path","name":"case_token","schema":{"type":"string"},"required":true,"description":"Token of case to get works for."}],"responses":{"200":{"x-summary":"OK","description":"CaseEvidence","content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/CaseWorks"}}}}}}}},"x-si-base":"./InternalDocs/docs/cases.yaml","x-github-repo":"UseAlloy/Alloy","x-github-sha":"5fa046ee6f027fda6cbf56f212ef6b42e94c1bfe","x-readme":{"explorer-enabled":true,"proxy-enabled":true}}