Adobe Suite Uigroupby API

The Uigroupby API from Adobe Suite — 15 operation(s) for uigroupby.

Documentation GitHub OpenAPI

Operations 20

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /uigroupby/{id} Look up one list grouping · Get for UIGroupBy #

Ask an LLM

“How do I read the definition of one saved grouping used in Workfront lists?”

“Can I choose which fields come back for a single grouping?”

Tell an agent

Show grouping {id}.

Get UI grouping {id} with fields {fields}.

PUT /uigroupby/{id} Update one list grouping · Edit a UIGroupBy #

Ask an LLM

“What's the call to change how an existing grouping organizes list rows?”

“Can I rename or adjust a single saved grouping?”

Tell an agent

Edit grouping {id} with the changes I describe.

Update UI grouping {id} and return {fields}.

DELETE /uigroupby/{id} Delete one list grouping · Delete for UIGroupBy #

Ask an LLM

“Can I delete a grouping nobody uses anymore?”

“Is there a force flag for removing a single grouping?”

Tell an agent destructive · confirm first

Delete grouping {id}.

Remove UI grouping {id} with force {force}.

GET /uigroupby Fetch several list groupings by ID · Bulk Get for UIGroupBy #

Ask an LLM

“Can I load multiple groupings at once when I have their IDs?”

“Which call returns a batch of known list groupings?”

Tell an agent

Fetch groupings {id}.

Get the UI groupings {id} showing only {fields}.

PUT /uigroupby Update many list groupings at once · Bulk Edit for UIGroupBy #

Ask an LLM

“How do I bulk edit several groupings in one request?”

“Can I apply the same change to a set of groupings together?”

Tell an agent

Apply these edits to every grouping I list.

Bulk update the UI groupings and return {fields}.

POST /uigroupby Create or copy a list grouping · Create or copy a uigroupby #

Ask an LLM

“How do I create a new grouping for organizing list views?”

“Can I make a new grouping by copying an existing one?”

Tell an agent

Create a new UI grouping with the settings I give you.

Copy grouping {copySourceID} into a new grouping.

DELETE /uigroupby Delete many list groupings at once · Bulk Delete for UIGroupBy #

Ask an LLM

“Can I bulk delete a list of groupings by ID?”

“What removes several groupings in a single call?”

Tell an agent destructive · confirm first

Bulk delete groupings {id}.

Remove every UI grouping in {id} using force {force}.

GET /uigroupby/count Count list groupings · Count of uigroupby #

Ask an LLM

“How many groupings match a given filter?”

“Can I get just the total of saved groupings?”

Tell an agent

Count groupings where {filters}.

Tell me how many UI groupings exist.

GET /uigroupby/search Search list groupings · Search of uigroupby #

Ask an LLM

“What's the way to find groupings by name or object type?”

“Can I search groupings with paging and sort options?”

Tell an agent

Search groupings matching {filters}.

Find UI groupings where {filters} and list {fields}.

GET /uigroupby/report Run an aggregate report on list groupings · Report of uigroupby #

Ask an LLM

“Can I get grouped totals of groupings as a report?”

“Which call gives a report-style summary of UI groupings?”

Tell an agent

Run a grouping report filtered by {filters}.

Summarize UI groupings as a report with {listOptions}.

PUT /uigroupby/{id}/share Share one list grouping with a user or team · Sharing of a UIGroupBy #

Ask an LLM

“How do I let a teammate use one of my saved groupings?”

“Can I share a grouping with view rights but forbid certain actions?”

Tell an agent

Share grouping {id} with {accessorObjCode} {accessorID} at {coreAction} access.

Grant {accessorID} {coreAction} on grouping {id} but forbid {forbiddenActions}.

PUT /uigroupby/share Share several list groupings at once · Batch sharing of a UIGroupBy #

Ask an LLM

“Can I share a set of groupings with the same person in one request?”

“Is there a batch call to grant access to multiple groupings?”

Tell an agent

Share groupings {id} with {accessorObjCode} {accessorID} as {coreAction}.

Batch share UI groupings {id} to {accessorID} with {coreAction} rights.

PUT /uigroupby/{id}/unshare Remove someone's access to one list grouping · Un-sharing of a UIGroupBy #

Ask an LLM

“How do I stop sharing a grouping with a particular user?”

“Can I revoke a team's access to a single grouping?”

