Jump to

• Request
• Response

Create a terms of use definition is not supported

post

/fscmRestApi/resources/11.13.18.05/publicSectorTermsOfUsesTotals

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

Type: object

Show Source

• AgencyId(optional): integer(int32)
  The unique identifier for an agency that is associated with a terms of use definition.
• CreatedBy(optional): string
  Maximum Length: 64

  The user who created the terms of use definition.
• CreationDate(optional): string(date-time)
  The date and time that the terms of use definition was created.
• Description(optional): string
  Maximum Length: 100

  The description of the terms of use definition.
• EffectiveEndDate(optional): string(date)
  The effective end date of the terms of use definition.
• EffectiveStartDate(optional): string(date)
  The effective start date of the terms of use definition.
• LastUpdateDate(optional): string(date-time)
  The date and time when the terms of use definition was last updated.
• LastUpdatedBy(optional): string
  Maximum Length: 64

  The user who last updated the terms of use definition.
• LastUpdateLogin(optional): string
  Maximum Length: 32

  The session login associated to the user who last updated the terms of use definition.
• links(optional): array Items
  Title: Items

  Link Relations
• TermsContent(optional): string
  The detailed content of the terms of use.
• TermsUseId(optional): string
  Maximum Length: 255

  The unique identifier for the terms of use definition.
• UseBusLicensing(optional): string
  Maximum Length: 1

  Indicates whether the terms of use definition can be used for business licensing functionality. If the value is Y, the definition can be used. The default value is N. NOTE: This attribute is deprecated in update 22B and should not be used.
• UsePermitting(optional): string
  Maximum Length: 1

  Indicates whether the terms of use definition can be used for permits functionality. If the value is Y, the definition can be used. The default value is N. NOTE: This attribute is deprecated in update 22B and should not be used.
• UsePlanning(optional): string
  Maximum Length: 1

  Indicates whether the terms of use definition can be used for planning and zoning functionality. If the value is Y, the definition can be used. The default value is N. NOTE: This attribute is deprecated in update 22B and should not be used.
• UsePolLicensing(optional): string
  Maximum Length: 1

  Indicates whether the terms of use definition can be used for professional licensing functionality. If the value is Y, the definition can be used. The default value is N. NOTE: This attribute is deprecated in update 22B and should not be used.
• UseRegistration(optional): string
  Maximum Length: 1

  Indicates whether the terms of use definition can be used in the public user registration process. If the value is Y, the definition can be used. The default value is N. NOTE: This attribute is deprecated in update 22B and should not be used.

{
    "properties":{
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The unique identifier for an agency that is associated with a terms of use definition."
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the terms of use definition."
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time that the terms of use definition was created."
        },
        "Description":{
            "maxLength":100,
            "type":"string",
            "description":"The description of the terms of use definition."
        },
        "EffectiveEndDate":{
            "format":"date",
            "type":"string",
            "description":"The effective end date of the terms of use definition."
        },
        "EffectiveStartDate":{
            "format":"date",
            "type":"string",
            "description":"The effective start date of the terms of use definition."
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the terms of use definition was last updated."
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The session login associated to the user who last updated the terms of use definition."
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the terms of use definition."
        },
        "TermsContent":{
            "type":"string",
            "description":"The detailed content of the terms of use."
        },
        "TermsUseId":{
            "maxLength":255,
            "type":"string",
            "description":"The unique identifier for the terms of use definition."
        },
        "UseBusLicensing":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the terms of use definition can be used for business licensing functionality. If the value is Y, the definition can be used. The default value is N. NOTE: This attribute is deprecated in update 22B and should not be used."
        },
        "UsePermitting":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the terms of use definition can be used for permits functionality. If the value is Y, the definition can be used. The default value is N. NOTE: This attribute is deprecated in update 22B and should not be used."
        },
        "UsePlanning":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the terms of use definition can be used for planning and zoning functionality. If the value is Y, the definition can be used. The default value is N. NOTE: This attribute is deprecated in update 22B and should not be used."
        },
        "UsePolLicensing":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the terms of use definition can be used for professional licensing functionality. If the value is Y, the definition can be used. The default value is N. NOTE: This attribute is deprecated in update 22B and should not be used."
        },
        "UseRegistration":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the terms of use definition can be used in the public user registration process. If the value is Y, the definition can be used. The default value is N. NOTE: This attribute is deprecated in update 22B and should not be used."
        },
        "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 : publicSectorTermsOfUsesTotals-item

