Jump to

• Request
• Response

Update a condition of approval

patch

/fscmRestApi/resources/11.13.18.05/publicSectorConditionsOfApprovalTransactions/{CoaKey}

Request

Supported Media Types

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

Path Parameters

• CoaKey: integer
  The unique identifier of the condition of approval.

Body ()

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

Root Schema : publicSectorConditionsOfApprovalTransactions-item

Type: object

Show Source

• CategoryId(optional): string
  Maximum Length: 20

  The identifier of the type of the category.
• CategoryName(optional): string
  Maximum Length: 50

  The name of the category.
• COAConditionComplyPeriods(optional): array Conditions of Approval Compliance Periods
  Title: Conditions of Approval Compliance Periods

  The conditions of approval compliance period resource is used to create, update, and delete the compliances in the conditions of approval associated with a planning and zoning application.
• CoaKey(optional): integer(int64)
  The unique identifier of the condition of approval.
• Compliance(optional): string
  Maximum Length: 4000

  The compliances associated with the condition of approval.
• Condition(optional): string
  The actual text of the condition of approval.
• ConditionPlain(optional): string
  The text of the condition of approval without any HTML tags.
• ConditionType(optional): string
  Maximum Length: 10

  The identifier of the type of the condition.
• links(optional): array Items
  Title: Items

  Link Relations
• LnpRecordKey(optional): integer(int64)
  The unique identifier of the planning and zoning application.
• ResolvedDate(optional): string(date-time)
  The date on which the condition of approval was resolved.
• SourceCoaKey(optional): integer(int64)
  The unique identifier of the condition of approval for the planning application.
• Status(optional): string
  Maximum Length: 10

  The status of the condition of approval. The valid values are Applied and Resolved.
• StatusType(optional): string
  Maximum Length: 80

  The status of the condition of approval. Valid values are Applied and Resolved.
• SubcategoryId(optional): string
  Maximum Length: 20

  The identifier of the type of the subcategory.
• SubcategoryName(optional): string
  Maximum Length: 50

  The name of the subcategory.
• Type(optional): string
  Maximum Length: 80

  The name of the condition type.
• UpdatedByDate(optional): string
  Maximum Length: 255

  The date on which the condition of approval was updated.
• UpdatedByName(optional): string
  The name of the person who updated the condition.