Tell an agent destructive · confirm first

Unshare grouping {id} from {accessorObjCode} {accessorID}.

Revoke {accessorID}'s access to UI grouping {id}.

PUT /uigroupby/unshare Remove access to several list groupings · Batch un-sharing of a UIGroupBy #

Ask an LLM

“Can I pull one user's access from many groupings in a single call?”

“Which call batch-revokes sharing across a list of groupings?”

Tell an agent destructive · confirm first

Unshare groupings {id} from {accessorObjCode} {accessorID}.

Batch revoke {accessorID} from every UI grouping in {id}.

PUT /uigroupby/{id}/sharePublic Make one list grouping publicly shared · Public share of a UIGroupBy #

Ask an LLM

“Can I make one grouping public for everyone in the organization?”

“Is it possible to publicly share a grouping while blocking some actions?”

Tell an agent

Share grouping {id} publicly with {coreAction} access.

Make UI grouping {id} public as {coreAction}, forbidding {forbiddenActions}.

PUT /uigroupby/sharePublic Make several list groupings publicly shared · Batch public share of a UIGroupBy #

Ask an LLM

“Can I publish a whole set of groupings publicly in one request?”

“What's the batch call for public sharing of many groupings?”

Tell an agent

Publicly share groupings {id} with {coreAction} access.

Batch publish UI groupings {id} as {coreAction} but block {forbiddenActions}.

PUT /uigroupby/{id}/unsharePublic Remove the public share from one list grouping · Public un-share of a UIGroupBy #

Ask an LLM

“What takes a single grouping out of public view?”

“Can I turn off public sharing on just one grouping?”

Tell an agent destructive · confirm first

Remove the public share from grouping {id}.

Make UI grouping {id} private again.

PUT /uigroupby/unsharePublic Remove public shares from several list groupings · Batch public un-share of a UIGroupBy #

Ask an LLM

“Can I switch off public sharing for many groupings at once?”

“Which call batch-removes public access from a list of groupings?”

Tell an agent destructive · confirm first

Remove public sharing from groupings {id}.

Take UI groupings {id} out of public view in one batch.

PUT /uigroupby/disableSystemWideVisibility Hide groupings from everyone system-wide · U IGroup by disable system wide visibility #

Ask an LLM

“How do I stop certain groupings from appearing for all users?”

“Can I turn off system-wide visibility for a set of groupings?”

Tell an agent

Disable system-wide visibility for groupings {groupByIDs}.

Hide groupings {groupByIDs} from every user's list options.

PUT /uigroupby/enableSystemWideVisibility Show groupings to everyone system-wide · U IGroup by enable system wide visibility #

Ask an LLM

“Is there a way to make certain groupings available to all users?”

“Can I turn on system-wide visibility for selected groupings?”

Tell an agent

Enable system-wide visibility for groupings {groupByIDs}.

Make groupings {groupByIDs} visible to every user in the system.

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/adobe-suite:adobe-suite-uigroupby-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

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.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Adobe Workfront Uigroupby API
  version: v19.0
servers:
- url: https://{domain}.my.workfront.com/attask/api/v19.0
  description: Production environment
- url: https://{domain}.preview.workfront.com/attask/api/v19.0
  description: Preview environment
