Jump to

• Request
• Response

Create a set of conditions

post

/fscmRestApi/resources/11.13.18.05/publicSectorConditions

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

Request Body - application/json ()

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

Root Schema : schema

Type: object

Show Source

• AdditionalInfo: string
  Title: Additional Information

  Maximum Length: 500

  The additional Information about the condition and resolution actions.
• AgencyId: integer (int32)
  Default Value: 1

  The unique identifier of the public sector agency.
• BrPreventAmendmentFlag: string
  Title: Business License Amendment

  Maximum Length: 1

  Indicates whether the condition is allowed to prevented by the Prevent Amendement process.
• BrPreventFinalIns: string
  Title: Prevent Final Inspection

  Maximum Length: 1

  Indicates whether the condition prevents scheduling and the resulting inspection for a case on hold. If the value is Y, the scheduling and inspection can't be made. The default value is N.
• BrPreventInsResult: string
  Title: Prevent Inspection Result

  Maximum Length: 1

  Indicates whether the condition prevents resulting inspection for a case on hold. If the value is Y, the inspection can't be made. The default value is N.
• BrPreventInsSched: string
  Title: Prevent Inspection Schedule

  Maximum Length: 1

  Indicates whether the condition prevents an inspection from being scheduled for a case on hold. If the value is Y, the inspection can't be scheduled. The default value is N.
• BrPreventIssue: string
  Title: Prevent Issue or Final

  Maximum Length: 1

  Indicates whether the condition prevents an issue/final business from being added for a case on hold. If the value is Y, an issue/final business can't be added. The default value is N.
• BrPreventNew: string
  Title: Prevent Application Progress

  Maximum Length: 1

  Indicates whether the condition prevents a new business from being added for a case on hold. If the value is Y, a new business can't be added. The default value is N.
• BrPreventRenewal: string
  Title: Business License Renewal

  Maximum Length: 1

  Indicates whehter the condition prevents an existing business from being renewed for a case on hold. The default value is N.
• BrPreventWorkflow: string
  Title: Prevent Workflow Advancement

  Maximum Length: 1

  Indicates whether the condition prevents the workflow from advancing for a case on hold. If the value is Y, the workflow can't advance. The default value is N.
• BrRestrictPayment: string
  Title: Prevent Payment

  Maximum Length: 1

  Indicates whether the condition restricts payment from being made for a case on hold. If the value is Y, payment can't be made. The default value is N.
• ConditionName: string
  Title: Condition Name

  Maximum Length: 50

  The unique name of the condition.
• Description: string
  Title: Description

  Maximum Length: 500

  The detailed description of the condition.
• DisplayMessage: string
  Title: Display Message

  Maximum Length: 300

  The information about the condition that is visible across all the transactions.
• EnabledFlag: boolean
  Title: Enabled

  Maximum Length: 1

  Indicates if the condition is available for the users to apply against a record, such as permits, planning, and zoning. The default value is Y, which means that the condition is available.
• InheritFlag: boolean
  Title: Apply Condition to Transactions

  Maximum Length: 1

  Indicates if the condition is inheritable. The default value is N.
• ObjectType: string
  Title: Object Type

  Maximum Length: 3

  The type of record against which a condition can be applied.
• ParcelImportUpdateFlag: boolean
  Title: Allow Updates by Parcel Import

  Maximum Length: 1

  Indicates whether a condition is allowed to be updated by the Parcel Import process. The default value is N.
• Priority: integer (int32)
  Title: Priority

  The priority of the condition as set by the agency.
• Severity: integer (int32)
  Title: Severity

  The severity of the condition. The severity levels are Lock, Hold, and Notice. Lock represents the highest level of severity.

