Create a time expense category
post
/fscmRestApi/resources/11.13.18.05/publicSectorTimeExpenseCategories
Request
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
AgencyId: integer
(int32)
Title:
Agency ID
Default Value:1
The identifier for the public sector agency associated with the time expense category. -
Category(required): string
Title:
Category
Maximum Length:40
The name for the time expense category. -
CategoryId(required): string
Title:
Category ID
Maximum Length:30
The unique identifier for the time expense category. -
Description: string
Title:
Description
Maximum Length:500
The description for the time expense category. -
EnabledFlag(required): boolean
Title:
Enabled
Maximum Length:1
Indicates whether the time expense category is enabled in time entry type setup. -
TimeExpenseSubcategory: array
Time Expense Subcategories
Title:
Time Expense Subcategories
Time Expense Subcategories associated with this Time Expense Category.
Nested Schema : Time Expense Subcategories
Type:
array
Title:
Time Expense Subcategories
Time Expense Subcategories associated with this Time Expense Category.
Show Source
Nested Schema : publicSectorTimeExpenseCategories-TimeExpenseSubcategory-item-post-request
Type:
Show Source
object
-
AgencyId: integer
(int32)
Title:
Agency ID
Default Value:1
The identifier for the public sector agency associated with the time expense subcategory. -
CategoryId: string
Title:
Category ID
Maximum Length:30
The unique identifier for the parent time expense category. -
Description: string
Title:
Description
Maximum Length:500
The description for the associated time expense subcategory. -
EnabledFlag: boolean
Title:
Enabled
Maximum Length:1
Inidicates whether the time expense subcategory is enabled in time entry type setup. -
Subcategory: string
Title:
Subcategory
Maximum Length:40
The name for the associated time expense subcategory. -
SubcategoryId: string
Title:
Subcategory ID
Maximum Length:30
The unique identifier for the associated time expense subcategory.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
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(required):
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.
Root Schema : publicSectorTimeExpenseCategories-item-response
Type:
Show Source
object
-
AgencyId: integer
(int32)
Title:
Agency ID
Default Value:1
The identifier for the public sector agency associated with the time expense category. -
Category: string
Title:
Category
Maximum Length:40
The name for the time expense category. -
CategoryId: string
Title:
Category ID
Maximum Length:30
The unique identifier for the time expense category. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date the time expense category was created. -
Description: string
Title:
Description
Maximum Length:500
The description for the time expense category. -
EnabledFlag: boolean
Title:
Enabled
Maximum Length:1
Indicates whether the time expense category is enabled in time entry type setup. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date the time expense category was last updated. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
TimeExpenseSubcategory: array
Time Expense Subcategories
Title:
Time Expense Subcategories
Time Expense Subcategories associated with this Time Expense Category.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Time Expense Subcategories
Type:
array
Title:
Time Expense Subcategories
Time Expense Subcategories associated with this Time Expense Category.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : publicSectorTimeExpenseCategories-TimeExpenseSubcategory-item-response
Type:
Show Source
object
-
AgencyId: integer
(int32)
Title:
Agency ID
Default Value:1
The identifier for the public sector agency associated with the time expense subcategory. -
CategoryId: string
Title:
Category ID
Maximum Length:30
The unique identifier for the parent time expense category. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date the time expense subcategory was created. -
Description: string
Title:
Description
Maximum Length:500
The description for the associated time expense subcategory. -
EnabledFlag: boolean
Title:
Enabled
Maximum Length:1
Inidicates whether the time expense subcategory is enabled in time entry type setup. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date the time expense subcategory was last updated. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Subcategory: string
Title:
Subcategory
Maximum Length:40
The name for the associated time expense subcategory. -
SubcategoryId: string
Title:
Subcategory ID
Maximum Length:30
The unique identifier for the associated time expense subcategory.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- TimeExpenseSubcategory
-
Parameters:
- publicSectorTimeExpenseCategoriesUniqID:
$request.path.publicSectorTimeExpenseCategoriesUniqID
Time Expense Subcategories associated with this Time Expense Category. - publicSectorTimeExpenseCategoriesUniqID: