Jump to

• Request
• Response

Create a record type display group

post

/fscmRestApi/resources/11.13.18.05/publicSectorDisplayGroups

Request

Supported Media Types

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

Body ()

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

Root Schema : publicSectorDisplayGroups-item

Type: object

Show Source

• AgencyId(optional): integer(int64)
  Title: Agency ID

  The unique identifier of a public sector agency.
• CreatedBy(optional): string
  Title: Created By

  Maximum Length: 64

  The user who created the record type display group.
• CreationDate(optional): string(date-time)
  Title: Creation Date

  The date when the record type display group was created.
• Description(optional): string
  Maximum Length: 100

  The short description of the record type display group.
• DisplayGroup(optional): string
  Maximum Length: 30

  The unique identifier of the record type display group.
• DisplayGroupLine(optional): array Record Type Display Group lines
  Title: Record Type Display Group lines

  The display groups resource is used to view, create, modify, or delete a display group. A display group is a set of record types organized logically from which the public user can select the desired item. A record type can be a permit, a license, and so on.
• EnabledFlag(optional): boolean
  Title: Enabled

  Indicates whether the record type display group is available to be used or not. The default value is false.
• LastUpdateDate(optional): string(date-time)
  Title: Last Updated Date

  The date when the record type display group was last updated.
• LastUpdatedBy(optional): string
  Title: Last Updated By

  Maximum Length: 64

  The user who last updated the record type display group.
• links(optional): array Items
  Title: Items

  Link Relations
• LongDescription(optional): string
  Title: Description

  Maximum Length: 1000

  The long description of the record type display group.
• Url(optional): string
  Title: URL

  The URL provides a link that the user can click to navigate to other pages with more information.
• UseBusLicensing(optional): string
  Maximum Length: 1

  Indicates whether the display group is used for the business licensing service or not. The default value is no.
• UsePermitting(optional): string
  Maximum Length: 1

  Indicates whether the display group is used for the permits service or not. The default value is yes.
• UsePlanning(optional): string
  Maximum Length: 1

  Indicates whether the display group is used for the planning and zoning service or not. The default value is no.
• UsePolLicensing(optional): string
  Maximum Length: 1

  Indicates whether the display group is used for the professional licensing service or not. The default value is no.

{
    "properties":{
        "AgencyId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of a public sector agency.",
            "title":"Agency ID"
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the record type display group.",
            "title":"Created By"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date when the record type display group was created.",
            "title":"Creation Date"
        },
        "Description":{
            "maxLength":100,
            "type":"string",
            "description":"The short description of the record type display group."
        },
        "DisplayGroup":{
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier of the record type display group."
        },
        "DisplayGroupLine":{
            "items":{
                "$ref":"#/definitions/publicSectorDisplayGroups-DisplayGroupLine-item"
            },
            "type":"array",
            "description":"The display groups resource is used to view, create, modify, or delete a display group. A display group is a set of record types organized logically from which the public user can select the desired item. A record type can be a permit, a license, and so on.",
            "title":"Record Type Display Group lines"
        },
        "EnabledFlag":{
            "type":"boolean",
            "description":"Indicates whether the record type display group is available to be used or not. The default value is false.",
            "title":"Enabled"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date when the record type display group was last updated.",
            "title":"Last Updated Date"
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the record type display group.",
            "title":"Last Updated By"
        },
        "LongDescription":{
            "maxLength":1000,
            "type":"string",
            "description":"The long description of the record type display group.",
            "title":"Description"
        },
        "Url":{
            "type":"string",
            "description":"The URL provides a link that the user can click to navigate to other pages with more information.",
            "title":"URL"
        },
        "UseBusLicensing":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the display group is used for the business licensing service or not. The default value is no."
        },
        "UsePermitting":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the display group is used for the permits service or not. The default value is yes."
        },
        "UsePlanning":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the display group is used for the planning and zoning service or not. The default value is no."
        },
        "UsePolLicensing":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the display group is used for the professional licensing service or not. The default value is no."
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Record Type Display Group lines

Type: array

Title: Record Type Display Group lines

The display groups resource is used to view, create, modify, or delete a display group. A display group is a set of record types organized logically from which the public user can select the desired item. A record type can be a permit, a license, and so on.

Show Source

• Array of: object publicSectorDisplayGroups-DisplayGroupLine-item