{
    "type":"object",
    "properties":{
        "AdditionalInfo":{
            "title":"Additional Information",
            "maxLength":500,
            "type":"string",
            "description":"The additional Information about the condition and resolution actions.",
            "nullable":true
        },
        "BrPreventAmendmentFlag":{
            "title":"Business License Amendment",
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the condition is allowed to prevented by the Prevent Amendement process.",
            "nullable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":500,
            "type":"string",
            "description":"The detailed description of the condition.",
            "nullable":true
        },
        "AgencyId":{
            "type":"integer",
            "description":"The unique identifier of the public sector agency.",
            "format":"int32",
            "nullable":false,
            "default":1,
            "x-hints":{
                "precision":8
            }
        },
        "BrPreventInsSched":{
            "title":"Prevent Inspection Schedule",
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the condition prevents an inspection from being scheduled for a case on hold. If the value is Y, the inspection can't be scheduled. The default value is N.",
            "nullable":true
        },
        "Priority":{
            "title":"Priority",
            "type":"integer",
            "description":"The priority of the condition as set by the agency.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":1
            }
        },
        "BrPreventIssue":{
            "title":"Prevent Issue or Final",
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the condition prevents an issue/final business from being added for a case on hold. If the value is Y, an issue/final business can't be added. The default value is N.",
            "nullable":true
        },
        "InheritFlag":{
            "title":"Apply Condition to Transactions",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates if the condition is inheritable. The default value is N.",
            "nullable":true
        },
        "BrPreventRenewal":{
            "title":"Business License Renewal",
            "maxLength":1,
            "type":"string",
            "description":"Indicates whehter the condition prevents an existing business from being renewed for a case on hold. The default value is N.",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            }
        },
        "Severity":{
            "title":"Severity",
            "type":"integer",
            "description":"The severity of the condition. The severity levels are Lock, Hold, and Notice. Lock represents the highest level of severity.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":1
            }
        },
        "ConditionName":{
            "title":"Condition Name",
            "maxLength":50,
            "type":"string",
            "description":"The unique name of the condition.",
            "nullable":false
        },
        "BrPreventWorkflow":{
            "title":"Prevent Workflow Advancement",
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the condition prevents the workflow from advancing for a case on hold. If the value is Y, the workflow can't advance. The default value is N.",
            "nullable":true
        },
        "ParcelImportUpdateFlag":{
            "title":"Allow Updates by Parcel Import",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether a condition is allowed to be updated by the Parcel Import process. The default value is N.",
            "nullable":true
        },
        "ObjectType":{
            "title":"Object Type",
            "maxLength":3,
            "type":"string",
            "description":"The type of record against which a condition can be applied.",
            "nullable":false
        },
        "BrPreventFinalIns":{
            "title":"Prevent Final Inspection",
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the condition prevents scheduling and the resulting inspection for a case on hold. If the value is Y, the scheduling and inspection can't be made. The default value is N.",
            "nullable":true
        },
        "BrPreventInsResult":{
            "title":"Prevent Inspection Result",
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the condition prevents resulting inspection for a case on hold. If the value is Y, the inspection can't be made. The default value is N.",
            "nullable":true
        },
        "BrRestrictPayment":{
            "title":"Prevent Payment",
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the condition restricts payment from being made for a case on hold. If the value is Y, payment can't be made. The default value is N.",
            "nullable":true
        },
        "DisplayMessage":{
            "title":"Display Message",
            "maxLength":300,
            "type":"string",
            "description":"The information about the condition that is visible across all the transactions.",
            "nullable":true
        },
        "EnabledFlag":{
            "title":"Enabled",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates if the condition is available for the users to apply against a record, such as permits, planning, and zoning. The default value is Y, which means that the condition is available.",
            "nullable":false
        },
        "BrPreventNew":{
            "title":"Prevent Application Progress",
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the condition prevents a new business from being added for a case on hold. If the value is Y, a new business can't be added. The default value is N.",
            "nullable":true
        }
    }
}

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 : publicSectorConditions-item-response

Type: object

Show Source

