Get all debriefs

get

/fscmRestApi/resources/11.13.18.05/debriefs

Request

Query Parameters
  • 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).
  • 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
  • Used as a predefined finder to search the collection.

    Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

    The following are the available finder names and corresponding finder variables:

    • PrimaryKey: Finds debrief headers according to the specified primary key.
      Finder Variables:
      • DebriefHeaderId; integer; Value that uniquely identifies the debrief header.
  • This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
  • 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
  • Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
  • This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY

    Format: ?q=expression1;expression2

    You can use these queryable attributes to filter this collection resource using the q query parameter:
    • AssetId; integer; Value that uniquely identifies the asset.
    • AssetNumber; string; Number that identifies the asset.
    • BUName; string; Name of the business unit where the sales order is created.
    • BUOrgId; integer; Value that uniquely identifies the business unit.
    • BillToAddress; string; Value that defines the bill-to address of the bill-to party.
    • BillToPartySiteId; integer; Value that uniquely identifies the bill-to party.
    • CostOrganizationCode; string; Abbreviation that identifies the maintenance organization.
    • CostOrganizationId; integer; Value that uniquely identifies the maintenance organization.
    • CostOrganizationName; string; Name of the maintenance organization.
    • CreateChargesFlag; boolean; Value that pulls the charges created for maintenance work orders for a debrief transaction.
    • CreatedBy; string; Who column: indicates the user who created the row for debrief.
    • CreationDate; string; Who column: indicates the date and time row created for debrief.
    • CurrencyCode; string; Abbreviation that identifies the currency for repricing the debrief.
    • CustomerAccountId; integer; Value that uniquely identifies the customer account.
    • CustomerAccountNumber; string; Number that identifies the customer account.
    • CustomerName; string; Name of the customer.
    • DebriefHeaderId; integer; Value that uniquely identifies the debrief header record.
    • DebriefNumber; string; Number that uniquely identifies the debrief header record.
    • DebriefStatus; string; Value that defines the meaning of the debrief status. The Values are derived from lookup ORA_RCL_DEBRIEF_STATUS.
    • DebriefStatusCode; string; Abbreviation that identifies the status of the debrief header. A list of accepted values is defined in the lookup type ORA_RCL_DEBRIEF_STATUS. You cannot add additional debrief statuses.
    • FreezePrice; string; Value that indicates whether or not the price is frozen when creating the sales order.
    • LastUpdateDate; string; Who column: indicates the date and time of the last update of the row for debrief.
    • LastUpdateLogin; string; Who column: indicates the session login associated with the user who last updated the row for debrief.
    • LastUpdatedBy; string; Who column: indicates the user who last updated the row for debrief.
    • ObjectVersionNumber; integer; Number that is used to implement optimistic locking. This number is incremented every time the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was most recently queried.
    • OrderId; number; Value that uniquely identifies the order.
    • OrderNumber; string; Number that uniquely identifies the order.
    • ParentEntityCode; string; Abbreviation that identifies the parent entity of the debrief header.
    • ParentEntityCodeMeaning; string; Meaning of the parent entity code. A list of accepted values is defined in the lookup type ORA_RCL_SOURCE_DOC_TYPE.
    • ParentEntityId; integer; Value that uniquely identifies the parent entity of the debrief header.
    • ParentEntityName; string; Name of the parent entity associated with the debrief.
    • ParentEntityNumber; string; Number that identifies the parent document associated with the service logistics debrief record.
    • PartyId; integer; Value that uniquely identifies the customer party (HZ_PARTIES) associated with the service logistics debrief record (RCL_DEBRIEF_HEADERS).
    • ProductItemDescription; string; Value that defines description of the product item.
    • ProductItemId; integer; Value that uniquely identifies the product (EGP_SYSTEM_ITEMS) associated with the service logistics debrief record (RCL_DEBRIEF_HEADERS).
    • ProductItemNumber; string; Number that uniquely identifies the product (EGP_SYSTEM_ITEMS) associated with the service logistics debrief record (RCL_DEBRIEF_HEADERS).
    • ProductSerialNumber; string; Serial number that identifies the product.
    • PurchaseOrder; string; Value that defines the purchase order number from the service request for the debrief header.
    • Quantity; number; Asset quantity ordered for the return material authorization (RMA) line.
    • ReceivedQuantity; number; Asset quantity received for the return material authorization (RMA) line.
    • RepriceFlag; boolean; Value that identifies the repricing of the debrief. Contains one of the following values: true or false. If true, initiates repricing for the debrief. If false, doesn't initiate repricing for the debrief.
    • ServiceRequestId; integer; Value that uniquely identifies the service request.
    • ServiceRequestNumber; string; Number that identifies the service request.
    • ShipToAddress; string; Shipping or service address of the customer.
    • ShipToPartySiteId; integer; Value that uniquely identifies the ship-to party.
    • TechnicianEmailAddress; string; Email address of the technician.
    • TechnicianPartyId; integer; Value that uniquely identifies the technician resource (HZ_PARTIES) associated with the service logistics debrief record (RCL_DEBRIEF_HEADERS).
    • TechnicianPartyName; string; Name of the technician.
    • TechnicianPartyNumber; string; Party number of the technician.
    • WorkOrderSubTypeCode; string; Abbreviation that identifies the work order subtype.
    • WorkOrderSubTypeMeaning; string; Meaning of the work order subtype.
  • The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
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.

