Jump to

• Request
• Response

Get a condition applied against a record

get

/fscmRestApi/resources/11.13.18.05/publicSectorConditionLists/{ConditionKey}

Request

Path Parameters

• ConditionKey(required): integer
  The unique identifier of the applied condition against a transaction.

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

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.

There's no request body for this operation.

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

Type: object

Show Source

• AdditionalInfo: string
  Title: Additional Information

  Maximum Length: 500

  The additional details about the condition that was applied against a transaction.
• AgencyId: integer (int32)
  Default Value: 1

  The unique identifier of the public sector agency.
• AppliedBy: string
  Title: Applied By

  Maximum Length: 64

  The name of the user who applied the condition.
• AppliedDate: string (date-time)
  Title: Applied Date

  The date when the condition was applied against a transaction.
• ApplyToInProcessTrans: boolean
  Title: Include in-process transactions

  Maximum Length: 1

  Default Value: false

  The option to enable the condition to be inherited to exiting transactions (in-process transactions).The valid values are Y and N. Select Y to apply the condition to all the existing transactions belonging to the same parcel.
• BrPreventAmendmentFlag: string
  Title: Business License Amendment

  Maximum Length: 1

  Indicates the prevent amendment business rule for hold condition.
• 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

  The option to enable the Prevent Inspection Result functionality for the transaction against which a condition is applied. The default value is 'N'.
• BrPreventInsSched: string
  Title: Prevent Inspection Schedule

  Maximum Length: 1

  The option to enable the Prevent Inspection Scheduling functionality for the transaction against which a condition is applied. The default value is 'N'.
• BrPreventIssue: string
  Title: Prevent Issue or Final

  Maximum Length: 1

  The option to enable the Prevent Issue or Final workflow functionality for the transaction against which a condition is applied. The default value is 'N'.
• BrPreventNew: string
  Title: Prevent Application Progress

  Maximum Length: 1

  The option to enable the Prevent New functionality for the transaction against which a condition is applied. The default value is 'N'.
• BrPreventRenewal: string
  Title: Business License Renewal

  Maximum Length: 1

  The option to enable the Prevent Renewal functionality for the transaction against which a condition is applied. The default value is 'N'.
• BrPreventWorkflow: string
  Title: Prevent Workflow Advancement

  Maximum Length: 1

  The option to enable the Prevent Workflow Advancing functionality for the transaction against which a condition is applied. The default value is 'N'.
• BrRestrictPayment: string
  Title: Prevent Payment

  Maximum Length: 1

  The option to enable the Restrict Payment functionality for the transaction against which a condition is applied. The default value is 'N'.
• ConditionKey: integer
  The unique identifier of the applied condition against a transaction.
• ConditionName: string
  Title: Condition Name

  Maximum Length: 50

  The name of the condition that is applied.
• ConditionPuid: string
  Maximum Length: 480

  The public unique identifier of the condition from the data migration transaction.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

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

  Maximum Length: 500

  The detailed description about the condition applied against a transaction.
• InheritFlag: boolean
  Title: Apply Condition to Transactions

  Maximum Length: 1

  The option that indicates that the condition was inherited and not applied directly against the transaction.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date when the condition was last updated.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ObjectKeyGenValue1: string
  Maximum Length: 50

  The string key value 1 to identify the unique transaction to which a condition is applied.
• ObjectKeyGenValue2: string
  Maximum Length: 50

  The string key value 2 to identify the unique transaction to which a condition is applied.
• ObjectKeyGenValue3: string
  Maximum Length: 50

  The string key value 3 to identify the unique transaction to which a condition is applied.
• ObjectKeyNumValue1: integer (int64)
  The integer key value 1 to identify the unique transaction to which a condition is applied.
• ObjectKeyNumValue2: integer (int64)
  The integer key value 2 to identify the unique transaction to which a condition is applied.
• ObjectKeyNumValue3: integer (int64)
  The integer key value 3 to identify the unique transaction to which a condition is applied.
• ObjectSubType: string
  Maximum Length: 3

  Default Value: NA

  The unique sub type value to identify the sub type of a record. For example, an address within a parcel.
• ObjectType: string
  Title: Object Type

  Maximum Length: 3

  The unique type of record against which a condition is applied.
• ParentConditionKey: integer (int64)
  The unique identifier of the condition from the parent transaction.
• ParentPuid: string
  Maximum Length: 480

  The public unique identifier for the parent data migration transaction.
• Priority: integer (int32)
  Title: Priority

  The priority of the condition within the transaction. The values are '1' for High, '2' for Medium, and '3' for Low.
• PublicFlag: boolean
  Title: Display Description to Public

  Maximum Length: 1

  Default Value: true

  The option to enable the description to be visible for the public users. The default value is 'Y'.
• ReferenceApplicationId: string
  Maximum Length: 50

  The attribute used to store the reference application ID.
• ReferenceClassification: string
  Maximum Length: 30

  The attribute used to store the reference classification.