• AdditionalInfo: string
  Title: Additional Information

  Maximum Length: 500

  The additional Information about the condition and resolution actions.
• AgencyId: integer (int32)
  Default Value: 1

  The unique identifier of the public sector agency.
• BrPreventAmendmentFlag: string
  Title: Business License Amendment

  Maximum Length: 1

  Indicates whether the condition is allowed to prevented by the Prevent Amendement process.
• BrPreventFinalIns: string
  Title: Prevent Final Inspection

  Maximum Length: 1

  Indicates whether the condition prevents scheduling and the resulting inspection for a case on hold. If the value is Y, the scheduling and inspection can't be made. The default value is N.
• BrPreventInsResult: string
  Title: Prevent Inspection Result

  Maximum Length: 1

  Indicates whether the condition prevents resulting inspection for a case on hold. If the value is Y, the inspection can't be made. The default value is N.
• BrPreventInsSched: string
  Title: Prevent Inspection Schedule

  Maximum Length: 1

  Indicates whether the condition prevents an inspection from being scheduled for a case on hold. If the value is Y, the inspection can't be scheduled. The default value is N.
• BrPreventIssue: string
  Title: Prevent Issue or Final

  Maximum Length: 1

  Indicates whether the condition prevents an issue/final business from being added for a case on hold. If the value is Y, an issue/final business can't be added. The default value is N.
• BrPreventNew: string
  Title: Prevent Application Progress

  Maximum Length: 1

  Indicates whether the condition prevents a new business from being added for a case on hold. If the value is Y, a new business can't be added. The default value is N.
• BrPreventRenewal: string
  Title: Business License Renewal

  Maximum Length: 1

  Indicates whehter the condition prevents an existing business from being renewed for a case on hold. The default value is N.
• BrPreventWorkflow: string
  Title: Prevent Workflow Advancement

  Maximum Length: 1

  Indicates whether the condition prevents the workflow from advancing for a case on hold. If the value is Y, the workflow can't advance. The default value is N.
• BrRestrictPayment: string
  Title: Prevent Payment

  Maximum Length: 1

  Indicates whether the condition restricts payment from being made for a case on hold. If the value is Y, payment can't be made. The default value is N.
• ConditionName: string
  Title: Condition Name

  Maximum Length: 50

  The unique name of the condition.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The name of the user who created the condition.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date when the condition was created.
• Description: string
  Title: Description

  Maximum Length: 500

  The detailed description of the condition.
• DisplayMessage: string
  Title: Display Message

  Maximum Length: 300

  The information about the condition that is visible across all the transactions.
• EnabledFlag: boolean
  Title: Enabled

  Maximum Length: 1

  Indicates if the condition is available for the users to apply against a record, such as permits, planning, and zoning. The default value is Y, which means that the condition is available.
• InheritFlag: boolean
  Title: Apply Condition to Transactions

  Maximum Length: 1

  Indicates if the condition is inheritable. The default value is N.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date when the condition was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The name of the user who last updated the condition.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ObjectType: string
  Title: Object Type

  Maximum Length: 3

  The type of record against which a condition can be applied.
• ParcelImportUpdateFlag: boolean
  Title: Allow Updates by Parcel Import

  Maximum Length: 1

  Indicates whether a condition is allowed to be updated by the Parcel Import process. The default value is N.
• Priority: integer (int32)
  Title: Priority

  The priority of the condition as set by the agency.
