Jump to

• Request
• Response

Create a set of related transactions

post

/fscmRestApi/resources/11.13.18.05/publicSectorRelatedTransactions

Request

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.
• Upsert-Mode:
  Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• Comments: string
  Title: Comments

  Maximum Length: 1000

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

  The identifier of the type of dependency between the linked planning and zoning applications.
• OriginalCreatedBy: string
  The user who originally created the record in the legacy system. This is used only for data migrations. Updates the Created By attribute.
• PriAppFlag: string
  Maximum Length: 1

  Default Value: N

  The identifier of the ralated transaction, which is the primary application.
• RelatedKey: integer (int64)
  The unique identifier of the related transaction record.
• RelatedPuid: string
  Maximum Length: 480

  The public unique identifier of a migrated related record transaction.
• RelTransactionType: string
  Maximum Length: 8

  Default Value: ORA_REC

  Identifies the related transaction type like permit, planning, business license, or case.
• RelTransId: string
  Title: Link Existing Application

  Maximum Length: 50

  The unique identifier of the related transaction.
• RelTransKey: integer (int64)
  The unique identifier of the planning and zoning application that is being linked.
• RelTransPuid: string
  Maximum Length: 64

  The public unique identifier of a migrated planning and zoning application that is being linked.
• RelTransTypeId: string
  Maximum Length: 30

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

  Default Value: N

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

  The unique identifier of the planning and zoning application.
• TransactionKey: integer (int64)
  The unique identifier of the planning and zoning application.
• TransactionPuid: string
  Maximum Length: 64

  The public unique identifier of a migrated planning and zoning application.
• TransactionType: string
  Maximum Length: 8

  Default Value: ORA_REC

  Identifies the source transaction type like permit, planning, business license, or case.

