Generated by API Evangelist
Written by API Evangelist tooling for Esri's API. It is a proposal applied on top of the contract, not a document Esri publishes.
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for ESRI ArcGIS Platform Portal API
version: 1.0.0
extends: openapi/esri-portal-api-openapi.yml
actions:
- target: $.info
update:
x-apievangelist-phrasing:
method: generated
generated: '2026-09-26'
generator: build-phrasing.py
label: Generated by API Evangelist
operations: 5
- target: $.paths['/portals/self'].get
update:
x-apievangelist-phrasing:
intent: Get my organization's portal information
effect: read
questions:
- How do I see my ArcGIS organization's portal name, description and thumbnail?
- What resources and helper services does my organization's portal expose?
instructions:
- text: Show me our organization's portal details.
- text: Fetch the portal self information in {f} format.
slots:
f: query.f
method: generated
generated: '2026-09-26'
- target: $.paths['/community/users/{username}'].get
update:
x-apievangelist-phrasing:
intent: Get a portal user's profile
effect: read
questions:
- Can I look up the profile of a specific member of our ArcGIS organization?
- What profile details are returned for a portal user by username?
instructions:
- text: Show the profile for user {username}.
slots:
username: path.username
- text: Get the community profile of {username} as {f}.
slots:
username: path.username
f: query.f
method: generated
generated: '2026-09-26'
- target: $.paths['/content/users/{username}/items'].get
update:
x-apievangelist-phrasing:
intent: List content items a user owns
effect: read
questions:
- How do I list all the maps, layers and apps a particular user owns?
- Can I page through and sort one user's content items?
instructions:
- text: List the items owned by {username}.
slots:
username: path.username
- text: Show {num} of {username}'s items starting at {start}, sorted by {sortField} {sortOrder}.
slots:
num: query.num
username: path.username
start: query.start
sortField: query.sortField
sortOrder: query.sortOrder
method: generated
generated: '2026-09-26'
- target: $.paths['/content/items/{itemId}'].get
update:
x-apievangelist-phrasing:
intent: Get a portal item's details
effect: read
questions:
- What information can I get about a single map or layer item by its ID?
- Which call returns the metadata of one specific portal item?
instructions:
- text: Get the details of portal item {itemId}.
slots:
itemId: path.itemId
- text: Fetch item {itemId} in {f} format.
slots:
itemId: path.itemId
f: query.f
method: generated
generated: '2026-09-26'
- target: $.paths['/search'].get
update:
x-apievangelist-phrasing:
intent: Search portal items, groups and users
effect: read
questions:
- Can I search across the whole portal for feature services owned by a certain person?
- What query syntax does ArcGIS portal search accept for filtering items, groups and users?
- Is there a way to sort and page portal search results?
instructions:
- text: Search the portal for {q}.
slots:
q: query.q
- text: Run portal search {q} and return {num} results sorted by {sortField} {sortOrder}.
slots:
q: query.q
num: query.num
sortField: query.sortField
sortOrder: query.sortOrder
method: generated
generated: '2026-09-26'
Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.