Api Cheat Sheet



Edit

OverAPI.com is a site collecting all the cheatsheets,all! RESTful API cheatsheet. Code Description; 200 OK: Successful get, patch (return a JSON object) 201 Created: Successful post (return a JSON object) 202. Maintained by Vue.js Tips Hosted by MarozedVue.js Tips Hosted by Marozed. APPLIES TO: SQL API The Azure Cosmos DB query cheat sheets help you quickly write queries for your data by displaying common database queries, operations, functions, and operators in easy-to-print PDF reference sheets. The cheat sheets include reference information for the SQL, MongoDB, Table, and Gremlin APIs. Elasticsearch Cheat Sheet for developers. Elasticsearch API cheatsheet for developers with copy and paste example for the most useful APIs. 🔎 Elasticsearch 1.x2.x5.x6.x7.xCheatsheet 🔍. All the API endpoints and pro-tips you always forgot about in one place!

Here are all the functions you will be using inside your EntityCrudController's setup() method, grouped by the operation you will most likely use them for.

Operations

ListEntries

Columns

Methods: addColumn(), addColumns(), modifyColumn(), removeColumn(), removeColumns(), setColumnDetails(), setColumnsDetails(), setColumns(), beforeColumn(), afterColumn(), makeFirstColumn()

Buttons

Methods: addButton(), addButtonFromModelFunction(), addButtonFromView(), removeButton(), removeButtonFromStack()

Filters

Methods: addFilter(), modifyFilter(), removeFilter(), removeAllFilters(), filters()

Details Row

Methods: enableDetailsRow(), disableDetailsRow()

Export Buttons

Methods: enableExportButtons()

Responsive Table

Methods: enableResponsiveTable(), disableResponsiveTable()

Persistent Table

Methods: enablePersistenTable(), disablePersistenTable()

Page Length

Methods: setDetaultPageLength(), setPageLengthMenu()

NOTE: Do not use 0 as a key, if you want to represent 'ALL' use -1 instead.

Cheat

Actions Column

Dom api cheat sheet

Methods: setActionColumnPriority()

Custom / Advanced Queries

Methods: addClause(), groupBy(), limit(), orderBy()

Show

Use the same Columns API as for the ListEntries operation, but inside your show() method.

Create & Update Operations

Methods: addField(), addFields(), modifyField(), modifyFields(), removeField(), removeFields(), removeAllFields(), beforeField(), afterField()

Reorder

Methods: enableReorder(), disableReorder(), isReorderEnabled()

Revisions

All Operations

Cheat

Methods: allowAccess(), denyAccess(), hasAccess(), hasAccessOrFail(), hasAccessToAll(), hasAccessToAny(), setShowView(), setEditView(), setCreateView(), setListView(), setReorderView(), setRevisionsView, setRevisionsTimelineView(), setDetailsRowView(), getEntry(), getFields(), getColumns(), getCurrentEntry(), getTitle(), setTitle(), getHeading(), setHeading(), getSubheading(), setSubheading(),

Inspired by Stephane Leroy Cheat Sheet about RQM Resources I will present my findings about RTC REST APIs. This is “work in progress” I will extend the Post as needed.

Every time you request a resource don’t forget to include the following headers.

NameValue
OSLC-Core-Version2.0
Acceptapplication/xml
Content-Typeapplication/rdf+xml

RTC REST API

Create the URL with the CLM Server name and the URL Snippet from the table below like https://jazzserver.ibm.com:9443/cm/process/project-areas

ACTIONURL SNIPPET
Show all Servicesccm/service > 302 Redirect to

ccm/service/com.ibm.team.repository.service.ITeamServerStatusContentService/

Service Provider Catalog ccm/oslc/workitems/catalog

DNG REST API

Create the URL with the CLM Server name and the URL Snippet from the table below like https://jazzserver.ibm.com:9443/cm/process/project-areas

Apa Cheat Sheet Owl

ACTIONURL SNIPPET
Show all Servicesrm/service > 302 Redirect to

rm/service/com.ibm.team.repository.service.ITeamServerStatusContentService/

RTC Process REST API (link)

Create the URL with the CLM Server name and the URL Snippet from the table below like https://jazzserver.ibm.com:9443/cm/process/project-areas

ActionURL Snippet
Get RTC Project Areasccm/process/project-areas
Service Provider Links collectionccm/process/project-areas/_qZ1dsu9YEeOb7eLwSED0KA/links
Service Provider Catalog ccm/oslc/workitems/catalog
Api Cheat Sheet

DNG Process REST API (no documentation found, put it seems similar to RTC)

ActionURL Snippet
Get DNG Project Areasrm/process/project-areas
Service Provider Links collectionrm/process/project-areas/_7jWhMl3qEeSt–_ZBwtxhQ/links

RTC Service SOAP API

Create the URL with the CLM Server name and the URL Snippet from the table below like https://jazzserver.ibm.com:9443/cm/process/project-areas

ActionURL Snippet
Get al RTC Project Areasccm/service/com.ibm.team.process.internal.service.web.IProcessWebUIService/allProjectAreas?hideArchivedProjects=true
Get Queries of a certain PA ccm/service/com.ibm.team.workitem.common.internal.rest.IQueryRestService/scopedQueries?scope=3&includeCount=false&includeParentScopes=true&projectAreaItemId=_0H5NsGmGEeSmHamBorgNJw&suppressCrossRepoQueries=false

Api 14c Cheat Sheet

RQM REST API (Reporting API)

To my surprise is the RQM Reporting API “CRUD” able.

Api Cheat Sheet

Details here.