Jump to

• Request
• Response

Create an application group

post

/fscmRestApi/resources/11.13.18.05/publicSectorApplGroups

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

Type: object

Show Source

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

  Identifies a public sector agency.
• ApplGroup(optional): string
  Title: Group

  Maximum Length: 30

  The categorization for the application form.
• CreatedBy(optional): string
  Title: Created By

  Maximum Length: 64

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

  The date when the application group was created.
• Description(optional): string
  Title: Description

  Maximum Length: 100

  The description for the permit group.
• EnabledFlag(optional): boolean
  Title: Enabled

  Indicates whether the application 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 application group was last updated.
• LastUpdatedBy(optional): string
  Title: Last Updated By

  Maximum Length: 64

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

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

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

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

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

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

{
    "properties":{
        "AgencyId":{
            "format":"int64",
            "type":"integer",
            "description":"Identifies a public sector agency.",
            "title":"Agency ID"
        },
        "ApplGroup":{
            "maxLength":30,
            "type":"string",
            "description":"The categorization for the application form.",
            "title":"Group"
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the application group.",
            "title":"Created By"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date when the application group was created.",
            "title":"Creation Date"
        },
        "Description":{
            "maxLength":100,
            "type":"string",
            "description":"The description for the permit group.",
            "title":"Description"
        },
        "EnabledFlag":{
            "type":"boolean",
            "description":"Indicates whether the application 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 application group was last updated.",
            "title":"Last Updated Date"
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the application group.",
            "title":"Last Updated By"
        },
        "UseBusLicensing":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the application group will be used for the business licensing service or not. The default value is no."
        },
        "UsePermitting":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the application group will be used for the permits service or not. The default value is yes."
        },
        "UsePlanning":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the application group will be used for the planning and zoning service or not. The default value is no."
        },
        "UsePolLicensing":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the application group will be 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 : 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 : publicSectorApplGroups-item

Type: object

Show Source

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

  Identifies a public sector agency.
• ApplGroup(optional): string
  Title: Group

  Maximum Length: 30

  The categorization for the application form.
• CreatedBy(optional): string
  Title: Created By

  Maximum Length: 64

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

  The date when the application group was created.
• Description(optional): string
  Title: Description

  Maximum Length: 100

  The description for the permit group.
• EnabledFlag(optional): boolean
  Title: Enabled

  Indicates whether the application 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 application group was last updated.
• LastUpdatedBy(optional): string
  Title: Last Updated By

  Maximum Length: 64

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

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

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

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

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

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

{
    "properties":{
        "AgencyId":{
            "format":"int64",
            "type":"integer",
            "description":"Identifies a public sector agency.",
            "title":"Agency ID"
        },
        "ApplGroup":{
            "maxLength":30,
            "type":"string",
            "description":"The categorization for the application form.",
            "title":"Group"
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the application group.",
            "title":"Created By"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date when the application group was created.",
            "title":"Creation Date"
        },
        "Description":{
            "maxLength":100,
            "type":"string",
            "description":"The description for the permit group.",
            "title":"Description"
        },
        "EnabledFlag":{
            "type":"boolean",
            "description":"Indicates whether the application 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 application group was last updated.",
            "title":"Last Updated Date"
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the application group.",
            "title":"Last Updated By"
        },
        "UseBusLicensing":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the application group will be used for the business licensing service or not. The default value is no."
        },
        "UsePermitting":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the application group will be used for the permits service or not. The default value is yes."
        },
        "UsePlanning":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the application group will be used for the planning and zoning service or not. The default value is no."
        },
        "UsePolLicensing":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the application group will be 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 : 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