Jump to

• Request
• Response

Create one definition

post

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

Request

Path Parameters

• MaintenanceProgramId(required): integer(int64)
  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.
• WorkRequirementId(required): integer(int64)
  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

• 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.
• Upsert-Mode:
  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

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• DisabledFlag: boolean
  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.
• DueAtCycleInterval: number
  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: string
  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.
• RepeatsInCycleFlag: boolean
  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.
• WorkDefinitionId: integer (int64)
  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.
• WorkDefinitionRequirementId: integer (int64)
  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.

{
    "type":"object",
    "properties":{
        "DisabledFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "default":false
        },
        "WorkDefinitionRequirementId":{
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "WorkDefinitionId":{
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "DueAtCycleInterval":{
            "title":"Due at Cycle Interval",
            "type":"number",
            "description":"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.",
            "nullable":true
        },
        "RepeatsInCycleFlag":{
            "title":"Repeats in Cycle",
            "maxLength":1,
            "type":"boolean",
            "description":"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.",
            "nullable":false
        },
        "Name":{
            "type":"string",
            "description":"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.",
            "nullable":true
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context(required):
  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(required):
  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

• DisabledFlag: boolean
  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.
• DueAtCycleInterval: number
  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: array Links
  Title: Links

  The link relations associated with the resource instance.
• Name: string
  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.
• RepeatsInCycleFlag: boolean
  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.
• WorkDefinitionId: integer (int64)
  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.
• WorkDefinitionMaintenanceNameId: integer (int64)
  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.
• WorkDefinitionRequirementId: integer (int64)
  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.

{
    "type":"object",
    "properties":{
        "DisabledFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "WorkDefinitionRequirementId":{
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "WorkDefinitionId":{
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DueAtCycleInterval":{
            "title":"Due at Cycle Interval",
            "type":"number",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "WorkDefinitionMaintenanceNameId":{
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RepeatsInCycleFlag":{
            "title":"Repeats in Cycle",
            "maxLength":1,
            "type":"boolean",
            "description":"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.",
            "nullable":false,
            "x-queryable":true
        },
        "Name":{
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top