{
    "type":"object",
    "properties":{
        "PriAppFlag":{
            "maxLength":"1",
            "type":"string",
            "description":"The identifier of the ralated transaction, which is the primary application.",
            "nullable":false,
            "default":"N"
        },
        "TransactionType":{
            "maxLength":"8",
            "type":"string",
            "description":"Identifies the source transaction type like permit, planning, business license, or case.",
            "nullable":false,
            "default":"ORA_REC"
        },
        "TransactionKey":{
            "type":"integer",
            "description":"The unique identifier of the planning and zoning application.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "OriginalCreatedBy":{
            "type":"string",
            "description":"The user who originally created the record in the legacy system. This is used only for data migrations. Updates the Created By attribute.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "SubAppFlag":{
            "maxLength":"1",
            "type":"string",
            "description":"The identifier of the ralated transaction, which is the sub-application.",
            "nullable":false,
            "default":"N"
        },
        "RelatedKey":{
            "type":"integer",
            "description":"The unique identifier of the related transaction record.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "Comments":{
            "title":"Comments",
            "maxLength":"1000",
            "type":"string",
            "description":"The comments entered by the agency staff in the planning and zoning application.",
            "nullable":true
        },
        "TransactionPuid":{
            "maxLength":"64",
            "type":"string",
            "description":"The public unique identifier of a migrated planning and zoning application.",
            "nullable":false
        },
        "RelTransId":{
            "title":"Link Existing Application",
            "maxLength":"50",
            "type":"string",
            "description":"The unique identifier of the related transaction.",
            "nullable":true
        },
        "Dependency":{
            "maxLength":"10",
            "type":"string",
            "description":"The identifier of the type of dependency between the linked planning and zoning applications.",
            "nullable":false
        },
        "RelTransPuid":{
            "maxLength":"64",
            "type":"string",
            "description":"The public unique identifier of a migrated planning and zoning application that is being linked.",
            "nullable":true
        },
        "TransactionId":{
            "maxLength":"50",
            "type":"string",
            "description":"The unique identifier of the planning and zoning application.",
            "nullable":false
        },
        "RelatedPuid":{
            "maxLength":"480",
            "type":"string",
            "description":"The public unique identifier of a migrated related record transaction.",
            "nullable":false
        },
        "RelTransTypeId":{
            "maxLength":"30",
            "type":"string",
            "description":"The unique identifier of the related transaction type.",
            "nullable":false
        },
        "RelTransactionType":{
            "maxLength":"8",
            "type":"string",
            "description":"Identifies the related transaction type like permit, planning, business license, or case.",
            "nullable":false,
            "default":"ORA_REC"
        },
        "RelTransKey":{
            "type":"integer",
            "description":"The unique identifier of the planning and zoning application that is being linked.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        }
    }
}

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

Type: object

Show Source

• AddedDate: string (date-time)
  Read Only: true

  The date on which the applications were linked.
• Classification: string
  Read Only: true

  Maximum Length: 3

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

  Maximum Length: 1000

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

  The identifier of the type of dependency between the linked planning and zoning applications.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• OriginalCreatedBy: string
  The user who originally created the record in the legacy system. This is used only for data migrations. Updates the Created By attribute.
• PriAppFlag: string
  Maximum Length: 1

  Default Value: N

  The identifier of the ralated transaction, which is the primary application.
• RelatedKey: integer (int64)
  The unique identifier of the related transaction record.
• RelatedPuid: string
  Maximum Length: 480

  The public unique identifier of a migrated related record transaction.
• RelTransactionType: string
  Maximum Length: 8

  Default Value: ORA_REC

  Identifies the related transaction type like permit, planning, business license, or case.
• RelTransId: string
  Title: Link Existing Application

  Maximum Length: 50

  The unique identifier of the related transaction.
• RelTransKey: integer (int64)
  The unique identifier of the planning and zoning application that is being linked.
• RelTransPuid: string
  Maximum Length: 64

  The public unique identifier of a migrated planning and zoning application that is being linked.
• RelTransTypeCode: string
  Title: Application Type

  Read Only: true

  Maximum Length: 40

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

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

  Default Value: N

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

  The unique identifier of the planning and zoning application.
• TransactionKey: integer (int64)
  The unique identifier of the planning and zoning application.
• TransactionPuid: string
  Maximum Length: 64

  The public unique identifier of a migrated planning and zoning application.
• TransactionType: string
  Maximum Length: 8

  Default Value: ORA_REC

  Identifies the source transaction type like permit, planning, business license, or case.

{
    "type":"object",
    "properties":{
        "PriAppFlag":{
            "maxLength":"1",
            "type":"string",
            "description":"The identifier of the ralated transaction, which is the primary application.",
            "nullable":false,
            "default":"N",
            "x-queryable":true
        },
        "TransactionType":{
            "maxLength":"8",
            "type":"string",
            "description":"Identifies the source transaction type like permit, planning, business license, or case.",
            "nullable":false,
            "default":"ORA_REC",
            "x-queryable":true
        },
        "TransactionKey":{
            "type":"integer",
            "description":"The unique identifier of the planning and zoning application.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "OriginalCreatedBy":{
            "type":"string",
            "description":"The user who originally created the record in the legacy system. This is used only for data migrations. Updates the Created By attribute.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "SubAppFlag":{
            "maxLength":"1",
            "type":"string",
            "description":"The identifier of the ralated transaction, which is the sub-application.",
            "nullable":false,
            "default":"N",
            "x-queryable":true
        },
        "RelatedKey":{
            "type":"integer",
            "description":"The unique identifier of the related transaction record.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "Comments":{
            "title":"Comments",
            "maxLength":"1000",
            "type":"string",
            "description":"The comments entered by the agency staff in the planning and zoning application.",
            "nullable":true,
            "x-queryable":true
        },
        "TransactionPuid":{
            "maxLength":"64",
            "type":"string",
            "description":"The public unique identifier of a migrated planning and zoning application.",
            "nullable":false,
            "x-queryable":true
        },
        "RelTransId":{
            "title":"Link Existing Application",
            "maxLength":"50",
            "type":"string",
            "description":"The unique identifier of the related transaction.",
            "nullable":true,
            "x-queryable":true
        },
        "Dependency":{
            "maxLength":"10",
            "type":"string",
            "description":"The identifier of the type of dependency between the linked planning and zoning applications.",
            "nullable":false,
            "x-queryable":true
        },
        "RelTransPuid":{
            "maxLength":"64",
            "type":"string",
            "description":"The public unique identifier of a migrated planning and zoning application that is being linked.",
            "nullable":true,
            "x-queryable":true
        },
        "TransactionId":{
            "maxLength":"50",
            "type":"string",
            "description":"The unique identifier of the planning and zoning application.",
            "nullable":false,
            "x-queryable":true
        },
        "AddedDate":{
            "type":"string",
            "description":"The date on which the applications were linked.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RelatedPuid":{
            "maxLength":"480",
            "type":"string",
            "description":"The public unique identifier of a migrated related record transaction.",
            "nullable":false,
            "x-queryable":true
        },
        "Classification":{
            "maxLength":"3",
            "type":"string",
            "description":"The classification of the type of application.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RelTransTypeId":{
            "maxLength":"30",
            "type":"string",
            "description":"The unique identifier of the related transaction type.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "RelTransactionType":{
            "maxLength":"8",
            "type":"string",
            "description":"Identifies the related transaction type like permit, planning, business license, or case.",
            "nullable":false,
            "default":"ORA_REC",
            "x-queryable":true
        },
        "RelTransKey":{
            "type":"integer",
            "description":"The unique identifier of the planning and zoning application that is being linked.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "RelTransTypeCode":{
            "title":"Application Type",
            "maxLength":"40",
            "type":"string",
            "description":"The unique identifier of the related transaction type code.",
            "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