Jump to

• Request
• Response

Get all value sets

get

<servername>/fscmRestApi/resources/11.13.18.05/valueSets

Request

Query Parameters

• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• finder: string
  Used as a predefined finder to search the collection.
  
  Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
  
  The following are the available finder names and corresponding finder variables:
  
  

  • PrimaryKey
    Finder Variables:
    • ValueSetId
  • ValueSetCodeFinder
    Finder Variables:
    • ValueSetCode
• limit: integer
  This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• offset: integer
  Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
• q: string
  This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
  
  Format: ?q=expression1;expression2
• totalResults: boolean
  The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".

Header Parameters

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

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json
• application/vnd.oracle.adf.resourcecollection+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 : valueSets

Match All

Show Source

• object CollectionProperties
• object valueSets-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/CollectionProperties"
        },
        {
            "type":"object",
            "properties":{
                "items":{
                    "title":"Items",
                    "type":"array",
                    "description":"The items in the collection.",
                    "items":{
                        "$ref":"#/components/schemas/valueSets-item-response"
                    }
                }
            }
        }
    ]
}

Nested Schema : CollectionProperties

Type: object

Show Source

• count(required): integer
  The number of resource instances returned in the current range.
• hasMore(required): boolean
  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The link relations associated with the resource instance.
• offset(required): integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : valueSets-allOf[1]

Type: object

Show Source

• items: array Items
  Title: Items

  The items in the collection.

{
    "type":"object",
    "properties":{
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/valueSets-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 : 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":{
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "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."
        },
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"The value of this attribute changes with each update to the resource instance. The value of the changeIndicator attribute is same as the entity tag (ETag) in the HTTP header."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  The value of this attribute changes with each update to the resource instance. The value of the changeIndicator attribute is same as the entity tag (ETag) in the HTTP header.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"The value of this attribute changes with each update to the resource instance. The value of the changeIndicator attribute is same as the entity tag (ETag) in the HTTP header."
        }
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: valueSets-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/valueSets-item-response"
    }
}

Nested Schema : valueSets-item-response

Match All

Show Source

• object ItemProperties
• object valueSets-item-response-allOf[2]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/ItemProperties"
        },
        {
            "$ref":"#/components/schemas/valueSets-item"
        },
        {
            "type":"object",
            "properties":{
                "validationTable":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/valueSets-validationTable-item-response"
                    }
                },
                "values":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/valueSets-values-item-response"
                    }
                }
            }
        }
    ]
}

Nested Schema : ItemProperties

Type: object

Show Source

• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : valueSets-item

Type: object

Show Source

• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who created the value set.
• CreationDate: string (date-time)
  Read Only: true

  The date when the value set was created.
• DataSecurityObjectName: string
  Title: Data Security Resource Name

  Maximum Length: 60

  The name of the corresponding data security object for this value set. When you enable security on a value set, the data security object name is an existing value set or one that you want to create.
• Description: string
  Title: Description

  Maximum Length: 240

  The description of the value set.
• IndependentValueSetCode: string
  Title: Value Set Code

  Maximum Length: 60

  The value set code of the independent value set.
• IndependentValueSetId: integer (int64)
  Title: Independent Value Set

  The identifier of the independent value set. You can use an independent value set to specify a user-defined set of valid values.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date when the value set was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who last updated the value set.
• MaximumLength: integer (int32)
  Title: Maximum Length

  The maximum number of characters allowed in a value set value.
• MaximumValue: string
  Title: Maximum Value

  Maximum Length: 150

  The maximum character value allowed for the value set.
• MaximumValueDate: string (date)
  Title: Maximum Value

  The maximum date value allowed for the value set.
• MaximumValueNumber: number
  Title: Maximum Value

  The maximum number value allowed for the value set.
• MaximumValueTimestamp: string (date-time)
  Title: Maximum Value

  The maximum timestamp value allowed for the value set.
• MinimumValue: string
  Title: Minimum Value

  Maximum Length: 150

  The minimum character value allowed for the value set.
• MinimumValueDate: string (date)
  Title: Minimum Value

  The minimum date value allowed for the value set.
• MinimumValueNumber: number
  Title: Minimum Value

  The minimum number value allowed for the value set.
