Jump to

• Request
• Response

Update

patch

/fscmRestApi/resources/11.13.18.05/itemStructures/{BillSequenceId}/child/Component/{ComponentSequenceId}/child/ReferenceDesignator/{ReferenceDesignatorSequenceId}

Request

Path Parameters

• BillSequenceId(required): integer
  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=
• ComponentSequenceId(required): number
  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=
• ReferenceDesignatorSequenceId(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

• ACDType: integer
  Default Value: 1

  Read Only: This attribute specifies the acdType code which defines whether the reference designator is being added, modified or deleted through a change line
• ChangeLineId: integer (int64)
  Default Value: -1

  Read Only: This attribute provides the revised line the reference designator is added/modified
• ChangeNotice: string
  Maximum Length: 10

  Read Only: This attribute provides the Change Order Notice to which the reference designator is added/modified
• Description: string
  Title: Description

  Maximum Length: 240

  An attribute value that describes the reference designator code
• ReferenceDesignator: string
  Title: Reference Designator

  Maximum Length: 15

  An attribute that represents the code of a reference designator
• ReferenceDesignatorDFF: array ReferenceDesignatorDFF
  Descriptive Flexfield extensions for structure reference designators.

{
    "type":"object",
    "properties":{
        "ACDType":{
            "type":"integer",
            "description":"Read Only: This attribute specifies the acdType code which defines whether the reference designator is being added, modified or deleted through a change line",
            "nullable":true,
            "default":1
        },
        "ChangeLineId":{
            "type":"integer",
            "description":"Read Only: This attribute provides the revised line the reference designator is added/modified",
            "format":"int64",
            "nullable":true,
            "default":-1,
            "x-hints":{
                "precision":18
            }
        },
        "ChangeNotice":{
            "maxLength":10,
            "type":"string",
            "description":"Read Only: This attribute provides the Change Order Notice to which the reference designator is added/modified",
            "nullable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":240,
            "type":"string",
            "description":"An attribute value that describes the reference designator code",
            "nullable":true
        },
        "ReferenceDesignator":{
            "title":"Reference Designator",
            "maxLength":15,
            "type":"string",
            "description":"An attribute that represents the code of a reference designator",
            "nullable":false
        },
        "ReferenceDesignatorDFF":{
            "type":"array",
            "description":"Descriptive Flexfield extensions for structure reference designators.",
            "items":{
                "$ref":"#/components/schemas/itemStructures-Component-ReferenceDesignator-ReferenceDesignatorDFF-item-patch-request"
            },
            "x-cardinality":"1"
        }
    }
}

Nested Schema : ReferenceDesignatorDFF

Type: array

Descriptive Flexfield extensions for structure reference designators.

Show Source

• Array of: object schema

{
    "type":"array",
    "description":"Descriptive Flexfield extensions for structure reference designators.",
    "items":{
        "$ref":"#/components/schemas/itemStructures-Component-ReferenceDesignator-ReferenceDesignatorDFF-item-patch-request"
    },
    "x-cardinality":"1"
}

Nested Schema : schema

Type: object

Show Source

• __FLEX_Context: string
  Title: Context

  Maximum Length: 30

  Context
• __FLEX_Context_DisplayValue: string
  Title: Context

  Context

{
    "type":"object",
    "properties":{
        "__FLEX_Context":{
            "title":"Context",
            "maxLength":30,
            "type":"string",
            "description":"Context",
            "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"
                }
            }
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context",
            "type":"string",
            "description":"Context",
            "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"
                }
            }
        }
    }
}

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 : itemStructures-Component-ReferenceDesignator-item-response

Type: object

Show Source

• ACDType: integer
  Default Value: 1

  Read Only: This attribute specifies the acdType code which defines whether the reference designator is being added, modified or deleted through a change line
• ACDTypeValue: string
  Read Only: true

  Maximum Length: 255

  Read Only: This attribute specifies whether the reference designator is being added, modified or deleted through a change line
• ChangeLineId: integer (int64)
  Default Value: -1

  Read Only: This attribute provides the revised line the reference designator is added/modified
• ChangeNotice: string
  Maximum Length: 10

  Read Only: This attribute provides the Change Order Notice to which the reference designator is added/modified
