Skip To Content
ArcGIS Developer
Dashboard

/setContentStatus: Set Content Status

  • 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=pjson

The 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=pjson

Description

The setContentStatus operation allows an item owner or organization administrator to mark an item as authoritative (org_authoritative, public_authoritative) or deprecated (deprecated) to recommend or discourage the use of the item. To change an item's status to either authoritative or deprecated, an item owner or organization administrator must be assigned a role that includes the portal:admin:updateItems privilege.

Authoritative items can be marked as either org_authoritative or public_authoritative. 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. Marking an item as authoritative, either within the organization or when shared with the public, the item will display an Authoritative badge on the Overview tab on the ArcGIS Online or ArcGIS Enterprise site.

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.

Request parameters

ParameterDetails
status

Specifies the item's status as deprecated or authoritative. To mark an item as public_authoritative, an organization must have its identity verified by Esri. Specifying an item as authoritative will cause the item to display an Authoritative badge on the Overview tab on the ArcGIS Online or ArcGIS Enterprise site. Specifying an item as deprecated will cause the item to display a Deprecated badge. Organization members, as well as public members for verified organizations, can search for items that have these badges using the Status filter.

Note:

Authoritative items are automatically protected to prevent accidental deletion and are boosted in search results to increase visibility and encourage use.

Values: null | deprecated | org_authoritative | public_authoritative

clearEmptyFields

Clears 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

PropertyDetails
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": []
  }
}