PUT
Update Case
Updates a Case.
Important
Calls to this method must include the cookie .LawPanel.AuthCookie in order to identify you at user level. For more details about authentication please check this link. To obtain the cookie you can use the method Login.
Request URL
Request headers
string
Subscription key which provides access to this API.
Request body
Payload with data to update the Case.
- string Required id: Case ID to be modified.
- string Required name: Name of the Case.
- string Required file_status_id: The Case status ID. To get a list of statuses available please check this link.
- string Required file_client_id: The Company ID to be used as Agent for the Case. To get a list of Companies available please check this link.
- array Optional tags: The tags ID for the Case. To get a list of tags available please check this link.
- array Optional other_supervisors: The User IDs for other supervisors of this Case. To get a list of users available please check this link.
- string Required user_id: The User ID to be the Case Owner/Responsible. To get a list of Users available please check this link.
- string Optional number: A string to be used as a representation/code for the case.
-
array
Required
components: An array with values for all components of the Case Template:
- string Required file_template_component_id: The ID of the case template component. To get more details about the case template please check this link.
- string Optional entity_id: If this component is binded with an entity of LawPanel (an User, Company, Registry, Search, etc.) you should use its ID here. Else you can ignore this field.
- string Optional value: If this component is not binded with an entity of LawPanel (it's an String, DateTime, Integer, etc.) you should include here its value. If component is an structure of any type, you should save the value as a JSON serialized entity.
- bool Required active: A boolean to identify/filter active or not active Cases.
Loading...
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"file_status_id": {
"type": "string"
},
"file_client_id": {},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"other_supervisors": {
"type": "array",
"items": {
"type": "string"
}
},
"user_id": {
"type": "string"
},
"number": {
"type": "string"
},
"components": {
"type": "array",
"items": {
"type": "object",
"properties": {
"file_template_component_id": {
"type": "string"
},
"entity_id": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"id",
"file_template_component_id",
"entity_id",
"value"
]
}
},
"active": {
"type": "string"
}
},
"example": {
"id": "53d2d270-4129-4a86-9123-ab4500df3da4",
"name": "Yun Bey",
"file_status_id": "dbb513aa-58e3-4a70-a805-a74c00714768",
"file_client_id": null,
"tags": [
"da599d0b-1010-45ca-8ced-ac3600c3c1c7",
" 5c9ced5e-c6c5-4dee-8fed-ac3600c3ca09"
],
"other_supervisors": [
"03ce7827-aac0-477d-a01b-aad8012abc99"
],
"user_id": "03ce7827-aac0-477d-a01b-aad8012abc99",
"number": "0303456",
"components": [
{
"file_template_component_id": "03f91a9b-fa22-4e3f-b95d-aad8012abc45",
"entity_id": "00000000-0000-0000-0000-000000000000",
"value": "Common Law Mark"
},
{
"file_template_component_id": "27cd665d-084b-45d2-a8dc-aad8012abc45",
"entity_id": "00000000-0000-0000-0000-000000000000",
"value": "Opposed"
},
{
"file_template_component_id": "67d2da70-62ef-4a31-a665-aad8012abc45",
"entity_id": "00000000-0000-0000-0000-000000000000",
"value": "2020-09-14T00:00:00Z"
},
{
"file_template_component_id": "78a1df77-bf30-4439-8dc7-aad8012abc4e",
"entity_id": "00000000-0000-0000-0000-000000000000",
"value": "This is the content for the property \"Information\""
}
],
"active": "true"
}
}
Response 200
Return details about the update operation.
Loading...