• MinimumValueTimestamp: string (date-time)
  Title: Minimum Value

  The minimum timestamp value allowed for the value set.
• ModuleId: string
  Title: Module

  Maximum Length: 32

  The identifier of the module, which is a node at product line, product family, application, or logical business area level.
• Precision: integer (int32)
  Title: Precision

  The maximum number of significant digits allowed for a value set value.
• ProtectedFlag: string
  Title: Protected

  Maximum Length: 1

  Indicates whether the value set is protected aganist updates. The value sets marked as protected can't be edited or deleted.
• Scale: integer (int32)
  Title: Scale

  The maximum number of digits that can follow the decimal point for a value set value.
• SecurityEnabledFlag: string
  Title: Security enabled

  Maximum Length: 1

  Default Value: N

  Indicates whether data security is enabled for the value set value. The default value is false.
• UppercaseOnlyFlag: string
  Title: Uppercase only

  Maximum Length: 1

  Default Value: N

  Indicates whether only uppercase letters are allowed in a value set value. The default value is false.
• ValidationType: string
  Title: Validation Type

  Maximum Length: 30

  The validatuin type describes the way the value set values are validated. For example Dependent, Independent, and Format validation types.
• ValueDataType: string
  Title: Value Data Type

  Maximum Length: 30

  The value data type such as Character, Number, Date, and Date Time.
• ValueSetCode: string
  Title: Value Set Code

  Maximum Length: 60

  The value set code of the value set. For each value set, you can define a context whose code is the value set code, and whose context-sensitive segments are shown for the values of that value set.
• ValueSetId: integer (int64)
  Read Only: true

  The identifier of the value set.
• ValueSubtype: string
  Title: Value Subtype

  Maximum Length: 30

  The value subtype such as Text, Translated text, Numeric digits only, Time (20:08), and Time (20:08:08).
• ZeroFillFlag: string
  Title: Zero fill

  Maximum Length: 1

  Default Value: N

  Indicates whether the value set value is padded on the left with zeroes. The default value is false.

