Topics

All topics

Headless API

Item CRUD operations

This article contains
NEW TO SITEFINITY?

Create an item

To create an item, you must execute a POST request to the following endpoint:

{baseurl}/api/default/{entity}

Where {entity} is the entity of the module that you are working with.

You must specify all the properties of the item in JSON format inside the request body.

Sample request

POST http://mysite.com/api/default/newsitems

{
"Title": "Sample news item"
}
view raw CreateAnItemRB.json hosted with ❤ by GitHub

Sample response

{
"@odata.context": "http://mysite.com/api/default/$metadata#newsitems/$entity",
"Id": "f1aef86e-c13f-459b-a318-23bf8c507fe9",
"LastModified": "2021-05-25T17:16:41Z",
"PublicationDate": "2021-05-25T17:16:41Z",
"Title": "Sample news item",
"Description": "",
"DateCreated": "2021-05-25T17:16:41Z",
"IncludeInSitemap": true,
"UrlName": "75fa90f6-452e-4755-b511-fc9e7534f081",
"Category": [],
"Tags": [],
"AllowComments": true,
"Summary": "",
"Content": "",
"Author": "",
"SourceName": null,
"SourceSite": null,
"Provider": "OpenAccessDataProvider",
"Comments": []
}
view raw CreateAnItem.json hosted with ❤ by GitHub

Create a draft item

To create a new item in draft state, you must execute a POST request to the following endpoint:

{baseurl}/sf/system/{entity}

Where {entity} is the entity of the module that you are working with.

You must specify all the properties of the item in JSON format inside the request body.

Sample request

POST http://mysite.com/sf/system/newsitems

{
"Title": "Sample news item"
}
view raw CreateAnItemRB.json hosted with ❤ by GitHub

Sample response

{
"@odata.context": "http://localhost:13376/sf/system/$metadata#newsitems/$entity",
"Id": "81cd3a6e-019a-478e-9099-eda84da9fb5f",
"LastModified": "2022-04-06T14:22:39Z",
"PublicationDate": "2022-04-06T14:22:31Z",
"Title": "basic news 11",
"Description": "",
"DateCreated": "2022-04-06T14:22:32Z",
"IncludeInSitemap": true,
"UrlName": "9c0d3c9a-76ef-41d8-8ac5-548b721f84f2",
"Tags": [],
"Category": [],
"AllowComments": true,
"Summary": "",
"Content": "",
"Author": "",
"SourceName": null,
"SourceSite": null,
"Urls": [],
"Provider": "OpenAccessDataProvider",
"CreatedBy": "admin user",
"LastModifiedBy": "admin user",
"AvailableLanguages": [
"en"
],
"Comments": [],
"LockedStatus": null,
"DisplayStatus": [
{
"Name": "Draft",
"Source": "Lifecycle",
"Label": "Draft",
"DetailedLabel": "Saved as draft",
"PublicationDate": null,
"ExpirationDate": null,
"Date": "2022-04-06T14:22:39.56Z",
"User": "admin user",
"Id": null,
"Message": {
"Title": null,
"Description": null,
"Operations": []
}
}
],
"FirstPublished": null,
"LastPublished": null
}
view raw create-draft-item-response-body.json hosted with ❤ by GitHub

Get a collection of items

To get all items from a specific module, you must execute a GET request to the following endpoint:

{baseurl}/api/default/{entity}

Where {entity} is the entity of the module that you are working with.

Sample request

GET http://mysite.com/api/default/newsitems

Sample response

