Update device's meta information (assignment info and location)

curl --request PATCH \
  --url https://api.itmc.i.moneyforward.com/api/v1/organizations/{organizationId}/devices/{deviceId}/meta \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "status": "active",
  "peopleId": 123,
  "assignmentStartDate": "2021-01-01",
  "assignmentEndDate": "2021-01-02",
  "location1": "location1",
  "location2": "location2",
  "comment": "Assigned to new employee"
}
'

import requests

url = "https://api.itmc.i.moneyforward.com/api/v1/organizations/{organizationId}/devices/{deviceId}/meta"

payload = {
    "status": "active",
    "peopleId": 123,
    "assignmentStartDate": "2021-01-01",
    "assignmentEndDate": "2021-01-02",
    "location1": "location1",
    "location2": "location2",
    "comment": "Assigned to new employee"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    status: 'active',
    peopleId: 123,
    assignmentStartDate: '2021-01-01',
    assignmentEndDate: '2021-01-02',
    location1: 'location1',
    location2: 'location2',
    comment: 'Assigned to new employee'
  })
};

fetch('https://api.itmc.i.moneyforward.com/api/v1/organizations/{organizationId}/devices/{deviceId}/meta', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.itmc.i.moneyforward.com/api/v1/organizations/{organizationId}/devices/{deviceId}/meta",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'status' => 'active',
    'peopleId' => 123,
    'assignmentStartDate' => '2021-01-01',
    'assignmentEndDate' => '2021-01-02',
    'location1' => 'location1',
    'location2' => 'location2',
    'comment' => 'Assigned to new employee'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.itmc.i.moneyforward.com/api/v1/organizations/{organizationId}/devices/{deviceId}/meta"

	payload := strings.NewReader("{\n  \"status\": \"active\",\n  \"peopleId\": 123,\n  \"assignmentStartDate\": \"2021-01-01\",\n  \"assignmentEndDate\": \"2021-01-02\",\n  \"location1\": \"location1\",\n  \"location2\": \"location2\",\n  \"comment\": \"Assigned to new employee\"\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api.itmc.i.moneyforward.com/api/v1/organizations/{organizationId}/devices/{deviceId}/meta")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"status\": \"active\",\n  \"peopleId\": 123,\n  \"assignmentStartDate\": \"2021-01-01\",\n  \"assignmentEndDate\": \"2021-01-02\",\n  \"location1\": \"location1\",\n  \"location2\": \"location2\",\n  \"comment\": \"Assigned to new employee\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.itmc.i.moneyforward.com/api/v1/organizations/{organizationId}/devices/{deviceId}/meta")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"status\": \"active\",\n  \"peopleId\": 123,\n  \"assignmentStartDate\": \"2021-01-01\",\n  \"assignmentEndDate\": \"2021-01-02\",\n  \"location1\": \"location1\",\n  \"location2\": \"location2\",\n  \"comment\": \"Assigned to new employee\"\n}"

response = http.request(request)
puts response.read_body

{
  "id": 123,
  "memo": "foo bar",
  "type": "pc",
  "people": {
    "id": 1,
    "primaryEmail": "foo@gmail.com",
    "displayName": "Yamaha Honda",
    "avatar": "avatar_url",
    "username": "foo",
    "type": "employee",
    "status": "suspended",
    "suspendedAt": "2021-07-13T19:15:40.000Z",
    "createdAt": "2021-07-13T19:15:40.000Z"
  },
  "identity": {
    "employeeStatus": "active",
    "employeeType": "full_time_employee",
    "firstName": "First Name",
    "lastName": "Last Name",
    "id": "<string>",
    "organizationId": 123,
    "peopleId": "<string>",
    "managementType": "managed",
    "displayName": "Display Name",
    "avatar": "<string>",
    "primaryEmail": "primay@email.com",
    "secondaryEmails": [
      "secondary+1@email.com",
      "secondary+2@email.com"
    ],
    "companyName": "company name",
    "workLocation": "work location",
    "department": {
      "name": "department name"
    },
    "serviceCount": 123,
    "deviceCount": 123,
    "costs": [
      {
        "amount": 100,
        "currency": "usd"
      }
    ],
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "isManager": true,
    "isMock": true,
    "isEmailEditable": true,
    "hasPresetFieldsUnlinked": true
  },
  "preset": {
    "subtype": "other",
    "price": 123.321
  },
  "custom": {
    "custom_text_field": "foo",
    "custom_date_field": "2024-01-01",
    "custom_number_field": 123,
    "custom_dropdown_field": "Option Displayed Value A"
  },
  "createdAt": "2024-03-20T00:00:00Z",
  "updatedAt": "2024-03-20T00:00:00Z",
  "customFieldsWithMetadata": [
    {
      "id": 1,
      "attributeCode": "custom_text_field",
      "attributeName": "Text field",
      "value": "foo"
    },
    {
      "id": 2,
      "attributeCode": "custom_date_field",
      "attributeName": "Date field",
      "value": "2024-01-01"
    },
    {
      "id": 3,
      "attributeCode": "custom_number_field",
      "attributeName": "Number field",
      "value": 123
    },
    {
      "id": 4,
      "attributeCode": "custom_dropdown_field",
      "attributeName": "Dropdown field",
      "value": "Option Displayed Value A"
    }
  ]
}

