- URL:https://[root]/content/items/[itemID]/setContentStatus(POST only)
Example usage
The following is a sample ArcGIS Online POST request for the setContentStatus operation:
POST /sharing/rest/content/items/c20206e7efd94c65a643cfa3c004734e/setContentStatus HTTP/1.1
Host: org.arcgis.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []
status=org_authoritative&clearEmptyFields=false&f=pjsonThe following is a sample ArcGIS Enterprise POST request for the setContentStatus operation:
POST /webadaptor/sharing/rest/content/items/c20206e7efd94c65a643cfa3c004734e/setContentStatus HTTP/1.1
Host: machine.domain.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []
status=org_authoritative&clearEmptyFields=false&f=pjsonDescription
The setContentStatus operation allows an item owner or organization administrator to change the status of an item to either authoritative or deprecated. To change an item's status, an item owner or organization administrator must be assigned a role that includes the portal:admin:updateItems privilege.
When an item is marked as authoritative (either org_authoritative or public_authoritative), it will be given an Authoritative badge, which indicates to organization members that the item is recommended for use. Items marked as authoritative are automatically protected to prevent accidental deletion and are boosted in search results to increase visibility and encourage use. When an item is marked as deprecated (deprecated), it will be given a Deprecated badge, which indicates to organization members that the item is not recommended for use.
Item status badges can be viewed in either an ArcGIS Online or ArcGIS Enterprise portal site when in the Content tab, under either My Content for item owners or My Organization for all other organization members, as well as under the Overview tab when viewing the item's details. As well, the Status filter can be used to search the organization for authoritative or deprecated items.
Only organizations that have had their identity verified by Esri can mark their items as public_authoritative. Once an organization has its identity verified, all items previously marked as org_authoritative will be automatically converted to public_authoritative. As well, if an item marked as org_authoritative is shared with the public from a verified organization, the item's status will automatically be converted to public_authoritative. Similarly, when unsharing an item from the public that is marked as public_authoritative, the item's status will be automatically changed to org_authoritative.
Note:
Verified organizations cannot change their name; the organization must be unverified first. To change the name of a verified organization, all public_authoritative items must be unshared from the public or all instances of authoritative status must be removed from the organization before an organization can become unverified and change its name.
An item's status can also be reset by clearing out the value for status (submitting an empty string) and selecting clearEmptyFields (true). Submitting a request with this information will immediately remove all badges and authoritative or deprecated status.
Request parameters
| Parameter | Details |
|---|---|
| status | Specifies the item's status as either deprecated or authoritative. To mark an item as public_authoritative, an organization must have its identity verified by Esri. Note:Authoritative items are automatically protected to prevent accidental deletion and are boosted in search results to increase visibility and encourage use. Values: deprecated | org_authoritative | public_authoritative |
| clearEmptyFields | Clears the empty string field for the status parameter. If the status parameter contains an empty string, and clearEmptyFields is set as true, an item previously marked as either org_authoritative, public_authoritative, deprecated will have its status reset. or any string fields that are passed in empty. The default value is false. Values: true | false |
| f | The response format. The default format is html. Values: html | json | pjson |
Response properties
| Property | Details |
|---|---|
| success | Indicates if the operation was successful. |
| itemId | The ID of the item. |
JSON Response syntax
{
"success": true,
"itemId": "<itemId>"
}JSON Response examples
The following is a sample success response for the setContentStatus operation:
{
"success": true,
"itemId": "c20206e7efd94c65a643cfa3c004734e"
}The following is a sample error message for the setContentStatus operation:
{
"error": {
"code": 400,
"messageCode": "CONT_0163",
"message": "Unable to update item status to public_authoritative. Org has to be public and verified.",
"details": []
}
}