Create a document subcategory
post
/fscmRestApi/resources/11.13.18.05/publicSectorDocumentSubcategories
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
-
AcceptedEventFlag: boolean
Maximum Length:
1
Default Value:false
Indicates whether an attachment is required referencing the document subcategory when a permit is accepted. The default value is no. -
AgencyId: integer
Title:
Agency ID
Default Value:1
The agency identifier of the public sector entity to which this document subcategory applies. -
CompletedEventFlag: boolean
Maximum Length:
1
Default Value:false
Indicates whether an attachment is required referencing the document subcategory when a permit is completed. The default value is no. -
Description: string
Title:
Description
Maximum Length:100
The long description value for document subcategory related to an attachment. -
DocumentCategory: string
Title:
Category ID
Maximum Length:30
The unique identifier for the document category. -
DocumentSubcategory: string
Title:
Subcategory ID
Maximum Length:30
The unique identifier for the document subcategory. -
EnabledFlag: boolean
Title:
Enabled
Maximum Length:1
Indicates whether the document subcategory is enabled or not available for selection in attachments. If true, the document subcategory is enabled and is a valid value that can be selected as a document subcategory. If false, the document subcategory is not a valid value and can't be selected as a document subcategory. The default value is true. -
FinalInspectionEventFlag: boolean
Maximum Length:
1
Default Value:false
Indicates whether an attachment is required referencing the document subcategory when a final inspection is added. The default value is no. -
IssuedEventFlag: boolean
Maximum Length:
1
Default Value:false
Indicates whether an attachment is required referencing the document subcategory when a permit is issued is required. The default value is no. -
Subcategory: string
Title:
Subcategory
Maximum Length:25
The value that will be displayed for document subcategory related to an attachment. -
SubmittedEventFlag: boolean
Maximum Length:
1
Default Value:false
Indicates whether an attachment is required referencing the document subcategory when a permit is submitted. The default value is no. -
UserAssistanceText: string
(byte)
The required documents information for document subcategories.
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 : publicSectorDocumentSubcategories-item-response
Type:
Show Source
object
-
AcceptedEventFlag: boolean
Maximum Length:
1
Default Value:false
Indicates whether an attachment is required referencing the document subcategory when a permit is accepted. The default value is no. -
AgencyId: integer
Title:
Agency ID
Default Value:1
The agency identifier of the public sector entity to which this document subcategory applies. -
CompletedEventFlag: boolean
Maximum Length:
1
Default Value:false
Indicates whether an attachment is required referencing the document subcategory when a permit is completed. The default value is no. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the document subcategory was created. -
Description: string
Title:
Description
Maximum Length:100
The long description value for document subcategory related to an attachment. -
DocumentCategory: string
Title:
Category ID
Maximum Length:30
The unique identifier for the document category. -
DocumentSubcategory: string
Title:
Subcategory ID
Maximum Length:30
The unique identifier for the document subcategory. -
EnabledFlag: boolean
Title:
Enabled
Maximum Length:1
Indicates whether the document subcategory is enabled or not available for selection in attachments. If true, the document subcategory is enabled and is a valid value that can be selected as a document subcategory. If false, the document subcategory is not a valid value and can't be selected as a document subcategory. The default value is true. -
FinalInspectionEventFlag: boolean
Maximum Length:
1
Default Value:false
Indicates whether an attachment is required referencing the document subcategory when a final inspection is added. The default value is no. -
IssuedEventFlag: boolean
Maximum Length:
1
Default Value:false
Indicates whether an attachment is required referencing the document subcategory when a permit is issued is required. The default value is no. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time when the document subcategory was last modified. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Subcategory: string
Title:
Subcategory
Maximum Length:25
The value that will be displayed for document subcategory related to an attachment. -
SubmittedEventFlag: boolean
Maximum Length:
1
Default Value:false
Indicates whether an attachment is required referencing the document subcategory when a permit is submitted. The default value is no. -
UserAssistanceText: string
(byte)
The required documents information for document subcategories.
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.