IBM Maximo: Dicas de APIs Rest: Difference between revisions

From Wiki
Line 70: Line 70:
! Key !! Description
! Key !! Description
|-
|-
| uri?oslc.select=attr1,attr2,child{attr4,attr5,grandchild{*}} || -  
| oslc.select=attr1,attr2,child{attr4,attr5,grandchild{*}} || -  
|-
|-
| uri?oslc.select=attr1,rel1.attr1,rel.rel2{attr1,attr2},rel.rel3.os {*} ||  
| oslc.select=attr1,rel1.attr1,rel.rel2{attr1,attr2},rel.rel3.os {*} ||  
* rel1.attr1 – 1:1 relations. Results in a JSON Object for property named “rel1”.
* rel1.attr1 – 1:1 relations. Results in a JSON Object for property named “rel1”.
* rel.rel2 {attr1,attr2} – 1:* relations. Results in a JSON Array for property named “rel2”.
* rel.rel2 {attr1,attr2} – 1:* relations. Results in a JSON Array for property named “rel2”.

Revision as of 19:51, 25 January 2022

Arquitetura

Documentação

Artigos de Referência

Technotes

URLs

/maximo/oslc/os/MXINTOBJECT

/maximo/oslc/os/MXOBJECTCFG

Headers

Key Value Description
maxauth base64(username:password) Username and Password encoded as base64
Content-Type application/json Example
Accept application/json Example

Parameters

Key Value Description
uri?lean=1 1 simple notation
uri?oslc.select - Fields to retrieve. Sample: intobjectname,description,rel.maxintobjdetail{objectname,hierarchypath}
uri?oslc.pageSize=N -
  • Stable Paging – good for downloading large data sets.
  • Auto paging – Helps prevent OOM for large dataset requests when no page size specified.
  • Limit Paging – Helps prevent OOM for large dataset requests when high page size specified.
uri?oslc.where application/json

Where clause. Sample:

  • usewith='INTEGRATION'
  • objectname IN ['WORKORDER','WOACTIVITY']
uri?savedQuery=name - Saved query can be SQL, Java, Auto Script. /apimeta/<os name> lists all saved queries for an Object Structure

oslc.select

Key Description
oslc.select=attr1,attr2,child{attr4,attr5,grandchild{*}} -
oslc.select=attr1,rel1.attr1,rel.rel2{attr1,attr2},rel.rel3.os {*}
  • rel1.attr1 – 1:1 relations. Results in a JSON Object for property named “rel1”.
  • rel.rel2 {attr1,attr2} – 1:* relations. Results in a JSON Array for property named “rel2”.
  • rel.rel3.os {*} – 1:* relations. Results in a JSON Array with OS json (for the named os) as array members.

oslc.where

Key Description
uri?oslc.where=attr1 in [“val1”,”val2”] and attr2>200 -
uri?oslc.where=objectname IN ['WORKORDER','WOACTIVITY'] -
uri?oslc.where=usewith='INTEGRATION' -

Ver também