Jump to

• Request
• Response

Get detailed history of one approval action on a purchase order

get

/fscmRestApi/resources/11.13.18.05/purchasingDocumentHistoryDetails/{purchasingDocumentHistoryDetailsUniqID}/child/documentVersionActions/{documentVersionActionsUniqID}

Request

Path Parameters

• documentVersionActionsUniqID(required): string
  This is the hash key of the attributes which make up the composite key--- DocumentId, DocumentTypeCode, DocumentSubTypeCode, SequenceNumber and ActionCode ---for the Document History Details resource and used to uniquely identify an instance of Document History Details. The client should not generate the hash key value. Instead, the client should query on the Document History Details collection resource with a filter on the primary key values in order to navigate to a specific instance of Document History Details.
  
  For example: documentVersionActions?q=DocumentId=<value1>;DocumentTypeCode=<value2>;DocumentSubTypeCode=<value3>;SequenceNumber=<value4>;ActionCode=<value5>
• purchasingDocumentHistoryDetailsUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Purchasing Document Versions resource and used to uniquely identify an instance of Purchasing Document Versions. The client should not generate the hash key value. Instead, the client should query on the Purchasing Document Versions collection resource in order to navigate to a specific instance of Purchasing Document Versions to get the hash key.

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

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.

There's no request body for this operation.

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 : purchasingDocumentHistoryDetails-documentVersionActions-item-response

Type: object

Show Source

• Action: string
  Title: Meaning

  Read Only: true

  Maximum Length: 80

  Name of the action performed on a purchasing document.
• ActionCode: string
  Read Only: true

  Maximum Length: 25

  Abbreviation that identifies the approval action performed on a purchasing document.
• ActionDate: string (date-time)
  Title: Action Date

  Read Only: true

  Date and time when the action is executed.
• AdditionalInformation: string
  Read Only: true

  Maximum Length: 255

  Additional information related to the approval or control action.
• DocumentId: integer (int64)
  Read Only: true

  Value that uniquely identifies the purchasing document.
• DocumentSubTypeCode: string
  Read Only: true

  Maximum Length: 25

  Abbreviation that identifies the document subtype associated with a purchasing document.
• DocumentTypeCode: string
  Read Only: true

  Maximum Length: 25

  Abbreviation that identifies the purchasing document type.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PerformedBy: string
  Title: Name

  Read Only: true

  Maximum Length: 240

  Display name of the person taking the action.
• PerformedById: integer (int64)
  Read Only: true

  Unique identifier of the person taking the action.
• SequenceNumber: integer
  Read Only: true

  Sequence of the approval or control action for a purchasing document.
• VersionId: integer (int64)
  Read Only: true

  Finds the purchasing document version according to the primary key.

{
    "type":"object",
    "properties":{
        "VersionId":{
            "type":"integer",
            "description":"Finds the purchasing document version according to the primary key.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "AdditionalInformation":{
            "maxLength":"255",
            "type":"string",
            "description":"Additional information related to the approval or control action.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "Action":{
            "title":"Meaning",
            "maxLength":"80",
            "type":"string",
            "description":"Name of the action performed on a purchasing document.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "PerformedById":{
            "type":"integer",
            "description":"Unique identifier of the person taking the action.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "DocumentId":{
            "type":"integer",
            "description":"Value that uniquely identifies the purchasing document.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "DocumentTypeCode":{
            "maxLength":"25",
            "type":"string",
            "description":"Abbreviation that identifies the purchasing document type.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "SequenceNumber":{
            "type":"integer",
            "description":"Sequence of the approval or control action for a purchasing document.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "ActionCode":{
            "maxLength":"25",
            "type":"string",
            "description":"Abbreviation that identifies the approval action performed on a purchasing document.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PerformedBy":{
            "title":"Name",
            "maxLength":"240",
            "type":"string",
            "description":"Display name of the person taking the action.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "DocumentSubTypeCode":{
            "maxLength":"25",
            "type":"string",
            "description":"Abbreviation that identifies the document subtype associated with a purchasing document.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "ActionDate":{
            "title":"Action Date",
            "type":"string",
            "description":"Date and time when the action is executed.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":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."
        }
    }
}

Back to Top