{
    "type":"object",
    "properties":{
        "ValueSetId":{
            "type":"integer",
            "description":"The identifier of the value set.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":false,
                "adf-precision":18,
                "adf-hasDefaultValueExpression":true
            }
        },
        "ModuleId":{
            "title":"Module",
            "maxLength":32,
            "type":"string",
            "description":"The identifier of the module, which is a node at product line, product family, application, or logical business area level.",
            "nullable":false,
            "x-queryable":true,
            "x-hints":{
                "updatable":true
            }
        },
        "ValueSetCode":{
            "title":"Value Set Code",
            "maxLength":60,
            "type":"string",
            "description":"The value set code of the value set. For each value set, you can define a context whose code is the value set code, and whose context-sensitive segments are shown for the values of that value set.",
            "nullable":false,
            "x-queryable":true,
            "x-hints":{
                "updatable":false
            }
        },
        "Description":{
            "title":"Description",
            "maxLength":240,
            "type":"string",
            "description":"The description of the value set.",
            "nullable":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":true
            }
        },
        "ValidationType":{
            "title":"Validation Type",
            "maxLength":30,
            "type":"string",
            "description":"The validatuin type describes the way the value set values are validated. For example Dependent, Independent, and Format validation types.",
            "nullable":false,
            "x-queryable":true,
            "x-hints":{
                "updatable":false
            }
        },
        "ValueDataType":{
            "title":"Value Data Type",
            "maxLength":30,
            "type":"string",
            "description":"The value data type such as Character, Number, Date, and Date Time.",
            "nullable":false,
            "x-queryable":true,
            "x-hints":{
                "updatable":false
            }
        },
        "ValueSubtype":{
            "title":"Value Subtype",
            "maxLength":30,
            "type":"string",
            "description":"The value subtype such as Text, Translated text, Numeric digits only, Time (20:08), and Time (20:08:08).",
            "nullable":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":false
            }
        },
        "ProtectedFlag":{
            "title":"Protected",
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the value set is protected aganist updates. The value sets marked as protected can't be edited or deleted.",
            "nullable":false,
            "x-queryable":true,
            "x-hints":{
                "updatable":true,
                "adf-hasDefaultValueExpression":true
            }
        },
        "MaximumLength":{
            "title":"Maximum Length",
            "type":"integer",
            "description":"The maximum number of characters allowed in a value set value.",
            "format":"int32",
            "nullable":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":true,
                "adf-precision":4
            }
        },
        "Precision":{
            "title":"Precision",
            "type":"integer",
            "description":"The maximum number of significant digits allowed for a value set value.",
            "format":"int32",
            "nullable":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":true,
                "adf-precision":2
            }
        },
        "Scale":{
            "title":"Scale",
            "type":"integer",
            "description":"The maximum number of digits that can follow the decimal point for a value set value.",
            "format":"int32",
            "nullable":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":false,
                "adf-precision":3
            }
        },
        "UppercaseOnlyFlag":{
            "title":"Uppercase only",
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether only uppercase letters are allowed in a value set value. The default value is false.",
            "nullable":true,
            "default":"N",
            "x-queryable":true,
            "x-hints":{
                "updatable":true
            }
        },
        "ZeroFillFlag":{
            "title":"Zero fill",
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the value set value is padded on the left with zeroes. The default value is false.",
            "nullable":true,
            "default":"N",
            "x-queryable":true,
            "x-hints":{
                "updatable":true
            }
        },
        "SecurityEnabledFlag":{
            "title":"Security enabled",
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether data security is enabled for the value set value. The default value is false.",
            "nullable":true,
            "default":"N",
            "x-queryable":true,
            "x-hints":{
                "updatable":true
            }
        },
        "DataSecurityObjectName":{
            "title":"Data Security Resource Name",
            "maxLength":60,
            "type":"string",
            "description":"The name of the corresponding data security object for this value set. When you enable security on a value set, the data security object name is an existing value set or one that you want to create.",
            "nullable":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":true
            }
        },
        "MinimumValue":{
            "title":"Minimum Value",
            "maxLength":150,
            "type":"string",
            "description":"The minimum character value allowed for the value set.",
            "nullable":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":true
            }
        },
        "MinimumValueNumber":{
            "title":"Minimum Value",
            "type":"number",
            "description":"The minimum number value allowed for the value set.",
            "nullable":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":true
            }
        },
        "MinimumValueDate":{
            "title":"Minimum Value",
            "type":"string",
            "description":"The minimum date value allowed for the value set.",
            "format":"date",
            "nullable":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":true
            }
        },
        "MinimumValueTimestamp":{
            "title":"Minimum Value",
            "type":"string",
            "description":"The minimum timestamp value allowed for the value set.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":true
            }
        },
        "MaximumValue":{
            "title":"Maximum Value",
            "maxLength":150,
            "type":"string",
            "description":"The maximum character value allowed for the value set.",
            "nullable":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":true
            }
        },
        "MaximumValueNumber":{
            "title":"Maximum Value",
            "type":"number",
            "description":"The maximum number value allowed for the value set.",
            "nullable":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":true
            }
        },
        "MaximumValueDate":{
            "title":"Maximum Value",
            "type":"string",
            "description":"The maximum date value allowed for the value set.",
            "format":"date",
            "nullable":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":true
            }
        },
        "MaximumValueTimestamp":{
            "title":"Maximum Value",
            "type":"string",
            "description":"The maximum timestamp value allowed for the value set.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":true
            }
        },
        "IndependentValueSetId":{
            "title":"Independent Value Set",
            "type":"integer",
            "description":"The identifier of the independent value set. You can use an independent value set to specify a user-defined set of valid values.",
            "format":"int64",
            "nullable":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":false,
                "adf-precision":18
            }
        },
        "IndependentValueSetCode":{
            "title":"Value Set Code",
            "maxLength":60,
            "type":"string",
            "description":"The value set code of the independent value set.",
            "nullable":false,
            "x-queryable":true,
            "x-hints":{
                "updatable":false
            }
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the value set was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":false
            }
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the value set.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":false
            }
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the value set was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":false
            }
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the value set.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":false
            }
        }
    },
    "x-links":[
        {
            "rel":"lov",
            "method":"get",
            "title":"IndependentValueSetCodeLOV",
            "href":"/fndSetupApi/resources/11.13.18.05/valueSets/{valueSets_Id}/lov/IndependentValueSetCodeLOV",
            "mediaType":"application/vnd.oracle.adf.resourcecollection+json",
            "encType":"application/x-www-form-urlencoded",
            "targetSchema":{
                "$ref":"#/components/schemas/valueSets-IndependentValueSetCodeLOV"
            },
            "schema":{
                "type":"object",
                "properties":{
                    "expand":{
                        "type":"string",
                        "description":"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":{
                        "type":"string",
                        "description":"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.<br><br>Format: ?fields=Attribute1,Attribute2<br><br>Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2"
                    },
                    "onlyData":{
                        "type":"boolean",
                        "description":"The resource item payload will be filtered in order to contain only data (no links section, for example)."
                    },
                    "dependency":{
                        "type":"string",
                        "description":"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<br><br>Format: &lt;attr1&gt;=&lt;val1&gt;,&lt;attr2&gt;=&lt;value2&gt;"
                    },
                    "links":{
                        "type":"string",
                        "description":"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 : &lt;link_relation&gt;<br><br>Example:<br>self,canonical<br>"
                    },
                    "limit":{
                        "type":"integer",
                        "description":"This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources."
                    },
                    "offset":{
                        "type":"integer",
                        "description":"Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0."
                    },
                    "totalResults":{
                        "type":"boolean",
                        "description":"The resource collection representation will include the \"estimated row count\" when \"?totalResults=true\", otherwise the count is not included.  The default value is \"false\"."
                    },
                    "q":{
                        "type":"string",
                        "description":"This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno&gt;=10 and &lt;= 30;Loc!=NY <br><br>Format: ?q=expression1;expression2"
                    },
                    "orderBy":{
                        "type":"string",
                        "description":"This parameter orders a resource collection based on the specified fields.  The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and \"asc\" or \"desc\".  Specify \"asc\" for ascending and \"desc\" for descending. The default value is \"asc\".  For example, ?orderBy=field1:asc,field2:desc"
                    },
                    "finder":{
                        "type":"string",
                        "description":"Used as a predefined finder to search the collection.<br><br>Format: ?finder=&lt;finderName&gt;;&lt;variableName&gt;=&lt;variableValue&gt;,&lt;variableName2&gt;=&lt;variableValue2&gt;<br><br>The following are the available finder names and corresponding finder variables:<br><br>"
                    }
                }
            },
            "adf-attributeMap":[
                {
                    "source":"ValueSetCode",
                    "target":"IndependentValueSetCode"
                },
                {
                    "source":"ValueSetId",
                    "target":"IndependentValueSetId",
                    "derived":true
                }
            ],
            "adf-displayAttributes":[
                "ValueSetCode"
            ]
        }
    ]
}

