Merge a layout

Merges layout data.

PATCH /matters/{matterId}/layouts/{itemId}

Merge a layout

cURL

curl --request PATCH \
  --url https://api.smokeball.com/matters/{matterId}/layouts/{itemId} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json-patch+json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "itemId": "59791902-6280-471b-bd18-f8439ba3042f",
  "layoutDesignId": "414ab774-adce-4659-b18c-82d1b0e826a0",
  "index": 0,
  "parentItemId": "59791902-6280-471b-bd18-f8439ba3042f",
  "parentId": "Client",
  "parentIndex": 0,
  "name": "Item",
  "description": "Text describing item",
  "values": [
    {
      "key": "<string>",
      "value": "<string>",
      "state": "<unknown>"
    }
  ],
  "events": [
    {
      "id": "<string>",
      "appointmentId": "<string>"
    }
  ],
  "isRemoved": false
}
'

import requests

url = "https://api.smokeball.com/matters/{matterId}/layouts/{itemId}"

payload = {
    "itemId": "59791902-6280-471b-bd18-f8439ba3042f",
    "layoutDesignId": "414ab774-adce-4659-b18c-82d1b0e826a0",
    "index": 0,
    "parentItemId": "59791902-6280-471b-bd18-f8439ba3042f",
    "parentId": "Client",
    "parentIndex": 0,
    "name": "Item",
    "description": "Text describing item",
    "values": [
        {
            "key": "<string>",
            "value": "<string>",
            "state": "<unknown>"
        }
    ],
    "events": [
        {
            "id": "<string>",
            "appointmentId": "<string>"
        }
    ],
    "isRemoved": False
}
headers = {
    "x-api-key": "<api-key>",
    "Authorization": "<api-key>",
    "Content-Type": "application/json-patch+json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {
    'x-api-key': '<api-key>',
    Authorization: '<api-key>',
    'Content-Type': 'application/json-patch+json'
  },
  body: JSON.stringify({
    itemId: '59791902-6280-471b-bd18-f8439ba3042f',
    layoutDesignId: '414ab774-adce-4659-b18c-82d1b0e826a0',
    index: 0,
    parentItemId: '59791902-6280-471b-bd18-f8439ba3042f',
    parentId: 'Client',
    parentIndex: 0,
    name: 'Item',
    description: 'Text describing item',
    values: [{key: '<string>', value: '<string>', state: '<unknown>'}],
    events: [{id: '<string>', appointmentId: '<string>'}],
    isRemoved: false
  })
};

