Jump to

• Request
• Response

Create one operation dependency

post

/fscmRestApi/resources/11.13.18.05/workDefinitionRequests/{workDefinitionRequestsUniqID}/child/workDefinitionHeaders/{workDefinitionHeadersUniqID}/child/operationDependencies

Request

Path Parameters

• workDefinitionHeadersUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Work Definition Headers resource and used to uniquely identify an instance of Work Definition Headers. The client should not generate the hash key value. Instead, the client should query on the Work Definition Headers collection resource in order to navigate to a specific instance of Work Definition Headers to get the hash key.
• workDefinitionRequestsUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Work Definition Requests resource and used to uniquely identify an instance of Work Definition Requests. The client should not generate the hash key value. Instead, the client should query on the Work Definition Requests collection resource in order to navigate to a specific instance of Work Definition Requests to get the hash key.

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

• ActionCode: string
  Maximum Length: 30

  Value that specifies the desired action to perform on the operation dependency of a work definition operation. Valid values are: CREATE, UPDATE, or DELETE.
• DependencyType: string
  Maximum Length: 30

  Indicates the dependency type between previous and next work operations in the operation dependency setup. Valid values are: Finish-to-start or Start-to-start.
• ErrorMessageNames: string
  Maximum Length: 255

  Names of the error messages that occurred when processing the work definition operation. Each text string in the ErrorMessages attribute corresponds to one error message name in the ErrorMessageNames attribute. A comma (,) separates each message name.
• ErrorMessages: string
  Maximum Length: 2000

  Text of the error message, if any, that occurred when processing the work definition operation. Each text string in the ErrorMessages attribute corresponds to one error message name in the ErrorMessageNames attribute. A double dollar sign ($$) separates each message.
• NextOperationSequenceNumber: number
  The operation that's executed after completion of the current operation, as defined in this operation dependency.
• PreviousOperationSequenceNumber: number
  The operation that's executed prior to the current operation.
• TransferPercent: number
  Indicates the percent of batch quantity that's transferred from the current operation to the next operation in the operation dependency setup. For the first operation dependency, if the process batch quantity type is calculated, the transfer percentage is null because there's no previous operation to transfer from. The transfer percentage of the last operation dependency is always null because there's no next operation to transfer to.

{
    "type":"object",
    "properties":{
        "ActionCode":{
            "maxLength":30,
            "type":"string",
            "description":"Value that specifies the desired action to perform on the operation dependency of a work definition operation. Valid values are: CREATE, UPDATE, or DELETE.",
            "nullable":false
        },
        "DependencyType":{
            "maxLength":30,
            "type":"string",
            "description":"Indicates the dependency type between previous and next work operations in the operation dependency setup. Valid values are: Finish-to-start or Start-to-start.",
            "nullable":true
        },
        "ErrorMessageNames":{
            "maxLength":255,
            "type":"string",
            "description":"Names of the error messages that occurred when processing the work definition operation. Each text string in the ErrorMessages attribute corresponds to one error message name in the ErrorMessageNames attribute. A comma (,) separates each message name.",
            "nullable":true
        },
        "ErrorMessages":{
            "maxLength":2000,
            "type":"string",
            "description":"Text of the error message, if any, that occurred when processing the work definition operation. Each text string in the ErrorMessages attribute corresponds to one error message name in the ErrorMessageNames attribute. A double dollar sign ($$) separates each message.",
            "nullable":true
        },
        "NextOperationSequenceNumber":{
            "type":"number",
            "description":"The operation that's executed after completion of the current operation, as defined in this operation dependency.",
            "nullable":true
        },
        "PreviousOperationSequenceNumber":{
            "type":"number",
            "description":"The operation that's executed prior to the current operation.",
            "nullable":true
        },
        "TransferPercent":{
            "type":"number",
            "description":"Indicates the percent of batch quantity that's transferred from the current operation to the next operation in the operation dependency setup. For the first operation dependency, if the process batch quantity type is calculated, the transfer percentage is null because there's no previous operation to transfer from. The transfer percentage of the last operation dependency is always null because there's no next operation to transfer to.",
            "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 : workDefinitionRequests-workDefinitionHeaders-operationDependencies-item-response

Type: object

Show Source

• ActionCode: string
  Maximum Length: 30

  Value that specifies the desired action to perform on the operation dependency of a work definition operation. Valid values are: CREATE, UPDATE, or DELETE.
• DependencyType: string
  Maximum Length: 30

  Indicates the dependency type between previous and next work operations in the operation dependency setup. Valid values are: Finish-to-start or Start-to-start.
• ErrorMessageNames: string
  Maximum Length: 255

  Names of the error messages that occurred when processing the work definition operation. Each text string in the ErrorMessages attribute corresponds to one error message name in the ErrorMessageNames attribute. A comma (,) separates each message name.
• ErrorMessages: string
  Maximum Length: 2000

  Text of the error message, if any, that occurred when processing the work definition operation. Each text string in the ErrorMessages attribute corresponds to one error message name in the ErrorMessageNames attribute. A double dollar sign ($$) separates each message.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• NextOperationSequenceNumber: number
  The operation that's executed after completion of the current operation, as defined in this operation dependency.
• PreviousOperationSequenceNumber: number
  The operation that's executed prior to the current operation.
• TransferPercent: number
  Indicates the percent of batch quantity that's transferred from the current operation to the next operation in the operation dependency setup. For the first operation dependency, if the process batch quantity type is calculated, the transfer percentage is null because there's no previous operation to transfer from. The transfer percentage of the last operation dependency is always null because there's no next operation to transfer to.

{
    "type":"object",
    "properties":{
        "ActionCode":{
            "maxLength":30,
            "type":"string",
            "description":"Value that specifies the desired action to perform on the operation dependency of a work definition operation. Valid values are: CREATE, UPDATE, or DELETE.",
            "nullable":false,
            "x-queryable":true
        },
        "DependencyType":{
            "maxLength":30,
            "type":"string",
            "description":"Indicates the dependency type between previous and next work operations in the operation dependency setup. Valid values are: Finish-to-start or Start-to-start.",
            "nullable":true,
            "x-queryable":true
        },
        "ErrorMessageNames":{
            "maxLength":255,
            "type":"string",
            "description":"Names of the error messages that occurred when processing the work definition operation. Each text string in the ErrorMessages attribute corresponds to one error message name in the ErrorMessageNames attribute. A comma (,) separates each message name.",
            "nullable":true,
            "x-queryable":true
        },
        "ErrorMessages":{
            "maxLength":2000,
            "type":"string",
            "description":"Text of the error message, if any, that occurred when processing the work definition operation. Each text string in the ErrorMessages attribute corresponds to one error message name in the ErrorMessageNames attribute. A double dollar sign ($$) separates each message.",
            "nullable":true,
            "x-queryable":true
        },
        "NextOperationSequenceNumber":{
            "type":"number",
            "description":"The operation that's executed after completion of the current operation, as defined in this operation dependency.",
            "nullable":true,
            "x-queryable":true
        },
        "PreviousOperationSequenceNumber":{
            "type":"number",
            "description":"The operation that's executed prior to the current operation.",
            "nullable":true,
            "x-queryable":true
        },
        "TransferPercent":{
            "type":"number",
            "description":"Indicates the percent of batch quantity that's transferred from the current operation to the next operation in the operation dependency setup. For the first operation dependency, if the process batch quantity type is calculated, the transfer percentage is null because there's no previous operation to transfer from. The transfer percentage of the last operation dependency is always null because there's no next operation to transfer to.",
            "nullable":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."
        }
    }
}

Back to Top