Jump to

• Request
• Response

Create a global custom record

post

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

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

• LnpGlobalCustomPuid: string
  Maximum Length: 480

  The unique key identifier for the related data migration transaction.
• LnpRecordId: string
  Maximum Length: 50

  The logical identifier of the application record. This ID is generated based on the auto number rule configured for the record type.
• LnpRecordKey: integer (int64)
  The unique identifier of the record.
• ObjectVersionNumber: integer (int32)
  The system attribute that captures the incremental version number for an object.
• RecordNumber: string
  Maximum Length: 64

  The parent record key for the data migration transaction.

{
    "type":"object",
    "properties":{
        "LnpGlobalCustomPuid":{
            "maxLength":"480",
            "type":"string",
            "description":"The unique key identifier for the related data migration transaction.",
            "nullable":false
        },
        "LnpRecordId":{
            "maxLength":"50",
            "type":"string",
            "description":"The logical identifier of the application record. This ID is generated based on the auto number rule configured for the record type.",
            "nullable":false
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The system attribute that captures the incremental version number for an object.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"9"
            }
        },
        "RecordNumber":{
            "maxLength":"64",
            "type":"string",
            "description":"The parent record key for the data migration transaction.",
            "nullable":true
        },
        "LnpRecordKey":{
            "type":"integer",
            "description":"The unique identifier of the record.",
            "format":"int64",
            "nullable":false,
            "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 : publicSectorRecords-LnpGlobalCustom-item-response

Type: object

Show Source

• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The name of the user who created the comment.
• CreationDate: string (date-time)
  Read Only: true

  The date when the global custom was created.
• LastUpdateDate: string (date-time)
  Read Only: true

  The name of the user who last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The date when the global custom was last updated.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  The name of the user who last login.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LnpGlobalCustomPuid: string
  Maximum Length: 480

  The unique key identifier for the related data migration transaction.
• LnpRecordId: string
  Maximum Length: 50

  The logical identifier of the application record. This ID is generated based on the auto number rule configured for the record type.
• LnpRecordKey: integer (int64)
  The unique identifier of the record.
• ObjectVersionNumber: integer (int32)
  The system attribute that captures the incremental version number for an object.
• RecordNumber: string
  Maximum Length: 64

  The parent record key for the data migration transaction.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The date when the global custom was last updated.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LnpGlobalCustomPuid":{
            "maxLength":"480",
            "type":"string",
            "description":"The unique key identifier for the related data migration transaction.",
            "nullable":false,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the global custom was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LnpRecordId":{
            "maxLength":"50",
            "type":"string",
            "description":"The logical identifier of the application record. This ID is generated based on the auto number rule configured for the record type.",
            "nullable":false,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The name of the user who created the comment.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The system attribute that captures the incremental version number for an object.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "RecordNumber":{
            "maxLength":"64",
            "type":"string",
            "description":"The parent record key for the data migration transaction.",
            "nullable":true,
            "x-queryable":true
        },
        "LnpRecordKey":{
            "type":"integer",
            "description":"The unique identifier of the record.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The name of the user who last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":"32",
            "type":"string",
            "description":"The name of the user who last login.",
            "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