• CreationDateTime: string (date-time)
  Read Only: true

  Who column: An attribute that indicates the date and time of the creation of the reference designator
• Description: string
  Title: Description

  Maximum Length: 240

  An attribute value that describes the reference designator code
• LastUpdateDateTime: string (date-time)
  Read Only: true

  Who column: An attribute which indicates the date and time of the last update of the reference designator
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ReferenceDesignator: string
  Title: Reference Designator

  Maximum Length: 15

  An attribute that represents the code of a reference designator
• ReferenceDesignatorDFF: array ReferenceDesignatorDFF
  Descriptive Flexfield extensions for structure reference designators.
• ReferenceDesignatorSequenceId: integer (int64)
  An unique identifier for the reference designator in a structure.

{
    "type":"object",
    "properties":{
        "ACDType":{
            "type":"integer",
            "description":"Read Only: This attribute specifies the acdType code which defines whether the reference designator is being added, modified or deleted through a change line",
            "nullable":true,
            "default":1,
            "x-queryable":true
        },
        "ACDTypeValue":{
            "maxLength":255,
            "type":"string",
            "description":"Read Only: This attribute specifies whether the reference designator is being added, modified or deleted through a change line",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ChangeLineId":{
            "type":"integer",
            "description":"Read Only: This attribute provides the revised line the reference designator is added/modified",
            "format":"int64",
            "nullable":true,
            "default":-1,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ChangeNotice":{
            "maxLength":10,
            "type":"string",
            "description":"Read Only: This attribute provides the Change Order Notice to which the reference designator is added/modified",
            "nullable":true,
            "x-queryable":true
        },
        "CreationDateTime":{
            "type":"string",
            "description":"Who column: An attribute that indicates the date and time of the creation of the reference designator",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":240,
            "type":"string",
            "description":"An attribute value that describes the reference designator code",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDateTime":{
            "type":"string",
            "description":"Who column: An attribute which indicates the date and time of the last update of the reference designator",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ReferenceDesignator":{
            "title":"Reference Designator",
            "maxLength":15,
            "type":"string",
            "description":"An attribute that represents the code of a reference designator",
            "nullable":false,
            "x-queryable":true
        },
        "ReferenceDesignatorDFF":{
            "type":"array",
            "description":"Descriptive Flexfield extensions for structure reference designators.",
            "items":{
                "$ref":"#/components/schemas/itemStructures-Component-ReferenceDesignator-ReferenceDesignatorDFF-item-response"
            },
            "x-cardinality":"1"
        },
        "ReferenceDesignatorSequenceId":{
            "type":"integer",
            "description":"An unique identifier for the reference designator in a structure.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "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"
    }
}

Nested Schema : ReferenceDesignatorDFF

Type: array

Descriptive Flexfield extensions for structure reference designators.

Show Source

• Array of: object itemStructures-Component-ReferenceDesignator-ReferenceDesignatorDFF-item-response

{
    "type":"array",
    "description":"Descriptive Flexfield extensions for structure reference designators.",
    "items":{
        "$ref":"#/components/schemas/itemStructures-Component-ReferenceDesignator-ReferenceDesignatorDFF-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 : itemStructures-Component-ReferenceDesignator-ReferenceDesignatorDFF-item-response

Type: object

Show Source

• __FLEX_Context: string
  Title: Context

  Maximum Length: 30

  Context
• __FLEX_Context_DisplayValue: string
  Title: Context

  Context
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• RefDesigSequenceId: integer (int64)

{
    "type":"object",
    "properties":{
        "RefDesigSequenceId":{
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "__FLEX_Context":{
            "title":"Context",
            "maxLength":30,
            "type":"string",
            "description":"Context",
            "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
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context",
            "type":"string",
            "description":"Context",
            "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
        },
        "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

ReferenceDesignatorDFF

Operation: /fscmRestApi/resources/11.13.18.05/itemStructures/{BillSequenceId}/child/Component/{ComponentSequenceId}/child/ReferenceDesignator/{ReferenceDesignatorSequenceId}/child/ReferenceDesignatorDFF

Parameters:

• BillSequenceId: $request.path.BillSequenceId
• ComponentSequenceId: $request.path.ComponentSequenceId
• ReferenceDesignatorSequenceId: $request.path.ReferenceDesignatorSequenceId

Back to Top