security:
- ApiKeyHeader: []
- SessionIDHeader: []
- AtTaskCookie: []
- WFAuthCookie: []
tags:
- name: Uigroupby
paths:
  /uigroupby/{id}:
    get:
      summary: Get for UIGroupBy
      operationId: getUIGroupBy
      parameters:
      - name: id
        in: path
        description: Object ID
        required: true
        schema:
          type: string
      - name: fields
        in: query
        description: JSON array defining the fields to retrieve
        required: false
        example: '["ID", "name"]'
        content:
          application/json:
            schema:
              type: array
              items:
                type: string
      responses:
        '200':
          description: Great Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: ./UIGroupBy.json
        '422':
          $ref: '#/components/responses/422_UNPROCESSABLE_ENTITY'
        '400':
          $ref: '#/components/responses/400_BAD_REQUEST'
        '429':
          $ref: '#/components/responses/429_TOO_MANY_REQUESTS'
        '403':
          $ref: '#/components/responses/403_FORBIDDEN'
        '401':
          $ref: '#/components/responses/401_UNAUTHORIZED'
        '404':
          $ref: '#/components/responses/404_NOT_FOUND'
        '500':
          $ref: '#/components/responses/500_INTERNAL_SERVER_ERROR'
        '410':
          $ref: '#/components/responses/410_GONE'
      tags:
      - Uigroupby
    put:
      summary: Edit a UIGroupBy
      operationId: editUIGroupBy
      parameters:
      - name: id
        in: path
        description: Object ID
        required: true
        schema:
          type: string
      - name: fields
        in: query
        description: JSON array defining the fields to retrieve
        required: false
        example: '["ID", "name"]'
        content:
          application/json:
            schema:
              type: array
              items:
                type: string
      responses:
        '200':
          description: Great Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: ./UIGroupBy.json
        '422':
          $ref: '#/components/responses/422_UNPROCESSABLE_ENTITY'
        '400':
          $ref: '#/components/responses/400_BAD_REQUEST'
        '429':
          $ref: '#/components/responses/429_TOO_MANY_REQUESTS'
        '403':
          $ref: '#/components/responses/403_FORBIDDEN'
        '401':
          $ref: '#/components/responses/401_UNAUTHORIZED'
        '404':
          $ref: '#/components/responses/404_NOT_FOUND'
        '500':
          $ref: '#/components/responses/500_INTERNAL_SERVER_ERROR'
        '410':
          $ref: '#/components/responses/410_GONE'
      tags:
      - Uigroupby
    delete:
      summary: Delete for UIGroupBy
      operationId: deleteUIGroupBy
      parameters:
      - name: id
        in: path
        description: Object ID
        required: true
        schema:
          type: string
      - name: force
        in: query
        description: force delete flag
        required: false
        schema:
          type: boolean
      responses:
        '200':
          $ref: '#/components/responses/200_OK'
        '422':
          $ref: '#/components/responses/422_UNPROCESSABLE_ENTITY'
        '400':
          $ref: '#/components/responses/400_BAD_REQUEST'
        '429':
          $ref: '#/components/responses/429_TOO_MANY_REQUESTS'
        '403':
          $ref: '#/components/responses/403_FORBIDDEN'
        '401':
          $ref: '#/components/responses/401_UNAUTHORIZED'
        '404':
          $ref: '#/components/responses/404_NOT_FOUND'
        '500':
          $ref: '#/components/responses/500_INTERNAL_SERVER_ERROR'
        '410':
          $ref: '#/components/responses/410_GONE'
      tags:
      - Uigroupby
  /uigroupby:
    get:
      summary: Bulk Get for UIGroupBy
      operationId: getUIGroupBys
      parameters:
      - name: id
        in: query
        description: Object IDs
        required: true
        schema:
          type: string
          example: id1,id2,id3
      - name: fields
        in: query
        description: JSON array defining the fields to retrieve
        required: false
        example: '["ID", "name"]'
        content:
          application/json:
            schema:
              type: array
              items:
                type: string
      responses:
        '200':
          description: Great Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    anyOf:
                    - $ref: ./UIGroupBy.json
                    - type: array
                      items:
                        $ref: ./UIGroupBy.json
        '422':
          $ref: '#/components/responses/422_UNPROCESSABLE_ENTITY'
        '400':
          $ref: '#/components/responses/400_BAD_REQUEST'
        '429':
          $ref: '#/components/responses/429_TOO_MANY_REQUESTS'
        '403':
          $ref: '#/components/responses/403_FORBIDDEN'
        '401':
          $ref: '#/components/responses/401_UNAUTHORIZED'
        '404':
          $ref: '#/components/responses/404_NOT_FOUND'
        '500':
          $ref: '#/components/responses/500_INTERNAL_SERVER_ERROR'
        '410':
          $ref: '#/components/responses/410_GONE'
      tags:
      - Uigroupby
    put:
      summary: Bulk Edit for UIGroupBy
      operationId: editUIGroupBys
      parameters:
      - name: fields
        in: query
        description: JSON array defining the fields to retrieve
        required: false
        example: '["ID", "name"]'
        content:
          application/json:
            schema:
              type: array
              items:
                type: string
      requestBody:
        content:
          application/json:
            schema:
              anyOf:
              - $ref: ./UIGroupBy.json
              - type: array
                items:
                  $ref: ./UIGroupBy.json
      responses:
        '200':
          description: Great Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    anyOf:
                    - $ref: ./UIGroupBy.json
                    - type: array
                      items:
                        $ref: ./UIGroupBy.json
        '422':
          $ref: '#/components/responses/422_UNPROCESSABLE_ENTITY'
        '400':
          $ref: '#/components/responses/400_BAD_REQUEST'
        '429':
          $ref: '#/components/responses/429_TOO_MANY_REQUESTS'
        '403':
          $ref: '#/components/responses/403_FORBIDDEN'
        '401':
          $ref: '#/components/responses/401_UNAUTHORIZED'
        '404':
          $ref: '#/components/responses/404_NOT_FOUND'
        '500':
          $ref: '#/components/responses/500_INTERNAL_SERVER_ERROR'
        '410':
          $ref: '#/components/responses/410_GONE'
      tags:
      - Uigroupby
    post:
      summary: Create or copy a uigroupby
      operationId: addUIGroupBys
      parameters:
      - name: fields
        in: query
        description: JSON array defining the fields to retrieve
        required: false
        example: '["ID", "name"]'
        content:
          application/json:
            schema:
              type: array
              items:
                type: string
      - name: copySourceID
        in: query
        description: Source object ID for copy
        required: false
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              anyOf:
              - $ref: ./UIGroupBy.json
              - type: array
                items:
                  $ref: ./UIGroupBy.json
      responses:
        '200':
          description: Great Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    anyOf:
                    - $ref: ./UIGroupBy.json
                    - type: array
                      items:
                        $ref: ./UIGroupBy.json
        '422':
          $ref: '#/components/responses/422_UNPROCESSABLE_ENTITY'
        '400':
          $ref: '#/components/responses/400_BAD_REQUEST'
        '429':
          $ref: '#/components/responses/429_TOO_MANY_REQUESTS'
        '403':
          $ref: '#/components/responses/403_FORBIDDEN'
        '401':
          $ref: '#/components/responses/401_UNAUTHORIZED'
        '404':
          $ref: '#/components/responses/404_NOT_FOUND'
        '500':
          $ref: '#/components/responses/500_INTERNAL_SERVER_ERROR'
        '410':
          $ref: '#/components/responses/410_GONE'
      tags:
      - Uigroupby
    delete:
      summary: Bulk Delete for UIGroupBy
      operationId: deleteUIGroupBys
      parameters:
      - name: id
        in: query
        description: Object IDs
        required: true
        schema:
          type: string
          example: id1,id2,id3
      - name: force
        in: query
        description: force delete flag
        required: false
        schema:
          type: boolean
      responses:
        '200':
          $ref: '#/components/responses/200_OK'
        '422':
          $ref: '#/components/responses/422_UNPROCESSABLE_ENTITY'
        '400':
          $ref: '#/components/responses/400_BAD_REQUEST'
        '429':
          $ref: '#/components/responses/429_TOO_MANY_REQUESTS'
        '403':
          $ref: '#/components/responses/403_FORBIDDEN'
        '401':
          $ref: '#/components/responses/401_UNAUTHORIZED'
        '404':
          $ref: '#/components/responses/404_NOT_FOUND'
        '500':
          $ref: '#/components/responses/500_INTERNAL_SERVER_ERROR'
        '410':
          $ref: '#/components/responses/410_GONE'
      tags:
      - Uigroupby
  /uigroupby/count:
    get:
      summary: Count of uigroupby
      operationId: countUIGroupBys
      parameters:
      - name: filters
        in: query
        description: JSON representing the filtering conditions
        required: false
        content:
          application/json:
            schema:
              type: object
      responses:
        '200':
          description: Great Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      count:
                        type: integer
                        format: int32
        '422':
          $ref: '#/components/responses/422_UNPROCESSABLE_ENTITY'
        '400':
          $ref: '#/components/responses/400_BAD_REQUEST'
        '429':
          $ref: '#/components/responses/429_TOO_MANY_REQUESTS'
        '403':
          $ref: '#/components/responses/403_FORBIDDEN'
        '401':
          $ref: '#/components/responses/401_UNAUTHORIZED'
        '404':
          $ref: '#/components/responses/404_NOT_FOUND'
        '500':
          $ref: '#/components/responses/500_INTERNAL_SERVER_ERROR'
        '410':
          $ref: '#/components/responses/410_GONE'
      tags:
      - Uigroupby
  /uigroupby/search:
    get:
      summary: Search of uigroupby
      operationId: searchUIGroupBys
      parameters:
      - name: filters
        in: query
        description: JSON representing the filtering conditions
        required: false
        content:
          application/json:
            schema:
              type: object
      - name: fields
        in: query
        description: JSON array defining the fields to retrieve
        required: false
        example: '["ID", "name"]'
        content:
          application/json:
            schema:
              type: array
              items:
                type: string
      - name: listOptions
        in: query
        description: JSON object defining the list options
        required: false
        content:
          application/json:
            schema:
              $ref: ./ListOptions.json
      responses:
        '200':
          description: Great Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: ./UIGroupBy.json
        '422':
          $ref: '#/components/responses/422_UNPROCESSABLE_ENTITY'
        '400':
          $ref: '#/components/responses/400_BAD_REQUEST'
        '429':
          $ref: '#/components/responses/429_TOO_MANY_REQUESTS'
        '403':
          $ref: '#/components/responses/403_FORBIDDEN'
        '401':
          $ref: '#/components/responses/401_UNAUTHORIZED'
        '404':
          $ref: '#/components/responses/404_NOT_FOUND'
        '500':
          $ref: '#/components/responses/500_INTERNAL_SERVER_ERROR'
        '410':
          $ref: '#/components/responses/410_GONE'
      tags:
      - Uigroupby
  /uigroupby/report:
    get:
      summary: Report of uigroupby
      operationId: reportUIGroupBys
      parameters:
      - name: filters
        in: query
        description: JSON representing the filtering conditions
        required: false
        content:
          application/json:
            schema:
              type: object
      - name: listOptions
        in: query
        description: JSON object defining the list options
        required: false
        content:
          application/json:
            schema:
              $ref: ./ListOptions.json
      responses:
        '200':
          description: Great Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
        '422':
          $ref: '#/components/responses/422_UNPROCESSABLE_ENTITY'
        '400':
          $ref: '#/components/responses/400_BAD_REQUEST'
        '429':
          $ref: '#/components/responses/429_TOO_MANY_REQUESTS'
        '403':
          $ref: '#/components/responses/403_FORBIDDEN'
        '401':
          $ref: '#/components/responses/401_UNAUTHORIZED'
        '404':
          $ref: '#/components/responses/404_NOT_FOUND'
        '500':
          $ref: '#/components/responses/500_INTERNAL_SERVER_ERROR'
        '410':
          $ref: '#/components/responses/410_GONE'
      tags:
      - Uigroupby
  /uigroupby/{id}/share:
    put:
      summary: Sharing of a UIGroupBy
      operationId: shareUIGroupBy
      parameters:
      - name: id
        in: path
        description: Object ID
        required: true
        schema:
          type: string
      - name: accessorObjCode
        in: query
        required: true
        schema:
          type: string
      - name: accessorID
        in: query
        required: true
        schema:
          type: string
      - name: coreAction
        in: query
        required: true
        schema:
          type: string
          enum:
          - VIEW
          - EDIT
          - DELETE
      - name: forbiddenActions
        in: query
        schema:
          type: array
          items:
            type: string
            enum:
            - SHARE
            - SHARE_SYSTEMWIDE
      responses:
        '200':
          $ref: '#/components/responses/200_OK'
        '422':
          $ref: '#/components/responses/422_UNPROCESSABLE_ENTITY'
        '400':
          $ref: '#/components/responses/400_BAD_REQUEST'
        '429':
          $ref: '#/components/responses/429_TOO_MANY_REQUESTS'
        '403':
          $ref: '#/components/responses/403_FORBIDDEN'
        '401':
          $ref: '#/components/responses/401_UNAUTHORIZED'
        '404':
          $ref: '#/components/responses/404_NOT_FOUND'
        '500':
          $ref: '#/components/responses/500_INTERNAL_SERVER_ERROR'
        '410':
          $ref: '#/components/responses/410_GONE'
      tags:
      - Uigroupby
  /uigroupby/share:
    put:
      summary: Batch sharing of a UIGroupBy
      operationId: batchShareUIGroupBy
      parameters:
      - name: id
        in: query
        description: Object IDs
        required: true
        schema:
          type: string
          example: id1,id2,id3
      - name: accessorObjCode
        in: query
        required: true
        schema:
          type: string
      - name: accessorID
        in: query
        required: true
        schema:
          type: string
      - name: coreAction
        in: query
        required: true
        schema:
          type: string
          enum:
          - VIEW
          - EDIT
          - DELETE
      - name: forbiddenActions
        in: query
        schema:
          type: array
          items:
            type: string
            enum:
            - SHARE
            - SHARE_SYSTEMWIDE
      responses:
        '200':
          $ref: '#/components/responses/200_OK'
        '422':
          $ref: '#/components/responses/422_UNPROCESSABLE_ENTITY'
        '400':
          $ref: '#/components/responses/400_BAD_REQUEST'
        '429':
          $ref: '#/components/responses/429_TOO_MANY_REQUESTS'
        '403':
          $ref: '#/components/responses/403_FORBIDDEN'
        '401':
          $ref: '#/components/responses/401_UNAUTHORIZED'
        '404':
          $ref: '#/components/responses/404_NOT_FOUND'
        '500':
          $ref: '#/components/responses/500_INTERNAL_SERVER_ERROR'
        '410':
          $ref: '#/components/responses/410_GONE'
      tags:
      - Uigroupby
  /uigroupby/{id}/unshare:
    put:
      summary: Un-sharing of a UIGroupBy
      operationId: unshareUIGroupBy
      parameters:
      - name: id
        in: path
        description: Object ID
        required: true
        schema:
          type: string
      - name: accessorObjCode
        in: query
        required: true
        schema:
          type: string
      - name: accessorID
        in: query
        required: true
        schema:
          type: string
      responses:
        '200':
          $ref: '#/components/responses/200_OK'
        '422':
          $ref: '#/components/responses/422_UNPROCESSABLE_ENTITY'
        '400':
          $ref: '#/components/responses/400_BAD_REQUEST'
        '429':
          $ref: '#/components/responses/429_TOO_MANY_REQUESTS'
        '403':
          $ref: '#/components/responses/403_FORBIDDEN'
        '401':
          $ref: '#/components/responses/401_UNAUTHORIZED'
        '404':
          $ref: '#/components/responses/404_NOT_FOUND'
        '500':
          $ref: '#/components/responses/500_INTERNAL_SERVER_ERROR'
        '410':
          $ref: '#/components/responses/410_GONE'
      tags:
      - Uigroupby
  /uigroupby/unshare:
    put:
      summary: Batch un-sharing of a UIGroupBy
      operationId: batchUnshareUIGroupBy
      parameters:
      - name: id
        in: query
        description: Object IDs
        required: true
        schema:
          type: string
          example: id1,id2,id3
      - name: accessorObjCode
        in: query
        required: true
        schema:
          type: string
      - name: accessorID
        in: query
        required: true
        schema:
          type: string
      responses:
        '200':
          $ref: '#/components/responses/200_OK'
        '422':
          $ref: '#/components/responses/422_UNPROCESSABLE_ENTITY'
        '400':
          $ref: '#/components/responses/400_BAD_REQUEST'
        '429':
          $ref: '#/components/responses/429_TOO_MANY_REQUESTS'
        '403':
          $ref: '#/components/responses/403_FORBIDDEN'
        '401':
          $ref: '#/components/responses/401_UNAUTHORIZED'
        '404':
          $ref: '#/components/responses/404_NOT_FOUND'
        '500':
          $ref: '#/components/responses/500_INTERNAL_SERVER_ERROR'
        '410':
          $ref: '#/components/responses/410_GONE'
      tags:
      - Uigroupby
  /uigroupby/{id}/sharePublic:
    put:
      summary: Public share of a UIGroupBy
      operationId: sharePublicUIGroupBy
      parameters:
      - name: id
        in: path
        description: Object ID
        required: true
        schema:
          type: string
      - name: coreAction
        in: query
        required: true
        schema:
          type: string
          enum:
          - VIEW
          - EDIT
          - DELETE
      - name: forbiddenActions
        in: query
        schema:
          type: array
          items:
            type: string
            enum:
            - SHARE
            - SHARE_SYSTEMWIDE
      responses:
        '200':
          $ref: '#/components/responses/200_OK'
        '422':
          $ref: '#/components/responses/422_UNPROCESSABLE_ENTITY'
        '400':
          $ref: '#/components/responses/400_BAD_REQUEST'
        '429':
          $ref: '#/components/responses/429_TOO_MANY_REQUESTS'
        '403':
          $ref: '#/components/responses/403_FORBIDDEN'
        '401':
          $ref: '#/components/responses/401_UNAUTHORIZED'
        '404':
          $ref: '#/components/responses/404_NOT_FOUND'
        '500':
          $ref: '#/components/responses/500_INTERNAL_SERVER_ERROR'
        '410':
          $ref: '#/components/responses/410_GONE'
      tags:
      - Uigroupby
  /uigroupby/sharePublic:
    put:
      summary: Batch public share of a UIGroupBy
      operationId: batchSharePublicUIGroupBy
      parameters:
      - name: id
        in: query
        description: Object IDs
        required: true
        schema:
          type: string
          example: id1,id2,id3
      - name: coreAction
        in: query
        required: true
        schema:
          type: string
          enum:
          - VIEW
          - EDIT
          - DELETE
      - name: forbiddenActions
        in: query
        schema:
          type: array
          items:
            type: string
            enum:
            - SHARE
            - SHARE_SYSTEMWIDE
      responses:
        '200':
          $ref: '#/components/responses/200_OK'
        '422':
          $ref: '#/components/responses/422_UNPROCESSABLE_ENTITY'
        '400':
          $ref: '#/components/responses/400_BAD_REQUEST'
        '429':
          $ref: '#/components/responses/429_TOO_MANY_REQUESTS'
        '403':
          $ref: '#/components/responses/403_FORBIDDEN'
        '401':
          $ref: '#/components/responses/401_UNAUTHORIZED'
        '404':
          $ref: '#/components/responses/404_NOT_FOUND'
        '500':
          $ref: '#/components/responses/500_INTERNAL_SERVER_ERROR'
        '410':
          $ref: '#/components/responses/410_GONE'
      tags:
      - Uigroupby
  /uigroupby/{id}/unsharePublic:
    put:
      summary: Public un-share of a UIGroupBy
      operationId: unsharePublicUIGroupBy
      parameters:
      - name: id
        in: path
        description: Object ID
        required: true
        schema:
          type: string
      responses:
        '200':
          $ref: '#/components/responses/200_OK'
        '422':
          $ref: '#/components/responses/422_UNPROCESSABLE_ENTITY'
        '400':
          $ref: '#/components/responses/400_BAD_REQUEST'
        '429':
          $ref: '#/components/responses/429_TOO_MANY_REQUESTS'
        '403':
          $ref: '#/components/responses/403_FORBIDDEN'
        '401':
          $ref: '#/components/responses/401_UNAUTHORIZED'
        '404':
          $ref: '#/components/responses/404_NOT_FOUND'
        '500':
          $ref: '#/components/responses/500_INTERNAL_SERVER_ERROR'
        '410':
          $ref: '#/components/responses/410_GONE'
      tags:
      - Uigroupby
  /uigroupby/unsharePublic:
    put:
      summary: Batch public un-share of a UIGroupBy
      operationId: batchUnsharePublicUIGroupBy
      parameters:
      - name: id
        in: query
        description: Object IDs
        required: true
        schema:
          type: string
          example: id1,id2,id3
      responses:
        '200':
          $ref: '#/components/responses/200_OK'
        '422':
          $ref: '#/components/responses/422_UNPROCESSABLE_ENTITY'
        '400':
          $ref: '#/components/responses/400_BAD_REQUEST'
        '429':
          $ref: '#/components/responses/429_TOO_MANY_REQUESTS'
        '403':
          $ref: '#/components/responses/403_FORBIDDEN'
        '401':
          $ref: '#/components/responses/401_UNAUTHORIZED'
        '404':
          $ref: '#/components/responses/404_NOT_FOUND'
        '500':
          $ref: '#/components/responses/500_INTERNAL_SERVER_ERROR'
        '410':
          $ref: '#/components/responses/410_GONE'
      tags:
      - Uigroupby
  /uigroupby/disableSystemWideVisibility:
    summary: disableSystemWideVisibility
    put:
      operationId: uIGroupByDisableSystemWideVisibility
      parameters:
      - name: groupByIDs
        in: query
        description: groupByIDs
        required: false
        schema:
          type: array
          items:
            type: string
      responses:
        '200':
          description: Great Success
        '422':
          $ref: '#/components/responses/422_UNPROCESSABLE_ENTITY'
        '400':
          $ref: '#/components/responses/400_BAD_REQUEST'
        '429':
          $ref: '#/components/responses/429_TOO_MANY_REQUESTS'
        '403':
          $ref: '#/components/responses/403_FORBIDDEN'
        '401':
          $ref: '#/components/responses/401_UNAUTHORIZED'
        '404':
          $ref: '#/components/responses/404_NOT_FOUND'
        '500':
          $ref: '#/components/responses/500_INTERNAL_SERVER_ERROR'
        '410':
          $ref: '#/components/responses/410_GONE'
      tags:
      - Uigroupby
      summary: U IGroup by disable system wide visibility
      x-summary-source: derived
  /uigroupby/enableSystemWideVisibility:
    summary: enableSystemWideVisibility
    put:
      operationId: uIGroupByEnableSystemWideVisibility
      parameters:
      - name: groupByIDs
        in: query
        description: groupByIDs
        required: false
        schema:
          type: array
          items:
            type: string
      responses:
        '200':
          description: Great Success
        '422':
          $ref: '#/components/responses/422_UNPROCESSABLE_ENTITY'
        '400':
          $ref: '#/components/responses/400_BAD_REQUEST'
        '429':
          $ref: '#/components/responses/429_TOO_MANY_REQUESTS'
        '403':
          $ref: '#/components/responses/403_FORBIDDEN'
        '401':
          $ref: '#/components/responses/401_UNAUTHORIZED'
        '404':
          $ref: '#/components/responses/404_NOT_FOUND'
        '500':
          $ref: '#/components/responses/500_INTERNAL_SERVER_ERROR'
        '410':
          $ref: '#/components/responses/410_GONE'
      tags:
      - Uigroupby
      summary: U IGroup by enable system wide visibility
      x-summary-source: derived
