Jump to

• Request
• Response
• Examples

Update a filter set

patch

/fscmRestApi/resources/11.13.18.05/jointVentureProjectSets/{projectSetId}/child/filterSets/{filterSetId}

Request

Path Parameters

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

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• description: string
  Title: Description

  Maximum Length: 240

  The description of the filter set.
• filters: array Filters
  Title: Filters

  The filters resource is used to view, create, update, or delete filters for a filter set.
• projectFilterSetDFF: array projectFilterSetDFF

{
    "type":"object",
    "properties":{
        "description":{
            "title":"Description",
            "maxLength":240,
            "type":"string",
            "description":"The description of the filter set.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "filters":{
            "title":"Filters",
            "type":"array",
            "description":"The filters resource is used to view, create, update, or delete filters for a filter set.",
            "items":{
                "$ref":"#/components/schemas/jointVentureProjectSets-filterSets-filters-item-patch-request"
            }
        },
        "projectFilterSetDFF":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/jointVentureProjectSets-filterSets-projectFilterSetDFF-item-patch-request"
            },
            "x-cardinality":"1"
        }
    }
}

Nested Schema : Filters

Type: array

Title: Filters

The filters resource is used to view, create, update, or delete filters for a filter set.

Show Source

• Array of: object jointVentureProjectSets-filterSets-filters-item-patch-request

{
    "title":"Filters",
    "type":"array",
    "description":"The filters resource is used to view, create, update, or delete filters for a filter set.",
    "items":{
        "$ref":"#/components/schemas/jointVentureProjectSets-filterSets-filters-item-patch-request"
    }
}

Nested Schema : projectFilterSetDFF

Type: array

Show Source

• Array of: object schema

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

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

Type: object

Show Source

• attribute: string
  Title: Attribute

  The attribute of the filter.
• filterValues: array Filter Values
  Title: Filter Values

  The filter values resource is used to view, create, update, or delete filter values.
• highValue: string
  Title: Value 2

  Maximum Length: 255

  The second value of the filter.
• lowValue: string
  Title: Value 1

  Maximum Length: 255

  The first value of the filter.
• operator: string
  Title: Operator

  The operator of the filter.
• projectFilterDFF: array projectFilterDFF

{
    "type":"object",
    "properties":{
        "attribute":{
            "title":"Attribute",
            "type":"string",
            "description":"The attribute of the filter.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false",
                "dependencies":[
                    "attributeLookupCode"
                ]
            }
        },
        "filterValues":{
            "title":"Filter Values",
            "type":"array",
            "description":"The filter values resource is used to view, create, update, or delete filter values.",
            "items":{
                "$ref":"#/components/schemas/jointVentureProjectSets-filterSets-filters-filterValues-item-patch-request"
            }
        },
        "highValue":{
            "title":"Value 2",
            "maxLength":255,
            "type":"string",
            "description":"The second value of the filter.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "lowValue":{
            "title":"Value 1",
            "maxLength":255,
            "type":"string",
            "description":"The first value of the filter.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "operator":{
            "title":"Operator",
            "type":"string",
            "description":"The operator of the filter.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false",
                "dependencies":[
                    "operatorLookupCode"
                ]
            }
        },
        "projectFilterDFF":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/jointVentureProjectSets-filterSets-filters-projectFilterDFF-item-patch-request"
            },
            "x-cardinality":"1"
        }
    }
}

Nested Schema : Filter Values

Type: array

Title: Filter Values

The filter values resource is used to view, create, update, or delete filter values.

Show Source

• Array of: object schema

{
    "title":"Filter Values",
    "type":"array",
    "description":"The filter values resource is used to view, create, update, or delete filter values.",
    "items":{
        "$ref":"#/components/schemas/jointVentureProjectSets-filterSets-filters-filterValues-item-patch-request"
    }
}

Nested Schema : projectFilterDFF

Type: array

Show Source

• Array of: object schema

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

Nested 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 schema

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

Nested Schema : schema

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

Nested Schema : schema

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

Nested Schema : schema

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

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 : jointVentureProjectSets-filterSets-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.
• description: string
  Title: Description

  Maximum Length: 240

  The description of the filter set.
• filters: array Filters
  Title: Filters

  The filters resource is used to view, create, update, or delete filters for a filter set.
• filterSet: string
  Title: Filter Set

  Maximum Length: 30

  The unique name of the filter set.
• filterSetId: integer (int64)
  Title: Filter Set ID

  The unique identifier of the filter set.
• 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.
• projectFilterSetDFF: array projectFilterSetDFF

{
    "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
        },
        "description":{
            "title":"Description",
            "maxLength":240,
            "type":"string",
            "description":"The description of the filter set.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "filterSet":{
            "title":"Filter Set",
            "maxLength":30,
            "type":"string",
            "description":"The unique name of the filter set.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "filterSetId":{
            "title":"Filter Set ID",
            "type":"integer",
            "description":"The unique identifier of the filter set.",
            "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
        },
        "filters":{
            "title":"Filters",
            "type":"array",
            "description":"The filters resource is used to view, create, update, or delete filters for a filter set.",
            "items":{
                "$ref":"#/components/schemas/jointVentureProjectSets-filterSets-filters-item-response"
            }
        },
        "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"
            }
        },
        "projectFilterSetDFF":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/jointVentureProjectSets-filterSets-projectFilterSetDFF-item-response"
            },
            "x-cardinality":"1"
        }
    }
}

