日報タグ登録

POST

/daily_report_tags

const url = 'https://api.smaregi.dev/TARGET-CONTRACT-ID/timecard/daily_report_tags';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"name":"営業活動","dailyReportTagGroupCode":"1","dailyReportTagDivisionCode":"1","color":"#FF6B6B","defaultDailyReportTagFlag":"1","showFlag":"0","sortNum":"1","memo":"顧客との商談や提案活動に関するタグ"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://api.smaregi.dev/TARGET-CONTRACT-ID/timecard/daily_report_tags \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "name": "営業活動", "dailyReportTagGroupCode": "1", "dailyReportTagDivisionCode": "1", "color": "#FF6B6B", "defaultDailyReportTagFlag": "1", "showFlag": "0", "sortNum": "1", "memo": "顧客との商談や提案活動に関するタグ" }'

日報タグを登録します

対象

プラン
- エンタープライズ、旧有料
オプション
- 日報

対象ユーザー権限

日報管理編集

Authorizations

AppAccessToken
timecard.daily-reports:write
UserAccessToken
timecard.daily-reports:write

Request Body

application/json

object

name

required

タグ名

string

<= 30 characters

dailyReportTagGroupCode

日報タググループコード

string

dailyReportTagDivisionCode

日報タグ区分コード

string

color

required

カラー（#とそれに続く16進数文字列6桁）

string

<= 7 characters

defaultDailyReportTagFlag

デフォルトのタグかどうか

0: デフォルトでない
1: デフォルト

string

Allowed values: 0 1

showFlag

従業員に表示するかどうか

0: 非表示
1: 表示

string

Allowed values: 0 1

sortNum

表示順

string

<= 9 characters

memo

メモ

string

<= 2000 characters

Example

{
  "name": "営業活動",
  "dailyReportTagGroupCode": "1",
  "dailyReportTagDivisionCode": "1",
  "color": "#FF6B6B",
  "defaultDailyReportTagFlag": "1",
  "showFlag": "0",
  "sortNum": "1",
  "memo": "顧客との商談や提案活動に関するタグ"
}

Responses

200

登録成功

application/json

object

dailyReportTagId

日報タグID

string

name

タグ名

string

dailyReportTagGroupCode

日報タググループコード

string

dailyReportTagDivisionCode

日報タグ区分コード

string

color

カラー

string

defaultDailyReportTagFlag

デフォルトのタグかどうか

0: デフォルトでない
1: デフォルト

string

Allowed values: 0 1

memo

メモ

string

sortNum

表示順

string

Example

{
  "dailyReportTagId": "123",
  "name": "営業活動",
  "dailyReportTagGroupCode": "1",
  "dailyReportTagDivisionCode": "1",
  "color": "#FF6B6B",
  "defaultDailyReportTagFlag": "1",
  "memo": "顧客との商談や提案活動に関するタグ",
  "sortNum": "1"
}

400

日報タグ名が重複している場合
登録に失敗した場合

application/json

object

type

エラータイプを識別するURI、もしくはabout:blank

string

title

エラーの概要

string

detail

エラーの詳細

string

Example

{
  "type": "about:blank",
  "title": "Bad Request",
  "detail": "日報タグ名の重複は認められません。すでに作成済みまたは申請中の日報タグに同名のものがあります。入力した日報タグ名を変更してください。"
}

404

指定したコードのデータが存在しない場合

application/json

object

type

エラータイプを識別するURI、もしくはabout:blank

string

title

エラーの概要

string

detail

エラーの詳細

string

Example

{
  "type": "about:blank",
  "title": "Not Found",
  "detail": "グループ区分に該当するデータが存在しません。 コード: 999"
}