Nested Schema : valueSets-item-response-allOf[2]

Type: object

Show Source

• validationTable: array validationTable
• values: array values

{
    "type":"object",
    "properties":{
        "validationTable":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/valueSets-validationTable-item-response"
            }
        },
        "values":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/valueSets-values-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 : validationTable

Type: array

Show Source

• Array of: valueSets-validationTable-item-response

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/valueSets-validationTable-item-response"
    }
}

Nested Schema : values

Type: array

Show Source

• Array of: valueSets-values-item-response

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/valueSets-values-item-response"
    }
}

Nested Schema : valueSets-validationTable-item-response

Match All

Show Source

• object ItemProperties
• object valueSets-validationTable-item

{
    "allOf":[
        {
            "$ref":"#/components/schemas/ItemProperties"
        },
        {
            "$ref":"#/components/schemas/valueSets-validationTable-item"
        }
    ]
}

Nested Schema : valueSets-validationTable-item

Type: object

Show Source

• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who created the value set validation table.
• CreationDate: string (date-time)
  Read Only: true

  The date when the value set validation table was created.
• DescriptionColumnLength: integer (int32)
  Title: Description Column Length

  Read Only: true

  The length of the description column.
• DescriptionColumnName: string
  Title: Description Column Name

  Maximum Length: 240

  The column name that holds the description of the value set value.
• DescriptionColumnType: string
  Title: Description Column Type

  Read Only: true

  Maximum Length: 30

  The data type of the description column.
• EnabledFlagColumnName: string
  Title: Enabled Flag Column Name

  Maximum Length: 240

  The column name that holds the enabled flag of the value set value.
