IBM Maximo: Dicas de APIs Rest: Difference between revisions

From Wiki
Line 44: Line 44:
{| class="wikitable sortable"
{| class="wikitable sortable"
|-
|-
! Key !! Value!! Description
! Key !! Description
|-
|-
| uri?lean=1 || 1 || simple notation
| uri?'''lean'''=1 || simple notation
|-
|-
| uri?oslc.select || - || Fields to retrieve. Sample: intobjectname,description,rel.maxintobjdetail{objectname,hierarchypath}
| uri?'''oslc.select''' || Fields to retrieve. Sample: intobjectname,description,rel.maxintobjdetail{objectname,hierarchypath}
|-
|-
| uri?oslc.pageSize=N || - 
| uri?'''oslc.pageSize'''=N  
||
||
* Stable Paging – good for downloading large data sets.
* Stable Paging – good for downloading large data sets.
Line 56: Line 56:
* Limit Paging – Helps prevent OOM for large dataset requests when high page size specified.
* Limit Paging – Helps prevent OOM for large dataset requests when high page size specified.
|-
|-
| uri?oslc.where || application/json
| uri?'''oslc.where'''
||
||
Where clause. Sample:
Where clause. Sample:
Line 62: Line 62:
* objectname IN ['WORKORDER','WOACTIVITY']
* 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
| uri?'''savedQuery'''=name || Saved query can be SQL, Java, Auto Script. /apimeta/<os name> lists all saved queries for an Object Structure
|-
| uri?'''tlrange'''=-3M&'''tlattribute'''=dateattr[=indexdate]
||
* tlattribute - the timeline attribute to which the range applies. If no
index data specified, its defaulted to the current date-time.
* tlrange – The range in Months (M)/Years (Y)/ Week (W)/ Days (D)/ Hour (h)/Min (m)/ Seconds (s). + and - indicates whether to add or substract from tlattribute date-time.
|}
|}
uri?tlrange=-3M&tlattribute=dateattr[=indexdate]


=== oslc.select  ===
=== oslc.select  ===

Revision as of 19:53, 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 Description
uri?lean=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

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
uri?tlrange=-3M&tlattribute=dateattr[=indexdate]
  • tlattribute - the timeline attribute to which the range applies. If no

index data specified, its defaulted to the current date-time.

  • tlrange – The range in Months (M)/Years (Y)/ Week (W)/ Days (D)/ Hour (h)/Min (m)/ Seconds (s). + and - indicates whether to add or substract from tlattribute date-time.
uri?tlrange=-3M&tlattribute=dateattr[=indexdate]

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

Retrieved from "https://ebasso.net/wiki/index.php?title=IBM_Maximo:_Dicas_de_APIs_Rest&oldid=7369"