{
    "items":{
        "$ref":"#/definitions/publicSectorDisplayGroups-DisplayGroupLine-item"
    },
    "type":"array",
    "description":"The display groups resource is used to view, create, modify, or delete a display group. A display group is a set of record types organized logically from which the public user can select the desired item. A record type can be a permit, a license, and so on.",
    "title":"Record Type Display Group lines"
}

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 : publicSectorDisplayGroups-DisplayGroupLine-item

Type: object

Show Source

• AgencyId(optional): integer(int64)
  Title: Agency ID

  The unique identifier of a public sector agency.
• CreatedBy(optional): string
  Title: Created By

  Maximum Length: 64

  The user who created the record type display group line.
• CreationDate(optional): string(date-time)
  Title: Creation Date

  The date when the record type display group line was created.
• DisplayGroup(optional): string
  Maximum Length: 30

  The display group to which the group line belongs.
• DisplayOrder(optional): integer(int64)
  The display number for the display group line.
• LastUpdateDate(optional): string(date-time)
  Title: Last Updated Date

  The date when the record type display group line was last updated.
• LastUpdatedBy(optional): string
  Title: Last Updated By

  Maximum Length: 64

  The user who last updated the record type display group line.
• links(optional): array Items
  Title: Items

  Link Relations
• RecordTypeCode(optional): string
  Title: Record Type Code

  Maximum Length: 20

  The short name of the record type included in the display group line.
• RecordTypeId(optional): string
  Title: Record Type ID

  Maximum Length: 30

  The unique identifier of the record type included in the display group line.

{
    "properties":{
        "AgencyId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of a public sector agency.",
            "title":"Agency ID"
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the record type display group line.",
            "title":"Created By"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date when the record type display group line was created.",
            "title":"Creation Date"
        },
        "DisplayGroup":{
            "maxLength":30,
            "type":"string",
            "description":"The display group to which the group line belongs."
        },
        "DisplayOrder":{
            "format":"int64",
            "type":"integer",
            "description":"The display number for the display group line."
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date when the record type display group line was last updated.",
            "title":"Last Updated Date"
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the record type display group line.",
            "title":"Last Updated By"
        },
        "RecordTypeCode":{
            "maxLength":20,
            "type":"string",
            "description":"The short name of the record type included in the display group line.",
            "title":"Record Type Code"
        },
        "RecordTypeId":{
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier of the record type included in the display group line.",
            "title":"Record Type ID"
        },
        "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 : publicSectorDisplayGroups-item

Type: object

Show Source

• AgencyId(optional): integer(int64)
  Title: Agency ID

  The unique identifier of a public sector agency.
• CreatedBy(optional): string
  Title: Created By

  Maximum Length: 64

  The user who created the record type display group.
• CreationDate(optional): string(date-time)
  Title: Creation Date

  The date when the record type display group was created.
• Description(optional): string
  Maximum Length: 100

  The short description of the record type display group.
• DisplayGroup(optional): string
  Maximum Length: 30

  The unique identifier of the record type display group.
• DisplayGroupLine(optional): array Record Type Display Group lines
  Title: Record Type Display Group lines

  The display groups resource is used to view, create, modify, or delete a display group. A display group is a set of record types organized logically from which the public user can select the desired item. A record type can be a permit, a license, and so on.
• EnabledFlag(optional): boolean
  Title: Enabled

  Indicates whether the record type display group is available to be used or not. The default value is false.
• LastUpdateDate(optional): string(date-time)
  Title: Last Updated Date

  The date when the record type display group was last updated.
• LastUpdatedBy(optional): string
  Title: Last Updated By

  Maximum Length: 64

  The user who last updated the record type display group.
• links(optional): array Items
  Title: Items

  Link Relations
• LongDescription(optional): string
  Title: Description

  Maximum Length: 1000

  The long description of the record type display group.
• Url(optional): string
  Title: URL

  The URL provides a link that the user can click to navigate to other pages with more information.
• UseBusLicensing(optional): string
  Maximum Length: 1

  Indicates whether the display group is used for the business licensing service or not. The default value is no.
• UsePermitting(optional): string
  Maximum Length: 1

  Indicates whether the display group is used for the permits service or not. The default value is yes.
• UsePlanning(optional): string
  Maximum Length: 1

  Indicates whether the display group is used for the planning and zoning service or not. The default value is no.
• UsePolLicensing(optional): string
  Maximum Length: 1

  Indicates whether the display group is used for the professional licensing service or not. The default value is no.

{
    "properties":{
        "AgencyId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of a public sector agency.",
            "title":"Agency ID"
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the record type display group.",
            "title":"Created By"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date when the record type display group was created.",
            "title":"Creation Date"
        },
        "Description":{
            "maxLength":100,
            "type":"string",
            "description":"The short description of the record type display group."
        },
        "DisplayGroup":{
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier of the record type display group."
        },
        "DisplayGroupLine":{
            "items":{
                "$ref":"#/definitions/publicSectorDisplayGroups-DisplayGroupLine-item"
            },
            "type":"array",
            "description":"The display groups resource is used to view, create, modify, or delete a display group. A display group is a set of record types organized logically from which the public user can select the desired item. A record type can be a permit, a license, and so on.",
            "title":"Record Type Display Group lines"
        },
        "EnabledFlag":{
            "type":"boolean",
            "description":"Indicates whether the record type display group is available to be used or not. The default value is false.",
            "title":"Enabled"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date when the record type display group was last updated.",
            "title":"Last Updated Date"
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the record type display group.",
            "title":"Last Updated By"
        },
        "LongDescription":{
            "maxLength":1000,
            "type":"string",
            "description":"The long description of the record type display group.",
            "title":"Description"
        },
        "Url":{
            "type":"string",
            "description":"The URL provides a link that the user can click to navigate to other pages with more information.",
            "title":"URL"
        },
        "UseBusLicensing":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the display group is used for the business licensing service or not. The default value is no."
        },
        "UsePermitting":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the display group is used for the permits service or not. The default value is yes."
        },
        "UsePlanning":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the display group is used for the planning and zoning service or not. The default value is no."
        },
        "UsePolLicensing":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the display group is used for the professional licensing service or not. The default value is no."
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Record Type Display Group lines

