Jump to

• Request
• Response

Create

post

/fscmRestApi/resources/11.13.18.05/publicSectorRecords/{LnpRecordKey}/child/LnpReLink

Request

Path Parameters

• LnpRecordKey(required): integer(int64)
  The unique identifier for a record. The record is for a permit, business license, professional license, or planning and zoning, and is determined by the classification.

Header Parameters

• Metadata-Context: string
  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: string
  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: string
  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

• DeletedFlag: string
  Maximum Length: 20
• LnpRecordId: string
  Maximum Length: 50
• LnpRecordKey(required): integer
• LnpReLinkKey: integer
• LnpReLinkPuid: string
  Maximum Length: 480
• MigratedDataFlag: string
  Maximum Length: 3
• RecordKey(required): integer
• ReRecord: array ReRecord
• ReRecordId: string
  Maximum Length: 50

{
    "required":[
        "LnpRecordKey",
        "RecordKey"
    ],
    "type":"object",
    "properties":{
        "DeletedFlag":{
            "maxLength":20,
            "type":"string",
            "nullable":true
        },
        "LnpReLinkKey":{
            "type":"integer",
            "nullable":false,
            "x-hints":{
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "LnpReLinkPuid":{
            "maxLength":480,
            "type":"string",
            "nullable":true
        },
        "LnpRecordId":{
            "maxLength":50,
            "type":"string",
            "nullable":true
        },
        "LnpRecordKey":{
            "type":"integer",
            "nullable":false
        },
        "MigratedDataFlag":{
            "maxLength":3,
            "type":"string",
            "nullable":true
        },
        "ReRecord":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/publicSectorRecords-LnpReLink-ReRecord-item-post-request"
            }
        },
        "ReRecordId":{
            "maxLength":50,
            "type":"string",
            "nullable":true
        },
        "RecordKey":{
            "type":"integer",
            "nullable":false
        }
    }
}

Nested Schema : ReRecord

Type: array

Show Source

• Array of: object publicSectorRecords-LnpReLink-ReRecord-item-post-request

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/publicSectorRecords-LnpReLink-ReRecord-item-post-request"
    }
}

Nested Schema : publicSectorRecords-LnpReLink-ReRecord-item-post-request

Type: object

Show Source

• AgencyId: integer (int32)
• ClosedDate: string (date-time)
• CreatedByUserName: string
  Maximum Length: 30
• CurrentTransFlag: string
  Maximum Length: 3
• Description: string
  Title: Description
• DescriptionPlain: string
  Title: Description
• FeatureAttributes: string (byte)
• FeatureGeometry: string (byte)
• LastFeatureEditDate: string (date-time)
• LastUpdatedByUserName: string
  Maximum Length: 30
• LayoutVersion: string
  Maximum Length: 30
• MigratedDataFlag: string
  Maximum Length: 3
• MobileFlag: string
  Maximum Length: 1
• ParentRecordKey: integer (int64)
  Title: Parent
• ProgramTypeId: string
  Maximum Length: 50
• RecordId: string
  Title: ID

  Maximum Length: 50
• RecordKey: integer (int64)
• RecordName: string
  Maximum Length: 80
• RecordNumber: string
  Maximum Length: 64
• ReName: string
  Title: Name

  Maximum Length: 100
• RowType: string
  Maximum Length: 30
• Status: string
  Title: Status

  Maximum Length: 30
• SubmitDate: string (date-time)

