Jump to

• Request
• Response

Create one revision of an item

post

/fscmRestApi/resources/11.13.18.05/productChangeOrders/{ChangeId}/child/AffectedObject/{AffectedObjectUniqID}/child/AffectedItem/{AffectedItemUniqID}/child/ItemRevision

Request

Path Parameters

• AffectedItemUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Affected Items resource and used to uniquely identify an instance of Affected Items. The client should not generate the hash key value. Instead, the client should query on the Affected Items collection resource in order to navigate to a specific instance of Affected Items to get the hash key.
• AffectedObjectUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Affected Objects resource and used to uniquely identify an instance of Affected Objects. The client should not generate the hash key value. Instead, the client should query on the Affected Objects collection resource in order to navigate to a specific instance of Affected Objects to get the hash key.
• ChangeId(required): integer
  Value that uniquely identifies the change.

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.
• Upsert-Mode:
  Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• AltRevisionCode: string
  Maximum Length: 40
• AttachmentEntityName: string
  Maximum Length: 255

  Default Value: ITEM_REVISION_ENTITY
• ChangeLineId: integer (int64)
• ContextChangeLineId: integer
  Default Value: -1
• ContextDate: string (date-time)
• ContextVersionId: integer
  Default Value: -1
• CopyAttachments: boolean
• CopyDocuments: boolean
• EffectivityDate(required): string (date-time)
  Title: Effective Date

  Revision effectively date
• ItemId(required): integer (int64)
  An unique identifier for a part, material, product or service that is unique as compared with other items by the nature of its attributes.
• ItemRevisionDescription: string
  Title: Description

  Maximum Length: 240

  The description for on item revision.
• ItemRevisionEffCategory: array ItemRevisionEffCategory
  ItemService.ItemRevisionEffCategory
• ObjectVersionNumber: integer (int32)
  This value is set to value of '1" when the item is created and incremented every time the item is updated.
• OrganizationId1(required): integer (int64)
• RequestId: integer (int64)
  This is the request id generated at import. Its use case is to verify import, the items will be published based on RequestID.
• RevisionCode(required): string
  Title: Revision Code

  Maximum Length: 18

  An attribute value that represents a revision.
• RevisionExtensibleFlexfieldCategoryCode: string
  Maximum Length: 240

  An attribute value for the EFF category code for the Item revision.
• RevisionId: integer (int64)
  An unique identifier of a revision.
• RevisionReason: string
  Title: Revision Reason

  Maximum Length: 30
• RevisionReasonValue: string
  An attribute value that represents the reason for a revision.
• VersionAsOfDate: string (date-time)
• VersionId: integer
  Default Value: -1