components:
  responses:
    200_OK:
      description: Great Success
      content:
        application/json:
          schema:
            type: object
            properties:
              data:
                type: object
                properties:
                  success:
                    type: boolean
    422_UNPROCESSABLE_ENTITY:
      description: The request contains invalid data.
      content:
        application/json:
          schema:
            type: object
            properties:
              error:
                type: object
                properties:
                  class:
                    type: string
                  message:
                    type: string
    404_NOT_FOUND:
      description: The requested resource was not found.
      content:
        application/json:
          schema:
            type: object
            properties:
              error:
                type: object
                properties:
                  class:
                    type: string
                  message:
                    type: string
    429_TOO_MANY_REQUESTS:
      description: Too many concurrent API requests for the given customer.
      content:
        application/json:
          schema:
            type: object
            properties:
              error:
                type: object
                properties:
                  class:
                    type: string
                  message:
                    type: string
    500_INTERNAL_SERVER_ERROR:
      description: An unexpected error occurred.
      content:
        application/json:
          schema:
            type: object
            properties:
              error:
                type: object
                properties:
                  class:
                    type: string
                  message:
                    type: string
    400_BAD_REQUEST:
      description: The operation is not supported.
      content:
        application/json:
          schema:
            type: object
            properties:
              error:
                type: object
                properties:
                  class:
                    type: string
                  message:
                    type: string
    401_UNAUTHORIZED:
      description: The request is not authenticated.
      content:
        application/json:
          schema:
            type: object
            properties:
              error:
                type: object
                properties:
                  class:
                    type: string
                  message:
                    type: string
    410_GONE:
      description: The requested resource is no longer available in this API version.
      content:
        application/json:
          schema:
            type: object
            properties:
              error:
                type: object
                properties:
                  class:
                    type: string
                  message:
                    type: string
    403_FORBIDDEN:
      description: The user does not have permission to perform the operation.
      content:
        application/json:
          schema:
            type: object
            properties:
              error:
                type: object
                properties:
                  class:
                    type: string
                  message:
                    type: string
  securitySchemes:
    SessionIDHeader:
      type: apiKey
      name: sessionID
      in: header
    AtTaskCookie:
      type: apiKey
      name: attask
      in: cookie
    WFAuthCookie:
      type: apiKey
      name: wf-auth
      in: cookie
    ApiKeyHeader:
      type: apiKey
      name: apiKey
      in: header

Adobe Suite Uigroupby API

Operations 20

Documentation

Specifications

Other Resources

Work with this as data

MCP server

Tools for apis

Call it yourself

Get an API key

OpenAPI Specification