• Severity: integer (int32)
  Title: Severity

  The severity of the condition. The severity levels are Lock, Hold, and Notice. Lock represents the highest level of severity.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the condition was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":500,
            "type":"string",
            "description":"The detailed description of the condition.",
            "nullable":true,
            "x-queryable":true
        },
        "AgencyId":{
            "type":"integer",
            "description":"The unique identifier of the public sector agency.",
            "format":"int32",
            "nullable":false,
            "default":1,
            "x-hints":{
                "precision":8
            },
            "x-queryable":true
        },
        "BrPreventInsSched":{
            "title":"Prevent Inspection Schedule",
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the condition prevents an inspection from being scheduled for a case on hold. If the value is Y, the inspection can't be scheduled. The default value is N.",
            "nullable":true,
            "x-queryable":true
        },
        "InheritFlag":{
            "title":"Apply Condition to Transactions",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates if the condition is inheritable. The default value is N.",
            "nullable":true,
            "x-queryable":true
        },
        "ConditionName":{
            "title":"Condition Name",
            "maxLength":50,
            "type":"string",
            "description":"The unique name of the condition.",
            "nullable":false,
            "x-queryable":true
        },
        "BrPreventWorkflow":{
            "title":"Prevent Workflow Advancement",
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the condition prevents the workflow from advancing for a case on hold. If the value is Y, the workflow can't advance. The default value is N.",
            "nullable":true,
            "x-queryable":true
        },
        "ParcelImportUpdateFlag":{
            "title":"Allow Updates by Parcel Import",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether a condition is allowed to be updated by the Parcel Import process. The default value is N.",
            "nullable":true,
            "x-queryable":true
        },
        "ObjectType":{
            "title":"Object Type",
            "maxLength":3,
            "type":"string",
            "description":"The type of record against which a condition can be applied.",
            "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 if the condition is available for the users to apply against a record, such as permits, planning, and zoning. The default value is Y, which means that the condition is available.",
            "nullable":false,
            "x-queryable":true
        },
        "BrPreventNew":{
            "title":"Prevent Application Progress",
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the condition prevents a new business from being added for a case on hold. If the value is Y, a new business can't be added. The default value is N.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The name of the user who last updated the condition.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AdditionalInfo":{
            "title":"Additional Information",
            "maxLength":500,
            "type":"string",
            "description":"The additional Information about the condition and resolution actions.",
            "nullable":true,
            "x-queryable":true
        },
        "BrPreventAmendmentFlag":{
            "title":"Business License Amendment",
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the condition is allowed to prevented by the Prevent Amendement process.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The name of the user who created the condition.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Priority":{
            "title":"Priority",
            "type":"integer",
            "description":"The priority of the condition as set by the agency.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":1
            },
            "x-queryable":true
        },
        "BrPreventIssue":{
            "title":"Prevent Issue or Final",
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the condition prevents an issue/final business from being added for a case on hold. If the value is Y, an issue/final business can't be added. The default value is N.",
            "nullable":true,
            "x-queryable":true
        },
        "BrPreventRenewal":{
            "title":"Business License Renewal",
            "maxLength":1,
            "type":"string",
            "description":"Indicates whehter the condition prevents an existing business from being renewed for a case on hold. The default value is N.",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "Severity":{
            "title":"Severity",
            "type":"integer",
            "description":"The severity of the condition. The severity levels are Lock, Hold, and Notice. Lock represents the highest level of severity.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":1
            },
            "x-queryable":true
        },
        "BrPreventFinalIns":{
            "title":"Prevent Final Inspection",
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the condition prevents scheduling and the resulting inspection for a case on hold. If the value is Y, the scheduling and inspection can't be made. The default value is N.",
            "nullable":true,
            "x-queryable":true
        },
        "BrPreventInsResult":{
            "title":"Prevent Inspection Result",
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the condition prevents resulting inspection for a case on hold. If the value is Y, the inspection can't be made. The default value is N.",
            "nullable":true,
            "x-queryable":true
        },
        "BrRestrictPayment":{
            "title":"Prevent Payment",
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the condition restricts payment from being made for a case on hold. If the value is Y, payment can't be made. The default value is N.",
            "nullable":true,
            "x-queryable":true
        },
        "DisplayMessage":{
            "title":"Display Message",
            "maxLength":300,
            "type":"string",
            "description":"The information about the condition that is visible across all the transactions.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when the condition 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