Jump to

• Request
• Response
• Examples

Update a joint venture operational state

patch

/fscmRestApi/resources/11.13.18.05/jointVentureOperationalStates/{operationalStateId}

Request

Path Parameters

• operationalStateId(required): integer(int64)
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=

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

• operationalState: string
  Title: State

  The description of the operational state.
• operationalStateDFF: array operationalStateDFF
• reason: string
  Title: Reason

  The reason for the assigned operational state.
• reasonDetails: string
  Title: Reason Details

  Maximum Length: 240

  Additional text to describe the reason for the joint venture operational state.

{
    "type":"object",
    "properties":{
        "reason":{
            "title":"Reason",
            "type":"string",
            "description":"The reason for the assigned operational state.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "reasonLookupCode"
                ]
            }
        },
        "operationalStateDFF":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/jointVentureOperationalStates-operationalStateDFF-item-patch-request"
            },
            "x-cardinality":"1"
        },
        "operationalState":{
            "title":"State",
            "type":"string",
            "description":"The description of the operational state.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "operationalStateLookupCode"
                ]
            }
        },
        "reasonDetails":{
            "title":"Reason Details",
            "maxLength":"240",
            "type":"string",
            "description":"Additional text to describe the reason for the joint venture operational state.",
            "nullable":true
        }
    }
}

Nested Schema : operationalStateDFF

Type: array

Show Source

• Array of: object jointVentureOperationalStates-operationalStateDFF-item-patch-request

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/jointVentureOperationalStates-operationalStateDFF-item-patch-request"
    },
    "x-cardinality":"1"
}

Nested Schema : jointVentureOperationalStates-operationalStateDFF-item-patch-request

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Segment

  Maximum Length: 150

  Context Segment
• __FLEX_Context_DisplayValue: string
  Title: Context Segment

  Context Segment

{
    "type":"object",
    "properties":{
        "__FLEX_Context_DisplayValue":{
            "title":"Context Segment",
            "type":"string",
            "description":"Context Segment",
            "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":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        },
        "__FLEX_Context":{
            "title":"Context Segment",
            "maxLength":"150",
            "type":"string",
            "description":"Context Segment",
            "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":"LOV"
            },
            "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 : jointVentureOperationalStates-item-response

Type: object

Show Source

• createdBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the joint venture operational state.
• creationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date and time when the joint venture operational state was created.
• jointVenture: string
  Title: Joint Venture

  The name of the joint venture of the operational state.
• jointVentureDescription: string
  Title: Joint Venture Description

  Read Only: true

  Maximum Length: 240

  The description of the joint venture.
• lastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date and time when the joint venture operational state was last updated.
• lastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the joint venture operational state.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• operationalState: string
  Title: State

  The description of the operational state.
• operationalStateDFF: array operationalStateDFF
• operationalStateId: integer (int64)
  Title: Operational State ID

  Read Only: true

  The unique identifier of the joint venture operational state.
• primarySegment: string
  Title: Primary Segment

  Read Only: true

  The name of the account segment labeled as the primary segment in the chart of accounts instance associated with the joint venture.
• reason: string
  Title: Reason

  The reason for the assigned operational state.
• reasonDetails: string
  Title: Reason Details

  Maximum Length: 240

  Additional text to describe the reason for the joint venture operational state.
• reportedDate: string (date)
  Title: Reported Date

  The reported date of the operational state.
• segmentValue: string
  Title: Primary Segment Value

  Maximum Length: 25

  A valid value defined for the segment labeled as the primary segment within the chart of accounts instance associated with the joint venture.
• segmentValueDescription: string
  Title: Primary Segment Value Description

  Read Only: true

  The description of the primary segment value.

{
    "type":"object",
    "properties":{
        "lastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the joint venture operational state.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "reason":{
            "title":"Reason",
            "type":"string",
            "description":"The reason for the assigned operational state.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "reasonLookupCode"
                ]
            },
            "x-queryable":true
        },
        "lastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the joint venture operational state was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "primarySegment":{
            "title":"Primary Segment",
            "type":"string",
            "description":"The name of the account segment labeled as the primary segment in the chart of accounts instance associated with the joint venture.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "segmentValue":{
            "title":"Primary Segment Value",
            "maxLength":"25",
            "type":"string",
            "description":"A valid value defined for the segment labeled as the primary segment within the chart of accounts instance associated with the joint venture.",
            "nullable":true,
            "x-queryable":true
        },
        "creationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the joint venture operational state was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "reasonDetails":{
            "title":"Reason Details",
            "maxLength":"240",
            "type":"string",
            "description":"Additional text to describe the reason for the joint venture operational state.",
            "nullable":true,
            "x-queryable":true
        },
        "operationalStateDFF":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/jointVentureOperationalStates-operationalStateDFF-item-response"
            },
            "x-cardinality":"1"
        },
        "segmentValueDescription":{
            "title":"Primary Segment Value Description",
            "type":"string",
            "description":"The description of the primary segment value.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "jointVenture":{
            "title":"Joint Venture",
            "type":"string",
            "description":"The name of the joint venture of the operational state.",
            "nullable":true,
            "x-queryable":true
        },
        "createdBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the joint venture operational state.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "reportedDate":{
            "title":"Reported Date",
            "type":"string",
            "description":"The reported date of the operational state.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "operationalStateId":{
            "title":"Operational State ID",
            "type":"integer",
            "description":"The unique identifier of the joint venture operational state.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "jointVentureDescription":{
            "title":"Joint Venture Description",
            "maxLength":"240",
            "type":"string",
            "description":"The description of the joint venture.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "operationalState":{
            "title":"State",
            "type":"string",
            "description":"The description of the operational state.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "operationalStateLookupCode"
                ]
            },
            "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 : operationalStateDFF

