- URL:
- https://[root]/content/items/[itemID]/setContentStatus
- Methods:
POST
Example usage
The following is a sample ArcGIS Online POST request for the set
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=pjson
The following is a sample ArcGIS Enterprise POST request for the set
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=pjson
Description
The set
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
privilege.
When an item is marked as authoritative (either org
or public
), 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
. Once an organization has its identity verified, all items previously marked as org
will be automatically converted to public
. As well, if an item marked as org
is shared with the public from a verified organization, the item's status will automatically be converted to public
. Similarly, when unsharing an item from the public that is marked as public
, the item's status will be automatically changed to org
.
An item's status can also be reset by clearing out the value for status
(submitting an empty string) and selecting clear
(true
). Submitting a request with this information will immediately remove all badges and authoritative or deprecated status.
Request parameters
Parameter | Details |
---|---|
| Specifies the item's status as either deprecated or authoritative. To mark an item as Values: |
| Clears the empty string field for the status parameter. If the status parameter contains an empty string, and Values: |
| The response format. The default format is Values: |
Response properties
Property | Details |
---|---|
| Indicates if the operation was successful. |
| The ID of the item. |
JSON Response syntax
{
"success": true,
"itemId": "<itemId>"
}
JSON Response examples
The following is a sample success response for the set
operation:
{
"success": true,
"itemId": "c20206e7efd94c65a643cfa3c004734e"
}
The following is a sample error message for the set
operation:
{
"error": {
"code": 400,
"messageCode": "CONT_0163",
"message": "Unable to update item status to public_authoritative. Org has to be public and verified.",
"details": []
}
}