Jump to

• Request
• Response

Get all contract line internal attributes

get

/fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/ContractLine/{LineId}/child/ProjectContractLineInternalAttributes

Request

Path Parameters

• LineId(required): integer(int64)
  The unique identifier of the contract line.
• contractsUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Contracts resource and used to uniquely identify an instance of Contracts. The client should not generate the hash key value. Instead, the client should query on the Contracts collection resource in order to navigate to a specific instance of Contracts to get the hash key.

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>
• effectiveDate: string
  This query parameter is used to fetch resources which are effective dated as of the specified start date. The value of this query parameter is a string having a date in yyyy-MM-dd format
• 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 contract line internal attribute with the specified contract ID, contract line ID and major version.
    Finder Variables:
    • ContractId; integer; The unique identifier of the contract.
    • ContractLineId; integer; The unique identifier of the contract line.
    • MajorVersion; integer; The major version.
• 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:
  

  • ContractId; integer; Unique identifier of the contract.
  • ContractLineId; integer; Unique identifier of the contract line.
  • ControlMilestoneDatesFlag; boolean; Indicates whether project managers can change the planned finish date of a milestone once created in the project plan. The default value is Y, which allows project managers to manage planned finish dates for milestones in the project plan.
  • ExpOrgSourceFlag; boolean; Indicates whether the expenditure organization populated on the intercompany invoice line sent to payables comes from the task owning organization on the original expenditure item or the expenditure organization on the intercompany contract line.
  • ExpTypeOrigEiFlag; boolean; Indicates whether the expenditure type populated on the internal invoice line sent to payables comes from the expenditure type on the original expenditure item or the expenditure type on the internal contract line..
  • ExpenditureTypeId; integer; Unique identifier for the expenditure type which is recorded on the internal invoices of the receiver in Oracle Fusion Payables for the contract line.
  • ExpenditureTypeName; string; Name of the expenditure type that is recorded on the internal invoices of the receiver in Oracle Fusion Payables for the contract line.
  • ExternalReferenceKey; string; The external reference key.
  • ExternalSourceKey; string; The external source key.
  • MajorVersion; integer; Identification of the version of the contract, created by amending the contract, used to generate the revenue distribution.
  • OrganizationId; integer; Unique identifier for the expenditure organization which is recorded on the internal invoices of the receiver in Oracle Fusion Payables for the contract line.
  • OrganizationName; string; Name of the organization that is recorded on the internal invoices of the receiver in Oracle Fusion Payables for the contract line.
  • ProviderBusinessUnitId; integer; Unique identifier for the business unit that provides goods or services which are charged using the internal contract line.
  • ProviderBusinessUnitName; string; Name of the business unit that provides goods or services which are charged using the internal contract line.
  • RcvrBusinessUnitId; integer; The unique identifier of the receiver business unit.
  • RcvrBusinessUnitName; string; The receiver business unit name.
  • ReceiverProjectId; integer; Unique identifier for the project which is recorded on the internal invoices of the receiver in Oracle Fusion Payables for the contract line.
  • ReceiverProjectName; string; Name of the project that is recorded on the internal invoices of the receiver in Oracle Fusion Payables for the contract line.
  • ReceiverTaskId; integer; Unique identifier for the task which is recorded on the internal invoices of the receiver in Oracle Fusion Payables for the contract line.
  • ReceiverTaskName; string; Name of the task that is recorded on the internal invoices of the receiver in Oracle Fusion Payables for the contract line.
• 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

• Effective-Of:
  This header accepts a string value. The string is a semi-colon separated list of =. It is used to perform effective date range operations. The accepted parameters are RangeMode, RangeSpan, RangeStartDate, RangeEndDate, RangeStartSequence and RangeEndSequence. The parameter values are always strings. The possible values for RangeMode are SET_LOGICAL_START, SET_LOGICAL_END, END_DATE, SET_EFFECTIVE_START, SET_EFFECTIVE_END, REPLACE_CORRECTION, REPLACE_UPDATE, RECONCILE_CORRECTION, CORRECTION, RECONCILE_UPDATE, UPDATE, ZAP and DELETE_CHANGES. The possible values for RangeSpan are PHYSICAL_ROW_END_DATE and LOGICAL_ROW_END_DATE. The values for RangeStartDate and RangeEndDate have to be a string representation of a date in yyyy-MM-dd format. The value for RangeStartSequence and RangeEndSequence must be strings such that when parsed they yield positive integers.