• EndDateColumnName: string
  Title: End Date Column Name

  Maximum Length: 240

  The column name that holds the end date of the value set value.
• FromClause: string
  Title: FROM Clause

  Maximum Length: 240

  The SQL FROM clause that identifies the database tables or views on which the value set is based.
• IdColumnLength: integer (int32)
  Title: ID Column Length

  Read Only: true

  The length of the identifier column.
• IdColumnName: string
  Title: ID Column Name

  Maximum Length: 240

  The column name that holds the identifier of the value set value.
• IdColumnType: string
  Title: ID Column Type

  Read Only: true

  Maximum Length: 30

  The data type of the identifier column.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date when the value set validation table was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who last updated the value set validation table.
• OrderByClause: string
  Title: ORDER BY Clause

  Maximum Length: 4000

  The SQL ORDER BY clause that dertermines the order of the value set values in the list of values.
• StartDateColumnName: string
  Title: Start Date Column Name

  Maximum Length: 240

  The column name that holds the start date of the value set value.
• ValueAttributesTableAlias: string
  Title: Value Attributes Table Alias

  Maximum Length: 30

  The SQL alias of the table or view that holds the key flexfield value attribute values.
• ValueColumnLength: integer (int32)
  Title: Value Column Length

  Read Only: true

  The length of the value column.
• ValueColumnName: string
  Title: Value Column Name

  Maximum Length: 240

  The column name that holds the value set value.
• ValueColumnType: string
  Title: Value Column Type

  Read Only: true

  Maximum Length: 30

  The data type of the value column.
• ValueSetId: integer (int64)
  Read Only: true

  The identifier for the parent value set.
• WhereClause: string
  Title: WHERE Clause

  Maximum Length: 4000

  The SQL WHERE clause that filters the rows of the tables or views in the FROM clause.

{
    "type":"object",
    "properties":{
        "ValueSetId":{
            "type":"integer",
            "description":"The identifier for the parent value set.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":false,
                "adf-precision":18
            }
        },
        "FromClause":{
            "title":"FROM Clause",
            "maxLength":240,
            "type":"string",
            "description":"The SQL FROM clause that identifies the database tables or views on which the value set is based.",
            "nullable":false,
            "x-queryable":true,
            "x-hints":{
                "updatable":true
            }
        },
        "WhereClause":{
            "title":"WHERE Clause",
            "maxLength":4000,
            "type":"string",
            "description":"The SQL WHERE clause that filters the rows of the tables or views in the FROM clause.",
            "nullable":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":true,
                "adf-controlType":"edit"
            }
        },
        "OrderByClause":{
            "title":"ORDER BY Clause",
            "maxLength":4000,
            "type":"string",
            "description":"The SQL ORDER BY clause that dertermines the order of the value set values in the list of values.",
            "nullable":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":true
            }
        },
        "ValueColumnName":{
            "title":"Value Column Name",
            "maxLength":240,
            "type":"string",
            "description":"The column name that holds the value set value.",
            "nullable":false,
            "x-queryable":true,
            "x-hints":{
                "updatable":true
            }
        },
        "ValueColumnLength":{
            "title":"Value Column Length",
            "type":"integer",
            "description":"The length of the value column.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":false,
                "adf-precision":4
            }
        },
        "ValueColumnType":{
            "title":"Value Column Type",
            "maxLength":30,
            "type":"string",
            "description":"The data type of the value column.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":false
            }
        },
        "IdColumnName":{
            "title":"ID Column Name",
            "maxLength":240,
            "type":"string",
            "description":"The column name that holds the identifier of the value set value.",
            "nullable":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":true
            }
        },
        "IdColumnLength":{
            "title":"ID Column Length",
            "type":"integer",
            "description":"The length of the identifier column.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":false,
                "adf-precision":4
            }
        },
        "IdColumnType":{
            "title":"ID Column Type",
            "maxLength":30,
            "type":"string",
            "description":"The data type of the identifier column.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":false
            }
        },
        "DescriptionColumnName":{
            "title":"Description Column Name",
            "maxLength":240,
            "type":"string",
            "description":"The column name that holds the description of the value set value.",
            "nullable":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":true
            }
        },
        "DescriptionColumnLength":{
            "title":"Description Column Length",
            "type":"integer",
            "description":"The length of the description column.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":false,
                "adf-precision":4
            }
        },
        "DescriptionColumnType":{
            "title":"Description Column Type",
            "maxLength":30,
            "type":"string",
            "description":"The data type of the description column.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":false
            }
        },
        "EnabledFlagColumnName":{
            "title":"Enabled Flag Column Name",
            "maxLength":240,
            "type":"string",
            "description":"The column name that holds the enabled flag of the value set value.",
            "nullable":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":true
            }
        },
        "StartDateColumnName":{
            "title":"Start Date Column Name",
            "maxLength":240,
            "type":"string",
            "description":"The column name that holds the start date of the value set value.",
            "nullable":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":true
            }
        },
        "EndDateColumnName":{
            "title":"End Date Column Name",
            "maxLength":240,
            "type":"string",
            "description":"The column name that holds the end date of the value set value.",
            "nullable":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":true
            }
        },
        "ValueAttributesTableAlias":{
            "title":"Value Attributes Table Alias",
            "maxLength":30,
            "type":"string",
            "description":"The SQL alias of the table or view that holds the key flexfield value attribute values.",
            "nullable":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":true
            }
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the value set validation table was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":false
            }
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the value set validation table.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":false
            }
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the value set validation table was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":false
            }
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the value set validation table.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":false
            }
        }
    }
}