There's no request body for this operation.

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 : debriefs
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : debriefs-item-response
Type: object
Show Source
Nested Schema : Flexfields for Debriefs
Type: array
Title: Flexfields for Debriefs
The Flexfields for Debriefs resource manages the flexfields for a debrief.
Show Source
Nested Schema : Debrief Lines
Type: array
Title: Debrief Lines
The Debrief Lines resource manages additional information for service activity, labor item, start time, end time, material item, quantity, unit of measure, expense item, amount, and currency code.
Show Source
Nested Schema : Flexfields for Project Details
Type: array
Title: Flexfields for Project Details
The Flexfields for Project Details resource manages the flexfields that contain details about the project.
Show Source
  • Discriminator: __FLEX_Context
    Discriminator: { "propertyName":"__FLEX_Context", "mapping":{ "AP_Distribution_Sets":"#/components/schemas/oracle_apps_flex_scm_serviceLogistics_billing_debrief_workOrders_pjcWorkOrder_view_PJCDFFAP__5FDistribution__5FSetsVO-item-response", "AP_Invoice_Distribution":"#/components/schemas/oracle_apps_flex_scm_serviceLogistics_billing_debrief_workOrders_pjcWorkOrder_view_PJCDFFAP__5FInvoice__5FDistributionVO-item-response", "AP_Invoice_Line":"#/components/schemas/oracle_apps_flex_scm_serviceLogistics_billing_debrief_workOrders_pjcWorkOrder_view_PJCDFFAP__5FInvoice__5FLineVO-item-response", "EXM_Expense_Report":"#/components/schemas/oracle_apps_flex_scm_serviceLogistics_billing_debrief_workOrders_pjcWorkOrder_view_PJCDFFEXM__5FExpense__5FReportVO-item-response", "EXM_Expense_Report_Line":"#/components/schemas/oracle_apps_flex_scm_serviceLogistics_billing_debrief_workOrders_pjcWorkOrder_view_PJCDFFEXM__5FExpense__5FReport__5FLineVO-item-response", "INV_Misc_Transactions":"#/components/schemas/oracle_apps_flex_scm_serviceLogistics_billing_debrief_workOrders_pjcWorkOrder_view_PJCDFFINV__5FMisc__5FTransactionsVO-item-response", "OM_Sales_Order":"#/components/schemas/oracle_apps_flex_scm_serviceLogistics_billing_debrief_workOrders_pjcWorkOrder_view_PJCDFFOM__5FSales__5FOrderVO-item-response", "PJC_All":"#/components/schemas/oracle_apps_flex_scm_serviceLogistics_billing_debrief_workOrders_pjcWorkOrder_view_PJCDFFPJC__5FAllVO-item-response", "PJC_Expenditure_Batch":"#/components/schemas/oracle_apps_flex_scm_serviceLogistics_billing_debrief_workOrders_pjcWorkOrder_view_PJCDFFPJC__5FExpenditure__5FBatchVO-item-response", "POR_Requisition":"#/components/schemas/oracle_apps_flex_scm_serviceLogistics_billing_debrief_workOrders_pjcWorkOrder_view_PJCDFFPOR__5FRequisitionVO-item-response", "POR_User_Preferences":"#/components/schemas/oracle_apps_flex_scm_serviceLogistics_billing_debrief_workOrders_pjcWorkOrder_view_PJCDFFPOR__5FUser__5FPreferencesVO-item-response", "PO_Purchase_Order":"#/components/schemas/oracle_apps_flex_scm_serviceLogistics_billing_debrief_workOrders_pjcWorkOrder_view_PJCDFFPO__5FPurchase__5FOrderVO-item-response", "PO_Purchase_Order_Line":"#/components/schemas/oracle_apps_flex_scm_serviceLogistics_billing_debrief_workOrders_pjcWorkOrder_view_PJCDFFPO__5FPurchase__5FOrder__5FLineVO-item-response", "PO_Purchase_Order_Schedule":"#/components/schemas/oracle_apps_flex_scm_serviceLogistics_billing_debrief_workOrders_pjcWorkOrder_view_PJCDFFPO__5FPurchase__5FOrder__5FScheduleVO-item-response" } }