• ReferenceKeyNumValue1: integer (int64)
  This attribute is the first key value of the Reference table. This is used in the case reference transaction that contains number key values.
• ReferenceKeyNumValue2: integer (int64)
  This attribute is the second key value of the Reference table. This is used in the case reference transaction that contains number key values.
• ReferencePuid: string
  Maximum Length: 480

  Indicates the reference PUID.
• RemovalDate: string (date-time)
  Title: Resolved Date

  The date when the condition was resolved.
• RemovedBy: string
  Title: Resolved By

  Maximum Length: 64

  The name of the user who resolved the condition.
• ResolutionAction: string
  Title: Resolution Action

  Maximum Length: 500

  The detailed information about the action that was taken to resolve the condition.
• ResolveInProcessTrans: boolean
  Title: Resolve condition applied to transactions

  Maximum Length: 1

  Default Value: false

  The option to include all the in-process transactions for the resolution. The valid values are Y and N. Select Y to include all the in-process transactions.
• Severity: integer (int32)
  Title: Severity

  The severity of the condition. The values are '1' for Lock, '2' for Hold, and '3' for Notice.
• Status: string
  Title: Status

  Maximum Length: 1

  Default Value: A

  The status of the condition that is applied against a transaction. The values are 'A' for Applied and 'R' for Removed.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the condition was applied.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":"500",
            "type":"string",
            "description":"The detailed description about the condition applied against a transaction.",
            "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":"The option to enable the Prevent Inspection Scheduling functionality for the transaction against which a condition is applied. The default value is 'N'.",
            "nullable":true,
            "x-queryable":true
        },
        "InheritFlag":{
            "title":"Apply Condition to Transactions",
            "maxLength":"1",
            "type":"boolean",
            "description":"The option that indicates that the condition was inherited and not applied directly against the transaction.",
            "nullable":true,
            "x-queryable":true
        },
        "ApplyToInProcessTrans":{
            "title":"Include in-process transactions",
            "maxLength":"1",
            "type":"boolean",
            "description":"The option to enable the condition to be inherited to exiting transactions (in-process transactions).The valid values are Y and N. Select Y to apply the condition to all the existing transactions belonging to the same parcel.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "ConditionName":{
            "title":"Condition Name",
            "maxLength":"50",
            "type":"string",
            "description":"The name of the condition that is applied.",
            "nullable":false,
            "x-queryable":true
        },
        "BrPreventWorkflow":{
            "title":"Prevent Workflow Advancement",
            "maxLength":"1",
            "type":"string",
            "description":"The option to enable the Prevent Workflow Advancing functionality for the transaction against which a condition is applied. The default value is 'N'.",
            "nullable":true,
            "x-queryable":true
        },
        "ResolutionAction":{
            "title":"Resolution Action",
            "maxLength":"500",
            "type":"string",
            "description":"The detailed information about the action that was taken to resolve the condition.",
            "nullable":true,
            "x-queryable":true
        },
        "ObjectSubType":{
            "maxLength":"3",
            "type":"string",
            "description":"The unique sub type value to identify the sub type of a record. For example, an address within a parcel.",
            "nullable":false,
            "default":"NA",
            "x-queryable":true
        },
        "ResolveInProcessTrans":{
            "title":"Resolve condition applied to transactions",
            "maxLength":"1",
            "type":"boolean",
            "description":"The option to include all the in-process transactions for the resolution. The valid values are Y and N. Select Y to include all the in-process transactions.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "ObjectKeyNumValue3":{
            "type":"integer",
            "description":"The integer key value 3 to identify the unique transaction to which a condition is applied.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ObjectType":{
            "title":"Object Type",
            "maxLength":"3",
            "type":"string",
            "description":"The unique type of record against which a condition is applied.",
            "nullable":false,
            "x-queryable":true
        },
        "RemovedBy":{
            "title":"Resolved By",
            "maxLength":"64",
            "type":"string",
            "description":"The name of the user who resolved the condition.",
            "nullable":true,
            "x-queryable":true
        },
        "ConditionPuid":{
            "maxLength":"480",
            "type":"string",
            "description":"The public unique identifier of the condition from the data migration transaction.",
            "nullable":false,
            "x-queryable":true
        },
        "ReferenceClassification":{
            "maxLength":"30",
            "type":"string",
            "description":"The attribute used to store the reference classification.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "PublicFlag":{
            "title":"Display Description to Public",
            "maxLength":"1",
            "type":"boolean",
            "description":"The option to enable the description to be visible for the public users. The default value is 'Y'.",
            "nullable":true,
            "default":true,
            "x-queryable":true
        },
        "ObjectKeyGenValue1":{
            "maxLength":"50",
            "type":"string",
            "description":"The string key value 1 to identify the unique transaction to which a condition is applied.",
            "nullable":true,
            "x-queryable":true
        },
        "BrPreventNew":{
            "title":"Prevent Application Progress",
            "maxLength":"1",
            "type":"string",
            "description":"The option to enable the Prevent New functionality for the transaction against which a condition is applied. The default value is 'N'.",
            "nullable":true,
            "x-queryable":true
        },
        "ObjectKeyGenValue2":{
            "maxLength":"50",
            "type":"string",
            "description":"The string key value 2 to identify the unique transaction to which a condition is applied.",
            "nullable":true,
            "x-queryable":true
        },
        "ReferenceApplicationId":{
            "maxLength":"50",
            "type":"string",
            "description":"The attribute used to store the reference application ID.",
            "nullable":true,
            "x-queryable":true
        },
        "ObjectKeyNumValue1":{
            "type":"integer",
            "description":"The integer key value 1 to identify the unique transaction to which a condition is applied.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ObjectKeyGenValue3":{
            "maxLength":"50",
            "type":"string",
            "description":"The string key value 3 to identify the unique transaction to which a condition is applied.",
            "nullable":true,
            "x-queryable":true
        },
        "ObjectKeyNumValue2":{
            "type":"integer",
            "description":"The integer key value 2 to identify the unique transaction to which a condition is applied.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "AppliedDate":{
            "title":"Applied Date",
            "type":"string",
            "description":"The date when the condition was applied against a transaction.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "Status":{
            "title":"Status",
            "maxLength":"1",
            "type":"string",
            "description":"The status of the condition that is applied against a transaction. The values are 'A' for Applied and 'R' for Removed.",
            "nullable":false,
            "default":"A",
            "x-queryable":true
        },
        "AdditionalInfo":{
            "title":"Additional Information",
            "maxLength":"500",
            "type":"string",
            "description":"The additional details about the condition that was applied against a transaction.",
            "nullable":true,
            "x-queryable":true
        },
        "RemovalDate":{
            "title":"Resolved Date",
            "type":"string",
            "description":"The date when the condition was resolved.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "ReferencePuid":{
            "maxLength":"480",
            "type":"string",
            "description":"Indicates the reference PUID.",
            "nullable":true,
            "x-queryable":true
        },
        "BrPreventAmendmentFlag":{
            "title":"Business License Amendment",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates the prevent amendment business rule for hold condition.",
            "nullable":true,
            "x-queryable":true
        },
        "BrPreventIssue":{
            "title":"Prevent Issue or Final",
            "maxLength":"1",
            "type":"string",
            "description":"The option to enable the Prevent Issue or Final workflow functionality for the transaction against which a condition is applied. The default value is 'N'.",
            "nullable":true,
            "x-queryable":true
        },
        "Priority":{
            "title":"Priority",
            "type":"integer",
            "description":"The priority of the condition within the transaction. The values are '1' for High, '2' for Medium, and '3' for Low.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"1"
            },
            "x-queryable":true
        },
        "BrPreventRenewal":{
            "title":"Business License Renewal",
            "maxLength":"1",
            "type":"string",
            "description":"The option to enable the Prevent Renewal functionality for the transaction against which a condition is applied. The default value is 'N'.",
            "nullable":true,
            "x-queryable":true
        },
        "Severity":{
            "title":"Severity",
            "type":"integer",
            "description":"The severity of the condition. The values are '1' for Lock, '2' for Hold, and '3' for Notice.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"1"
            },
            "x-queryable":true
        },
        "ParentConditionKey":{
            "type":"integer",
            "description":"The unique identifier of the condition from the parent transaction.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ParentPuid":{
            "maxLength":"480",
            "type":"string",
            "description":"The public unique identifier for the parent data migration transaction.",
            "nullable":true,
            "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
        },
        "AppliedBy":{
            "title":"Applied By",
            "maxLength":"64",
            "type":"string",
            "description":"The name of the user who applied the condition.",
            "nullable":true,
            "x-queryable":true
        },
        "BrPreventInsResult":{
            "title":"Prevent Inspection Result",
            "maxLength":"1",
            "type":"string",
            "description":"The option to enable the Prevent Inspection Result functionality for the transaction against which a condition is applied. The default value is 'N'.",
            "nullable":true,
            "x-queryable":true
        },
        "BrRestrictPayment":{
            "title":"Prevent Payment",
            "maxLength":"1",
            "type":"string",
            "description":"The option to enable the Restrict Payment functionality for the transaction against which a condition is applied. The default value is 'N'.",
            "nullable":true,
            "x-queryable":true
        },
        "ConditionKey":{
            "type":"integer",
            "description":"The unique identifier of the applied condition against a transaction.",
            "nullable":true,
            "x-hints":{
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "ReferenceKeyNumValue1":{
            "type":"integer",
            "description":"This attribute is the first key value of the Reference table. This is used in the case reference transaction that contains number key values.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ReferenceKeyNumValue2":{
            "type":"integer",
            "description":"This attribute is the second key value of the Reference table. This is used in the case reference transaction that contains number key values.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "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