Jump to

• Request
• Response

Update one approved supplier list status

patch

/fscmRestApi/resources/11.13.18.05/purchasingApprovedSupplierListStatuses/{StatusId}

Request

Path Parameters

• StatusId(required): integer(int64)
  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

• AllowPurchasingApprovalFlag: boolean
  Title: Allow Purchase Order Approval

  Maximum Length: 1

  Enables you to allow or prevent purchase order approvals for this supplier. If true, it allows purchase order approvals. If false, it's prevented.
• AllowSourcingFlag: boolean
  Title: Allow Document Sourcing

  Maximum Length: 1

  Enables you to allow or prevent sourcing to this supplier. If true, it allows sourcing. If false, it's prevented.
• AslDefaultFlag: boolean
  Title: Default Status

  Maximum Length: 1

  Contains one of the following values: true or false. If true, the status is the default for new entries on the approved supplier list. If false, it isn't the default.
• InactiveDate: string (date)
  Title: End Date

  Date when the approved supplier list status becomes inactive.
• Status: string
  Title: Status

  Maximum Length: 25

  Name of the status.
• StatusDescription: string
  Title: Description

  Maximum Length: 240

  Description of the status.

{
    "type":"object",
    "properties":{
        "AllowPurchasingApprovalFlag":{
            "title":"Allow Purchase Order Approval",
            "maxLength":1,
            "type":"boolean",
            "description":"Enables you to allow or prevent purchase order approvals for this supplier. If true, it allows purchase order approvals. If false, it's prevented.",
            "nullable":true
        },
        "AllowSourcingFlag":{
            "title":"Allow Document Sourcing",
            "maxLength":1,
            "type":"boolean",
            "description":"Enables you to allow or prevent sourcing to this supplier. If true, it allows sourcing. If false, it's prevented.",
            "nullable":true
        },
        "AslDefaultFlag":{
            "title":"Default Status",
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, the status is the default for new entries on the approved supplier list. If false, it isn't the default.",
            "nullable":false
        },
        "InactiveDate":{
            "title":"End Date",
            "type":"string",
            "description":"Date when the approved supplier list status becomes inactive.",
            "format":"date",
            "nullable":true
        },
        "Status":{
            "title":"Status",
            "maxLength":25,
            "type":"string",
            "description":"Name of the status.",
            "nullable":false
        },
        "StatusDescription":{
            "title":"Description",
            "maxLength":240,
            "type":"string",
            "description":"Description of the status.",
            "nullable":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 : purchasingApprovedSupplierListStatuses-item-response

Type: object

Show Source

• AllowPurchasingApprovalFlag: boolean
  Title: Allow Purchase Order Approval

  Maximum Length: 1

  Enables you to allow or prevent purchase order approvals for this supplier. If true, it allows purchase order approvals. If false, it's prevented.
• AllowSourcingFlag: boolean
  Title: Allow Document Sourcing

  Maximum Length: 1

  Enables you to allow or prevent sourcing to this supplier. If true, it allows sourcing. If false, it's prevented.
• AslDefaultFlag: boolean
  Title: Default Status

  Maximum Length: 1

  Contains one of the following values: true or false. If true, the status is the default for new entries on the approved supplier list. If false, it isn't the default.
• InactiveDate: string (date)
  Title: End Date

  Date when the approved supplier list status becomes inactive.
• links: array Links
  Title: Links

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

  Maximum Length: 25

  Name of the status.
• StatusDescription: string
  Title: Description

  Maximum Length: 240

  Description of the status.
• StatusId: integer (int64)
  Read Only: true

  Value that uniquely identifies the status.

{
    "type":"object",
    "properties":{
        "AllowPurchasingApprovalFlag":{
            "title":"Allow Purchase Order Approval",
            "maxLength":1,
            "type":"boolean",
            "description":"Enables you to allow or prevent purchase order approvals for this supplier. If true, it allows purchase order approvals. If false, it's prevented.",
            "nullable":true,
            "x-queryable":true
        },
        "AllowSourcingFlag":{
            "title":"Allow Document Sourcing",
            "maxLength":1,
            "type":"boolean",
            "description":"Enables you to allow or prevent sourcing to this supplier. If true, it allows sourcing. If false, it's prevented.",
            "nullable":true,
            "x-queryable":true
        },
        "AslDefaultFlag":{
            "title":"Default Status",
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, the status is the default for new entries on the approved supplier list. If false, it isn't the default.",
            "nullable":false,
            "x-queryable":true
        },
        "InactiveDate":{
            "title":"End Date",
            "type":"string",
            "description":"Date when the approved supplier list status becomes inactive.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "Status":{
            "title":"Status",
            "maxLength":25,
            "type":"string",
            "description":"Name of the status.",
            "nullable":false,
            "x-queryable":true
        },
        "StatusDescription":{
            "title":"Description",
            "maxLength":240,
            "type":"string",
            "description":"Description of the status.",
            "nullable":false,
            "x-queryable":true
        },
        "StatusId":{
            "type":"integer",
            "description":"Value that uniquely identifies the status.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "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