Jump to

• Request
• Response

Update a time expense subcategory

patch

/fscmRestApi/resources/11.13.18.05/publicSectorTimeExpenseSubcategories/{publicSectorTimeExpenseSubcategoriesUniqID}

Request

Path Parameters

• publicSectorTimeExpenseSubcategoriesUniqID(required): string
  This is the hash key of the attributes which make up the composite key--- AgencyId, CategoryId and SubcategoryId ---for the Time Expense Subcategories resource and used to uniquely identify an instance of Time Expense Subcategories. The client should not generate the hash key value. Instead, the client should query on the Time Expense Subcategories collection resource with a filter on the primary key values in order to navigate to a specific instance of Time Expense Subcategories.
  
  For example: publicSectorTimeExpenseSubcategories?q=AgencyId=<value1>;CategoryId=<value2>;SubcategoryId=<value3>

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.

Supported Media Types

• application/json

Request Body - application/json ()

The following table describes the body parameters in the request for this task.

Root Schema : schema

Type: object

Show Source

• Description: string
  Title: Description

  Maximum Length: 500

  The description for the time expense subcategory.
• EnabledFlag: boolean
  Title: Enabled

  Maximum Length: 1

  Indicates whether the time expense subcategory is enabled in time entry type setup.
• Subcategory: string
  Title: Subcategory

  Maximum Length: 40

  The name for the time expense subcategory.

{
    "type":"object",
    "properties":{
        "Description":{
            "title":"Description",
            "maxLength":500,
            "type":"string",
            "description":"The description for the time expense subcategory.",
            "nullable":true
        },
        "EnabledFlag":{
            "title":"Enabled",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the time expense subcategory is enabled in time entry type setup.",
            "nullable":false
        },
        "Subcategory":{
            "title":"Subcategory",
            "maxLength":40,
            "type":"string",
            "description":"The name for the time expense subcategory.",
            "nullable":false
        }
    }
}

Back to Top

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.

Body ()

Root Schema : publicSectorTimeExpenseSubcategories-item-response

Type: object

Show Source

• AgencyId: integer (int32)
  Title: Agency ID

  Default Value: 1

  The unique 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 category of this time expense subcategory.
• 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 time expense subcategory.
• EnabledFlag: boolean
  Title: Enabled

  Maximum Length: 1

  Indicates 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 time expense subcategory.
• SubcategoryId: string
  Title: Subcategory ID

  Maximum Length: 30

  The unique identifier for the time expense subcategory.

{
    "type":"object",
    "properties":{
        "CategoryId":{
            "title":"Category ID",
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier for the parent category of this time expense subcategory.",
            "nullable":false,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date the time expense subcategory was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":500,
            "type":"string",
            "description":"The description for the time expense subcategory.",
            "nullable":true,
            "x-queryable":true
        },
        "AgencyId":{
            "title":"Agency ID",
            "type":"integer",
            "description":"The unique identifier for the public sector agency associated with the time expense subcategory.",
            "format":"int32",
            "nullable":false,
            "default":1,
            "x-hints":{
                "precision":8
            },
            "x-queryable":true
        },
        "Subcategory":{
            "title":"Subcategory",
            "maxLength":40,
            "type":"string",
            "description":"The name for the time expense subcategory.",
            "nullable":false,
            "x-queryable":true
        },
        "SubcategoryId":{
            "title":"Subcategory ID",
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier for the time expense subcategory.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "EnabledFlag":{
            "title":"Enabled",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the time expense subcategory is enabled in time entry type setup.",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date the time expense subcategory 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