Create a required document
post
/fscmRestApi/resources/11.13.18.05/publicSectorRequiredDocuments
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 if an attachment is required referencing the document category when a permit is accepted. The default value is N for no. -
ActionComment: string
Maximum Length:
300
Used for comments given during a transaction. -
AddedFlag: boolean
Maximum Length:
1
Default Value:false
Indicates whether the required document was added manually. -
AgencyId: integer
(int32)
The agency identifier of the public sector entity to which this required document record applies.
-
CompletedEventFlag: boolean
Maximum Length:
1
Default Value:false
Indicates if an attachment is required referencing the document category when a permit is completed. The default value is N for no. -
DeletedFlag: boolean
Maximum Length:
1
Default Value:false
Indicates that the required document was removed as a required document. -
DocCategory: string
Maximum Length:
30
The unique identifier for the document category. -
DocSubcategory: string
Maximum Length:
30
The unique identifier for the document subcategory. -
DocUploadedFlag: boolean
Maximum Length:
1
Default Value:false
Indicates whether an attachment was uploaded for this requirement. -
FinalInspectionEventFlag: boolean
Maximum Length:
1
Default Value:false
Indicates if an attachment is required referencing the document category when a final inspection is added. The default value is N for no. -
IssuedEventFlag: boolean
Maximum Length:
1
Default Value:false
Indicates if an attachment is required referencing the document category when a permit is issued. The default value is N for no. -
LastAction: string
Title:
Override Action
Maximum Length:3
Indicates the last transactional action taken on the required document. Valid values are ADD, UPD, DEL (Add, Update, Delete). -
LnpRecordId: string
Maximum Length:
50
The identifier for a permit, business license, professional license, or planning and zoning record. For example, a license ID with a value such as License ID RA-2017-00029. -
LnpRecordKey: integer
(int64)
The identifier for the associated application
-
RecordNumber: string
Maximum Length:
64
The public identifier of the associated application. -
RequiredDocumentKey: integer
(int64)
The unique identifier for a required document.
-
RequiredDocumentPuid: string
Maximum Length:
480
The public unique identifier for a required document. -
SubmittedEventFlag: boolean
Maximum Length:
1
Default Value:false
Indicates if an attachment is required referencing the document category when a permit is submitted. The default value is N for no. -
UpdatedFlag: boolean
Maximum Length:
1
Default Value:false
Indicates that the required document was updated manually.
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.
Root Schema : publicSectorRequiredDocuments-item-response
Type:
Show Source
object
-
AcceptedEventFlag: boolean
Maximum Length:
1
Default Value:false
Indicates if an attachment is required referencing the document category when a permit is accepted. The default value is N for no. -
ActionComment: string
Maximum Length:
300
Used for comments given during a transaction. -
AddedFlag: boolean
Maximum Length:
1
Default Value:false
Indicates whether the required document was added manually. -
AgencyId: integer
(int32)
The agency identifier of the public sector entity to which this required document record applies.
-
Category: string
Read Only:
true
Maximum Length:25
The short description value for the document category. -
CategoryLongDescr: string
Read Only:
true
Maximum Length:100
The long description value for the document category. -
CompletedEventFlag: boolean
Maximum Length:
1
Default Value:false
Indicates if an attachment is required referencing the document category when a permit is completed. The default value is N for no. -
CreatedByName: string
Title:
Created By
Read Only:true
Maximum Length:32
The name of the user who created the record. -
CreationDate: string
(date-time)
Read Only:
true
The date when the record was created. -
DeletedFlag: boolean
Maximum Length:
1
Default Value:false
Indicates that the required document was removed as a required document. -
DocCategory: string
Maximum Length:
30
The unique identifier for the document category. -
DocSubcategory: string
Maximum Length:
30
The unique identifier for the document subcategory. -
DocUploadedFlag: boolean
Maximum Length:
1
Default Value:false
Indicates whether an attachment was uploaded for this requirement. -
FinalInspectionEventFlag: boolean
Maximum Length:
1
Default Value:false
Indicates if an attachment is required referencing the document category when a final inspection is added. The default value is N for no. -
IssuedEventFlag: boolean
Maximum Length:
1
Default Value:false
Indicates if an attachment is required referencing the document category when a permit is issued. The default value is N for no. -
LastAction: string
Title:
Override Action
Maximum Length:3
Indicates the last transactional action taken on the required document. Valid values are ADD, UPD, DEL (Add, Update, Delete). -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date when the record was last updated. -
LastUpdatedByName: string
Read Only:
true
Maximum Length:32
The name of the user who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LnpRecordId: string
Maximum Length:
50
The identifier for a permit, business license, professional license, or planning and zoning record. For example, a license ID with a value such as License ID RA-2017-00029. -
LnpRecordKey: integer
(int64)
The identifier for the associated application
-
RecordNumber: string
Maximum Length:
64
The public identifier of the associated application. -
RequiredDocumentKey: integer
(int64)
The unique identifier for a required document.
-
RequiredDocumentPuid: string
Maximum Length:
480
The public unique identifier for a required document. -
Subcategory: string
Read Only:
true
Maximum Length:25
The short description value for the document subcategory. -
SubcategoryLongDescr: string
Read Only:
true
Maximum Length:100
The long description value for the document subcategory. -
SubmittedEventFlag: boolean
Maximum Length:
1
Default Value:false
Indicates if an attachment is required referencing the document category when a permit is submitted. The default value is N for no. -
UpdatedFlag: boolean
Maximum Length:
1
Default Value:false
Indicates that the required document was updated manually.
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.