Nested Schema : debriefs-debriefsDFF-item-response
Type: object
Show Source
Nested Schema : debriefs-lines-item-response
Type: object
Show Source
Nested Schema : Charges
Type: array
Title: Charges
The Charges resource is used to view all the service charges for a debrief line.
Show Source
Nested Schema : Flexfields for Debrief Lines
Type: array
Title: Flexfields for Debrief Lines
The Flexfields for Debrief Lines resource manages the flexfields for a debrief line.
Show Source
  • Discriminator: __FLEX_Context
    Discriminator: { "propertyName":"__FLEX_Context", "mapping":{ "E":"#/components/schemas/oracle_apps_flex_scm_serviceLogistics_billing_debrief_DebriefLineDFF_view_DebriefLineDFFEVO-item-response", "EE":"#/components/schemas/oracle_apps_flex_scm_serviceLogistics_billing_debrief_DebriefLineDFF_view_DebriefLineDFFEEVO-item-response", "EF":"#/components/schemas/oracle_apps_flex_scm_serviceLogistics_billing_debrief_DebriefLineDFF_view_DebriefLineDFFEFVO-item-response", "EL":"#/components/schemas/oracle_apps_flex_scm_serviceLogistics_billing_debrief_DebriefLineDFF_view_DebriefLineDFFELVO-item-response", "EM":"#/components/schemas/oracle_apps_flex_scm_serviceLogistics_billing_debrief_DebriefLineDFF_view_DebriefLineDFFEMVO-item-response", "F":"#/components/schemas/oracle_apps_flex_scm_serviceLogistics_billing_debrief_DebriefLineDFF_view_DebriefLineDFFFVO-item-response", "L":"#/components/schemas/oracle_apps_flex_scm_serviceLogistics_billing_debrief_DebriefLineDFF_view_DebriefLineDFFLVO-item-response", "M":"#/components/schemas/oracle_apps_flex_scm_serviceLogistics_billing_debrief_DebriefLineDFF_view_DebriefLineDFFMVO-item-response" } }
Nested Schema : debriefs-lines-charges-item-response
Type: object
Show Source
Nested Schema : Discriminator: __FLEX_Context
Type: object
Discriminator: __FLEX_Context

Discriminator Values

Match One Schema
Show Source
Nested Schema : oracle_apps_flex_scm_serviceLogistics_billing_debrief_DebriefLineDFF_view_DebriefLineDFFEVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_flex_scm_serviceLogistics_billing_debrief_DebriefLineDFF_view_DebriefLineDFFEEVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_flex_scm_serviceLogistics_billing_debrief_DebriefLineDFF_view_DebriefLineDFFEFVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_flex_scm_serviceLogistics_billing_debrief_DebriefLineDFF_view_DebriefLineDFFELVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_flex_scm_serviceLogistics_billing_debrief_DebriefLineDFF_view_DebriefLineDFFEMVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_flex_scm_serviceLogistics_billing_debrief_DebriefLineDFF_view_DebriefLineDFFFVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_flex_scm_serviceLogistics_billing_debrief_DebriefLineDFF_view_DebriefLineDFFLVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_flex_scm_serviceLogistics_billing_debrief_DebriefLineDFF_view_DebriefLineDFFMVO-item-response
Type: object
Show Source
Nested Schema : Discriminator: __FLEX_Context
Type: object
Discriminator: __FLEX_Context

Discriminator Values

Match One Schema
Show Source
Nested Schema : oracle_apps_flex_scm_serviceLogistics_billing_debrief_workOrders_pjcWorkOrder_view_PJCDFFAP__5FDistribution__5FSetsVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_flex_scm_serviceLogistics_billing_debrief_workOrders_pjcWorkOrder_view_PJCDFFAP__5FInvoice__5FDistributionVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_flex_scm_serviceLogistics_billing_debrief_workOrders_pjcWorkOrder_view_PJCDFFAP__5FInvoice__5FLineVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_flex_scm_serviceLogistics_billing_debrief_workOrders_pjcWorkOrder_view_PJCDFFEXM__5FExpense__5FReportVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_flex_scm_serviceLogistics_billing_debrief_workOrders_pjcWorkOrder_view_PJCDFFEXM__5FExpense__5FReport__5FLineVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_flex_scm_serviceLogistics_billing_debrief_workOrders_pjcWorkOrder_view_PJCDFFINV__5FMisc__5FTransactionsVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_flex_scm_serviceLogistics_billing_debrief_workOrders_pjcWorkOrder_view_PJCDFFOM__5FSales__5FOrderVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_flex_scm_serviceLogistics_billing_debrief_workOrders_pjcWorkOrder_view_PJCDFFPJC__5FAllVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_flex_scm_serviceLogistics_billing_debrief_workOrders_pjcWorkOrder_view_PJCDFFPJC__5FExpenditure__5FBatchVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_flex_scm_serviceLogistics_billing_debrief_workOrders_pjcWorkOrder_view_PJCDFFPOR__5FRequisitionVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_flex_scm_serviceLogistics_billing_debrief_workOrders_pjcWorkOrder_view_PJCDFFPOR__5FUser__5FPreferencesVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_flex_scm_serviceLogistics_billing_debrief_workOrders_pjcWorkOrder_view_PJCDFFPO__5FPurchase__5FOrderVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_flex_scm_serviceLogistics_billing_debrief_workOrders_pjcWorkOrder_view_PJCDFFPO__5FPurchase__5FOrder__5FLineVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_flex_scm_serviceLogistics_billing_debrief_workOrders_pjcWorkOrder_view_PJCDFFPO__5FPurchase__5FOrder__5FScheduleVO-item-response
Type: object
Show Source
Back to Top