> For the complete documentation index, see [llms.txt](https://interfacing.gitbook.io/interfacing-help-files/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://interfacing.gitbook.io/interfacing-help-files/solutions-developers/api-and-information-repository/rest-apis/use-cases-and-examples/update-an-object.md).

# Update an Object

Use the `PUT /items/{nodeId}` endpoint to update an existing object in **IMS**. This is commonly used for synchronizing data between IMS and external systems, whether one-way or two-way via an integrated script.

***

## Quick Start

* **Base Endpoint URL**: <https://YOURIMS.interfacing.com/api/v1/items/{nodeId}>
* **Authentication**: Obtain a valid token (see [Authentication & Token Management](/interfacing-help-files/solutions-developers/api-and-information-repository/rest-apis.md#authentication-and-token-management))
* **Swagger Documentation**: <https://YOUREPC.interfacing.com/api/v1/swagger/#/Common/updateItem>

***

## Tips on the Update Method

The simplest update method is:

1. [**Retrieve** the object](/interfacing-help-files/solutions-developers/api-and-information-repository/rest-apis/use-cases-and-examples/retrieve-an-object.md) via a `GET` request.
2. **Modify** any field values locally.
3. **Submit** the updated object via this `PUT` endpoint.

Ensure the `nodeId` and `nodeVersionId` fields are included in your request body.

## Request Example

<pre class="language-json"><code class="lang-json">15:35:11.354 request:
3 > PUT http://myims.interfacing.com/api/v1/items/1450CEF9-89A3-4B48-98F7-09735BECD54B?draft=true
3 > Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...
3 > Content-Type: application/json; charset=UTF-8
3 > Content-Length: 229
3 > Host: myims.interfacing.com
<strong>3 > Connection: Keep-Alive
</strong>3 > User-Agent: Apache-HttpClient/4.5.13 (Java/11.0.15)
3 > Accept-Encoding: gzip,deflate
{
  "parent": {
    "nodeId": "A9CCB5F4-9A79-8AE7-8C4C-289A025D0D88"
  },
  "@type": "NodeElement",
  "nodeVersionId": "413426F8-66D4-49F6-843C-2F7AFEB298F5",
  "name": "new name",
  "nodeType": "DOCUMENT_SET",
  "nodeId": "1450CEF9-89A3-4B48-98F7-09735BECD54B"
}

</code></pre>

***

## Response Example

```json
15:35:11.440 response time in milliseconds: 86
3 < 200
3 < Server: nginx/1.21.6
3 < Date: Wed, 08 Jun 2022 19:35:11 GMT
3 < Content-Type: application/json
3 < Content-Length: 513
3 < X-Varnish: 198279
3 < Age: 0
3 < Via: 1.1 varnish (Varnish/7.1)
3 < Connection: keep-alive
{
  "nodeSubTypeName": null,
  "userNodeSubType": null,
  "@type": "BaseElement",
  "nodeVersionId": "BFA4C9F0-89C6-46C1-BD93-7CE15988BF5C",
  "nodeType": "DOCUMENT_SET",
  "creationDate": "2022-06-08T15:35:11.253-04:00",
  "nodeStatus": "IN_PROGRESS",
  "publishedNodeVersionId": null,
  "version": "0.0002",
  "nodeSubType": null,
  "modificationDate": "2022-06-08T15:35:11.367-04:00",
  "extensions": null,
  "deleted": false,
  "system": false,
  "referenceNumber": null,
  "name": "new name",
  "locked": false,
  "nodeId": "1450CEF9-89A3-4B48-98F7-09735BECD54B",
  "favorite": false
}
```

***

## CURL Example

```bash
curl --request PUT --url 'http://myims.interfacing.com/api/v1/items/1450CEF9-89A3-4B48-98F7-09735BECD54B?draft=true' --header 'Content-Type: application/json' -b /tmp/cookie.tmp \
--data '{
"parent": {
"nodeId": "A9CCB5F4-9A79-8AE7-8C4C-289A025D0D88"
},
"@type": "NodeElement",
"nodeVersionId": "413426F8-66D4-49F6-843C-2F7AFEB298F5",
"name": "new name",
"nodeType": "DOCUMENT_SET",
"nodeId": "1450CEF9-89A3-4B48-98F7-09735BECD54B"
}'
```

***

## What is this feature in IMS?

<mark style="color:red;">Users with Edit security permissions, including those with delete, environment, or system admin roles, can update or edit objects directly within the IMS web application.</mark>&#x20;

<mark style="color:red;">By clicking the Edit button, which is available in both the library list and the item’s details panel, users are taken to the Edit Details window for the selected object. In this window, they can modify various business details describing the object, such as associations, responsibilities, and other relevant information.</mark>

> <mark style="color:red;">To learn more about the editing functionality in IMS,</mark> [<mark style="color:red;">please click here.</mark>](/interfacing-help-files/drafts/library-management.md)

***

## See Also

<table data-view="cards"><thead><tr><th></th><th data-hidden data-card-target data-type="content-ref"></th><th data-hidden data-card-cover data-type="files"></th></tr></thead><tbody><tr><td>Authentication &#x26; Token Management</td><td><a href="/interfacing-help-files/solutions-developers/api-and-information-repository/rest-apis.md#authentication-and-token-management">REST APIs</a></td><td><a href="https://1488562728-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FTx7AmE0d2Q4ja20EYjF5%2Fuploads%2FLfvkwix26vW3CnepEMTv%2FIMS-V16-NAV-Home-Icons-5.png?alt=media&amp;token=4244c676-38ac-4218-8552-680a3ac1dcdc">IMS-V16-NAV-Home-Icons-5.png</a></td></tr><tr><td>API Reference (Swagger)</td><td><a href="/interfacing-help-files/solutions-developers/api-and-information-repository/rest-apis/api-reference-swagger.md">API Reference (Swagger)</a></td><td><a href="https://1488562728-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FTx7AmE0d2Q4ja20EYjF5%2Fuploads%2FuIm0jP36LBJWUKIgHGxl%2FIMS-V16-NAV-Library-Icons-41.png?alt=media&amp;token=a91c1498-c99a-4013-b6bd-5877df0a71bb">IMS-V16-NAV-Library-Icons-41.png</a></td></tr><tr><td>How to Perform Other Use Cases</td><td><a href="/interfacing-help-files/solutions-developers/api-and-information-repository/rest-apis/use-cases-and-examples/how-to-perform-other-use-cases.md">How to Perform Other Use Cases</a></td><td><a href="https://1488562728-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FTx7AmE0d2Q4ja20EYjF5%2Fuploads%2F5Aeu2y0v898h8TlT2GMk%2FIMS-V16-Intro-7.png?alt=media&amp;token=4c09eacd-abdd-44d1-b318-8d6dbb4a11b1">IMS-V16-Intro-7.png</a></td></tr></tbody></table>


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://interfacing.gitbook.io/interfacing-help-files/solutions-developers/api-and-information-repository/rest-apis/use-cases-and-examples/update-an-object.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.