Explore
TicTAP Integration API
1.0.0
OAS 3.0
TicTAP Integration API.
Detailed examples can be found in the
REST API help
. page
Authorize
Entities
GET
/api
/integration
/entities
/by-id
/{id}
Get entity detail by id
POST
/api
/integration
/entities
/by-id
/{id}
/reminders
Create a reminder in an entity identified by id
POST
/api
/integration
/entities
/{id}
/state-transition
Apply a state transition to an entity that belongs to the team
POST
/api
/integration
/entities
/{id}
/state
Force state in an entity that belongs to the team. This will override any state transition rules.
GET
/api
/integration
/entities
/{slug}
/{idOrExternalReference}
PUT
/api
/integration
/entities
/{slug}
/{idOrExternalReference}
Update dynamic entity in the definition collection
DELETE
/api
/integration
/entities
/{slug}
/{idOrExternalReference}
Remove an entity that belongs to the team
GET
/api
/integration
/definitions
/{slug}
/entities
/{idOrExternalReference}
PUT
/api
/integration
/definitions
/{slug}
/entities
/{idOrExternalReference}
Update dynamic entity in the definition collection
DELETE
/api
/integration
/definitions
/{slug}
/entities
/{idOrExternalReference}
Remove an entity that belongs to the team
GET
/api
/integration
/entities
/{slug}
Get all the entities available in a definition. Or query for entities in a definition, optionally including children.
POST
/api
/integration
/entities
/{slug}
Create a new entity of given definition
GET
/api
/integration
/definitions
/{slug}
/entities
Get all the entities available in a definition. Or query for entities in a definition, optionally including children.
POST
/api
/integration
/definitions
/{slug}
/entities
Create a new entity of given definition
PUT
/api
/integration
/entities
/{id}
Update dynamic entity by id
PUT
/api
/integration
/definitions
/{slug}
/entities
/{idOrExternalReference}
/files
File an entity or schedule it to be filed at given date
POST
/api
/integration
/definitions
/{slug}
/entities
/{idOrExternalReference}
/reminders
Create a reminder in an entity
Definitions
GET
/api
/integration
/definitions
/{slug}
Get a definition by slug
GET
/api
/integration
/definitions
Get all the definitions available in a team.
Front Users
POST
/api
/integration
/frontusers
Creates a new Front User for the integration Team
Tags
POST
/api
/integration
/tags
/{sku}
/data
/{formId}
Adds data to a tag via a form submission
POST
/api
/integration
/tags
/{code}
/media
Upload one or more media files that will be used in a form submission to a tag.
GET
/api
/integration
/tags
/{sku}
Get tag detail information by SKU
PUT
/api
/integration
/tags
/{sku}
Edit tag by sku
DELETE
/api
/integration
/tags
/{sku}
Delete tag by sku
GET
/api
/integration
/tags
Get paginated tag list
POST
/api
/integration
/tags
Create a new tag in a collection
Schemas
EntityPlanningRead
DescendantsAgendaSummary
ButtonBlock
BodyBlock
AddressInputBlock
EntityInputBlock
FileInputBlock
FormEvent
EntityEvent
InvalidArgumentError
EntityNotFoundError
Field
DefinitionList
DefinitionDetail
EntityChild
EntityList
EntityDetail
NamedEvent
BlockWrite
TagDetail
PagedResults
ReminderCreate
Reminder
EntityCreateUpdate
FrontUserCreate
FrontUser
TagData
TagUpdate
TagCreate
BaseTag
NFCTag
QRTag
EntityPlanningStatusEnum
Uuid
VisibilityRule
LinkProperty
Media
AbstractMediaSource
DataSource
DateRange
UpdateRule
MetaRule
LabelRule
StateRule
UserRule
EntityDefinitionRule
DynamicEntityDataSource
TagSearchDataSource
EntityChildrenDataSource
BaseField
UpdateRuleTargetEnum
UpdateRuleTypeEnum
UpdateOperationEnum
MetaRuleCondition
Label
UserRuleConfiguration
Definition
TagSearch
DateField
TextField
NumericField
EmailField
ChoiceField
MediaField
MediaCollectionField
DynamicEntityField
ManifestIconMediaField
VirtualField
AddressField
InverseRelationField