{
    "properties":{
        "COAConditionComplyPeriods":{
            "items":{
                "$ref":"#/definitions/publicSectorConditionsOfApprovalTransactions-COAConditionComplyPeriods-item"
            },
            "type":"array",
            "description":"The conditions of approval compliance period resource is used to create, update, and delete the compliances in the conditions of approval associated with a planning and zoning application.",
            "title":"Conditions of Approval Compliance Periods"
        },
        "CategoryId":{
            "maxLength":20,
            "type":"string",
            "description":"The identifier of the type of the category."
        },
        "CategoryName":{
            "maxLength":50,
            "type":"string",
            "description":"The name of the category."
        },
        "CoaKey":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the condition of approval."
        },
        "Compliance":{
            "maxLength":4000,
            "type":"string",
            "description":"The compliances associated with the condition of approval."
        },
        "Condition":{
            "type":"string",
            "description":"The actual text of the condition of approval."
        },
        "ConditionPlain":{
            "type":"string",
            "description":"The text of the condition of approval without any HTML tags."
        },
        "ConditionType":{
            "maxLength":10,
            "type":"string",
            "description":"The identifier of the type of the condition."
        },
        "LnpRecordKey":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the planning and zoning application."
        },
        "ResolvedDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date on which the condition of approval was resolved."
        },
        "SourceCoaKey":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the condition of approval for the planning application."
        },
        "Status":{
            "maxLength":10,
            "type":"string",
            "description":"The status of the condition of approval. The valid values are Applied and Resolved."
        },
        "StatusType":{
            "maxLength":80,
            "type":"string",
            "description":"The status of the condition of approval. Valid values are Applied and Resolved."
        },
        "SubcategoryId":{
            "maxLength":20,
            "type":"string",
            "description":"The identifier of the type of the subcategory."
        },
        "SubcategoryName":{
            "maxLength":50,
            "type":"string",
            "description":"The name of the subcategory."
        },
        "Type":{
            "maxLength":80,
            "type":"string",
            "description":"The name of the condition type."
        },
        "UpdatedByDate":{
            "maxLength":255,
            "type":"string",
            "description":"The date on which the condition of approval was updated."
        },
        "UpdatedByName":{
            "type":"string",
            "description":"The name of the person who updated the condition."
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Conditions of Approval Compliance Periods

Type: array

Title: Conditions of Approval Compliance Periods

The conditions of approval compliance period resource is used to create, update, and delete the compliances in the conditions of approval associated with a planning and zoning application.

Show Source

• Array of: object publicSectorConditionsOfApprovalTransactions-COAConditionComplyPeriods-item

{
    "items":{
        "$ref":"#/definitions/publicSectorConditionsOfApprovalTransactions-COAConditionComplyPeriods-item"
    },
    "type":"array",
    "description":"The conditions of approval compliance period resource is used to create, update, and delete the compliances in the conditions of approval associated with a planning and zoning application.",
    "title":"Conditions of Approval Compliance Periods"
}

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 : publicSectorConditionsOfApprovalTransactions-COAConditionComplyPeriods-item

Type: object

Show Source

• CoaKey(optional): integer(int64)
  The unique identifier of the condition of approval.
• Comments(optional): string
  Title: Resolution Comments

  Maximum Length: 1000

  The comment entered at the time of resolution.
• ComplyPrdId(optional): string
  Maximum Length: 20

  The identifier of the compliance period associated with the conditions of approval.
• EnabledFlag(optional): string
  Maximum Length: 1

  Indicates if the compliance period is applicable to the conditions of approval.
• links(optional): array Items
  Title: Items

  Link Relations
• Status(optional): string
  Title: Resolved

  Maximum Length: 10

  Indicates if the compliance period is resolved or applied.

{
    "properties":{
        "CoaKey":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the condition of approval."
        },
        "Comments":{
            "maxLength":1000,
            "type":"string",
            "description":"The comment entered at the time of resolution.",
            "title":"Resolution Comments"
        },
        "ComplyPrdId":{
            "maxLength":20,
            "type":"string",
            "description":"The identifier of the compliance period associated with the conditions of approval."
        },
        "EnabledFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates if the compliance period is applicable to the conditions of approval."
        },
        "Status":{
            "maxLength":10,
            "type":"string",
            "description":"Indicates if the compliance period is resolved or applied.",
            "title":"Resolved"
        },
        "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 : publicSectorConditionsOfApprovalTransactions-item

Type: object

Show Source

• CategoryId(optional): string
  Maximum Length: 20

  The identifier of the type of the category.
• CategoryName(optional): string
  Maximum Length: 50

  The name of the category.
• COAConditionComplyPeriods(optional): array Conditions of Approval Compliance Periods
  Title: Conditions of Approval Compliance Periods

  The conditions of approval compliance period resource is used to create, update, and delete the compliances in the conditions of approval associated with a planning and zoning application.
• CoaKey(optional): integer(int64)
  The unique identifier of the condition of approval.
• Compliance(optional): string
  Maximum Length: 4000

  The compliances associated with the condition of approval.
• Condition(optional): string
  The actual text of the condition of approval.
• ConditionPlain(optional): string
  The text of the condition of approval without any HTML tags.
• ConditionType(optional): string
  Maximum Length: 10

  The identifier of the type of the condition.
• links(optional): array Items
  Title: Items

  Link Relations
• LnpRecordKey(optional): integer(int64)
  The unique identifier of the planning and zoning application.
• ResolvedDate(optional): string(date-time)
  The date on which the condition of approval was resolved.
• SourceCoaKey(optional): integer(int64)
  The unique identifier of the condition of approval for the planning application.
• Status(optional): string
  Maximum Length: 10

  The status of the condition of approval. The valid values are Applied and Resolved.
• StatusType(optional): string
  Maximum Length: 80

  The status of the condition of approval. Valid values are Applied and Resolved.
• SubcategoryId(optional): string
  Maximum Length: 20

  The identifier of the type of the subcategory.
• SubcategoryName(optional): string
  Maximum Length: 50

  The name of the subcategory.
• Type(optional): string
  Maximum Length: 80

  The name of the condition type.
• UpdatedByDate(optional): string
  Maximum Length: 255

  The date on which the condition of approval was updated.
• UpdatedByName(optional): string
  The name of the person who updated the condition.

{
    "properties":{
        "COAConditionComplyPeriods":{
            "items":{
                "$ref":"#/definitions/publicSectorConditionsOfApprovalTransactions-COAConditionComplyPeriods-item"
            },
            "type":"array",
            "description":"The conditions of approval compliance period resource is used to create, update, and delete the compliances in the conditions of approval associated with a planning and zoning application.",
            "title":"Conditions of Approval Compliance Periods"
        },
        "CategoryId":{
            "maxLength":20,
            "type":"string",
            "description":"The identifier of the type of the category."
        },
        "CategoryName":{
            "maxLength":50,
            "type":"string",
            "description":"The name of the category."
        },
        "CoaKey":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the condition of approval."
        },
        "Compliance":{
            "maxLength":4000,
            "type":"string",
            "description":"The compliances associated with the condition of approval."
        },
        "Condition":{
            "type":"string",
            "description":"The actual text of the condition of approval."
        },
        "ConditionPlain":{
            "type":"string",
            "description":"The text of the condition of approval without any HTML tags."
        },
        "ConditionType":{
            "maxLength":10,
            "type":"string",
            "description":"The identifier of the type of the condition."
        },
        "LnpRecordKey":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the planning and zoning application."
        },
        "ResolvedDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date on which the condition of approval was resolved."
        },
        "SourceCoaKey":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the condition of approval for the planning application."
        },
        "Status":{
            "maxLength":10,
            "type":"string",
            "description":"The status of the condition of approval. The valid values are Applied and Resolved."
        },
        "StatusType":{
            "maxLength":80,
            "type":"string",
            "description":"The status of the condition of approval. Valid values are Applied and Resolved."
        },
        "SubcategoryId":{
            "maxLength":20,
            "type":"string",
            "description":"The identifier of the type of the subcategory."
        },
        "SubcategoryName":{
            "maxLength":50,
            "type":"string",
            "description":"The name of the subcategory."
        },
        "Type":{
            "maxLength":80,
            "type":"string",
            "description":"The name of the condition type."
        },
        "UpdatedByDate":{
            "maxLength":255,
            "type":"string",
            "description":"The date on which the condition of approval was updated."
        },
        "UpdatedByName":{
            "type":"string",
            "description":"The name of the person who updated the condition."
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Conditions of Approval Compliance Periods

Type: array

Title: Conditions of Approval Compliance Periods

The conditions of approval compliance period resource is used to create, update, and delete the compliances in the conditions of approval associated with a planning and zoning application.

Show Source

• Array of: object publicSectorConditionsOfApprovalTransactions-COAConditionComplyPeriods-item

{
    "items":{
        "$ref":"#/definitions/publicSectorConditionsOfApprovalTransactions-COAConditionComplyPeriods-item"
    },
    "type":"array",
    "description":"The conditions of approval compliance period resource is used to create, update, and delete the compliances in the conditions of approval associated with a planning and zoning application.",
    "title":"Conditions of Approval Compliance Periods"
}

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 : publicSectorConditionsOfApprovalTransactions-COAConditionComplyPeriods-item

Type: object

Show Source

• CoaKey(optional): integer(int64)
  The unique identifier of the condition of approval.
• Comments(optional): string
  Title: Resolution Comments

  Maximum Length: 1000

  The comment entered at the time of resolution.
• ComplyPrdId(optional): string
  Maximum Length: 20

  The identifier of the compliance period associated with the conditions of approval.
• EnabledFlag(optional): string
  Maximum Length: 1

  Indicates if the compliance period is applicable to the conditions of approval.
• links(optional): array Items
  Title: Items

  Link Relations
• Status(optional): string
  Title: Resolved

  Maximum Length: 10

  Indicates if the compliance period is resolved or applied.

{
    "properties":{
        "CoaKey":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the condition of approval."
        },
        "Comments":{
            "maxLength":1000,
            "type":"string",
            "description":"The comment entered at the time of resolution.",
            "title":"Resolution Comments"
        },
        "ComplyPrdId":{
            "maxLength":20,
            "type":"string",
            "description":"The identifier of the compliance period associated with the conditions of approval."
        },
        "EnabledFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates if the compliance period is applicable to the conditions of approval."
        },
        "Status":{
            "maxLength":10,
            "type":"string",
            "description":"Indicates if the compliance period is resolved or applied.",
            "title":"Resolved"
        },
        "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