IBM Maximo: Dicas de APIs Rest - Revision history

Ebasso: /* URLs */

2024-10-29T00:45:18Z

URLs

← Older revision		Revision as of 00:45, 29 October 2024
Line 18:		Line 18:
	= URLs =		= URLs =

			<big>Important: starting on MAS 8, default context change from '''/maximo/oslc/''' to '''/maximo/api/'''</big>

	* '''/maximo/oas3/maximoapis.html'''-> Maximo RESTful API By Category		* '''/maximo/oas3/maximoapis.html'''-> Maximo RESTful API By Category

Ebasso at 00:43, 29 October 2024

2024-10-29T00:43:51Z

← Older revision		Revision as of 00:43, 29 October 2024
Line 17:		Line 17:

	= URLs =		= URLs =



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


Line 28:		Line 30:


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

	* '''/maximo/~~oslc~~/apimeta''' -> APIs Metadata. Metadata for all the object structures that are API eligible		* '''/maximo/api/apimeta''' -> APIs Metadata. Metadata for all the object structures that are API eligible
	* '''/maximo/~~oslc~~/license''' -> License Keys		* '''/maximo/api/license''' -> License Keys

	* '''/maximo/~~oslc~~/log'''		* '''/maximo/api/log'''
	** [[IBM Maximo: REST API Troubleshooting]]		** [[IBM Maximo: REST API Troubleshooting]]

	* '''/maximo/~~oslc~~/members''' -> Server Members, API for the Maximo Management Interface (MMI).		* '''/maximo/api/members''' -> Server Members, API for the Maximo Management Interface (MMI).
	* '''/maximo/~~oslc~~/members/thisserver''' ->This Server		* '''/maximo/api/members/thisserver''' ->This Server
	* '''/maximo/~~oslc~~/products''' -> Installed Products		* '''/maximo/api/products''' -> Installed Products
	* '''/maximo/~~oslc~~/systeminfo''' -> System Info		* '''/maximo/api/systeminfo''' -> System Info
	* '''/maximo/~~oslc~~/version''' -> Version		* '''/maximo/api/version''' -> Version
	* '''/maximo/~~oslc~~/whoami''' -> Who am I		* '''/maximo/api/whoami''' -> Who am I

	* '''/maximo/~~oslc~~/service/system'''		* '''/maximo/api/service/system'''
	** [[IBM Maximo: REST API working with system properties]]		** [[IBM Maximo: REST API working with system properties]]

	* '''/maximo/~~oslc~~/sp''' -> Service Provider		* '''/maximo/api/sp''' -> Service Provider

	= Object Structures =		= Object Structures =

	* '''/maximo/~~oslc~~/os/MXINTOBJECT'''		* '''/maximo/api/os/MXINTOBJECT'''
	** [[IBM Maximo: Get a list of Object Structures using REST API]]		** [[IBM Maximo: Get a list of Object Structures using REST API]]

	*'''/maximo/~~oslc~~/os/MXOBJECTCFG'''		*'''/maximo/api/os/MXOBJECTCFG'''
	** [[IBM Maximo: Get the attributes of Object Structures using REST API]]		** [[IBM Maximo: Get the attributes of Object Structures using REST API]]

	* '''/maximo/~~oslc~~/jsonschema/<object structure>'''		* '''/maximo/api/jsonschema/<object structure>'''
	** GET jsonschema/mxapiwodetail – gets the schema for the OS, but one object at a time.		** GET jsonschema/mxapiwodetail – gets the schema for the OS, but one object at a time.
	** GET jsonschema/mxapiwodetail?oslc.select=* - gets the full schema		** GET jsonschema/mxapiwodetail?oslc.select=* - gets the full schema
Line 187:		Line 189:
	\| uri/<os>?'''distinct'''=attr1&oslc.where=... \|\| select DISTINCT Exemplo: <br>/os/mxapiasset?distinct=siteid&oslc.where=...		\| uri/<os>?'''distinct'''=attr1&oslc.where=... \|\| select DISTINCT Exemplo: <br>/os/mxapiasset?distinct=siteid&oslc.where=...
	\|-		\|-
	\| uri/<os>?'''attributesearch'''=[CLASSIFICATION] \|\| Classification attribute search. <br>/maximo/~~oslc~~/os/mxapiasset?attributesearch=[SPEED:>=50;AREA;ELEV:=300]		\| uri/<os>?'''attributesearch'''=[CLASSIFICATION] \|\| Classification attribute search. <br>/maximo/api/os/mxapiasset?attributesearch=[SPEED:>=50;AREA;ELEV:=300]
	\|}		\|}

Ebasso: /* Parameters */

2023-05-12T20:34:46Z

Parameters

