Cmdlets for Kintone

Build 24.0.9060

Space

Create, Update, Delete and Query the available Space in kintone.

Select

The Id column is required in the WHERE clause. The cmdlet will use the Kintone APIs to filter the results by this column. By default, the cmdlet will process other filters client-side within the cmdlet.

For example, the following queries are processed server side:

SELECT * FROM Space WHERE Id = 7

Insert

The SpaceTemplateID, Name, Members columns are required in the INSERT statement.

INSERT INTO Space(SpaceTemplateID, Name, Members) Values(1, 'New_Space', '[{"entity":{"type":"USER","code":"[email protected]"},"isAdmin":true}]')

Update

The Id column is required to update the Space.

UPDATE Space SET body='Space Body' WHERE Id = 16

Delete

The Id column is required to delete the Space.

DELETE FROM Space WHERE Id = 16

Columns

Name Type ReadOnly References Description
Id [KEY] String True

The Space ID.

Name String False

The name of the Space.

DefaultThread String False

The Thread ID of the default thread that was created when the Space was made.

IsPrivate Boolean False

The Private settings of the Space.

CreatorCode String False

The code (log in name) of the creator. An empty string is returned for inactive or deleted users.

CreatorName String False

The display name of the creator. An empty string is returned for inactive or deleted users.

ModifierCode String False

The code (log in name) of the updater. An empty string is returned for inactive or deleted users.

ModifierName String False

The display name of the updater. An empty string is returned for inactive or deleted users.

MemberCount String False

The number of members of the Space.

CoverType String False

The image type of the Cover Photo.

CoverKey String False

The key of the Cover Photo.

CoverUrl String False

The URL of the Cover Photo.

Body String False

The HTML of the Space body. Null is returned if the HTML in the body is empty. However, if the body has been set before, the HTML tags may be set even if nothing is displayed on the screen and the string will be returned.

UseMultiThread Boolean False

The Enable multiple threads setting.

IsGuest Boolean False

The Guest Space setting.

FixedMember Boolean False

AttachedApps String False

A list of Apps that are in the thread. This does not include Apps that are not live yet.

ShowAnnouncement Boolean False

The display status for the Announcement widget.

ShowThreadList Boolean False

The display status for the Threads widget.

ShowAppList Boolean False

The display status for the Apps widget.

ShowMemberList Boolean False

The display status for the People widget.

ShowRelatedLinkList Boolean False

The display status for the Related Apps and Spaces widget.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
SpaceTemplateID String

The Space Template ID. It is required while creating a new Space.

Members String

A list of members of the Space. It is required while creating a new Space. At least one Space Administrator must be specified. Inactive and deleted users cannot be specified.

Copyright (c) 2024 CData Software, Inc. - All rights reserved.
Build 24.0.9060