Create system option
post
/fscmRestApi/resources/11.13.18.05/assetSystemOptions
Request
Header Parameters
-
Metadata-Context: string
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".
-
REST-Framework-Version: string
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.
-
Upsert-Mode: string
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
AdjustMxForecastByLastCompleteFlag: boolean
Maximum Length:
1
Indicates whether future due dates will adjust in the maintenance forecast if the last completion option is enabled. -
AllowMergeSuppressAcrossRequirementsFlag: boolean
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. -
AllowMxForecastGenerationOnlineFlag: boolean
Maximum Length:
1
Indicates whether you can generate a forecast for a maintenance program online from the manage programs page. -
AllowMxWoCreationOnlineFlag: boolean
Maximum Length:
1
Indicates whether you can generate a forecast for a maintenance program online from the manage programs page. -
ConsiderOrganizationRelationshipsFlag: boolean
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. -
CustomerAssetValidationOrg: string
Title:
Customer Asset Validation Organization
Maximum Length:255
Name of the customer asset validation organization. The value is read only. -
CustomerAssetValidationOrgId: integer
(int64)
Title:
Customer Asset Validation Organization ID
Value that uniquely identifes the customer asset validation organization. The value is read only. -
DefaultHorizonDaysSchedAssignWO: number
Number of days in the production scheduling horizon.
-
DefaultWOComponentCatSchedAssignWO: integer
(int64)
Default work order components catalog for scheduling and assigning work orders.
-
DefaultWOItemCatSchedAssignWO: integer
(int64)
Default work order items catalog for scheduling and assigning work orders.
-
EnforceResourceAssignmentsFlag: boolean
Maximum Length:
1
Indicates whether resource assignments are required to complete an operation on the report work page. -
EnforceResourceQualificationsFlag: boolean
Maximum Length:
1
Indicates whether resource qualifications are required to complete an operation on the report work page. This field isn't currently used. -
IotAssetAPIURL: string
Title:
IoT Asset API Address
Maximum Length:240
Address for the ap in IoT Asset Monitoring solution. The value is read only. -
IotConfidenceValue: number
Title:
IoT Recommendation Confidence
Value that represents the confidence of a recommendation from the IoT Asset Monitoring solution. The value is read only. -
IotEventCodeAPIURL: string
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. -
IotIncidentAPIURL: string
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. -
IotIntegrationFlag: boolean
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. -
IotLearningDirectorAPIURL: string
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. -
MaximumPercentResourceSchedAssignWO: number
Maximum percentage of a resource that can be scheduled in a day.
-
MxDefaultMasterOrg: string
Title:
Default Master Organization
Maximum Length:255
Name of the default master organization for asset maintenance. The value is read only. -
MxDefaultMasterOrgId: integer
(int64)
Title:
Default Master Organization ID
Value that uniquely identifes the default master organization for asset maintenance. The value is read only. -
SubmitBulkIngestAfterBatchProcessFlag: boolean
Title:
Automatically Submit the Bulk Ingest Job After Batch Processing
Maximum Length:1
Indicates whether the bulk ingest process should be automatically submitted after updates to indexed objects. -
SystemOptionId: integer
(int64)
Value that uniquely identifies the system option. The application creates this value when it creates the system option. The value is read only.
-
UsePSToSchedAssignWOFlag: boolean
Maximum Length:
1
Indicates whether production scheduling is enabled to schedule and assign work orders.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context:
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".
-
REST-Framework-Version:
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.
Root Schema : assetSystemOptions-item-response
Type:
Show Source
object
-
AdjustMxForecastByLastCompleteFlag: boolean
Maximum Length:
1
Indicates whether future due dates will adjust in the maintenance forecast if the last completion option is enabled. -
AllowMergeSuppressAcrossRequirementsFlag: boolean
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. -
AllowMxForecastGenerationOnlineFlag: boolean
Maximum Length:
1
Indicates whether you can generate a forecast for a maintenance program online from the manage programs page. -
AllowMxWoCreationOnlineFlag: boolean
Maximum Length:
1
Indicates whether you can generate a forecast for a maintenance program online from the manage programs page. -
ConsiderOrganizationRelationshipsFlag: boolean
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. -
CreatedBy: string
Read Only:
true
Maximum Length:64
Login username of the user who created the record. -
CreationDate: string
(date-time)
Read Only:
true
Date when the record was created. -
CustomerAssetValidationOrg: string
Title:
Customer Asset Validation Organization
Maximum Length:255
Name of the customer asset validation organization. The value is read only. -
CustomerAssetValidationOrgId: integer
(int64)
Title:
Customer Asset Validation Organization ID
Value that uniquely identifes the customer asset validation organization. The value is read only. -
DefaultHorizonDaysSchedAssignWO: number
Number of days in the production scheduling horizon.
-
DefaultWOComponentCatSchedAssignWO: integer
(int64)
Default work order components catalog for scheduling and assigning work orders.
-
DefaultWOItemCatSchedAssignWO: integer
(int64)
Default work order items catalog for scheduling and assigning work orders.
-
EnforceResourceAssignmentsFlag: boolean
Maximum Length:
1
Indicates whether resource assignments are required to complete an operation on the report work page. -
EnforceResourceQualificationsFlag: boolean
Maximum Length:
1
Indicates whether resource qualifications are required to complete an operation on the report work page. This field isn't currently used. -
IotAssetAPIURL: string
Title:
IoT Asset API Address
Maximum Length:240
Address for the ap in IoT Asset Monitoring solution. The value is read only. -
IotConfidenceValue: number
Title:
IoT Recommendation Confidence
Value that represents the confidence of a recommendation from the IoT Asset Monitoring solution. The value is read only. -
IotEventCodeAPIURL: string
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. -
IotIncidentAPIURL: string
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. -
IotIntegrationFlag: boolean
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. -
IotLearningDirectorAPIURL: string
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. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date when the record was updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
Login user name of the user who updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MaximumPercentResourceSchedAssignWO: number
Maximum percentage of a resource that can be scheduled in a day.
-
MxDefaultMasterOrg: string
Title:
Default Master Organization
Maximum Length:255
Name of the default master organization for asset maintenance. The value is read only. -
MxDefaultMasterOrgId: integer
(int64)
Title:
Default Master Organization ID
Value that uniquely identifes the default master organization for asset maintenance. The value is read only. -
SubmitBulkIngestAfterBatchProcessFlag: boolean
Title:
Automatically Submit the Bulk Ingest Job After Batch Processing
Maximum Length:1
Indicates whether the bulk ingest process should be automatically submitted after updates to indexed objects. -
SystemOptionId: integer
(int64)
Value that uniquely identifies the system option. The application creates this value when it creates the system option. The value is read only.
-
UsePSToSchedAssignWOFlag: boolean
Maximum Length:
1
Indicates whether production scheduling is enabled to schedule and assign work orders.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.