Jump to

• Request
• Response
• Examples

Get all operational measures for the joint venture journal

get

/fscmRestApi/resources/11.13.18.05/jointVentureAccountingHeaders/{accountingHeaderId}/child/operationalMeasures

Request

Path Parameters

• accountingHeaderId(required): integer(int64)
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=

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
• finder: string
  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 the operational measure that matches the primary key criteria specified.
    Finder Variables
    • operationalMeasureId; integer; The unique identifier of the operational measure.
  • measureFinder Finds all operational measures that match the specified search criteria.
    Finder Variables
    • jointVenture; string; The unique name of the joint venture.
    • measureDate; string; The date of the operational measure.
    • measureLineType; string; The type of the operational measure line for processing reversals and corrections of statistical journal entries. Valid values are Original, Canceled, and Reversed.
    • measureStatus; string; The status of the operational measure for generating statistical journal entries.
    • measureType; string; The unique name of the measure type.
    • measureTypeDescription; string; The description of the measure type.
    • measureValueType; string; The value type used to identify the operational measure value as a number or a percent.
    • reference; string; The reference; string; associated with the operational measure.
    • searchAllText; string; A search value to identify operational measures that contain the specified text in any of the string attributes.
    • segmentValue; string; A valid value defined for the segment labeled as the primary segment within the chart of accounts instance associated with the joint venture.
    • unitOfMeasure; string; The unit of measure for the operational measure value.
• limit: integer
  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.
• 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
  
• offset: integer
  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.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  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
• q: string
  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:
  

  • accountingHeaderId; integer; The unique identifier of the accounting header.
  • createdBy; string; The user who created the operational measure.
  • creationDate; string; The date and time when the operational measure was created.
  • documentNumber; string; The unique document reference for the joint venture accounting transaction.
  • jointVenture; string; The unique name of the joint venture.
  • jointVentureDescription; string; The description of the joint venture.
  • lastUpdateDate; string; The date and time when the operational measure was last updated.
  • lastUpdatedBy; string; The user who last updated the operational measure.
  • measureDate; string; The date of the operational measure.
  • measureLineNumber; integer; The line number of the operational measure that's incremented when processing reversals and corrections of statistical journal entries.
  • measureLineType; string; The type of the operational measure line for processing reversals and corrections of statistical journal entries. Valid values are Original, Canceled, and Reversed.
  • measureStatus; string; The status of the operational measure for generating statistical journal entries.
  • measureType; string; The unique name of the measure type.
  • measureTypeDescription; string; The description of the measure type.
  • measureValue; number; The value of the operational measure.
  • measureValueType; string; The value type used to identify the operational measure value as a number or a percent.
  • operationalMeasureId; integer; The unique identifier of the operational measure.
  • primarySegment; string; The name of the account segment labeled as the primary segment in the chart of accounts instance associated with the joint venture.
  • reference; string; The reference associated with the operational measure.
  • segmentValue; string; A valid value defined for the segment labeled as the primary segment within the chart of accounts instance associated with the joint venture.
  • segmentValueDescription; string; The description of the primary segment value.
  • unitOfMeasure; string; The unit of measure for the operational measure value.
• totalResults: boolean
  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

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

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

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

Body ()

Root Schema : jointVentureAccountingHeaders-operationalMeasures

Type: object

Show Source

• count(required): integer
  The number of resource instances returned in the current range.
• hasMore(required): boolean
  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array Items
  Title: Items

  The items in the collection.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The link relations associated with the resource instance.
• offset(required): integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/jointVentureAccountingHeaders-operationalMeasures-item-response"
            }
        }
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object jointVentureAccountingHeaders-operationalMeasures-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/jointVentureAccountingHeaders-operationalMeasures-item-response"
    }
}

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 : jointVentureAccountingHeaders-operationalMeasures-item-response

Type: object

Show Source

• accountingHeaderId: integer (int64)
  Title: Accounting Header ID

  Read Only: true

  The unique identifier of the accounting header.
• createdBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the operational measure.
• creationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date and time when the operational measure was created.
• documentNumber: string
  Title: Document Number

  Read Only: true

  Maximum Length: 240

  The unique document reference for the joint venture accounting transaction.
• jointVenture: string
  Title: Joint Venture

  The unique name of the joint venture.
• jointVentureDescription: string
  Title: Joint Venture Description

  Read Only: true

  Maximum Length: 240

  The description of the joint venture.
• lastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date and time when the operational measure was last updated.
• lastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the operational measure.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• measureDate: string (date)
  Title: Measure Date

  The date of the operational measure.
• measureLineNumber: integer (int32)
  Title: Line Number

  Read Only: true

  The line number of the operational measure that's incremented when processing reversals and corrections of statistical journal entries.
• measureLineType: string
  Title: Line Type

  Read Only: true

  Maximum Length: 80

  The type of the operational measure line for processing reversals and corrections of statistical journal entries. Valid values are Original, Canceled, and Reversed.
• measureStatus: string
  Title: Status

  The status of the operational measure for generating statistical journal entries.
• measureType: string
  Title: Measure Type

  The unique name of the measure type.
• measureTypeDescription: string
  Title: Measure Type Description

  Read Only: true

  Maximum Length: 240

  The description of the measure type.
• measureValue: number
  Title: Measure Value

  The value of the operational measure.
• measureValueType: string
  Title: Value Type

  Read Only: true

  Maximum Length: 80

  The value type used to identify the operational measure value as a number or a percent.
• operationalMeasureId: integer (int64)
  Title: Operational Measure ID

  Read Only: true

  The unique identifier of the operational measure.
• primarySegment: string
  Title: Primary Segment

  Read Only: true

  Maximum Length: 255

  The name of the account segment labeled as the primary segment in the chart of accounts instance associated with the joint venture.
• reference: string
  Title: Reference

  Maximum Length: 64

  The reference associated with the operational measure.
• segmentValue: string
  Title: Primary Segment Value

  Maximum Length: 25

  A valid value defined for the segment labeled as the primary segment within the chart of accounts instance associated with the joint venture.
• segmentValueDescription: string
  Title: Primary Segment Value Description

  Read Only: true

  The description of the primary segment value.
• unitOfMeasure: string
  Title: Unit of Measure

  Read Only: true

  Maximum Length: 80

  The unit of measure for the operational measure value.

{
    "type":"object",
    "properties":{
        "operationalMeasureId":{
            "title":"Operational Measure ID",
            "type":"integer",
            "description":"The unique identifier of the operational measure.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "lastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the operational measure.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "measureLineType":{
            "title":"Line Type",
            "maxLength":80,
            "type":"string",
            "description":"The type of the operational measure line for processing reversals and corrections of statistical journal entries. Valid values are Original, Canceled, and Reversed.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "unitOfMeasure":{
            "title":"Unit of Measure",
            "maxLength":80,
            "type":"string",
            "description":"The unit of measure for the operational measure value.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "lookupCodeUnitOfMeasure"
                ]
            },
            "x-queryable":true
        },
        "lastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the operational measure was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "documentNumber":{
            "title":"Document Number",
            "maxLength":240,
            "type":"string",
            "description":"The unique document reference for the joint venture accounting transaction.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "primarySegment":{
            "title":"Primary Segment",
            "maxLength":255,
            "type":"string",
            "description":"The name of the account segment labeled as the primary segment in the chart of accounts instance associated with the joint venture.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "segmentValue":{
            "title":"Primary Segment Value",
            "maxLength":25,
            "type":"string",
            "description":"A valid value defined for the segment labeled as the primary segment within the chart of accounts instance associated with the joint venture.",
            "nullable":true,
            "x-queryable":true
        },
        "measureStatus":{
            "title":"Status",
            "type":"string",
            "description":"The status of the operational measure for generating statistical journal entries.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "lookupCodeStatus"
                ]
            },
            "x-queryable":true
        },
        "measureLineNumber":{
            "title":"Line Number",
            "type":"integer",
            "description":"The line number of the operational measure that's incremented when processing reversals and corrections of statistical journal entries.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "creationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the operational measure was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "accountingHeaderId":{
            "title":"Accounting Header ID",
            "type":"integer",
            "description":"The unique identifier of the accounting header.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "measureDate":{
            "title":"Measure Date",
            "type":"string",
            "description":"The date of the operational measure.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "measureValueType":{
            "title":"Value Type",
            "maxLength":80,
            "type":"string",
            "description":"The value type used to identify the operational measure value as a number or a percent.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "lookupCodeMeasureValueType"
                ]
            },
            "x-queryable":true
        },
        "reference":{
            "title":"Reference",
            "maxLength":64,
            "type":"string",
            "description":"The reference associated with the operational measure.",
            "nullable":true,
            "x-queryable":true
        },
        "measureValue":{
            "title":"Measure Value",
            "type":"number",
            "description":"The value of the operational measure.",
            "nullable":true,
            "x-queryable":true
        },
        "segmentValueDescription":{
            "title":"Primary Segment Value Description",
            "type":"string",
            "description":"The description of the primary segment value.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "jointVenture":{
            "title":"Joint Venture",
            "type":"string",
            "description":"The unique name of the joint venture.",
            "nullable":true,
            "x-queryable":true
        },
        "createdBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the operational measure.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "jointVentureDescription":{
            "title":"Joint Venture Description",
            "maxLength":240,
            "type":"string",
            "description":"The description of the joint venture.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "measureTypeDescription":{
            "title":"Measure Type Description",
            "maxLength":240,
            "type":"string",
            "description":"The description of the measure type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "measureType":{
            "title":"Measure Type",
            "type":"string",
            "description":"The unique name of the measure type.",
            "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

