REST API for Oracle Fusion Cloud Financials

Update a filter value

patch

/fscmRestApi/resources/11.13.18.05/jointVentureProjectSets/{projectSetId}/child/filterSets/{filterSetId}/child/filters/{filterId}/child/filterValues/{filterValueId}

Request

Path Parameters

filterId(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=
filterSetId(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=
filterValueId(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=
projectSetId(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=

Header Parameters

Metadata-Context: string

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: string

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.

Supported Media Types

application/json

Root Schema : schema

Type: object

Show Source

projectFilterValueDFF: array projectFilterValueDFF
value: string

Title: Value

Maximum Length: 255

The value to include in a filter's list of values.

{
    "type":"object",
    "properties":{
        "projectFilterValueDFF":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/jointVentureProjectSets-filterSets-filters-filterValues-projectFilterValueDFF-item-patch-request"
            },
            "x-cardinality":"1"
        },
        "value":{
            "title":"Value",
            "maxLength":255,
            "type":"string",
            "description":"The value to include in a filter's list of values.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        }
    }
}

Nested Schema : projectFilterValueDFF

Type: array

Show Source

Array of: object jointVentureProjectSets-filterSets-filters-filterValues-projectFilterValueDFF-item-patch-request

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/jointVentureProjectSets-filterSets-filters-filterValues-projectFilterValueDFF-item-patch-request"
    },
    "x-cardinality":"1"
}

Nested Schema : jointVentureProjectSets-filterSets-filters-filterValues-projectFilterValueDFF-item-patch-request

Type: object

Show Source

__FLEX_Context: string

Title: Context Segment

Maximum Length: 30

Context Segment
__FLEX_Context_DisplayValue: string

Title: Context Segment

Context Segment

{
    "type":"object",
    "properties":{
        "__FLEX_Context":{
            "title":"Context Segment",
            "maxLength":30,
            "type":"string",
            "description":"Context Segment",
            "nullable":true,
            "x-hints":{
                "help":{
                    "instruction":"Context Segment"
                },
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_IsDiscriminator":"true",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Segment",
            "type":"string",
            "description":"Context Segment",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "help":{
                    "instruction":"Context Segment"
                },
                "DISPLAYHINT":"Hide",
                "FND_ACFF_IsReadOnly":"true",
                "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Name",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        }
    }
}

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 : jointVentureProjectSets-filterSets-filters-filterValues-item-response

Type: object

Show Source

createdBy: string

Title: Created By

Read Only: true

Maximum Length: 64

The user who created the resource item.
creationDate: string (date-time)

Title: Creation Date

Read Only: true

The date and time when the resource item was created.
filterValueId: integer (int64)

Title: Filter Value ID

The unique identifier of the filter value.
lastUpdateDate: string (date-time)

Title: Last Updated Date

Read Only: true

The date and time when the resource item was last updated.
lastUpdatedBy: string

Title: Last Updated By

Read Only: true

Maximum Length: 64

The user who last updated the resource item.
links: array Links

Title: Links

The link relations associated with the resource instance.
projectFilterValueDFF: array projectFilterValueDFF
value: string

Title: Value

Maximum Length: 255

The value to include in a filter's list of values.

{
    "type":"object",
    "properties":{
        "createdBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the resource item.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "creationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the resource item was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "filterValueId":{
            "title":"Filter Value ID",
            "type":"integer",
            "description":"The unique identifier of the filter value.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "fnd:FND_AUDIT_USER_KEY":"true",
                "precision":18,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "lastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the resource item was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "lastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the resource item.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "projectFilterValueDFF":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/jointVentureProjectSets-filterSets-filters-filterValues-projectFilterValueDFF-item-response"
            },
            "x-cardinality":"1"
        },
        "value":{
            "title":"Value",
            "maxLength":255,
            "type":"string",
            "description":"The value to include in a filter's list of values.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"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 : projectFilterValueDFF

Type: array

Show Source

Array of: object jointVentureProjectSets-filterSets-filters-filterValues-projectFilterValueDFF-item-response

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/jointVentureProjectSets-filterSets-filters-filterValues-projectFilterValueDFF-item-response"
    },
    "x-cardinality":"1"
}

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

Nested Schema : jointVentureProjectSets-filterSets-filters-filterValues-projectFilterValueDFF-item-response

Type: object

Show Source

__FLEX_Context: string

Title: Context Segment

Maximum Length: 30

Context Segment
__FLEX_Context_DisplayValue: string

Title: Context Segment

Context Segment
FilterValueId: integer (int64)

Title: Filter Value ID
links: array Links

Title: Links

The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "FilterValueId":{
            "title":"Filter Value ID",
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "__FLEX_Context":{
            "title":"Context Segment",
            "maxLength":30,
            "type":"string",
            "description":"Context Segment",
            "nullable":true,
            "x-hints":{
                "help":{
                    "instruction":"Context Segment"
                },
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_IsDiscriminator":"true",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Segment",
            "type":"string",
            "description":"Context Segment",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "help":{
                    "instruction":"Context Segment"
                },
                "DISPLAYHINT":"Hide",
                "FND_ACFF_IsReadOnly":"true",
                "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Name",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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

Links

projectFilterValueDFF

Operation: /fscmRestApi/resources/11.13.18.05/jointVentureProjectSets/{projectSetId}/child/filterSets/{filterSetId}/child/filters/{filterId}/child/filterValues/{filterValueId}/child/projectFilterValueDFF

Parameters:

filterId: $request.path.filterId
filterSetId: $request.path.filterSetId
filterValueId: $request.path.filterValueId
projectSetId: $request.path.projectSetId

Examples

The following example shows how to update a filter value by submitting a PATCH request on the REST resource using cURL.

curl -i -u "username:password" -H "Content-type: application/json" -X PATCH "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentureProjectSets/300100591586556/child/filterSets/300100591590038/child/filters/300100591593721/child/filterValues/300100591593472"

Example Request Body

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

{
    "value": "HEPP Project 3"
}

Example Response Body

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

{
    "filterValueId": 300100591593472,
    "value": "HEPP Project 3",
    "createdBy": "username",
    "creationDate": "2024-05-22T06:40:54+00:00",
    "lastUpdatedBy": "username",
    "lastUpdateDate": "2024-05-22T06:46:57+00:00",
    "links": [
        {
            "rel": "self",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentureProjectSets/300100591586556/child/filterSets/300100591590038/child/filters/300100591593721/child/filterValues/300100591593472",
            "name": "filterValues",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
            }
        },
        {
            "rel": "canonical",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentureProjectSets/300100591586556/child/filterSets/300100591590038/child/filters/300100591593721/child/filterValues/300100591593472",
            "name": "filterValues",
            "kind": "item"
        },
        {
            "rel": "parent",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentureProjectSets/300100591586556/child/filterSets/300100591590038/child/filters/300100591593721",
            "name": "filters",
            "kind": "item"
        },
        {
            "rel": "child",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentureProjectSets/300100591586556/child/filterSets/300100591590038/child/filters/300100591593721/child/filterValues/300100591593472/child/projectFilterValueDFF",
            "name": "projectFilterValueDFF",
            "kind": "collection"
        }
    ]
}