REST API for Oracle Fusion Cloud Procurement

Get one line type

get

/fscmRestApi/resources/11.13.18.05/purchasingLineTypesLOV/{purchasingLineTypesLOVUniqID}

Request

Path Parameters

purchasingLineTypesLOVUniqID(required): string

This is the hash key of the attributes which make up the composite key for the Purchasing Line Types resource and used to uniquely identify an instance of Purchasing Line Types. The client should not generate the hash key value. Instead, the client should query on the Purchasing Line Types collection resource in order to navigate to a specific instance of Purchasing Line Types 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>
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.

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.

Root Schema : purchasingLineTypesLOV-item-response

Type: object

Show Source

CreditFlag: boolean

Title: Credit Flag

Read Only: true

Maximum Length: 1

Contains one of the following values: true or false. If true, then the credit line type is enabled for this document style. If false, then the credit line type isn't enabled for this document style. This attribute doesn't have a default value.
DefaultCategory: string

Title: Default Category

Read Only: true

Maximum Length: 2400

Default purchasing category associated with the purchasing line type.
DefaultCategoryCode: string

Title: Default Category Code

Read Only: true

Maximum Length: 820

Abbreviation for the default purchasing category associated with the purchasing line type.
DefaultCategoryId: integer (int64)

Title: Default Category ID

Read Only: true

Value that uniquely identifies the default purchasing category associated with the purchasing line type.
DefaultInvoiceMatchOption: string

Title: Default Invoice Match Option

Read Only: true

Maximum Length: 80

Default invoice match option associated with the purchasing line type.
DefaultInvoiceMatchOptionCode: string

Title: Default Invoice Match Option Code

Read Only: true

Maximum Length: 25

Abbreviation that identifies the default invoice match option associated with the purchasing line type.
DefaultMatchApprovalLevel: string

Title: Default Match Approval Level

Read Only: true

Maximum Length: 255

Default match approval level associated with the purchasing line type.
DefaultMatchApprovalLevelCode: string

Title: Default Match Approval Level Code

Read Only: true

Maximum Length: 255

Abbreviation that identifies the default match approval level associated with the purchasing line type.
DefaultReceiptCloseTolerancePercent: number

Title: Default Receipt Close Tolerance Percent

Read Only: true

Default receipt close tolerance percentage associated with the purchasing line type.
DefaultUOM: string

Title: Default UOM

Read Only: true

Maximum Length: 25

Default unit of measure associated with the purchasing line type.
DefaultUOMCode: string

Title: Default UOM Code

Read Only: true

Maximum Length: 3

Abbreviation that identifies that default unit of measure associated with the purchasing line type.
Description: string

Title: Description

Read Only: true

Maximum Length: 240

Description of the purchasing line type.
EndDate: string (date)

Title: End Date

Read Only: true

Date after which the line type is no longer valid.
LineType: string

Title: Line Type

Read Only: true

Maximum Length: 30

Type that indicates whether the line type references an item or a service.
LineTypeCode: string

Title: Line Type Code

Read Only: true

Maximum Length: 30

Abbreviation that identifies the purchasing line type.
LineTypeId: integer (int64)

Title: Line Type ID

Read Only: true

Value that uniquely identifies whether the line type line references an item or a service.
links: array Links

Title: Links

The link relations associated with the resource instance.
ProductType: string

Title: Product Type

Read Only: true

Maximum Length: 80

Product type associated with the purchasing line type.
ProductTypeCode: string

Title: Product Type Code

Read Only: true

Maximum Length: 30

Abbreviation that identifies the product type associated with the line type.
PurchaseBasis: string

Title: Purchase Basis

Read Only: true

Maximum Length: 80

Purchase basis of the line type.
PurchaseBasisCode: string

Title: Purchase Basis Code

Read Only: true

Maximum Length: 30

Abbreviation that identifies the purchase basis type associated with the line type.

