Jump to

• Request
• Response
• Examples

Create a filter

post

/fscmRestApi/resources/11.13.18.05/jointVentureAccountSets/{accountSetId}/child/filterSets/{filterSetId}/child/filters

Request

Path Parameters

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

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.
• Upsert-Mode:
  Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• filterDFF: array filterDFF
• highValue: string
  Title: High Value

  Maximum Length: 25

  The high value of the filter.
• lowValue: string
  Title: Low Value

  Maximum Length: 25

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

  The operator of the filter.
• segment: string
  Title: Segment

  The segment name of the filter.

{
    "type":"object",
    "properties":{
        "lowValue":{
            "title":"Low Value",
            "maxLength":"25",
            "type":"string",
            "description":"The low value of the filter.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "filterDFF":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/jointVentureAccountSets-filterSets-filters-filterDFF-item-post-request"
            },
            "x-cardinality":"1"
        },
        "highValue":{
            "title":"High Value",
            "maxLength":"25",
            "type":"string",
            "description":"The high 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"
                ]
            }
        },
        "segment":{
            "title":"Segment",
            "type":"string",
            "description":"The segment name of the filter.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        }
    }
}

Nested Schema : filterDFF

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/jointVentureAccountSets-filterSets-filters-filterDFF-item-post-request"
    },
    "x-cardinality":"1"
}

Nested Schema : schema

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Segment

  Maximum Length: 150
• __FLEX_Context_DisplayValue: string
  Title: Context Segment
• AccountFilterId: integer (int64)
  Title: Filter ID

{
    "type":"object",
    "properties":{
        "AccountFilterId":{
            "title":"Filter ID",
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Segment",
            "type":"string",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "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"
                }
            }
        },
        "__FLEX_Context":{
            "title":"Context Segment",
            "maxLength":"150",
            "type":"string",
            "nullable":true,
            "x-hints":{
                "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"
                }
            }
        }
    }
}

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

Type: object

Show Source

• createdBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

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

  Read Only: true

  The date and time when the filter was created.
• filterDFF: array filterDFF
• filterId: integer (int64)
  Title: Filter ID

  Read Only: true

  The unique identifier of the filter.
• highValue: string
  Title: High Value

  Maximum Length: 25

  The high value of the filter.
• lastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

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

  Read Only: true

  Maximum Length: 64

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

  The link relations associated with the resource instance.
• lowValue: string
  Title: Low Value

  Maximum Length: 25

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

  The operator of the filter.
• segment: string
  Title: Segment

  The segment name of the filter.

{
    "type":"object",
    "properties":{
        "filterId":{
            "title":"Filter ID",
            "type":"integer",
            "description":"The unique identifier of the filter.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "fnd:FND_AUDIT_USER_KEY":"true",
                "precision":"18",
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "lastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the filter.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "lowValue":{
            "title":"Low Value",
            "maxLength":"25",
            "type":"string",
            "description":"The low value of the filter.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "highValue":{
            "title":"High Value",
            "maxLength":"25",
            "type":"string",
            "description":"The high value of the filter.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "createdBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the filter.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "lastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the filter was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "segment":{
            "title":"Segment",
            "type":"string",
            "description":"The segment name of the filter.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "filterDFF":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/jointVentureAccountSets-filterSets-filters-filterDFF-item-response"
            },
            "x-cardinality":"1"
        },
        "creationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the filter was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":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"
                ]
            }
        }
    }
}

Nested Schema : filterDFF

Type: array

Show Source

• Array of: object jointVentureAccountSets-filterSets-filters-filterDFF-item-response

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/jointVentureAccountSets-filterSets-filters-filterDFF-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 : jointVentureAccountSets-filterSets-filters-filterDFF-item-response

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Segment

  Maximum Length: 150
• __FLEX_Context_DisplayValue: string
  Title: Context Segment
• AccountFilterId: integer (int64)
  Title: Filter ID
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "AccountFilterId":{
            "title":"Filter ID",
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Segment",
            "type":"string",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "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
        },
        "__FLEX_Context":{
            "title":"Context Segment",
            "maxLength":"150",
            "type":"string",
            "nullable":true,
            "x-hints":{
                "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
        }
    }
}

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

Links

filterDFF

Operation: /fscmRestApi/resources/11.13.18.05/jointVentureAccountSets/{accountSetId}/child/filterSets/{filterSetId}/child/filters/{filterId}/child/filterDFF

Parameters:

• accountSetId: $request.path.accountSetId
• filterId: $request.path.filterId
• filterSetId: $request.path.filterSetId

Back to Top

Examples

The following example shows how to create a filter by submitting a POST request on the REST resource using cURL.

curl -i -u "username:password" -H "Content-type: application/json" -X POST -d <payload> "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentureAccountSets/300100548889109/child/filterSets/300100548888128/child/filters"

Example Request Body

The following example shows the contents of the request body in JSON format:

{
   "segment":"HEPPCompany",
   "operator":"Equal",
   "highValue":null,
   "lowValue":"89"
}

Example Response Body

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

{
   "filterId":300100548887231,
   "segment":"HEPPCompany",
   "operator":"Equal",
   "lowValue":"89",
   "highValue":null,
   "createdBy":"username",
   "creationDate":"2021-12-02T08:15:47+00:00",
   "lastUpdatedBy":"username",
   "lastUpdateDate":"2021-12-02T08:15:47.056+00:00",
   "links":[
      {
         "rel":"self",
         "href":"https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentureAccountSets/300100548889109/child/filterSets/300100548888128/child/filters/300100548887231",
         "name":"filters",
         "kind":"item",
         "properties":{
            "changeIndicator":"ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
         }
      },
      {
         "rel":"canonical",
         "href":"https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentureAccountSets/300100548889109/child/filterSets/300100548888128/child/filters/300100548887231",
         "name":"filters",
         "kind":"item"
      },
      {
         "rel":"parent",
         "href":"https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentureAccountSets/300100548889109/child/filterSets/300100548888128",
         "name":"filterSets",
         "kind":"item"
      },
      {
         "rel":"child",
         "href":"https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentureAccountSets/300100548889109/child/filterSets/300100548888128/child/filters/300100548887231/child/filterDFF",
         "name":"filterDFF",
         "kind":"collection"
      }
   ]
}

Back to Top