SMsmokeball
Layout Matter Items

Merge a layout

Merges layout data.

patch/matters/{matterId}/layouts/{itemId}

Request

  • Base URL
    https://api.smokeball.com
  • URL
    https://api.smokeball.com/matters/{matterId}/layouts/{itemId}
  • Auth
    API key in header x-api-key and API key in header Authorization

Path parameters

matterIdstring uuid required

Matter ID

itemIdstring uuid required

Matter item Id

Query parameters

skipFieldValidationboolean

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

Request body

itemIdstring nullable

Unique identifier for the matter list item.

layoutDesignIdstring nullable

Identifier of the layout design.

indexinteger

Zero-based index of the layout item.

parentItemIdstring nullable

Unique identifier for the parent matter list item.

parentIdstring nullable

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

parentIndexinteger

Zero-based index of the parent matter list item.

namestring nullable

Name of the layout item.

descriptionstring nullable

Brief description of the layout item.

isRemovedboolean

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

Example request

{
  "itemId": "59791902-6280-471b-bd18-f8439ba3042f",
  "layoutDesignId": "414ab774-adce-4659-b18c-82d1b0e826a0",
  "parentItemId": "59791902-6280-471b-bd18-f8439ba3042f",
  "parentId": "Client",
  "name": "Item",
  "description": "Text describing item"
}

Response

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

idstring nullable
hrefstring nullable
relationstring nullable
methodstring nullable

Changes

No recorded changes to this operation across all 15 revisions of this API.