Update a project type
patch
/fscmRestApi/resources/11.13.18.05/publicSectorProjectTypes/{publicSectorProjectTypesUniqID}
Request
Path Parameters
-
publicSectorProjectTypesUniqID(required): string
This is the hash key of the attributes which make up the composite key--- AgencyId and ProjectType ---for the Project Types resource and used to uniquely identify an instance of Project Types. The client should not generate the hash key value. Instead, the client should query on the Project Types collection resource with a filter on the primary key values in order to navigate to a specific instance of Project Types.
For example: publicSectorProjectTypes?q=AgencyId=<value1>;ProjectType=<value2>
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
Root Schema : schema
Type:
Show Source
object
-
Description: string
Title:
Description
Maximum Length:100
The description of the project type. -
DocGroupId: string
Title:
Group ID
Maximum Length:30
The unique identifier for a document group. -
EnabledFlag: boolean
Title:
Enabled
Maximum Length:1
Default Value:true
Indicates if the project type is available for the users to select while creating a project. -
LongDescription: string
Title:
Long Description
Maximum Length:1000
The long description of the project type. -
RuleId: string
Title:
Rule ID
Maximum Length:20
The unique identifier of the auto numbering sequence for the project type.
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 : publicSectorProjectTypes-item-response
Type:
Show Source
object
-
AgencyId: integer
(int32)
Default Value:
1
The unique identifier for a public sector agency. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The name of the user who created the project type. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the project type was created. -
Description: string
Title:
Description
Maximum Length:100
The description of the project type. -
DocGroupId: string
Title:
Group ID
Maximum Length:30
The unique identifier for a document group. -
EnabledFlag: boolean
Title:
Enabled
Maximum Length:1
Default Value:true
Indicates if the project type is available for the users to select while creating a project. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date when the project type was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The name of the user who last updated the project type. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LongDescription: string
Title:
Long Description
Maximum Length:1000
The long description of the project type. -
ProjectType: string
Title:
Project Type
Maximum Length:50
The unique name entered by the user to define the project type. Examples of the project type can be Residential and Commercial. -
RuleId: string
Title:
Rule ID
Maximum Length:20
The unique identifier of the auto numbering sequence for the project type.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
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.