Jump to

• Request
• Response

Create a set of conditions

post

/fscmRestApi/resources/11.13.18.05/publicSectorConditions

Request

Supported Media Types

• application/vnd.oracle.adf.resourceitem+json
• application/json

Body ()

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

Root Schema : publicSectorConditions-item

Type: object

Show Source

• AdditionalInfo(optional): string
  Title: Additional Information

  Maximum Length: 500

  The additional Information about the condition and resolution actions.
• AgencyId(optional): integer(int32)
  The unique identifier of the public sector agency.
• BrPreventFinalIns(optional): 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(optional): 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(optional): 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(optional): 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(optional): 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.
• BrPreventWorkflow(optional): 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(optional): 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(optional): string
  Title: Condition Name

  Maximum Length: 50

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

  Maximum Length: 64

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

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

  Maximum Length: 500

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

  Maximum Length: 300

  The information about the condition that is visible across all the transactions.
• EnabledFlag(optional): string
  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(optional): string
  Title: Apply Condition to Transactions

  Maximum Length: 1

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

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

  Maximum Length: 64

  The name of the user who last updated the condition.
• links(optional): array Items
  Title: Items

  Link Relations
• ObjectType(optional): string
  Title: Object Type

  Maximum Length: 3

  The type of record against which a condition can be applied.
• Priority(optional): integer(int32)
  Title: Priority

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

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