Examples

The following example shows how to retrieve all joint venture operational measures for the joint venture journal by submitting a GET request on the REST resource using cURL.

curl -i -u "username:password" -H "Content-type: application/json" -X GET "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentureAccountingHeaders/100101481396951/child/operationalMeasures"

Example Response Body

The following shows an example of the response body in JSON format.

{
  "items": [
    {
      "operationalMeasureId": 300100571663118,
      "measureType": "WATER01",
      "measureTypeDescription": "Water usage",
      "jointVenture": "STATPROJ",
      "jointVentureDescription": "Offshore drilling",
      "primarySegment": "HEPPCostcenter",
      "segmentValue": "2020",
      "segmentValueDescription": "Offshore East North Coast Cost Center",
      "reference": "R130223050251",
      "measureDate": "2017-01-22",
      "measureValue": 12.12,
      "unitOfMeasure": "Units",
      "measureValueType": "Number",
      "createdBy": "username",
      "creationDate": "2023-02-13T05:48:52+00:00",
      "lastUpdatedBy": "username",
      "lastUpdateDate": "2023-02-13T05:53:20.465+00:00",
      "measureStatus": "Process complete",
      "measureLineType": "Original",
      "measureLineNumber": 1,
      "accountingHeaderId": 100101481396951,
      "documentNumber": "OPERATIONAL_MEASURE:STATPROJ:22-01-2017:13-02-2023:05:53:19",
      "links": [
        {
          "rel": "self",
          "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentureAccountingHeaders/100101481396951/child/operationalMeasures/300100571663118",
          "name": "operationalMeasures",
          "kind": "item",
          "properties": {
            "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
          }
        },
        {
          "rel": "canonical",
          "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentureAccountingHeaders/100101481396951/child/operationalMeasures/300100571663118",
          "name": "operationalMeasures",
          "kind": "item"
        },
        {
          "rel": "parent",
          "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentureAccountingHeaders/100101481396951",
          "name": "jointVentureAccountingHeaders",
          "kind": "item"
        }
      ]
    }
  ],
  "count": 1,
  "hasMore": false,
  "limit": 25,
  "offset": 0,
  "links": [
    {
      "rel": "self",
      "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentureAccountingHeaders/100101481396951/child/operationalMeasures",
      "name": "operationalMeasures",
      "kind": "collection"
    }
  ]
}

Back to Top