Jump to

• Request
• Response

Create one approver

post

/fscmRestApi/resources/11.13.18.05/productChangeOrders/{ChangeId}/child/changeApprovers

Request

Path Parameters

• 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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• Approverflag: string
  Maximum Length: 255

  Contains one of the following values: true or false. If true, then an approver is mandatory. If false, then an approver is optional. This attribute does not have a default value.
• AssigneeName: string
  Maximum Length: 400

  Name of the user or role that is assigned as an approver.
• AssigneeTypeCode: string
  Maximum Length: 20

  Abbreviation that identifies the type of approver. Valid values include role and user.
• OriginalAssigneeType: string
  Maximum Length: 30

  Name of the role from which this user assignment originated.
• ResponseRequiredFrom: string
  Maximum Length: 10

  Value that indicates if approval is requested from one or all of the approvers.
• StatusCode: integer
  Abbreviation that identifies the workflow status.

{
    "type":"object",
    "properties":{
        "AssigneeName":{
            "maxLength":"400",
            "type":"string",
            "description":"Name of the user or role that is assigned as an approver.",
            "nullable":true,
            "x-queryable":false
        },
        "OriginalAssigneeType":{
            "maxLength":"30",
            "type":"string",
            "description":"Name of the role from which this user assignment originated.",
            "nullable":true
        },
        "Approverflag":{
            "maxLength":"255",
            "type":"string",
            "description":"Contains one of the following values: true or false. If true, then an approver is mandatory. If false, then an approver is optional. This attribute does not have a default value.",
            "nullable":true
        },
        "AssigneeTypeCode":{
            "maxLength":"20",
            "type":"string",
            "description":"Abbreviation that identifies the type of approver. Valid values include role and user.",
            "nullable":false
        },
        "StatusCode":{
            "type":"integer",
            "description":"Abbreviation that identifies the workflow status.",
            "nullable":true
        },
        "ResponseRequiredFrom":{
            "maxLength":"10",
            "type":"string",
            "description":"Value that indicates if approval is requested from one or all of the approvers.",
            "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 : productChangeOrders-changeApprovers-item-response

Type: object

Show Source

• Approverflag: string
  Maximum Length: 255

  Contains one of the following values: true or false. If true, then an approver is mandatory. If false, then an approver is optional. This attribute does not have a default value.
• AssigneeName: string
  Maximum Length: 400

  Name of the user or role that is assigned as an approver.
• AssigneeTypeCode: string
  Maximum Length: 20

  Abbreviation that identifies the type of approver. Valid values include role and user.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• OriginalAssigneeType: string
  Maximum Length: 30

  Name of the role from which this user assignment originated.
• ResponseRequiredFrom: string
  Maximum Length: 10

  Value that indicates if approval is requested from one or all of the approvers.
• StatusCode: integer
  Abbreviation that identifies the workflow status.

{
    "type":"object",
    "properties":{
        "AssigneeName":{
            "maxLength":"400",
            "type":"string",
            "description":"Name of the user or role that is assigned as an approver.",
            "nullable":true,
            "x-queryable":false
        },
        "OriginalAssigneeType":{
            "maxLength":"30",
            "type":"string",
            "description":"Name of the role from which this user assignment originated.",
            "nullable":true,
            "x-queryable":true
        },
        "Approverflag":{
            "maxLength":"255",
            "type":"string",
            "description":"Contains one of the following values: true or false. If true, then an approver is mandatory. If false, then an approver is optional. This attribute does not have a default value.",
            "nullable":true,
            "x-queryable":true
        },
        "AssigneeTypeCode":{
            "maxLength":"20",
            "type":"string",
            "description":"Abbreviation that identifies the type of approver. Valid values include role and user.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "StatusCode":{
            "type":"integer",
            "description":"Abbreviation that identifies the workflow status.",
            "nullable":true,
            "x-queryable":true
        },
        "ResponseRequiredFrom":{
            "maxLength":"10",
            "type":"string",
            "description":"Value that indicates if approval is requested from one or all of the approvers.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

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