1. REST API for Oracle Fusion Cloud SCM
  2. Tasks
  3. Manufacturing
  4. Asset System Options

Get one system option

get

/fscmRestApi/resources/11.13.18.05/assetSystemOptions/{SystemOptionId}

Request

Path Parameters
Query Parameters
  • This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2

    Format: <attr1>=<val1>,<attr2>=<value2>
  • When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
  • This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.

    Format: ?fields=Attribute1,Attribute2

    Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
  • This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>

    Example:
    self,canonical
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
Header Parameters
  • If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Body ()
Root Schema : assetSystemOptions-item-response
Type: object
Show Source
  • Title: Allow Suppress and Merge Across Work Requirements in a Maintenance Program
    Maximum Length: 1
    Indicates if merge and suppress options are allowed across work requirements or not in a maintenance program.
  • Title: Consider Organization Relationships When Creating Maintenance Work Orders
    Maximum Length: 1
    Indicates if organization relationships will be considered when maintenance work orders are created.
  • Read Only: true
    Maximum Length: 64
    Login username of the user who created the record.
  • Read Only: true
    Date when the record was created.
  • Title: Customer Asset Validation Organization
    Read Only: true
    Maximum Length: 255
    Name of the customer asset validation organization. The value is read only.
  • Title: Customer Asset Validation Organization ID
    Value that uniquely identifes the customer asset validation organization. The value is read only.
  • Title: IoT Asset API Address
    Maximum Length: 240
    Address for the ap in IoT Asset Monitoring solution. The value is read only.
  • Title: IoT Recommendation Confidence
    Value that represents the confidence of a recommendation from the IoT Asset Monitoring solution. The value is read only.
  • Title: IoT Event Code API Address
    Maximum Length: 240
    Address for the event codes rest api in the IoT Asset Monitoring solution. The value is read only.
  • Title: IoT Incident API Address
    Maximum Length: 240
    Address for the incidents rest api in the IoT Asset Monitoring solution. The value is read only.
  • Title: Enable IoT
    Maximum Length: 1
    Indicates if the integration to the IoT Asset Monitoring solution is enabled or not. The value is read only.
  • Title: IoT Learning Director API Address
    Maximum Length: 240
    Address for the learning director rest api in the IoT Asset Monitoring solution. The value is read only.
  • Read Only: true
    Date when the record was updated.
  • Read Only: true
    Maximum Length: 64
    Login user name of the user who updated the record.
  • Links
  • Title: Default Master Organization
    Read Only: true
    Maximum Length: 255
    Name of the default master organization for asset maintenance. The value is read only.
  • Title: Default Master Organization ID
    Value that uniquely identifes the default master organization for asset maintenance. The value is read only.
  • Value that uniquely identifies the system option. The application creates this value when it creates the system option. The value is read only.
Back to Top

Examples

This example describes how to get a single response for asset system options.

Example cURL Command

Use the following cURL command to submit a request on the REST resource:

curl -u username:password "https://servername/fscmRestApi/resources/version/assetSystemOptions/SystemOptionId"

For example:

curl -u username:password "https://servername/fscmRestApi/resources/version/assetSystemOptions/100103417212763"

Example Response Body

The following example includes the contents of the response body in JSON format: 
{
    "items": [
        {
            "SystemOptionId": 100103417212763,
            "IotIntegrationFlag": false,
            "IotConfidenceValue": null,
            "IotAssetAPIURL": "privateclientapi/v2/integration/mc/importAssets",
            "IotEventCodeAPIURL": "privateclientapi/v2/integration/mc/eventCodes",
            "IotLearningDirectorAPIURL": "privateclientapi/v2/learning/analyticsWorkflow",
            "IotIncidentAPIURL": "clientapi/v2/incidents",
            "MxDefaultMasterOrgId": 123456789,
            "MxDefaultMasterOrg": "ORG123",
            "CustomerAssetValidationOrgId": null,
            "CustomerAssetValidationOrg": null,
            "AllowMergeSuppressAcrossRequirementsFlag": true,
            "CreatedBy": "USER_123ABC",
            "CreationDate": "2023-07-18T21:43:30+00:00",
            "LastUpdateDate": "2023-08-03T06:31:13+00:00",
            "LastUpdatedBy": "USER_123ABC",
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername/fscmRestApi/resources/version/assetSystemOptions/100103417212763",
                    "name": "assetSystemOptions",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000878"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername/fscmRestApi/resources/version/assetSystemOptions/100103417212763",
                    "name": "assetSystemOptions",
                    "kind": "item"
                }
            ]
        }
    ],
    "count": 1,
    "hasMore": false,
    "limit": 25,
    "offset": 0,
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/version/assetSystemOptions",
            "name": "assetSystemOptions",
            "kind": "collection"
        }
    ]
}
Back to Top