Jump to

• Request
• Response

Update one price book publication

patch

/fscmRestApi/resources/11.13.18.05/priceBooks/{PriceBookNumber}/child/publications/{PriceBookPublicationId}

Request

Path Parameters

• PriceBookNumber(required): string
  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=
• PriceBookPublicationId(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=

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

• Description: string
  Maximum Length: 1000

  Description of the price book publication.
• DimensionCriteria: string (byte)
  Criteria used to generate the price book.
• Name: string
  Maximum Length: 80

  Name of the price book publication.
• PriceBookId: integer
  Value that uniquely identifies the price book. This value is automatically assigned by Oracle Pricing.
• ProductCriteria: string (byte)
  Product criteria used to generate the price book.
• PublicationDate: string (date-time)
  The date and time the document was published.
• PublicationFormat: string
  Maximum Length: 30

  Format used for creating the price book publication.

{
    "type":"object",
    "properties":{
        "Description":{
            "maxLength":1000,
            "type":"string",
            "description":"Description of the price book publication.",
            "nullable":true
        },
        "DimensionCriteria":{
            "type":"string",
            "description":"Criteria used to generate the price book.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "Name":{
            "maxLength":80,
            "type":"string",
            "description":"Name of the price book publication.",
            "nullable":true
        },
        "PriceBookId":{
            "type":"integer",
            "description":"Value that uniquely identifies the price book. This value is automatically assigned by Oracle Pricing.",
            "nullable":false
        },
        "ProductCriteria":{
            "type":"string",
            "description":"Product criteria used to generate the price book.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "PublicationDate":{
            "type":"string",
            "description":"The date and time the document was published.",
            "format":"date-time",
            "nullable":true
        },
        "PublicationFormat":{
            "maxLength":30,
            "type":"string",
            "description":"Format used for creating the price book publication.",
            "nullable":true
        }
    }
}

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 : priceBooks-publications-item-response

Type: object

Show Source

• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who created the record.
• CreationDate: string (date-time)
  Read Only: true

  Date and time when the record was created.
• Description: string
  Maximum Length: 1000

  Description of the price book publication.
• DimensionCriteria: string (byte)
  Criteria used to generate the price book.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date and time when the record was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who most recently updated the record.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  The session login associated with the user who last updated the record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Name: string
  Maximum Length: 80

  Name of the price book publication.
• PriceBookId: integer
  Value that uniquely identifies the price book. This value is automatically assigned by Oracle Pricing.
• PriceBookPublicationId: integer
  Value that uniquely identifies the price book publication.
• ProductCriteria: string (byte)
  Product criteria used to generate the price book.
• PublicationDate: string (date-time)
  The date and time the document was published.
• PublicationFormat: string
  Maximum Length: 30

  Format used for creating the price book publication.
• StatusCode: string
  Read Only: true

  Maximum Length: 30

  Abbreviation that identifies the status of the publication.

{
    "type":"object",
    "properties":{
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "maxLength":1000,
            "type":"string",
            "description":"Description of the price book publication.",
            "nullable":true,
            "x-queryable":true
        },
        "DimensionCriteria":{
            "type":"string",
            "description":"Criteria used to generate the price book.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date and time when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The session login associated with the user who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Name":{
            "maxLength":80,
            "type":"string",
            "description":"Name of the price book publication.",
            "nullable":true,
            "x-queryable":true
        },
        "PriceBookId":{
            "type":"integer",
            "description":"Value that uniquely identifies the price book. This value is automatically assigned by Oracle Pricing.",
            "nullable":false,
            "x-queryable":true
        },
        "PriceBookPublicationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the price book publication.",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "ProductCriteria":{
            "type":"string",
            "description":"Product criteria used to generate the price book.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "PublicationDate":{
            "type":"string",
            "description":"The date and time the document was published.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "PublicationFormat":{
            "maxLength":30,
            "type":"string",
            "description":"Format used for creating the price book publication.",
            "nullable":true,
            "x-queryable":true
        },
        "StatusCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the status of the publication.",
            "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"
            }
        }
    }
}

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

publishPriceBook

Operation: /fscmRestApi/resources/11.13.18.05/priceBooks/{PriceBookNumber}/child/publications/{PriceBookPublicationId}/action/publishPriceBook

Parameters:

• PriceBookNumber: $request.path.PriceBookNumber
• PriceBookPublicationId: $request.path.PriceBookPublicationId

Publishes a pregenerated collection of prices based on a set of input parameters.

Back to Top