Nested Schema : Filters

Type: array

Title: Filters

The filters resource is used to view, create, update, or delete filters for a filter set.

Show Source

• Array of: object jointVentureProjectSets-filterSets-filters-item-response

{
    "title":"Filters",
    "type":"array",
    "description":"The filters resource is used to view, create, update, or delete filters for a filter set.",
    "items":{
        "$ref":"#/components/schemas/jointVentureProjectSets-filterSets-filters-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 : projectFilterSetDFF

Type: array

Show Source

• Array of: object jointVentureProjectSets-filterSets-projectFilterSetDFF-item-response

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

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

Type: object

Show Source

• attribute: string
  Title: Attribute

  The attribute of the filter.
• 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.
• filterId: integer (int64)
  Title: Filter ID

  The unique identifier of the filter.
• filterValues: array Filter Values
  Title: Filter Values

  The filter values resource is used to view, create, update, or delete filter values.
• highValue: string
  Title: Value 2

  Maximum Length: 255

  The second value of the filter.
• 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.
• lowValue: string
  Title: Value 1

  Maximum Length: 255

  The first value of the filter.
• operator: string
  Title: Operator

  The operator of the filter.
• projectFilterDFF: array projectFilterDFF

{
    "type":"object",
    "properties":{
        "attribute":{
            "title":"Attribute",
            "type":"string",
            "description":"The attribute of the filter.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false",
                "dependencies":[
                    "attributeLookupCode"
                ]
            }
        },
        "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
        },
        "filterId":{
            "title":"Filter ID",
            "type":"integer",
            "description":"The unique identifier of the filter.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "filterValues":{
            "title":"Filter Values",
            "type":"array",
            "description":"The filter values resource is used to view, create, update, or delete filter values.",
            "items":{
                "$ref":"#/components/schemas/jointVentureProjectSets-filterSets-filters-filterValues-item-response"
            }
        },
        "highValue":{
            "title":"Value 2",
            "maxLength":255,
            "type":"string",
            "description":"The second value of the filter.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"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"
            }
        },
        "lowValue":{
            "title":"Value 1",
            "maxLength":255,
            "type":"string",
            "description":"The first value of the filter.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "operator":{
            "title":"Operator",
            "type":"string",
            "description":"The operator of the filter.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false",
                "dependencies":[
                    "operatorLookupCode"
                ]
            }
        },
        "projectFilterDFF":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/jointVentureProjectSets-filterSets-filters-projectFilterDFF-item-response"
            },
            "x-cardinality":"1"
        }
    }
}

Nested Schema : Filter Values

Type: array

Title: Filter Values

The filter values resource is used to view, create, update, or delete filter values.

Show Source

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

{
    "title":"Filter Values",
    "type":"array",
    "description":"The filter values resource is used to view, create, update, or delete filter values.",
    "items":{
        "$ref":"#/components/schemas/jointVentureProjectSets-filterSets-filters-filterValues-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 : projectFilterDFF

Type: array

Show Source

• Array of: object jointVentureProjectSets-filterSets-filters-projectFilterDFF-item-response

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

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

Nested Schema : jointVentureProjectSets-filterSets-filters-projectFilterDFF-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
• FilterId: integer (int64)
  Title: Filter ID
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "FilterId":{
            "title":"Filter 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"
    }
}

Nested Schema : jointVentureProjectSets-filterSets-projectFilterSetDFF-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
• FilterSetId: integer (int64)
  Title: Filter Set ID
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "FilterSetId":{
            "title":"Filter Set 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

filters

Operation: /fscmRestApi/resources/11.13.18.05/jointVentureProjectSets/{projectSetId}/child/filterSets/{filterSetId}/child/filters

Parameters:

• filterSetId: $request.path.filterSetId
• projectSetId: $request.path.projectSetId

The filters resource is used to view, create, update, or delete filters for a filter set.

projectFilterSetDFF

Operation: /fscmRestApi/resources/11.13.18.05/jointVentureProjectSets/{projectSetId}/child/filterSets/{filterSetId}/child/projectFilterSetDFF

Parameters:

• filterSetId: $request.path.filterSetId
• projectSetId: $request.path.projectSetId

Back to Top

Examples

The following example shows how to update a project set filter set by submitting a POST 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

Example Request Body

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

{
    "description":"Phase 1 survey costs"
}

Example Response Body

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

{
    "filterSetId": 300100591590038,
    "filterSet": "JV1SURVEYING",
    "description": "Phase 1 survey costs",
    "createdBy": "username",
    "creationDate": "2024-05-22T05:48:06+00:00",
    "lastUpdatedBy": "username",
    "lastUpdateDate": "2024-05-22T05:53:50+00:00",
    "links": [
        {
            "rel": "self",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentureProjectSets/300100591586556/child/filterSets/300100591590038",
            "name": "filterSets",
            "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",
            "name": "filterSets",
            "kind": "item"
        },
        {
            "rel": "parent",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentureProjectSets/300100591586556",
            "name": "jointVentureProjectSets",
            "kind": "item"
        },
        {
            "rel": "child",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentureProjectSets/300100591586556/child/filterSets/300100591590038/child/filters",
            "name": "filters",
            "kind": "collection"
        },
        {
            "rel": "child",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentureProjectSets/300100591586556/child/filterSets/300100591590038/child/projectFilterSetDFF",
            "name": "projectFilterSetDFF",
            "kind": "collection"
        }
    ]
}

Back to Top