Type: array

Show Source

• Array of: object jointVentureOperationalStates-operationalStateDFF-item-response

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/jointVentureOperationalStates-operationalStateDFF-item-response"
    },
    "x-cardinality":"1"
}

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."
        }
    }
}

Nested Schema : jointVentureOperationalStates-operationalStateDFF-item-response

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Segment

  Maximum Length: 150

  Context Segment
• __FLEX_Context_DisplayValue: string
  Title: Context Segment

  Context Segment
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• OperationalStateId: integer (int64)
  Title: Operational State ID

  Read Only: true

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "OperationalStateId":{
            "title":"Operational State ID",
            "type":"integer",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Segment",
            "type":"string",
            "description":"Context Segment",
            "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":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        },
        "__FLEX_Context":{
            "title":"Context Segment",
            "maxLength":"150",
            "type":"string",
            "description":"Context Segment",
            "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":"LOV"
            },
            "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"
    }
}

Links

operationalStateDFF

Operation: /fscmRestApi/resources/11.13.18.05/jointVentureOperationalStates/{operationalStateId}/child/operationalStateDFF

Parameters:

• operationalStateId: $request.path.operationalStateId

Back to Top

Examples

The following example shows how to update a joint venture operational state by submitting a PATCH request on the REST resource using cURL.

curl -i -u "username:password" -H "Content-type: application/json" -X PATCH -d <payload> "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentureOperationalStates/300100544742449"

Example Request Payload

The following example shows the contents of the request body in JSON format:

{
    "operationalState": "Maintenance",
    "reason": "Periodic Service",
    "reasonDetails": "Biweekly maintenance",
}

Example Response Body

The following example shows the contents of the response body in JSON format:

{
    "operationalStateId": 300100544742449,
    "jointVenture": "GREENCORP",
    "jointVentureDescription": "Green Corp. Solutions",
    "primarySegment": "HEPPCostcenter",
    "segmentValue": "1001",
    "segmentValueDescription": "Greater Prudhoe Cost Center",
    "reportedDate": "2021-08-11",
    "operationalState": "Maintenance",
    "reason": "Periodic Service",
    "reasonDetails": "Biweekly maintenance",
    "createdBy": "username",
    "creationDate": "2021-08-31T07:49:42+00:00",
    "lastUpdatedBy": "username",
    "lastUpdateDate": "2021-08-31T07:50:21+00:00",
    "links": [
        {
            "rel": "self",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentureOperationalStates/300100544742449",
            "name": "jointVentureOperationalStates",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
            }
        },
        {
            "rel": "canonical",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentureOperationalStates/300100544742449",
            "name": "jointVentureOperationalStates",
            "kind": "item"
        },
        {
            "rel": "child",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentureOperationalStates/300100544742449/child/operationalStateDFF",
            "name": "operationalStateDFF",
            "kind": "collection"
        }
    ]
}

Back to Top