Organisations

Read one of an organisation's patterns

The pattern with its source for each flavour, its slots and its notes.

GET/orgs/{org}/patterns/{name}

TL;DR

Question	Answer
What does it do?	Read one of an organisation's patterns.
What does it take?	`org`, `name` in the path.
What does it return?	Status 200 with a body of type `OrganisationPattern`.
What can go wrong?	`401` not signed in, or the key is not valid; `404` no such organisation or pattern, or the caller is not a member of it; `429` too many requests; `503` organisations are not set up on this server. Every failure uses the one error envelope.

The pattern with its source for each flavour, its slots and its notes. Every member and a key of the organisation.

Field	Type	Required	Description
`org`	`string`	yes	The organisation's id or slug.
`name`	`string`	yes	The name after `org:`.

Status	Meaning	Body
200	The pattern.	`OrganisationPattern`
401	Not signed in, or the key is not valid.	`ErrorResponse`
404	No such organisation or pattern, or the caller is not a member of it.	`ErrorResponse`
429	Too many requests.	`ErrorResponse`
503	Organisations are not set up on this server.	`ErrorResponse`

A 200 answer has the type OrganisationPattern.

Field	Type	Required	Description
`id`	`string`	yes	What the tools take: `org:<name>`.
`name`	`string`	yes	The name after `org:`.
`title`	`string`	yes
`summary`	`string`	yes
`whenToUse`	`string`	yes
`kind`	`string`	yes	The kind of diagram, such as `flow`.
`tags`	`string[]`	yes
`flavours`	`("neutral" \| "aws" \| "azure" \| "gcp")[]`	yes
`slotCount`	`integer`	yes	minimum 0.
`createdAt`	`integer`	yes
`updatedAt`	`integer`	yes
`updatedBy`	`string \| null`	yes	The account that last saved it, or null once that account is gone.
`templates`	`object`	yes	The Plotwork source of each flavour (neutral, aws, azure, gcp), at least one, with `{{slot}}` markers inside quoted labels.
`templates.neutral`	`string`	no	at most 10000 characters.
`templates.aws`	`string`	no	at most 10000 characters.
`templates.azure`	`string`	no	at most 10000 characters.
`templates.gcp`	`string`	no	at most 10000 characters.
`slots`	`object[]`	yes
`slots[].id`	`string`	yes	Lowercase words joined with hyphens; written `{{id}}` inside a quoted label of the source. at least 1 character; at most 40 characters.
`slots[].default`	`string`	yes	The text the slot has when nothing replaces it. No quotes or line breaks. at most 60 characters.
`slots[].meaning`	`string`	yes	One line on what belongs in the slot, so an agent fills it with the right thing. at most 200 characters.
`notes`	`object`	yes
`notes.keep`	`string`	yes	What to leave exactly as it is.
`notes.rename`	`string`	yes	What to rename or replace, and how.
`notes.split`	`string`	yes	When the diagram has grown too big, and where to cut it.

Doc	Why
API reference	Every endpoint, and the error envelope
Schemas	Every request and response type
Tool reference	The operations as callable tools