Jump to

• Request
• Response

Get all enumerations

get

/fscmRestApi/resources/11.13.18.05/publicSectorOpaEnumerations

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: Finds the record that matches the primary key criteria.
    Finder Variables:
    • EnumName; string; The name of the enumeration.
  • SimpleSearchFinder: Finds the enumeration that matches the specified keyword.
    Finder Variables:
    • value; string; The keyword that is used to find an enumeration by enumeration name or child enumeration name.
• 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
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • ChildEnumName; string; The name of the child enumeration.
  • CreatedBy; string; The name of the user who created the enumeration.
  • CreatedOn; string; The date on which the enumeration was created.
  • CreationDate; string; The date on which the enumeration was created.
  • DeletedFlag; string; Indicates if the enumeration is logically deleted. Valid values are Y for deleted, and N for existing enumeration. The default value is N.
  • Description; string; The description of the enumeration.
  • EnumName; string; The name of the enumeration.
  • EnumType; string; The data type of the enumeration.
  • LastUpdateDate; string; The name of the user who last updated the enumeration.
  • LastUpdatedBy; string; The date on which the enumeration was last updated.
  • OwnerId; string; The identifier of the owner who is associated with the enumeration.
  • SeedDataLock; integer; Indicates if the enumeration is a seed data. Valid values are 0 for the data that is customer data, 1 for the seed data that cannot be modified, and 2 indicates that the seed data can be modified.
  • UncertainValue; string; Indicates that the value for the enumeration is uncertain.
  • UsesCustomTable; string; Indicates if the enumeration uses a user-defined table. Valid values are Y or N.
  • ViewObjectId; number; The identifier of the View object that is associated with the enumeration.
• 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:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

There's no request body for this operation.

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

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.
• items: array Items
  Title: Items

  The items in the collection.
