Jump to

• Request
• Response

Create documents

post

/fscmRestApi/resources/11.13.18.05/maintenanceWorkOrders/{WorkOrderId}/child/documentReference

Request

Path Parameters

• WorkOrderId(required): integer(int64)
  Value that uniquely identifies the work order. This attribute is read-only. The value of this attribute is derived from the work order number when the application creates the work order.

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

• ActiveEndDate: string (date)
  Date when the document reference is deactivated. The record is not deleted but always deactivated.
• DocumentHeaderId: integer (int64)
  Value that uniquely identifies the header of the document assigned to the document reference.
• DocumentLineId: integer (int64)
  Value that uniquely identifies the line of the document assigned to the document reference.
• DocumentLineNumber: string
  Maximum Length: 80

  Number that identifies the line of the document assigned to the document reference.
• DocumentNumber: string
  Maximum Length: 80

  Number that identifies of the document assigned to the document reference.
• DocumentReferenceId: integer (int64)
  Value that uniquely identifies the work order document reference.
• DocumentSubLineId: integer (int64)
  Value that uniquely identifies the sub line of the document assigned to the document reference.
• DocumentSubLineLevelOneId: integer (int64)
  Value that uniquely identifies the level one sub line of the document assigned to the document reference.
• DocumentSubLineLevelOneNumber: string
  Maximum Length: 80

  Number that identifies the level one sub line of the document assigned to the document reference.
• DocumentSubLineLevelTwoId: integer (int64)
  Value that uniquely identifies the level two sub line of the document assigned to the document reference.
• DocumentSubLineLevelTwoNumber: string
  Maximum Length: 80

  Number that identifies the level two sub line of the document assigned to the document reference.
• DocumentSubLineNumber: string
  Maximum Length: 80

  Number that identifies the sub line of the document assigned to the document reference.
• DocumentType: string
  Maximum Length: 30

  Type of document assigned to the document reference. This attribute is read-only. A list of accepted values is defined in the lookup type ORA_CSE_DOCUMENT_TYPE.
• SourceReferenceId: integer (int64)
  Value that uniquely identifies the source reference of the document.
• SourceSystemId: integer (int64)
  Value that uniquely identifies the source application of the document reference.
• SourceSystemTypeCode: string
  Maximum Length: 30

  Abbreviation that identifies the type of source application assigned to the document reference. This attribute is read-only. A list of accepted values is defined in the lookup type ORA_WIE_SOURCE_SYSTEM_TYPE. Valid values are INTERNAL or EXTERNAL.
• WorkOrderId: integer (int64)
  Value that uniquely identifies the work order to which the document reference is associated. This attribute is read-only. The value of this attribute is derived from the work order.