• 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 : contracts-ContractLine-ProjectContractLineInternalAttributes

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/contracts-ContractLine-ProjectContractLineInternalAttributes-item-response"
            },
            "x-cardinality":"1"
        }
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object contracts-ContractLine-ProjectContractLineInternalAttributes-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/contracts-ContractLine-ProjectContractLineInternalAttributes-item-response"
    },
    "x-cardinality":"1"
}

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 : contracts-ContractLine-ProjectContractLineInternalAttributes-item-response

Type: object

Show Source

• ContractId: integer
  Unique identifier of the contract.
• ContractLineId: integer
  Unique identifier of the contract line.
• ControlMilestoneDatesFlag: boolean
  Maximum Length: 1

  Indicates whether project managers can change the planned finish date of a milestone once created in the project plan. The default value is Y, which allows project managers to manage planned finish dates for milestones in the project plan.
• ExpenditureTypeId: integer
  Unique identifier for the expenditure type which is recorded on the internal invoices of the receiver in Oracle Fusion Payables for the contract line.
• ExpenditureTypeName: string
  Title: Expenditure Type Name

  Maximum Length: 240

  Name of the expenditure type that is recorded on the internal invoices of the receiver in Oracle Fusion Payables for the contract line.
• ExpOrgSourceFlag: boolean
  Title: Use original task owning organization

  Maximum Length: 20

  Indicates whether the expenditure organization populated on the intercompany invoice line sent to payables comes from the task owning organization on the original expenditure item or the expenditure organization on the intercompany contract line.
• ExpTypeOrigEiFlag: boolean
  Title: Use original expenditure type

  Maximum Length: 1

  Indicates whether the expenditure type populated on the internal invoice line sent to payables comes from the expenditure type on the original expenditure item or the expenditure type on the internal contract line..
• ExternalReferenceKey: string
  Maximum Length: 150

  The external reference key.
• ExternalSourceKey: string
  Maximum Length: 150

  The external source key.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MajorVersion: integer
  Identification of the version of the contract, created by amending the contract, used to generate the revenue distribution.
• OrganizationId: integer
  Unique identifier for the expenditure organization which is recorded on the internal invoices of the receiver in Oracle Fusion Payables for the contract line.
• OrganizationName: string
  Title: Expenditure Organization Name

  Maximum Length: 240

  Name of the organization that is recorded on the internal invoices of the receiver in Oracle Fusion Payables for the contract line.
• ProviderBusinessUnitId: integer
  Title: Provider Business Unit ID

  Unique identifier for the business unit that provides goods or services which are charged using the internal contract line.
• ProviderBusinessUnitName: string
  Title: Provider Business Unit Name

  Maximum Length: 240

  Name of the business unit that provides goods or services which are charged using the internal contract line.
• RcvrBusinessUnitId: integer (int64)
  The unique identifier of the receiver business unit.
• RcvrBusinessUnitName: string
  Title: Receiver Business Unit

  Maximum Length: 240

  The receiver business unit name.
• ReceiverProjectId: integer
  Unique identifier for the project which is recorded on the internal invoices of the receiver in Oracle Fusion Payables for the contract line.
• ReceiverProjectName: string
  Title: Receiver Project Name

  Maximum Length: 240

  Name of the project that is recorded on the internal invoices of the receiver in Oracle Fusion Payables for the contract line.
• ReceiverTaskId: integer
  Unique identifier for the task which is recorded on the internal invoices of the receiver in Oracle Fusion Payables for the contract line.
• ReceiverTaskName: string
  Title: Receiver Task Name

  Maximum Length: 255

  Name of the task that is recorded on the internal invoices of the receiver in Oracle Fusion Payables for the contract line.

