Create a research item

post deprecated

https://{client}-api.bipsync.com/v1/research

This endpoint is deprecated: use /v2/research/note or /v2/research/file instead.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

title

string

A brief summary. Will default to the name of the first uploaded attachment, should one exist.

content

string

Rich content of the research, in HTML format.

user

string

The ID of the user which authored the item. This parameter is not accepted when an OAuth access token issued using the Authorization Code Grant is used.

fields

object

A dictionary of field values, keyed by field apiIdentifier. The format of each field value will depend on the field type.

sharedFields

array

A dictionary of field values, keyed on field ID. The format of each field value will depend on the field type.

sharedFields

categories

collaborate

boolean

Set to false to lock the item, true to enable editing by users with whom it has been shared.

frozen

boolean

Set to true to prevent any further changes to the item.

migrationAttributes

array

A dictionary of attributes intended for the storage of legacy system data.

migrationAttributes

sharedUsers

array

An array of user IDs. The item will be shared with those users.

sharedUsers

sharedGroups

array

An array of user group IDs. The item will be shared with those groups.

sharedGroups

consumerId

string

externalIds

array of objects

externalIds

labels

array

An array of label IDs. The research item will be tagged with these labels. Alias of the 'categories' parameter.

labels

labelPath

string

A hierarchical path to a label in the form of Branch/Sub-branch/Leaf. The item is tagged to the leaf label. Labels are matched strictly by name or else ignored.

labelPaths

array

A list of hierarchical paths to labels in the form of Branch/Sub-branch/Leaf. The item is tagged to each leaf label. Labels are matched strictly by name or else ignored.

labelPaths

unmatchedTags

array

A list of tags included in an emailed in note subject line that were not matched to an entity in Bipsync.

unmatchedTags

Response

200

Create result

Language

Credentials

OAuth2

URL

Loading…