Overview
Configuration is provided for establishing connections with Kintone REST service. The configuration is used in the REST Connection Manager.
Quick Start
In this task, we will show you step-by-step how to create a connection to Kintone REST API using COZYROC's REST Connection Manager.
Step 1. Run "Visual Studio" under "Administrator account". Right click on Connection managers Tab and Select New Connection. In Add SSIS Connection Manager scroll down and select Connection managers for REST Connection and click Add.
Step 2. From drop-down menu Configuration select Kintone. Set [Host] to the desired host in the Server host parameter.
Step 3. Provide value for the parameter loginName and parameter password in the grid below.
Step 4. Click "Test Connection" to test your connection.
Congratulations! You have now established a connection to your Kintone instance.
In this guide, we will show how to read data from the Kintone service resource using the COZYROC REST Source component.
Step 1. Select an existing "Data Flow task" or create a new "Data Flow Task".
Step 2. Open "SSIS Toolbox" and drag and drop COZYROC "REST Source" component.
Step 3. Double click on the "REST Source" component and select Kintone connection from the combo. Select from available Kintone resources listed in the second combo below.
Optionally you can include extra parameters in the grid below if needed.
Step 4. Click on the "Columns tab" and select Kintone resource columns you want to read.
Step 5. Click Preview to make sure all necessary resource columns are included.
Bravo! You have now learned how to read data from Kintone service.
In this guide, we will show how to write data to the Kintone service resource using the COZYROC REST Destination component.
Step 1. Select an existing "Data Flow task" or create a new "Data Flow Task".
Step 2. Open the "SSIS Toolbox" and drag and drop COZYROC "REST Destination" component.
Step 3. Double click on the "REST Destination" component and select Kintone connection from the combo. Also, select resource action and Kintone resource you want to work on.
Step 4. Click on the "Mapping" tab and map the input columns for the process you are configuring.
If you want to provide input for other resource composite objects, change the input above and map the columns.
Done. You have now learned how to write data into the Kintone resource.
Configuration
Base URL address: https://[Host].kintone.com.
- OAuth
-
The authentication uses an authorized token. The token will be refreshed with the following expression:
{{=Date.now() + (response.expires_in - 300) * 1000}}.The authentication has the following user-defined parameters:
- Scope:
The following request parameters will be automatically processed during the authentication process:
-
Authorization:
Bearer {{=token.Access}}
Documentation: https://developer.kintone.io/hc/en-us/articles/360001562353.
- Password
-
The authentication uses a parameters-based authentication.
The authentication has the following user-defined parameters:
- LoginName:
- Password:
The following request parameters will be automatically processed during the authentication process:
-
X-Cybozu-Authorization:
{{=Base64.encode(connection.user.LoginName + ':' + connection.user.Password)}}
Documentation: https://en.wikipedia.org/wiki/Basic_access_authentication.
- API Token
-
The authentication uses a parameters-based authentication.
The authentication has the following user-defined parameters:
- Token:
The following request parameters will be automatically processed during the authentication process:
-
X-Cybozu-API-Token:
{{=connection.user.Token}}
Based on resource template RecordT.
- [Read] action
-
Endpoint URL address:
/apps.json.
The result is extracted from:{{=response.apps}}.Documentation: https://developer.kintone.io/hc/en-us/articles/115005336727.
- [Read Single] action
-
Endpoint URL address:
/app.json.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- id: Required. Specify the appId
Documentation: https://developer.kintone.io/hc/en-us/articles/212494888.
- appId
A key field. Data type: DT_I4
- code
Template: ShortText.
- name
Template: ShortText.
- description
Template: ShortText.
- spaceId
Data type: DT_I4
- threadId
Data type: DT_I4
- createdAt
Template: DateTime.
- creator
Template: RefT.
- modifiedAt
Template: DateTime.
- modifier
Template: RefT.
Based on resource template RecordT.
- [Create] action
-
Endpoint URL address:
/preview/app.json.The following request parameters will be automatically processed:
-
application/json:
{{=item}}
Documentation: https://developer.kintone.io/hc/en-us/articles/115004712547.
-
application/json:
- name
Template: ShortText.
- spaceId
Data type: DT_I4
- threadId
Data type: DT_I4
Based on resource template RecordT.
- [Read] action
-
Endpoint URL address:
/preview/app/deploy.json.
The result is extracted from:{{=response.apps}}.Documentation: https://developer.kintone.io/hc/en-us/articles/115004890947.
- [Create] action
-
Endpoint URL address:
/preview/app/deploy.json.The following request parameters will be automatically processed:
-
application/json:
{{={ apps: batch, revert: true } }}
Documentation: https://developer.kintone.io/hc/en-us/articles/115004712547.
-
application/json:
- app
Data type: DT_I4
- status
Template: ShortText.
- revision
Data type: DT_I4
- revert
Data type: DT_BOOL
Based on resource template RecordT.
- [Read] action
-
Endpoint URL address:
/app/form/fields.json.
The result is extracted from:{{=_.values(response.properties)}}.The action has the following user-defined parameters:
- app: Required. Specify the appId
The following request parameters will be automatically processed:
-
app:
{{=Kintone.UI.AppEditor.getValue(parameters)}}
Documentation: https://developer.kintone.io/hc/en-us/articles/115005509288.
- [Create] action
-
Endpoint URL address:
/preview/app/form/fields.json.The following request parameters will be automatically processed:
-
application/json:
{{=function() { var result = { app: batch[0].app, properties: {} }; _.each(batch, function(item) { result.properties[item.code] = item; }); return result; }()}}
Documentation: https://developer.kintone.io/hc/en-us/articles/115005506868.
-
application/json:
- [Update] action
-
Endpoint URL address:
/preview/app/form/fields.json.The following request parameters will be automatically processed:
-
application/json:
{{=function() { var result = { app: batch[0].app, properties: {} }; _.each(batch, function(item) { result.properties[item.code] = item; }); return result; }()}}
Documentation: https://developer.kintone.io/hc/en-us/articles/115004712547.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/preview/app/form/fields.json.The following request parameters will be automatically processed:
-
application/json:
{{={ app: batch[0].app, fields: _.pluck(batch, 'code') } }}
Documentation: https://developer.kintone.io/hc/en-us/articles/115005341187.
-
application/json:
- code
A key field. Template: ShortText.
- label
Template: ShortText.
- type
Template: ShortText.
- noLabel
Data type: DT_BOOL
- enabled
Data type: DT_BOOL
- required
Data type: DT_BOOL
- unique
Data type: DT_BOOL
- maxValue
Data type: DT_I4
- minValue
Data type: DT_I4
- maxLength
Data type: DT_I4
- minLength
Data type: DT_I4
- defaultValue
Template: ShortText.
- defaultNowValue
Data type: DT_BOOL
- options
The gathered value is processed with
{{=_.values(value)}}expression. Field components:- An array.
- Contains the following components: index, label.
- align
Template: ShortText.
- expression
Template: ShortText.
- hideExpression
Data type: DT_BOOL
- digit
Data type: DT_BOOL
- thumbnailSize
Data type: DT_I4
- protocol
Template: ShortText.
- format
Template: ShortText.
- displayScale
Data type: DT_I4
- unit
Template: ShortText.
- unitPosition
Template: ShortText.
- entities
Field components:
- An array.
-
Uses template:
EntityRefT.
- referenceTable
Field components:
-
Uses template:
ShortText. - Contains the following components: relatedApp, condition, filterCond, displayFields, sort, size.
-
Uses template:
- lookup
Field components:
-
Uses template:
LongText. - Contains the following components: fieldMappings, lookupPickerFields, filterCond, sort.
-
Uses template:
- openGroup
Data type: DT_BOOL
- fields
Template: LongText. A composite field.
- app
A key field. Template: ShortText.
Based on resource template RecordT.
- [Read] action
-
Endpoint URL address:
/preview/app/form/layout.json.
The result is extracted from:{{=response.layout}}.The action has the following user-defined parameters:
- app: Required. Specify the appId
The following request parameters will be automatically processed:
-
app:
{{=Kintone.UI.AppEditor.getValue(parameters)}}
Documentation: https://developer.kintone.io/hc/en-us/articles/115005509068.
- [Update] action
-
Endpoint URL address:
/preview/app/form/layout.json.The action has the following user-defined parameters:
- app: Required. Specify the appId
The following request parameters will be automatically processed:
-
application/json:
{{={ app: Kintone.UI.AppEditor.getValue(parameters), layout: batch } }}
Documentation: https://developer.kintone.io/hc/en-us/articles/115005341427.
- type
Template: ShortText.
- code
Template: ShortText.
- fields
Field components:
- An array.
-
Uses template:
FieldLayoutT.
- layout
Field components:
-
Uses template:
ShortText. - Contains the following components: type, code, fields, layout.
-
Uses template:
Based on resource template RecordT.
- [Read] action
-
Endpoint URL address:
/app/views.json.
The result is extracted from:{{=_.values(response.views)}}.The action has the following user-defined parameters:
- app: Required. Specify the appId
The following request parameters will be automatically processed:
-
app:
{{=Kintone.UI.AppEditor.getValue(parameters)}}
Documentation: https://developer.kintone.io/hc/en-us/articles/115004401787.
- [Update] action
-
Endpoint URL address:
/preview/app/views.json.The action has the following user-defined parameters:
- app: Required. Specify the appId
The following request parameters will be automatically processed:
-
application/json:
{{={ app: Kintone.UI.AppEditor.getValue(parameters), views: batch } }}
Documentation: https://developer.kintone.io/hc/en-us/articles/115004880588.
- builtinType
Template: ShortText.
- date
Template: ShortText.
- fields
Template: LongText. A composite field.
- filterCond
Template: ShortText.
- html
Template: ShortText.
- id
Template: ShortText.
- index
Template: ShortText.
- name
Template: ShortText.
- pager
Data type: DT_BOOL
- device
Template: ShortText.
- sort
Template: ShortText.
- title
Template: ShortText.
- type
Template: ShortText.
Based on resource template RecordT.
- [Read] action
-
Endpoint URL address:
/preview/app/status.json.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- app: Required. Specify the appId
The following request parameters will be automatically processed:
-
app:
{{=Kintone.UI.AppEditor.getValue(parameters)}}
Documentation: https://developer.kintone.io/hc/en-us/articles/115005238087.
- [Update] action
-
Endpoint URL address:
/preview/app/status.json.Documentation: https://developer.kintone.io/hc/en-us/articles/115005066028.
- enable
Data type: DT_BOOL
- app
Data type: DT_I4
- states
Field components:
-
Uses template:
StatesT. - Contains the following components: Not started, In progress, Completed.
-
Uses template:
- actions
Field components:
- An array.
- Contains the following components: name, from, to, filterCond.
- revision
Template: ShortText.
Based on resource template RecordT.
- [Read] action
-
Endpoint URL address:
/app/customize.json.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- app: Required. Specify the appId
The following request parameters will be automatically processed:
-
app:
{{=Kintone.UI.AppEditor.getValue(parameters)}}
Documentation: https://developer.kintone.io/hc/en-us/articles/115004704967.
- scope
Template: ShortText.
- app
Data type: DT_I4
- desktop
Field components:
-
Uses template:
FileListT. - Contains the following components: js, css.
-
Uses template:
- mobile
Field components:
-
Uses template:
FileListT. - Contains the following components: js, css.
-
Uses template:
- revision
Template: ShortText.
Based on resource template RecordT.
- [Read] action
-
Endpoint URL address:
/app/acl.json.
The result is extracted from:{{=response.rights}}.The action has the following user-defined parameters:
- app: Required. Specify the appId
The following request parameters will be automatically processed:
-
app:
{{=Kintone.UI.AppEditor.getValue(parameters)}}
Documentation: https://developer.kintone.io/hc/en-us/articles/115005336327.
- [Update] action
-
Endpoint URL address:
/app/acl.json.The action has the following user-defined parameters:
- app: Required. Specify the appId
The following request parameters will be automatically processed:
-
application/json:
{{={ app: Kintone.UI.AppEditor.getValue(parameters), rights: batch } }}
Documentation: https://developer.kintone.io/hc/en-us/articles/115005445908.
The resource includes the fields from the EntityT template.
- appEditable
Data type: DT_BOOL
- recordViewable
Data type: DT_BOOL
- recordAddable
Data type: DT_BOOL
- recordEditable
Data type: DT_BOOL
- recordDeletable
Data type: DT_BOOL
- recordImportable
Data type: DT_BOOL
- recordExportable
Data type: DT_BOOL
Based on resource template RecordT.
- [Read] action
-
Endpoint URL address:
/record/acl.json.
The result is extracted from:{{=response.rights}}.The action has the following user-defined parameters:
- app: Required. Specify the appId
The following request parameters will be automatically processed:
-
app:
{{=Kintone.UI.AppEditor.getValue(parameters)}}
Documentation: https://developer.kintone.io/hc/en-us/articles/115005192867.
- [Update] action
-
Endpoint URL address:
/record/acl.json.The action has the following user-defined parameters:
- app: Required. Specify the appId
The following request parameters will be automatically processed:
-
application/json:
{{={ app: Kintone.UI.AppEditor.getValue(parameters), rights: batch } }}
Documentation: https://developer.kintone.io/hc/en-us/articles/115005364008.
- filterCond
Template: ShortText.
- app
Data type: DT_I4
- entities
Field components:
- An array.
-
Uses template:
EntityT. - Contains the following components: viewable, editable, deletable.
Based on resource template RecordT.
- [Read] action
-
Endpoint URL address:
/field/acl.json.
The result is extracted from:{{=response.rights}}.The action has the following user-defined parameters:
- app: Specify the appId
The following request parameters will be automatically processed:
-
app:
{{=Kintone.UI.AppEditor.getValue(parameters)}}
Documentation: https://developer.kintone.io/hc/en-us/articles/115005362108.
- [Update] action
-
Endpoint URL address:
/field/acl.json.The action has the following user-defined parameters:
- app: Required. Specify the appId
The following request parameters will be automatically processed:
-
application/json:
{{={ app: Kintone.UI.AppEditor.getValue(parameters), rights: batch } }}
Documentation: https://developer.kintone.io/hc/en-us/articles/115005190347.
- code
Template: ShortText.
- entities
Field components:
- An array.
-
Uses template:
EntityT.
Based on resource template RecordT.
- [Read] action
-
Endpoint URL address:
/records/acl/evaluate.json.
The result is extracted from:{{=response.rights}}.The action has the following user-defined parameters:
- app: Required. Specify the appId
- ids: Specify the Array of recordId
The following request parameters will be automatically processed:
-
app:
{{=Kintone.UI.AppEditor.getValue(parameters)}}
Documentation: https://developer.kintone.io/hc/en-us/articles/360005496913.
- app
Data type: DT_I4
- id
Data type: DT_I4
- record
Field components:
- Contains the following components: viewable, editable, deletable.
- fields
Field components:
-
Uses template:
FieldPermissionT. - Contains the following components: Text, Text_Area, Updated_datetime, Updated_by.
-
Uses template:
Based on resource template RecordT.
- [Read] action
-
Endpoint URL address:
/app/notifications/general.json.
The result is extracted from:{{=response.notifications}}.The action has the following user-defined parameters:
- app: Specify the appId
The following request parameters will be automatically processed:
-
app:
{{=Kintone.UI.AppEditor.getValue(parameters)}}
Documentation: https://developer.kintone.io/hc/en-us/articles/900003976986.
- [Update] action
-
Endpoint URL address:
/preview/app/notifications/general.json.The action has the following user-defined parameters:
- app: Required. Specify the appId
The following request parameters will be automatically processed:
-
application/json:
{{={ app: Kintone.UI.AppEditor.getValue(parameters), notifications: batch } }}
Documentation: https://developer.kintone.io/hc/en-us/articles/900004909883.
The resource includes the fields from the EntityT template.
- recordAdded
Data type: DT_BOOL
- recordEdited
Data type: DT_BOOL
- commentAdded
Data type: DT_BOOL
- statusChanged
Data type: DT_BOOL
- fileImported
Data type: DT_BOOL
Based on resource template RecordT.
- [Read] action
-
Endpoint URL address:
/app/notifications/perRecord.json.
The result is extracted from:{{=response.notifications}}.The action has the following user-defined parameters:
- app: Required. Specify the appId
The following request parameters will be automatically processed:
-
app:
{{=Kintone.UI.AppEditor.getValue(parameters)}}
Documentation: https://developer.kintone.io/hc/en-us/articles/900004909023.
- [Update] action
-
Endpoint URL address:
/preview/app/notifications/perRecord.json.The action has the following user-defined parameters:
- app: Required. Specify the appId
The following request parameters will be automatically processed:
-
application/json:
{{={ app: Kintone.UI.AppEditor.getValue(parameters), notifications: batch } }}
Documentation: https://developer.kintone.io/hc/en-us/articles/900004909963.
- filterCond
Template: ShortText.
- title
Template: ShortText.
- targets
Template: TargetT.
Based on resource template RecordT.
- [Read] action
-
Endpoint URL address:
/app/notifications/reminder.json.
The result is extracted from:{{=response.notifications}}.The action has the following user-defined parameters:
- app: Required. Specify the appId
The following request parameters will be automatically processed:
-
app:
{{=Kintone.UI.AppEditor.getValue(parameters)}}
Documentation: https://developer.kintone.io/hc/en-us/articles/900003958666.
- [Update] action
-
Endpoint URL address:
/preview/app/notifications/reminder.json.The action has the following user-defined parameters:
- app: Required. Specify the appId
The following request parameters will be automatically processed:
-
application/json:
{{={ app: Kintone.UI.AppEditor.getValue(parameters), notifications: batch } }}
Documentation: https://developer.kintone.io/hc/en-us/articles/900003959746.
- timing
Field components:
-
Uses template:
ShortText. - Contains the following components: code, daysLater, hoursLater, time.
-
Uses template:
- filterCond
Template: ShortText.
- title
Template: ShortText.
- targets
Template: TargetT.
Based on resource template RecordT.
- [Read] action
-
Endpoint URL address:
/records.json.
The result is extracted from:{{=Kintone.readRecord(resource.getFields(parameters), response.records)}}.
The result is paginated.The action has the following user-defined parameters:
- app: Required. Specify the appId
- query: Optional. Specify the query
The following request parameters will be automatically processed:
-
app:
{{=Kintone.UI.AppEditor.getValue(parameters)}}
Documentation: https://developer.kintone.io/hc/en-us/articles/360019245194.
- [Read Single] action
-
Endpoint URL address:
/record.json.
The result is extracted from:{{=Kintone.readRecord(resource.getFields(parameters), response.record)}}.
The result is paginated.The action has the following user-defined parameters:
- app: Specify the appId
- id: Specify the recordId
The following request parameters will be automatically processed:
-
app:
{{=Kintone.UI.AppEditor.getValue(parameters)}}
Documentation: https://developer.kintone.io/hc/en-us/articles/213149287.
- [Create] action
-
Endpoint URL address:
/records.json.
The result is extracted from:{{=_.map(response.ids, function(id) { return { id: id }; })}}.The action has the following user-defined parameters:
- app: Required. Specify the app.
The following request parameters will be automatically processed:
-
application/json:
{{={ app : Kintone.UI.AppEditor.getValue(parameters), records : Kintone.getActionPayload(resource.getFields(parameters), batch) } }}
Documentation: https://developer.kintone.io/hc/en-us/articles/212494628.
- [Update] action
-
Endpoint URL address:
/records.json.
The result is extracted from:{{=response.records}}.The action has the following user-defined parameters:
- app: Required. Specify the app.
The following request parameters will be automatically processed:
-
application/json:
{{={ app : Kintone.UI.AppEditor.getValue(parameters), records : Kintone.getActionPayload(resource.getFields(parameters), batch) } }}
Documentation: https://developer.kintone.io/hc/en-us/articles/360000313622.
- [Delete] action
-
Endpoint URL address:
/records.json.The action has the following user-defined parameters:
- app: Required. Specify the app.
The following request parameters will be automatically processed:
-
application/json:
{{={ app : Kintone.UI.AppEditor.getValue(parameters), ids : _.pluck(batch, 'id') } }}
Documentation: https://developer.kintone.io/hc/en-us/articles/360000313622.
- id
A key field. Data type: DT_I4
- $revision
Field components:
-
Uses template:
ShortText. - Contains the following components: type, value.
-
Uses template:
- [External]
-
The external fields URL address:
/app/form/fields.json. The external fields list is extracted from:{{=Kintone.getFields(response, parameters)}}.
Based on resource template RecordT.
- [Read] action
-
Endpoint URL address:
/record/comments.json.
The result is extracted from:{{=response.comments}}.The action has the following user-defined parameters:
- app: Required. Specify the appId
- record: Required. Specify the recordId
The following request parameters will be automatically processed:
-
app:
{{=Kintone.UI.AppEditor.getValue(parameters)}}
Documentation: https://developer.kintone.io/hc/en-us/articles/219105188.
- [Create] action
-
Endpoint URL address:
/record/comment.json.The following request parameters will be automatically processed:
-
application/json:
{{={ app: item.app, record: item.record, comment: item } }}
Documentation: https://developer.kintone.io/hc/en-us/articles/219501367.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/record/comment.json.The following request parameters will be automatically processed:
-
application/json:
{{={ app: item.app, record: item.record, comment: item.id } }}
Documentation: https://developer.kintone.io/hc/en-us/articles/219562607.
-
application/json:
- text
Template: ShortText.
- mentions
Template: MentionT.
- createdAt
Template: DateTime. A read-only field.
- creator
Template: RefT. A read-only field.
- id
A key field. Data type: DT_I4
- app
A key field. Data type: DT_I4
- record
A key field. Data type: DT_I4
Based on resource template RecordT.
- [Read] action
-
Endpoint URL address:
/space.json.The action has the following user-defined parameters:
- id: Required. Specify the spaceId
Documentation: https://developer.kintone.io/hc/en-us/articles/115006107968.
- [Create] action
-
Endpoint URL address:
/template/space.json.Documentation: https://developer.kintone.io/hc/en-us/articles/115005932707.
- [Delete] action
-
Endpoint URL address:
/space.json.The following request parameters will be automatically processed:
-
application/json:
{{=item}}
Documentation: https://developer.kintone.io/hc/en-us/articles/115006107928.
-
application/json:
- id
A key field. Data type: DT_I4
- name
Template: ShortText.
- defaultThread
Data type: DT_I4 A read-only field.
- isPrivate
Data type: DT_BOOL
- creator
Template: RefT. A read-only field.
- modifier
Template: RefT. A read-only field.
- memberCount
Data type: DT_I4 A read-only field.
- coverType
Template: ShortText. A read-only field.
- coverKey
Template: ShortText. A read-only field.
- coverUrl
Template: ShortText. A read-only field.
- body
Template: ShortText. The value is sent to
/space/body.jsonaddress.- useMultiThread
Data type: DT_BOOL A read-only field.
- isGuest
Data type: DT_BOOL
- fixedMember
Data type: DT_BOOL
- attachedApps
A read-only field. Field components:
- An array.
- Contains the following components: appId, code, name, description, createdAt, creator, modifiedAt, modifier, threadId.
- members
Field components:
- An array.
-
Uses template:
EntityT.
Based on resource template RecordT.
- [Read] action
-
Endpoint URL address:
/space/members.json.
The result is extracted from:{{=response.members}}.The action has the following user-defined parameters:
- id: Required. Specify the spaceId
Documentation: https://developer.kintone.io/hc/en-us/articles/115006107828.
- [Update] action
-
Endpoint URL address:
/space/members.json.The following request parameters will be automatically processed:
-
application/json:
{{={ id: item.id, members: batch } }}
Documentation: https://developer.kintone.io/hc/en-us/articles/115005932647.
-
application/json:
The resource includes the fields from the EntityT template.
- id
A key field. Data type: DT_I4
- isAdmin
Data type: DT_BOOL
- isImplicit
Data type: DT_BOOL
Based on resource template RecordT.
- [Create] action
-
Endpoint URL address:
/guests.json.The following request parameters will be automatically processed:
-
application/json:
{{={ guests : batch } }}
Documentation: https://developer.kintone.io/hc/en-us/articles/115006107768.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/guests.json.The following request parameters will be automatically processed:
-
application/json:
{{={ guests: _.pluck(batch, 'code')}}
Documentation: https://developer.kintone.io/hc/en-us/articles/115005932607.
-
application/json:
- code
A key field. Template: ShortText.
- password
Template: ShortText.
- timezone
Template: ShortText.
- locale
Template: ShortText.
- image
Template: ShortText.
- name
Template: ShortText.
- company
Template: ShortText.
- division
Template: ShortText.
- phone
Template: ShortText.
- callto
Template: ShortText.
Based on resource template UserT.
- [Read] action
-
Endpoint URL address:
/users.json.
The result is extracted from:{{=response.users}}.Documentation: https://developer.kintone.io/hc/en-us/articles/115008421668.
- [Read Department] action
-
Endpoint URL address:
/v1/organization/users.json.
The result is extracted from:{{=_.pluck(response.userTitles, 'user')}}.The action has the following user-defined parameters:
- code: Required. Specify the departmentCode
The following request parameters will be automatically processed:
-
application/json:
{{={ code: parameters.code, offset: parameters.iterator, size: parameters.batchSize } }}
Documentation: https://developer.kintone.io/hc/en-us/articles/115008421508.
- [Read Group] action
-
Endpoint URL address:
/v1/group/users.json.
The result is extracted from:{{=response.users}}.The action has the following user-defined parameters:
- code: Required. Specify the groupCode
The following request parameters will be automatically processed:
-
application/json:
{{={ code: parameters.code, offset: parameters.iterator, size: parameters.batchSize } }}
Documentation: https://developer.kintone.io/hc/en-us/articles/115008271687.
- [Create] action
-
Endpoint URL address:
/users.json.The following request parameters will be automatically processed:
-
application/json:
{{={ users : batch } }}
Documentation: https://developer.kintone.io/hc/en-us/articles/115001864014.
-
application/json:
- [Update] action
-
Endpoint URL address:
/users.json.The following request parameters will be automatically processed:
-
application/json:
{{={ users : batch } }}
Documentation: https://developer.kintone.io/hc/en-us/articles/115001865774.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/users.json.The following request parameters will be automatically processed:
-
application/json:
{{={ codes: _.pluck(batch, 'code') } }}
Documentation: https://developer.kintone.io/hc/en-us/articles/115001865533.
-
application/json:
- code
A key field. Template: ShortText.
- birthDate
Template: Date.
- callto
Template: ShortText.
- services
Template: LongText. A composite field.
- ctime
Data type: DT_DBTIMESTAMP
- customItemValues
Field components:
- An array.
- Contains the following components: code, value.
- description
Template: ShortText.
Template: ShortText.
- employeeNumber
Template: ShortText.
- extensionNumber
Template: ShortText.
- givenName
Template: ShortText.
- givenNameReading
Template: ShortText.
- id
Template: ShortText.
- joinDate
Template: Date.
- localName
Template: ShortText.
- localNameLocale
Template: ShortText.
- locale
Template: ShortText.
- mobilePhone
Template: ShortText.
- mtime
Template: DateTime.
- name
Template: ShortText.
- phone
Template: ShortText.
- primaryOrganization
Template: ShortText.
- sortOrder
Data type: DT_I4
- surName
Template: ShortText.
- surNameReading
Template: ShortText.
- timezone
Template: ShortText.
- url
Template: ShortText.
- valid
Data type: DT_BOOL
- password
Template: ShortText.
- title
Field components:
-
Uses template:
ShortText. - Contains the following components: code, description, id, name.
-
Uses template:
Based on resource template UserT.
- [Read] action
-
Endpoint URL address:
/users.json.
The result is extracted from:{{=response.organizations}}.Documentation: https://developer.kintone.io/hc/en-us/articles/115008271847.
- [Read User] action
-
Endpoint URL address:
/user/organizations.json.
The result is extracted from:{{=_.pluck(response.organizationTitles, 'organization')}}.The action has the following user-defined parameters:
- code: Required. Specify the departmentCode
The following request parameters will be automatically processed:
-
application/json:
{{={ code: parameters.code } }}
Documentation: https://developer.kintone.io/hc/en-us/articles/115008271807.
- [Create] action
-
Endpoint URL address:
/organizations.json.The following request parameters will be automatically processed:
-
application/json:
{{={ organizations : batch } }}
Documentation: https://developer.kintone.io/hc/en-us/articles/360000286061.
-
application/json:
- [Update] action
-
Endpoint URL address:
/organizations.json.The following request parameters will be automatically processed:
-
application/json:
{{={ organizations : batch } }}
Documentation: https://developer.kintone.io/hc/en-us/articles/360000286601.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/organizations.json.The following request parameters will be automatically processed:
-
application/json:
{{={ codes: _.pluck(batch, 'code') } }}
Documentation: https://developer.kintone.io/hc/en-us/articles/360000287922.
-
application/json:
- code
A key field. Template: ShortText.
- id
Data type: DT_I4
- name
Template: ShortText.
- parentCode
Template: ShortText.
- localName
Template: ShortText.
- localNameLocale
Template: ShortText.
- description
Template: ShortText.
Based on resource template UserT.
- [Read] action
-
Endpoint URL address:
/groups.json.
The result is extracted from:{{=response.groups}}.Documentation: https://developer.kintone.io/hc/en-us/articles/115008421608.
- [Read User] action
-
Endpoint URL address:
/user/groups.json.
The result is extracted from:{{=response.groups}}.The action has the following user-defined parameters:
- code: Required. Specify the userCode (login-name)
Documentation: https://developer.kintone.io/hc/en-us/articles/115008271787.
- id
Data type: DT_I4
- code
Template: ShortText.
- name
Template: ShortText.
- description
Template: ShortText.
- [Read] action
-
The result is paginated.The following request parameters will be automatically processed:
-
offset:
{{=parameters.iterator}} -
limit:
{{=parameters.batchSize}} -
_includeUserParameters:
{{=parameters}}
-
offset:
- [Create] action
-
The action uses POST method.The following request parameters will be automatically processed:
-
application/json:
{{=item}} -
_includeUserParameters:
{{=parameters}}
-
application/json:
- [Update] action
-
The action uses PUT method.The following request parameters will be automatically processed:
-
application/json:
{{=item}} -
_includeUserParameters:
{{=parameters}}
-
application/json:
- [Delete] action
-
The action uses DELETE method.
Based on resource template Base.
Based on resource template Base.
- ShortText
Data type: DT_WSTR ( length 255 )
- LongText
Data type: DT_WSTR ( length 1000 )
- DateTime
Data type: DT_DBTIMESTAMP
- Date
Data type: DT_DBDATE
- Number
Data type: DT_I4
- RefT
Field components:
-
Uses template:
ShortText. - Contains the following components: code, name.
-
Uses template:
- RefListT
Field components:
- Contains the following components: value.
- FileT
Field components:
-
Uses template:
ShortText. - Contains the following components: fileKey, name, contentType, size, content.
-
Uses template:
- AttachmentT
Field components:
- Contains the following components: value.
- EntityRefT
Field components:
-
Uses template:
ShortText. - Contains the following components: type, code.
-
Uses template:
- EntityT
Field components:
-
Uses template:
EntityRefT. - Contains the following components: entity, includeSubs.
-
Uses template:
- AssigneeT
Field components:
-
Uses template:
ShortText. - Contains the following components: type, entities.
-
Uses template:
- FileListT
Field components:
- An array.
- Contains the following components: type, file.
- StatesT
Field components:
-
Uses template:
ShortText. - Contains the following components: name, index, assignee.
-
Uses template:
- FieldPermissionT
Field components:
- Contains the following components: viewable, editable.
- TargetT
Field components:
- An array.
-
Uses template:
EntityT.
- MentionT
Field components:
- An array.
-
Uses template:
EntityRefT.
- FieldLayoutT
Field components:
-
Uses template:
ShortText. - Contains the following components: type, code, label, elementId, size.
-
Uses template:
What's New
- New: Introduced connection
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.