Jump to

• Request
• Response

Get a condition applied against a transaction

get

/fscmRestApi/resources/11.13.18.05/publicSectorConditionListDetails/{ConditionKey}

Request

Path Parameters

• ConditionKey(required): integer(int64)
  The unique identifier of the condition that is applied 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 : publicSectorConditionListDetails-item-response

Type: object

Show Source

• AdditionalInfo: string
  Title: Additional Information

  Read Only: true

  Maximum Length: 500

  The additional details on the condition that was applied against the transaction.
• AgencyId: integer (int32)
  Read Only: true

  Default Value: 1

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

  Read Only: true

  Maximum Length: 64

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

  Read Only: true

  The date when the condition was applied against the transaction.
• BrPreventNew: string
  Title: Prevent Application Progress

  Read Only: true

  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'.
• ConditionKey: integer (int64)
  Read Only: true

  The unique identifier of the condition that is applied against a transaction.
• ConditionName: string
  Title: Condition Name

  Read Only: true

  Maximum Length: 50

  The name of the condition that is applied.
• ConditionSource: string
  Read Only: true

  Maximum Length: 3

  The source from which the condition is inherited.
• Description: string
  Title: Description

  Read Only: true

  Maximum Length: 500

  The detailed description about the condition that is applied against a transaction.
• DisplayMessage: string
  Title: Display Message

  Read Only: true

  Maximum Length: 150

  The brief information about the condition that is visible across all the transaction.
• InheritFlag: boolean
  Title: Apply Condition to Transactions

  Read Only: true

  Maximum Length: 1

  The option to indicate that the condition was inherited and not applied directly against the transaction.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MeaningSeverity: string
  Title: Severity

  Read Only: true

  Maximum Length: 80

  The meaning of the severity. The value '1' is for Lock, '2' is for Hold, and '3' is for Notice.
• MeaningStatus: string
  Title: Status

  Read Only: true

  Maximum Length: 80

  The meaning of the status. The value 'A' is for Applied and 'R' is for Removed.
• ObjectKeyGenValue1: string
  Read Only: true

  Maximum Length: 50

  The string key value 1 to identify the unique transaction to which a condition is applied.
• ObjectKeyGenValue2: string
  Read Only: true

  Maximum Length: 50

  The string key value 2 to identify the unique transaction to which a condition is applied.
• ObjectKeyGenValue3: string
  Read Only: true

  Maximum Length: 50

  The string key value 3 to identify the unique transaction to which a condition is applied.
• ObjectKeyNumValue1: integer (int64)
  Read Only: true

  The integer key value 1 to identify the unique transaction to which a condition is applied.
• ObjectKeyNumValue2: integer (int64)
  Read Only: true

  The integer key value 2 to identify the unique transaction to which a condition is applied.
• ObjectKeyNumValue3: integer (int64)
  Read Only: true

  The integer key value 3 to identify the unique transaction to which a condition is applied.
• ObjectSubType: string
  Read Only: true

  Maximum Length: 3

  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

  Read Only: true

  Maximum Length: 3

  The unique type of record against which a condition is applied.
• ParentConditionKey: integer (int64)
  Read Only: true

  The unique identifier of the condition from the parent transaction.
• Priority: integer (int32)
  Title: Priority

  Read Only: true

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

  Read Only: true

  Maximum Length: 1

  The option to enable the description to be visible for the public users. The default value is 'Y'.
• RemovalDate: string (date-time)
  Title: Resolved Date

  Read Only: true

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

  Read Only: true

  Maximum Length: 64

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

  Read Only: true

  Maximum Length: 500

  The detailed information about the action that was taken to resolve the condition.
• Severity: integer (int32)
  Title: Severity

  Read Only: true

  The severity of the condition. The values are '1' for Lock, '2' for Hold, and '3' for Notice severity.
• SourceObjectKeyGenValueOne: string
  Read Only: true

  Maximum Length: 50

  The ObjectKeyGenValue1 value from the source record.