{
    "required":[
        "EffectivityDate",
        "ItemId",
        "OrganizationId1",
        "RevisionCode"
    ],
    "type":"object",
    "properties":{
        "VersionAsOfDate":{
            "type":"string",
            "format":"date-time",
            "nullable":true
        },
        "VersionId":{
            "type":"integer",
            "nullable":true,
            "default":"-1"
        },
        "OrganizationId1":{
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "ItemRevisionDescription":{
            "title":"Description",
            "maxLength":"240",
            "type":"string",
            "description":"The description for on item revision.",
            "nullable":true
        },
        "RevisionReasonValue":{
            "type":"string",
            "description":"An attribute value that represents the reason for a revision.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ChangeLineId":{
            "type":"integer",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "RevisionExtensibleFlexfieldCategoryCode":{
            "maxLength":"240",
            "type":"string",
            "description":"An attribute value for the EFF category code for the Item revision.",
            "nullable":true,
            "x-queryable":false
        },
        "ItemRevisionEffCategory":{
            "type":"array",
            "description":"ItemService.ItemRevisionEffCategory",
            "items":{
                "$ref":"#/components/schemas/productChangeOrders-AffectedObject-AffectedItem-ItemRevision-ItemRevisionEffCategory-item-post-request"
            },
            "x-cardinality":"1"
        },
        "ContextVersionId":{
            "type":"integer",
            "nullable":true,
            "default":"-1",
            "x-queryable":false
        },
        "RequestId":{
            "type":"integer",
            "description":"This is the request id generated at import. Its use case is to verify import, the items will be published based on RequestID.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "CopyAttachments":{
            "type":"boolean",
            "nullable":true,
            "x-queryable":false
        },
        "CopyDocuments":{
            "type":"boolean",
            "nullable":true,
            "x-queryable":false
        },
        "RevisionReason":{
            "title":"Revision Reason",
            "maxLength":"30",
            "type":"string",
            "nullable":true
        },
        "ItemId":{
            "type":"integer",
            "description":"An unique identifier for a part, material, product or service that is unique as compared with other items by the nature of its attributes.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "RevisionId":{
            "type":"integer",
            "description":"An unique identifier of a revision.",
            "format":"int64",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "AltRevisionCode":{
            "maxLength":"40",
            "type":"string",
            "nullable":true
        },
        "RevisionCode":{
            "title":"Revision Code",
            "maxLength":"18",
            "type":"string",
            "description":"An attribute value that represents a revision.",
            "nullable":false
        },
        "EffectivityDate":{
            "title":"Effective Date",
            "type":"string",
            "description":"Revision effectively date",
            "format":"date-time",
            "nullable":false
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"This value is set to value of '1\" when the item is created and incremented every time the item is updated.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"9"
            }
        },
        "ContextDate":{
            "type":"string",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        },
        "AttachmentEntityName":{
            "maxLength":"255",
            "type":"string",
            "nullable":true,
            "default":"ITEM_REVISION_ENTITY"
        },
        "ContextChangeLineId":{
            "type":"integer",
            "nullable":true,
            "default":"-1",
            "x-queryable":false
        }
    }
}

Nested Schema : ItemRevisionEffCategory

Type: array

ItemService.ItemRevisionEffCategory

Show Source

• Array of: object productChangeOrders-AffectedObject-AffectedItem-ItemRevision-ItemRevisionEffCategory-item-post-request

{
    "type":"array",
    "description":"ItemService.ItemRevisionEffCategory",
    "items":{
        "$ref":"#/components/schemas/productChangeOrders-AffectedObject-AffectedItem-ItemRevision-ItemRevisionEffCategory-item-post-request"
    },
    "x-cardinality":"1"
}

Nested Schema : productChangeOrders-AffectedObject-AffectedItem-ItemRevision-ItemRevisionEffCategory-item-post-request

Type: object

Show Source

• CategoryCode: string
  Maximum Length: 240
• RevisionId: integer (int64)
• VersionId: integer
  Default Value: -1

{
    "type":"object",
    "properties":{
        "CategoryCode":{
            "maxLength":"240",
            "type":"string",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "VersionId":{
            "type":"integer",
            "nullable":true,
            "default":"-1",
            "x-queryable":false
        },
        "RevisionId":{
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "fnd:FND_AUDIT_FORCE_WRITE":"true",
                "precision":"18",
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        }
    }
}

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 : productChangeOrders-AffectedObject-AffectedItem-ItemRevision-item-response

Type: object

Show Source

• AltRevisionCode: string
  Maximum Length: 40
• AttachmentEntityName: string
  Maximum Length: 255

  Default Value: ITEM_REVISION_ENTITY
• ChangeLineId: integer (int64)
• ContextChangeLineId: integer
  Default Value: -1
• ContextDate: string (date-time)
• ContextVersionId: integer
  Default Value: -1
• CopyAttachments: boolean
• CopyDocuments: boolean
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  Who column: An attribute which indicates the user that created the item revision.
• CreationDateTime: string (date-time)
  Read Only: true

  Who column: An attribute that indicates the date and time of the creation of the item revision.
• EffectivityDate: string (date-time)
  Title: Effective Date

  Revision effectively date
• EndEffectivityDate: string (date-time)
  Read Only: true

  Date and time when the effectivity of the revision ends.
• ImplementationDate: string (date-time)
  Read Only: true

  Date and time when the revision was implemented.
• InventoryItemId: integer (int64)
  Read Only: true
• InvItemIdChar: string
  Read Only: true

  Maximum Length: 255
• ItemId: integer (int64)
  An unique identifier for a part, material, product or service that is unique as compared with other items by the nature of its attributes.
• ItemRevisionDescription: string
  Title: Description

  Maximum Length: 240

  The description for on item revision.
• ItemRevisionEffCategory: array ItemRevisionEffCategory
  ItemService.ItemRevisionEffCategory
• LastUpdateDateTime: string (date-time)
  Read Only: true

  Who column: An attribute which indicates the date and time of the last update of the item revision.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  Who column: An attribute which indicates the user that last updated the item revision
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  Who column: An attribute which indicates the user that logged in last for the item revision
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ObjectVersionNumber: integer (int32)
  This value is set to value of '1" when the item is created and incremented every time the item is updated.
• ObjectVersionNumber1: integer (int32)
  Read Only: true
• OrganizationId: integer (int64)
  Read Only: true

  An unique identifier for an organizing unit in the internal or external structure of your enterprise. Organization structures provide the framework for performing legal reporting, financial control, and management reporting.
• OrganizationId1: integer (int64)
• OrgIdChar: string
  Read Only: true

  Maximum Length: 255
• RequestId: integer (int64)
  This is the request id generated at import. Its use case is to verify import, the items will be published based on RequestID.
• RevisionCode: string
  Title: Revision Code

  Maximum Length: 18

  An attribute value that represents a revision.
• RevisionExtensibleFlexfieldCategoryCode: string
  Maximum Length: 240

  An attribute value for the EFF category code for the Item revision.
• RevisionId: integer (int64)
  An unique identifier of a revision.
• RevisionIdChar: string
  Read Only: true

  Maximum Length: 255
• RevisionReason: string
  Title: Revision Reason

  Maximum Length: 30
• RevisionReasonValue: string
  An attribute value that represents the reason for a revision.
• VersionAsOfDate: string (date-time)
• VersionId: integer
  Default Value: -1

{
    "type":"object",
    "properties":{
        "VersionAsOfDate":{
            "type":"string",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "OrganizationId1":{
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ItemRevisionEffCategory":{
            "type":"array",
            "description":"ItemService.ItemRevisionEffCategory",
            "items":{
                "$ref":"#/components/schemas/productChangeOrders-AffectedObject-AffectedItem-ItemRevision-ItemRevisionEffCategory-item-response"
            },
            "x-cardinality":"1"
        },
        "LastUpdateDateTime":{
            "type":"string",
            "description":"Who column: An attribute which indicates the date and time of the last update of the item revision.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OrganizationId":{
            "type":"integer",
            "description":"An unique identifier for an organizing unit in the internal or external structure of your enterprise. Organization structures provide the framework for performing legal reporting, financial control, and management reporting.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "OrgIdChar":{
            "maxLength":"255",
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ItemId":{
            "type":"integer",
            "description":"An unique identifier for a part, material, product or service that is unique as compared with other items by the nature of its attributes.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "RevisionId":{
            "type":"integer",
            "description":"An unique identifier of a revision.",
            "format":"int64",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "RevisionIdChar":{
            "maxLength":"255",
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "InvItemIdChar":{
            "maxLength":"255",
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "EffectivityDate":{
            "title":"Effective Date",
            "type":"string",
            "description":"Revision effectively date",
            "format":"date-time",
            "nullable":false,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"This value is set to value of '1\" when the item is created and incremented every time the item is updated.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "EndEffectivityDate":{
            "type":"string",
            "description":"Date and time when the effectivity of the revision ends.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ImplementationDate":{
            "type":"string",
            "description":"Date and time when the revision was implemented.",
            "format":"date-time",
            "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"
            }
        },
        "ContextDate":{
            "type":"string",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        },
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"Who column: An attribute which indicates the user that last updated the item revision",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "VersionId":{
            "type":"integer",
            "nullable":true,
            "default":"-1",
            "x-queryable":true
        },
        "ItemRevisionDescription":{
            "title":"Description",
            "maxLength":"240",
            "type":"string",
            "description":"The description for on item revision.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"Who column: An attribute which indicates the user that created the item revision.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RevisionReasonValue":{
            "type":"string",
            "description":"An attribute value that represents the reason for a revision.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ChangeLineId":{
            "type":"integer",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "RevisionExtensibleFlexfieldCategoryCode":{
            "maxLength":"240",
            "type":"string",
            "description":"An attribute value for the EFF category code for the Item revision.",
            "nullable":true,
            "x-queryable":false
        },
        "ContextVersionId":{
            "type":"integer",
            "nullable":true,
            "default":"-1",
            "x-queryable":false
        },
        "RequestId":{
            "type":"integer",
            "description":"This is the request id generated at import. Its use case is to verify import, the items will be published based on RequestID.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CopyAttachments":{
            "type":"boolean",
            "nullable":true,
            "x-queryable":false
        },
        "CopyDocuments":{
            "type":"boolean",
            "nullable":true,
            "x-queryable":false
        },
        "InventoryItemId":{
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "RevisionReason":{
            "title":"Revision Reason",
            "maxLength":"30",
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "ObjectVersionNumber1":{
            "type":"integer",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "AltRevisionCode":{
            "maxLength":"40",
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "RevisionCode":{
            "title":"Revision Code",
            "maxLength":"18",
            "type":"string",
            "description":"An attribute value that represents a revision.",
            "nullable":false,
            "x-queryable":true
        },
        "CreationDateTime":{
            "type":"string",
            "description":"Who column: An attribute that indicates the date and time of the creation of the item revision.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AttachmentEntityName":{
            "maxLength":"255",
            "type":"string",
            "nullable":true,
            "default":"ITEM_REVISION_ENTITY",
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":"32",
            "type":"string",
            "description":"Who column: An attribute which indicates the user that logged in last for the item revision",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ContextChangeLineId":{
            "type":"integer",
            "nullable":true,
            "default":"-1",
            "x-queryable":false
        }
    }
}

Nested Schema : ItemRevisionEffCategory

Type: array

ItemService.ItemRevisionEffCategory

Show Source

• Array of: object productChangeOrders-AffectedObject-AffectedItem-ItemRevision-ItemRevisionEffCategory-item-response

{
    "type":"array",
    "description":"ItemService.ItemRevisionEffCategory",
    "items":{
        "$ref":"#/components/schemas/productChangeOrders-AffectedObject-AffectedItem-ItemRevision-ItemRevisionEffCategory-item-response"
    },
    "x-cardinality":"1"
}

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 : productChangeOrders-AffectedObject-AffectedItem-ItemRevision-ItemRevisionEffCategory-item-response

Type: object

Show Source

• CategoryCode: string
  Maximum Length: 240
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• RevisionId: integer (int64)
• VersionId: integer
  Default Value: -1

{
    "type":"object",
    "properties":{
        "CategoryCode":{
            "maxLength":"240",
            "type":"string",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "VersionId":{
            "type":"integer",
            "nullable":true,
            "default":"-1",
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "RevisionId":{
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "fnd:FND_AUDIT_FORCE_WRITE":"true",
                "precision":"18",
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        }
    }
}

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

ItemRevisionEffCategory

Parameters:

• AffectedItemUniqID: $request.path.AffectedItemUniqID
• AffectedObjectUniqID: $request.path.AffectedObjectUniqID
• ChangeId: $request.path.ChangeId
• productChangeOrders_AffectedObject_AffectedItem_ItemRevision_Id: $request.path.productChangeOrders_AffectedObject_AffectedItem_ItemRevision_Id

Back to Top