Type: object

Show Source

• AgencyId(optional): integer(int32)
  The unique identifier for an agency that is associated with a terms of use definition.
• CreatedBy(optional): string
  Maximum Length: 64

  The user who created the terms of use definition.
• CreationDate(optional): string(date-time)
  The date and time that the terms of use definition was created.
• Description(optional): string
  Maximum Length: 100

  The description of the terms of use definition.
• EffectiveEndDate(optional): string(date)
  The effective end date of the terms of use definition.
• EffectiveStartDate(optional): string(date)
  The effective start date of the terms of use definition.
• LastUpdateDate(optional): string(date-time)
  The date and time when the terms of use definition was last updated.
• LastUpdatedBy(optional): string
  Maximum Length: 64

  The user who last updated the terms of use definition.
• LastUpdateLogin(optional): string
  Maximum Length: 32

  The session login associated to the user who last updated the terms of use definition.
• links(optional): array Items
  Title: Items

  Link Relations
• TermsContent(optional): string
  The detailed content of the terms of use.
• TermsUseId(optional): string
  Maximum Length: 255

  The unique identifier for the terms of use definition.
• UseBusLicensing(optional): string
  Maximum Length: 1

  Indicates whether the terms of use definition can be used for business licensing functionality. If the value is Y, the definition can be used. The default value is N. NOTE: This attribute is deprecated in update 22B and should not be used.
• UsePermitting(optional): string
  Maximum Length: 1

  Indicates whether the terms of use definition can be used for permits functionality. If the value is Y, the definition can be used. The default value is N. NOTE: This attribute is deprecated in update 22B and should not be used.
• UsePlanning(optional): string
  Maximum Length: 1

  Indicates whether the terms of use definition can be used for planning and zoning functionality. If the value is Y, the definition can be used. The default value is N. NOTE: This attribute is deprecated in update 22B and should not be used.
• UsePolLicensing(optional): string
  Maximum Length: 1

  Indicates whether the terms of use definition can be used for professional licensing functionality. If the value is Y, the definition can be used. The default value is N. NOTE: This attribute is deprecated in update 22B and should not be used.
• UseRegistration(optional): string
  Maximum Length: 1

  Indicates whether the terms of use definition can be used in the public user registration process. If the value is Y, the definition can be used. The default value is N. NOTE: This attribute is deprecated in update 22B and should not be used.

{
    "properties":{
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The unique identifier for an agency that is associated with a terms of use definition."
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the terms of use definition."
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time that the terms of use definition was created."
        },
        "Description":{
            "maxLength":100,
            "type":"string",
            "description":"The description of the terms of use definition."
        },
        "EffectiveEndDate":{
            "format":"date",
            "type":"string",
            "description":"The effective end date of the terms of use definition."
        },
        "EffectiveStartDate":{
            "format":"date",
            "type":"string",
            "description":"The effective start date of the terms of use definition."
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the terms of use definition was last updated."
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The session login associated to the user who last updated the terms of use definition."
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the terms of use definition."
        },
        "TermsContent":{
            "type":"string",
            "description":"The detailed content of the terms of use."
        },
        "TermsUseId":{
            "maxLength":255,
            "type":"string",
            "description":"The unique identifier for the terms of use definition."
        },
        "UseBusLicensing":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the terms of use definition can be used for business licensing functionality. If the value is Y, the definition can be used. The default value is N. NOTE: This attribute is deprecated in update 22B and should not be used."
        },
        "UsePermitting":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the terms of use definition can be used for permits functionality. If the value is Y, the definition can be used. The default value is N. NOTE: This attribute is deprecated in update 22B and should not be used."
        },
        "UsePlanning":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the terms of use definition can be used for planning and zoning functionality. If the value is Y, the definition can be used. The default value is N. NOTE: This attribute is deprecated in update 22B and should not be used."
        },
        "UsePolLicensing":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the terms of use definition can be used for professional licensing functionality. If the value is Y, the definition can be used. The default value is N. NOTE: This attribute is deprecated in update 22B and should not be used."
        },
        "UseRegistration":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the terms of use definition can be used in the public user registration process. If the value is Y, the definition can be used. The default value is N. NOTE: This attribute is deprecated in update 22B and should not be used."
        },
        "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