IBM Maximo: Dicas de APIs Rest: Difference between revisions

From Wiki
Line 18: Line 18:


= URLs =
= URLs =
* '''/maximo/oas3/api.html'''-> Maximo RESTful API - Swagger
* '''/maximo/oslc/oas?includeactions=1'''->  Maximo RESTful API - Swagger  include actions


* '''/maximo/oslc/''' -> Default uri os oslc
* '''/maximo/oslc/''' -> Default uri os oslc

Revision as of 20:36, 25 January 2022

Arquitetura

Documentação

Artigos de Referência

Technotes

URLs

  • /maximo/oas3/api.html-> Maximo RESTful API - Swagger
  • /maximo/oslc/oas?includeactions=1-> Maximo RESTful API - Swagger include actions
  • /maximo/oslc/ -> Default uri os oslc
  • /maximo/oslc/apimeta -> APIs Metadata
  • /maximo/oslc/license -> License Keys
  • /maximo/oslc/members -> Server Members
  • /maximo/oslc/members/thisserver ->This Server
  • /maximo/oslc/products -> Installed Products
  • /maximo/oslc/systeminfo -> System Info
  • /maximo/oslc/version -> Version
  • /maximo/oslc/whoami -> Who am I
  • /maximo/oslc/sp -> Service Provider


/maximo/oslc/os/MXINTOBJECT

/maximo/oslc/os/MXOBJECTCFG

jsonschema/ 

GET jsonschema/mxapiwodetail – gets the schema for the OS, but one object at a time.
GET jsonschema/mxapiwodetail?oslc.select=* - gets the full schema

Support child object schemas GET jsonschema/mxapiasset/assetmeter
Support schema views - Get jsonschema/mxapiasset?oslc.select=attr1,rel1.attr2
Mbo schemas GET jsonmboschemas/asset

Headers

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

Parameters

Key Description
uri?lean=1 simple notation
uri?oslc.select Fields to retrieve. Sample: intobjectname,description,rel.maxintobjdetail{objectname,hierarchypath}
uri?oslc.paging=true -
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.
POST uri?interactive=1 Handling Yes/No/Cancel interactions
GET uri?gbcols=status,count.*,sum.attr1&gbsortby=-count.*

Aggregation APIs. Also supports date histograms – yearly/quarterly/monthly/weekly. For example GET /mxapiwodetail? gbcols=year$statusdate,quarter$statusdate,sum.actlabhrs

uri?_format=xml

uri?_format=csv

type of output


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=7382"