fetch('https://api.smokeball.com/matters/{matterId}/layouts/{itemId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.smokeball.com/matters/{matterId}/layouts/{itemId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'itemId' => '59791902-6280-471b-bd18-f8439ba3042f',
    'layoutDesignId' => '414ab774-adce-4659-b18c-82d1b0e826a0',
    'index' => 0,
    'parentItemId' => '59791902-6280-471b-bd18-f8439ba3042f',
    'parentId' => 'Client',
    'parentIndex' => 0,
    'name' => 'Item',
    'description' => 'Text describing item',
    'values' => [
        [
                'key' => '<string>',
                'value' => '<string>',
                'state' => '<unknown>'
        ]
    ],
    'events' => [
        [
                'id' => '<string>',
                'appointmentId' => '<string>'
        ]
    ],
    'isRemoved' => false
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json-patch+json",
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.smokeball.com/matters/{matterId}/layouts/{itemId}"

	payload := strings.NewReader("{\n  \"itemId\": \"59791902-6280-471b-bd18-f8439ba3042f\",\n  \"layoutDesignId\": \"414ab774-adce-4659-b18c-82d1b0e826a0\",\n  \"index\": 0,\n  \"parentItemId\": \"59791902-6280-471b-bd18-f8439ba3042f\",\n  \"parentId\": \"Client\",\n  \"parentIndex\": 0,\n  \"name\": \"Item\",\n  \"description\": \"Text describing item\",\n  \"values\": [\n    {\n      \"key\": \"<string>\",\n      \"value\": \"<string>\",\n      \"state\": \"<unknown>\"\n    }\n  ],\n  \"events\": [\n    {\n      \"id\": \"<string>\",\n      \"appointmentId\": \"<string>\"\n    }\n  ],\n  \"isRemoved\": false\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("Authorization", "<api-key>")
	req.Header.Add("Content-Type", "application/json-patch+json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api.smokeball.com/matters/{matterId}/layouts/{itemId}")
  .header("x-api-key", "<api-key>")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json-patch+json")
  .body("{\n  \"itemId\": \"59791902-6280-471b-bd18-f8439ba3042f\",\n  \"layoutDesignId\": \"414ab774-adce-4659-b18c-82d1b0e826a0\",\n  \"index\": 0,\n  \"parentItemId\": \"59791902-6280-471b-bd18-f8439ba3042f\",\n  \"parentId\": \"Client\",\n  \"parentIndex\": 0,\n  \"name\": \"Item\",\n  \"description\": \"Text describing item\",\n  \"values\": [\n    {\n      \"key\": \"<string>\",\n      \"value\": \"<string>\",\n      \"state\": \"<unknown>\"\n    }\n  ],\n  \"events\": [\n    {\n      \"id\": \"<string>\",\n      \"appointmentId\": \"<string>\"\n    }\n  ],\n  \"isRemoved\": false\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.smokeball.com/matters/{matterId}/layouts/{itemId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["x-api-key"] = '<api-key>'
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json-patch+json'
request.body = "{\n  \"itemId\": \"59791902-6280-471b-bd18-f8439ba3042f\",\n  \"layoutDesignId\": \"414ab774-adce-4659-b18c-82d1b0e826a0\",\n  \"index\": 0,\n  \"parentItemId\": \"59791902-6280-471b-bd18-f8439ba3042f\",\n  \"parentId\": \"Client\",\n  \"parentIndex\": 0,\n  \"name\": \"Item\",\n  \"description\": \"Text describing item\",\n  \"values\": [\n    {\n      \"key\": \"<string>\",\n      \"value\": \"<string>\",\n      \"state\": \"<unknown>\"\n    }\n  ],\n  \"events\": [\n    {\n      \"id\": \"<string>\",\n      \"appointmentId\": \"<string>\"\n    }\n  ],\n  \"isRemoved\": false\n}"

response = http.request(request)
puts response.read_body

202

{
  "id": "<string>",
  "href": "<string>",
  "relation": "<string>",
  "method": "GET"
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>"
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>"
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>"
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>"
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>"
}

Authorizations

x-api-key · string · header · required

Authorization · string · header · required

Path Parameters

matterId · string<uuid> · required

Matter ID

itemId · string<uuid> · required

Matter item Id

Query Parameters

skipFieldValidation · boolean · default: false

Used to skip the field validation, may be needed for Smokeball data split migrations

Body

application/json-patch+jsonapplication/jsonapplication/*+json

Data to merge into the existing layout

itemId · string | null

Unique identifier for the matter list item.

Example:

"59791902-6280-471b-bd18-f8439ba3042f"

layoutDesignId · string | null

Identifier of the layout design.

Example:

"414ab774-adce-4659-b18c-82d1b0e826a0"

index · integer<int32>

Zero-based index of the layout item.

Example:

0

parentItemId · string | null

Unique identifier for the parent matter list item.

Example:

"59791902-6280-471b-bd18-f8439ba3042f"

parentId · string | null

Identifier of the parent matter list item specific to the provider.

Example:

"Client"

parentIndex · integer<int32>

Zero-based index of the parent matter list item.

Example:

0

name · string | null

Name of the layout item.

Example:

"Item"

description · string | null

Brief description of the layout item.

Example:

"Text describing item"

values · object[] | null

List of layout values.

Show child attributes

events · object[] | null

List of layout events.

Show child attributes

isRemoved · boolean

Boolean flag indicating if the layout item is to be removed.

Example:

false

Response

202

application/json

When the request is accepted. Returns a hypermedia 'Link' object of the layout item to be updated.

id · string | null

href · string | null

relation · string | null

method · string | null · default: GET