Create a set of delegate information
post
/fscmRestApi/resources/11.13.18.05/publicSectorDelegates
Create a set of delegate information
Request
Supported Media Types
- application/vnd.oracle.adf.resourceitem+json
- application/json
The following table describes the body parameters in the request for this task.
Root Schema : publicSectorDelegates-item
Type:
Show Source
object
-
CreatedBy(optional):
string
Maximum Length:
64
The user who initiated the delegation. -
CreationDate(optional):
string(date-time)
The date and time that the delegation was initiated.
-
DelegateContactId(optional):
integer(int64)
Contact ID of the delegate as a contact.
-
DelegateDetail(optional):
array Delegate Details
Title:
Delegate Details
The delegates resource is used to view, create, delete or modify delegate information for registered public users. -
DelegateEmailId(optional):
string
Title:
Delegate Email
Maximum Length:100
The email of a delegate user. -
DelegateHeaderId(optional):
integer(int64)
The unique identifier of a delegation.
-
DelegateHistory(optional):
array Delegate Histories
Title:
Delegate Histories
The delegates resource is used to view, create, delete or modify delegate information for registered public users. -
DelegatePartyId(optional):
integer(int64)
The party ID for the delegate user.
-
DelegatePersonFirstName(optional):
string
Title:
Delegate First Name
The first name of a delegate user. -
DelegatePersonLastName(optional):
string
Title:
Delegate Last Name
The last name of a delegate user. -
DelegatePhoneAreaCode(optional):
string
Title:
Delegate Phone Area Code
The phone area code of a delegate user. -
DelegatePhoneCountryCode(optional):
string
Title:
Delegate Phone Country Code
The phone country code of a delegate user. -
DelegatePhoneExtension(optional):
string
Title:
Delegate Phone Extension
The phone extension of a delegate user. -
DelegatePhoneNumber(optional):
string
Title:
Delegate Phone Number
The phone number of a delegate user. -
DelegatePreferredContactMethod(optional):
string
The delegate user's preferred way of receiving communication. The value is ORA_TEXT for text or blank for email.
-
DelegateProfileId(optional):
integer(int64)
The account profile ID of a delegate user.
-
DelegateProfileName(optional):
string
Delegate user's account profile name.
-
DelegatePscUserId(optional):
integer(int64)
The unique identifier of a delegate as a registered public user.
-
DelegateUserGuid(optional):
string
Maximum Length:
64
The unique user GUID of a delegate user. -
DelegateUserId(optional):
integer(int64)
The unique Fusion user ID for the delegate user.
-
DelegateUserName(optional):
string
Title:
Delegate User Name
The user name that a delegate uses to sign into the system. -
DelegationStatus(optional):
string
Title:
Status
Maximum Length:30
The status of the delegation request.
Valid values are ORA_PR (Privileges Required), ORA_INS (Invitation Not Sent), ORA_IS (Invitation Sent), ORA_ID (Invitation Declined), ORA_RNS (Request not Sent), ORA_RS (Request Sent), ORA_RD (Request Declined), ORA_ACTIVE (Active), and ORA_DS (Disabled). -
DelegationType(optional):
string
Title:
Delegation Type
Maximum Length:30
The delegation type. The value ORA_PROFILE indicates that the delegation is for all transactions of a profile. The value ORA_TRANSACTION indicates that the delegation is for individual transactions. -
EmailSuppress(optional):
string
Title:
Suppress Email
Maximum Length:1
Status indicating whether email notifications sent to the transaction owner for delegate actions are suppressed. Valid values are Y and N. -
LastUpdateDate(optional):
string(date-time)
The date and time that the delegation was last updated.
-
LastUpdatedBy(optional):
string
Maximum Length:
64
The user who last updated the delegation information. -
LastUpdateLogin(optional):
string
Maximum Length:
32
The session login associated with the user who last updated the delegation information. -
links(optional):
array Items
Title:
Items
Link Relations -
PrivilegeType(optional):
string
Title:
Privilege Type
Maximum Length:30
The delegation privilege type. ORA_MANAGE indicates that the delegate can manage transactions. ORA_VIEWONLY indicates that the delegate has read-only access to transactions. -
PtoEmailId(optional):
string
Title:
Profile or Transaction Owner Email
Maximum Length:100
Email of the profile or transaction owner. -
PtoPartyId(optional):
integer(int64)
The party ID of the profile or transaction owner.
-
PtoPersonFirstName(optional):
string
Title:
Profile or Transaction Owner First Name
The first name of the profile or transaction owner. -
PtoPersonLastName(optional):
string
Title:
Profile or Transaction Owner Last Name
The last name of the profile or transaction owner. -
PtoPersonMiddleName(optional):
string
Title:
Profile or Transaction Owner Middle Name
The middle name of the profile or transaction owner. -
PtoPersonName(optional):
string
Title:
Profile or Transaction Owner Name
The name of the profile or transaction owner. -
PtoPhoneAreaCode(optional):
string
Title:
Profile or Transaction Owner Phone Area Code
The phone area code of the profile or transaction owner. -
PtoPhoneCountryCode(optional):
string
Title:
Profile or Transaction Owner Phone Country Code
The phone country code of the profile or transaction owner. -
PtoPhoneExtension(optional):
string
Title:
Profile or Transaction Owner Phone Extension
The phone extension of the profile or transaction owner. -
PtoPhoneNumber(optional):
string
Title:
Profile or Transaction Owner Phone Number
The phone number of the profile or transaction owner. -
PtoPreferredContactMethod(optional):
string
The profile or transaction owner's preferred way of receiving communication. The value is ORA_TEXT for text, or blank for email.
-
PtoProfileId(optional):
integer(int64)
The account profile ID of the profile or transaction owner.
-
PtoProfileName(optional):
string
Profile or transaction owner's account profile name.
-
PtoPscUserId(optional):
integer(int64)
The unique identifier for a transaction owner as a registered public user.
-
PtoUserGuid(optional):
string
Maximum Length:
64
The unique user GUID for a delegate user. -
PtoUserId(optional):
integer(int64)
The unique Fusion user ID for the profile or transaction owner.
-
PtoUserName(optional):
string
Title:
Profile or Transaction Owner User Name
The user name of the profile or transaction owner. -
RequestType(optional):
string
Maximum Length:
30
Delegation request type. The value ORA_INVITE represents an invitation from the owner of a profile or transaction. The value ORA_REQUEST indicates that this is a request from a prospective delegate. -
StatusChangeDate(optional):
string(date)
Date of the most recent delegation status change.
-
ToDelegationStatus(optional):
string
Maximum Length:
30
A status indicating if a delegation change request is pending. The value is ORA_NR for a pending change request, or blank when there is no pending change request. -
ToDelegationType(optional):
string
Title:
Change Delegation To
Maximum Length:30
The target delegation type for a delegation change request. The value ORA_PROFILE indicates that the delegation is for all transactions for a profile. The value ORA_TRANSACTION indicates that the delegation is for individual transactions. -
ToPrivilegeType(optional):
string
Maximum Length:
30
The target privilege type for a delegation change request. ORA_MANAGE indicates that the delegate can manage transactions. ORA_VIEWONLY indicates that the delegate has read-only access to transactions.
Nested Schema : Delegate Details
Type:
array
Title:
Delegate Details
The delegates resource is used to view, create, delete or modify delegate information for registered public users.
Show Source
Nested Schema : Delegate Histories
Type:
array
Title:
Delegate Histories
The delegates resource is used to view, create, delete or modify delegate information for registered public users.
Show Source
Nested Schema : publicSectorDelegates-DelegateDetail-item
Type:
Show Source
object
-
CreatedBy(optional):
string
Maximum Length:
64
The user who initiated the transaction delegation. -
CreationDate(optional):
string(date-time)
The date and time that the transaction delegation was initiated.
-
DelegateDetailId(optional):
integer(int64)
The unique identifier of a delegation detail record.
-
DelegateHeaderId(optional):
integer(int64)
The Delegation Header ID from the Delegation Header table.
-
LastUpdateDate(optional):
string(date-time)
The date and time that the transaction delegation was last updated.
-
LastUpdatedBy(optional):
string
Maximum Length:
64
The user who last updated the transaction delegation information. -
LastUpdateLogin(optional):
string
Maximum Length:
32
The session login associated with the user who last updated transaction delegation information. -
links(optional):
array Items
Title:
Items
Link Relations -
PrivilegeType(optional):
string
Maximum Length:
30
The privilege type. ORA_MANAGE indicates that the delegate can manage transactions. ORA_VIEWONLY indicates that the delegate has read-only access to transactions. -
PtoObjectId(optional):
string
Maximum Length:
50
The unique identifier of a permit or planning and zoning transaction. -
PtoObjectKey(optional):
integer(int64)
The unique key of a permit or planning and zoning transaction.
-
PtoObjectType(optional):
string
Title:
Transaction Type
Maximum Length:30
The type of object to which access is delegated, indicating if delegation is for permits or for planning and zoning. Valid values are ORA_PERMIT and ORA_PZ. -
Status(optional):
string
Title:
Status
Maximum Length:30
The delegation status for the transaction. Valid values are ORA_ACTIVE, ORA_INACTIVE, and ORA_NR. -
ToPrivilegeType(optional):
string
Title:
Change Privilege To
Maximum Length:30
The target privilege type for a change request. ORA_MANAGE indicates that the delegate can manage transactions. ORA_VIEWONLY indicates that the delegate has read-only access to transactions.
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.
Nested Schema : publicSectorDelegates-DelegateHistory-item
Type:
Show Source
object
-
AttributeChanged(optional):
string
Maximum Length:
30
The attribute that was changed. The value is ORA_DSTATUS for a change in delegation status. -
ChangeAction(optional):
string
Maximum Length:
30
The action that created the change. Valid values are ACCEPTED and DECLINED. -
ChangeDate(optional):
string(date-time)
The date and time when a change was made to a delegation's status.
-
CreatedBy(optional):
string
Maximum Length:
64
The user who initiated a delegation change request. -
CreationDate(optional):
string(date-time)
The date and time that the delegation was created.
-
DelegateDetailId(optional):
integer(int64)
The delegation detail ID from the delegation detail table.
-
DelegateHeaderId(optional):
integer(int64)
The Delegation Header ID from the Delegation Header table.
-
DelegateHistoryId(optional):
integer(int64)
The unique identifier for a delegation history record.
-
LastUpdateDate(optional):
string(date-time)
The date and time that the delegation was last updated.
-
LastUpdatedBy(optional):
string
Maximum Length:
64
The user who last updated the transaction delegation information. -
LastUpdateLogin(optional):
string
Maximum Length:
32
The session login associated with the user who last updated delegation information. -
links(optional):
array Items
Title:
Items
Link Relations -
NewValue(optional):
string
Maximum Length:
30
The new value of the attribute that was changed. -
PreviousValue(optional):
string
Maximum Length:
30
The previous value for the attribute that was changed. -
StatusUpdatedByGuid(optional):
string
Maximum Length:
64
The user GUID of the user whose action changed the status.
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 : publicSectorDelegates-item
Type:
Show Source
object
-
CreatedBy(optional):
string
Maximum Length:
64
The user who initiated the delegation. -
CreationDate(optional):
string(date-time)
The date and time that the delegation was initiated.
-
DelegateContactId(optional):
integer(int64)
Contact ID of the delegate as a contact.
-
DelegateDetail(optional):
array Delegate Details
Title:
Delegate Details
The delegates resource is used to view, create, delete or modify delegate information for registered public users. -
DelegateEmailId(optional):
string
Title:
Delegate Email
Maximum Length:100
The email of a delegate user. -
DelegateHeaderId(optional):
integer(int64)
The unique identifier of a delegation.
-
DelegateHistory(optional):
array Delegate Histories
Title:
Delegate Histories
The delegates resource is used to view, create, delete or modify delegate information for registered public users. -
DelegatePartyId(optional):
integer(int64)
The party ID for the delegate user.
-
DelegatePersonFirstName(optional):
string
Title:
Delegate First Name
The first name of a delegate user. -
DelegatePersonLastName(optional):
string
Title:
Delegate Last Name
The last name of a delegate user. -
DelegatePhoneAreaCode(optional):
string
Title:
Delegate Phone Area Code
The phone area code of a delegate user. -
DelegatePhoneCountryCode(optional):
string
Title:
Delegate Phone Country Code
The phone country code of a delegate user. -
DelegatePhoneExtension(optional):
string
Title:
Delegate Phone Extension
The phone extension of a delegate user. -
DelegatePhoneNumber(optional):
string
Title:
Delegate Phone Number
The phone number of a delegate user. -
DelegatePreferredContactMethod(optional):
string
The delegate user's preferred way of receiving communication. The value is ORA_TEXT for text or blank for email.
-
DelegateProfileId(optional):
integer(int64)
The account profile ID of a delegate user.
-
DelegateProfileName(optional):
string
Delegate user's account profile name.
-
DelegatePscUserId(optional):
integer(int64)
The unique identifier of a delegate as a registered public user.
-
DelegateUserGuid(optional):
string
Maximum Length:
64
The unique user GUID of a delegate user. -
DelegateUserId(optional):
integer(int64)
The unique Fusion user ID for the delegate user.
-
DelegateUserName(optional):
string
Title:
Delegate User Name
The user name that a delegate uses to sign into the system. -
DelegationStatus(optional):
string
Title:
Status
Maximum Length:30
The status of the delegation request.
Valid values are ORA_PR (Privileges Required), ORA_INS (Invitation Not Sent), ORA_IS (Invitation Sent), ORA_ID (Invitation Declined), ORA_RNS (Request not Sent), ORA_RS (Request Sent), ORA_RD (Request Declined), ORA_ACTIVE (Active), and ORA_DS (Disabled). -
DelegationType(optional):
string
Title:
Delegation Type
Maximum Length:30
The delegation type. The value ORA_PROFILE indicates that the delegation is for all transactions of a profile. The value ORA_TRANSACTION indicates that the delegation is for individual transactions. -
EmailSuppress(optional):
string
Title:
Suppress Email
Maximum Length:1
Status indicating whether email notifications sent to the transaction owner for delegate actions are suppressed. Valid values are Y and N. -
LastUpdateDate(optional):
string(date-time)
The date and time that the delegation was last updated.
-
LastUpdatedBy(optional):
string
Maximum Length:
64
The user who last updated the delegation information. -
LastUpdateLogin(optional):
string
Maximum Length:
32
The session login associated with the user who last updated the delegation information. -
links(optional):
array Items
Title:
Items
Link Relations -
PrivilegeType(optional):
string
Title:
Privilege Type
Maximum Length:30
The delegation privilege type. ORA_MANAGE indicates that the delegate can manage transactions. ORA_VIEWONLY indicates that the delegate has read-only access to transactions. -
PtoEmailId(optional):
string
Title:
Profile or Transaction Owner Email
Maximum Length:100
Email of the profile or transaction owner. -
PtoPartyId(optional):
integer(int64)
The party ID of the profile or transaction owner.
-
PtoPersonFirstName(optional):
string
Title:
Profile or Transaction Owner First Name
The first name of the profile or transaction owner. -
PtoPersonLastName(optional):
string
Title:
Profile or Transaction Owner Last Name
The last name of the profile or transaction owner. -
PtoPersonMiddleName(optional):
string
Title:
Profile or Transaction Owner Middle Name
The middle name of the profile or transaction owner. -
PtoPersonName(optional):
string
Title:
Profile or Transaction Owner Name
The name of the profile or transaction owner. -
PtoPhoneAreaCode(optional):
string
Title:
Profile or Transaction Owner Phone Area Code
The phone area code of the profile or transaction owner. -
PtoPhoneCountryCode(optional):
string
Title:
Profile or Transaction Owner Phone Country Code
The phone country code of the profile or transaction owner. -
PtoPhoneExtension(optional):
string
Title:
Profile or Transaction Owner Phone Extension
The phone extension of the profile or transaction owner. -
PtoPhoneNumber(optional):
string
Title:
Profile or Transaction Owner Phone Number
The phone number of the profile or transaction owner. -
PtoPreferredContactMethod(optional):
string
The profile or transaction owner's preferred way of receiving communication. The value is ORA_TEXT for text, or blank for email.
-
PtoProfileId(optional):
integer(int64)
The account profile ID of the profile or transaction owner.
-
PtoProfileName(optional):
string
Profile or transaction owner's account profile name.
-
PtoPscUserId(optional):
integer(int64)
The unique identifier for a transaction owner as a registered public user.
-
PtoUserGuid(optional):
string
Maximum Length:
64
The unique user GUID for a delegate user. -
PtoUserId(optional):
integer(int64)
The unique Fusion user ID for the profile or transaction owner.
-
PtoUserName(optional):
string
Title:
Profile or Transaction Owner User Name
The user name of the profile or transaction owner. -
RequestType(optional):
string
Maximum Length:
30
Delegation request type. The value ORA_INVITE represents an invitation from the owner of a profile or transaction. The value ORA_REQUEST indicates that this is a request from a prospective delegate. -
StatusChangeDate(optional):
string(date)
Date of the most recent delegation status change.
-
ToDelegationStatus(optional):
string
Maximum Length:
30
A status indicating if a delegation change request is pending. The value is ORA_NR for a pending change request, or blank when there is no pending change request. -
ToDelegationType(optional):
string
Title:
Change Delegation To
Maximum Length:30
The target delegation type for a delegation change request. The value ORA_PROFILE indicates that the delegation is for all transactions for a profile. The value ORA_TRANSACTION indicates that the delegation is for individual transactions. -
ToPrivilegeType(optional):
string
Maximum Length:
30
The target privilege type for a delegation change request. ORA_MANAGE indicates that the delegate can manage transactions. ORA_VIEWONLY indicates that the delegate has read-only access to transactions.
Nested Schema : Delegate Details
Type:
array
Title:
Delegate Details
The delegates resource is used to view, create, delete or modify delegate information for registered public users.
Show Source
Nested Schema : Delegate Histories
Type:
array
Title:
Delegate Histories
The delegates resource is used to view, create, delete or modify delegate information for registered public users.
Show Source
Nested Schema : publicSectorDelegates-DelegateDetail-item
Type:
Show Source
object
-
CreatedBy(optional):
string
Maximum Length:
64
The user who initiated the transaction delegation. -
CreationDate(optional):
string(date-time)
The date and time that the transaction delegation was initiated.
-
DelegateDetailId(optional):
integer(int64)
The unique identifier of a delegation detail record.
-
DelegateHeaderId(optional):
integer(int64)
The Delegation Header ID from the Delegation Header table.
-
LastUpdateDate(optional):
string(date-time)
The date and time that the transaction delegation was last updated.
-
LastUpdatedBy(optional):
string
Maximum Length:
64
The user who last updated the transaction delegation information. -
LastUpdateLogin(optional):
string
Maximum Length:
32
The session login associated with the user who last updated transaction delegation information. -
links(optional):
array Items
Title:
Items
Link Relations -
PrivilegeType(optional):
string
Maximum Length:
30
The privilege type. ORA_MANAGE indicates that the delegate can manage transactions. ORA_VIEWONLY indicates that the delegate has read-only access to transactions. -
PtoObjectId(optional):
string
Maximum Length:
50
The unique identifier of a permit or planning and zoning transaction. -
PtoObjectKey(optional):
integer(int64)
The unique key of a permit or planning and zoning transaction.
-
PtoObjectType(optional):
string
Title:
Transaction Type
Maximum Length:30
The type of object to which access is delegated, indicating if delegation is for permits or for planning and zoning. Valid values are ORA_PERMIT and ORA_PZ. -
Status(optional):
string
Title:
Status
Maximum Length:30
The delegation status for the transaction. Valid values are ORA_ACTIVE, ORA_INACTIVE, and ORA_NR. -
ToPrivilegeType(optional):
string
Title:
Change Privilege To
Maximum Length:30
The target privilege type for a change request. ORA_MANAGE indicates that the delegate can manage transactions. ORA_VIEWONLY indicates that the delegate has read-only access to transactions.
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.
Nested Schema : publicSectorDelegates-DelegateHistory-item
Type:
Show Source
object
-
AttributeChanged(optional):
string
Maximum Length:
30
The attribute that was changed. The value is ORA_DSTATUS for a change in delegation status. -
ChangeAction(optional):
string
Maximum Length:
30
The action that created the change. Valid values are ACCEPTED and DECLINED. -
ChangeDate(optional):
string(date-time)
The date and time when a change was made to a delegation's status.
-
CreatedBy(optional):
string
Maximum Length:
64
The user who initiated a delegation change request. -
CreationDate(optional):
string(date-time)
The date and time that the delegation was created.
-
DelegateDetailId(optional):
integer(int64)
The delegation detail ID from the delegation detail table.
-
DelegateHeaderId(optional):
integer(int64)
The Delegation Header ID from the Delegation Header table.
-
DelegateHistoryId(optional):
integer(int64)
The unique identifier for a delegation history record.
-
LastUpdateDate(optional):
string(date-time)
The date and time that the delegation was last updated.
-
LastUpdatedBy(optional):
string
Maximum Length:
64
The user who last updated the transaction delegation information. -
LastUpdateLogin(optional):
string
Maximum Length:
32
The session login associated with the user who last updated delegation information. -
links(optional):
array Items
Title:
Items
Link Relations -
NewValue(optional):
string
Maximum Length:
30
The new value of the attribute that was changed. -
PreviousValue(optional):
string
Maximum Length:
30
The previous value for the attribute that was changed. -
StatusUpdatedByGuid(optional):
string
Maximum Length:
64
The user GUID of the user whose action changed the status.