Jump to

• Request
• Response

Get all job attributes

get

/fscmRestApi/resources/11.13.18.05/publicSectorJobFuncSections

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 job attribute row that matches the specified primary key criteria.
    Finder Variables:
    • JobFuncSecId; string; The key identifier of the job attribute.
• 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:
  

  • CreatedBy; string; The name of user who created the row.
  • CreationDate; string; The date and time when the row was created.
  • DeletedFlag; string; Indicates whether the job attribute is logically deleted (Y or N). Valid values are Y for a deleted record, and N for an active record. The default value is N.
  • EnabledFlag; string; Indicates that the job attribute is ready to be used.
  • InheritAllValues; string; Indicates if all the returned values will be assigned.
  • JobFuncSecDescr; string; The description of the job attribute.
  • JobFuncSecId; string; The unique identifier for the job attribute.
  • LastUpdateDate; string; The date and time when the row was last updated.
  • LastUpdatedBy; string; The name of the user who last updated the row.
  • PromptTableKey1; string; Identifies the assignable value from the list of values returned by using the URL in the "RestResourceId" attribute.
  • PromptTableKey10; string; An additional identifier of the assignable value retrieved from the "RestResourceId" attribute.
  • PromptTableKey2; string; An additional identifier of the assignable value retrieved from the "RestResourceId" attribute.
  • PromptTableKey3; string; An additional identifier of the assignable value retrieved from the "RestResourceId" attribute.
  • PromptTableKey4; string; An additional identifier of the assignable value retrieved from the "RestResourceId" attribute.
  • PromptTableKey5; string; An additional identifier of the assignable value retrieved from the "RestResourceId" attribute.
  • PromptTableKey6; string; An additional identifier of the assignable value retrieved from the "RestResourceId" attribute.
  • PromptTableKey7; string; An additional identifier of the assignable value retrieved from the "RestResourceId" attribute.
  • PromptTableKey8; string; An additional identifier of the assignable value retrieved from the "RestResourceId" attribute.
  • PromptTableKey9; string; An additional identifier of the assignable value retrieved from the "RestResourceId" attribute.
  • PromptTableName; string; The name of the table in which the values will be edited.
  • SectionReturnValue; string; Indicates the type of the values that are returned.
  • SeedDataLock; integer; Indicates whether the row is seed data. Valid values are 0 for customer data, 1 for seed data that cannot be modified, and a value greater than 1 indicates that the seed data can be modified.
• 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 : publicSectorJobFuncSections

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/publicSectorJobFuncSections-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 publicSectorJobFuncSections-item-response

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

Type: object

Show Source

• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

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

  Read Only: true

  The date and time when the row was created.
• DeletedFlag: string
  Maximum Length: 1

  Indicates whether the job attribute is logically deleted (Y or N). Valid values are Y for a deleted record, and N for an active record. The default value is N.
• EnabledFlag: string
  Title: Enabled

  Maximum Length: 1

  Indicates that the job attribute is ready to be used.
• InheritAllValues: string
  Title: Inherit All Values

  Maximum Length: 1

  Indicates if all the returned values will be assigned.
• JobFuncSecDescr: string
  Title: Job Attribute

  Maximum Length: 100

  The description of the job attribute.
• JobFuncSecId: string
  Title: Job Attribute ID

  Maximum Length: 50

  The unique identifier for the job attribute.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

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

  Read Only: true

  Maximum Length: 64

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

  The link relations associated with the resource instance.
• PromptTableKey1: string
  Title: Prompt Field 1

  Maximum Length: 100

  Identifies the assignable value from the list of values returned by using the URL in the "RestResourceId" attribute.
• PromptTableKey10: string
  Maximum Length: 100

  An additional identifier of the assignable value retrieved from the "RestResourceId" attribute.
• PromptTableKey2: string
  Title: Prompt Field 2

  Maximum Length: 100

  An additional identifier of the assignable value retrieved from the "RestResourceId" attribute.
• PromptTableKey3: string
  Title: Prompt Field 3

  Maximum Length: 100

  An additional identifier of the assignable value retrieved from the "RestResourceId" attribute.
• PromptTableKey4: string
  Title: Prompt Field 4

  Maximum Length: 100

  An additional identifier of the assignable value retrieved from the "RestResourceId" attribute.
• PromptTableKey5: string
  Title: Prompt Field 5

  Maximum Length: 100

  An additional identifier of the assignable value retrieved from the "RestResourceId" attribute.
• PromptTableKey6: string
  Maximum Length: 100

  An additional identifier of the assignable value retrieved from the "RestResourceId" attribute.
• PromptTableKey7: string
  Maximum Length: 100

  An additional identifier of the assignable value retrieved from the "RestResourceId" attribute.
• PromptTableKey8: string
  Maximum Length: 100

  An additional identifier of the assignable value retrieved from the "RestResourceId" attribute.