{
    "type":"object",
    "properties":{
        "AgencyId":{
            "type":"integer",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":8
            }
        },
        "ClosedDate":{
            "type":"string",
            "format":"date-time",
            "nullable":true
        },
        "CreatedByUserName":{
            "maxLength":30,
            "type":"string",
            "nullable":true
        },
        "CurrentTransFlag":{
            "maxLength":3,
            "type":"string",
            "nullable":true
        },
        "Description":{
            "title":"Description",
            "type":"string",
            "nullable":true
        },
        "DescriptionPlain":{
            "title":"Description",
            "type":"string",
            "nullable":true
        },
        "FeatureAttributes":{
            "type":"string",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "FeatureGeometry":{
            "type":"string",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "LastFeatureEditDate":{
            "type":"string",
            "format":"date-time",
            "nullable":true
        },
        "LastUpdatedByUserName":{
            "maxLength":30,
            "type":"string",
            "nullable":true
        },
        "LayoutVersion":{
            "maxLength":30,
            "type":"string",
            "nullable":true
        },
        "MigratedDataFlag":{
            "maxLength":3,
            "type":"string",
            "nullable":true
        },
        "MobileFlag":{
            "maxLength":1,
            "type":"string",
            "nullable":true
        },
        "ParentRecordKey":{
            "title":"Parent",
            "type":"integer",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ProgramTypeId":{
            "maxLength":50,
            "type":"string",
            "nullable":true
        },
        "ReName":{
            "title":"Name",
            "maxLength":100,
            "type":"string",
            "nullable":true
        },
        "RecordId":{
            "title":"ID",
            "maxLength":50,
            "type":"string",
            "nullable":false
        },
        "RecordKey":{
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "RecordName":{
            "maxLength":80,
            "type":"string",
            "nullable":true
        },
        "RecordNumber":{
            "maxLength":64,
            "type":"string",
            "nullable":false
        },
        "RowType":{
            "maxLength":30,
            "type":"string",
            "nullable":false
        },
        "Status":{
            "title":"Status",
            "maxLength":30,
            "type":"string",
            "nullable":true
        },
        "SubmitDate":{
            "type":"string",
            "format":"date-time",
            "nullable":false
        }
    }
}

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 : publicSectorRecords-LnpReLink-item-response

Type: object

Show Source

• CreatedBy: string
  Read Only: true

  Maximum Length: 64
• CreationDate: string (date-time)
  Read Only: true
• DeletedFlag: string
  Maximum Length: 20
• LastUpdateDate: string (date-time)
  Read Only: true
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LnpRecordId: string
  Maximum Length: 50
• LnpRecordKey: integer
• LnpReLinkKey: integer
• LnpReLinkPuid: string
  Maximum Length: 480
• MigratedDataFlag: string
  Maximum Length: 3
• ObjectVersionNumber: integer (int32)
  Read Only: true
• RecordKey: integer
• ReRecord: array ReRecord
• ReRecordId: string
  Maximum Length: 50

{
    "type":"object",
    "properties":{
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DeletedFlag":{
            "maxLength":20,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LnpReLinkKey":{
            "type":"integer",
            "nullable":false,
            "x-hints":{
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "LnpReLinkPuid":{
            "maxLength":480,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "LnpRecordId":{
            "maxLength":50,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "LnpRecordKey":{
            "type":"integer",
            "nullable":false,
            "x-queryable":true
        },
        "MigratedDataFlag":{
            "maxLength":3,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "ReRecord":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/publicSectorRecords-LnpReLink-ReRecord-item-response"
            }
        },
        "ReRecordId":{
            "maxLength":50,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "RecordKey":{
            "type":"integer",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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 : ReRecord

Type: array

Show Source

• Array of: object publicSectorRecords-LnpReLink-ReRecord-item-response

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/publicSectorRecords-LnpReLink-ReRecord-item-response"
    }
}

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."
        }
    }
}

Nested Schema : publicSectorRecords-LnpReLink-ReRecord-item-response

Type: object

Show Source

• Address1: string
  Read Only: true

  Maximum Length: 240
• Address2: string
  Read Only: true

  Maximum Length: 240
• AgencyId: integer (int32)
• Category: string
  Title: Category

  Read Only: true

  Maximum Length: 30
• CategoryMeaning: string
  Read Only: true

  Maximum Length: 255
• City: string
  Read Only: true

  Maximum Length: 60
• Classification: string
  Title: Classification

  Read Only: true

  Maximum Length: 10
• ClosedDate: string (date-time)
• Country: string
  Read Only: true

  Maximum Length: 3
• CreatedBy: string
  Read Only: true

  Maximum Length: 64
• CreatedByUserName: string
  Maximum Length: 30
• CreationDate: string (date-time)
  Read Only: true
• CreationDateLocation: string (date-time)
  Read Only: true
• CurrentTransFlag: string
  Maximum Length: 3
• Description: string
  Title: Description
• DescriptionPlain: string
  Title: Description
• FeatureAttributes: string (byte)
• FeatureGeometry: string (byte)
• LastFeatureEditDate: string (date-time)
• LastUpdateDate: string (date-time)
  Read Only: true
• LastUpdateDateLocation: string (date-time)
  Read Only: true
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64
• LastUpdatedByUserName: string
  Maximum Length: 30
• Latitude: number
  Read Only: true
• LayoutVersion: string
  Maximum Length: 30
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Longitude: number
  Read Only: true
• MigratedDataFlag: string
  Maximum Length: 3
• MobileFlag: string
  Maximum Length: 1
• ParentRecordKey: integer (int64)
  Title: Parent
• PostalCode: string
  Read Only: true

  Maximum Length: 60
• ProgramTypeId: string
  Maximum Length: 50
• RecordId: string
  Title: ID

  Maximum Length: 50
• RecordKey: integer (int64)
• RecordName: string
  Maximum Length: 80
• RecordNumber: string
  Maximum Length: 64
• RefEntityLocationId: string
  Read Only: true

  Maximum Length: 50
• RefEntityLocationKey: integer (int64)
  Read Only: true
• ReName: string
  Title: Name

  Maximum Length: 100
• ReType: string
  Title: Reference Entity Type

  Read Only: true

  Maximum Length: 100
• ReTypeCode: string
  Title: Reference Entity Type ID

  Read Only: true

  Maximum Length: 40
• ReTypeId: string
  Title: Reference Entity Type ID

  Read Only: true

  Maximum Length: 50
• RowType: string
  Maximum Length: 30
• State: string
  Read Only: true

  Maximum Length: 60
• Status: string
  Title: Status

  Maximum Length: 30
• StatusMeaning: string
  Read Only: true

  Maximum Length: 50
• Subcategory: string
  Title: Subcategory

  Read Only: true

  Maximum Length: 30
• SubcategoryMeaning: string
  Read Only: true

  Maximum Length: 255
• SubClassification: string
  Title: Subclassification

  Read Only: true

  Maximum Length: 10
• SubmitDate: string (date-time)

{
    "type":"object",
    "properties":{
        "Address1":{
            "maxLength":240,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Address2":{
            "maxLength":240,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AgencyId":{
            "type":"integer",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":8
            },
            "x-queryable":true
        },
        "Category":{
            "title":"Category",
            "maxLength":30,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CategoryMeaning":{
            "maxLength":255,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "City":{
            "maxLength":60,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Classification":{
            "title":"Classification",
            "maxLength":10,
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ClosedDate":{
            "type":"string",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "Country":{
            "maxLength":3,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedByUserName":{
            "maxLength":30,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDateLocation":{
            "type":"string",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CurrentTransFlag":{
            "maxLength":3,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "DescriptionPlain":{
            "title":"Description",
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "FeatureAttributes":{
            "type":"string",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "FeatureGeometry":{
            "type":"string",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "LastFeatureEditDate":{
            "type":"string",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDateLocation":{
            "type":"string",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedByUserName":{
            "maxLength":30,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "Latitude":{
            "type":"number",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LayoutVersion":{
            "maxLength":30,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "Longitude":{
            "type":"number",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MigratedDataFlag":{
            "maxLength":3,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "MobileFlag":{
            "maxLength":1,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "ParentRecordKey":{
            "title":"Parent",
            "type":"integer",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PostalCode":{
            "maxLength":60,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ProgramTypeId":{
            "maxLength":50,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "ReName":{
            "title":"Name",
            "maxLength":100,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "ReType":{
            "title":"Reference Entity Type",
            "maxLength":100,
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ReTypeCode":{
            "title":"Reference Entity Type ID",
            "maxLength":40,
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ReTypeId":{
            "title":"Reference Entity Type ID",
            "maxLength":50,
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RecordId":{
            "title":"ID",
            "maxLength":50,
            "type":"string",
            "nullable":false,
            "x-queryable":true
        },
        "RecordKey":{
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RecordName":{
            "maxLength":80,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "RecordNumber":{
            "maxLength":64,
            "type":"string",
            "nullable":false,
            "x-queryable":true
        },
        "RefEntityLocationId":{
            "maxLength":50,
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RefEntityLocationKey":{
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "RowType":{
            "maxLength":30,
            "type":"string",
            "nullable":false,
            "x-queryable":true
        },
        "State":{
            "maxLength":60,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Status":{
            "title":"Status",
            "maxLength":30,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "StatusMeaning":{
            "maxLength":50,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SubClassification":{
            "title":"Subclassification",
            "maxLength":10,
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Subcategory":{
            "title":"Subcategory",
            "maxLength":30,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SubcategoryMeaning":{
            "maxLength":255,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SubmitDate":{
            "type":"string",
            "format":"date-time",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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"
    }
}

Links

ReRecord

Operation: /fscmRestApi/resources/11.13.18.05/publicSectorRecords/{LnpRecordKey}/child/LnpReLink/{publicSectorRecords_LnpReLink_Id}/child/ReRecord

Parameters:

• LnpRecordKey: $request.path.LnpRecordKey
• publicSectorRecords_LnpReLink_Id: $request.path.publicSectorRecords_LnpReLink_Id

Back to Top