Update a contact type
patch
/fscmRestApi/resources/11.13.18.05/publicSectorContactTypes/{publicSectorContactTypesUniqID}
Request
Supported Media Types
- application/vnd.oracle.adf.resourceitem+json
- application/json
Path Parameters
-
publicSectorContactTypesUniqID: integer
This is the hash key of the attributes which make up the composite key--- ContactType and AgencyId ---for the Contact Types resource and used to uniquely identify an instance of Contact Types. The client should not generate the hash key value. Instead, the client should query on the Contact Types collection resource with a filter on the primary key values in order to navigate to a specific instance of Contact Types.
For example: publicSectorContactTypes?q=ContactType=<value1>;AgencyId=<value2>
The following table describes the body parameters in the request for this task.
Root Schema : publicSectorContactTypes-item
Type:
Show Source
object
-
AgencyId(optional):
integer(int32)
The agency ID of the contact type.
-
ContactType(optional):
string
Title:
Contact Type
Maximum Length:30
The contact type name. -
CreatedBy(optional):
string
Maximum Length:
64
The user who created the contact type. -
CreationDate(optional):
string(date-time)
The date and time that the contact type was created.
-
Description(optional):
string
Title:
Description
Maximum Length:100
The description of the contact type. -
EnabledFlag(optional):
string
Title:
Enabled
Maximum Length:1
Indicates whether the contact type is active. If the value is Y, the contact type is active. -
EnablePermitAccess(optional):
string
Title:
Permit Access Enabled
Maximum Length:1
Indicates whether permit access is enabled for a contact type. -
LastUpdateDate(optional):
string(date-time)
The date and time when the contact type was last updated.
-
LastUpdatedBy(optional):
string
Maximum Length:
64
The user who last updated the contact type. -
links(optional):
array Items
Title:
Items
Link Relations
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 : publicSectorContactTypes-item
Type:
Show Source
object
-
AgencyId(optional):
integer(int32)
The agency ID of the contact type.
-
ContactType(optional):
string
Title:
Contact Type
Maximum Length:30
The contact type name. -
CreatedBy(optional):
string
Maximum Length:
64
The user who created the contact type. -
CreationDate(optional):
string(date-time)
The date and time that the contact type was created.
-
Description(optional):
string
Title:
Description
Maximum Length:100
The description of the contact type. -
EnabledFlag(optional):
string
Title:
Enabled
Maximum Length:1
Indicates whether the contact type is active. If the value is Y, the contact type is active. -
EnablePermitAccess(optional):
string
Title:
Permit Access Enabled
Maximum Length:1
Indicates whether permit access is enabled for a contact type. -
LastUpdateDate(optional):
string(date-time)
The date and time when the contact type was last updated.
-
LastUpdatedBy(optional):
string
Maximum Length:
64
The user who last updated the contact type. -
links(optional):
array Items
Title:
Items
Link Relations
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.