Jump to

• Request
• Response
• Examples

Update a project value set

patch

/fscmRestApi/resources/11.13.18.05/jointVentureAssignmentRules/{assignmentRuleId}/child/projectValueSets/{projectValueSetId}

Request

Path Parameters

• assignmentRuleId(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=
• projectValueSetId(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: string
  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: string
  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

• expenditureType: string
  Title: Expenditure Type

  Maximum Length: 240

  The name of the expenditure type.
• project: string
  Title: Project Number

  Maximum Length: 25

  The number of the project.
• projectValueSetDFF: array projectValueSetDFF
• task: string
  Title: Task Number

  Maximum Length: 100

  The number of the task.

{
    "type":"object",
    "properties":{
        "expenditureType":{
            "title":"Expenditure Type",
            "maxLength":240,
            "type":"string",
            "description":"The name of the expenditure type.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "project":{
            "title":"Project Number",
            "maxLength":25,
            "type":"string",
            "description":"The number of the project.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "projectValueSetDFF":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/jointVentureAssignmentRules-projectValueSets-projectValueSetDFF-item-patch-request"
            },
            "x-cardinality":"1"
        },
        "task":{
            "title":"Task Number",
            "maxLength":100,
            "type":"string",
            "description":"The number of the task.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        }
    }
}

Nested Schema : projectValueSetDFF

Type: array

Show Source

• Array of: object jointVentureAssignmentRules-projectValueSets-projectValueSetDFF-item-patch-request

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

Nested Schema : jointVentureAssignmentRules-projectValueSets-projectValueSetDFF-item-patch-request

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Segment

  Maximum Length: 30

  Context Segment
• __FLEX_Context_DisplayValue: string
  Title: Context Segment

  Context Segment
• ProjectValueSetId: integer (int64)
  Title: Project Value Set ID

{
    "type":"object",
    "properties":{
        "ProjectValueSetId":{
            "title":"Project Value Set ID",
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "__FLEX_Context":{
            "title":"Context Segment",
            "maxLength":30,
            "type":"string",
            "description":"Context Segment",
            "nullable":true,
            "x-hints":{
                "help":{
                    "instruction":"Context Segment"
                },
                "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"
                }
            }
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Segment",
            "type":"string",
            "description":"Context Segment",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "help":{
                    "instruction":"Context Segment"
                },
                "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"
                }
            }
        }
    }
}

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 : jointVentureAssignmentRules-projectValueSets-item-response

Type: object

Show Source

• createdBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the resource item.
• creationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date and time when the resource item was created.
• expenditureType: string
  Title: Expenditure Type

  Maximum Length: 240

  The name of the expenditure type.
• expenditureTypeDescription: string
  Title: Expenditure Type Description

  Read Only: true

  Maximum Length: 2000

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

  Read Only: true

  The date and time when the resource item was last updated.
• lastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the resource item.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• project: string
  Title: Project Number

  Maximum Length: 25

  The number of the project.
• projectName: string
  Title: Project Name

  Read Only: true

  Maximum Length: 240

  The name of the project.
• projectValueSetDFF: array projectValueSetDFF
• projectValueSetId: integer (int64)
  Title: Project Value Set ID

  Read Only: true

  The unique identifier of the project value set.
• task: string
  Title: Task Number

  Maximum Length: 100

  The number of the task.
• taskName: string
  Title: Task Name

  Read Only: true

  Maximum Length: 255

  The name of the task.