PATCH

api

organizations

{organizationId}

devices

{deviceId}

meta

Update device's meta information (assignment info and location)

curl --request PATCH \
  --url https://api.itmc.i.moneyforward.com/api/v1/organizations/{organizationId}/devices/{deviceId}/meta \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "status": "active",
  "peopleId": 123,
  "assignmentStartDate": "2021-01-01",
  "assignmentEndDate": "2021-01-02",
  "location1": "location1",
  "location2": "location2",
  "comment": "Assigned to new employee"
}
'

import requests

url = "https://api.itmc.i.moneyforward.com/api/v1/organizations/{organizationId}/devices/{deviceId}/meta"

payload = {
    "status": "active",
    "peopleId": 123,
    "assignmentStartDate": "2021-01-01",
    "assignmentEndDate": "2021-01-02",
    "location1": "location1",
    "location2": "location2",
    "comment": "Assigned to new employee"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    status: 'active',
    peopleId: 123,
    assignmentStartDate: '2021-01-01',
    assignmentEndDate: '2021-01-02',
    location1: 'location1',
    location2: 'location2',
    comment: 'Assigned to new employee'
  })
};

fetch('https://api.itmc.i.moneyforward.com/api/v1/organizations/{organizationId}/devices/{deviceId}/meta', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.itmc.i.moneyforward.com/api/v1/organizations/{organizationId}/devices/{deviceId}/meta",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'status' => 'active',
    'peopleId' => 123,
    'assignmentStartDate' => '2021-01-01',
    'assignmentEndDate' => '2021-01-02',
    'location1' => 'location1',
    'location2' => 'location2',
    'comment' => 'Assigned to new employee'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.itmc.i.moneyforward.com/api/v1/organizations/{organizationId}/devices/{deviceId}/meta"

	payload := strings.NewReader("{\n  \"status\": \"active\",\n  \"peopleId\": 123,\n  \"assignmentStartDate\": \"2021-01-01\",\n  \"assignmentEndDate\": \"2021-01-02\",\n  \"location1\": \"location1\",\n  \"location2\": \"location2\",\n  \"comment\": \"Assigned to new employee\"\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api.itmc.i.moneyforward.com/api/v1/organizations/{organizationId}/devices/{deviceId}/meta")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"status\": \"active\",\n  \"peopleId\": 123,\n  \"assignmentStartDate\": \"2021-01-01\",\n  \"assignmentEndDate\": \"2021-01-02\",\n  \"location1\": \"location1\",\n  \"location2\": \"location2\",\n  \"comment\": \"Assigned to new employee\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.itmc.i.moneyforward.com/api/v1/organizations/{organizationId}/devices/{deviceId}/meta")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"status\": \"active\",\n  \"peopleId\": 123,\n  \"assignmentStartDate\": \"2021-01-01\",\n  \"assignmentEndDate\": \"2021-01-02\",\n  \"location1\": \"location1\",\n  \"location2\": \"location2\",\n  \"comment\": \"Assigned to new employee\"\n}"

response = http.request(request)
puts response.read_body