{
    "type":"object",
    "properties":{
        "DocumentReferenceId":{
            "type":"integer",
            "description":"Value that uniquely identifies the work order document reference.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "DocumentSubLineLevelOneId":{
            "type":"integer",
            "description":"Value that uniquely identifies the level one sub line of the document assigned to the document reference.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "DocumentType":{
            "maxLength":30,
            "type":"string",
            "description":"Type of document assigned to the document reference. This attribute is read-only. A list of accepted values is defined in the lookup type ORA_CSE_DOCUMENT_TYPE.",
            "nullable":true
        },
        "DocumentNumber":{
            "maxLength":80,
            "type":"string",
            "description":"Number that identifies of the document assigned to the document reference.",
            "nullable":true
        },
        "SourceSystemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the source application of the document reference.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "DocumentSubLineNumber":{
            "maxLength":80,
            "type":"string",
            "description":"Number that identifies the sub line of the document assigned to the document reference.",
            "nullable":true
        },
        "DocumentSubLineLevelTwoId":{
            "type":"integer",
            "description":"Value that uniquely identifies the level two sub line of the document assigned to the document reference.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "WorkOrderId":{
            "type":"integer",
            "description":"Value that uniquely identifies the work order to which the document reference is associated. This attribute is read-only. The value of this attribute is derived from the work order.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "DocumentSubLineLevelOneNumber":{
            "maxLength":80,
            "type":"string",
            "description":"Number that identifies the level one sub line of the document assigned to the document reference.",
            "nullable":true
        },
        "DocumentLineNumber":{
            "maxLength":80,
            "type":"string",
            "description":"Number that identifies the line of the document assigned to the document reference.",
            "nullable":true
        },
        "DocumentSubLineLevelTwoNumber":{
            "maxLength":80,
            "type":"string",
            "description":"Number that identifies the level two sub line of the document assigned to the document reference.",
            "nullable":true
        },
        "SourceSystemTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the type of source application assigned to the document reference. This attribute is read-only. A list of accepted values is defined in the lookup type ORA_WIE_SOURCE_SYSTEM_TYPE. Valid values are INTERNAL or EXTERNAL.",
            "nullable":true
        },
        "SourceReferenceId":{
            "type":"integer",
            "description":"Value that uniquely identifies the source reference of the document.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "DocumentHeaderId":{
            "type":"integer",
            "description":"Value that uniquely identifies the header of the document assigned to the document reference.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "DocumentLineId":{
            "type":"integer",
            "description":"Value that uniquely identifies the line of the document assigned to the document reference.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "DocumentSubLineId":{
            "type":"integer",
            "description":"Value that uniquely identifies the sub line of the document assigned to the document reference.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ActiveEndDate":{
            "type":"string",
            "description":"Date when the document reference is deactivated. The record is not deleted but always deactivated.",
            "format":"date",
            "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 : maintenanceWorkOrders-documentReference-item-response

Type: object

Show Source

• ActiveEndDate: string (date)
  Date when the document reference is deactivated. The record is not deleted but always deactivated.
• DocumentHeaderId: integer (int64)
  Value that uniquely identifies the header of the document assigned to the document reference.
• DocumentLineId: integer (int64)
  Value that uniquely identifies the line of the document assigned to the document reference.
• DocumentLineNumber: string
  Maximum Length: 80

  Number that identifies the line of the document assigned to the document reference.
• DocumentNumber: string
  Maximum Length: 80

  Number that identifies of the document assigned to the document reference.
• DocumentReferenceId: integer (int64)
  Value that uniquely identifies the work order document reference.
• DocumentSubLineId: integer (int64)
  Value that uniquely identifies the sub line of the document assigned to the document reference.
• DocumentSubLineLevelOneId: integer (int64)
  Value that uniquely identifies the level one sub line of the document assigned to the document reference.
• DocumentSubLineLevelOneNumber: string
  Maximum Length: 80

  Number that identifies the level one sub line of the document assigned to the document reference.
• DocumentSubLineLevelTwoId: integer (int64)
  Value that uniquely identifies the level two sub line of the document assigned to the document reference.
• DocumentSubLineLevelTwoNumber: string
  Maximum Length: 80

  Number that identifies the level two sub line of the document assigned to the document reference.
• DocumentSubLineNumber: string
  Maximum Length: 80

  Number that identifies the sub line of the document assigned to the document reference.
• DocumentType: string
  Maximum Length: 30

  Type of document assigned to the document reference. This attribute is read-only. A list of accepted values is defined in the lookup type ORA_CSE_DOCUMENT_TYPE.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• SourceReferenceId: integer (int64)
  Value that uniquely identifies the source reference of the document.
• SourceSystemId: integer (int64)
  Value that uniquely identifies the source application of the document reference.
• SourceSystemTypeCode: string
  Maximum Length: 30

  Abbreviation that identifies the type of source application assigned to the document reference. This attribute is read-only. A list of accepted values is defined in the lookup type ORA_WIE_SOURCE_SYSTEM_TYPE. Valid values are INTERNAL or EXTERNAL.
• WorkOrderId: integer (int64)
  Value that uniquely identifies the work order to which the document reference is associated. This attribute is read-only. The value of this attribute is derived from the work order.

{
    "type":"object",
    "properties":{
        "DocumentReferenceId":{
            "type":"integer",
            "description":"Value that uniquely identifies the work order document reference.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "DocumentSubLineLevelOneId":{
            "type":"integer",
            "description":"Value that uniquely identifies the level one sub line of the document assigned to the document reference.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DocumentType":{
            "maxLength":30,
            "type":"string",
            "description":"Type of document assigned to the document reference. This attribute is read-only. A list of accepted values is defined in the lookup type ORA_CSE_DOCUMENT_TYPE.",
            "nullable":true,
            "x-queryable":true
        },
        "DocumentNumber":{
            "maxLength":80,
            "type":"string",
            "description":"Number that identifies of the document assigned to the document reference.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceSystemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the source application of the document reference.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DocumentSubLineNumber":{
            "maxLength":80,
            "type":"string",
            "description":"Number that identifies the sub line of the document assigned to the document reference.",
            "nullable":true,
            "x-queryable":true
        },
        "DocumentSubLineLevelTwoId":{
            "type":"integer",
            "description":"Value that uniquely identifies the level two sub line of the document assigned to the document reference.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "WorkOrderId":{
            "type":"integer",
            "description":"Value that uniquely identifies the work order to which the document reference is associated. This attribute is read-only. The value of this attribute is derived from the work order.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DocumentSubLineLevelOneNumber":{
            "maxLength":80,
            "type":"string",
            "description":"Number that identifies the level one sub line of the document assigned to the document reference.",
            "nullable":true,
            "x-queryable":true
        },
        "DocumentLineNumber":{
            "maxLength":80,
            "type":"string",
            "description":"Number that identifies the line of the document assigned to the document reference.",
            "nullable":true,
            "x-queryable":true
        },
        "DocumentSubLineLevelTwoNumber":{
            "maxLength":80,
            "type":"string",
            "description":"Number that identifies the level two sub line of the document assigned to the document reference.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceSystemTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the type of source application assigned to the document reference. This attribute is read-only. A list of accepted values is defined in the lookup type ORA_WIE_SOURCE_SYSTEM_TYPE. Valid values are INTERNAL or EXTERNAL.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SourceReferenceId":{
            "type":"integer",
            "description":"Value that uniquely identifies the source reference of the document.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DocumentHeaderId":{
            "type":"integer",
            "description":"Value that uniquely identifies the header of the document assigned to the document reference.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DocumentLineId":{
            "type":"integer",
            "description":"Value that uniquely identifies the line of the document assigned to the document reference.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DocumentSubLineId":{
            "type":"integer",
            "description":"Value that uniquely identifies the sub line of the document assigned to the document reference.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ActiveEndDate":{
            "type":"string",
            "description":"Date when the document reference is deactivated. The record is not deleted but always deactivated.",
            "format":"date",
            "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