Type: array

Title: Record Type Display Group lines

The display groups resource is used to view, create, modify, or delete a display group. A display group is a set of record types organized logically from which the public user can select the desired item. A record type can be a permit, a license, and so on.

Show Source

• Array of: object publicSectorDisplayGroups-DisplayGroupLine-item

{
    "items":{
        "$ref":"#/definitions/publicSectorDisplayGroups-DisplayGroupLine-item"
    },
    "type":"array",
    "description":"The display groups resource is used to view, create, modify, or delete a display group. A display group is a set of record types organized logically from which the public user can select the desired item. A record type can be a permit, a license, and so on.",
    "title":"Record Type Display Group lines"
}

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 : publicSectorDisplayGroups-DisplayGroupLine-item

Type: object

Show Source

• AgencyId(optional): integer(int64)
  Title: Agency ID

  The unique identifier of a public sector agency.
• CreatedBy(optional): string
  Title: Created By

  Maximum Length: 64

  The user who created the record type display group line.
• CreationDate(optional): string(date-time)
  Title: Creation Date

  The date when the record type display group line was created.
• DisplayGroup(optional): string
  Maximum Length: 30

  The display group to which the group line belongs.
• DisplayOrder(optional): integer(int64)
  The display number for the display group line.
• LastUpdateDate(optional): string(date-time)
  Title: Last Updated Date

  The date when the record type display group line was last updated.
• LastUpdatedBy(optional): string
  Title: Last Updated By

  Maximum Length: 64

  The user who last updated the record type display group line.
• links(optional): array Items
  Title: Items

  Link Relations
• RecordTypeCode(optional): string
  Title: Record Type Code

  Maximum Length: 20

  The short name of the record type included in the display group line.
• RecordTypeId(optional): string
  Title: Record Type ID

  Maximum Length: 30

  The unique identifier of the record type included in the display group line.

{
    "properties":{
        "AgencyId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of a public sector agency.",
            "title":"Agency ID"
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the record type display group line.",
            "title":"Created By"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date when the record type display group line was created.",
            "title":"Creation Date"
        },
        "DisplayGroup":{
            "maxLength":30,
            "type":"string",
            "description":"The display group to which the group line belongs."
        },
        "DisplayOrder":{
            "format":"int64",
            "type":"integer",
            "description":"The display number for the display group line."
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date when the record type display group line was last updated.",
            "title":"Last Updated Date"
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the record type display group line.",
            "title":"Last Updated By"
        },
        "RecordTypeCode":{
            "maxLength":20,
            "type":"string",
            "description":"The short name of the record type included in the display group line.",
            "title":"Record Type Code"
        },
        "RecordTypeId":{
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier of the record type included in the display group line.",
            "title":"Record Type ID"
        },
        "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