{
"@odata.context": "http://localhost:4242/api/default/$metadata#newsitems(Id,LastModified,PublicationDate,Title,Description,DateCreated,IncludeInSitemap,UrlName,AllowComments,Summary,Content,Author,SourceName,SourceSite)",
"value": [
{
"Id": "fa7e8140-5a9b-478a-9312-848b206a7337",
"LastModified": "2021-04-13T18:55:23Z",
"PublicationDate": "2021-03-12T13:27:08Z",
"Title": "Lorem ipsum",
"Description": "",
"DateCreated": "2021-03-12T13:27:08Z",
"IncludeInSitemap": true,
"UrlName": "lorem-ipsum",
"AllowComments": true,
"Summary": "",
"Content": "",
"Author": "",
"SourceName": null,
"SourceSite": null
},
{
"Id": "3b177186-8b09-497c-8def-58613183d670",
"LastModified": "2021-04-13T18:34:18Z",
"PublicationDate": "2021-04-13T18:34:18Z",
"Title": "Sample news item",
"Description": "",
"DateCreated": "2021-04-13T18:34:18Z",
"IncludeInSitemap": true,
"UrlName": "sample-news-item",
"AllowComments": true,
"Summary": "Lorem Ipsum",
"Content": "<strong>Lorem Ipsum</strong>&nbsp;is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry's standard dummy text ever since the 1500s, when an unknown printer took a galley of type and scrambled it to make a type specimen book.",
"Author": "",
"SourceName": null,
"SourceSite": null
}
]
}
view raw GetACollectionSR.json hosted with ❤ by GitHub

Get an item

To get a single item, you must execute a GET request to the following endpoint:

{baseurl}/api/default/{entity}({itemId})

Where:

  • {entity} is the entity of the module that you are working with
  • {itemId} is the ID of the item

Sample request

GET http://mysite.com/api/default/newsitems(3b177186-8b09-497c-8def-58613183d670)

Sample response

{
"@odata.context": "http://localhost:4242/api/default/$metadata#newsitems/$entity",
"Id": "3b177186-8b09-497c-8def-58613183d670",
"LastModified": "2021-04-13T18:34:18Z",
"PublicationDate": "2021-04-13T18:34:18Z",
"Title": "Sample news item",
"Description": "",
"DateCreated": "2021-04-13T18:34:18Z",
"IncludeInSitemap": true,
"UrlName": "sample-news-item",
"Tags": [
"af652e26-6ac2-40f6-9e4c-da6186b4296e"
],
"Category": [
"9eee95aa-bba0-4fd6-8577-1ba1600dd284"
],
"AllowComments": true,
"Summary": "Lorem Ipsum",
"Content": "<strong>Lorem Ipsum</strong>&nbsp;is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry's standard dummy text ever since the 1500s, when an unknown printer took a galley of type and scrambled it to make a type specimen book.",
"Author": "",
"SourceName": null,
"SourceSite": null,
"Provider": "OpenAccessDataProvider",
"Comments": []
}
view raw GetAnItemSR.json hosted with ❤ by GitHub

Update an item

To update an item, you must execute a PATCH request to the following endpoint:

{baseurl}/api/default/{entity}({itemId})

Where:

  • {entity} is the entity of the module that you are working with
  • {itemId} is the ID of the item

You must specify all the properties that you want to update in JSON format inside the request body.

Sample request

PATCH http://mysite.com/api/default/newsitems(f1aef86e-c13f-459b-a318-23bf8c507fe9)

{
"Title": "Updated news item"
}
view raw UpdateAnItem.json hosted with ❤ by GitHub

Sample response

No response body

Delete an item

To delete an item, you must execute a DELETE request to the following endpoint:

{baseurl}/api/default/{entity}({itemId})

Where:

  • {entity} is the entity of the module that you are working with
  • {itemId} is the ID of the item

Sample request

DELETE http://mysite.com/api/default/newsitems(f1aef86e-c13f-459b-a318-23bf8c507fe9)

Sample response

No response body

Want to learn more?

Increase your Sitefinity skills by signing up for our free trainings. Get Sitefinity-certified at Progress Education Community to boost your credentials.

Get started with Integration Hub | Sitefinity Cloud | Sitefinity SaaS

This free lesson teaches administrators, marketers, and other business professionals how to use the Integration hub service to create automated workflows between Sitefinity and other business systems.

Web Security for Sitefinity Administrators

This free lesson teaches administrators the basics about protecting yor Sitefinity instance and its sites from external threats. Configure HTTPS, SSL, allow lists for trusted sites, and cookie security, among others.

Foundations of Sitefinity ASP.NET Core Development

The free on-demand video course teaches developers how to use Sitefinity .NET Core and leverage its decoupled architecture and new way of coding against the platform.

Was this article helpful?

Next article

Hierarchical items operations