Create one definition

post

/fscmRestApi/resources/11.13.18.05/maintenancePrograms/{MaintenanceProgramId}/child/workRequirements/{WorkRequirementId}/child/workDefinitions

Request

Path Parameters
  • Value that uniquely identifies a maintenance program. The application generates this value and is referenced during retrieval and update of a maintenance program definition. This value can't be updated after its creation.
  • Value that uniquely identifies the work requirement. The application generates this value when it creates a new requirement. This value is referenced during retrieval and update of a work requirement. This value can't be updated after its creation.
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.
  • 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
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
  • Maximum Length: 1
    Default Value: false
    Value that indicates whether a work definition is disabled or not. Contains one of the following values: true or false. If true, then the work definition is disabled. If false, then the work definition isn't disabled. If there are work orders created for the work requirement, this attribute is set to true when deleting a work definition.
  • Title: Due at Cycle Interval
    Value that specifies the interval in a cycle at which the work definition is due. The value is required if the repeats-in-cycle mark is true. This value can be updated after its creation.
  • Name of the work definition. Either work definition name or ID can be used during a POST, PATCH, or GET action. This value can only be updated after its creation until work orders have been created.
  • Title: Repeats in Cycle
    Maximum Length: 1
    Contains one of the following values: true or false. If true, then the work definition repeats in the cycle at the interval value. If false, then the work definition doesn't repeat but is due only at the interval value. The default value is true. This value can be updated after its creation.
  • Value that uniquely identifies the work definition. Either work definition name or ID can be used during a POST, PATCH, or GET action. This value can only be updated after its creation until work orders have been created.
  • Value that uniquely identifies a work definition within a work requirement. The application generates this value when a work definition is associated with a work requirement. This value can't be updated after its creation.
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 : maintenancePrograms-workRequirements-workDefinitions-item-response
Type: object
Show Source
  • Maximum Length: 1
    Default Value: false
    Value that indicates whether a work definition is disabled or not. Contains one of the following values: true or false. If true, then the work definition is disabled. If false, then the work definition isn't disabled. If there are work orders created for the work requirement, this attribute is set to true when deleting a work definition.
  • Title: Due at Cycle Interval
    Value that specifies the interval in a cycle at which the work definition is due. The value is required if the repeats-in-cycle mark is true. This value can be updated after its creation.
  • Links
  • Name of the work definition. Either work definition name or ID can be used during a POST, PATCH, or GET action. This value can only be updated after its creation until work orders have been created.
  • Title: Repeats in Cycle
    Maximum Length: 1
    Contains one of the following values: true or false. If true, then the work definition repeats in the cycle at the interval value. If false, then the work definition doesn't repeat but is due only at the interval value. The default value is true. This value can be updated after its creation.
  • Value that uniquely identifies the work definition. Either work definition name or ID can be used during a POST, PATCH, or GET action. This value can only be updated after its creation until work orders have been created.
  • Read Only: true
    Value that uniquely identifies the name of a work definition within a work requirement. The application generates this value when a work definition is created.
  • Value that uniquely identifies a work definition within a work requirement. The application generates this value when a work definition is associated with a work requirement. This value can't be updated after its creation.
Back to Top