← Older revision		Revision as of 20:34, 12 May 2023
Line 150:		Line 150:
	"localref": "oslc/os/mxapisr/_SUV.....g0",		"localref": "oslc/os/mxapisr/_SUV.....g0",
	}		}
			\|-
			\| uri?'''inlinedoc'''=1 \|\| getting attachments inline as part of a json document.
	\|-		\|-
	\| uri?'''internalvalues'''=1 \|\| ???		\| uri?'''internalvalues'''=1 \|\| ???
Line 155:		Line 157:
	\| uri?'''addschema'''=1 \|\| ???		\| uri?'''addschema'''=1 \|\| ???
	\|-		\|-
	\| uri?'''~~inlinedoc~~'''=1 \|\| ~~getting attachments inline as part of a json document.~~		\| uri?'''docdownloadid'''=1 \|\| ???
	\|}		\|}

Ebasso: /* Parameters */

2023-05-12T20:33:38Z

Parameters

← Older revision		Revision as of 20:33, 12 May 2023
Line 154:		Line 154:
	\|-		\|-
	\| uri?'''addschema'''=1 \|\| ???		\| uri?'''addschema'''=1 \|\| ???
			\|-
			\| uri?'''inlinedoc'''=1 \|\| getting attachments inline as part of a json document.
	\|}		\|}

Ebasso: /* Parameters */

2023-05-12T15:59:12Z

Parameters

← Older revision		Revision as of 15:59, 12 May 2023
Line 142:		Line 142:
	Default		Default
	{		{
	"localref": "<nowiki>http://server/maximo/</nowiki>oslc/os/~~fic_fvi_api~~/_SUV.....g0",		"localref": "<nowiki>http://server/maximo/</nowiki>oslc/os/mxapisr/_SUV.....g0",
	}		}

Line 148:		Line 148:

	{		{
	"localref": "oslc/os/~~fic_fvi_api~~/_SUV.....g0",		"localref": "oslc/os/mxapisr/_SUV.....g0",
	}		}
	\|-		\|-

Ebasso: /* Parameters */

2023-05-12T15:58:33Z

Parameters

← Older revision		Revision as of 15:58, 12 May 2023
Line 138:		Line 138:
	"locations_collectionref": "...",		"locations_collectionref": "...",
	\|-		\|-
	\| uri?'''relativeuri'''=1 \|\| ~~???~~		\| uri?'''relativeuri'''=1 \|\| returns a relative url instead of the complete url.

			Default
			{
			"localref": "<nowiki>http://server/maximo/</nowiki>oslc/os/fic_fvi_api/_SUV.....g0",
			}

			with '''relativeuri'''=1

			{
			"localref": "oslc/os/fic_fvi_api/_SUV.....g0",
			}
	\|-		\|-
	\| uri?'''internalvalues'''=1 \|\| ???		\| uri?'''internalvalues'''=1 \|\| ???

Ebasso: /* Parameters */

2023-05-12T15:18:10Z

Parameters