Nested Schema : valueSets-values-item-response

Match All

Show Source

• object ItemProperties
• object valueSets-values-item

{
    "allOf":[
        {
            "$ref":"#/components/schemas/ItemProperties"
        },
        {
            "$ref":"#/components/schemas/valueSets-values-item"
        }
    ]
}

Nested Schema : valueSets-values-item

Type: object

Show Source

• AccountType: string
  Maximum Length: 30

  Identifies the account type of account segment values.
• ControlAccount: string
  Maximum Length: 30

  Identifies the third party control account.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who created the value.
• CreationDate: string (date-time)
  Read Only: true

  The date when the value was created.
• Description: string
  Title: Description

  Maximum Length: 240

  The description of the value.
• DetailBudgetingAllowed: string
  Maximum Length: 30

  Specifies whether budget entry is allowed for a given segment value.
• DetailPostingAllowed: string
  Maximum Length: 30

  Specifies whether posting is allowed for a given segment value.
• EnabledFlag: string
  Title: Enabled

  Maximum Length: 1

  Default Value: Y

  Indicates whether the value is currently enabled for use. The default value is true.
• EndDateActive: string (date)
  Title: End Date

  The date till which the value is available for use.
• FinancialCategory: string
  Maximum Length: 30

  The financial category of the value.
• IndependentValue: string
  Title: Independent Value

  Maximum Length: 150

  Independent character value.
• IndependentValueDate: string (date)
  Title: Independent Value

  Independent date value.
• IndependentValueNumber: number
  Title: Independent Value

  Independent number value.
• IndependentValueTimestamp: string (date-time)
  Title: Independent Value

  Independent timestamp value.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date when the value was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who last updated the value.
• ReconciliationFlag: string
  Maximum Length: 30

  Indicates whether reconciliation is enabled.
• SortOrder: integer (int64)
  Title: Sort Order

  The number that indicated the order in which the values appear in the list of values.
• StartDateActive: string (date)
  Title: Start Date

  The date from when the value is available for use.
• SummaryFlag: string
  Maximum Length: 30

  Denotes summarization.
• TranslatedValue: string
  Title: Translated Value

  Maximum Length: 150

  Translated value.
• Value: string
  Title: Value

  Maximum Length: 150

  Character value.
• ValueDate: string (date)
  Title: Value

  Date value.
• ValueId: integer (int64)
  Title: Value ID

  Read Only: true

  The identifier for the value set value.
• ValueNumber: number
  Title: Value

  Number value.
• ValueTimestamp: string (date-time)
  Title: Value

  Timestamp value.

