Update a terms of use definition is not supported
patch
/fscmRestApi/resources/11.13.18.05/publicSectorTermsOfUsesTotals/{publicSectorTermsOfUsesTotalsUniqID}
Request
Supported Media Types
- application/vnd.oracle.adf.resourceitem+json
- application/json
Path Parameters
-
publicSectorTermsOfUsesTotalsUniqID: integer
This is the hash key of the attributes which make up the composite key--- TermsUseId, EffectiveStartDate, EffectiveEndDate and AgencyId ---for the Terms Of Use Totals resource and used to uniquely identify an instance of Terms Of Use Totals. The client should not generate the hash key value. Instead, the client should query on the Terms Of Use Totals collection resource with a filter on the primary key values in order to navigate to a specific instance of Terms Of Use Totals.
For example: publicSectorTermsOfUsesTotals?q=TermsUseId=<value1>;EffectiveStartDate=<value2>;EffectiveEndDate=<value3>;AgencyId=<value4>
The following table describes the body parameters in the request for this task.
Root Schema : publicSectorTermsOfUsesTotals-item
Type:
Show Source
object
-
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. -
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. -
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. -
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. -
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.
Nested Schema : link
Type:
Show Source
object
-
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.
Response
Supported Media Types
- application/vnd.oracle.adf.resourceitem+json
- application/json
Default Response
The following table describes the default response for this task.
Root Schema : publicSectorTermsOfUsesTotals-item
Type:
Show Source
object
-
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. -
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. -
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. -
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. -
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.
Nested Schema : link
Type:
Show Source
object
-
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.