{
    "type":"object",
    "properties":{
        "createdBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the resource item.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "creationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the resource item was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "expenditureType":{
            "title":"Expenditure Type",
            "maxLength":240,
            "type":"string",
            "description":"The name of the expenditure type.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "expenditureTypeDescription":{
            "title":"Expenditure Type Description",
            "maxLength":2000,
            "type":"string",
            "description":"The description of the expenditure type.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "lastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the resource item was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "lastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the resource item.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "project":{
            "title":"Project Number",
            "maxLength":25,
            "type":"string",
            "description":"The number of the project.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "projectName":{
            "title":"Project Name",
            "maxLength":240,
            "type":"string",
            "description":"The name of the project.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "projectValueSetDFF":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/jointVentureAssignmentRules-projectValueSets-projectValueSetDFF-item-response"
            },
            "x-cardinality":"1"
        },
        "projectValueSetId":{
            "title":"Project Value Set ID",
            "type":"integer",
            "description":"The unique identifier of the project value set.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "task":{
            "title":"Task Number",
            "maxLength":100,
            "type":"string",
            "description":"The number of the task.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "taskName":{
            "title":"Task Name",
            "maxLength":255,
            "type":"string",
            "description":"The name of the task.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "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 : projectValueSetDFF

Type: array

Show Source

• Array of: object jointVentureAssignmentRules-projectValueSets-projectValueSetDFF-item-response

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/jointVentureAssignmentRules-projectValueSets-projectValueSetDFF-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 : jointVentureAssignmentRules-projectValueSets-projectValueSetDFF-item-response

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Segment

  Maximum Length: 30

  Context Segment
• __FLEX_Context_DisplayValue: string
  Title: Context Segment

  Context Segment
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ProjectValueSetId: integer (int64)
  Title: Project Value Set ID

{
    "type":"object",
    "properties":{
        "ProjectValueSetId":{
            "title":"Project Value Set ID",
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "__FLEX_Context":{
            "title":"Context Segment",
            "maxLength":30,
            "type":"string",
            "description":"Context Segment",
            "nullable":true,
            "x-hints":{
                "help":{
                    "instruction":"Context Segment"
                },
                "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
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Segment",
            "type":"string",
            "description":"Context Segment",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "help":{
                    "instruction":"Context Segment"
                },
                "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
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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

projectValueSetDFF

Operation: /fscmRestApi/resources/11.13.18.05/jointVentureAssignmentRules/{assignmentRuleId}/child/projectValueSets/{projectValueSetId}/child/projectValueSetDFF

Parameters:

• assignmentRuleId: $request.path.assignmentRuleId
• projectValueSetId: $request.path.projectValueSetId

Back to Top

Examples

The following example shows how to update a project value set 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/jointVentureAssignmentRules/300100549966522/child/projectValueSets/300100549966527"

Example Request Body

The following shows an example of the request body in JSON format.

{
   "projectValueSetId":300100549966527,
   "expenditureType":"PJI",
   "project":null,
   "task":null
}

Example Response Body

The following shows an example of the response body in JSON format.

{
   "projectValueSetId":300100549966527,
   "project":null,
   "task":null,
   "expenditureType":"PJI",
   "createdBy":"username",
   "creationDate":"2022-03-07T08:12:08+00:00",
   "lastUpdatedBy":"username",
   "lastUpdateDate":"2022-03-07T08:16:01+00:00",
   "projectName":null,
   "taskName":null,
   "expenditureTypeDescription":"Use for loading Costs for PJI Portals",
   "links":[
      {
         "rel":"self",
         "href":"https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentureAssignmentRules/300100549966522/child/projectValueSets/300100549966527",
         "name":"projectValueSets",
         "kind":"item",
         "properties":{
            "changeIndicator":"ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
         }
      },
      {
         "rel":"canonical",
         "href":"https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentureAssignmentRules/300100549966522/child/projectValueSets/300100549966527",
         "name":"projectValueSets",
         "kind":"item"
      },
      {
         "rel":"parent",
         "href":"https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentureAssignmentRules/300100549966522",
         "name":"jointVentureAssignmentRules",
         "kind":"item"
      },
      {
         "rel":"child",
         "href":"https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentureAssignmentRules/300100549966522/child/projectValueSets/300100549966527/child/projectValueSetDFF",
         "name":"projectValueSetDFF",
         "kind":"collection"
      }
   ]
}

Back to Top