{
    "properties":{
        "AdditionalInfo":{
            "maxLength":500,
            "type":"string",
            "description":"The additional Information about the condition and resolution actions.",
            "title":"Additional Information"
        },
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The unique identifier of the public sector agency."
        },
        "BrPreventFinalIns":{
            "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.",
            "title":"Prevent Final Inspection"
        },
        "BrPreventInsResult":{
            "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.",
            "title":"Prevent Inspection Result"
        },
        "BrPreventInsSched":{
            "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.",
            "title":"Prevent Inspection Schedule"
        },
        "BrPreventIssue":{
            "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.",
            "title":"Prevent Issue or Final"
        },
        "BrPreventNew":{
            "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.",
            "title":"Prevent Application Progress"
        },
        "BrPreventWorkflow":{
            "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.",
            "title":"Prevent Workflow Advancement"
        },
        "BrRestrictPayment":{
            "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.",
            "title":"Prevent Payment"
        },
        "ConditionName":{
            "maxLength":50,
            "type":"string",
            "description":"The unique name of the condition.",
            "title":"Condition Name"
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The name of the user who created the condition.",
            "title":"Created By"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date when the condition was created.",
            "title":"Creation Date"
        },
        "Description":{
            "maxLength":500,
            "type":"string",
            "description":"The detailed description of the condition.",
            "title":"Description"
        },
        "DisplayMessage":{
            "maxLength":300,
            "type":"string",
            "description":"The information about the condition that is visible across all the transactions.",
            "title":"Display Message"
        },
        "EnabledFlag":{
            "maxLength":1,
            "type":"string",
            "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.",
            "title":"Enabled"
        },
        "InheritFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates if the condition is inheritable. The default value is N.",
            "title":"Apply Condition to Transactions"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date when the condition was last updated.",
            "title":"Last Updated Date"
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The name of the user who last updated the condition.",
            "title":"Last Updated By"
        },
        "ObjectType":{
            "maxLength":3,
            "type":"string",
            "description":"The type of record against which a condition can be applied.",
            "title":"Object Type"
        },
        "Priority":{
            "format":"int32",
            "type":"integer",
            "description":"The priority of the condition as set by the agency.",
            "title":"Priority"
        },
        "Severity":{
            "format":"int32",
            "type":"integer",
            "description":"The severity of the condition. The severity levels are Lock, Hold, and Notice. Lock represents the highest level of severity.",
            "title":"Severity"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Nested Schema : link

Type: object

Show Source

• href(optional): string
  Title: hyperlink reference

  The URI to the related resource.
• rel(optional): string
  Title: relation

  The name of the relation to the resource instance. Example: self.

{
    "properties":{
        "href":{
            "type":"string",
            "description":"The URI to the related resource.",
            "title":"hyperlink reference"
        },
        "rel":{
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "title":"relation"
        }
    },
    "type":"object"
}

Back to Top

Response

Supported Media Types

• application/vnd.oracle.adf.resourceitem+json
• application/json

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : publicSectorConditions-item

Type: object

Show Source

• AdditionalInfo(optional): string
  Title: Additional Information

  Maximum Length: 500

  The additional Information about the condition and resolution actions.
• AgencyId(optional): integer(int32)
  The unique identifier of the public sector agency.
• BrPreventFinalIns(optional): 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(optional): 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(optional): 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(optional): 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(optional): 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.
• BrPreventWorkflow(optional): 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(optional): 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(optional): string
  Title: Condition Name

  Maximum Length: 50

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

  Maximum Length: 64

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

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

  Maximum Length: 500

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

  Maximum Length: 300

  The information about the condition that is visible across all the transactions.
• EnabledFlag(optional): string
  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(optional): string
  Title: Apply Condition to Transactions

  Maximum Length: 1

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

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

  Maximum Length: 64

  The name of the user who last updated the condition.
• links(optional): array Items
  Title: Items

  Link Relations
• ObjectType(optional): string
  Title: Object Type

  Maximum Length: 3

  The type of record against which a condition can be applied.
• Priority(optional): integer(int32)
  Title: Priority

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

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

{
    "properties":{
        "AdditionalInfo":{
            "maxLength":500,
            "type":"string",
            "description":"The additional Information about the condition and resolution actions.",
            "title":"Additional Information"
        },
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The unique identifier of the public sector agency."
        },
        "BrPreventFinalIns":{
            "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.",
            "title":"Prevent Final Inspection"
        },
        "BrPreventInsResult":{
            "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.",
            "title":"Prevent Inspection Result"
        },
        "BrPreventInsSched":{
            "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.",
            "title":"Prevent Inspection Schedule"
        },
        "BrPreventIssue":{
            "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.",
            "title":"Prevent Issue or Final"
        },
        "BrPreventNew":{
            "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.",
            "title":"Prevent Application Progress"
        },
        "BrPreventWorkflow":{
            "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.",
            "title":"Prevent Workflow Advancement"
        },
        "BrRestrictPayment":{
            "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.",
            "title":"Prevent Payment"
        },
        "ConditionName":{
            "maxLength":50,
            "type":"string",
            "description":"The unique name of the condition.",
            "title":"Condition Name"
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The name of the user who created the condition.",
            "title":"Created By"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date when the condition was created.",
            "title":"Creation Date"
        },
        "Description":{
            "maxLength":500,
            "type":"string",
            "description":"The detailed description of the condition.",
            "title":"Description"
        },
        "DisplayMessage":{
            "maxLength":300,
            "type":"string",
            "description":"The information about the condition that is visible across all the transactions.",
            "title":"Display Message"
        },
        "EnabledFlag":{
            "maxLength":1,
            "type":"string",
            "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.",
            "title":"Enabled"
        },
        "InheritFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates if the condition is inheritable. The default value is N.",
            "title":"Apply Condition to Transactions"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date when the condition was last updated.",
            "title":"Last Updated Date"
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The name of the user who last updated the condition.",
            "title":"Last Updated By"
        },
        "ObjectType":{
            "maxLength":3,
            "type":"string",
            "description":"The type of record against which a condition can be applied.",
            "title":"Object Type"
        },
        "Priority":{
            "format":"int32",
            "type":"integer",
            "description":"The priority of the condition as set by the agency.",
            "title":"Priority"
        },
        "Severity":{
            "format":"int32",
            "type":"integer",
            "description":"The severity of the condition. The severity levels are Lock, Hold, and Notice. Lock represents the highest level of severity.",
            "title":"Severity"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Nested Schema : link

Type: object

Show Source

• href(optional): string
  Title: hyperlink reference

  The URI to the related resource.
• rel(optional): string
  Title: relation

  The name of the relation to the resource instance. Example: self.

{
    "properties":{
        "href":{
            "type":"string",
            "description":"The URI to the related resource.",
            "title":"hyperlink reference"
        },
        "rel":{
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "title":"relation"
        }
    },
    "type":"object"
}

Back to Top