• 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."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "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."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/publicSectorOpaEnumerations-item-response"
            }
        }
    },
    "x-hints":{
        "subgroup":"SharedServices",
        "usage":"BusinessObject",
        "group":"psc"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object publicSectorOpaEnumerations-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/publicSectorOpaEnumerations-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 : publicSectorOpaEnumerations-item-response

Type: object

Show Source

• ChildEnumName: string
  Title: Child Enumeration Name

  Maximum Length: 30

  The name of the child enumeration.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The name of the user who created the enumeration.
• CreatedOn: string (date-time)
  The date on which the enumeration was created.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date on which the enumeration was created.
• DeletedFlag: string
  Maximum Length: 1

  Default Value: N

  Indicates if the enumeration is logically deleted. Valid values are Y for deleted, and N for existing enumeration. The default value is N.
• Description: string
  Title: Description

  Maximum Length: 100

  The description of the enumeration.
• EnumName: string
  Title: Enumeration Name

  Maximum Length: 30

  The name of the enumeration.
• EnumType: string
  Title: Enumeration Type

  Maximum Length: 10

  The data type of the enumeration.
• EnumValueService: array Enumeration Values
  Title: Enumeration Values

  The enumeration values resource is used to view the values associated to a particular enumeration name.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The name of the user who last updated the enumeration.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The date on which the enumeration was last updated.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• OwnerId: string
  Maximum Length: 10

  The identifier of the owner who is associated with the enumeration.
• SeedDataLock: integer (int32)
  Default Value: 0

  Indicates if the enumeration is a seed data. Valid values are 0 for the data that is customer data, 1 for the seed data that cannot be modified, and 2 indicates that the seed data can be modified.
• UncertainValue: string
  Title: Uncertain Value

  Maximum Length: 40

  Indicates that the value for the enumeration is uncertain.
• UsesCustomTable: string
  Maximum Length: 1

  Indicates if the enumeration uses a user-defined table. Valid values are Y or N.
• ViewObjectId: number
  Title: View Object ID

  The identifier of the View object that is associated with the enumeration.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The date on which the enumeration was last updated.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date on which the enumeration was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The name of the user who created the enumeration.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":"100",
            "type":"string",
            "description":"The description of the enumeration.",
            "nullable":true,
            "x-queryable":true
        },
        "EnumName":{
            "title":"Enumeration Name",
            "maxLength":"30",
            "type":"string",
            "description":"The name of the enumeration.",
            "nullable":false,
            "x-queryable":true
        },
        "SeedDataLock":{
            "type":"integer",
            "description":"Indicates if the enumeration is a seed data. Valid values are 0 for the data that is customer data, 1 for the seed data that cannot be modified, and 2 indicates that the seed data can be modified.",
            "format":"int32",
            "nullable":false,
            "default":"0",
            "x-hints":{
                "precision":"1"
            },
            "x-queryable":true
        },
        "ChildEnumName":{
            "title":"Child Enumeration Name",
            "maxLength":"30",
            "type":"string",
            "description":"The name of the child enumeration.",
            "nullable":true,
            "x-queryable":true
        },
        "EnumValueService":{
            "title":"Enumeration Values",
            "type":"array",
            "description":"The enumeration values resource is used to view the values associated to a particular enumeration name.",
            "items":{
                "$ref":"#/components/schemas/publicSectorOpaEnumerations-EnumValueService-item-response"
            }
        },
        "OwnerId":{
            "maxLength":"10",
            "type":"string",
            "description":"The identifier of the owner who is associated with the enumeration.",
            "nullable":true,
            "x-queryable":true
        },
        "EnumType":{
            "title":"Enumeration Type",
            "maxLength":"10",
            "type":"string",
            "description":"The data type of the enumeration.",
            "nullable":true,
            "x-queryable":true
        },
        "DeletedFlag":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates if the enumeration is logically deleted. Valid values are Y for deleted, and N for existing enumeration. The default value is N.",
            "nullable":false,
            "default":"N",
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "UncertainValue":{
            "title":"Uncertain Value",
            "maxLength":"40",
            "type":"string",
            "description":"Indicates that the value for the enumeration is uncertain.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedOn":{
            "type":"string",
            "description":"The date on which the enumeration was created.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "UsesCustomTable":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates if the enumeration uses a user-defined table. Valid values are Y or N.",
            "nullable":true,
            "x-queryable":true
        },
        "ViewObjectId":{
            "title":"View Object ID",
            "type":"number",
            "description":"The identifier of the View object that is associated with the enumeration.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The name of the user who last updated the enumeration.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Enumeration Values

Type: array

Title: Enumeration Values

The enumeration values resource is used to view the values associated to a particular enumeration name.

Show Source

• Array of: object publicSectorOpaEnumerations-EnumValueService-item-response

{
    "title":"Enumeration Values",
    "type":"array",
    "description":"The enumeration values resource is used to view the values associated to a particular enumeration name.",
    "items":{
        "$ref":"#/components/schemas/publicSectorOpaEnumerations-EnumValueService-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 : publicSectorOpaEnumerations-EnumValueService-item-response

Type: object

Show Source

• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The name of the user who created the enumeration value.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date on which the enumeration value was created.
• DeletedFlag: string
  Maximum Length: 1

  Default Value: N

  Indicates if the enumeration value is logically deleted. Valid values are Y for deleted, and N for an existing enumeration value. The default value is N.
• Description: string
  Title: Description

  Maximum Length: 30

  The description of the enumeration value.
• EnumName: string
  Title: Enumeration Name

  Maximum Length: 30

  The name of the enumeration that is associated with the enumeration value.
• EnumValue: string
  Title: Enumeration Value

  Maximum Length: 50

  The value of the enumeration.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date on which the enumeration value was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The name of the user who last updated the enumeration value.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• OwnerId: string
  Maximum Length: 10

  The identifier of the owner who is associated with the enumeration value.
• SeedDataLock: integer (int32)
  Default Value: 0

  Indicates if the enumeration value is a seed data. Valid values are 0 for the data that is customer data, 1 for seed data that cannot be modified, and 2 indicates that the seed data can be modified.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The name of the user who last updated the enumeration value.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date on which the enumeration value was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The name of the user who created the enumeration value.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":"30",
            "type":"string",
            "description":"The description of the enumeration value.",
            "nullable":true,
            "x-queryable":true
        },
        "OwnerId":{
            "maxLength":"10",
            "type":"string",
            "description":"The identifier of the owner who is associated with the enumeration value.",
            "nullable":true,
            "x-queryable":true
        },
        "EnumName":{
            "title":"Enumeration Name",
            "maxLength":"30",
            "type":"string",
            "description":"The name of the enumeration that is associated with the enumeration value.",
            "nullable":false,
            "x-queryable":true
        },
        "EnumValue":{
            "title":"Enumeration Value",
            "maxLength":"50",
            "type":"string",
            "description":"The value of the enumeration.",
            "nullable":false,
            "x-queryable":true
        },
        "SeedDataLock":{
            "type":"integer",
            "description":"Indicates if the enumeration value is a seed data. Valid values are 0 for the data that is customer data, 1 for seed data that cannot be modified, and 2 indicates that the seed data can be modified.",
            "format":"int32",
            "nullable":false,
            "default":"0",
            "x-hints":{
                "precision":"1"
            },
            "x-queryable":true
        },
        "DeletedFlag":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates if the enumeration value is logically deleted. Valid values are Y for deleted, and N for an existing enumeration value. The default value is N.",
            "nullable":false,
            "default":"N",
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date on which the enumeration value was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":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 : 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."
        }
    }
}

Back to Top