← Older revision		Revision as of 15:18, 12 May 2023
Line 108:		Line 108:
	\|-		\|-
	\| uri?'''oslc.where''' \|\| especifica a cláusula WHERE para filtrar o conjunto de resultados de uma consulta. Veja seção [[IBM Maximo: Dicas de APIs Rest#OSLC.WHERE\|OSLC.WHERE]] abaixo.		\| uri?'''oslc.where''' \|\| especifica a cláusula WHERE para filtrar o conjunto de resultados de uma consulta. Veja seção [[IBM Maximo: Dicas de APIs Rest#OSLC.WHERE\|OSLC.WHERE]] abaixo.
			\|-
			\| uri?'''actions'''=name \|\| veja seção [[IBM Maximo: Dicas de APIs Rest#ACTIONS\|ACTIONS]] abaixo
	\|-		\|-
	\| uri?'''oslc.orderBy'''<br>uri?'''oslc.orderBy'''=-attr1,+attr2 \|\| especifica como os resultados de uma consulta são ordenados. O sinal de '''(-)''' para ordem decrescente e sinal de '''(+)''' para ordem crescente, sendo que o sinal + deve estar encoded.		\| uri?'''oslc.orderBy'''<br>uri?'''oslc.orderBy'''=-attr1,+attr2 \|\| especifica como os resultados de uma consulta são ordenados. O sinal de '''(-)''' para ordem decrescente e sinal de '''(+)''' para ordem crescente, sendo que o sinal + deve estar encoded.
Line 149:		Line 151:
	\|-		\|-
	\| uri?'''savedQuery'''=name \|\| Saved query can be SQL, Java, Auto Script. <br>'''/apimeta/<os name>''' lists all saved queries for an Object Structure. <br>savedQuery=KPI:ASSETKPI		\| uri?'''savedQuery'''=name \|\| Saved query can be SQL, Java, Auto Script. <br>'''/apimeta/<os name>''' lists all saved queries for an Object Structure. <br>savedQuery=KPI:ASSETKPI
	\|-
	~~\| uri?'''actions'''=name \|\| veja seção [[IBM Maximo: Dicas de APIs Rest#ACTIONS\|ACTIONS]] abaixo~~
	\|-		\|-
	\| uri?'''tlrange'''=-3M&'''tlattribute'''=dateattr[=indexdate]		\| uri?'''tlrange'''=-3M&'''tlattribute'''=dateattr[=indexdate]

Ebasso: /* Parameters */

2023-05-12T15:17:28Z

Parameters

← Older revision		Revision as of 15:17, 12 May 2023
Line 150:		Line 150:
	\| uri?'''savedQuery'''=name \|\| Saved query can be SQL, Java, Auto Script. <br>'''/apimeta/<os name>''' lists all saved queries for an Object Structure. <br>savedQuery=KPI:ASSETKPI		\| uri?'''savedQuery'''=name \|\| Saved query can be SQL, Java, Auto Script. <br>'''/apimeta/<os name>''' lists all saved queries for an Object Structure. <br>savedQuery=KPI:ASSETKPI
	\|-		\|-
	\| uri?'''actions'''=name \|\| veja seção ~~'''Actions'''~~ abaixo		\| uri?'''actions'''=name \|\| veja seção [[IBM Maximo: Dicas de APIs Rest#ACTIONS\|ACTIONS]] abaixo
	\|-		\|-
	\| uri?'''tlrange'''=-3M&'''tlattribute'''=dateattr[=indexdate]		\| uri?'''tlrange'''=-3M&'''tlattribute'''=dateattr[=indexdate]

Ebasso: /* Parameters */

2023-05-12T15:16:37Z

Parameters

← Older revision		Revision as of 15:16, 12 May 2023
Line 107:		Line 107:
	\| uri?'''oslc.select''' \|\| especifica o conjunto de atributos a serem buscados nas estruturas de objetos, bem como nos objetos relacionados. Veja seção [[IBM Maximo: Dicas de APIs Rest#OSLC.SELECT\|OSLC.SELECT]] abaixo.		\| uri?'''oslc.select''' \|\| especifica o conjunto de atributos a serem buscados nas estruturas de objetos, bem como nos objetos relacionados. Veja seção [[IBM Maximo: Dicas de APIs Rest#OSLC.SELECT\|OSLC.SELECT]] abaixo.
	\|-		\|-
	\| uri?'''oslc.where''' \|\| especifica a cláusula WHERE para filtrar o conjunto de resultados de uma consulta. Veja seção ~~'''oslc~~.~~where'''~~ abaixo.		\| uri?'''oslc.where''' \|\| especifica a cláusula WHERE para filtrar o conjunto de resultados de uma consulta. Veja seção [[IBM Maximo: Dicas de APIs Rest#OSLC.WHERE\|OSLC.WHERE]] abaixo.
	\|-		\|-
	\| uri?'''oslc.orderBy'''<br>uri?'''oslc.orderBy'''=-attr1,+attr2 \|\| especifica como os resultados de uma consulta são ordenados. O sinal de '''(-)''' para ordem decrescente e sinal de '''(+)''' para ordem crescente, sendo que o sinal + deve estar encoded.		\| uri?'''oslc.orderBy'''<br>uri?'''oslc.orderBy'''=-attr1,+attr2 \|\| especifica como os resultados de uma consulta são ordenados. O sinal de '''(-)''' para ordem decrescente e sinal de '''(+)''' para ordem crescente, sendo que o sinal + deve estar encoded.

Ebasso: /* Parameters */

2023-05-12T15:16:07Z

Parameters

← Older revision		Revision as of 15:16, 12 May 2023
Line 105:		Line 105:
	\| uri?'''lean'''=1 \|\| simple notation		\| uri?'''lean'''=1 \|\| simple notation
	\|-		\|-
	\| uri?'''oslc.select''' \|\| especifica o conjunto de atributos a serem buscados nas estruturas de objetos, bem como nos objetos relacionados. Veja seção [[IBM Maximo: Dicas de APIs Rest#os.~~select~~\|os.~~select~~]] abaixo.		\| uri?'''oslc.select''' \|\| especifica o conjunto de atributos a serem buscados nas estruturas de objetos, bem como nos objetos relacionados. Veja seção [[IBM Maximo: Dicas de APIs Rest#OSLC.SELECT\|OSLC.SELECT]] abaixo.
	\|-		\|-
	\| uri?'''oslc.where''' \|\| especifica a cláusula WHERE para filtrar o conjunto de resultados de uma consulta. Veja seção '''oslc.where''' abaixo.		\| uri?'''oslc.where''' \|\| especifica a cláusula WHERE para filtrar o conjunto de resultados de uma consulta. Veja seção '''oslc.where''' abaixo.