{
  "id": 123,
  "memo": "foo bar",
  "type": "pc",
  "people": {
    "id": 1,
    "primaryEmail": "foo@gmail.com",
    "displayName": "Yamaha Honda",
    "avatar": "avatar_url",
    "username": "foo",
    "type": "employee",
    "status": "suspended",
    "suspendedAt": "2021-07-13T19:15:40.000Z",
    "createdAt": "2021-07-13T19:15:40.000Z"
  },
  "identity": {
    "employeeStatus": "active",
    "employeeType": "full_time_employee",
    "firstName": "First Name",
    "lastName": "Last Name",
    "id": "<string>",
    "organizationId": 123,
    "peopleId": "<string>",
    "managementType": "managed",
    "displayName": "Display Name",
    "avatar": "<string>",
    "primaryEmail": "primay@email.com",
    "secondaryEmails": [
      "secondary+1@email.com",
      "secondary+2@email.com"
    ],
    "companyName": "company name",
    "workLocation": "work location",
    "department": {
      "name": "department name"
    },
    "serviceCount": 123,
    "deviceCount": 123,
    "costs": [
      {
        "amount": 100,
        "currency": "usd"
      }
    ],
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "isManager": true,
    "isMock": true,
    "isEmailEditable": true,
    "hasPresetFieldsUnlinked": true
  },
  "preset": {
    "subtype": "other",
    "price": 123.321
  },
  "custom": {
    "custom_text_field": "foo",
    "custom_date_field": "2024-01-01",
    "custom_number_field": 123,
    "custom_dropdown_field": "Option Displayed Value A"
  },
  "createdAt": "2024-03-20T00:00:00Z",
  "updatedAt": "2024-03-20T00:00:00Z",
  "customFieldsWithMetadata": [
    {
      "id": 1,
      "attributeCode": "custom_text_field",
      "attributeName": "Text field",
      "value": "foo"
    },
    {
      "id": 2,
      "attributeCode": "custom_date_field",
      "attributeName": "Date field",
      "value": "2024-01-01"
    },
    {
      "id": 3,
      "attributeCode": "custom_number_field",
      "attributeName": "Number field",
      "value": 123
    },
    {
      "id": 4,
      "attributeCode": "custom_dropdown_field",
      "attributeName": "Dropdown field",
      "value": "Option Displayed Value A"
    }
  ]
}

承認

Authorization

string

header

必須

For authenticated requests, set the Authorization: Bearer your_api_key parameter in the header.
You can create and manage your API Keys by visiting the API Keys tab in the Settings page of your organization in Admina

パスパラメータ

organizationId

number

必須

deviceId

number

必須

ボディ

application/json

status

enum<string>

The status of the device. If IN_STOCK status is set, the device will be unassigned and the assignment start/end date will be cleared. If DECOMMISSIONED status is set, the assignment dates will be cleared but the last assigned user will be preserved for audit purposes.

利用可能なオプション:

in_stock,

pre_use,

active,

missing,

malfunction,

decommissioned,

on_order

例:

"active"

peopleId

number | null

The people ID to assign the device to. If null, the device will be unassigned. Device that has IN_STOCK status can't be assigned to a person. For DECOMMISSIONED devices, the last assigned user is preserved for audit purposes.

例:

123

assignmentStartDate

string<date> | null

The date the device is assigned to the person. Device that has IN_STOCK or DECOMMISSIONED can't have assignment start date

例:

"2021-01-01"

assignmentEndDate

string<date> | null

The date the device assignment ends. Device that has IN_STOCK or DECOMMISSIONED can't have assignment end date

例:

"2021-01-02"

location1

string

Primary location information for the device

例:

"location1"

location2

string

Secondary location information for the device

例:

"location2"

comment

string | null

Comment or reason for the assignment/status change

例:

"Assigned to new employee"

レスポンス

number

必須

Unique identifier for the device

例:

123

memo

string

必須

Additional notes or memo about the device

例:

"foo bar"

type

enum<string>

必須

Type of the device (e.g., PC, Phone, Tablet)

利用可能なオプション:

pc,

phone,

other

例:

"pc"

people

object | null

必須

Person assigned to this device, or null if unassigned

Show child attributes

identity

object | null

必須

Identity information of the assigned person, or null if unassigned

Show child attributes

preset

object

必須

Preset fields for the device. This is a hashmap where the key maps to the field uniqueName in device fields.

Show child attributes

例:

{ "subtype": "other", "price": 123.321 }

custom

object

必須

Custom fields for the device. This is a hashmap where the key maps to the field uniqueName in device fields.

Show child attributes

例:

{
  "custom_text_field": "foo",
  "custom_date_field": "2024-01-01",
  "custom_number_field": 123,
  "custom_dropdown_field": "Option Displayed Value A"
}

createdAt

string<date-time>

必須

Timestamp when the device was created

例:

"2024-03-20T00:00:00Z"

updatedAt

string<date-time>

必須

Timestamp when the device was last updated

例:

"2024-03-20T00:00:00Z"

customFieldsWithMetadata

object[]

必須

read-only

Show child attributes

例:

[
  {
    "id": 1,
    "attributeCode": "custom_text_field",
    "attributeName": "Text field",
    "value": "foo"
  },
  {
    "id": 2,
    "attributeCode": "custom_date_field",
    "attributeName": "Date field",
    "value": "2024-01-01"
  },
  {
    "id": 3,
    "attributeCode": "custom_number_field",
    "attributeName": "Number field",
    "value": 123
  },
  {
    "id": 4,
    "attributeCode": "custom_dropdown_field",
    "attributeName": "Dropdown field",
    "value": "Option Displayed Value A"
  }
]

最終更新日 2026年8月13日

IT Management API

ガイド

エンドポイント

Update device's meta information (assignment info and location)

承認

パスパラメータ

ボディ

レスポンス