Overview
Configuration is provided for establishing connections with the Basecamp service. The configuration is used in the REST Connection Manager.
Setup
Press 
icon to get more information about the connection parameters.
Obtain data
Use REST Source component to get data from service resource.
Insert data
Use REST Destination component to insert data into service resource.
Demonstration
Configuration
Base URL address: https://3.basecampapi.com/[ACCOUNT_ID].
- Token
-
The authentication uses an authorized token. The token will be refreshed with the following expression:
{{=Date.now() + (response.expires_in - 300) * 1000}}.The following request parameters will be automatically processed during the authentication process:
-
Authorization:
Bearer {{=token.Access}}
Documentation: https://github.com/basecamp/api/blob/master/sections/authentication.md#oauth-2.
-
Authorization:
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/chats.json.Documentation: https://github.com/basecamp/bc3-api/blob/master/sections/campfires.md#get-campfires.
- id
A key field. Template: ShortText.
- status
Template: ShortText.
- created_at
Template: DateTime.
- updated_at
Template: DateTime.
- type
Template: ShortText.
- url
Template: ShortText.
- app_url
Template: ShortText.
- bucket
Template: BucketRef.
- creator
Template: Person.
- topic
Template: ShortText.
- lines_url
Template: ShortText.
- lines
The gathered value is processed with
{{=connection.resourceManager['Campfire Line'].getData({ parameters: ['projectId=' + item.bucket.id, 'campfireId=' + item.id] })}}expression. Field components:- An array.
-
Uses template:
CampfireLine.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/buckets/{{=parameters.projectId}}/chats/{{=parameters.campfireId}}/lines.json.The action has the following user-defined parameters:
- projectId: Required. Specify project identifier.
- campfireId: Required. Specify campfire identifier.
Documentation: https://github.com/basecamp/bc3-api/blob/master/sections/campfires.md#get-campfire-lines.
- [Create] action
-
Endpoint URL address:
/buckets/{{=item.projectId}}/chats/{{=item.campfireId}}/lines.json.Documentation: https://github.com/basecamp/bc3-api/blob/master/sections/campfires.md#create-a-campfire-line.
The resource includes the fields from the CampfireLine template.
- projectId
Template: ShortText.
- campfireId
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/buckets/{{=parameters.projectId}}/chats/{{=parameters.campfireId}}/integrations.json.The action has the following user-defined parameters:
- projectId: Required. Specify project identifier.
- campfireId: Required. Specify campfire identifier.
Documentation: https://github.com/basecamp/bc3-api/blob/master/sections/chatbots.md#get-chatbots.
- [Create] action
-
Endpoint URL address:
/buckets/{{=item.projectId}}/chats/{{=item.campfireId}}/integrations.json.Documentation: https://github.com/basecamp/bc3-api/blob/master/sections/chatbots.md#create-a-chatbot.
- [Update] action
-
Endpoint URL address:
/buckets/{{=item.projectId}}/chats/{{=item.campfireId}}/integrations/{{=item.id}}.json.Documentation: https://github.com/basecamp/bc3-api/blob/master/sections/chatbots.md#update-a-chatbot.
- [Delete] action
-
Endpoint URL address:
/buckets/{{=item.projectId}}/chats/{{=item.campfireId}}/integrations/{{=item.id}}.json.Documentation: https://github.com/basecamp/bc3-api/blob/master/sections/chatbots.md#destroy-a-chatbot.
- id
A key field. Template: ShortText.
- created_at
Template: DateTime. A read-only field.
- updated_at
Template: DateTime. A read-only field.
- service_name
Template: ShortText.
- command_url
Template: ShortText.
- url
Template: ShortText. A read-only field.
- app_url
Template: ShortText. A read-only field.
- lines_url
Template: ShortText. A read-only field.
- projectId
A key field. Template: ShortText.
- campfireId
A key field. Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/buckets/{{=parameters.projectId}}/client/approvals.json.The action has the following user-defined parameters:
- projectId: Required. Specify project identifier.
Documentation: https://github.com/basecamp/bc3-api/blob/master/sections/client_approvals.md#get-client-approvals.
- id
A key field. Template: ShortText.
- status
Template: ShortText.
- created_at
Template: DateTime.
- updated_at
Template: DateTime.
- type
Template: ShortText.
- url
Template: ShortText.
- app_url
Template: ShortText.
- parent
Template: ParentRef.
- bucket
Template: BucketRef.
- creator
Template: Person.
- content
Template: LongText.
- subject
Template: ShortText.
- due_on
Template: DateTime.
- replies_count
Data type: DT_I4
- replies_url
Template: ShortText.
- approval_status
Template: ShortText.
- approver
Template: Person.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/buckets/{{=parameters.projectId}}/client/correspondences.json.The action has the following user-defined parameters:
- projectId: Required. Specify project identifier.
Documentation: https://github.com/basecamp/bc3-api/blob/master/sections/client_correspondences.md#get-client-correspondences.
- id
A key field. Template: ShortText.
- status
Template: ShortText.
- created_at
Template: DateTime.
- updated_at
Template: DateTime.
- type
Template: ShortText.
- url
Template: ShortText.
- app_url
Template: ShortText.
- parent
Template: ParentRef.
- bucket
Template: BucketRef.
- creator
Template: Person.
- content
Template: LongText.
- subject
Template: ShortText.
- replies_count
Data type: DT_I4
- replies_url
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/buckets/{{=parameters.projectId}}/client/recordings/{{=parameters.recordingId}}/replies.json.The action has the following user-defined parameters:
- projectId: Required. Specify project identifier.
- recordingId: Required. Specify recording identifier.
Documentation: https://github.com/basecamp/bc3-api/blob/master/sections/client_replies.md#get-client-replies.
- id
A key field. Template: ShortText.
- status
Template: ShortText.
- created_at
Template: DateTime.
- updated_at
Template: DateTime.
- type
Template: ShortText.
- url
Template: ShortText.
- app_url
Template: ShortText.
- parent
Template: ParentRef.
- bucket
Template: BucketRef.
- creator
Template: Person.
- content
Template: LongText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/buckets/{{=parameters.projectId}}/recordings/{{=parameters.recordingId}}/comments.json.The action has the following user-defined parameters:
- projectId: Required. Specify project identifier.
- recordingId: Required. Specify recording identifier.
Documentation: https://github.com/basecamp/bc3-api/blob/master/sections/comments.md#get-comments.
- [Create] action
-
Endpoint URL address:
/buckets/{{=item.bucket}}/recordings/{{=item.recordingId}}/comments.json.Documentation: https://github.com/basecamp/bc3-api/blob/master/sections/comments.md#create-a-comment.
- [Update] action
-
Endpoint URL address:
/buckets/{{=item.bucket}}/comments/{{=item.id}}.json.Documentation: https://github.com/basecamp/bc3-api/blob/master/sections/comments.md#update-a-comment.
- [Delete] action
-
Endpoint URL address:
/buckets/{{=item.bucket}}/recordings/{{=item.id}}/status/trashed.json.Documentation: https://github.com/basecamp/bc3-api/blob/master/sections/recordings.md#trash-a-recording.
- id
A key field. Template: ShortText.
- status
Template: ShortText.
- created_at
Template: DateTime. A read-only field.
- updated_at
Template: DateTime. A read-only field.
- type
Template: ShortText. A read-only field.
- url
Template: ShortText. A read-only field.
- app_url
Template: ShortText. A read-only field.
- parent
Template: ParentRef. A read-only field.
- bucket
Template: BucketRef.
- creator
Template: Person. A read-only field.
- content
Template: LongText.
- recordingId
A key field. Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/buckets/{{=parameters.projectId}}/vaults/{{=parameters.vaultId}}/documents.json.The action has the following user-defined parameters:
- projectId: Required. Specify project identifier.
- vaultId: Required. Specify vault identifier.
Documentation: https://github.com/basecamp/bc3-api/blob/master/sections/documents.md#get-documents.
- [Create] action
-
Endpoint URL address:
/buckets/{{=item.bucket}}/vaults/{{=item.vaultId}}/documents.json.Documentation: https://github.com/basecamp/bc3-api/blob/master/sections/documents.md#create-a-document.
- [Update] action
-
Endpoint URL address:
/buckets/{{=item.bucket}}/documents/{{=item.id}}.json.Documentation: https://github.com/basecamp/bc3-api/blob/master/sections/documents.md#update-a-document.
- [Delete] action
-
Endpoint URL address:
/buckets/{{=item.bucket}}/recordings/{{=item.id}}/status/trashed.json.Documentation: https://github.com/basecamp/bc3-api/blob/master/sections/recordings.md#trash-a-recording.
- id
A key field. Template: ShortText.
- status
Template: ShortText.
- created_at
Template: DateTime. A read-only field.
- updated_at
Template: DateTime. A read-only field.
- type
Template: ShortText. A read-only field.
- url
Template: ShortText. A read-only field.
- app_url
Template: ShortText. A read-only field.
- comments_count
Data type: DT_I4 A read-only field.
- comments_url
Template: ShortText. A read-only field.
- parent
Template: ParentRef. A read-only field.
- bucket
Template: BucketRef.
- creator
Template: Person. A read-only field.
- title
Template: ShortText.
- content
Template: LongText.
- vaultId
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/buckets/{{=parameters.projectId}}/recordings/{{=parameters.recordingId}}/events.json.The action has the following user-defined parameters:
- projectId: Required. Specify project identifier.
- recordingId: Required. Specify recording identifier.
Documentation: https://github.com/basecamp/bc3-api/blob/master/sections/events.md#get-events.
- id
A key field. Template: ShortText.
- recording_id
Template: ShortText.
- action
Template: ShortText.
- details
Template: LongText. A composite field.
- created_at
Template: DateTime. A read-only field.
- creator
Template: Person. A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/buckets/{{=parameters.projectId}}/inboxes/{{=parameters.inboxId}}/forwards.json.The action has the following user-defined parameters:
- projectId: Required. Specify project identifier.
- inboxId: Required. Specify inbox identifier.
Documentation: https://github.com/basecamp/bc3-api/blob/master/sections/forwards.md#get-forwards.
- [Delete] action
-
Endpoint URL address:
/buckets/{{=item.bucket}}/recordings/{{=item.id}}/status/trashed.json.Documentation: https://github.com/basecamp/bc3-api/blob/master/sections/recordings.md#trash-a-recording.
- id
A key field. Template: ShortText.
- status
Template: ShortText.
- created_at
Template: DateTime. A read-only field.
- updated_at
Template: DateTime. A read-only field.
- type
Template: ShortText. A read-only field.
- url
Template: ShortText. A read-only field.
- app_url
Template: ShortText. A read-only field.
- parent
Template: ParentRef. A read-only field.
- bucket
Template: BucketRef.
- creator
Template: Person. A read-only field.
- content
Template: LongText.
- bookmark_url
Template: ShortText.
- subscription_url
Template: ShortText.
- subject
Template: ShortText.
- from
Template: ShortText.
- replies_count
Data type: DT_I4
- replies_url
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/buckets/{{=parameters.projectId}}/message_boards/{{=parameters.messageBoardId}}/messages.json.The action has the following user-defined parameters:
- projectId: Required. Specify project identifier.
- messageBoardId: Required. Specify message board identifier.
Documentation: https://github.com/basecamp/bc3-api/blob/master/sections/messages.md#get-messages.
- [Create] action
-
Endpoint URL address:
/buckets/{{=item.bucket}}/message_boards/{{=item.messageBoardId}}/messages.json.Documentation: https://github.com/basecamp/bc3-api/blob/master/sections/messages.md#create-a-message.
- [Update] action
-
Endpoint URL address:
/buckets/{{=item.bucket}}/messages/{{=item.id}}.json.Documentation: https://github.com/basecamp/bc3-api/blob/master/sections/messages.md#update-a-message.
- [Delete] action
-
Endpoint URL address:
/buckets/{{=item.bucket}}/recordings/{{=item.id}}/status/trashed.json.Documentation: https://github.com/basecamp/bc3-api/blob/master/sections/recordings.md#trash-a-recording.
- id
A key field. Template: ShortText.
- status
Template: ShortText.
- created_at
Template: DateTime. A read-only field.
- updated_at
Template: DateTime. A read-only field.
- type
Template: ShortText. A read-only field.
- url
Template: ShortText. A read-only field.
- app_url
Template: ShortText. A read-only field.
- comments_count
Data type: DT_I4 A read-only field.
- comments_url
Template: ShortText. A read-only field.
- parent
Template: ParentRef. A read-only field.
- bucket
Template: BucketRef.
- creator
Template: Person. A read-only field.
- content
Template: LongText.
- bookmark_url
Template: ShortText.
- subscription_url
Template: ShortText.
- subject
Template: ShortText.
- messageBoardId
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/buckets/{{=parameters.projectId}}/categories.json.The action has the following user-defined parameters:
- projectId: Required. Specify project identifier.
Documentation: https://github.com/basecamp/bc3-api/blob/master/sections/message_types.md#get-message-types.
- [Create] action
-
Endpoint URL address:
/buckets/{{=item.bucket}}/categories.json.Documentation: https://github.com/basecamp/bc3-api/blob/master/sections/message_types.md#create-a-message-type.
- [Update] action
-
Endpoint URL address:
/buckets/{{=item.bucket}}/categories/{{=item.id}}.json.Documentation: https://github.com/basecamp/bc3-api/blob/master/sections/message_types.md#update-a-message-type.
- [Delete] action
-
Endpoint URL address:
/buckets/{{=item.bucket}}/categories/{{=item.id}}.json.Documentation: https://github.com/basecamp/bc3-api/blob/master/sections/message_types.md#destroy-a-message-type.
- id
A key field. Template: ShortText.
- name
Template: ShortText.
- icon
Template: ShortText.
- created_at
Template: DateTime. A read-only field.
- updated_at
Template: DateTime. A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/people.json.Documentation: https://github.com/basecamp/bc3-api/blob/master/sections/people.md#get-all-people.
- [Read projectId] action
-
Endpoint URL address:
/projects/{{=parameters.projectId}}/people.json.The action has the following user-defined parameters:
- projectId: Required. Specify project identifier.
- [Read pingable] action
-
Endpoint URL address:
/circles/people.json.Documentation: https://github.com/basecamp/bc3-api/blob/master/sections/people.md#get-pingable-people.
The resource includes the fields from the Person template.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/projects.json.Documentation: https://github.com/basecamp/bc3-api/blob/master/sections/projects.md#get-projects.
- [Create] action
-
Endpoint URL address:
/projects.json.Documentation: https://github.com/basecamp/bc3-api/blob/master/sections/projects.md#create-a-project.
- [Update] action
-
Endpoint URL address:
/projects/{{=item.id}}.json.Documentation: https://github.com/basecamp/bc3-api/blob/master/sections/projects.md#update-a-project.
- [Delete] action
-
Endpoint URL address:
/projects/{{=item.id}}.json.Documentation: https://github.com/basecamp/bc3-api/blob/master/sections/projects.md#trash-a-project.
- id
A key field. Template: ShortText.
- status
Template: ShortText. A read-only field.
- created_at
Template: DateTime. A read-only field.
- updated_at
Template: DateTime. A read-only field.
- name
Template: ShortText.
- description
Template: LongText.
- bookmark_url
Template: ShortText. A read-only field.
- url
Template: ShortText. A read-only field.
- app_url
Template: ShortText. A read-only field.
- dock
A read-only field. Field components:
- An array.
- Contains the following components: id, title, name, enabled, position, url, app_url.
- bookmarked
Data type: DT_BOOL A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/buckets/{{=parameters.projectId}}/questions/{{=parameters.questionId}}/answers.json.The action has the following user-defined parameters:
- projectId: Required. Specify project identifier.
- questionId: Required. Specify question identifier.
Documentation: https://github.com/basecamp/bc3-api/blob/master/sections/question_answers.md#get-question-answers.
- id
A key field. Template: ShortText.
- status
Template: ShortText.
- created_at
Template: DateTime. A read-only field.
- updated_at
Template: DateTime. A read-only field.
- type
Template: ShortText. A read-only field.
- url
Template: ShortText. A read-only field.
- app_url
Template: ShortText. A read-only field.
- comments_count
Data type: DT_I4 A read-only field.
- comments_url
Template: ShortText. A read-only field.
- parent
Template: ParentRef. A read-only field.
- bucket
Template: BucketRef.
- creator
Template: Person. A read-only field.
- title
Template: ShortText.
- content
Template: LongText.
- group_on
Data type: DT_DBDATE
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/buckets/{{=parameters.projectId}}/questionnaires/{{=parameters.questionnaireId}}/questions.json.The action has the following user-defined parameters:
- projectId: Required. Specify project identifier.
- questionnaireId: Required. Specify questionnaire identifier.
Documentation: https://github.com/basecamp/bc3-api/blob/master/sections/questions.md#get-questions.
- id
A key field. Template: ShortText.
- status
Template: ShortText.
- created_at
Template: DateTime. A read-only field.
- updated_at
Template: DateTime. A read-only field.
- type
Template: ShortText. A read-only field.
- url
Template: ShortText. A read-only field.
- app_url
Template: ShortText. A read-only field.
- comments_count
Data type: DT_I4 A read-only field.
- comments_url
Template: ShortText. A read-only field.
- parent
Template: ParentRef. A read-only field.
- bucket
Template: BucketRef.
- creator
Template: Person. A read-only field.
- paused
Data type: DT_BOOL
- title
Template: ShortText.
- schedule
Field components:
-
Uses template:
ShortText. - Contains the following components: frequency, days, hour, minute, start_date.
-
Uses template:
- answers_count
Data type: DT_I4
- answers_url
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/buckets/{{=parameters.projectId}}/schedules/{{=parameters.scheduleId}}/entries.json.The action has the following user-defined parameters:
- projectId: Required. Specify project identifier.
- scheduleId: Required. Specify schedule identifier.
Documentation: https://github.com/basecamp/bc3-api/blob/master/sections/schedule_entries.md#get-schedule-entries.
- [Create] action
-
Endpoint URL address:
/buckets/{{=item.bucket}}/schedules/{{=item.id}}/entries.json.Documentation: https://github.com/basecamp/bc3-api/blob/master/sections/schedule_entries.md#create-a-schedule-entry.
- [Update] action
-
Endpoint URL address:
/buckets/{{=item.bucket}}/schedule_entries/{{=item.id}}.json.Documentation: https://github.com/basecamp/bc3-api/blob/master/sections/schedule_entries.md#update-a-schedule-entry.
- [Delete] action
-
Endpoint URL address:
/buckets/{{=item.bucket}}/recordings/{{=item.id}}/status/trashed.json.Documentation: https://github.com/basecamp/bc3-api/blob/master/sections/recordings.md#trash-a-recording.
- id
A key field. Template: ShortText.
- status
Template: ShortText.
- created_at
Template: DateTime. A read-only field.
- updated_at
Template: DateTime. A read-only field.
- type
Template: ShortText. A read-only field.
- url
Template: ShortText. A read-only field.
- app_url
Template: ShortText. A read-only field.
- comments_count
Data type: DT_I4 A read-only field.
- comments_url
Template: ShortText. A read-only field.
- parent
Template: ParentRef. A read-only field.
- bucket
Template: BucketRef.
- creator
Template: Person. A read-only field.
- description
Template: LongText.
- bookmark_url
Template: ShortText. A read-only field.
- subscription_url
Template: ShortText. A read-only field.
- summary
Template: ShortText.
- all_day
Data type: DT_BOOL
- starts_at
Template: DateTime.
- ends_at
Template: DateTime.
- participants
Field components:
- An array.
-
Uses template:
Person.
- participant_ids
Template: LongText. A composite field.
- notify
Data type: DT_BOOL
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/templates.json.Documentation: https://github.com/basecamp/bc3-api/blob/master/sections/templates.md#get-templates.
- [Create] action
-
Endpoint URL address:
/templates.json.Documentation: https://github.com/basecamp/bc3-api/blob/master/sections/templates.md#create-a-template.
- [Update] action
-
Endpoint URL address:
/templates/{{=item.id}}.json.Documentation: https://github.com/basecamp/bc3-api/blob/master/sections/templates.md#update-a-template.
- [Delete] action
-
Endpoint URL address:
/templates/{{=item.id}}.json.Documentation: https://github.com/basecamp/bc3-api/blob/master/sections/templates.md#trash-a-template.
- id
A key field. Template: ShortText.
- status
Template: ShortText.
- created_at
Template: DateTime. A read-only field.
- updated_at
Template: DateTime. A read-only field.
- name
Template: ShortText.
- description
Template: ShortText.
- url
Template: ShortText. A read-only field.
- app_url
Template: ShortText. A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/buckets/{{=parameters.projectId}}/todosets/{{=parameters.todoSetId}}/todolists.json.The action has the following user-defined parameters:
- projectId: Required. Specify project identifier.
- todoSetId: Required. Specify to-do set identifier.
Documentation: https://github.com/basecamp/bc3-api/blob/master/sections/todolists.md#get-to-do-lists.
- [Create] action
-
Endpoint URL address:
/buckets/{{=item.bucket}}/todosets/{{=item.todoSetId}}/todolists.json.Documentation: https://github.com/basecamp/bc3-api/blob/master/sections/todolists.md#create-a-to-do-list.
- [Update] action
-
Endpoint URL address:
/buckets/{{=item.bucket}}/todolists/{{=item.id}}.json.Documentation: https://github.com/basecamp/bc3-api/blob/master/sections/todolists.md#update-a-to-do-list.
- [Delete] action
-
Endpoint URL address:
/buckets/{{=item.bucket}}/recordings/{{=item.id}}/status/trashed.json.Documentation: https://github.com/basecamp/bc3-api/blob/master/sections/recordings.md#trash-a-recording.
- id
A key field. Template: ShortText.
- status
Template: ShortText.
- created_at
Template: DateTime. A read-only field.
- updated_at
Template: DateTime. A read-only field.
- type
Template: ShortText. A read-only field.
- url
Template: ShortText. A read-only field.
- app_url
Template: ShortText. A read-only field.
- comments_count
Data type: DT_I4 A read-only field.
- comments_url
Template: ShortText. A read-only field.
- parent
Template: ParentRef. A read-only field.
- bucket
Template: BucketRef.
- creator
Template: Person. A read-only field.
- description
Template: LongText.
- bookmark_url
Template: ShortText. A read-only field.
- subscription_url
Template: ShortText. A read-only field.
- completed
Data type: DT_BOOL A read-only field.
- completed_ratio
Template: ShortText. A read-only field.
- name
Template: ShortText.
- todos_url
Template: ShortText. A read-only field.
- app_todos_url
Template: ShortText. A read-only field.
- todoSetId
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/buckets/{{=parameters.projectId}}/todolists/{{=parameters.todoListId}}/todos.json.The action has the following user-defined parameters:
- projectId: Required. Specify project identifier.
- todoListId: Required. Specify to-do list identifier.
Documentation: https://github.com/basecamp/bc3-api/blob/master/sections/todos.md#get-to-dos.
- [Create] action
-
Endpoint URL address:
/buckets/{{=item.bucket}}/todolists/{{=item.todoListId}}/todos.json.Documentation: https://github.com/basecamp/bc3-api/blob/master/sections/todos.md#create-a-to-do.
- [Update] action
-
Endpoint URL address:
/buckets/{{=item.bucket}}/todos/{{=item.id}}.json.Documentation: https://github.com/basecamp/bc3-api/blob/master/sections/todos.md#update-a-to-do.
- [Delete] action
-
Endpoint URL address:
/buckets/{{=item.bucket}}/recordings/{{=item.id}}/status/trashed.json.Documentation: https://github.com/basecamp/bc3-api/blob/master/sections/recordings.md#trash-a-recording.
- id
A key field. Template: ShortText.
- status
Template: ShortText.
- created_at
Template: DateTime. A read-only field.
- updated_at
Template: DateTime. A read-only field.
- type
Template: ShortText. A read-only field.
- url
Template: ShortText. A read-only field.
- app_url
Template: ShortText. A read-only field.
- comments_count
Data type: DT_I4 A read-only field.
- comments_url
Template: ShortText. A read-only field.
- parent
Template: ParentRef. A read-only field.
- bucket
Template: BucketRef.
- creator
Template: Person. A read-only field.
- description
Template: LongText.
- bookmark_url
Template: ShortText. A read-only field.
- subscription_url
Template: ShortText. A read-only field.
- completed
Data type: DT_BOOL
- content
Template: LongText.
- starts_on
Template: DateTime.
- due_on
Data type: DT_DBDATE
- assignees
Template: LongText. A composite field.
- completion_url
Template: ShortText. A read-only field.
- todoListId
Template: ShortText.
- assignee_ids
Template: LongText. A composite field.
- notify
Data type: DT_BOOL
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/buckets/{{=parameters.projectId}}/vaults/{{=parameters.vaultId}}/uploads.json.The action has the following user-defined parameters:
- projectId: Required. Specify project identifier.
- vaultId: Required. Specify vault identifier.
Documentation: https://github.com/basecamp/bc3-api/blob/master/sections/uploads.md#get-uploads.
- [Create] action
-
Endpoint URL address:
/buckets/{{=item.bucket}}/vaults/{{=item.vaultId}}/uploads.json.Documentation: https://github.com/basecamp/bc3-api/blob/master/sections/uploads.md#create-an-upload.
- [Update] action
-
Endpoint URL address:
/buckets/{{=item.bucket}}/uploads/{{=item.id}}.json.Documentation: https://github.com/basecamp/bc3-api/blob/master/sections/uploads.md#update-an-upload.
- [Delete] action
-
Endpoint URL address:
/buckets/{{=item.bucket}}/recordings/{{=item.id}}/status/trashed.json.Documentation: https://github.com/basecamp/bc3-api/blob/master/sections/recordings.md#trash-a-recording.
- id
A key field. Template: ShortText.
- status
Template: ShortText.
- created_at
Template: DateTime. A read-only field.
- updated_at
Template: DateTime. A read-only field.
- type
Template: ShortText. A read-only field.
- url
Template: ShortText. A read-only field.
- app_url
Template: ShortText. A read-only field.
- comments_count
Data type: DT_I4 A read-only field.
- comments_url
Template: ShortText. A read-only field.
- parent
Template: ParentRef. A read-only field.
- bucket
Template: BucketRef.
- creator
Template: Person. A read-only field.
- description
Template: LongText.
- filename
Template: ShortText.
- content_type
Template: ShortText.
- byte_size
Data type: DT_I4 A read-only field.
- width
Data type: DT_I4 A read-only field.
- height
Data type: DT_I4 A read-only field.
- download_url
Template: ShortText. A read-only field.
- app_download_url
Template: ShortText. A read-only field.
- vaultId
Template: ShortText.
- attachable_sgid
Template: ShortText.
- base_name
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/buckets/{{=parameters.projectId}}/vaults/{{=parameters.parentVaultId}}/vaults.json.The action has the following user-defined parameters:
- projectId: Required. Specify project identifier.
- parentVaultId: Required. Specify parent vault identifier.
Documentation: https://github.com/basecamp/bc3-api/blob/master/sections/vaults.md#get-vaults.
- [Create] action
-
Endpoint URL address:
/buckets/{{=item.bucket}}/vaults/{{=item.parentVaultId}}/vaults.json.Documentation: https://github.com/basecamp/bc3-api/blob/master/sections/vaults.md#create-a-vault.
- [Update] action
-
Endpoint URL address:
/buckets/{{=item.bucket}}/vaults/{{=item.id}}.json.Documentation: https://github.com/basecamp/bc3-api/blob/master/sections/vaults.md#update-a-vault.
- id
A key field. Template: ShortText.
- status
Template: ShortText.
- created_at
Template: DateTime. A read-only field.
- updated_at
Template: DateTime. A read-only field.
- type
Template: ShortText. A read-only field.
- url
Template: ShortText. A read-only field.
- app_url
Template: ShortText. A read-only field.
- parent
Template: ParentRef. A read-only field.
- bucket
Template: BucketRef.
- creator
Template: Person. A read-only field.
- title
Template: ShortText.
- documents_count
Data type: DT_I4 A read-only field.
- documents_url
Template: ShortText. A read-only field.
- uploads_count
Data type: DT_I4 A read-only field.
- uploads_url
Template: ShortText. A read-only field.
- vaults_count
Data type: DT_I4 A read-only field.
- vaults_url
Template: ShortText. A read-only field.
- parentVaultId
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/buckets/{{=parameters.projectId}}/webhooks.json.The action has the following user-defined parameters:
- projectId: Required. Specify project identifier.
Documentation: https://github.com/basecamp/bc3-api/blob/master/sections/webhooks.md#get-webhooks.
- [Create] action
-
Endpoint URL address:
/buckets/{{=item.bucket}}/webhooks.json.Documentation: https://github.com/basecamp/bc3-api/blob/master/sections/webhooks.md#create-a-webhook.
- [Update] action
-
Endpoint URL address:
/buckets/{{=item.bucket}}/webhooks/{{=item.id}}.json.Documentation: https://github.com/basecamp/bc3-api/blob/master/sections/webhooks.md#update-a-webhook.
- [Delete] action
-
Endpoint URL address:
/buckets/{{=item.bucket}}/webhooks/{{=item.id}}.json.Documentation: https://github.com/basecamp/bc3-api/blob/master/sections/webhooks.md#destroy-a-webhook.
- id
A key field. Template: ShortText.
- active
Data type: DT_BOOL
- created_at
Template: DateTime. A read-only field.
- updated_at
Template: DateTime. A read-only field.
- payload_url
Template: ShortText.
- types
Template: LongText. A composite field.
- type
Template: ShortText. A read-only field.
- url
Template: ShortText. A read-only field.
- app_url
Template: ShortText. A read-only field.
- [Read] action
-
The result is extracted from:{{=response.data}}.
The result is paginated.The following request parameters will be automatically processed:
-
page:
{{=parameters.iterator}} -
_includeUserParameters:
{{=parameters}}
-
page:
- [Create] action
-
The action uses POST method.The following request parameters will be automatically processed:
-
application/json:
{{=item}}
-
application/json:
- [Update] action
-
The action uses PUT method.The following request parameters will be automatically processed:
-
application/json:
{{=item}}
-
application/json:
- [Delete] action
-
The action uses DELETE method.
- ShortText
Data type: DT_WSTR ( length 255 )
- LongText
Data type: DT_WSTR ( length 1000 )
- DateTime
Data type: DT_DBTIMESTAMP
- Person
Field components:
-
Uses template:
ShortText. - Contains the following components: id, name, attachable_sgid, email_address, personable_type, title, created_at, updated_at, admin, owner, avatar_url, company.
-
Uses template:
- BucketRef
Field components:
-
Uses template:
ShortText. - Contains the following components: id, name, type.
-
Uses template:
- ParentRef
A read-only field. Field components:
-
Uses template:
ShortText. - Contains the following components: id, title, type, url, app_url.
-
Uses template:
- CampfireLine
Field components:
-
Uses template:
ShortText. - Contains the following components: id, status, created_at, updated_at, type, url, app_url, parent, bucket, creator, content.
-
Uses template:
What's New
- New: Introduced connection.
Related documentation
COZYROC SSIS+ Components Suite is free for testing in your development environment.
A licensed version can be deployed on-premises, on Azure-SSIS IR and on COZYROC Cloud.