• SourceObjectKeyNumValueOne: integer (int64)
  Read Only: true

  The ObjectKeyNumValue1 value from the source record.
• SourceObjectKeyNumValueTwo: integer (int64)
  Read Only: true

  The ObjectKeyNumValue2 value from the source record.
• Status: string
  Title: Status

  Read Only: true

  Maximum Length: 1

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

{
    "type":"object",
    "properties":{
        "Description":{
            "title":"Description",
            "maxLength":"500",
            "type":"string",
            "description":"The detailed description about the condition that is applied against a transaction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AgencyId":{
            "type":"integer",
            "description":"The unique identifier of the public sector agency.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "default":"1",
            "x-hints":{
                "precision":"8"
            },
            "x-queryable":true
        },
        "ConditionSource":{
            "maxLength":"3",
            "type":"string",
            "description":"The source from which the condition is inherited.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InheritFlag":{
            "title":"Apply Condition to Transactions",
            "maxLength":"1",
            "type":"boolean",
            "description":"The option to indicate that the condition was inherited and not applied directly against the transaction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ConditionName":{
            "title":"Condition Name",
            "maxLength":"50",
            "type":"string",
            "description":"The name of the condition that is applied.",
            "nullable":true,
            "readOnly":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,
            "readOnly":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":true,
            "readOnly":true,
            "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,
            "readOnly":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":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RemovedBy":{
            "title":"Resolved By",
            "maxLength":"64",
            "type":"string",
            "description":"The name of user who resolved the condition.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "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,
            "readOnly":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,
            "readOnly":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,
            "readOnly":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,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceObjectKeyNumValueTwo":{
            "type":"integer",
            "description":"The ObjectKeyNumValue2 value from the source record.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "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,
            "readOnly":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,
            "readOnly":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,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Status":{
            "title":"Status",
            "maxLength":"1",
            "type":"string",
            "description":"The status of the condition that is applied against the transaction. The values are 'A' for Applied and 'R' for Removed.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AppliedDate":{
            "title":"Applied Date",
            "type":"string",
            "description":"The date when the condition was applied against the transaction.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AdditionalInfo":{
            "title":"Additional Information",
            "maxLength":"500",
            "type":"string",
            "description":"The additional details on the condition that was applied against the transaction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RemovalDate":{
            "title":"Resolved Date",
            "type":"string",
            "description":"The date when the condition was resolved.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Priority":{
            "title":"Priority",
            "type":"integer",
            "description":"The priority of the condition applied against the transaction. The values are '1' for high, '2' for Medium, and '3' Low.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"1"
            },
            "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 severity.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"1"
            },
            "x-queryable":true
        },
        "MeaningSeverity":{
            "title":"Severity",
            "maxLength":"80",
            "type":"string",
            "description":"The meaning of the severity. The value '1' is for Lock, '2' is for Hold, and '3' is for Notice.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceObjectKeyGenValueOne":{
            "maxLength":"50",
            "type":"string",
            "description":"The ObjectKeyGenValue1 value from the source record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ParentConditionKey":{
            "type":"integer",
            "description":"The unique identifier of the condition from the parent transaction.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "MeaningStatus":{
            "title":"Status",
            "maxLength":"80",
            "type":"string",
            "description":"The meaning of the status. The value 'A' is for Applied and 'R' is for Removed.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AppliedBy":{
            "title":"Applied By",
            "maxLength":"64",
            "type":"string",
            "description":"The name of the user who applied the condition.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceObjectKeyNumValueOne":{
            "type":"integer",
            "description":"The ObjectKeyNumValue1 value from the source record.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ConditionKey":{
            "type":"integer",
            "description":"The unique identifier of the condition that is applied against a transaction.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "DisplayMessage":{
            "title":"Display Message",
            "maxLength":"150",
            "type":"string",
            "description":"The brief information about the condition that is visible across all the transaction.",
            "nullable":true,
            "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