{
    "type":"object",
    "properties":{
        "LineTypeCode":{
            "title":"Line Type Code",
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the purchasing line type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LineTypeId":{
            "title":"Line Type ID",
            "type":"integer",
            "description":"Value that uniquely identifies whether the line type line references an item or a service.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":"240",
            "type":"string",
            "description":"Description of the purchasing line type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DefaultInvoiceMatchOptionCode":{
            "title":"Default Invoice Match Option Code",
            "maxLength":"25",
            "type":"string",
            "description":"Abbreviation that identifies the default invoice match option associated with the purchasing line type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "DefaultReceiptCloseTolerancePercent":{
            "title":"Default Receipt Close Tolerance Percent",
            "type":"number",
            "description":"Default receipt close tolerance percentage associated with the purchasing line type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ProductType":{
            "title":"Product Type",
            "maxLength":"80",
            "type":"string",
            "description":"Product type associated with the purchasing line type.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DefaultCategoryCode":{
            "title":"Default Category Code",
            "maxLength":"820",
            "type":"string",
            "description":"Abbreviation for the default purchasing category associated with the purchasing line type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PurchaseBasis":{
            "title":"Purchase Basis",
            "maxLength":"80",
            "type":"string",
            "description":"Purchase basis of the line type.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreditFlag":{
            "title":"Credit Flag",
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the credit line type is enabled for this document style. If false, then the credit line type isn't enabled for this document style. This attribute doesn't have a default value.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ProductTypeCode":{
            "title":"Product Type Code",
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the product type associated with the line type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"Date after which the line type is no longer valid.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DefaultInvoiceMatchOption":{
            "title":"Default Invoice Match Option",
            "maxLength":"80",
            "type":"string",
            "description":"Default invoice match option associated with the purchasing line type.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "DefaultCategory":{
            "title":"Default Category",
            "maxLength":"2400",
            "type":"string",
            "description":"Default purchasing category associated with the purchasing line type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PurchaseBasisCode":{
            "title":"Purchase Basis Code",
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the purchase basis type associated with the line type.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DefaultCategoryId":{
            "title":"Default Category ID",
            "type":"integer",
            "description":"Value that uniquely identifies the default purchasing category associated with the purchasing line type.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "DefaultMatchApprovalLevel":{
            "title":"Default Match Approval Level",
            "maxLength":"255",
            "type":"string",
            "description":"Default match approval level associated with the purchasing line type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "DefaultUOM":{
            "title":"Default UOM",
            "maxLength":"25",
            "type":"string",
            "description":"Default unit of measure associated with the purchasing line type.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"edit"
            }
        },
        "DefaultMatchApprovalLevelCode":{
            "title":"Default Match Approval Level Code",
            "maxLength":"255",
            "type":"string",
            "description":"Abbreviation that identifies the default match approval level associated with the purchasing line type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LineType":{
            "title":"Line Type",
            "maxLength":"30",
            "type":"string",
            "description":"Type that indicates whether the line type references an item or a service.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DefaultUOMCode":{
            "title":"Default UOM Code",
            "maxLength":"3",
            "type":"string",
            "description":"Abbreviation that identifies that default unit of measure associated with the purchasing line type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        }
    }
}

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."
        }
    }
}

Examples

This example describes how to get one purchasing line type.

Example cURL Command

Use the following cURL command to submit a request on the REST resource:

curl -u username:password "https://servername/fscmRestApi/resources/version/purchasingLineTypesLOV/purchasingLineTypesLOVUniqID"

For example:

curl -u username:password "https://servername/fscmRestApi/resources/version/purchasingLineTypesLOV/300100206485542"

Example Response Body

The following example includes the contents of the response body in JSON format:

{
    "LineTypeId": "300100206485542",
    "LineTypeCode": "2WAYR",
    "LineType": "2WAYR",
    "Description": "2-Way match to receipt",
    "CreditFlag": false,
    "ProductTypeCode": "GOODS",
    "ProductType": "Goods",
    "PurchaseBasisCode": "GOODS",
    "PurchaseBasis": "Quantity",
    "EndDate": null,
    "DefaultMatchApprovalLevelCode": "2-Way",
    "DefaultMatchApprovalLevel": "2 Way",
    "DefaultInvoiceMatchOptionCode": "R",
    "DefaultInvoiceMatchOption": "Receipt",
    "DefaultReceiptCloseTolerancePercent": null,
    "DefaultCategoryId": "1",
    "DefaultCategoryCode": "MISC.MISC",
    "DefaultCategory": "Miscellaneous_1",
    "DefaultUOMCode": "Ea",
    "DefaultUOM": "Each",
    "@context": {
        "key": "300100206485542,Ea,1,R,PO%20INVOICE%20MATCH%20OPTION,GOODS,PURCHASE%20BASIS,GOODS,ZX_PRODUCT_TYPE",
        "links": [
            {
                "rel": "self",
                "href": "https://servername/fscmRestApi/resources/version/purchasingLineTypesLOV/300100206485542%2CEa%2C1%2CR%2CPO%2520INVOICE%2520MATCH%2520OPTION%2CGOODS%2CPURCHASE%2520BASIS%2CGOODS%2CZX_PRODUCT_TYPE",
                "name": "purchasingLineTypesLOV",
                "kind": "item"
            },
            {
                "rel": "canonical",
                "href": "https://servername/fscmRestApi/resources/version/purchasingLineTypesLOV/300100206485542%2CEa%2C1%2CR%2CPO%2520INVOICE%2520MATCH%2520OPTION%2CGOODS%2CPURCHASE%2520BASIS%2CGOODS%2CZX_PRODUCT_TYPE",
                "name": "purchasingLineTypesLOV",
                "kind": "item"
            }
        ]
    }
}