Get one document
get
/fscmRestApi/resources/11.13.18.05/maintenanceWorkOrders/{WorkOrderId}/child/documentReference/{DocumentReferenceId}
Request
Path Parameters
-
DocumentReferenceId(required): integer(int64)
Value that uniquely identifies the work order document reference.
-
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.
Query Parameters
-
dependency: string
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> -
expand: string
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).
-
fields: string
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 -
links: string
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 -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
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.
There's no request body for this operation.
Back to TopResponse
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.
Root Schema : maintenanceWorkOrders-documentReference-item-response
Type:
Show Source
object
-
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.
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.