Update a contract party
patch
/fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/ContractParty/{ContractPartyUniqID}
Request
Path Parameters
-
ContractPartyUniqID(required): string
This is the hash key of the attributes which make up the composite key--- Id and MajorVersion ---for the Contract Parties resource and used to uniquely identify an instance of Contract Parties. The client should not generate the hash key value. Instead, the client should query on the Contract Parties collection resource with a filter on the primary key values in order to navigate to a specific instance of Contract Parties.
For example: ContractParty?q=Id=<value1>;MajorVersion=<value2> -
contractsUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Contracts resource and used to uniquely identify an instance of Contracts. The client should not generate the hash key value. Instead, the client should query on the Contracts collection resource in order to navigate to a specific instance of Contracts to get the hash key.
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
ContractClass: string
Maximum Length:
80
The contract class. -
ContractPartyContact: array
Contract Party Contacts
Title:
Contract Party Contacts
The contract party contacts resource is used to view the details of contract party contact. A party contact of a contract is one who is responsible to follow up on the contractual obligations. -
ContractPartyFlexfieldVA: array
Contract Party Flexfields
Title:
Contract Party Flexfields
The contract party flex fields is used to view, create, update contract party flex field information. -
DeleteFlag: boolean
Default Value:
false
Delete Flag -
ExternalKey: string
Maximum Length:
120
The key identifier of the contract party in the external source system. -
ExternalSource: string
Maximum Length:
120
The name of external source system where the contract party is imported from. -
Id: integer
(int64)
The unique identifier of the contract party.
-
MajorVersion: integer
(int64)
Default Value:
1
The version of the contract party. -
PartyId: integer
(int64)
The unique identifier of the contract party.
-
PartyName: string
Title:
Name
The name of the contract party. -
PartyNameLOVSwitcher: string
The party name LOV switcher.
-
PartyRoleCode: string
Title:
Role
Maximum Length:30
The code that indicates the party role. -
Role: string
The name of the party role.
-
SignedBy: string
Title:
Signed By
Maximum Length:100
The party that signed the contract. -
SignedDate: string
(date)
Title:
Signed Date
The date on which the party signed the contract. -
SignerRole: string
Title:
Signer Role
Maximum Length:100
Signer Role
Nested Schema : Contract Party Contacts
Type:
array
Title:
Contract Party Contacts
The contract party contacts resource is used to view the details of contract party contact. A party contact of a contract is one who is responsible to follow up on the contractual obligations.
Show Source
Nested Schema : Contract Party Flexfields
Type:
array
Title:
Contract Party Flexfields
The contract party flex fields is used to view, create, update contract party flex field information.
Show Source
Nested Schema : schema
Type:
Show Source
object
-
AccessLevel: string
Title:
Access
Maximum Length:30
The access level of a contract party contact. -
AccessLevelName: string
The name of the access level of the contract party contact.
-
ContactId: integer
(int64)
The unique identifier of the contact.
-
ContactRoleCode: string
Title:
Role
Maximum Length:30
The code indicating the role of the contract party contact. -
ContractPartyContactFlexfieldVA: array
Contract Party Contact Flexfields
Title:
Contract Party Contact Flexfields
The contract party contact flex field resource is used to view, create, update contract party contact flex field information. -
EndDate: string
(date)
Title:
End Date
End Date -
ExternalKey: string
Maximum Length:
120
The key identifier of the contract party contact in the external source system. -
ExternalSource: string
Maximum Length:
120
The name of external source system where the contract party contact is imported from. -
Id: integer
(int64)
The unique identifier of the contract party contact.
-
MajorVersion: integer
(int64)
Default Value:
1
The version of the contract party contact. -
OwnerFlag: boolean
Title:
Owner
indicates whether the contact is the owner of the contract. -
PartyContactName: string
The name of the contract party contact.
-
Role: string
The role of the contract party contact.
-
RoutingSequence: number
Title:
Signing Sequence
Signing Sequence -
SignatureRole: string
Title:
Signature Role
Maximum Length:30
Signatory Role Code -
SignatureRoleMeaning: string
Signatory Role
-
SignerSequence: integer
Title:
Display Sequence
Singer Sequence -
StartDate: string
(date)
Title:
Start Date
Start Date
Nested Schema : Contract Party Contact Flexfields
Type:
array
Title:
Contract Party Contact Flexfields
The contract party contact flex field resource is used to view, create, update contract party contact flex field information.
Show Source
Nested Schema : contracts-ContractParty-ContractPartyContact-ContractPartyContactFlexfieldVA-item-patch-request
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:90
Descriptive Flexfield: structure definition of the user descriptive flexfield. -
__FLEX_Context_DisplayValue: string
Title:
Context Segment
-
Id: integer
(int64)
Contract Party Contact Flexfield ID
-
MajorVersion: integer
(int64)
Default Value:
1
Major Version
Nested Schema : schema
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:90
Descriptive Flexfield: structure definition of the user descriptive flexfield. -
__FLEX_Context_DisplayValue: string
Title:
Context Segment
-
Id: integer
(int64)
Contract Party Flexfield ID
-
MajorVersion: integer
(int64)
Default Value:
1
Major Version
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : contracts-ContractParty-item-response
Type:
Show Source
object
-
ContractClass: string
Maximum Length:
80
The contract class. -
ContractPartyContact: array
Contract Party Contacts
Title:
Contract Party Contacts
The contract party contacts resource is used to view the details of contract party contact. A party contact of a contract is one who is responsible to follow up on the contractual obligations. -
ContractPartyFlexfieldVA: array
Contract Party Flexfields
Title:
Contract Party Flexfields
The contract party flex fields is used to view, create, update contract party flex field information. -
DeleteFlag: boolean
Default Value:
false
Delete Flag -
ExternalKey: string
Maximum Length:
120
The key identifier of the contract party in the external source system. -
ExternalSource: string
Maximum Length:
120
The name of external source system where the contract party is imported from. -
HeaderStartDate: string
Read Only:
true
The header start date. -
Id: integer
(int64)
The unique identifier of the contract party.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MajorVersion: integer
(int64)
Default Value:
1
The version of the contract party. -
PartyId: integer
(int64)
The unique identifier of the contract party.
-
PartyName: string
Title:
Name
The name of the contract party. -
PartyNameLOVSwitcher: string
The party name LOV switcher.
-
PartyRoleCode: string
Title:
Role
Maximum Length:30
The code that indicates the party role. -
PartyRolePuid: string
Title:
Party Role PUID
Maximum Length:120
Party Role PUID -
Role: string
The name of the party role.
-
SignedBy: string
Title:
Signed By
Maximum Length:100
The party that signed the contract. -
SignedDate: string
(date)
Title:
Signed Date
The date on which the party signed the contract. -
SignerRole: string
Title:
Signer Role
Maximum Length:100
Signer Role
Nested Schema : Contract Party Contacts
Type:
array
Title:
Contract Party Contacts
The contract party contacts resource is used to view the details of contract party contact. A party contact of a contract is one who is responsible to follow up on the contractual obligations.
Show Source
Nested Schema : Contract Party Flexfields
Type:
array
Title:
Contract Party Flexfields
The contract party flex fields is used to view, create, update contract party flex field information.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : contracts-ContractParty-ContractPartyContact-item-response
Type:
Show Source
object
-
AccessLevel: string
Title:
Access
Maximum Length:30
The access level of a contract party contact. -
AccessLevelName: string
The name of the access level of the contract party contact.
-
ContactId: integer
(int64)
The unique identifier of the contact.
-
ContactPuid: string
Title:
Party Contact PUID
Maximum Length:120
Contact PUID -
ContactRoleCode: string
Title:
Role
Maximum Length:30
The code indicating the role of the contract party contact. -
ContractPartyContactFlexfieldVA: array
Contract Party Contact Flexfields
Title:
Contract Party Contact Flexfields
The contract party contact flex field resource is used to view, create, update contract party contact flex field information. -
EndDate: string
(date)
Title:
End Date
End Date -
ExternalKey: string
Maximum Length:
120
The key identifier of the contract party contact in the external source system. -
ExternalSource: string
Maximum Length:
120
The name of external source system where the contract party contact is imported from. -
Id: integer
(int64)
The unique identifier of the contract party contact.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MajorVersion: integer
(int64)
Default Value:
1
The version of the contract party contact. -
OwnerFlag: boolean
Title:
Owner
indicates whether the contact is the owner of the contract. -
PartyContactName: string
The name of the contract party contact.
-
Role: string
The role of the contract party contact.
-
RoutingSequence: number
Title:
Signing Sequence
Signing Sequence -
SignatureRole: string
Title:
Signature Role
Maximum Length:30
Signatory Role Code -
SignatureRoleMeaning: string
Signatory Role
-
SignerSequence: integer
Title:
Display Sequence
Singer Sequence -
StartDate: string
(date)
Title:
Start Date
Start Date
Nested Schema : Contract Party Contact Flexfields
Type:
array
Title:
Contract Party Contact Flexfields
The contract party contact flex field resource is used to view, create, update contract party contact flex field information.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : contracts-ContractParty-ContractPartyContact-ContractPartyContactFlexfieldVA-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:90
Descriptive Flexfield: structure definition of the user descriptive flexfield. -
__FLEX_Context_DisplayValue: string
Title:
Context Segment
-
Id: integer
(int64)
Contract Party Contact Flexfield ID
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MajorVersion: integer
(int64)
Default Value:
1
Major Version
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : contracts-ContractParty-ContractPartyFlexfieldVA-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:90
Descriptive Flexfield: structure definition of the user descriptive flexfield. -
__FLEX_Context_DisplayValue: string
Title:
Context Segment
-
Id: integer
(int64)
Contract Party Flexfield ID
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MajorVersion: integer
(int64)
Default Value:
1
Major Version
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- ContractPartyContact
-
Parameters:
- ContractPartyUniqID:
$request.path.ContractPartyUniqID
- contractsUniqID:
$request.path.contractsUniqID
The contract party contacts resource is used to view the details of contract party contact. A party contact of a contract is one who is responsible to follow up on the contractual obligations. - ContractPartyUniqID:
- ContractPartyFlexfieldVA
-
Parameters:
- ContractPartyUniqID:
$request.path.ContractPartyUniqID
- contractsUniqID:
$request.path.contractsUniqID
The contract party flex fields is used to view, create, update contract party flex field information. - ContractPartyUniqID: