Jump to

• Request
• Response

Update a contract party contact flexfield

patch

/fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/ContractParty/{ContractPartyUniqID}/child/ContractPartyContact/{ContractPartyContactUniqID}/child/ContractPartyContactFlexfieldVA/{ContractPartyContactFlexfieldVAUniqID}

Request

Path Parameters

• ContractPartyContactFlexfieldVAUniqID(required): string
  This is the hash key of the attributes which make up the composite key--- Id and MajorVersion ---for the Contract Party Contact Flexfields resource and used to uniquely identify an instance of Contract Party Contact Flexfields. The client should not generate the hash key value. Instead, the client should query on the Contract Party Contact Flexfields collection resource with a filter on the primary key values in order to navigate to a specific instance of Contract Party Contact Flexfields.
  
  For example: ContractPartyContactFlexfieldVA?q=Id=<value1>;MajorVersion=<value2>
• ContractPartyContactUniqID(required): string
  This is the hash key of the attributes which make up the composite key--- Id and MajorVersion ---for the Contract Party Contacts resource and used to uniquely identify an instance of Contract Party Contacts. The client should not generate the hash key value. Instead, the client should query on the Contract Party Contacts collection resource with a filter on the primary key values in order to navigate to a specific instance of Contract Party Contacts.
  
  For example: ContractPartyContact?q=Id=<value1>;MajorVersion=<value2>
• 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

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• __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

{
    "type":"object",
    "properties":{
        "MajorVersion":{
            "type":"integer",
            "description":"Major Version",
            "format":"int64",
            "nullable":false,
            "default":1,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":18
            }
        },
        "Id":{
            "type":"integer",
            "description":"Contract Party Contact Flexfield ID",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":18
            }
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Segment",
            "type":"string",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "DISPLAYHINT":"Hide",
                "FND_ACFF_IsReadOnly":"true",
                "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Name",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        },
        "__FLEX_Context":{
            "title":"Context Segment",
            "maxLength":90,
            "type":"string",
            "description":"Descriptive Flexfield: structure definition of the user descriptive flexfield.",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_IsDiscriminator":"true",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        }
    }
}

Back to Top

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.

Body ()

Root Schema : contracts-ContractParty-ContractPartyContact-ContractPartyContactFlexfieldVA-item-response

Type: object

Show Source

• __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

{
    "type":"object",
    "properties":{
        "MajorVersion":{
            "type":"integer",
            "description":"Major Version",
            "format":"int64",
            "nullable":false,
            "default":1,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "Id":{
            "type":"integer",
            "description":"Contract Party Contact Flexfield ID",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Segment",
            "type":"string",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "DISPLAYHINT":"Hide",
                "FND_ACFF_IsReadOnly":"true",
                "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Name",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        },
        "__FLEX_Context":{
            "title":"Context Segment",
            "maxLength":90,
            "type":"string",
            "description":"Descriptive Flexfield: structure definition of the user descriptive flexfield.",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_IsDiscriminator":"true",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Links

LVVO_V___FLEX_Context

Operation: /fscmRestApi/resources/11.13.18.05/FlexFndDffDescriptiveFlexfieldContexts

Parameters:

• finder: ValidValuesFinder%3BBind_ApplicationId%3D510%2CBind_DescriptiveFlexfieldCode%3DContractPartyContactFlexfield

The following properties are defined on the LOV link relation:

• Source Attribute: __FLEX_Context_DisplayValue; Target Attribute: Name
• Display Attribute: Name, Description

LVVO___FLEX_Context

Operation: /fscmRestApi/resources/11.13.18.05/FlexFndDffDescriptiveFlexfieldContexts

Parameters:

• finder: ValidValuesFinder%3BBind_ApplicationId%3D510%2CBind_DescriptiveFlexfieldCode%3DContractPartyContactFlexfield

The following properties are defined on the LOV link relation:

• Source Attribute: __FLEX_Context; Target Attribute: ContextCode
• Display Attribute: Name

Back to Top