Rest Api Cheat Sheet



Api

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.

The Salesforce Reports and Dashboards REST API gives programmatic access to integrate reporting into a wide variety of applications. You can get report metadata, run reports synchronously or asynchronously to get summary data with or without details, filter report results on the fly, get a list of asynchronous runs for a report and results of. Elasticsearch API cheatsheet for developers with copy and paste example for the most useful APIs 🔎 Elasticsearch 1.x 2.x 5.x 6.x 7.x Cheatsheet 🔍 All the API endpoints and pro-tips you always forgot about in. Have a look at input validation cheat sheet for comprehensive explanation. Use a secure parser for parsing the incoming messages. If you are using XML, make sure to use a parser that is not vulnerable to XXEProcessing) and similar attacks. Validate content types. A REST request or response body should match the intended content type in the header. REST Security Cheat Sheet¶ Introduction¶. REST (or REpresentational State Transfer) is an architectural style first described in Roy Fielding's Ph.D. Dissertation on Architectural Styles and the Design of Network-based Software Architectures. It evolved as Fielding wrote the HTTP/1.1 and URI specs and has been proven to be well-suited for developing distributed hypermedia applications.

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

Download free open mdb access database. 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

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

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

RQM REST API (Reporting API)

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

Details here.

Every reST (.rst) file should use these underlining styles. In reST, you can use differentstyles in any order you want. These are our conventions for TYPO3 documentation.

  • line 1-3: This is the doc title. Every .rst file should have one.

  • line 7: header label. This can be used for cross-referencing to this section:

  • 9-10: Header level 1

  • etc.

See also

External links¶

method 1:

(with one or two underscores at the end, if in doubt, use two)

Rest Api Cheat Sheet Cheat

method 2: “External Hyperlink Targets”:

This may be more convenient if you use a link several times.

Cross references¶

When linking within docs.typo3.org, you should use this method of cross-referencing.

Use it to link to a section in this manual:

A section with the label intersphinx must exist! It is placed before the header:

Or, when cross-referencing to other manuals:

When you are linking to another manual, make sure theshortcut (here: “h2document”) is included in Settings.cfg:

We use the same conventions for naming the shortcuts in Settings.cfg,see Settings.cfg. Not used manuals are commented out.

Tip

This is a cool feature, where reST & Sphinx shines: Even when a section ismoved to another page (which effectively changes the URL), the link will still work!

Link to: Same manualLink to: Other manual
Explicit anchor text:ref:`CrossReferencing<intersphinx>`:ref:`CrossReferencing<t3docwrite:intersphinx>`
Automatic anchor text:ref:`intersphinx`:ref:`t3docwrite:intersphinx`

See also

  • Link targets (labels)

To create a bullet list:

  • add a blank line before and after the list
  • indent the list item text by 3 spaces - including the item sign
  • to create a nested list:
    • indent the items by 3 spaces (left-align with parent item text)
    • apply rules of parent list (blank lines, item text indentation, .)

More text.

To create a numbered list:

  1. add a blank line before and after the list
  2. indent the list item text by 3 spaces - including the item sign
  3. to create a nested list:
    1. indent the items by 3 spaces (left-align with parent item text)
    2. apply rules of parent list (blank lines, item text indentation, .)

More text.

Important

Use syntactically correct code in your code blocks.

Code block directive¶

How it looks:

Source:

This uses the directive “code-block” (line 1)

Important

Make sure to indent correctly. The lines of the code-block (line 3+)must be indented (3 spaces).

Literal Block (::

Or, use the literal block markup :: if PHP is already set as defaultwith highlight directive and you want to combine a text with a colon,followed by the code block.

How it looks:

Assign the variable a:

Source:

For inline code or for other semantic markup of special texts, use text roles.

Examples:

  1. $result=$a+23; (PHP snippet)
  2. lib.hello.value=HelloWorld! (TypoScript snippets)
  3. /etc/passwd (file)
  4. ctrl + s (keyboard strokes)

Source (inline text with text roles):

Normal text, bold text and italic text.

Source (bold & italic):

Source (image):

Another example:

Rest

See also

Source (YouTube):

This is often used, for a Quick Start section, involving a few numbered steps:

With Big Numbers¶

This is an example with a code block (::) embedded in the sections.

Source:

How it looks:

  1. Embed an image

    Source:

  2. Two

    Do something else …

With Big Numbers XXL¶

Source:

How it looks:

  1. Embed an image

    Source:

  2. Two

    Do something else …

Tips, hints, important (Admonitions)¶

Tip

Rest Api Cheat Sheet Free

To look at the reST source of this rendered page, scroll to the bottomand click on “View page source”. Device driver windows vista.

Source (tip):
Rest api security options

Diagrams

Source:

Owasp Rest Security Cheat Sheet

How it looks: