MCP 207 tools

Browse the tools
Available tools

Possession types

A possession type is a kind of thing you own, such as books or cars. It says which details a thing of that kind carries.

Choose a tool to see the parameters it accepts.

Tools

List the possession types of the account, the kinds of things it owns such as office equipment or a vehicle, sorted by name, one page at a time. Each carries its colour, its icon, its groups and its fields in order.

page integer optional
The page to read, starting at 1.
per_page integer optional
How many possession types a page holds: 25 unless asked, 100 at most.

Read one possession type: its name, its colour, its icon, its groups and its fields in order, each field with its kind and, for a choice field, its choices.

possession_type string required
The id of the possession type, as list-possession-types gives it.

Write a possession type out as a file: its name, its colour, its icon, its groups and its fields, in order. The file can be imported again with import-possession-type.

possession_type string required
The id of the possession type, as list-possession-types gives it.

Add a possession type to the account: a kind of thing it owns, such as office equipment or a vehicle. Add its fields afterwards with create-possession-field. The change is written to the account log.

name string required
What the kind of thing is called.
colour string optional
One of the vault colours, as a hexadecimal value. Blue when left out. One of: #3f5fd0, #4f8a49, #9a6a24, #9a3f2b, #6b4fa8, #2f7f86, #a8447a, #4a4a52
icon string optional
One of the glyphs of the catalogue. None when left out. One of: profile, people, note, relationship, family, timeline, calendar, reminder, tasks, memory, journal, file, mail, phone, place, home, briefcase, organization, graduation, health, activity, ball, food, gift, pet, plane, globe, book, music, coin, car, target, tag, heart, star, lock, layers

Rename a possession type, give it another vault colour, or set, change or remove its icon. The change is written to the account log.

possession_type string required
The id of the possession type, as list-possession-types gives it.
name string optional
The new name.
colour string optional
One of the vault colours, as a hexadecimal value. One of: #3f5fd0, #4f8a49, #9a6a24, #9a3f2b, #6b4fa8, #2f7f86, #a8447a, #4a4a52
icon string optional
One of the glyphs of the catalogue. One of: profile, people, note, relationship, family, timeline, calendar, reminder, tasks, memory, journal, file, mail, phone, place, home, briefcase, organization, graduation, health, activity, ball, food, gift, pet, plane, globe, book, music, coin, car, target, tag, heart, star, lock, layers

Delete a possession type with its groups, its fields, and every possession of that type with the details it held. This cannot be undone. The change is written to the account log.

possession_type string required
The id of the possession type, as list-possession-types gives it.

Create a new possession type from a file written by export-possession-type. Nothing already in the account changes. A file with any problem creates nothing, and every problem is listed. The change is written to the account log.

file string required
The whole file, as JSON text.

Add a named group of fields to a possession type, such as Purchase or Technical details, placed after the other groups. The change is written to the account log.

possession_type string required
The id of the possession type, as list-possession-types gives it.
name string required
What the group is called.

Rename a group of fields of a possession type. The change is written to the account log.

possession_type string required
The id of the possession type, as list-possession-types gives it.
group string required
The id of the group, as get-possession-type gives it.
name string optional
The new name.

Remove a group from a possession type. Its fields are kept and become standalone fields of the type, after the ones already there. The change is written to the account log.

possession_type string required
The id of the possession type, as list-possession-types gives it.
group string required
The id of the group, as get-possession-type gives it.

Move a group of fields to another place among the groups of its possession type. The change is written to the account log.

possession_type string required
The id of the possession type, as list-possession-types gives it.
group string required
The id of the group, as get-possession-type gives it.
position integer required
Where it goes among the groups, counting from 1.

Add a field to a possession type, in one of its groups or standing alone, placed last. A choice field takes its choices in order. The change is written to the account log.

possession_type string required
The id of the possession type, as list-possession-types gives it.
group_id string optional
The id of the group the field goes in, as get-possession-type gives it. Left out, the field stands alone.
name string required
What the field is called, such as Serial number.
kind string required
What the field holds. One of: text, number, date, boolean, select, rating
options array optional
The choices of a choice field, in order. Ignored for every other kind.

Rename a field of a possession type, change its kind, or set its choices. A field that stops being a choice field loses its choices. A choice you remove is also removed from every possession that held it, and cannot be recovered. The change is written to the account log.

possession_type string required
The id of the possession type, as list-possession-types gives it.
field string required
The id of the field, as get-possession-type gives it.
name string optional
The new name.
kind string optional
What the field holds. One of: text, number, date, boolean, select, rating
options array optional
The choices of a choice field, in order, replacing the ones it has.

Remove a field from a possession type. This cannot be undone. The change is written to the account log.

possession_type string required
The id of the possession type, as list-possession-types gives it.
field string required
The id of the field, as get-possession-type gives it.

Move a field to another place among the fields of its group, or among the standalone fields of its possession type. The change is written to the account log.

possession_type string required
The id of the possession type, as list-possession-types gives it.
field string required
The id of the field, as get-possession-type gives it.
position integer required
Where it goes among the fields beside it, counting from 1.