Object structures for Work Centers
Object structures are included in the security group templates for Work Centers and tools. To enable access to Work Centers or tools, you must create a security group for each Work Centers and tool and apply a template to the security group.
An object structure enables access to data in Maximo® Asset Management by using HTTP REST API. The data can be protected by an object structure security mechanism that is available in Maximo Asset Management.
An object structure that is protected by security restricts access to the data for a specific group of users that are part of one or more security groups. When object structure security is enabled, these users have access to all persistent attributes that are associated with the object structure data, in addition to data that is persisted to the database. This behavior is the default behavior for any object structure in Maximo Asset Management.
If you want to change this behavior, then you can enforce additional security by implementing data restrictions. Any attribute that you do not want to be visible to certain groups of users can be restricted. For more information about configuring data security, see Specifying data restrictions for security groups.
Business Analysis Work Center
The following table lists the object structures that are in the security group template for the Business Analysis Work Center:
| Object structure name | Description | Access required |
|---|---|---|
| MXAPIASSET | APIs asset definition. | Read |
| MXAPIENDPOINT | Endpoint definition. | Read |
| MXAPIKPIMAIN | UI definition of the KPIMAIN table. | Read |
| MXAPIMAPMANAGER | APIs Map Manager object structure. | Read |
| MXAPIPERUSER | UI person user definition. | Read, Save |
| MXAPIPO | UI purchase orders definition. | Read, Save |
| MXAPIWO | UI work order definition. | Read |
| MXAPIWOSDATASET | Data set list for work orders. | Read |
| MXAPIEXTLINK | UI definition to retrieve information from an external link. | Not applicable, read by default |
Work Supervision Work Center
The following table lists the object structures that are in the security group template for the Work Supervision Work Center:
| Object structure name | Description | Access required |
|---|---|---|
| MXAPIASSIGNMENT | UI assignment definition. | Read |
| MXAPIKPIMAIN | UI definition of the KPIMAIN table. | Read |
| MXAPILABOR | UI definition of the Labor table. | Read |
| MXAPIPERUSER | UI definition of the Person table. | Read |
| MXAPIWMASSIGNMENT | UI work management assignment definition. | Read |
| MXAPIWODETAIL | APIs for work order that have plans and reservations definition. Signature options are Approve, Cancel, Close, Change status. |
Read, Save, Change Status. |
| MXAPIEXTLINK | UI definition to retrieve information from an external link. | Not applicable, read by default |
Work Execution Work Center
The following table lists the object structures that are in the security group template for the Work Execution Work Center:
| Object structure name | Description | Access required |
|---|---|---|
| MXAPIASSIGNMENT | UI assignment definition. | Read |
| MXAPIKPIMAIN | UI definition of the KPIMAIN table. | Read |
| MXAPILABOR | UI definition of the Labor table. | Read |
| MXAPIPERUSER | UI definition of the Person table. | Read |
| MXAPIWMASSIGNMENT | UI work management assignment definition. | Read |
| MXAPIWODETAIL | APIs for work order that have plans and reservations definition. Signature options are Approve, Cancel, Close, Complete, Change status. |
Read, Save, Change Status. |
| MXAPIEXTLINK | UI definition to retrieve information from an external link. | Not applicable, read by default |
Data Set Designer
Reporting must be correctly configured to use the Data Set Designer. The following table lists the object structures that are in the security group template for the Data Set Designer tool:
| Object structure name | Description | Access required |
|---|---|---|
| MXAPIANALYTICDATASET | APIs to analyze data set list. | Read, Save, Insert |
| MXAPIPERUSER | UI definition of the Person table. | Read, Save |
| MXAPIWOSDATASET | Data set list for work orders. | Read |
| MXAPIEXTLINK | UI definition to retrieve information from an external link. | Not applicable, read by default |
Service Requests
The following table lists the object structures that are in the security group template for the Service Requests tool:
| Object structure name | Description | Access required |
|---|---|---|
| MXAPIASSET | APIs asset definition. | Read |
| MXAPIBOOKMARK | UI bookmark definition. | Read, Delete |
| MXAPIDOMAIN | APIs domain definition. | Read |
| MXAPILOCANCESTOR | APIs location ancestor definition. | Read |
| MXAPILOCATION | APIs location definition. | Read |
| MXAPINOTIFICATION | APIs notification definition. | Read, Save, Delete, Insert |
| MXAPIPERUSER | UI definition of the Person table. | Read |
| MXAPISR | APIs service request. | Read, Save, Delete, Insert |
| MXAPITKCLASS | UI ticket class definition. | Read |
| MXAPITKTEMPLATE | UI ticket template definition. | Read |
| MXAPIWORKLOG | UI work log definition. | Read, Save |
| MXAPIEXTLINK | UI definition to retrieve information from an external link. | Not applicable, read by default |
Manage Inspection Forms
The following table lists the object structures that are in the security group template for the Manage Inspection Forms tool:
| Object structure name | Description | Access required |
|---|---|---|
| MXAPIDOCTYPE | Object structure to retrieve doctypes data. | Read |
| MXAPIDOMAIN | APIs domain definition. | Read |
| MXAPIINSPFORM | UI definition to retrieve inspection forms. | Delete, Insert, Read, Save |
| MXAPIINSPFORMSTATUS | Object structure to retrieve inspection form status history. | Delete, Insert, Read, Save |
| MXAPIMETER | Object Structure to retrieve meter data. | Read |
| MXAPIPERUSER | UI definition of the Person table | Read |
| MXAPIEXTLINK | UI definition to retrieve information from an external link. | Not applicable, read by default |
Conduct an Inspection
The following table lists the object structures that are in the security group template for the Conduct an Inspection tool:
| Object structure name | Description | Access required |
|---|---|---|
| MXAPIASSET | APIs asset definition. | Read |
| MXAPIASSETMETER | APIs for asset meter definition. | Read |
| MXAPIDOCTYPE | Object structure to retrieve doctypes data. | Read |
| MXAPIDOMAIN | APIs domain definition. | Read |
| MXAPIINSPFORM | UI definition to retrieve inspection forms. | Read |
| MXAPIINSPRESULT | UI definition to retrieve inspection results. Signature option is Change Status. |
Delete, Insert, Read, Save |
| MXAPILOCATIONMETER | Object structure for location meters. | Read |
| MXAPIMETER | Object structure to retrieve meter data. | Read |
| MXAPIOPERLOC | APIs for operation definition location. | Read |
| MXAPIPERUSER | UI definition of the Person table. | Read |
| MXAPIWODETAIL | API's work order withplans and reservations definition. | Insert, Read, Save |
| MXAPIEXTLINK | UI definition to retrieve information from an external link. | Not applicable, read by default |