{
    "type":"object",
    "properties":{
        "ValueId":{
            "title":"Value ID",
            "type":"integer",
            "description":"The identifier for the value set value.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":false,
                "adf-precision":18,
                "adf-hasDefaultValueExpression":true
            }
        },
        "IndependentValue":{
            "title":"Independent Value",
            "maxLength":150,
            "type":"string",
            "description":"Independent character value.",
            "nullable":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":false
            }
        },
        "IndependentValueNumber":{
            "title":"Independent Value",
            "type":"number",
            "description":"Independent number value.",
            "nullable":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":false
            }
        },
        "IndependentValueDate":{
            "title":"Independent Value",
            "type":"string",
            "description":"Independent date value.",
            "format":"date",
            "nullable":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":false
            }
        },
        "IndependentValueTimestamp":{
            "title":"Independent Value",
            "type":"string",
            "description":"Independent timestamp value.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":false
            }
        },
        "Value":{
            "title":"Value",
            "maxLength":150,
            "type":"string",
            "description":"Character value.",
            "nullable":false,
            "x-queryable":true,
            "x-hints":{
                "updatable":false
            }
        },
        "ValueNumber":{
            "title":"Value",
            "type":"number",
            "description":"Number value.",
            "nullable":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":false
            }
        },
        "ValueDate":{
            "title":"Value",
            "type":"string",
            "description":"Date value.",
            "format":"date",
            "nullable":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":false
            }
        },
        "ValueTimestamp":{
            "title":"Value",
            "type":"string",
            "description":"Timestamp value.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":false
            }
        },
        "TranslatedValue":{
            "title":"Translated Value",
            "maxLength":150,
            "type":"string",
            "description":"Translated value.",
            "nullable":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":true
            }
        },
        "Description":{
            "title":"Description",
            "maxLength":240,
            "type":"string",
            "description":"The description of the value.",
            "nullable":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":true
            }
        },
        "EnabledFlag":{
            "title":"Enabled",
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the value is currently enabled for use. The default value is true.",
            "nullable":false,
            "default":"Y",
            "x-queryable":true,
            "x-hints":{
                "updatable":true
            }
        },
        "StartDateActive":{
            "title":"Start Date",
            "type":"string",
            "description":"The date from when the value is available for use.",
            "format":"date",
            "nullable":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":true
            }
        },
        "EndDateActive":{
            "title":"End Date",
            "type":"string",
            "description":"The date till which the value is available for use.",
            "format":"date",
            "nullable":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":true
            }
        },
        "SortOrder":{
            "title":"Sort Order",
            "type":"integer",
            "description":"The number that indicated the order in which the values appear in the list of values.",
            "format":"int64",
            "nullable":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":true,
                "adf-precision":18
            }
        },
        "SummaryFlag":{
            "maxLength":30,
            "type":"string",
            "description":"Denotes summarization.",
            "nullable":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":true,
                "adf-hasDefaultValueExpression":true
            }
        },
        "DetailPostingAllowed":{
            "maxLength":30,
            "type":"string",
            "description":"Specifies whether posting is allowed for a given segment value.",
            "nullable":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":true,
                "adf-hasDefaultValueExpression":true
            }
        },
        "DetailBudgetingAllowed":{
            "maxLength":30,
            "type":"string",
            "description":"Specifies whether budget entry is allowed for a given segment value.",
            "nullable":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":true,
                "adf-hasDefaultValueExpression":true
            }
        },
        "AccountType":{
            "maxLength":30,
            "type":"string",
            "description":"Identifies the account type of account segment values.",
            "nullable":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":true,
                "adf-hasDefaultValueExpression":true
            }
        },
        "ControlAccount":{
            "maxLength":30,
            "type":"string",
            "description":"Identifies the third party control account.",
            "nullable":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":true,
                "adf-hasDefaultValueExpression":true
            }
        },
        "ReconciliationFlag":{
            "maxLength":30,
            "type":"string",
            "description":"Indicates whether reconciliation is enabled.",
            "nullable":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":true,
                "adf-hasDefaultValueExpression":true
            }
        },
        "FinancialCategory":{
            "maxLength":30,
            "type":"string",
            "description":"The financial category of the value.",
            "nullable":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":true,
                "adf-hasDefaultValueExpression":true
            }
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the value was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":false
            }
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the value.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":false
            }
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the value was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":false
            }
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the value.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":false
            }
        }
    }
}

Back to Top