Jump to

• Request
• Response

Update a required document

patch

/fscmRestApi/resources/11.13.18.05/publicSectorRequiredDocuments/{RequiredDocumentKey}

Request

Path Parameters

• RequiredDocumentKey(required): integer(int64)
  The unique identifier for a required document.

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 ()

Root Schema : schema

Type: object

Show Source

• 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.
• 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.
• 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).
• 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.

{
    "type":"object",
    "properties":{
        "AcceptedEventFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates if an attachment is required referencing the document category when a permit is accepted. The default value is N for no.",
            "nullable":false,
            "default":false
        },
        "SubmittedEventFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates if an attachment is required referencing the document category when a permit is submitted. The default value is N for no.",
            "nullable":false,
            "default":false
        },
        "LastAction":{
            "title":"Override Action",
            "maxLength":"3",
            "type":"string",
            "description":"Indicates the last transactional action taken on the required document. Valid values are ADD, UPD, DEL (Add, Update, Delete).",
            "nullable":true
        },
        "DeletedFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates that the required document was removed as a required document.",
            "nullable":false,
            "default":false
        },
        "DocUploadedFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether an attachment was uploaded for this requirement.",
            "nullable":false,
            "default":false
        },
        "UpdatedFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates that the required document was updated manually.",
            "nullable":false,
            "default":false
        },
        "ActionComment":{
            "maxLength":"300",
            "type":"string",
            "description":"Used for comments given during a transaction.",
            "nullable":true
        },
        "FinalInspectionEventFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates if an attachment is required referencing the document category when a final inspection is added. The default value is N for no.",
            "nullable":false,
            "default":false
        },
        "CompletedEventFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates if an attachment is required referencing the document category when a permit is completed. The default value is N for no.",
            "nullable":false,
            "default":false
        },
        "IssuedEventFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates if an attachment is required referencing the document category when a permit is issued. The default value is N for no.",
            "nullable":false,
            "default":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:
  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.

Body ()

Root Schema : publicSectorRequiredDocuments-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "CreatedByName":{
            "title":"Created By",
            "maxLength":"32",
            "type":"string",
            "description":"The name of the user who created the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Category":{
            "maxLength":"25",
            "type":"string",
            "description":"The short description value for the document category.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AgencyId":{
            "type":"integer",
            "description":"The agency identifier of the public sector entity to which this required document record applies.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"8"
            },
            "x-queryable":true
        },
        "LastAction":{
            "title":"Override Action",
            "maxLength":"3",
            "type":"string",
            "description":"Indicates the last transactional action taken on the required document. Valid values are ADD, UPD, DEL (Add, Update, Delete).",
            "nullable":true,
            "x-queryable":true
        },
        "UpdatedFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates that the required document was updated manually.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "SubcategoryLongDescr":{
            "maxLength":"100",
            "type":"string",
            "description":"The long description value for the document subcategory.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LastUpdatedByName":{
            "maxLength":"32",
            "type":"string",
            "description":"The name of the user who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DocCategory":{
            "maxLength":"30",
            "type":"string",
            "description":"The unique identifier for the document category.",
            "nullable":false,
            "x-queryable":true
        },
        "CompletedEventFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates if an attachment is required referencing the document category when a permit is completed. The default value is N for no.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "DocSubcategory":{
            "maxLength":"30",
            "type":"string",
            "description":"The unique identifier for the document subcategory.",
            "nullable":true,
            "x-queryable":true
        },
        "LnpRecordId":{
            "maxLength":"50",
            "type":"string",
            "description":"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.",
            "nullable":false,
            "x-queryable":true
        },
        "CategoryLongDescr":{
            "maxLength":"100",
            "type":"string",
            "description":"The long description value for the document category.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DocUploadedFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether an attachment was uploaded for this requirement.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "ActionComment":{
            "maxLength":"300",
            "type":"string",
            "description":"Used for comments given during a transaction.",
            "nullable":true,
            "x-queryable":true
        },
        "AddedFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the required document was added manually.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "FinalInspectionEventFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates if an attachment is required referencing the document category when a final inspection is added. The default value is N for no.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "LnpRecordKey":{
            "type":"integer",
            "description":"The identifier for the associated application",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "IssuedEventFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates if an attachment is required referencing the document category when a permit is issued. The default value is N for no.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "RequiredDocumentPuid":{
            "maxLength":"480",
            "type":"string",
            "description":"The public unique identifier for a required document.",
            "nullable":false,
            "x-queryable":true
        },
        "AcceptedEventFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates if an attachment is required referencing the document category when a permit is accepted. The default value is N for no.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "Subcategory":{
            "maxLength":"25",
            "type":"string",
            "description":"The short description value for the document subcategory.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SubmittedEventFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates if an attachment is required referencing the document category when a permit is submitted. The default value is N for no.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "DeletedFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates that the required document was removed as a required document.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "RequiredDocumentKey":{
            "type":"integer",
            "description":"The unique identifier for a required document.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "RecordNumber":{
            "maxLength":"64",
            "type":"string",
            "description":"The public identifier of the associated application.",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when the record 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