• PromptTableKey9: string
  Maximum Length: 100

  An additional identifier of the assignable value retrieved from the "RestResourceId" attribute.
• PromptTableName: string
  Maximum Length: 100

  The name of the table in which the values will be edited.
• RestResourceId: string
  Title: Rest Resource URL

  Maximum Length: 1000

  The uniform resource locater from which the look up values will be retrieved.
• RestResourceParameter: string
  Title: URL Parameters

  Maximum Length: 1000

  Allows the input of the additional query parameters that are to be included in the rest resource URL.
• SectionReturnValue: string
  Title: Return Value Type

  Maximum Length: 4

  Indicates the type of the values that are returned.
• SeedDataLock: integer (int32)
  Indicates whether the row is seed data. Valid values are 0 for customer data, 1 for seed data that cannot be modified, and a value greater than 1 indicates that the seed data can be modified.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the row was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PromptTableKey9":{
            "maxLength":"100",
            "type":"string",
            "description":"An additional identifier of the assignable value retrieved from the \"RestResourceId\" attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "JobFuncSecDescr":{
            "title":"Job Attribute",
            "maxLength":"100",
            "type":"string",
            "description":"The description of the job attribute.",
            "nullable":false,
            "x-queryable":true
        },
        "PromptTableKey6":{
            "maxLength":"100",
            "type":"string",
            "description":"An additional identifier of the assignable value retrieved from the \"RestResourceId\" attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "PromptTableKey5":{
            "title":"Prompt Field 5",
            "maxLength":"100",
            "type":"string",
            "description":"An additional identifier of the assignable value retrieved from the \"RestResourceId\" attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "PromptTableKey8":{
            "maxLength":"100",
            "type":"string",
            "description":"An additional identifier of the assignable value retrieved from the \"RestResourceId\" attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "PromptTableKey7":{
            "maxLength":"100",
            "type":"string",
            "description":"An additional identifier of the assignable value retrieved from the \"RestResourceId\" attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "SectionReturnValue":{
            "title":"Return Value Type",
            "maxLength":"4",
            "type":"string",
            "description":"Indicates the type of the values that are returned.",
            "nullable":false,
            "x-queryable":true
        },
        "PromptTableName":{
            "maxLength":"100",
            "type":"string",
            "description":"The name of the table in which the values will be edited.",
            "nullable":true,
            "x-queryable":true
        },
        "JobFuncSecId":{
            "title":"Job Attribute ID",
            "maxLength":"50",
            "type":"string",
            "description":"The unique identifier for the job attribute.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "RestResourceId":{
            "title":"Rest Resource URL",
            "maxLength":"1000",
            "type":"string",
            "description":"The uniform resource locater from which the look up values will be retrieved.",
            "nullable":true,
            "x-queryable":false
        },
        "EnabledFlag":{
            "title":"Enabled",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates that the job attribute is ready to be used.",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The name of the user who last updated the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RestResourceParameter":{
            "title":"URL Parameters",
            "maxLength":"1000",
            "type":"string",
            "description":"Allows the input of the additional query parameters that are to be included in the rest resource URL.",
            "nullable":true,
            "x-queryable":false
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The name of user who created the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SeedDataLock":{
            "type":"integer",
            "description":"Indicates whether the row is seed data. Valid values are 0 for customer data, 1 for seed data that cannot be modified, and a value greater than 1 indicates that the seed data can be modified.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"1"
            },
            "x-queryable":true
        },
        "PromptTableKey10":{
            "maxLength":"100",
            "type":"string",
            "description":"An additional identifier of the assignable value retrieved from the \"RestResourceId\" attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "InheritAllValues":{
            "title":"Inherit All Values",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates if all the returned values will be assigned.",
            "nullable":false,
            "x-queryable":true
        },
        "PromptTableKey2":{
            "title":"Prompt Field 2",
            "maxLength":"100",
            "type":"string",
            "description":"An additional identifier of the assignable value retrieved from the \"RestResourceId\" attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "DeletedFlag":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the job attribute is logically deleted (Y or N). Valid values are Y for a deleted record,  and N for an active record. The default value is N.",
            "nullable":true,
            "x-queryable":true
        },
        "PromptTableKey1":{
            "title":"Prompt Field 1",
            "maxLength":"100",
            "type":"string",
            "description":"Identifies the assignable value from the list of values returned by using the URL in the \"RestResourceId\" attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "PromptTableKey4":{
            "title":"Prompt Field 4",
            "maxLength":"100",
            "type":"string",
            "description":"An additional identifier of the assignable value retrieved from the \"RestResourceId\" attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "PromptTableKey3":{
            "title":"Prompt Field 3",
            "maxLength":"100",
            "type":"string",
            "description":"An additional identifier of the assignable value retrieved from the \"RestResourceId\" attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the row 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