{
    "type":"object",
    "properties":{
        "MajorVersion":{
            "type":"integer",
            "description":"Identification of the version of the contract, created by amending the contract, used to generate the revenue distribution.",
            "nullable":false,
            "x-queryable":true
        },
        "OrganizationName":{
            "title":"Expenditure Organization Name",
            "maxLength":"240",
            "type":"string",
            "description":"Name of the organization that is recorded on the internal invoices of the receiver in Oracle Fusion Payables for the contract line.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov",
                "dependencies":[
                    "ReceiverProjectName",
                    "ReceiverProjectId"
                ]
            },
            "x-queryable":true
        },
        "ExternalReferenceKey":{
            "maxLength":"150",
            "type":"string",
            "description":"The external reference key.",
            "nullable":true,
            "x-queryable":true
        },
        "ExpOrgSourceFlag":{
            "title":"Use original task owning organization",
            "maxLength":"20",
            "type":"boolean",
            "description":"Indicates whether the expenditure organization populated on the intercompany invoice line sent to payables comes from the task owning organization on the original expenditure item or the expenditure organization on the intercompany contract line.",
            "nullable":true,
            "x-queryable":true
        },
        "ExternalSourceKey":{
            "maxLength":"150",
            "type":"string",
            "description":"The external source key.",
            "nullable":true,
            "x-queryable":true
        },
        "ProviderBusinessUnitName":{
            "title":"Provider Business Unit Name",
            "maxLength":"240",
            "type":"string",
            "description":"Name of the business unit that provides goods or services which are charged using the internal contract line.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "ContractLineId":{
            "type":"integer",
            "description":"Unique identifier of the contract line.",
            "nullable":false,
            "x-queryable":true
        },
        "ContractId":{
            "type":"integer",
            "description":"Unique identifier of the contract.",
            "nullable":false,
            "x-queryable":true
        },
        "OrganizationId":{
            "type":"integer",
            "description":"Unique identifier for the expenditure organization which is recorded on the internal invoices of the receiver in Oracle Fusion Payables for the contract line.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "ReceiverProjectId"
                ]
            },
            "x-queryable":true
        },
        "RcvrBusinessUnitName":{
            "title":"Receiver Business Unit",
            "maxLength":"240",
            "type":"string",
            "description":"The receiver business unit name.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "ControlMilestoneDatesFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether project managers can change the planned finish date of a milestone once created in the project plan. The default value is Y, which allows project managers to manage planned finish dates for milestones in the project plan.",
            "nullable":true,
            "x-queryable":true
        },
        "ExpenditureTypeId":{
            "type":"integer",
            "description":"Unique identifier for the expenditure type which is recorded on the internal invoices of the receiver in Oracle Fusion Payables for the contract line.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "ReceiverProjectId"
                ]
            },
            "x-queryable":true
        },
        "ExpenditureTypeName":{
            "title":"Expenditure Type Name",
            "maxLength":"240",
            "type":"string",
            "description":"Name of the expenditure type that is recorded on the internal invoices of the receiver in Oracle Fusion Payables for the contract line.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "ReceiverProjectName",
                    "ReceiverProjectId"
                ]
            },
            "x-queryable":true
        },
        "ReceiverProjectName":{
            "title":"Receiver Project Name",
            "maxLength":"240",
            "type":"string",
            "description":"Name of the project that is recorded on the internal invoices of the receiver in Oracle Fusion Payables for the contract line.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "ProviderBusinessUnitId":{
            "title":"Provider Business Unit ID",
            "type":"integer",
            "description":"Unique identifier for the business unit that provides goods or services which are charged using the internal contract line.",
            "nullable":true,
            "x-queryable":true
        },
        "RcvrBusinessUnitId":{
            "type":"integer",
            "description":"The unique identifier of the receiver business unit.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":"18"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ReceiverTaskId":{
            "type":"integer",
            "description":"Unique identifier for the task which is recorded on the internal invoices of the receiver in Oracle Fusion Payables for the contract line.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "ReceiverProjectId"
                ]
            },
            "x-queryable":true
        },
        "ReceiverProjectId":{
            "type":"integer",
            "description":"Unique identifier for the project which is recorded on the internal invoices of the receiver in Oracle Fusion Payables for the contract line.",
            "nullable":true,
            "x-queryable":true
        },
        "ExpTypeOrigEiFlag":{
            "title":"Use original expenditure type",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the expenditure type populated on the internal invoice line sent to payables comes from the expenditure type on the original expenditure item or the expenditure type on the internal contract line..",
            "nullable":true,
            "x-queryable":true
        },
        "ReceiverTaskName":{
            "title":"Receiver Task Name",
            "maxLength":"255",
            "type":"string",
            "description":"Name of the task that is recorded on the internal invoices of the receiver in Oracle Fusion Payables for the contract line.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov",
                "dependencies":[
                    "ReceiverProjectName",
                    "ReceiverProjectId"
                ]
            },
            "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