Jump to

• Request
• Response

Update a related transaction

patch

/fscmRestApi/resources/11.13.18.05/publicSectorRelatedTransactions/{publicSectorRelatedTransactionsUniqID}

Request

Supported Media Types

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

Path Parameters

• publicSectorRelatedTransactionsUniqID: integer
  This is the hash key of the attributes which make up the composite key--- TransactionKey and AddedDate ---for the Related Transactions resource and used to uniquely identify an instance of Related Transactions. The client should not generate the hash key value. Instead, the client should query on the Related Transactions collection resource with a filter on the primary key values in order to navigate to a specific instance of Related Transactions.
  
  For example: publicSectorRelatedTransactions?q=TransactionKey=<value1>;AddedDate=<value2>

Body ()

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

Root Schema : publicSectorRelatedTransactions-item

Type: object

Show Source

• AddedDate(optional): string(date-time)
  The date on which the applications were linked.
• Classification(optional): string
  Maximum Length: 3

  The classification of the type of application.
• Comments(optional): string
  Title: Comments

  Maximum Length: 1000

  The comments entered by the agency staff in the planning and zoning application.
• Dependency(optional): string
  Maximum Length: 10

  The identifier of the type of dependency between the linked planning and zoning applications.
• links(optional): array Items
  Title: Items

  Link Relations
• PriAppFlag(optional): string
  Maximum Length: 1

  The identifier of the ralated transaction, which is the primary application.
• RelTransId(optional): string
  Title: Link Existing Application

  Maximum Length: 50

  The unique identifier of the related transaction.
• RelTransKey(optional): integer(int64)
  The unique identifier of the planning and zoning application that is being linked.
• RelTransTypeCode(optional): string
  Title: Application Type

  Maximum Length: 20

  The unique identifier of the related transaction type code.
• RelTransTypeId(optional): string
  Maximum Length: 30

  The unique identifier of the related transaction type.
• SubAppFlag(optional): string
  Maximum Length: 1

  The identifier of the ralated transaction, which is the sub-application.
• TransactionId(optional): string
  Maximum Length: 50

  The unique identifier of the planning and zoning application.
• TransactionKey(optional): integer(int64)
  The unique identifier of the planning and zoning application.

{
    "properties":{
        "AddedDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date on which the applications were linked."
        },
        "Classification":{
            "maxLength":3,
            "type":"string",
            "description":"The classification of the type of application."
        },
        "Comments":{
            "maxLength":1000,
            "type":"string",
            "description":"The comments entered by the agency staff in the planning and zoning application.",
            "title":"Comments"
        },
        "Dependency":{
            "maxLength":10,
            "type":"string",
            "description":"The identifier of the type of dependency between the linked planning and zoning applications."
        },
        "PriAppFlag":{
            "maxLength":1,
            "type":"string",
            "description":"The identifier of the ralated transaction, which is the primary application."
        },
        "RelTransId":{
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier of the related transaction.",
            "title":"Link Existing Application"
        },
        "RelTransKey":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the planning and zoning application that is being linked."
        },
        "RelTransTypeCode":{
            "maxLength":20,
            "type":"string",
            "description":"The unique identifier of the related transaction type code.",
            "title":"Application Type"
        },
        "RelTransTypeId":{
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier of the related transaction type."
        },
        "SubAppFlag":{
            "maxLength":1,
            "type":"string",
            "description":"The identifier of the ralated transaction, which is the sub-application."
        },
        "TransactionId":{
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier of the planning and zoning application."
        },
        "TransactionKey":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the planning and zoning application."
        },
        "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 : publicSectorRelatedTransactions-item

Type: object

Show Source

• AddedDate(optional): string(date-time)
  The date on which the applications were linked.
• Classification(optional): string
  Maximum Length: 3

  The classification of the type of application.
• Comments(optional): string
  Title: Comments

  Maximum Length: 1000

  The comments entered by the agency staff in the planning and zoning application.
• Dependency(optional): string
  Maximum Length: 10

  The identifier of the type of dependency between the linked planning and zoning applications.
• links(optional): array Items
  Title: Items

  Link Relations
• PriAppFlag(optional): string
  Maximum Length: 1

  The identifier of the ralated transaction, which is the primary application.
• RelTransId(optional): string
  Title: Link Existing Application

  Maximum Length: 50

  The unique identifier of the related transaction.
• RelTransKey(optional): integer(int64)
  The unique identifier of the planning and zoning application that is being linked.
• RelTransTypeCode(optional): string
  Title: Application Type

  Maximum Length: 20

  The unique identifier of the related transaction type code.
• RelTransTypeId(optional): string
  Maximum Length: 30

  The unique identifier of the related transaction type.
• SubAppFlag(optional): string
  Maximum Length: 1

  The identifier of the ralated transaction, which is the sub-application.
• TransactionId(optional): string
  Maximum Length: 50

  The unique identifier of the planning and zoning application.
• TransactionKey(optional): integer(int64)
  The unique identifier of the planning and zoning application.

{
    "properties":{
        "AddedDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date on which the applications were linked."
        },
        "Classification":{
            "maxLength":3,
            "type":"string",
            "description":"The classification of the type of application."
        },
        "Comments":{
            "maxLength":1000,
            "type":"string",
            "description":"The comments entered by the agency staff in the planning and zoning application.",
            "title":"Comments"
        },
        "Dependency":{
            "maxLength":10,
            "type":"string",
            "description":"The identifier of the type of dependency between the linked planning and zoning applications."
        },
        "PriAppFlag":{
            "maxLength":1,
            "type":"string",
            "description":"The identifier of the ralated transaction, which is the primary application."
        },
        "RelTransId":{
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier of the related transaction.",
            "title":"Link Existing Application"
        },
        "RelTransKey":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the planning and zoning application that is being linked."
        },
        "RelTransTypeCode":{
            "maxLength":20,
            "type":"string",
            "description":"The unique identifier of the related transaction type code.",
            "title":"Application Type"
        },
        "RelTransTypeId":{
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier of the related transaction type."
        },
        "SubAppFlag":{
            "maxLength":1,
            "type":"string",
            "description":"The identifier of the ralated transaction, which is the sub-application."
        },
        "TransactionId":{
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier of the planning and zoning application."
        },
        "TransactionKey":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the planning and zoning application."
        },
        "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